swagger_client.BridgesApi

All URIs are relative to http://localhost:8088/ari

Method	HTTP request	Description
bridges_bridge_id_add_channel_post	POST /bridges/{bridgeId}/addChannel	Add a channel to a bridge.
bridges_bridge_id_delete	DELETE /bridges/{bridgeId}	Shut down a bridge.
bridges_bridge_id_get	GET /bridges/{bridgeId}	Get bridge details.
bridges_bridge_id_moh_delete	DELETE /bridges/{bridgeId}/moh	Stop playing music on hold to a bridge.
bridges_bridge_id_moh_post	POST /bridges/{bridgeId}/moh	Play music on hold to a bridge or change the MOH class that is playing.
bridges_bridge_id_play_playback_id_post	POST /bridges/{bridgeId}/play/{playbackId}	Start playback of media on a bridge.
bridges_bridge_id_play_post	POST /bridges/{bridgeId}/play	Start playback of media on a bridge.
bridges_bridge_id_post	POST /bridges/{bridgeId}	Create a new bridge or updates an existing one.
bridges_bridge_id_record_post	POST /bridges/{bridgeId}/record	Start a recording.
bridges_bridge_id_remove_channel_post	POST /bridges/{bridgeId}/removeChannel	Remove a channel from a bridge.
bridges_bridge_id_variable_get	GET /bridges/{bridgeId}/variable	Get the value of a bridge variable or function.
bridges_bridge_id_variable_post	POST /bridges/{bridgeId}/variable	Set the value of a bridge variable or function.
bridges_bridge_id_video_source_channel_id_post	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.
bridges_bridge_id_video_source_delete	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.
bridges_get	GET /bridges	List all active bridges in Asterisk.
bridges_post	POST /bridges	Create a new bridge.

bridges_bridge_id_add_channel_post

bridges_bridge_id_add_channel_post(bridge_id, channel, role=role, absorb_dtmf=absorb_dtmf, mute=mute)

Add a channel to a bridge.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
channel = ['channel_example'] # list[str] | Ids of channels to add to bridge
role = 'role_example' # str | Channel's role in the bridge (optional)
absorb_dtmf = false # bool | Absorb DTMF coming from this channel, preventing it to pass through to the bridge (optional) (default to false)
mute = false # bool | Mute audio from this channel, preventing it to pass through to the bridge (optional) (default to false)

try:
    # Add a channel to a bridge.
    api_instance.bridges_bridge_id_add_channel_post(bridge_id, channel, role=role, absorb_dtmf=absorb_dtmf, mute=mute)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_add_channel_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
channel	list[str]	Ids of channels to add to bridge
role	str	Channel's role in the bridge	[optional]
absorb_dtmf	bool	Absorb DTMF coming from this channel, preventing it to pass through to the bridge	[optional] [default to false]
mute	bool	Mute audio from this channel, preventing it to pass through to the bridge	[optional] [default to false]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_delete

bridges_bridge_id_delete(bridge_id)

Shut down a bridge.

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id

try:
    # Shut down a bridge.
    api_instance.bridges_bridge_id_delete(bridge_id)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_get

Bridge bridges_bridge_id_get(bridge_id)

Get bridge details.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id

