laravel-jusibe
, (*1)
Laravel 5 Wrapper for Jusibe, (*2)
Installation
Before you go ahead to install the package, make sure you have Jusibe PHP library installed., (*3)
PHP 7.0+ or HHVM 3.3+, and Composer are required
First, pull in the package through Composer., (*4)
``` bash
$ composer require unicodeveloper/laravel-jusibe, (*5)
Another alternative is to simply add the following line to the require block of your `composer.json` file.
"unicodeveloper/laravel-jusibe": "1.0.*", (*6)
Then run `composer install` or `composer update` to download it and have the autoloader updated.
Once Laravel Jusibe is installed, you need to register the service provider. Open up `config/app.php` and add the following to the `providers` key.
* `Unicodeveloper\JusibePack\JusibeServiceProvider::class`
Also, register the Facade like so:
```php
'aliases' => [
...
'Jusibe' => Unicodeveloper\JusibePack\Facades\Jusibe::class,
...
]
Configuration
You can publish the configuration file using this command:, (*7)
php artisan vendor:publish --provider="Unicodeveloper\JusibePack\JusibeServiceProvider"
A configuration-file named jusibe.php
with some sensible defaults will be placed in your config
directory:, (*8)
<?php
return [
/**
* Public Key From Jusibe Dashboard
*
*/
'publicKey' => getenv('JUSIBE_PUBLIC_KEY'),
/**
* Access Token From Jusibe Dashboard
*
*/
'accessToken' => getenv('JUSIBE_ACCESS_TOKEN'),
];
Get the publicKey
and accessToken
from Jusibe API Keys Section, (*9)
Usage
Available methods for use are:, (*10)
/**
* Send SMS using the Jusibe API
* @param array $payload
* @return object
*/
Jusibe::sendSMS($payload)->getResponse();
/**
* Check the available SMS credits left in your Jusibe account
* @return object
*/
Jusibe::checkAvailableCredits()->getResponse();
/**
* Check the delivery status of a sent SMS
* @param string $messageID
* @return object
*/
Jusibe::checkDeliveryStatus('8nb1wrgdjw')->getResponse();
Send an SMS
<?php
$message = "I LOVE YOU, BABY";
$payload = [
'to' => '7079740987',
'from' => 'PROSPER DATING NETWORK',
'message' => $message
];
try {
$response = Jusibe::sendSMS($payload)->getResponse();
print_r($response);
} catch(Exception $e) {
echo $e->getMessage();
}
Check SMS Credits
<?php
try {
$response = Jusibe::checkAvailableCredits()->getResponse();
print_r($response);
} catch(Exception $e) {
echo $e->getMessage();
}
Check Delivery Status
<?php
try {
$response = Jusibe::checkDeliveryStatus('8nb1wrgdjw')->getResponse();
print_r($response);
} catch(Exception $e) {
echo $e->getMessage();
}
Send a Bulk SMS
<?php
// include your composer dependencies
require_once 'vendor/autoload.php';
use Unicodeveloper\Jusibe\Jusibe;
$publicKey = 'xxxxxxxxxxxxxx';
$accessToken = 'xxxxxxxxxxxxxx';
$jusibe = new Jusibe($publicKey, $accessToken);
$message = "You are invited for party!!!";
$payload = [
'to' => '7079740987,8077139164',
'from' => 'DOZIE GROUP',
'message' => $message
];
try {
$response = $jusibe->sendBulkSMS($payload)->getResponse();
print_r($response);
} catch(Exception $e) {
echo $e->getMessage();
}
Response Info for Developer, (*11)
, (*12)
Check Bulk Delivery Status
<?php
// include your composer dependencies
require_once 'vendor/autoload.php';
use Unicodeveloper\Jusibe\Jusibe;
$publicKey = 'xxxxxxxxxxxxxx';
$accessToken = 'xxxxxxxxxxxxxx';
$jusibe = new Jusibe($publicKey, $accessToken);
try {
$response = $jusibe->checkBulkDeliveryStatus('n2v9gby1jy')->getResponse();
print_r($response);
} catch(Exception $e) {
echo $e->getMessage();
}
Response Info for Developer, (*13)
, (*14)
Change log
Please see CHANGELOG for more information what has changed recently., (*15)
Testing
You can run the tests with:, (*16)
vendor/bin/phpunit run
Alternatively, you can run the tests like so:, (*17)
composer test
Contributing
Please see CONTRIBUTING for details., (*18)
Credits
License
The MIT License (MIT). Please see License File for more information., (*19)
Security
If you discover any security related issues, please email prosperotemuyiwa@gmail.com instead of using the issue tracker., (*20)