Bridges
Method Path | Path<br>h5. Parameters are case-sensitive | Return Model | Summary |
|---|
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 | 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. |
...
Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Unique ID to give to the bridge being created.
...
Get bridge details.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...
Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...
Add a channel to a bridge.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...
Remove a channel from a bridge.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...
Play music on hold to a bridge or change the MOH class that is playing.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...
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
...
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.
- bridgeId: string - Bridge's id
...
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.
- bridgeId: string - Bridge's id
- playbackId: string - Playback ID.
...
Start a recording. This records the mixed audio from all channels participating in this bridge.
Path parameters
Parameters are case-sensitive.
- bridgeId: string - Bridge's id
...