A PHP library to access Orange SMS API.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 77477fb Apr 13, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Update examples Apr 13, 2016
src Update Osms.php Sep 22, 2015
.gitignore Initial commit Apr 10, 2015
LICENSE.txt Initial commit Apr 10, 2015
README.md Update API documentation link Apr 12, 2016
composer.json Initial commit Apr 10, 2015

README.md

Osms

A PHP library to access Orange SMS API.

Current version: 2.0.1

Installation

With Composer (recommended)

Install Composer. Then, do:

$ composer require ismaeltoe/osms

Without Composer

Simply download the latest release.

Loading

You can load the class using Composer's autoloading:

require 'vendor/autoload.php';

Otherwise, you can simply require the file directly:

require 'path/to/Osms.php';

Quick Start

Case 1: You have no access token

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

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.

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.

SSL certificate problem

If you get an SSL error, set the peer's certificate checking option to false:

$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.

Documentation

Other Libraries

License

Released under the MIT License - see LICENSE.txt for details.