OSTIP_EXARI

v0.1.0

OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsbridgesFormat View Source

API calls for all endpoints tagged ApiDocsbridgesFormat.

Link to this section Summary

Functions

add_channel(connection, bridge_id, channel, opts \\ [])

Add a channel to a bridge

create(connection, opts \\ [])

Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down

create_with_id(connection, bridge_id, opts \\ [])

Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down

destroy(connection, bridge_id, opts \\ [])

Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand

get(connection, bridge_id, opts \\ [])

Get bridge details

list(connection, opts \\ [])

List all active bridges in Asterisk

play(connection, bridge_id, media, opts \\ [])

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.)

play_with_id(connection, bridge_id, playback_id, media, opts \\ [])

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.)

record(connection, bridge_id, name, format, opts \\ [])

Start a recording. This records the mixed audio from all channels participating in this bridge

remove_channel(connection, bridge_id, channel, opts \\ [])

Remove a channel from a bridge

start_moh(connection, bridge_id, opts \\ [])

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

stop_moh(connection, bridge_id, opts \\ [])

Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh

Link to this section Functions

Link to this function add_channel(connection, bridge_id, channel, opts \\ []) View Source 
add_channel(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Add a channel to a bridge.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • channel ([String.t]): Ids of channels to add to bridge

  • opts (KeywordList): [optional] Optional parameters

    • :role (String.t): Channel's role in the bridge

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function create(connection, opts \\ []) View Source 
create(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters

  • connection (Swagger.Client.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :type (String.t): Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
    • :bridge_id (String.t): Unique ID to give to the bridge being created.
    • :name (String.t): Name to give to the bridge being created.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function create_with_id(connection, bridge_id, opts \\ []) View Source 
create_with_id(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Unique ID to give to the bridge being created.

  • opts (KeywordList): [optional] Optional parameters

    • :type (String.t): Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
    • :name (String.t): Set the name of the bridge.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function destroy(connection, bridge_id, opts \\ []) View Source 
destroy(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function get(connection, bridge_id, opts \\ []) View Source 
get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get bridge details.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function list(connection, opts \\ []) View Source 
list(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all active bridges in Asterisk.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function play(connection, bridge_id, media, opts \\ []) View Source 
play(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

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.)

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • media ([String.t]): Media URIs to play.

  • opts (KeywordList): [optional] Optional parameters

    • :lang (String.t): For sounds, selects language for sound.
    • :offsetms (integer()): Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.
    • :skipms (integer()): Number of milliseconds to skip for forward/reverse operations.
    • :playback_id (String.t): Playback Id.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function play_with_id(connection, bridge_id, playback_id, media, opts \\ []) View Source 
play_with_id(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  [String.t()],
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

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.)

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • playback_id (String.t): Playback ID.
  • media ([String.t]): Media URIs to play.

  • opts (KeywordList): [optional] Optional parameters

    • :lang (String.t): For sounds, selects language for sound.
    • :offsetms (integer()): Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.
    • :skipms (integer()): Number of milliseconds to skip for forward/reverse operations.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function record(connection, bridge_id, name, format, opts \\ []) View Source 
record(Tesla.Env.client(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Start a recording. This records the mixed audio from all channels participating in this bridge.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • name (String.t): Recording's filename
  • format (String.t): Format to encode audio in

  • opts (KeywordList): [optional] Optional parameters

    • :max_duration_seconds (integer()): Maximum duration of the recording, in seconds. 0 for no limit.
    • :max_silence_seconds (integer()): Maximum duration of silence, in seconds. 0 for no limit.
    • :if_exists (String.t): Action to take if a recording with the same name already exists.
    • :beep (boolean()): Play beep when recording begins
    • :terminate_on (String.t): DTMF input to terminate recording.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function remove_channel(connection, bridge_id, channel, opts \\ []) View Source 
remove_channel(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Remove a channel from a bridge.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • channel ([String.t]): Ids of channels to remove from bridge
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function start_moh(connection, bridge_id, opts \\ []) View Source 
start_moh(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id

  • opts (KeywordList): [optional] Optional parameters

    • :moh_class (String.t): Channel's id

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function stop_moh(connection, bridge_id, opts \\ []) View Source 
stop_moh(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • bridge_id (String.t): Bridge's id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure