impalago/t-clickatell

Standalone PHP library to integrate with the Clickatell SMS gateway

PHP library for the Clickatell Platform

Master: , _(*1)

This library allows integration with the new Clickatell website., _(*2)

Please Note: Customers with accounts registered on the old central.clickatell.com should use the tagged released or dev branches for version 2 of the repository, version 3 and up is for the new platform and older accounts will not work with this., _(*3)

Usage

The new APIs only support sendMessage call and webhooks for outgoing and inbound messages via a RESTful interface., _(*4)

``` php use Clickatell\Rest; use Clickatell\ClickatellException;, <sub>(*5)</sub>

$clickatell = new \Clickatell\Rest('token');, <sub>(*6)</sub>

// Full list of support parameters can be found at https://www.clickatell.com/developers/api-documentation/rest-api-request-parameters/ try { $result = $clickatell->sendMessage(['to' => ['27111111111'], 'content' => 'Message Content']);, <sub>(*7)</sub>

foreach ($result['messages'] as $message) {
    var_dump($message);

    /*
    [
        'apiMsgId'  => null|string,
        'accepted'  => boolean,
        'to'        => string,
        'error'     => null|string
    ]
    */
}

} catch (ClickatellException $e) { // Any API call error will be thrown and should be handled appropriately. // The API does not return error codes, so it's best to rely on error descriptions. var_dump($e->getMessage()); }, <sub>(*8)</sub>

### Status/Reply Callback

After configuring your webhooks/callbacks inside the developer portal, you can use the static callback methods to listen for web requests from Clickatell. These callbacks will extract the supported fields from the request body.

``` php
use Clickatell\Rest;
use Clickatell\ClickatellException;

// Outgoing traffic callbacks (MT callbacks)
Rest::parseStatusCallback(function ($result) {
    var_dump($result);
    // This will execute if the request to the web page contains all the values
    // specified by Clickatell. Requests that omit these values will be ignored.
});

// Incoming traffic callbacks (MO/Two Way callbacks)
Rest::parseReplyCallback(function ($result) {
    var_dump($result);
    // This will execute if the request to the web page contains all the values
    // specified by Clickatell. Requests that omit these values will be ignored.
});

Issues/Contributions

Found a bug or missing a feature? Log it here and we will take a look., <sub>(*9)</sub>