Python library
Overview
Use Clickatell’s Python library with our HTTP or REST messaging APIs to interact with the Clickatell SMS Gateway.
When to use this
Used for developing programs and websites. After signing up, use this Python library to incorporate it into your current systems.
Installation
You can install this library via PIP as part of your requirements file.
pip install clickatell |
Usage
The library currently supports the Http and Rest protocols.
HTTP API
from clickatell.http import Http clickatell = Http(username, password, apiID)response = clickatell.sendMessage(['1111111111'], "My Message") for entry in response: print(entry['id']) # entry['id'] # entry['destination'] # entry['error'] # entry['errorCode'] |
REST API
from clickatell.rest import Rest clickatell = Rest(token);response = clickatell.sendMessage(['1111111111'], "My Message") for entry in response: print(entry['id']) # entry['id'] # entry['destination'] # entry['error'] # entry['errorCode'] |
Sending to multiple numbers
The sendMessage call to parameter can take an array of numbers. If you specify only a single number like
clickatell.sendMessage(1111111111, "Message") |
the library will automatically convert it to an array for your convenience.
Supported API calls
The available calls are defined in the clickatell.Transport interface.
def sendMessage(self, to, message, extra={}) def getBalance(self) def stopMessage(self, apiMsgId) def queryMessage(self, apiMsgId) def routeCoverage(self, msisdn) def getMessageCharge(self, apiMsgId) |
Dealing with extra parameters in sendMessage
For usability purposes the sendMessage call focuses on the recipients and the content. In order to specify and of the additional parameters defined in the Clickatell document, you can use the extra parameter and pass them as a dictionary.
You can see our other libraries and more documentation at the Clickatell APIs and Libraries Project.
Channels
Find the most up-to-date information about the channels available to communicate with your clients.
SMS
Enable any application, website or system to facilitate local or international one- or two-way SMS communication via an easy one-step integration with our HTTP API.
Documentation
One API
Communicate with your mobile customers via multiple communication channels with a single integration. You can send and receive messages on both WhatsApp and SMS without the overhead of programming individual channels.
Documentation
As an authorized WhatsApp Business Solution Provider, we assist you in applying for a WhatsApp Business account and number. Integrate with other powerful features available on our platform via our One API.
Documentation
Products
Find the most up-to-date information about the products we offer and how to elevate your engagement with customers.
Chat 2 Pay
Send payment requests to customers via chat for secure, contactless payment experiences.
Documentation
Chat Desk
An easy-to-use web-based application that enables real-time communication with your customers via a single web interface.
Documentation
Chat Flow
A web-based application that allows you to quickly and collaboratively design and deploy conversational experiences across multiple chat applications and connect it to your organization's core functional APIs.
Documentation
Campaign Manager
An online tool that allows you to create a custom SMS campaign within minutes - no coding or developers required.
Documentation
Marketplace
Find the most up-to-date information about Clickatell's Marketplace and how you can utilize it for the distribution and payment acceptance of digital products.
Bank Interfaces API
An explanation of the way Clickatell and banks interact with one another when dealing with purchases.
Documentation
Transact Result API
Initiates the delivery of the transaction result for a purchase that was made through Clickatell after Clickatell facilitated the dispensing of the product.
Documentation
Reserve and Transact API
Initiates a purchase and fund reservation request to Clickatell.
Documentation
Security Service API
Request authentication tokens to use in all other Clickatell API calls.
Documentation
Transact
A cloud-based platform that allows for the distribution and payment acceptance of multiple digital products.
Documentation
In-Flight Transaction Check API
Used prior to a purchase instruction to confirm that no similar transaction is in progress.
Documentation
User Transaction Lookup API
Identify if a new transaction is similar to one of the user's recent transactions so the response details can be used to pre-emptively complete the current transaction details.
Documentation
Customer Account Validation API
Validate a customer's bill payment account number prior to submitting the bill payment purchase request to the vendor.
Documentation
MNO Lookup API
Derive the specific mobile network operator (MNO) for the specified MSISDN.
Documentation
Token Lookup API
Look up tokens/vouchers to present back to the buyer/customer who purchased token-related products via Clickatell's platform.
Documentation
Notifications API
Send notifications to buyer/recipient using different channels.
Documentation
Transaction Lookup API
Used after a purchase to confirm the transaction status.
Documentation
Financial Terms Lookup API
Display the correct fee and settlement amounts as per the contractual agreement for the SKU being purchased.
Documentation
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have