diff options
| author | Matt Jordan <mjordan@digium.com> | 2016-05-18 06:19:58 -0500 |
|---|---|---|
| committer | Matt Jordan <mjordan@digium.com> | 2016-05-20 09:06:12 -0500 |
| commit | e773e3a9bbaf378d53647e4bac3ffcd61afb4ae6 (patch) | |
| tree | 23e75dcdaf9b8c72a23387bfabdd42f643e5c480 /rest-api | |
| parent | d4b77dad1b0154eb3b89133d941dd8d624deda54 (diff) | |
ARI: Add the ability to download the media associated with a stored recording
This patch adds a new feature to ARI that allows a client to download
the media associated with a stored recording. The new route is
/recordings/stored/{name}/file, and transmits the underlying binary file
using Asterisk's HTTP server's underlying file transfer facilities.
Because this REST route returns non-JSON, a few small enhancements had
to be made to the Python Swagger generation code, as well as the
mustache templates that generate the ARI bindings.
ASTERISK-26042 #close
Change-Id: I49ec5c4afdec30bb665d9c977ab423b5387e0181
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/recordings.json | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/rest-api/api-docs/recordings.json b/rest-api/api-docs/recordings.json index 51f0a21f4..d173ac98e 100644 --- a/rest-api/api-docs/recordings.json +++ b/rest-api/api-docs/recordings.json @@ -70,6 +70,38 @@ ] }, { + "path": "/recordings/stored/{recordingName}/file", + "description": "The actual file associated with the stored recording", + "operations": [ + { + "httpMethod": "GET", + "summary": "Get the file associated with the stored recording.", + "nickname": "getStoredFile", + "responseClass": "binary", + "parameters": [ + { + "name": "recordingName", + "description": "The name of the recording", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 403, + "reason": "The recording file could not be opened" + }, + { + "code": 404, + "reason": "Recording not found" + } + ] + } + ] + }, + { "path": "/recordings/stored/{recordingName}/copy", "description": "Copy an individual recording", "operations": [ |