Create route

POST

/routes

Last modified:2026-10-30 21:27:34

OperationId:CreateRoute

Adds a call route, which applies to the whole platform. Requires Super User scope. Add the route's next hops afterward with POST /routes/{route-id}/routecon.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned for synchronous=yes, sent in the body or the query string, when the route is applied within 2 seconds: the route, with its route-id. If it takes longer, you get 202 and the write still completes.

Bodyapplication/json

🟢202Accepted

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

cURL

Least-cost routeRoute for one core server

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/routes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "route-destination-match-pattern": "sip:1800*@*",
    "description": "Toll-free outbound",
    "route-method": "cost"
}'

Response Example

200 - Route for one core server

The applied route.

{
    "route-destination-match-pattern": "sip:1800*@*",
    "route-source-match-pattern": "*",
    "route-class": "*",
    "route-match-server-hostname": "core1.example.com",
    "route-is-enabled": "yes",
    "description": "Toll-free outbound from core1",
    "route-method": "fixed",
    "route-id": "c2lwOjE4MDAqQCp8fCp8fCp8fGNvcmUxLmV4YW1wbGUuY29t"
}

Modified at 2026-10-30 21:27:34

Count route connections

Create route connection