Update phone

Changes a phone, found by device-provisioning-mac-address in the body. Send only the fields to change. When you change a line and leave out device-models-brand-and-model, the phone keeps its stored model. A line you assign is enabled unless you send its device-provisioning-line-N-enabled. Setting device-provisioning-line-N-enabled to no on line 1 or 2 clears that line's extension.

Requires Office Manager, Reseller, or Super User scope. Site Manager can change a phone whose line 1 belongs to a user in its site, and hand line 1 only to a user in its site. Basic User and the other user scopes can change only their own phone, the one whose line 1 they own. Another user's phone, a phone with nobody on line 1, or giving line 1 to someone else returns 403. A phone in a domain your token cannot reach returns 404. Super User can change any phone.

The response is 202: the change is accepted and applied shortly after. created-datetime never changes. Every change clears device-provisioning-last-retrieved-datetime until the phone downloads its configuration again. device-provisioning-password as returned by a read is masked. Sending that masked value back keeps the stored password. A soft phone model (Manual or Softphone) returns 400.

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. Changing domain moves the phone and every line on it: you need access to the target domain (a Reseller, a domain in its own reseller; other scopes, their own domain), or the request returns 403.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/phones' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "device-provisioning-mac-address": "00005e005301", "device-provisioning-sip-uri-2": "sip:1002a@example.com", "device-provisioning-sip-transport-protocol": "tls", "notes": "Front Desk, second line added" }'

Request

Responses