Package: clickatell-platform
Clickatell Python LibraryThis library supports version2.7&3.6of Python.This library allows easy access to connecting theClickatell'sdifferent messenging API's.InstallationYou can install this library via PIP as part of your requirements file.pip install clickatell-platformClickatell Python PyPIUsageThe library currently supports theHttpandRestprotocols.HTTP APIfromclickatell.httpimportHttpclickatell=Http(apiKey)response=clickatell.sendMessage(['1111111111'],"My Message rest")print(response)#Returns the headers with all the messagesforentryinresponse['messages']:print(entry)#Returns all the message details per message#print(entry['apiMessageId'])#print(entry['to'])#print(entry['accepted'])#print(entry['error'])REST APIfromclickatell.restimportRestclickatell=Rest(apiKey)response=clickatell.sendMessage(['1111111111'],"My Message rest")printresponse#Returns the headers with all the messagesforentryinresponse['messages']:print(entry)#Returns all the message details per message#print(entry['apiMessageId'])#print(entry['to'])#print(entry['accepted'])#print(entry['error'])Sending to multiple numbersThesendMessagecalltoparameter can take an array of numbers. If you specify only a single number likeclickatell.sendMessage(1111111111, "Message")the library will automatically convert it to an array for your convenience.To send to multiple numbers, just pass a list of numbers likeclickatell.sendMessage([1111111111,2222222222], "Message")Supported API callsThe available calls are defined in theclickatell.Transportinterface.defsendMessage(self,to,message,extra={})Dealing with extra parameters in sendMessageFor usability purposes thesendMessagecall focuses on the recipients and the content. In order to specify and of the additional parameters defined
in theClickatell document, you can use theextraparameter and pass them as a dictionary.Receiving and consuming the status callbackThe following will be returned from the callback in two different sets:DELIVERED_TO_GATEWAY :integrationNamemessageIdrequestIdclientMessageIdtofromstatusCodestatusstatusDescriptiontimestampRECEIVED_BY_RECIPIENT :integrationNamemessageIdrequestIdclientMessageIdtofromstatusCodestatusstatusDescriptiontimestampThere is a python test server included in the clickatell folder.
To run this server, you require the endpoints pip package:pip install endpointsYou can run the server using the following command:endpoints --dir=clickatell/ --prefix=controller --host=<hostname>:<port>This server currently prints out to the server console. Replace the print function with your function name to consume the data.
All data is returned in JSON.Reference Links and More Info:Found a bug or missing a feature? Log it here and we will take a look.https://github.com/clickatell/clickatell-python/issuesRegister a new account to send sms's:https://www.clickatell.com/sign-up/Login to platform for API id, etc:https://portal.clickatell.com/#/loginRequest Parameters:https://www.clickatell.com/developers/api-documentation/rest-api-request-parameters/Send Message Info:https://www.clickatell.com/developers/api-documentation/rest-api-send-message/Error Messages:https://www.clickatell.com/developers/api-documentation/rest-api-error-message-descriptions/