try:
    # Get bridge details.
    api_response = api_instance.bridges_bridge_id_get(bridge_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id

Return type

Bridge

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_moh_delete

bridges_bridge_id_moh_delete(bridge_id)

Stop playing music on hold to a bridge.

This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id

try:
    # Stop playing music on hold to a bridge.
    api_instance.bridges_bridge_id_moh_delete(bridge_id)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_moh_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_moh_post

bridges_bridge_id_moh_post(bridge_id, moh_class=moh_class)

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
moh_class = 'moh_class_example' # str | Channel's id (optional)

try:
    # Play music on hold to a bridge or change the MOH class that is playing.
    api_instance.bridges_bridge_id_moh_post(bridge_id, moh_class=moh_class)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_moh_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
moh_class	str	Channel's id	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_play_playback_id_post

Playback bridges_bridge_id_play_playback_id_post(bridge_id, playback_id, media, lang=lang, offsetms=offsetms, skipms=skipms)

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
playback_id = 'playback_id_example' # str | Playback ID.
media = ['media_example'] # list[str] | Media URIs to play.
lang = 'lang_example' # str | For sounds, selects language for sound. (optional)
offsetms = 0 # int | Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. (optional) (default to 0)
skipms = 3000 # int | Number of milliseconds to skip for forward/reverse operations. (optional) (default to 3000)

try:
    # Start playback of media on a bridge.
    api_response = api_instance.bridges_bridge_id_play_playback_id_post(bridge_id, playback_id, media, lang=lang, offsetms=offsetms, skipms=skipms)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_play_playback_id_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
playback_id	str	Playback ID.
media	list[str]	Media URIs to play.
lang	str	For sounds, selects language for sound.	[optional]
offsetms	int	Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.	[optional] [default to 0]
skipms	int	Number of milliseconds to skip for forward/reverse operations.	[optional] [default to 3000]

Return type

Playback

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_play_post

Playback bridges_bridge_id_play_post(bridge_id, media, lang=lang, offsetms=offsetms, skipms=skipms, playback_id=playback_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.)

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
media = ['media_example'] # list[str] | Media URIs to play.
lang = 'lang_example' # str | For sounds, selects language for sound. (optional)
offsetms = 0 # int | Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. (optional) (default to 0)
skipms = 3000 # int | Number of milliseconds to skip for forward/reverse operations. (optional) (default to 3000)
playback_id = 'playback_id_example' # str | Playback Id. (optional)

try:
    # Start playback of media on a bridge.
    api_response = api_instance.bridges_bridge_id_play_post(bridge_id, media, lang=lang, offsetms=offsetms, skipms=skipms, playback_id=playback_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_play_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
media	list[str]	Media URIs to play.
lang	str	For sounds, selects language for sound.	[optional]
offsetms	int	Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.	[optional] [default to 0]
skipms	int	Number of milliseconds to skip for forward/reverse operations.	[optional] [default to 3000]
playback_id	str	Playback Id.	[optional]

Return type

Playback

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_post

Bridge bridges_bridge_id_post(bridge_id, type=type, name=name)

Create a new bridge or updates an existing one.

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Unique ID to give to the bridge being created.
type = 'type_example' # str | Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu) to set. (optional)
name = 'name_example' # str | Set the name of the bridge. (optional)

try:
    # Create a new bridge or updates an existing one.
    api_response = api_instance.bridges_bridge_id_post(bridge_id, type=type, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Unique ID to give to the bridge being created.
type	str	Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu) to set.	[optional]
name	str	Set the name of the bridge.	[optional]

Return type

Bridge

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_record_post

LiveRecording bridges_bridge_id_record_post(bridge_id, name, format, max_duration_seconds=max_duration_seconds, max_silence_seconds=max_silence_seconds, if_exists=if_exists, beep=beep, terminate_on=terminate_on)

Start a recording.

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
name = 'name_example' # str | Recording's filename
format = 'format_example' # str | Format to encode audio in
max_duration_seconds = 0 # int | Maximum duration of the recording, in seconds. 0 for no limit. (optional) (default to 0)
max_silence_seconds = 0 # int | Maximum duration of silence, in seconds. 0 for no limit. (optional) (default to 0)
if_exists = 'fail' # str | Action to take if a recording with the same name already exists. (optional) (default to fail)
beep = false # bool | Play beep when recording begins (optional) (default to false)
terminate_on = 'none' # str | DTMF input to terminate recording. (optional) (default to none)

try:
    # Start a recording.
    api_response = api_instance.bridges_bridge_id_record_post(bridge_id, name, format, max_duration_seconds=max_duration_seconds, max_silence_seconds=max_silence_seconds, if_exists=if_exists, beep=beep, terminate_on=terminate_on)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_record_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
name	str	Recording's filename
format	str	Format to encode audio in
max_duration_seconds	int	Maximum duration of the recording, in seconds. 0 for no limit.	[optional] [default to 0]
max_silence_seconds	int	Maximum duration of silence, in seconds. 0 for no limit.	[optional] [default to 0]
if_exists	str	Action to take if a recording with the same name already exists.	[optional] [default to fail]
beep	bool	Play beep when recording begins	[optional] [default to false]
terminate_on	str	DTMF input to terminate recording.	[optional] [default to none]

Return type

LiveRecording

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_remove_channel_post

bridges_bridge_id_remove_channel_post(bridge_id, channel)

Remove a channel from a bridge.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
channel = ['channel_example'] # list[str] | Ids of channels to remove from bridge

try:
    # Remove a channel from a bridge.
    api_instance.bridges_bridge_id_remove_channel_post(bridge_id, channel)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_remove_channel_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
channel	list[str]	Ids of channels to remove from bridge

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_variable_get

Variable bridges_bridge_id_variable_get(bridge_id, variable)

Get the value of a bridge variable or function.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
variable = 'variable_example' # str | The bridge variable or function to get

try:
    # Get the value of a bridge variable or function.
    api_response = api_instance.bridges_bridge_id_variable_get(bridge_id, variable)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_variable_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
variable	str	The bridge variable or function to get

Return type

Variable

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_variable_post

bridges_bridge_id_variable_post(bridge_id, variable, value=value)

Set the value of a bridge variable or function.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
variable = 'variable_example' # str | The bridge variable or function to set
value = 'value_example' # str | The value to set the variable to (optional)

try:
    # Set the value of a bridge variable or function.
    api_instance.bridges_bridge_id_variable_post(bridge_id, variable, value=value)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_variable_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
variable	str	The bridge variable or function to set
value	str	The value to set the variable to	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_video_source_channel_id_post

bridges_bridge_id_video_source_channel_id_post(bridge_id, channel_id)

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.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id
channel_id = 'channel_id_example' # str | Channel's id

try:
    # 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.
    api_instance.bridges_bridge_id_video_source_channel_id_post(bridge_id, channel_id)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_video_source_channel_id_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id
channel_id	str	Channel's id

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_bridge_id_video_source_delete

bridges_bridge_id_video_source_delete(bridge_id)

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.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
bridge_id = 'bridge_id_example' # str | Bridge's id

try:
    # 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.
    api_instance.bridges_bridge_id_video_source_delete(bridge_id)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_bridge_id_video_source_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
bridge_id	str	Bridge's id

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_get

list[Bridge] bridges_get()

List all active bridges in Asterisk.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))

try:
    # List all active bridges in Asterisk.
    api_response = api_instance.bridges_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Bridge]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bridges_post

Bridge bridges_post(type=type, bridge_id=bridge_id, name=name)

Create a new bridge.

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

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BridgesApi(swagger_client.ApiClient(configuration))
type = 'type_example' # str | Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu). (optional)
bridge_id = 'bridge_id_example' # str | Unique ID to give to the bridge being created. (optional)
name = 'name_example' # str | Name to give to the bridge being created. (optional)

try:
    # Create a new bridge.
    api_response = api_instance.bridges_post(type=type, bridge_id=bridge_id, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BridgesApi->bridges_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	str	Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu).	[optional]
bridge_id	str	Unique ID to give to the bridge being created.	[optional]
name	str	Name to give to the bridge being created.	[optional]

Return type

Bridge

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BridgesApi.md

Latest commit

History

BridgesApi.md

File metadata and controls

swagger_client.BridgesApi

bridges_bridge_id_add_channel_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_moh_delete

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_moh_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_play_playback_id_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_play_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_record_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_remove_channel_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_variable_get

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_variable_post

Example

Parameters

Return type

Authorization

HTTP request headers

bridges_bridge_id_video_source_channel_id_post