Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

SMS framework: Clickatell provider

Project Description

SMSframework Clickatell Provider

Clickatell Provider for smsframework.

You need a “Developers’ Central” Clickatell account with an HTTP API set up. From the API, you need: api_id, username, password.


Install from pypi:

$ pip install smsframework_clickatell

To receive SMS messages, you need to ensure that Flask microframework is also installed:

$ pip install smsframework_clickatell[receiver]


from smsframework import Gateway
from smsframework_clickatell import ClickatellProvider

gateway = Gateway()
gateway.add_provider('clickatell', ClickatellProvider,


Source: /smsframework_clickatell/

  • api_id: str: API ID to use
  • user: str: Account username
  • password: str: Account password
  • https: bool: Use HTTPS for outgoing messages? Default: False

Sending Parameters

Provider-specific sending params:

  • deliv_time: int: Delay the delivery for X minutes


from smsframework import OutgoingMessage

gateway.send(OutgoingMessage('+123', 'hi').params(deliv_time=15))

Additional Information




  • api_id: str: API id
  • charset: str: Message character set (when applicable, else - None)
  • udh: str: Header Data (when applicable, else - None)


  • status: int: Message status code
  • api_id: str: API id
  • charge: float: Charged funds

Public API


Returns the credist left on the account:

provider = gateway.get_provider('clickatell')
provider.get_balance() #-> 10.6


Source: /smsframework_clickatell/

Message Receiver: /im

After a number is purchased, go to Receive Messages > Manage long numbers / short codes, and then click the ‘Edit’ link of the two-way number which you would like to configure. Set “Reply Path” to “HTTP Get” | “HTTP Post”, in the field - put the message receiver URL.

  • “Username & Password” is not supported
  • “Secondary callback” is up to you

Message Receiver URL: <provider-name>/im

Status Receiver: /status

To start getting status reports from Clickatell, edit the HTTP API in the admin panel and click on “Enable your app to receive message delivery notifications”. In the field, put the receiver URL.

  • Status receiver only supports “HTTP Get” and “HTTP Post” methods.
  • “basic HTTP Authentication” is not supported

Status Receiver URL: <provider-name>/status

Release History

This version
History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(12.3 kB) Copy SHA256 Hash SHA256
2.7 Wheel Aug 14, 2014
(8.6 kB) Copy SHA256 Hash SHA256
Source Aug 14, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting