ismaeltoe/osms

PHP library wrapper of the Orange SMS API.

Osms

A PHP library to access Orange SMS API., _(*1)

Current version: 2.0.1, _(*2)

Installation

With Composer (recommended)

Install Composer. Then, do:, _(*3)

$ composer require ismaeltoe/osms

Without Composer

Simply download the latest release., _(*4)

Loading

You can load the class using Composer's autoloading:, _(*5)

require 'vendor/autoload.php';

Otherwise, you can simply require the file directly:, _(*6)

require 'path/to/Osms.php';

Quick Start

Case 1: You have no access token, _(*7)

require 'vendor/autoload.php';

use \Osms\Osms;

$config = array(
    'clientId' => 'your_client_id',
    'clientSecret' => 'your_client_secret'
);

$osms = new Osms($config);

// retrieve an access token
$response = $osms->getTokenFromConsumerKey();

if (!empty($response['access_token'])) {
    $senderAddress = 'tel:+22500000000';
    $receiverAddress = 'tel:+22500000000';
    $message = 'Hello World!';
    $senderName = 'Optimus Prime';

    $osms->sendSMS($senderAddress, $receiverAddress, $message, $senderName);
} else {
    // error
}

Case 2: You have an access token, _(*8)

require 'vendor/autoload.php';

use \Osms\Osms;

$config = array(
    'token' => 'your_access_token'
);

$osms = new Osms($config);

$senderAddress = 'tel:+22500000000';
$receiverAddress = 'tel:+22500000000';
$message = 'Hello World!';
$senderName = 'Optimus Prime';

$osms->sendSMS($senderAddress, $receiverAddress, $message, $senderName);

Check out examples for more examples., _(*9)

CHECK OUT also Osms.php to see all the methods available. But DON'T MODIFY IT. You can extend the class to add your own stuff., _(*10)

SSL certificate problem

If you get an SSL error, set the peer's certificate checking option to false:, _(*11)

$osms = new Osms();
$osms->setVerifyPeerSSL(false);

But it should work on your hosting server, so enable the certificate checking when you are ready to deploy your application for security reasons., _(*12)

Documentation

• Native API https://developer.orange.com/apis/sms-ci/getting-started

Other Libraries

• osms-android

License

Released under the MIT License - see LICENSE.txt for details., _(*13)