Read phone configuration file

Developing

GET

/domains/{domain}/phones/{mac}/config

Last modified:2026-10-02 20:50:55

OperationId:ReadPhoneConfigFileInDomain

Returns the provisioning file the endpoint provisioning (NDP) server renders for this phone — what the phone downloads at boot — so you can see exactly what it will be told.

The body is the file itself, text/plain or text/xml depending on the model, not JSON. Errors are the usual JSON error body.

Credentials are masked. Passwords, tokens and secrets in the file are shown masked (ab********yz), and so is any user:password@ in a URL. Usernames, line keys and every other setting are shown as rendered. A Super User can send include-secrets=yes to get the file unmasked; the reveal is audit-logged. Any other scope that sends it gets 403.

Some phones cannot be read yet. The provisioning server has no way to render a file without changing the phone's provisioning state, so the request is refused with 409 instead of reading:

while the phone's one-time global password is armed (global-one-time-pass is yes). Reading the file would use it up;

when the phone has no provisioning credentials yet and the server is set to generate them. Reading the file would create them.

Both clear once the phone has provisioned.

Access. Office Manager and above can read any phone in their domain, Reseller any phone in its territory, and Super User any phone. Site Manager can read phones whose line 1 belongs to a user at its own site. Basic User and the other user scopes can read only their own phone (the one whose line 1 they own). A phone you cannot see returns 404.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

text/plain

The phone's provisioning file, credentials masked unless include-secrets=yes.

Headers

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🔴502Bad Gateway

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/phones/482567306f13/config?file=poly-482567306f13.cfg&include-secrets=no' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success Example

account.1.enable = 1
account.1.user_name = 1001a
account.1.password = s3********99
account.1.sip_server.1.address = core1.example.com

Modified at 2026-10-02 20:50:55

Remove MAC address in Domain

Read phone configuration file (any domain)