def create_message(self, account_id, body): """Does a POST request to /users/{accountId}/messages. Endpoint for sending text messages and picture messages using V2 messaging. Args: account_id (string): User's account ID body (MessageRequest): TODO: type description here. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. 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 = '/users/{accountId}/messages' _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 'accountId': {'value': account_id, 'encode': False} }) _query_builder = self.config.get_base_uri(Server.MESSAGINGDEFAULT) _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)) MessagingBasicAuth.apply(self.config, _request) _response = self.execute_request(_request) # Endpoint and global error handling using HTTP status codes. if _response.status_code == 400: raise MessagingException('400 Request is malformed or invalid', _response) elif _response.status_code == 401: raise MessagingException('401 The specified user does not have access to the account', _response) elif _response.status_code == 403: raise MessagingException('403 The user does not have access to this API', _response) elif _response.status_code == 404: raise MessagingException('404 Path not found', _response) elif _response.status_code == 415: raise MessagingException('415 The content-type of the request is incorrect', _response) elif _response.status_code == 429: raise MessagingException('429 The rate limit has been reached', _response) self.validate_response(_response) decoded = APIHelper.json_deserialize(_response.text, BandwidthMessage.from_dictionary) _result = ApiResponse(_response, body=decoded) return _result
def create_session(self, account_id, body=None): """Does a POST request to /accounts/{accountId}/sessions. Create a new session Sessions are idempotent, so relevant parameters must be set in this function if desired Args: account_id (string): Account ID body (Session, optional): Session 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}/sessions' _url_path = APIHelper.append_url_with_template_parameters( _url_path, {'accountId': { 'value': account_id, 'encode': True }}) _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, Session.from_dictionary) _result = ApiResponse(_response, body=decoded) return _result
def list_media(self, account_id, continuation_token=None): """Does a GET request to /users/{accountId}/media. Gets a list of your media files. No query parameters are supported. Args: account_id (string): User's account ID continuation_token (string, optional): Continuation token used to retrieve subsequent media. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. 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 = '/users/{accountId}/media' _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 'accountId': {'value': account_id, 'encode': False} }) _query_builder = self.config.get_base_uri(Server.MESSAGINGDEFAULT) _query_builder += _url_path _query_url = APIHelper.clean_url(_query_builder) # Prepare headers _headers = { 'accept': 'application/json', 'Continuation-Token': continuation_token } # Prepare and execute request _request = self.config.http_client.get(_query_url, headers=_headers) MessagingBasicAuth.apply(self.config, _request) _response = self.execute_request(_request) # Endpoint and global error handling using HTTP status codes. if _response.status_code == 400: raise MessagingException('400 Request is malformed or invalid', _response) elif _response.status_code == 401: raise MessagingException('401 The specified user does not have access to the account', _response) elif _response.status_code == 403: raise MessagingException('403 The user does not have access to this API', _response) elif _response.status_code == 404: raise MessagingException('404 Path not found', _response) elif _response.status_code == 415: raise MessagingException('415 The content-type of the request is incorrect', _response) elif _response.status_code == 429: raise MessagingException('429 The rate limit has been reached', _response) self.validate_response(_response) decoded = APIHelper.json_deserialize(_response.text, Media.from_dictionary) _result = ApiResponse(_response, body=decoded) return _result
def get_messages(self, account_id, message_id=None, source_tn=None, destination_tn=None, message_status=None, error_code=None, from_date_time=None, to_date_time=None, page_token=None, limit=None): """Does a GET request to /users/{accountId}/messages. Gets a list of messages based on query parameters. Args: account_id (string): User's account ID message_id (string, optional): The ID of the message to search for. Special characters need to be encoded using URL encoding source_tn (string, optional): The phone number that sent the message destination_tn (string, optional): The phone number that received the message message_status (string, optional): The status of the message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED, ACCEPTED, UNDELIVERED error_code (int, optional): The error code of the message from_date_time (string, optional): The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. to_date_time (string, optional): The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. page_token (string, optional): A base64 encoded value used for pagination of results limit (int, optional): The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000 Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. 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 = '/users/{accountId}/messages' _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 'accountId': {'value': account_id, 'encode': False} }) _query_builder = self.config.get_base_uri(Server.MESSAGINGDEFAULT) _query_builder += _url_path _query_parameters = { 'messageId': message_id, 'sourceTn': source_tn, 'destinationTn': destination_tn, 'messageStatus': message_status, 'errorCode': error_code, 'fromDateTime': from_date_time, 'toDateTime': to_date_time, 'pageToken': page_token, 'limit': limit } _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) MessagingBasicAuth.apply(self.config, _request) _response = self.execute_request(_request) # Endpoint and global error handling using HTTP status codes. if _response.status_code == 400: raise MessagingException('400 Request is malformed or invalid', _response) elif _response.status_code == 401: raise MessagingException('401 The specified user does not have access to the account', _response) elif _response.status_code == 403: raise MessagingException('403 The user does not have access to this API', _response) elif _response.status_code == 404: raise MessagingException('404 Path not found', _response) elif _response.status_code == 415: raise MessagingException('415 The content-type of the request is incorrect', _response) elif _response.status_code == 429: raise MessagingException('429 The rate limit has been reached', _response) self.validate_response(_response) decoded = APIHelper.json_deserialize(_response.text, BandwidthMessagesList.from_dictionary) _result = ApiResponse(_response, body=decoded) return _result
def upload_media(self, account_id, media_id, body, content_type='application/octet-stream', cache_control=None): """Does a PUT request to /users/{accountId}/media/{mediaId}. Uploads a file the normal HTTP way. You may add headers to the request in order to provide some control to your media-file. Args: account_id (string): User's account ID media_id (string): The user supplied custom media ID body (typing.BinaryIO): TODO: type description here. content_type (string, optional): The media type of the entity-body cache_control (string, optional): General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. 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 = '/users/{accountId}/media/{mediaId}' _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 'accountId': {'value': account_id, 'encode': False}, 'mediaId': {'value': media_id, 'encode': False} }) _query_builder = self.config.get_base_uri(Server.MESSAGINGDEFAULT) _query_builder += _url_path _query_url = APIHelper.clean_url(_query_builder) if isinstance(body, FileWrapper): body_wrapper = body.file_stream body_content_type = body.content_type else: body_wrapper = body body_content_type = content_type # Prepare headers _headers = { 'content-type': body_content_type, 'Cache-Control': cache_control } # Prepare and execute request _request = self.config.http_client.put(_query_url, headers=_headers, parameters=body_wrapper) MessagingBasicAuth.apply(self.config, _request) _response = self.execute_request(_request) # Endpoint and global error handling using HTTP status codes. if _response.status_code == 400: raise MessagingException('400 Request is malformed or invalid', _response) elif _response.status_code == 401: raise MessagingException('401 The specified user does not have access to the account', _response) elif _response.status_code == 403: raise MessagingException('403 The user does not have access to this API', _response) elif _response.status_code == 404: raise MessagingException('404 Path not found', _response) elif _response.status_code == 415: raise MessagingException('415 The content-type of the request is incorrect', _response) elif _response.status_code == 429: raise MessagingException('429 The rate limit has been reached', _response) self.validate_response(_response) # Return appropriate type return ApiResponse(_response)
def get_call_state(self, account_id, call_id): """Does a GET request to /api/v2/accounts/{accountId}/calls/{callId}. Returns near-realtime metadata about the specified call Args: account_id (string): TODO: type description here. call_id (string): TODO: type description here. Returns: ApiCallStateResponse: 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}' _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 'accountId': account_id, 'callId': call_id }) _query_builder = self.config.get_base_uri(Server.VOICEDEFAULT) _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) 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, ApiCallStateResponse.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)
def create_messaging_two_factor(self, account_id, body): """Does a POST request to /accounts/{accountId}/code/messaging. Multi-Factor authentication with Bandwidth Messaging services. Allows a user to send an MFA code via a text message (SMS). Args: account_id (string): Bandwidth Account ID with Messaging service enabled body (TwoFactorCodeRequestSchema): TODO: type description here. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. 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 = '/accounts/{accountId}/code/messaging' _url_path = APIHelper.append_url_with_template_parameters( _url_path, {'accountId': { 'value': account_id, 'encode': False }}) _query_builder = self.config.get_base_uri( Server.MULTIFACTORAUTHDEFAULT) _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)) MultiFactorAuthBasicAuth.apply(self.config, _request) _response = self.execute_request(_request) # Endpoint and global error handling using HTTP status codes. if _response.status_code == 400: raise ErrorWithRequestException( 'If there is any issue with values passed in by the user', _response) elif _response.status_code == 401: raise UnauthorizedRequestException( 'Authentication is either incorrect or not present', _response) elif _response.status_code == 403: raise ForbiddenRequestException( 'The user is not authorized to access this resource', _response) elif _response.status_code == 500: raise ErrorWithRequestException( 'An internal server error occurred', _response) self.validate_response(_response) decoded = APIHelper.json_deserialize( _response.text, TwoFactorMessagingResponse.from_dictionary) _result = ApiResponse(_response, body=decoded) return _result