Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update to GIT-13-3135a74

...

GET

/bridges

List[Bridge]

List all active bridges in Asterisk.

POST

/bridges

Bridge

Create a new bridge.

POST

/bridges/{bridgeId}

Bridge

Create a new bridge or updates an existing one.

GET

/bridges/{bridgeId}

Bridge

Get bridge details.

DELETE

/bridges/{bridgeId}

void

Shut down a bridge.

POST

/bridges/{bridgeId}/addChannel

void

Add a channel to a bridge.

POST

/bridges/{bridgeId}/removeChannel

void

Remove a channel from a bridge.

POST

/bridges/{bridgeId}/videoSource/{channelId}

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

/bridges/{bridgeId}/videoSource

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

/bridges/{bridgeId}/moh

void

Play music on hold to a bridge or change the MOH class that is playing.

DELETE

/bridges/{bridgeId}/moh

void

Stop playing music on hold to a bridge.

POST

/bridges/{bridgeId}/play

Playback

Start playback of media on a bridge.

POST

/bridges/{bridgeId}/play/{playbackId}

Playback

Start playback of media on a bridge.

POST

/bridges/{bridgeId}/record

LiveRecording

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
setVideoSource

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
clearVideoSource

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
startMoh

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