diff options
| author | Jonathan Rose <jrose@digium.com> | 2013-08-23 00:26:19 +0000 |
|---|---|---|
| committer | Jonathan Rose <jrose@digium.com> | 2013-08-23 00:26:19 +0000 |
| commit | 21e22310c72f0c863f73dde8c31208cfdfa5aa3c (patch) | |
| tree | 5945e2a28d0b42b3abe354e53d79a08c3d8b0450 /rest-api | |
| parent | c25c093c676b27f9eaf9847cfeeda8e8cdc46d46 (diff) | |
ARI: Music on Hold/Background Music for bridges
Adds ARI functions to be able to turn on/off music on hold in a
bridge. It actually functions more as a background music without
further actions on the bridge since if the rest of the channels
in the bridge aren't explicitly muted, they will still be able
to communicate.
(closes issue ASTERISK-21974)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2688/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397505 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/bridges.json | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json index 940ed0aed..b698dcfeb 100644 --- a/rest-api/api-docs/bridges.json +++ b/rest-api/api-docs/bridges.json @@ -177,6 +177,79 @@ ] }, { + "path": "/bridges/{bridgeId}/mohStart", + "description": "Play music on hold to a bridge", + "operations": [ + { + "httpMethod": "POST", + "summary": "Play music on hold to a bridge or change the MOH class that is playing.", + "nickname": "mohStartBridge", + "responseClass": "void", + "parameters": [ + { + "name": "bridgeId", + "description": "Bridge's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + }, + { + "name": "mohClass", + "description": "Channel's id", + "paramType": "query", + "required": false, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Bridge not found" + }, + { + "code": 409, + "reason": "Bridge not in Stasis application" + } + ] + } + ] + }, + { + "path": "/bridges/{bridgeId}/mohStop", + "description": "Stop music on hold for a bridge", + "operations": [ + { + "httpMethod": "POST", + "summary": "Stop playing music on hold to a bridge.", + "notes": "This will only stop music on hold being played via bridges/{bridgeId}/mohStart.", + "nickname": "mohStopBridge", + "responseClass": "void", + "parameters": [ + { + "name": "bridgeId", + "description": "Bridge's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Bridge not found" + }, + { + "code": 409, + "reason": "Bridge not in Stasis application" + } + ] + } + ] + }, + { "path": "/bridges/{bridgeId}/play", "description": "Play media to the participants of a bridge", "operations": [ |