Add phone in domain

POST

/domains/{domain}/phones

Last modified:2026-10-08 23:10:42

OperationId:CreatePhoneInDomain

Adds a phone to the domain's inventory on the Endpoints server by MAC address, so it can download its configuration. Send device-provisioning-mac-address and device-models-brand-and-model. The MAC address can use :, -, or . separators, and is stored as 12 bare hex digits. Assign lines with device-provisioning-sip-uri-1 to device-provisioning-sip-uri-8. A line you assign is enabled unless you send its device-provisioning-line-N-enabled. The user who owns line 1 is the phone's user. The domain comes from the path.

Requires Site Manager, Office Manager, Reseller, or Super User scope. Site Manager can put only a device of a user in its site on line 1. Basic User and the other user scopes can add a phone only with their own device on line 1.

The response is 202: the phone is accepted and added shortly after. A MAC address that already exists in any domain returns 409. A soft phone model (Manual or Softphone) or a blank model returns 400, because there is nothing to provision. For Yealink, Polycom, Snom, Fanvil, Grandstream, and Htek phones, the MAC address is also registered with the vendor's zero-touch provisioning service when the platform has one configured.

Every line (device-provisioning-sip-uri-1 and up) must be a device in the phone's own domain. Line 1 must also belong to a user you may act for; lines 2 and up can be any device in the domain, for shared or monitored lines. A line from another domain returns 400.

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 phone is accepted and added shortly after.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

🟠409Conflict

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

cURL

Phone with line 1Separated MAC address

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//phones' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device-provisioning-mac-address": "00005e005301",
    "device-models-brand-and-model": "Yealink T54W",
    "device-provisioning-sip-uri-1": "sip:1001a@example.com",
    "device-provisioning-sip-transport-protocol": "udp",
    "notes": "Front Desk"
}'

Response Example

202 - Phone with line 1

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

Modified at 2026-10-08 23:10:42

Add phone

Update phone