txtnation/txtnation-gateway-php

A PHP library to help you integrate the txtNation Gateway.

MessageCloud Gateway PHP Library

The MessageCloud Gateway PHP Library works with PHP 5.4+. It is also compatible with PHP 7., _(*1)

Documentation

If you would rather build on top of the Gateway API from scratch, further documentation can be found in the MessageCloud Gateway docs., _(*2)

Prerequisites

This library has been developed and tested on Mac OS 10.11.4 and Fedora 22., _(*3)

The following README assumes that you are using the following PHP extensions:, _(*4)

• php-curl
• php-mbstring

Installation

Building with Composer

Using Composer you can easily download and build the app:, _(*5)

$ composer require messagecloud/gateway-php

Importing the Library

All you need to do to get started is add the following line at the top of your script:, _(*6)

require_once 'vendor/autoload.php';

To test that the library is working correctly you can run the following:, _(*7)

$objMessage = new SMSMessage(YOUR_COMPANY_NAME_HERE, YOUR_EKEY_HERE);
$objResult = $objMessage->msisdn('447528748500')->body('Hello, world!')->senderId('MessageCloud')->send();

if ($objResult->success()) {
    echo $objResult->getCallbackId();
} else {
    echo 'Error sending message! Code: ' . $objResult->getErrorCode() . ' (' . $objResult->getErrorMessage() . ')';
}

To which you will get a result similar to the following:, _(*8)

$ php test.php
123e4567-e89b-12d3-a456-426655440000

The callback ID can be used when receiving the delivery reports for your requests. Each delivery report will contain an id parameter containing the ID returned by the SMSMessage::getCallbackId() function., _(*9)

You can also include the following line underneath your require_once() function as a shortcut to the SMSMessage object:, _(*10)

use MessageCloud\Gateway\SMSMessage as SMSMessage;

Using the Library

Check out the examples of how to use this library. They can be found in the examples/ directory., _(*11)

Testing

You can test the library by using the following command (dev only):, _(*12)

$ composer test