diff options
| author | David M. Lee <dlee@digium.com> | 2013-07-03 17:58:45 +0000 |
|---|---|---|
| committer | David M. Lee <dlee@digium.com> | 2013-07-03 17:58:45 +0000 |
| commit | a75fd32212c35b41143442bd757387fad636177a (patch) | |
| tree | 461033acf36f4596d8fc9800a1195e12207b3ea2 /rest-api/api-docs/channels.json | |
| parent | c4adaf91067559dd5aa90577e181693abade0602 (diff) | |
ARI - channel recording support
This patch is the first step in adding recording support to the
Asterisk REST Interface.
Recordings are stored in /var/spool/recording. Since recordings may be
destructive (overwriting existing files), the API rejects attempts to
escape the recording directory (avoiding issues if someone attempts to
record to ../../lib/sounds/greeting, for example).
(closes issue ASTERISK-21594)
(closes issue ASTERISK-21581)
Review: https://reviewboard.asterisk.org/r/2612/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393550 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api/api-docs/channels.json')
| -rw-r--r-- | rest-api/api-docs/channels.json | 34 |
1 files changed, 27 insertions, 7 deletions
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index f013ef641..9900db739 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -565,7 +565,11 @@ "required": false, "allowMultiple": false, "dataType": "int", - "defaultValue": 0 + "defaultValue": 0, + "allowableValues": { + "valueType": "RANGE", + "min": 0 + } }, { "name": "maxSilenceSeconds", @@ -574,16 +578,28 @@ "required": false, "allowMultiple": false, "dataType": "int", - "defaultValue": 0 + "defaultValue": 0, + "allowableValues": { + "valueType": "RANGE", + "min": 0 + } }, { - "name": "append", - "description": "If true, and recording already exists, append to recording", + "name": "ifExists", + "description": "Action to take if a recording with the same name already exists.", "paramType": "query", "required": false, "allowMultiple": false, - "dataType": "boolean", - "defaultValue": false + "dataType": "string", + "defaultValue": "fail", + "allowableValues": { + "valueType": "LIST", + "values": [ + "fail", + "overwrite", + "append" + ] + } }, { "name": "beep", @@ -615,12 +631,16 @@ ], "errorResponses": [ { + "code": 400, + "reason": "Invalid parameters" + }, + { "code": 404, "reason": "Channel not found" }, { "code": 409, - "reason": "Channel is not in a Stasis application, or the channel is currently bridged with other channels." + "reason": "Channel is not in a Stasis application; the channel is currently bridged with other channels; A recording with the same name is currently in progress." } ] } |