Create route connection

POST

/routes/{route-id}/routecon

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

OperationId:CreateRouteConnection

Adds a route connection, one next hop, to the route that route-id names. 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.

route-connection-translation-destination-host is required and cannot be blank. route-connection-ordinal-index defaults to one more than the route's highest index, so the first connection gets 1. route-connection-translation-destination-user defaults to [*]. The 4 match fields come from route-id, and any in the body are ignored. The API does not check that the route exists or that the index is free.

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 every connection of the route. If it is not applied in time, you get the usual 202 and the write still completes.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned for synchronous=yes once the connection is applied: every connection of the route.

Bodyapplication/json

🟢202Accepted

🟠404

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

cURL

Next indexChosen index

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/routes/c2lwOjE4MDAqQCo/routecon' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "route-connection-translation-destination-host": "carrier1.example.com",
    "route-connection-integer-percentage": 60,
    "route-connection-integer-cost": 0
}'

Response Example

200 - Chosen index

The route's connections after the write.

[
    {
        "route-destination-match-pattern": "sip:1800*@*",
        "route-source-match-pattern": "*",
        "route-class": "*",
        "route-match-server-hostname": "*",
        "route-connection-ordinal-index": 1,
        "route-connection-translation-destination-user": "[*]",
        "route-connection-translation-destination-host": "carrier1.example.com",
        "route-connection-integer-percentage": 60,
        "route-connection-integer-cost": 0
    },
    {
        "route-destination-match-pattern": "sip:1800*@*",
        "route-source-match-pattern": "*",
        "route-class": "*",
        "route-match-server-hostname": "*",
        "route-connection-ordinal-index": 2,
        "route-connection-translation-destination-user": "[*]",
        "route-connection-translation-destination-host": "carrier2.example.com",
        "route-connection-integer-percentage": 40,
        "route-connection-integer-cost": 0
    }
]

Modified at 2026-09-26 18:05:10

Create route

Update route