Create dial rule in admin-only dial plan

Testing

POST

/dialplans/{dialplan}/dialrules

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

OperationId:CreateAdminOnlyDialrule

Creates a dial rule in an admin-only dial plan.

Send at least dial-rule-matching-to-uri and dial-rule-translation-destination-user. The dial plan comes from the path. The response is 202: the change is published and applied within a few seconds, so a read straight after it may not show the change yet. Send synchronous=yes to wait up to 2 seconds and get 200 with the created rule instead.

A rule with the same match fields already in the plan returns 409. To change a rule's match fields later, delete it and create a new one: PUT updates only the other fields.

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

Body Params application/json

Examples

Responses

🟢200OK

application/json

With synchronous=yes: the created rule, once applied.

Bodyapplication/json

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

cURL

CreateCreate and wait

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/dialplans/DID Table/dialrules' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dial-rule-matching-to-uri": "sip:15555550100@*",
    "dial-rule-application": "to-user",
    "dial-rule-translation-destination-user": "1001",
    "dial-rule-translation-destination-host": "example.com",
    "dial-rule-description": "Main line"
}'

Response Example

200 - Create and wait

{
    "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

List dial rules in admin-only dial plan

Count dial rules in admin-only dial plan