Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mediumart/orange-sms
A php library to interact with the orange sms api for MiddleEast and Africa.
https://github.com/mediumart/orange-sms
orange orange-api php sms
Last synced: 8 days ago
JSON representation
A php library to interact with the orange sms api for MiddleEast and Africa.
- Host: GitHub
- URL: https://github.com/mediumart/orange-sms
- Owner: mediumart
- License: mit
- Created: 2017-03-24T06:40:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-26T14:09:26.000Z (almost 3 years ago)
- Last Synced: 2024-09-21T12:44:39.469Z (about 2 months ago)
- Topics: orange, orange-api, php, sms
- Language: PHP
- Homepage:
- Size: 72.3 KB
- Stars: 13
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# orange-sms
[](https://travis-ci.org/mediumart/orange-sms)
[](https://scrutinizer-ci.com/g/mediumart/orange-sms/?branch=master)
[](https://scrutinizer-ci.com/g/mediumart/orange-sms/?branch=master)
## Description
A php library to interact with the orange sms api for MiddleEast and Africa.
## Installation
Using composer:
```
$ composer require mediumart/orange-sms
```
## Usage
First you need to resolve a `SMSClient` instance:
```php
use Mediumart\Orange\SMS\SMS;
use Mediumart\Orange\SMS\Http\SMSClient;
/**
* if you already have a valid access token
* */
$client = SMSClient::getInstance('');
// OR
/**
* directly using and
* */
$client = SMSClient::getInstance('', '');
```
next step, create an `SMS` object passing it the `$client` :
```php
$sms = new SMS($client);
```
and you're good to go:
```php
// prepare and send an sms in a fluent way
$sms->message('Hello, my dear...')
->from('+237690000000')
->to('+237670000000')
->send();
```
You now have access to the full orange sms api through the `$sms` object :
```php
// sending SMS.
$response = $sms->to('+237670000000')
->from('+237690000000', <'optional_sender_name>')
->message('Hello, world!')
->send();
// checking your balance(remaining sms units)
// with optional country code filter ie: CIV
$response = $sms->balance('');
// checking SMS orders history
// with optional country code filter ie: CMR
$response = $sms->ordersHistory('');
// checking SMS statistics
// with optional country code filter
// and optional appID filter
$response = $sms->statistics('', '');
// setting the SMS DR notification endpoint
// '' $url
// '' $sender = '+237690000000'
$response = $sms->setDeliveryReceiptNotificationUrl($url, $sender);
// checking the SMS DR notification endpoint
// '' $id
$response = $sms->checkDeliveryReceiptNotificationUrl($id);
// delete the SMS DR notification endpoint
// '' $id
// '' $sender = '+237690000000'
$response = $sms->deleteDeliveryReceiptNotificationUrl($id, $sender);
```
All `json` responses will automatically be converted to `array`.
Be sure to lookup [the official documentation](https://developer.orange.com/apis/sms-cm/getting-started), to see what to expect as a `response` to each call.
## Access Token
When you resolve the `SMSClient` instance using your `client_id` and `client_secret`, a new access token will be fetched from the api server and automatically set on the instance, along with its lifetime in seconds.
We recommend saving the token (*maybe to your database*) for future use, at least within the limit of its validity period. this will help speed up requests to the api.
Use the `getToken()` and `getTokenExpiresIn()` to get those values from the instance:
```php
use Mediumart\Orange\SMS\Http\SMSClient;
$client = SMSClient::getInstance('', '');
// get the token
$token = $client->getToken();
// get the token lifetime in seconds
$tokenExpiresIn = $client->getTokenExpiresIn();
```
If you wish, you can also fetch your access token directly without resolving a client instance, using the static `authorize` method:
```php
$response = SMSClient::authorize('', '');
```
this will return as `$response`, an array of this form:
```php
[
"token_type" => "Bearer",
"access_token" => "i6m2iIcY0SodWSe...L3ojAXXrH",
"expires_in" => "7776000"
]
```
## SSL Certificate check issue
If you experience ssl certificate checking issue, in your local environment. You can disable the check temporarily with the following line, before starting to interact with the api in your code.
Just for testing purposes though. You should never do this on a production server.
```php
\Mediumart\Orange\SMS\Http\SMSClientRequest::verify(false);
```
## License
Mediumart orange-sms is an open-sourced software licensed under the [MIT license](https://github.com/mediumart/orange-sms/blob/master/LICENSE.txt).