api:pbx:audio:delete
Table of Contents
API : PBX: Audio Delete
Introduction
This request will delete the specified audio item.
Request
| URL | https://api.telecomx.dk/pbx/audio/AUDIO_ID | |
|---|---|---|
| Method | DELETE | |
| Access level | PERSONAL if audio belongs to the user MANAGER, OWNER, RESELLER, ADMIN. |
|
| Param | AUDIO_ID | Id of the audio item (24 hex-char string) |
| Query | force | [optional] True to delete audio even if it is currently in use (ADMIN only). |
| ignore | [optional] Id of dialplan item using it. If this is set and it is the only one using the audio, then it is deleted, assuming that the dialplan item will no longer reference it. |
|
Query example
DELETE https://api.telecomx.dk/pbx/audio/1234567890ABCDEF12345678 DELETE https://api.telecomx.dk/pbx/audio/1234567890ABCDEF12345678?force=true DELETE https://api.telecomx.dk/pbx/audio/1234567890ABCDEF12345678?ignore=12345678901234567890DDDD
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Audio not found |
| 409 | usedBy | Audio is in use |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/audio/delete.txt · Last modified: 2019/06/26 12:23 by Per Møller