Read phone configuration file

Developing

GET

/phones/{mac}/config

Last modified:2026-10-03 07:30:56

OperationId:ReadPhoneConfigFile

Returns the configuration file the Endpoints server builds for this phone, the file the phone downloads when it boots. The body is the file itself, text/plain or text/xml depending on the model. Errors are the usual JSON error body.

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

Some phones cannot be read yet, because building the file would change the phone's provisioning state. The request returns 409 instead:

while the phone's one-time global password is armed (global-one-time-pass is yes), because reading the file would use it up

when the phone has no provisioning credentials yet and the server is set to generate them, because reading the file would create them

Both clear once the phone has provisioned.

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

This form takes no domain. The phone's own domain is used, and your token must be able to see it: a Reseller its territory, other domain scopes only their own domain.

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 configuration file, as text/plain or text/xml depending on the model. Content-Disposition names the file.

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/phones/00005e005301/config?file=poly-00005e005301.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-03 07:30:56

Read phone configuration file in domain

Count phones in domain