Create shared dial policy rule

POST

/dialpolicy/{policy}/permission

Last modified:2026-10-08 23:01:41

OperationId:CreatePermission

Adds a rule to a shared dial policy and publishes it over the service bus (SBUS). A rule matches a dialed destination in permission-match and either permits or denies the call (permission-mode). Requires Super User scope, because a shared policy changes dialing for every domain.

Send permission-match, permission-mode and permission-reason. In permission-match, ? matches one character and * matches any run of characters, as in sip:+1900???????@*. A 202 means the rule was published, not yet applied. Add synchronous=yes to wait up to 2 seconds for this server to show the rule: the answer is then 200 with the rule, or still 202.

A name with no shared policy answers 404. To add a rule to a domain's policy, use POST /domains/{domain}/dialpolicy/{policy}/permission.

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

Returned instead of 202 when synchronous=yes and the rule appeared within 2 seconds: the new rule.

Bodyapplication/json

🟢202Accepted

🟠404

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/dialpolicy//permission' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "permission-match": "sip:+1900???????@*",
    "permission-mode": "deny",
    "permission-reason": "Premium rate",
    "synchronous": "yes"
}'

Response Example

200 - Deny premium numbers

Answer to synchronous=yes.

{
    "dialpolicy": "US and Canada",
    "domain": "*",
    "permission-match": "sip:+1900???????@*",
    "permission-mode": "deny",
    "permission-reason": "Premium rate",
    "created-datetime": "2026-09-01T14:30:00Z",
    "permission-id": "c2lwOisxOTAwPz8_Pz8_P0Aq"
}

Modified at 2026-10-08 23:01:41

Update domain dial policy

Create domain dial policy rule