List dial rules in dial plan

GET

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

Last modified:2026-10-08 22:59:10

OperationId:ReadDialrules

Returns the dial rules in a dial plan, up to limit at a time (100 by default). 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.

Filter with the query parameters below. dial-rule-application and dial-rule-description match with SQL LIKE, so % is a wildcard; the others match exactly. Each rule carries a dialrule id to read, update, or delete it with.

For the total, call /dialrules/count with the same filters. For only the identifying fields of each rule, call /dialrules/list.

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

🟢200OK

application/json

The matching dial rules.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//dialplans//dialrules?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 rules

[
    {
        "domain": "example.com",
        "dial-rule-dial-plan": "example.com",
        "dial-rule-matching-to-uri": "sip:611@*",
        "dialrule": "c2lwOjYxMUAq",
        "enabled": "yes",
        "dial-rule-matching-from-uri": "*",
        "dial-rule-matching-day-of-week": "*",
        "dial-rule-matching-start-date": "*",
        "dial-rule-matching-end-date": "*",
        "dial-rule-matching-start-time": "*",
        "dial-rule-matching-end-time": "*",
        "dial-rule-application": "to-callqueue",
        "dial-rule-parameter": "",
        "dial-rule-translation-destination-scheme": "sip:",
        "dial-rule-translation-destination-user": "2500",
        "dial-rule-translation-destination-host": "example.com",
        "dial-rule-translation-source-name": "[*]",
        "dial-rule-translation-source-scheme": "[*]",
        "dial-rule-translation-source-user": "[*]",
        "dial-rule-translation-source-host": "[*]",
        "dial-rule-description": "611 - Customer Service Direct Dial"
    }
]

Modified at 2026-10-08 22:59:10

List answer rule summaries

Create dial rule