saber13812002 / sms
Laravel SMS Gateway Integration Package
Fund package maintenance!
tzsk
paypal.me/KMAhmed
Requires
- php: ^7.4|^8.0
- guzzlehttp/guzzle: ^7.0
- illuminate/http: ^7.0|^8.0
- illuminate/support: ^7.0|^8.0
Requires (Dev)
- aws/aws-sdk-php: ^3.87
- friendsofphp/php-cs-fixer: ^3.0
- kavenegar/php: ^1.2
- laravel/legacy-factories: ^1.0
- mediaburst/clockworksms: ^2.0
- melipayamak/php: ^1.0.0
- orchestra/testbench: ^5.0|^6.0
- phpunit/phpunit: ^9.3
- smsgatewayme/client: ^0.0.1
- twilio/sdk: ^6.0
- vimeo/psalm: ^4.0
README
This is a Laravel Package for SMS Gateway Integration. Now Sending SMS is easy.
List of supported gateways:
-
Others are under way.
📦 Install
Via Composer
$ composer require tzsk/sms
⚡ Configure
Publish the config file
$ php artisan sms:publish
In the config file you can set the default driver to use for all your SMS. But you can also change the driver at runtime.
Choose what gateway you would like to use for your application. Then make that as default driver so that you don't have to specify that everywhere. But, you can also use multiple gateways in a project.
// Eg. if you wan to use SNS. 'default' => 'sns',
Then fill the credentials for that gateway in the drivers array.
// Eg. for SNS. 'drivers' => [ 'sns' => [ // Fill all the credentials here. 'key' => 'Your AWS SNS Access Key', 'secret' => 'Your AWS SNS Secret Key', 'region' => 'Your AWS SNS Region', 'sender' => 'Your AWS SNS Sender ID', 'type' => 'Tansactional', // Or: 'Promotional' ], ... ]
Textlocal Configuration:
Textlocal is added by default. You just have to change the creadentials in the textlocal
driver section.
AWS SNS Configuration:
In case you want to use AWS SNS. Then you have to pull a composer library first.
composer require aws/aws-sdk-php
Clockwork Configuration:
In case you want to use Clockwork. Then you have to pull a composer library first.
composer require mediaburst/clockworksms
Twilio Configuration:
In case you want to use Twilio. Then you have to pull a composer library first.
composer require twilio/sdk
Then you just have to change the creadentials in the twilio
driver section.
Melipayamak Configuration:
In case you want to use Melipayamak. Then you have to pull a composer library first.
composer require melipayamak/php
Kavenegar Configuration:
In case you want to use Kavenegar. Then you have to pull a composer library first.
composer require kavenegar/php
SMS Gateway Me Configuration:
In case you want to use SMS Gateway Me. Then you have to pull a composer library first.
composer require smsgatewayme/client
🔥 Usage
In your code just use it like this.
# On the top of the file. use Tzsk\Sms\Facades\Sms; ... # In your Controller. Sms::send("this message", function($sms) { $sms->to(['Number 1', 'Number 2']); # The numbers to send to. }); # OR... Sms::send("this message")->to(['Number 1', 'Number 2'])->dispatch(); # If you want to use a different driver. Sms::via('gateway')->send("this message", function($sms) { $sms->to(['Number 1', 'Number 2']); }); # OR... Sms::via('gateway')->send("this message")->to(['Number 1', 'Number 2'])->dispatch(); # Here gateway is explicit : 'twilio' or 'textlocal' or any other driver in the config. # The numbers can be a single string as well. # If you are not a Laravel's facade fan, you can use sms helper: sms()->send("this message", function($sms) { $sms->to(['Number 1', 'Number 2']); # The numbers to send to. }); sms()->send("this message")->to(['Number 1', 'Number 2'])->dispatch(); sms()->via('gateway')->send("this message", function($sms) { $sms->to(['Number 1', 'Number 2']); }); sms()->via('gateway')->send("this message")->to(['Number 1', 'Number 2'])->dispatch();
😍 Channel Usage
First you have to create your notification using php artisan make:notification
command.
then SmsChannel::class
can be used as channel like the below:
namespace App\Notifications; use Tzsk\Sms\Builder; use Illuminate\Bus\Queueable; use Tzsk\Sms\Channels\SmsChannel; use Illuminate\Notifications\Notification; use Illuminate\Contracts\Queue\ShouldQueue; class InvoicePaid extends Notification { use Queueable; /** * Get the notification channels. * * @param mixed $notifiable * @return array|string */ public function via($notifiable) { return [SmsChannel::class]; } /** * Get the repicients and body of the notification. * * @param mixed $notifiable * @return Builder */ public function toSms($notifiable) { return (new Builder)->via('gateway') # via() is Optional ->send('this message') ->to('some number'); } }
Tip: You can use the same Builder Instance in the send method.
$builder = (new Builder)->via('gateway') # via() is Optional ->send('this message') ->to('some number'); Sms::send($builder); # OR... $builder = (new Builder)->send('this message') ->to(['some number']); Sms::via('gateway')->send($builder);
Custom Made Driver, How To:
First you have to name your driver in the drivers array and also you can specify any config params you want.
'drivers' => [ 'textlocal' => [...], 'twilio' => [...], 'my_driver' => [ ... # Your Config Params here. ] ]
Now you have to create a Driver Map Class that will be used to send the SMS.
In your driver, You just have to extend Tzsk\Sms\Contracts\Driver
.
Ex. You created a class : App\Packages\SMSDriver\MyDriver
.
namespace App\Packages\SMSDriver; use Tzsk\Sms\Contracts\Driver; class MyDriver extends Driver { # You will have to make 2 methods. /** * 1. __constructor($settings) # {Mandatory} This settings is your Config Params that you've set. * 2. send() # (Mandatory) This is the main message that will be sent. * * Example Given below: */ /** * @var array */ protected $settings; /** * @var mixed */ protected $client; /** * Your Driver Config. * * @var array $settings */ public function __construct($settings) { $this->settings = $settings; # Initialize any Client that you want. $this->client = new Client(); # Guzzle Client for example. } /** * @return object Ex.: (object) ['status' => true, 'data' => 'Client Response Data']; */ public function send() { $this->recipients; # Array of Recipients. $this->body; # SMS Body. # Main logic of Sending SMS. ... } }
Once you crate that class you have to specify it in the sms.php
Config file map
section.
'map' => [ ... 'my_driver' => App\Packages\SMSDriver\MyDriver::class, ]
Note:- You have to make sure that the key of the map
array is identical to the key of the drivers
array.
🔬 Testing
composer test
📅 Changelog
Please see CHANGELOG for more information on what has changed recently.
❤️ Contributing
Please see CONTRIBUTING for details.
🔒 Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
👑 Credits
👮♂️ License
The MIT License (MIT). Please see License File for more information.