1. Telebroad | Support Center
  2. Solution home
  3. Legacy API Documentation
  4. REST API - PUT Requests
Open navigation

PUT/phone/dnd (Legacy)

   Articles in this support section discuss Telebroad's legacy APIs. To learn about the current version of Telebroad APIs, which offer additional authentication options and support for advanced features, please go to https://developers.telebroad.com/.



With the PUT/phone/dnd request you can activate or deactivate the Do Not Disturb status on the Teleconsole and any physical phone that is associated with it. When DND status is activated, calls will go directly to voicemail.

 

If you are using the web version of the Teleconsole, please refresh your browser to see the DND status change.


Parameters


All parameters go in the request body in JSON Raw format.


ParameterTypeOperation
activeBooleanA value of 1 will activate the DND status on the Teleconsole.

A value of 0 will deactivate the DND status on the Teleconsole.
phonesstringThe phone lines to set the DND status for. Leave empty to set the status for all phones of the user, or specify one or several lines separated by a comma.

Example


To activate the Do Not Disturb status for phone line 124380 use the following syntax:


HTTPS method: PUT


Header


webserv.telebroad.com/api/teleconsole/rest/phone/dnd


Body


{"active":"1", "phones":"124380"}


Response:


A "null" error indicates a successful change of status. 


{

    "error": null,

    "result": "true"

}