List dial rules in admin-only dial plan

Testing

GET

/dialplans/{dialplan}/dialrules

Last modified:2026-09-26 06:29:39

OperationId:ReadAdminOnlyDialrules

Returns the dial rules in an admin-only dial plan, up to limit at a time (100 by default).

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.

This is the admin-only form of the endpoint, for the platform-shared dial plans whose domain is admin-only. Requires Super User scope. Super User Read Only can use GET; every other scope gets 403. The server sets domain to admin-only itself. For a plan that belongs to a domain, use the /domains/{domain}/dialplans/... form.

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

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/dialplans/DID Table/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=0&limit=100' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Dial rules

[
    {
        "domain": "admin-only",
        "dial-rule-dial-plan": "DID Table",
        "dial-rule-matching-to-uri": "sip:15555550100@*",
        "dialrule": "c2lwOjE1NTU1NTUwMTAwQCo",
        "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-user",
        "dial-rule-parameter": "",
        "dial-rule-translation-destination-scheme": "sip:",
        "dial-rule-translation-destination-user": "1001",
        "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": "Main line"
    }
]

Modified at 2026-09-26 06:29:39

Delete admin-only dial plan

Create dial rule in admin-only dial plan