api:pbx:app:action:pickup
Table of Contents
API : PBX : APP : Action : Pickup
Introduction
This request will pickup a ringing phone from another extension.
Request
| URL | https://api.telecomx.dk/pbx/app/action/pickup | ||
|---|---|---|---|
| Method | GET | ||
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, ADMIN. | ||
| Query | device | Id | Id of device to pickup with. |
| target | Id/String | Extension id, phone number or call id to pickup. | |
Request example
https://api.telecomx.dk/pbx/app/action/pickup?device=12345678901234567890ABCD&target=12345678901234567890AAAA https://api.telecomx.dk/pbx/app/action/pickup?device=12345678901234567890ABCD&target=pbx3.telecomx.dk:12345678901234567890AAAA https://api.telecomx.dk/pbx/app/action/pickup?device=12345678901234567890ABCD&target=201
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | device | Invalid device |
| 422 | target | Invalid target |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/app/action/pickup.txt · Last modified: 2021/06/18 12:46 by Per Møller