def delete_message(self, params):
"""
Delete conversation message
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['remote_address'] (:obj:`str`): Remote address information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
params['local_address'] (:obj:`str`): Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
params['message_id'] (:obj:`str`, optional): Identification of the SMS message. If messageId is not passed then the SMS thread is deleted with all messages.
"""
message_type = params.get('type')
url = ''
if (message_type == self.types['SMS']):
url = '{}/remoteAddresses/{}/localAddresses/{}'.format(
self.base_url, params.get('remote_address'),
params.get('local_address'))
if params.get('message_id'):
url = '{}/messages/{}'.format(url, params.get('message_id'))
response = self.api.send_request(url, {}, 'delete')
# check if response is test response.
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# if not custom response remove the top level key and return
return parse_response(response)
def unsubscribe(self, params):
"""
Unsubscription from conversation notification
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['subscription_id'] (:obj:`str`): Resource ID of the subscription
"""
message_type = params.get('type')
if (message_type == self.types['SMS']):
url = '{}/inbound/subscriptions/{}'.format(
self.base_url, params.get('subscription_id'))
response = self.api.send_request(url, {}, 'delete')
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {
'subscription_id':
params.get('subscription_id'),
'success':
True,
'message':
'Unsubscribed from {} conversation notification'.format(
params['type'])
}
return custom_response
def get_messages_in_thread(self, params):
"""
Read all messages in a thread
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['local_address'] (:obj:`str`): Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
params['remote_address'] (:obj:`str`): Remote address information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
params['query'] (:obj:`dict`, optional): To hold all query related parameters.
params['query']['max'] (:obj:`int`, optional): Number of messages that is requested from CPaaS.
params['query']['next'] (:obj:`string`, optional): Pointer for the next page to retrieve for the messages, provided by CPaaS in previous GET response.
params['query']['new'] (:obj:`string`, optional): Filters the messages or threads having messages that are not received by the user yet
params['query']['last_message_time'] (:obj:`int`, optional): Filters the messages or threads having messages that are sent/received after provided Epoch time
"""
message_type = params.get('type')
options = {}
url = ''
if (message_type == self.types['SMS']):
options = {'query': params.get('query')}
url = '{}/remoteAddresses/{}/localAddresses/{}/messages'.format(
self.base_url, params.get('remote_address'),
params.get('local_address'))
response = self.api.send_request(url, options)
# check if response is test response.
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# if not custom response remove the top level key and return
return parse_response(response)
def create_channel(self, params):
"""
Creates a new notification channel, webhook type.
Args:
params (dict): Single parameter to hold all options
params['webhook_url'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
Returns:
Returns a json.
"""
url = '{}/channels'.format(self.base_url)
options = {
'body': {
'notificationChannel': {
'channelData': {
'x-webhookURL': params.get('webhook_url')
},
'channelType': 'webhooks',
'clientCorrelator': self.api.config.client_correlator
}
}
}
response = self.api.send_request(url, options, 'post')
# check if response is test response.
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {
'channel_id': response['notificationChannel']['callbackURL'],
'webhook_url': response['notificationChannel']['channelData']['x-webhookURL'],
'channel_type': response['notificationChannel']['channelType']
}
return custom_response
def create_message(self, params):
"""
Send a new outbound message
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options.
params['sender_address'] (:obj:`str`): Sender address information, basically the from address. E164 formatted DID number passed as a value, which is owned by the user. If the user wants to let CPaaS uses the default assigned DID number, this field can either has "default" value or the same value as the user_id.
params['destination_address'] (:obj:`array[str]`):
params['message'] (:obj:`str`): SMS text message
"""
message_type = params.get('type')
destination_address = params.get('destination_address')
address = destination_address if type(
destination_address) is list else [destination_address]
if (message_type == self.types['SMS']):
options = {
'body': {
'outboundSMSMessageRequest': {
'address': address,
'clientCorrelator': self.api.config.client_correlator,
'outboundSMSTextMessage': {
'message': params.get('message')
}
}
}
}
url = '{}/outbound/{}/requests'.format(
self.base_url, params.get('sender_address'))
response = self.api.send_request(url, options, 'post')
# check if response is test response.
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {
'message':
response['outboundSMSMessageRequest']['outboundSMSTextMessage']
['message'],
'sender_address':
response['outboundSMSMessageRequest']['senderAddress'],
'delivery_info':
response['outboundSMSMessageRequest']['deliveryInfoList']
['deliveryInfo']
}
return custom_response
def resend_code(self, params):
"""
Resending the authentication code via same code resource, invalidating the previously sent code.
Args:
params (dict): Single parameter to hold all options
params['code_id'] (:obj:`str`): ID of the authentication code.
params['destination_address'] (:obj:`array[str]`): Destination address of the authentication code being sent. For sms type authentication codes, it should contain a E164 phone number. For e-mail type authentication codes, it should contain a valid e-mail address.
params['message'] (:obj:`str`): Message text sent to the destination, containing the placeholder for the code within the text. CPaaS requires to have *{code}* string within the text in order to generate a code and inject into the text. For email type code, one usage is to have the *{code}* string located within the link in order to get a unique link.
params['method'] (:obj:`str`, optional): Type of the authentication code delivery method, sms and email are supported types. Possible values: sms, email
params['expiry'] (:obj:`int`, optional): Lifetime duration of the code sent in seconds. This can contain values between 30 and 3600 seconds.
params['length'] (:obj:`int`, optional): Length of the authentication code tha CPaaS should generate for this request. It can contain values between 4 and 10.
params['type'] (:obj:`str`, optional): Type of the code that is generated. If not provided, default value is numeric. Possible values: numeric, alphanumeric, alphabetic
"""
destination_address = params.get('destination_address')
address = destination_address if type(
destination_address) is list else [destination_address]
options = {
'body': {
'code': {
'address': address,
'method': params.get('method') or 'sms',
'format': {
'length': params.get('length') or 6,
'type': params.get('type') or 'numeric'
},
'expiry': params.get('expiry') or 120,
'message': params.get('message')
}
}
}
url = '{}/codes/{}'.format(self.base_url, params.get('code_id'))
response = self.api.send_request(url, options, 'put')
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {'code_id': id_from(response['code']['resourceURL'])}
return custom_response
def subscribe(self, params):
"""
Create a new subscription.
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['webhook_url'] (:obj:`str`): The webhook that has been acquired during SMS API subscription, which the incoming notifications supposed to be sent to.
params['destination_address'] (:obj:`str`, optional): The address that incoming messages are received for this subscription. If does not exist, CPaaS uses the default assigned DID number to subscribe against. It is suggested to provide the intended E164 formatted DID number within this parameter.
"""
message_type = params.get('type')
if (message_type == self.types['SMS']):
# create a notifyURL with webhookURL
channel = NotificationChannel(self.api).create_channel(params)
options = {
'body': {
'subscription': {
'callbackReference': {
'notifyURL': channel['channel_id']
},
'clientCorrelator': self.api.config.client_correlator,
'destinationAddress': params.get('destination_address')
}
}
}
url = '{}/inbound/subscriptions'.format(self.base_url)
response = self.api.send_request(url, options, 'post')
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {
'webhook_url':
params.get('webhook_url'),
'destination_address':
response['subscription']['destinationAddress'],
'subscription_id':
id_from(response['subscription']['resourceURL'])
}
return custom_response
def get_messages(self, params):
"""
Gets all messages.
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['remote_address'] (:obj:`str`): Remote address information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
params['local_address'] (:obj:`str`): Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
params['query'] (:obj:`dict`, optional): To hold all query related parameters.
params['query']['name'] (:obj:`int`, optional): Performs search operation on first_name and last_name fields.
params['query']['first_name'] (:obj:`int`, optional): Performs search for the first_name field of the directory items.
params['query']['last_name'] (:obj:`int`, optional): Performs search for the last_name field of the directory items.
params['query']['user_name'] (:obj:`int`, optional): Performs search for the user_name field of the directory items.
params['query']['phone_number'] (:obj:`int`, optional): Performs search for the fields containing a phone number, like businessPhoneNumber, homePhoneNumber, mobile, pager, fax.
params['query']['order'] (:obj:`int`, optional): Ordering the contact results based on the requested sortBy value, order query parameter should be accompanied by sortBy query parameter.
params['query']['sort_by'] (:obj:`int`, optional): SortBy value is used to detect sorting the contact results based on which attribute. If order is not provided with that, ascending order is used.
params['query']['max'] (:obj:`int`, optional): Maximum number of contact results that has been requested from CPaaS for this query.
params['query']['next'] (:obj:`string`, optional): Pointer for the next chunk of contacts, should be gathered from the previous query results.
"""
message_type = params.get('type')
options = {}
url = ''
remote_address = params.get('remote_address')
local_address = params.get('local_address')
if (message_type == self.types['SMS']):
options = {'query': params.get('query')}
url = '{}/remoteAddresses'
if (remote_address):
url = '{}/{}'.format(url, remote_address)
if (local_address):
url = '{}/localAddresses/{}'.format(url, local_address)
response = self.api.send_request(url, options)
# check if response is test response.
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# if not custom response remove the top level key and return
return parse_response(response)
def verify_code(self, params):
"""
Verifying authentication code.
Args:
params (dict): Single parameter to hold all options
params['code_id'] (:obj:`str`): ID of the authentication code.
params['verification_code'] (:obj:`str`): Code that is being verified
"""
destination_address = params.get('destination_address')
address = destination_address if type(
destination_address) is list else [destination_address]
options = {
'body': {
'code': {
'verify': params.get('verification_code'),
}
}
}
url = '{}/codes/{}/verify'.format(self.base_url, params.get('code_id'))
# check if try block has to be added.
response = self.api.send_request(url, options, 'put')
if (is_test_response(response)):
return response.json()
# check if error_response. commented out because of no response thrown back when verification failed.
# elif (check_if_error_response(response)):
# return build_error_response(response)
# build custom_response.
if (response.status_code == 204):
custom_response = {'verified': True, 'message': 'Success'}
else:
custom_response = {
'verified': False,
'message': 'Code invalid or expired'
}
return custom_response
def get_subscriptions(self, params):
"""
Read all active subscriptions.
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
"""
url = ''
message_type = params.get('type')
if (message_type == this.types['SMS']):
url = '{}/inbound/subscriptions'.format(self.base_url)
response = self.api.send_request(url, {})
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = []
if (("subscriptionList" in response)
and ("subscription" in response["subscriptionList"])):
for subscription in response["subsctiptionList"][
"subscription"]:
custom_response.append({
'notify_url':
subscription['callbackReference']['notifyURL'],
'destination_address':
subscription['destinationAddress'],
'subscription_id':
id_from(subscription['resourceURL'])
})
return custom_response
def delete_code(self, params):
"""
Delete authentication code resource.
Args:
params (dict): Single parameter to hold all options
params['code_id'] (:obj:`str`): ID of the authentication code.
"""
url = '{}/codes/{}'.format(self.base_url, params.get('code_id'))
response = self.api.send_request(url, {}, 'put')
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
custom_response = {'code_id': params.get('code_id'), 'success': True}
return custom_response
def get_subscription(self, params):
"""
Read active subscription
Args:
params (dict): Single parameter to hold all options
params['type'] (:obj:`str`): Type of conversation. Possible values - SMS. Check conversation.types for more options
params['subscription_id'] (:obj:`str`): Resource ID of the subscription
"""
url = ''
message_type = params.get('type')
if (message_type == self.types['SMS']):
url = '{}/inbound/subscriptions/{}'.format(
self.base_url, params.get('subscription_id'))
response = self.api.send_request(url, {})
if (is_test_response(response)):
return response.json()
# check if error_response.
elif (check_if_error_response(response)):
return build_error_response(response)
# build custom_response.
response = response.json()
if ("subscription" in response):
custom_response = {
'notify_url':
response['subscription']['callbackReference']['notifyURL'],
'destination_address':
response['subcription']['destinationAddress'],
'subscription_id':
id_from(response['subscription']['resourceURL'])
}
return custom_response