api:pbx:extension:dnd
Table of Contents
API : PBX : Extension Phone DND
Introduction
Set or clear DND state for a phone associated with an extension. When in DND state the phone will never be called.
Request
| URL | https://api.telecomx.dk/pbx/extension/EXTENSION_ID/dnd | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL if extension belongs to the user VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | EXTENSION_ID | Id of the extension (24 hex-char string) |
| Query | sip | Id of SIP phone to set DND state for. |
| mvno | Id of MVNO phone to set DND state for. | |
| external | Id of EXTERNAL phone to set DND state for. | |
| state | [optional] True to enable, false to disable, omit to toggle. |
|
Only of one sip, mnvo and external can be set at a time.
Query examples
https://api.telecomx.dk/pbx/extension/1234567890ABCDEF12345678/dnd?sip=12345678901234567890AAAA&state=true https://api.telecomx.dk/pbx/extension/1234567890ABCDEF12345678/dnd?mvno=12345678901234567890AAAA&state=false https://api.telecomx.dk/pbx/extension/1234567890ABCDEF12345678/dnd?external=12345678901234567890AAAA
Response
| JSON object | ||
|---|---|---|
| dnd | Boolean | New DND state. |
Example
{ dnd: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in requestURI |
| 404 | not_found | Extension not found |
| 404 | sip | SIP phone not found |
| 404 | mvno | MVNO phone not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/extension/dnd.txt · Last modified: 2020/07/16 14:14 by Per Møller