djunehor / laravel-sms
Send SMS from your laravel application
Installs: 3 312
Dependents: 1
Suggesters: 0
Security: 0
Stars: 37
Watchers: 2
Forks: 20
Open Issues: 2
Requires
- php: >=7.1
- guzzlehttp/guzzle: >=6.5.x-dev
Requires (Dev)
- orchestra/testbench: >=3.5.x-dev
- phpunit/phpunit: >=6.0
This package is auto-updated.
Last update: 2024-11-05 01:09:33 UTC
README
Laravel SMS allows you to send SMS from your Laravel application using one of over 10 sms providers, or your own sms provider.
Requirements
- PHP >=7.1
Installation
Step 1
You can install the package via composer:
composer require djunehor/laravel-sms
Laravel 5.5 and above
The package will automatically register itself, so you can start using it immediately.
Laravel 5.4 and older
In Laravel version 5.4 and older, you have to add the service provider in config/app.php
file manually:
'providers' => [ // ... Djunehor\Sms\SmsServiceProvider::class, ];
Lumen
After installing the package, you will have to register it in bootstrap/app.php
file manually:
// Register Service Providers // ... $app->register(Djunehor\Sms\SmsServiceProvider::class); ];
Env Keys
SMS_SENDER= BETASMS_USERNAME= BETASMS_PASSWORD= BULK_SMS_NIGERIA_TOKEN= BULK_SMS_NIGERIA_DND= GOLD_SMS_247_USERNAME= GOLD_SMS_247_PASSWORD= MULTITEXTER_USERNAME= MULTITEXTER_PASSWORD= SMART_SMS_TOKEN= XWIRELESS_API_KEY= XWIRELESS_CLIENT_ID= NEXMO_API_KEY= NEXMO_API_SECRET= RING_CAPTCHA_APP_KEY= RING_CAPTCHA_API_KEY= RING_CAPTCHA_APP_SECRET= AFRICASTALKING_API_KEY= AFRICASTALKING_USERNAME= NIGERIAN_BULK_SMS_USERNAME= NIGERIAN_BULK_SMS_PASSWORD= KUDI_SMS_USERNAME= KUDI_SMS_PASSWORD= MEBO_SMS_API_KEY= SMSLIVE247_TOKEN= INFOBIP_BASE_URL= INFOBIP_USERNAME= INFOBIP_PASSWORD=
Step 2 - Publishing files
Run:
php artisan vendor:publish --tag=laravel-sms
This will move the migration file, seeder file and config file to your app. You can set your sms details in the config file or via env
Step 3 - Adding SMS credentials
- Add the env keys to your
.env
file - Or edit the config/laravel-sms.php file
Usage
//using betaSMS use Djunehor\Sms\BetaSms; $sms = new BetaSms(); $sms->text($message)->to(08135087966)->from('MyLaravel')->send(); //returns true if everything went fine. Or false if error occured. //You can get exception via getException() or get the server response via getResponse() //exceptions will be logged in your laravel log file
Using Helper function
//MeboSms $send = send_sms($message, $to, $from, MeboSms::class); //returns true/false
The default SMS provider is Nexmo. You can set the default SMS provider in config/laravel-sms.php
e.g 'default' => \Djunehor\Sms\Concrete\SmartSmsSolutions::class,
, so you can use the helper function like this:
$send = send_sms($message, $to); //$from is optional and is better set in the config
Available SMS Providers
Note: For smartSmsSolutions, you have to whitelist the sender on the platform before using, else smartsms will automatically change your senderId when sending - #6
Creating custom SMS Provider
- Create a class that extends
Djunehor\Sms\Concrete\Sms
class - Implement the
send()
which makes the request and return bool - (Optional) You can add the provider keys to the config/laravel-sms.php
Contributing
- Fork this project
- Clone your forked repo
- Make your changes and run tests
composer test
- Push and create Pull Request
- Make sure your PR passes all checks