swagger_client.RecordingsApi

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

Method	HTTP request	Description
recordings_live_recording_name_delete	DELETE /recordings/live/{recordingName}	Stop a live recording and discard it.
recordings_live_recording_name_get	GET /recordings/live/{recordingName}	List live recordings.
recordings_live_recording_name_mute_delete	DELETE /recordings/live/{recordingName}/mute	Unmute a live recording.
recordings_live_recording_name_mute_post	POST /recordings/live/{recordingName}/mute	Mute a live recording.
recordings_live_recording_name_pause_delete	DELETE /recordings/live/{recordingName}/pause	Unpause a live recording.
recordings_live_recording_name_pause_post	POST /recordings/live/{recordingName}/pause	Pause a live recording.
recordings_live_recording_name_stop_post	POST /recordings/live/{recordingName}/stop	Stop a live recording and store it.
recordings_stored_get	GET /recordings/stored	List recordings that are complete.
recordings_stored_recording_name_copy_post	POST /recordings/stored/{recordingName}/copy	Copy a stored recording.
recordings_stored_recording_name_delete	DELETE /recordings/stored/{recordingName}	Delete a stored recording.
recordings_stored_recording_name_file_get	GET /recordings/stored/{recordingName}/file	Get the file associated with the stored recording.
recordings_stored_recording_name_get	GET /recordings/stored/{recordingName}	Get a stored recording's details.

recordings_live_recording_name_delete

recordings_live_recording_name_delete(recording_name)

Stop a live recording and discard it.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Stop a live recording and discard it.
    api_instance.recordings_live_recording_name_delete(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_get

LiveRecording recordings_live_recording_name_get(recording_name)

List live recordings.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # List live recordings.
    api_response = api_instance.recordings_live_recording_name_get(recording_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_mute_delete

recordings_live_recording_name_mute_delete(recording_name)

Unmute a live recording.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Unmute a live recording.
    api_instance.recordings_live_recording_name_mute_delete(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_mute_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_mute_post

recordings_live_recording_name_mute_post(recording_name)

Mute a live recording.

Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Mute a live recording.
    api_instance.recordings_live_recording_name_mute_post(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_mute_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_pause_delete

recordings_live_recording_name_pause_delete(recording_name)

Unpause a live recording.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Unpause a live recording.
    api_instance.recordings_live_recording_name_pause_delete(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_pause_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_pause_post

recordings_live_recording_name_pause_post(recording_name)

Pause a live recording.

Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Pause a live recording.
    api_instance.recordings_live_recording_name_pause_post(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_pause_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_live_recording_name_stop_post

recordings_live_recording_name_stop_post(recording_name)

Stop a live recording and store it.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Stop a live recording and store it.
    api_instance.recordings_live_recording_name_stop_post(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_live_recording_name_stop_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_stored_get

list[StoredRecording] recordings_stored_get()

List recordings that are complete.

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.RecordingsApi(swagger_client.ApiClient(configuration))

try:
    # List recordings that are complete.
    api_response = api_instance.recordings_stored_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_stored_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[StoredRecording]

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]

recordings_stored_recording_name_copy_post

StoredRecording recordings_stored_recording_name_copy_post(recording_name, destination_recording_name)

Copy a stored recording.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording to copy
destination_recording_name = 'destination_recording_name_example' # str | The destination name of the recording

try:
    # Copy a stored recording.
    api_response = api_instance.recordings_stored_recording_name_copy_post(recording_name, destination_recording_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_stored_recording_name_copy_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording to copy
destination_recording_name	str	The destination name of the recording

Return type

StoredRecording

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]

recordings_stored_recording_name_delete

recordings_stored_recording_name_delete(recording_name)

Delete a stored recording.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Delete a stored recording.
    api_instance.recordings_stored_recording_name_delete(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_stored_recording_name_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_stored_recording_name_file_get

recordings_stored_recording_name_file_get(recording_name)

Get the file associated with the stored recording.

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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Get the file associated with the stored recording.
    api_instance.recordings_stored_recording_name_file_get(recording_name)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_stored_recording_name_file_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

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]

recordings_stored_recording_name_get

StoredRecording recordings_stored_recording_name_get(recording_name)

Get a stored recording's 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.RecordingsApi(swagger_client.ApiClient(configuration))
recording_name = 'recording_name_example' # str | The name of the recording

try:
    # Get a stored recording's details.
    api_response = api_instance.recordings_stored_recording_name_get(recording_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordingsApi->recordings_stored_recording_name_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
recording_name	str	The name of the recording

Return type

StoredRecording

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

RecordingsApi.md

Latest commit

History

RecordingsApi.md

File metadata and controls

swagger_client.RecordingsApi

recordings_live_recording_name_delete

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_get

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_mute_delete

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_mute_post

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_pause_delete

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_pause_post

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_live_recording_name_stop_post

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_stored_get

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_stored_recording_name_copy_post

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_stored_recording_name_delete

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_stored_recording_name_file_get

Example

Parameters

Return type

Authorization

HTTP request headers

recordings_stored_recording_name_get

Example

Parameters

Return type

Authorization

HTTP request headers