Python library

ARCHIVED

Overview

Use Clickatell’s Python library with our HTTP or REST messaging APIs to interact with the Clickatell SMS Gateway.

Get Python library

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

Clickatell Python PyPI

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.