README

ADN SMS gateway API package for Laravel.

Installation

You can install the package via composer in your Laravel or Lumen application.

composer require rahulhaque/adn-sms

Laravel

Publish the configuration file config/adn-sms.php where you can tweak some default options.

php artisan vendor:publish --provider="RahulHaque\AdnSms\AdnSmsServiceProvider"

Define your ADN_SMS_KEY and ADN_SMS_SECRET in the .env file or update the config/adn-sms.php file of your application.

Lumen

Laravel comes pre-installed with Guzzle HTTP Client however Lumen does not. Install guzzle as this package depends on it to make the API calls.

composer require guzzlehttp/guzzle

Enable use of Facades in your Lumen application by uncommenting the line $app->withFacades(); call in the bootstrap/app.php file.

$app->register(RahulHaque\AdnSms\AdnSmsServiceProvider::class);

Define your ADN_SMS_KEY and ADN_SMS_SECRET in the .env file of your application.

Or publish the config by copying the vendor/rahulhaque/adn-sms/config/adn-sms.php file to config/adn-sms.php of your Lumen application. Create the directory if doesn't exist. Register the config in the bootstrap/app.php file in the Register Configuration Files section.

$app->configure('adn-sms');

Configuration

First have a look at the ./config/adn-sms.php to know about all the options available out of the box. Some important ones are mentioned below.

Service Enable/Disable

You can easily turn off the whole service and any API calls from the config file. Comes in handy if the APIs are down or ongoing maintenance. Remember, if you set enabled to false in the configuration file, response body will always be empty string $response->body() = "".

Usage

Single SMS

Send single SMS to single recipient.

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::to('01XXXXXXXXX')
            ->message('Send SMS Test.')
            ->send();
        
        return $response->json();
    }
}

OTP SMS

Send OTP SMS to single recipient.

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::otp('01XXXXXXXXX')
            ->message('Send OTP SMS Test.')
            ->send();

        return $response->json();
    }
}

Bulk SMS

Send single SMS to multiple recipients.

Bulk SMS sending requires campaignTitle() as mandatory.

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::bulk(['01XXXXXXXXX', '02XXXXXXXXX'])
            ->campaignTitle('Bulk SMS Test')
            ->message('Send Bulk SMS Test.')
            ->send();
        
        return $response->json();
    }
}

Queue SMS Sending (Laravel)

You can also queue SMS sending. You can pass a callback function in the queue() method to receive the $response from the API call and process it further. It is really useful if you want to save the response in the database after queue executes. See example for finer detail.

use RahulHaque\AdnSms\Facades\AdnSms;
use Illuminate\Http\Client\Response;
use App\Models\Table;

class SomeController
{
    public function someFunction()
    {
        AdnSms::bulk(['01XXXXXXXXX', '02XXXXXXXXX'])
            ->campaignTitle('Bulk SMS Test')
            ->message('Send Bulk SMS Test.')
            ->queue(function (Response $response) {
                // Check if the response body is empty
                if ($response->body() != "") {
                    // Store the $response in the database
                    $model = new Table();
                    $model->data = $response->body();
                    $model->save();
                }
            });
    }
}

Do not forget to run php artisan queue:work.

IMPORTANT: queue() method is not available in Lumen as it does not supports queueable closer. However, you can create a queueable job in your Lumen application to do something similar. Call the send() method from your job and process the returned response further.

Check Balance

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::checkBalance();
        
        return $response->json();
    }
}

Check SMS Status

To check already sent SMS status, simply call the checkSmsStatus() method with SMS UID.

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::checkSmsStatus('SXXXXXXXXXXXXXXXX');
        
        return $response->json();
    }
}

Check Campaign Status

To check already sent SMS campaign status, simply call the checkCampaignStatus() method with campaign UID.

use RahulHaque\AdnSms\Facades\AdnSms;

class SomeController
{
    /**
     * Make request and return response
     *
     * @return \Illuminate\Http\Client\Response
     * @throws \Throwable
     */
    public function someFunction()
    {
        $response = AdnSms::checkCampaignStatus('CXXXXXXXXXXXXXXXX');
        
        return $response->json();
    }
}

Extras

You can also set ADN SMS key and secret on runtime by calling the key() and secret() method which will override the settings from config file. There is a format() method to set message format to TEXT|UNICODE as well.

Testing

Set recipient number in tests/Feature/AdnSmsTest.php and run.

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email at rahulhaque07@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

rahulhaque / adn-sms

Maintainers

Details