Read dial plan

GET

/domains/{domain}/dialplans/{dialplan}

Last modified:2026-10-30 21:30:53

OperationId:ReadDialplanForDomain

Returns the named dial plan when the domain can use it: a plan the domain owns, or a platform-shared plan. Requires Office Manager, Site Manager, Reseller, or Super User scope; a Reseller reaches only domains in its territory.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200Success

application/json

The dial plan, as an array like GET /domains/{domain}/dialplans returns. A plan the domain cannot use, or one that does not exist, returns [].

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//dialplans/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success Example

{
    "domain": "example.com",
    "dial-rule-dial-plan": "example.com",
    "dial-rule-description": "dialplan for example.com"
}

Modified at 2026-10-30 21:30:53

Count dial plans in domain

List dial plan summaries