diff options
| author | Jonathan Rose <jrose@digium.com> | 2013-07-19 19:40:27 +0000 |
|---|---|---|
| committer | Jonathan Rose <jrose@digium.com> | 2013-07-19 19:40:27 +0000 |
| commit | a6329a3acf0109d5b364476d212cd0aee4c20dfb (patch) | |
| tree | b0bac64d5dbe5ceb2ea2d32227c5b79349b38228 /rest-api | |
| parent | 17c546173fe1f24749af4643f19b40be180803de (diff) | |
ARI: MOH start and stop for a channel
(issue ASTERISK-21974)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2680/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@394810 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/channels.json | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index 69e905875..e54b02772 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -464,6 +464,79 @@ ] }, { + "path": "/channels/{channelId}/mohstart", + "description": "Play music on hold to a channel", + "operations": [ + { + "httpMethod": "POST", + "summary": "Play music on hold to a channel.", + "notes": "Using media operations such as playOnChannel on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.", + "nickname": "mohStartChannel", + "responseClass": "void", + "parameters": [ + { + "name": "channelId", + "description": "Channel's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + }, + { + "name": "mohClass", + "description": "Music on hold class to use", + "paramType": "query", + "required": false, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Channel not found" + }, + { + "code": 409, + "reason": "Channel not in a Stasis application" + } + ] + } + ] + }, + { + "path": "/channels/{channelId}/mohstop", + "description": "Stop playing music on hold to a channel", + "operations": [ + { + "httpMethod": "POST", + "summary": "Stop playing music on hold to a channel.", + "nickname": "mohStopChannel", + "responseClass": "void", + "parameters": [ + { + "name": "channelId", + "description": "Channel's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Channel not found" + }, + { + "code": 409, + "reason": "Channel not in a Stasis application" + } + ] + } + ] + }, + { "path": "/channels/{channelId}/play", "description": "Play media to a channel", "operations": [ |