Create route

POST

/routes

Last modified:2026-09-26 18:05:06

OperationId:CreateRoute

Adds a call route to route_config. Routes apply to the whole platform. Requires Super User scope. Other scopes, Reseller included, get 403. The API publishes the change on the service bus (SBUS) NmsRoute channel, and core applies it when the event arrives, so 202 means published, not applied.

Only route-destination-match-pattern is required. route-source-match-pattern, route-class, and route-match-server-hostname default to *, route-is-enabled to yes, and route-method to fixed. Those 4 match fields identify the route, and route-id encodes them. The API does not check for an existing route with the same 4 values.

Send synchronous=yes, in the body or the query string, to wait up to 2 seconds for the change to be applied. You then get 200 with the route and its route-id. If it is not applied in time, you get the usual 202 and the write still completes.

Add the route's next hops 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 once the route is applied: the route, with its route-id.

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-09-26 18:05:06

Count route connections

Create route connection