api:pbx:app:action:hold
Table of Contents
API : PBX : APP : Action : Hold
Introduction
This request will put a call on hold or unhold it.
This is only supported on Mitel and Yealink SIP phones.
Request
| URL | https://api.telecomx.dk/pbx/app/action/hold | ||
|---|---|---|---|
| Method | GET | ||
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, ADMIN. | ||
| Query | device | ID | Id of device to trigger hold on. |
| target | String | Id of call to put on hold. | |
Request example
https://api.telecomx.dk/pbx/app/action/hold?device=12345678901234567890ABCD https://api.telecomx.dk/pbx/app/action/hold?device=12345678901234567890ABCD&target=pbx4.telecomx.dk:743897859789539834gwgu9e29ufhfdhhijf3
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | target | Target not found |
| 422 | device | Invalid device |
| 422 | device | Unsupported device |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/app/action/hold.txt · Last modified: 2020/07/07 11:24 by Per Møller