Skip to content

caktus/rapidsms-clickatell

Repository files navigation

rapidsms-clickatell

Build Status

rclickatell is a basic Clickatell backend for the RapidSMS 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

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