Create phone number

POST

/domains/{domain}/phonenumbers

Last modified:2026-10-08 23:04:49

OperationId:CreatePhonenumber

Adds a phone number to the domain and sets where calls to it go. Scopes below Reseller add numbers only to their own domain, a Reseller only to domains in its territory, and a Super User to any domain.

Send phonenumber and dial-rule-translation-destination-user. To keep a number in the domain without routing it, use dial-rule-application available-number with [*] as the destination user and host. Any sms-* field also creates an SMS assignment for the number. A number that already has an SMS assignment but no dial rule gets its dial rule.

A 202 means the change is accepted and applied shortly after, so a read made right away can still show the old values. Read the number back to confirm it. A number already in the DID table answers 409, even when another domain holds it. Each domain keeps its numbers in the dial plan its inventory.did-table setting names, DID Table unless the domain changes it.

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

🟢202Accepted

application/json

The number is accepted and created shortly after this response.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠420Rate Limit Exceeded

Request Example

Shell

JavaScript

Java

Swift

cURL

Route to a userRoute to a user with SMSKeep available

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//phonenumbers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "phonenumber": "15555550123",
    "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

202 - Route to a user

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-08 23:04:49

List phone numbers

Count phone numbers