Skip to main content

Clickatell backend for the RapidSMS project.

Project description

rapidsms-clickatell
===================

.. image:: https://travis-ci.org/caktus/rapidsms-clickatell.svg?branch=develop
:alt: Build Status
:target: https://travis-ci.org/caktus/rapidsms-clickatell


rclickatell is a basic `Clickatell <https://www.clickatell.com/>`_ backend for the
`RapidSMS <https://www.rapidsms.org/>`_ project. Currently, rclickatell only
supports Mobile Terminated (MT) SMS communication (sending outgoing messages
using the Clickatell API), but could be extended in the future to support
Mobile Originated (MO) messages.

Requirements
------------

* Python 2.7 or Python 3.3+
* `Django <http://www.djangoproject.com/>`_ >= 1.7
* `RapidSMS <http://www.rapidsms.org/>`_ >= 0.18.0

Installation
------------

* Install via pip::

pip install rclickatell

Features and Settings
---------------------

* Status Notification: rclickatell can be configured to enable Clickatell's
callback functionality. When setup, after sending a an outgoing message,
Clickatell will ping the callback URL defined in your Clickatell API
account.

Usage
-----

Once ``rclickatell`` is installed, add it to ``INSTALLED_APPS`` and ``INSTALLED_BACKENDS`` in settings.py::

INSTALLED_APPS (
...
'rclickatell',
...
)

INSTALLED_BACKENDS = {
"clickatell": {
"ENGINE": "rclickatell.backend"
'user': '',
'password': '',
'api_id': '',
'callback' 3, # enable (levels 1-3) to enable Clickatell status notifications
},
}


Testing
-------

Install ``tox`` and then run it::

$ pip install tox
$ tox

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
rclickatell-0.1.0.tar.gz (7.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page