api:pbx:recording:ondemand
Table of Contents
API : PBX : Recording On Demand
Request
This request will start/stop/toggle recording of ongoing calls on an extension that belongs to the employee.
| URL | https://api.telecomx.dk/pbx/recording/ondemand | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER or ADMIN. | |
| Query | extension | Id of the extension the call is on (24 hex-char string). |
| mode | Action to perform: ENABLE - start recording DISABLE - stop recording TOGGLE - toggle current state |
|
Query examples
https://api.telecomx.dk/pbx/recording/ondemand?extension=1234578901234567890ABCD&mode=ENABLE https://api.telecomx.dk/pbx/recording/ondemand?extension=1234578901234567890ABCD&mode=TOGGLE
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success |
| mode | String | The mode that was sucessfully invoked: ENABLE or DISABLE |
Example
{ "success": true, "mode": "ENABLE" }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | calls | No ongoing calls found |
| 409 | calls | Not currently recording |
| 403 | mode | Wrong recording mode |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/recording/ondemand.txt · Last modified: 2019/11/18 08:07 by Per Møller