def delete_session(self, account_id, session_id):
"""Does a DELETE request to /accounts/{accountId}/sessions/{sessionId}.
Delete session by ID.
Args:
account_id (string): Account ID
session_id (string): Session ID
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. No
Content
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/accounts/{accountId}/sessions/{sessionId}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'accountId': {
'value': account_id,
'encode': False
},
'sessionId': {
'value': session_id,
'encode': False
}
})
_query_builder = self.config.get_base_uri(Server.WEBRTCDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.config.http_client.delete(_query_url)
WebRtcBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 401:
raise APIException('Unauthorized', _response)
elif _response.status_code == 403:
raise APIException('Access Denied', _response)
elif _response.status_code == 404:
raise APIException('Not Found', _response)
elif (_response.status_code < 200) or (_response.status_code > 208):
raise ErrorException('Unexpected Error', _response)
self.validate_response(_response)
# Return appropriate type
return ApiResponse(_response)
def get_stream_recording_media(self,
account_id,
call_id,
recording_id):
"""Does a GET request to /api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media.
Downloads the specified recording
Args:
account_id (string): TODO: type description here.
call_id (string): TODO: type description here.
recording_id (string): TODO: type description here.
Returns:
binary: Response from the API. successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'accountId': account_id,
'callId': call_id,
'recordingId': recording_id
})
_query_builder = self.config.get_base_uri(Server.VOICEDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.config.http_client.get(_query_url)
VoiceBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request, binary=True)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 400:
raise ApiErrorResponseException('Something\'s not quite right... Either your request is invalid or you\'re requesting it at a bad time. Please fix it before trying again.', _response)
elif _response.status_code == 401:
raise APIException('Please authenticate yourself.', _response)
elif _response.status_code == 403:
raise ApiErrorResponseException('Your credentials are invalid. Please use your API credentials for the Bandwidth Dashboard.', _response)
elif _response.status_code == 404:
raise ApiErrorResponseException('The resource specified cannot be found or does not belong to you.', _response)
elif _response.status_code == 415:
raise ApiErrorResponseException('We don\'t support that media type. If a request body is required, please send it to us as `application/json`.', _response)
elif _response.status_code == 429:
raise ApiErrorResponseException('You\'re sending requests to this endpoint too frequently. Please slow your request rate down and try again.', _response)
elif _response.status_code == 500:
raise ApiErrorResponseException('Something unexpected happened. Please try again.', _response)
self.validate_response(_response)
decoded = _response.text
_result = ApiResponse(_response, body=decoded)
return _result
def validate_response(self, response):
"""Validates an HTTP response by checking for global errors.
Args:
response (HttpResponse): The HttpResponse of the API call.
"""
if (response.status_code < 200) or (response.status_code > 208): # [200,208] = HTTP OK
raise APIException('HTTP response not OK.', response)
def get_participant(self, account_id, participant_id):
"""Does a GET request to /accounts/{accountId}/participants/{participantId}.
Get participant by ID.
Args:
account_id (string): Account ID
participant_id (string): Participant ID
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/accounts/{accountId}/participants/{participantId}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'accountId': {
'value': account_id,
'encode': False
},
'participantId': {
'value': participant_id,
'encode': False
}
})
_query_builder = self.config.get_base_uri(Server.WEBRTCDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.config.http_client.get(_query_url, headers=_headers)
WebRtcBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 401:
raise APIException('Unauthorized', _response)
elif _response.status_code == 403:
raise APIException('Access Denied', _response)
elif _response.status_code == 404:
raise APIException('Not Found', _response)
elif (_response.status_code < 200) or (_response.status_code > 208):
raise ErrorException('Unexpected Error', _response)
self.validate_response(_response)
decoded = APIHelper.json_deserialize(_response.text,
Participant.from_dictionary)
_result = ApiResponse(_response, body=decoded)
return _result
def update_participant_subscriptions(self,
account_id,
session_id,
participant_id,
body=None):
"""Does a PUT request to /accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions.
Update a participant's subscriptions.
This is a full update that will replace the participant's
subscriptions. First call `getParticipantSubscriptions` if you need
the current subscriptions. Call this function with no `Subscriptions`
object to remove all subscriptions.
Args:
account_id (string): Account ID
session_id (string): Session ID
participant_id (string): Participant ID
body (Subscriptions, optional): Initial state
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. No
Content
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'accountId': {
'value': account_id,
'encode': False
},
'sessionId': {
'value': session_id,
'encode': False
},
'participantId': {
'value': participant_id,
'encode': False
}
})
_query_builder = self.config.get_base_uri(Server.WEBRTCDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'content-type': 'application/json; charset=utf-8'}
# Prepare and execute request
_request = self.config.http_client.put(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(body))
WebRtcBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 400:
raise APIException('Bad Request', _response)
elif _response.status_code == 401:
raise APIException('Unauthorized', _response)
elif _response.status_code == 403:
raise APIException('Access Denied', _response)
elif _response.status_code == 404:
raise APIException('Not Found', _response)
elif (_response.status_code < 200) or (_response.status_code > 208):
raise ErrorException('Unexpected Error', _response)
self.validate_response(_response)
# Return appropriate type
return ApiResponse(_response)
def create_participant(self, account_id, body=None):
"""Does a POST request to /accounts/{accountId}/participants.
Create a new participant under this account.
Participants are idempotent, so relevant parameters must be set in
this function if desired.
Args:
account_id (string): Account ID
body (Participant, optional): Participant parameters
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/accounts/{accountId}/participants'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'accountId': {
'value': account_id,
'encode': False
}})
_query_builder = self.config.get_base_uri(Server.WEBRTCDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.config.http_client.post(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(body))
WebRtcBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 400:
raise APIException('Bad Request', _response)
elif _response.status_code == 401:
raise APIException('Unauthorized', _response)
elif _response.status_code == 403:
raise APIException('Access Denied', _response)
elif (_response.status_code < 200) or (_response.status_code > 208):
raise ErrorException('Unexpected Error', _response)
self.validate_response(_response)
decoded = APIHelper.json_deserialize(
_response.text, AccountsParticipantsResponse.from_dictionary)
_result = ApiResponse(_response, body=decoded)
return _result
def get_query_metadata_for_account(self,
account_id,
mfrom=None,
to=None,
min_start_time=None,
max_start_time=None):
"""Does a GET request to /api/v2/accounts/{accountId}/recordings.
Returns a list of metadata for the recordings associated with the
specified account. The list can be filtered by the optional from, to,
minStartTime, and maxStartTime arguments. The list is capped at 1000
entries and may be empty if no recordings match the specified
criteria.
Args:
account_id (string): TODO: type description here.
mfrom (string, optional): TODO: type description here.
to (string, optional): TODO: type description here.
min_start_time (string, optional): TODO: type description here.
max_start_time (string, optional): TODO: type description here.
Returns:
list of RecordingMetadataResponse: Response from the API.
successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/api/v2/accounts/{accountId}/recordings'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'accountId': account_id
})
_query_builder = self.config.get_base_uri(Server.VOICEDEFAULT)
_query_builder += _url_path
_query_parameters = {
'from': mfrom,
'to': to,
'minStartTime': min_start_time,
'maxStartTime': max_start_time
}
_query_builder = APIHelper.append_url_with_query_parameters(
_query_builder,
_query_parameters
)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.config.http_client.get(_query_url, headers=_headers)
VoiceBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 400:
raise ApiErrorResponseException('Something\'s not quite right... Either your request is invalid or you\'re requesting it at a bad time. Please fix it before trying again.', _response)
elif _response.status_code == 401:
raise APIException('Please authenticate yourself.', _response)
elif _response.status_code == 403:
raise ApiErrorResponseException('Your credentials are invalid. Please use your API credentials for the Bandwidth Dashboard.', _response)
elif _response.status_code == 404:
raise ApiErrorResponseException('The resource specified cannot be found or does not belong to you.', _response)
elif _response.status_code == 415:
raise ApiErrorResponseException('We don\'t support that media type. If a request body is required, please send it to us as `application/json`.', _response)
elif _response.status_code == 429:
raise ApiErrorResponseException('You\'re sending requests to this endpoint too frequently. Please slow your request rate down and try again.', _response)
elif _response.status_code == 500:
raise ApiErrorResponseException('Something unexpected happened. Please try again.', _response)
self.validate_response(_response)
decoded = APIHelper.json_deserialize(_response.text, RecordingMetadataResponse.from_dictionary)
_result = ApiResponse(_response, body=decoded)
return _result
def create_transcribe_recording(self,
account_id,
call_id,
recording_id,
body=None):
"""Does a POST request to /api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription.
Requests that the specified recording be transcribed
Args:
account_id (string): TODO: type description here.
call_id (string): TODO: type description here.
recording_id (string): TODO: type description here.
body (ApiTranscribeRecordingRequest, optional): TODO: type
description here.
Returns:
void: Response from the API.
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'accountId': account_id,
'callId': call_id,
'recordingId': recording_id
})
_query_builder = self.config.get_base_uri(Server.VOICEDEFAULT)
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
VoiceBasicAuth.apply(self.config, _request)
_response = self.execute_request(_request)
# Endpoint and global error handling using HTTP status codes.
if _response.status_code == 400:
raise ApiErrorResponseException('Something\'s not quite right... Either your request is invalid or you\'re requesting it at a bad time. Please fix it before trying again.', _response)
elif _response.status_code == 401:
raise APIException('Please authenticate yourself.', _response)
elif _response.status_code == 403:
raise ApiErrorResponseException('Your credentials are invalid. Please use your API credentials for the Bandwidth Dashboard.', _response)
elif _response.status_code == 404:
raise ApiErrorResponseException('The resource specified cannot be found or does not belong to you.', _response)
elif _response.status_code == 410:
raise ApiErrorResponseException('The media for this recording has been deleted, so we can\'t transcribe it', _response)
elif _response.status_code == 415:
raise ApiErrorResponseException('We don\'t support that media type. If a request body is required, please send it to us as `application/json`.', _response)
elif _response.status_code == 429:
raise ApiErrorResponseException('You\'re sending requests to this endpoint too frequently. Please slow your request rate down and try again.', _response)
elif _response.status_code == 500:
raise ApiErrorResponseException('Something unexpected happened. Please try again.', _response)
self.validate_response(_response)
# Return appropriate type
ApiResponse(_response)
