🎁 Laravel SMS Gateway

This is a Laravel Package for SMS Gateway Integration. Now sending SMS is easy and reliable.

List of supported gateways:

• AWS SNS

• Textlocal

• Twilio

• Clockwork

• LINK Mobility

• Kavenegar

• Melipayamak

• Melipayamakpattern

• Smsir

• Tsms

• Farazsms

• Farazsmspattern

• SMS Gateway Me

• SmsGateWay24

• Ghasedak

• Sms77

• SabaPayamak

• LSim

• Rahyabcp

• Rahyabir

• D7networks

• Hamyarsms

• SMSApi

• Others are under way.

📦 Install

Via Composer

$ composer require tzsk/sms

⚡ Configure

Publish the configuration file:

$ php artisan sms:publish

In the configuration file, you can set the default driver to use for sending your SMS messages. However, you can also seamlessly change the driver at runtime.

Choose the gateway you would like to use for your application. Then, set it as the default driver so that you do not have to specify it every time. You can also configure and use multiple gateways within the same project.

// Eg. if you want 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',
        'from' => 'Your AWS SNS Sender ID', //sender
        'type' => 'Tansactional', // Or: 'Promotional'
    ],
    ...
]

Textlocal Configuration:

Textlocal is added by default. You simply need to update the credentials in the textlocal driver section.

AWS SNS Configuration:

If you want to use AWS SNS, you must install the required composer library first:

composer require aws/aws-sdk-php

Clockwork Configuration:

If you want to use Clockwork, you must install the required composer library first:

composer require mediaburst/clockworksms

Twilio Configuration:

If you want to use Twilio, you must install the required composer library first:

composer require twilio/sdk

Then, simply update the credentials in the twilio driver section.

Melipayamak or Melipayamakpattern Configuration:

If you want to use Melipayamak or Melipayamakpattern, you must install the required composer library first:

composer require melipayamak/php

Kavenegar Configuration:

If you want to use Kavenegar, you must install the required composer library first:

composer require kavenegar/php

SMS Gateway Me Configuration:

If you want to use SMS Gateway Me, you must install the required composer library first:

composer require smsgatewayme/client

🔥 Usage

You can easily send SMS messages in your application code 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();

# Change the from|sender|sim value with from() option:

sms()->via('gateway')->send("this message")->from('Your From Number | Sender Value | Sim Value ')->to(['Number 1', 'Number 2'])->dispatch();

# Sending argument and pattern code in pattern drivers such as melipayamakpattern and farazsmspattern.

#Note: The first argument is always known as the pattern code.

sms()->via('melipayamakpattern')->send("patterncode=123 \n arg1=name \n arg2=family")->to(['Number 1', 'Number 2'])->dispatch();

Runtime Configuration

You can override the default gateway configuration at runtime:

# Override configuration for this specific SMS
Sms::via('gateway')
    ->config(['from' => 'CUSTOM-SENDER'])
    ->send('this message')
    ->to(['Number1', 'Number2'])
    ->dispatch();

😍 Channel Usage

First, you need to create your notification using the php artisan make:notification command. Then, the SmsChannel::class can be used as a notification channel like 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 implements ShouldQueue
{
    use Queueable;

    /**
     * Get the notification channels.
     *
     * @param  mixed  $notifiable
     * @return array|string
     */
    public function via($notifiable)
    {
        return [SmsChannel::class];
    }

    /**
     * Get the recipients 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 must define the name of your driver in the drivers array and specify any configuration parameters you need.

'drivers' => [
    'textlocal' => [...],
    'twilio' => [...],
    'my_driver' => [
        ... # Your Config Params here.
    ]
]

Next, you need to create a Driver Map Class that will be used to handle sending the SMS. Your driver class simply needs to extend Tzsk\Sms\Contracts\Driver.

For example, if you created a class: App\Packages\SMSDriver\MyDriver.

namespace App\Packages\SMSDriver;

use Tzsk\Sms\Contracts\Driver;

class MyDriver extends Driver
{
    /**
    * You Should implement these methods:
    *
    * 1. boot() -> (optional) Initialize any variable or configuration that you need.
    * 2. send() -> Main method to send messages.
    *
    * Note: settings array will be automatically assigned in Driver class' constructor.
    *
    * Example Given below:
    */

    /**
    * @var mixed
    */
    protected $client;

    protected function boot() : void
    {
        $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 create this class, you must specify it in the sms.php configuration file under the map section.

'map' => [
    ...
    'my_driver' => App\Packages\SMSDriver\MyDriver::class,
]

Note:- Ensure that the key of the map array is exactly 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

• Kazi Ahmed
• All Contributors

👮‍♂️ License

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