Create dial rule

POST

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

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

OperationId:CreateDialrule

Creates a dial rule in a dial plan. Requires Basic User, Site Manager, Office Manager, Reseller, or Super User scope. A Reseller reaches only domains in its territory; every other scope reaches only its own domain.

Send at least dial-rule-matching-to-uri and dial-rule-translation-destination-user. The dial plan and domain come from the path. The response is 202: the change is published, not yet applied, 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.

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

🟠404

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

cURL

CreateCreate and wait

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//dialplans//dialrules' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dial-rule-matching-to-uri": "sip:611@*",
    "dial-rule-application": "to-callqueue",
    "dial-rule-translation-destination-user": "2500",
    "dial-rule-translation-destination-host": "example.com",
    "dial-rule-description": "611 - Customer Service Direct Dial"
}'

Response Example

200 - Create and wait

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

List dial rules in dial plan

Count dial rules in dial plan