List dial rule summaries in dial plan

GET

/domains/{domain}/dialplans/{dialplan}/dialrules/list

Last modified:2026-10-08 23:00:12

OperationId:ListDialPlanDialRules

Returns the dial rules in a dial plan with only their identifying fields: dialrule, dial-rule-matching-to-uri, dial-rule-translation-destination-user, dial-rule-dial-plan, dial-rule-description, and domain. Requires Basic User, Site Manager, Office Manager, Reseller, or Super User scope, and Super User Read Only can read. A Reseller reaches only domains in its territory; every other scope reaches only its own domain.

Takes the same filters as the full list. Unlike the full list, it has no default limit: without one it returns every matching rule. Use it to fill a picker, then read a single rule for its full routing.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200Success

application/json

The matching dial rules, reduced to their identifying fields.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//dialplans//dialrules/list?dial-rule-matching-to-uri=sip%3A611%40*&dial-rule-matching-from-uri=*&dial-rule-application=to-callqueue%&dial-rule-parameter=&dial-rule-translation-destination-user=2500&dial-rule-description=%support%&start=undefined&limit=100' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Dial rule summaries

[
    {
        "dialrule": "c2lwOjYxMUAq",
        "dial-rule-matching-to-uri": "sip:611@*",
        "dial-rule-description": "611 - Customer Service Direct Dial",
        "dial-rule-dial-plan": "example.com",
        "dial-rule-translation-destination-user": "2500",
        "domain": "example.com"
    }
]

Modified at 2026-10-08 23:00:12

Count dial plans

Read admin-only dial plan