...
GET | List all active bridges in Asterisk. | ||
POST | Create a new bridge. | ||
POST | Create a new bridge or updates an existing one. | ||
GET | Get bridge details. | ||
DELETE | void | Shut down a bridge. | |
POST | void | Add a channel to a bridge. | |
POST | void | Remove a channel from a bridge. | |
POST | void | Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. | |
DELETE | void | Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream. | |
POST | void | Play music on hold to a bridge or change the MOH class that is playing. | |
DELETE | void | Stop playing music on hold to a bridge. | |
POST | Start playback of media on a bridge. | ||
POST | Start playback of media on a bridge. | ||
POST | Start a recording. |
...
- 400 - Channel not found
- 404 - Bridge not found
- 409 - Bridge not in Stasis application
- 422 - Channel not in this bridge
| Anchor | ||||
|---|---|---|---|---|
|
setVideoSource: POST /bridges/{bridgeId}/videoSource/{channelId}
Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
- channelId: string - Channel's id
Error Responses
- 404 - Bridge or Channel not found
- 409 - Channel not in Stasis application
- 422 - Channel not in this Bridge
| Anchor | ||||
|---|---|---|---|---|
|
clearVideoSource: DELETE /bridges/{bridgeId}/videoSource
Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
Error Responses
- 404 - Bridge not found
| Anchor | ||||
|---|---|---|---|---|
|
startMoh: POST /bridges/{bridgeId}/moh
Play music on hold to a bridge or change the MOH class that is playing.
Path parameters
Parameters are case-sensitive.
...
- mohClass: string - Channel's id
Error Responses
- 404 - Bridge not found
- 409 - Bridge not in Stasis application
...
Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
Error Responses
- 404 - Bridge not found
- 409 - Bridge not in Stasis application
...
Start playback of media on a bridge. The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
Path parameters
Parameters are case-sensitive.
...
- media: string - (required) Media's URI to play.
- lang: string - For sounds, selects language for sound.
- offsetms: int - Number of media to skip before playing.
- Allowed range: Min: 0; Max: None
- skipms: int - Number of milliseconds to skip for forward/reverse operations.
- Default: 3000
- Allowed range: Min: 0; Max: None
- playbackId: string - Playback Id.
Error Responses
- 404 - Bridge not found
- 409 - Bridge not in a Stasis application
...
Start playback of media on a bridge. The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
Path parameters
Parameters are case-sensitive.
...
- media: string - (required) Media's URI to play.
- lang: string - For sounds, selects language for sound.
- offsetms: int - Number of media to skip before playing.
- Allowed range: Min: 0; Max: None
- skipms: int - Number of milliseconds to skip for forward/reverse operations.
- Default: 3000
- Allowed range: Min: 0; Max: None
Error Responses
- 404 - Bridge not found
- 409 - Bridge not in a Stasis application
...
Start a recording. This records the mixed audio from all channels participating in this bridge.
Path parameters
Parameters are case-sensitive.
...
- name: string - (required) Recording's filename
- format: string - (required) Format to encode audio in
- maxDurationSeconds: int - Maximum duration of the recording, in seconds. 0 for no limit.
- Allowed range: Min: 0; Max: None
- maxSilenceSeconds: int - Maximum duration of silence, in seconds. 0 for no limit.
- Allowed range: Min: 0; Max: None
- ifExists: string - Action to take if a recording with the same name already exists.
- Default: fail
- Allowed values: fail, overwrite, append
- beep: boolean - Play beep when recording begins
- terminateOn: string - DTMF input to terminate recording.
- Default: none
- Allowed values: none, any, *, #
Error Responses
- 400 - Invalid parameters
- 404 - Bridge not found
- 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
- 422 - The format specified is unknown on this system