List dial rule summaries in admin-only dial plan

Testing

GET

/dialplans/{dialplan}/dialrules/list

Last modified:2026-09-26 06:31:30

OperationId:ListAdminOnlyDialruleSummaries

Returns the dial rules in an admin-only 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. Takes the same filters and paging as the full 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

🟢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/dialplans/DID Table/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=0&limit=100' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success Example

{
    "dialrule": "c2lwOjYxMUAq",
    "dial-rule-matching-to-uri": "sip:611@*",
    "dial-rule-description": "611 - Customer Service Direct Dial",
    "dial-rule-dial-plan": "DID Table",
    "dial-rule-translation-destination-user": "2500",
    "domain": "admin-only"
}

Modified at 2026-09-26 06:31:30

List dial plan summaries

Read Policies