Create dial plan with domain in body

POST

/dialplans

Last modified:2026-09-26 20:52:43

OperationId:CreateDialplanGlobal

Creates a dial plan for the domain named in the body. Requires Office Manager, Site Manager, Reseller, or Super User scope. A Reseller reaches only domains in its territory; every other scope reaches only its own domain.

Send domain and dial-rule-dial-plan, the plan name. dial-rule-description is optional and defaults to dialplan for <domain>. A domain of admin-only or * makes a platform-shared plan and needs Super User scope; any other scope gets 403. POST /dialplans/{dialplan} is the dedicated form for an admin-only plan. The response is 202: the change is published, not yet applied, so a read straight after it may not show the change yet.

POST /domains/{domain}/dialplans does the same with the domain in the path.

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

🟢202Accepted

application/json

The dial plan is published and applied within a few seconds.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/dialplans' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "example.com",
    "dial-rule-dial-plan": "Holiday Routing",
    "dial-rule-description": "Holiday routing for example.com"
}'

Response Example

202 - Create

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-09-26 20:52:43

List dial plans

Create dial plan in domain