arcturial/clickatell

Standalone PHP library to integrate with the Clickatell SMS gateway

Monday, October 9, 2017
by arcturial
Repository
6 Watchers
45 Stars
86,262 Installations

PHP
8 Dependents
0 Suggesters
30 Forks
2 Open issues
21 Versions
8 % Grown

The README.md

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;, _(*5)

$clickatell = new \Clickatell\Rest('token');, _(*6)

// 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']);, _(*7)

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()); }, _(*8)


### 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.
});

The Versions

09/10 2017

dev-master

9999999-dev https://arcturial.github.com

Standalone PHP library to integrate with the Clickatell SMS gateway

library clickatell

Standalone PHP library to integrate with the Clickatell SMS gateway

arcturial/clickatell

The README.md

PHP library for the Clickatell Platform

Usage

The Versions

dev-master

The Requires

The Development Requires

by Chris Brand

3.x-dev

The Requires

The Development Requires

by Chris Brand

3.0.0

The Requires

The Development Requires

by Chris Brand

2.x-dev

The Requires

The Development Requires

by Chris Brand

2.1.6

The Requires

The Development Requires

by Chris Brand

dev-issue-23

The Requires

The Development Requires

by Chris Brand

2.1.5

The Requires

The Development Requires

by Chris Brand

2.1.4

The Requires

The Development Requires

by Chris Brand

2.1.3

The Requires

The Development Requires

by Chris Brand

2.1.2

The Requires

The Development Requires

by Chris Brand

2.1.1

The Requires

The Development Requires

by Chris Brand

2.1.0

The Requires

The Development Requires

by Chris Brand

dev-feature-bundle

The Requires

The Development Requires

by Chris Brand

dev-feature-otp

The Requires

The Development Requires

by Chris Brand

2.0.0

The Requires

The Development Requires

by Chris Brand

dev-refactor

The Requires

The Development Requires

by Chris Brand

1.0.4

The Requires

The Development Requires

by Chris Brand

1.0.3

The Requires

The Development Requires

by Chris Brand

1.0.2