api:pbx:audio:callandplay
Table of Contents
API : PBX : Audio Call And Play
Introduction
This request will call a specified phone number, when answered play an audio item, and then hangup.
Request
| URL | https://api.telecomx.dk/pbx/audio/callandplay | ||
|---|---|---|---|
| Method | GET | ||
| Access level | MANAGER or OWNER if user belongs to the customer that owns the sound. RESELLER if customer belongs to the reseller. ADMIN. |
||
| Body | number | String | Phone number to call, E.164 formatting. |
| customer | Id | [optional] Id of customer the audio belongs to, defaults to the users own customer. |
|
| audio | Id | Id of the audio item to play. | |
| name | String | [optional] From name - displayed on SIP devices. |
|
| from | String | [optional] From number. If not set, the PBX's default number is presented. |
|
Request body example
https://api.telecomx.dk/pbx/audio/callandplay?number=%2B4570305050&customer=1234578901234567890ABCD&audio=12345678901234567890AAAA&name=Firealarm&from=%2B4580808080
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success. |
Example
{ succes: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | customer | Customer not found |
| 404 | number | Number not found |
| 404 | audio | Audio not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/audio/callandplay.txt · Last modified: 2019/02/21 10:27 by Per Møller