Download the PHP package rahulhaque/adn-sms without Composer
On this page you can find all versions of the php package rahulhaque/adn-sms. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rahulhaque/adn-sms
More information about rahulhaque/adn-sms
Files in rahulhaque/adn-sms
Package adn-sms
Short Description ADN SMS gateway API package for Laravel.
License MIT
Homepage https://github.com/rahulhaque/adn-sms-laravel
Informations about the package adn-sms
ADN SMS Laravel
ADN SMS gateway API package for Laravel.
Installation
You can install the package via composer in your Laravel or Lumen application.
Laravel
Publish the configuration file config/adn-sms.php
where you can tweak some default options.
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.
Enable use of Facades
in your Lumen application by uncommenting the line $app->withFacades();
call in the bootstrap/app.php
file.
Register the service provider in the Register Service Providers section of the bootstrap/app.php
file.
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.
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.
OTP SMS
Send OTP SMS to single recipient.
Bulk SMS
Send single SMS to multiple recipients.
Bulk SMS sending requires campaignTitle()
as mandatory.
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.
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
Check SMS Status
To check already sent SMS status, simply call the checkSmsStatus()
method with SMS UID.
Check Campaign Status
To check already sent SMS campaign status, simply call the checkCampaignStatus()
method with campaign UID.
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.
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 [email protected] instead of using the issue tracker.
Credits
- Rahul Haque
- All Contributors
License
The MIT License (MIT). Please see License File for more information.