masum/sms-gateway

It is a Laravel package which will serve as gateway to send SMS through various providers. It supports multiple sms gateways, and easily extendable to support new gateways.

v2.0.0 2025-11-23 00:07 UTC

Requires

• messagebird/php-rest-api: ^3.1
• twilio/sdk: ^8.8
• vonage/client: ^4.2.0

MIT

• Al Masum Nishat

• twilio
• laravel
• nexmo
• bulksms
• messagebird
• laravel sms gateway
• SSL Wireless

README

A Laravel package that provides a unified interface to send SMS through various providers. It supports multiple SMS gateways and is easily extendable to support new gateways.

Features

• Multiple Provider Support: Twilio, Nexmo/Vonage, MessageBird, Dialog, BulkSMS Bangladesh, SSL Wireless
• Simple API: Unified interface across all providers
• Easy Configuration: Configure via .env file
• Extendable: Easy to add new SMS providers
• Laravel Integration: Seamless integration with Laravel applications

Supported Gateways

International Providers

• Twilio - Global SMS provider (Trial & Production)
• Nexmo/Vonage - Global SMS provider
• MessageBird - Global SMS provider
• Dialog - Sri Lanka SMS provider

Bangladesh Providers

• BulkSMS Bangladesh - Cost-effective local provider
• SSL Wireless - Local enterprise provider

Installation

Install the package via Composer:

composer require masum/sms-gateway

Publish Configuration

Publish the configuration file to your Laravel application:

php artisan vendor:publish --provider="Masum\SmsGateway\SmsServiceProvider"

This will create a config/sms_gateway.php file in your application.

Configuration

Environment Variables

Add your SMS provider credentials to your .env file:

# Twilio Configuration
TWILIO_SID="your_account_sid"
TWILIO_TOKEN="your_auth_token"
TWILIO_SMS_FROM="[phone]"

# Nexmo/Vonage Configuration
NEXMO_API_KEY="your_api_key"
NEXMO_API_SECRET="your_api_secret"
NEXMO_SMS_FROM="YourBrand"

# MessageBird Configuration
MESSAGE_BIRD_API_KEY="your_api_key"
MESSAGE_BIRD_SMS_FROM="[phone]"

# Dialog (Sri Lanka) Configuration
DIALOG_SMS_API_KEY="your_api_key"
DIALOG_SMS_ENDPOINT="your_endpoint"
DIALOG_SMS_FROM="YourBrand"

# BulkSMS Bangladesh Configuration
BULKSMSBD_API_KEY="your_api_key"
BULKSMSBD_SENDER_ID="8809601000000"

# SSL Wireless Configuration
SSL_WIRELESS_USER="your_username"
SSL_WIRELESS_PASS="your_password"
SSL_WIRELESS_SID="your_sender_id"

Configuration File

The published config/sms_gateway.php file contains settings for all supported providers:

return [
    'nexmo_sms_api_settings' => [
        'API_KEY' => env('NEXMO_API_KEY', ''),
        'API_SECRET' => env('NEXMO_API_SECRET', ''),
        'SEND_SMS_FROM' => env('NEXMO_SMS_FROM', 'YourBrand'),
    ],
    'twilio_sms_api_settings' => [
        'SID' => env('TWILIO_SID', ''),
        'TOKEN' => env('TWILIO_TOKEN', ''),
        'SEND_SMS_FROM' => env('TWILIO_SMS_FROM', '[phone]'),
    ],
    'message_bird_sms_api_settings' => [
        'API_KEY' => env('MESSAGE_BIRD_API_KEY', ''),
        'SEND_SMS_FROM' => env('MESSAGE_BIRD_SMS_FROM', '[phone]'),
    ],
    'dialog_sms_api_settings' => [
        'API_KEY' => env('DIALOG_SMS_API_KEY', ''),
        'ENDPOINT' => env('DIALOG_SMS_ENDPOINT', ''),
        'SEND_SMS_FROM' => env('DIALOG_SMS_FROM', 'YourBrand'),
    ],
    'bulksmsbd_sms_api_settings' => [
        'API_KEY' => env('BULKSMSBD_API_KEY', ''),
        'SENDER_ID' => env('BULKSMSBD_SENDER_ID', '8809601000000'),
    ],
    'ssl_wireless_sms_api_settings' => [
        'USER' => env('SSL_WIRELESS_USER', ''),
        'PASS' => env('SSL_WIRELESS_PASS', ''),
        'SID' => env('SSL_WIRELESS_SID', ''),
    ],
];

Usage

Basic Usage

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\TwilioSmsGateway;

// Create gateway instance
$gateway = new TwilioSmsGateway();
$sms = new SmsGateway($gateway);

// Send SMS
$sms->sendSms('[phone]', 'Hello from Laravel!');

// Get response data
$response = $sms->getResponseData();
echo "Status: " . $response->getStatus();
echo "Message ID: " . $response->getMessageId();

Dynamic Provider Selection

use Masum\SmsGateway\SmsGateway;

$provider = config('app.sms_provider', 'twilio');

$gateway = match ($provider) {
    'bulksmsbd' => new \Masum\SmsGateway\BulkSmsBdGateway(),
    'ssl_wireless' => new \Masum\SmsGateway\SslWirelessSmsGateway(),
    'nexmo' => new \Masum\SmsGateway\NexmoSmsGateway(),
    'message_bird' => new \Masum\SmsGateway\MessageBirdSmsGateway(),
    'dialog' => new \Masum\SmsGateway\DialogSmsGateway(),
    default => new \Masum\SmsGateway\TwilioSmsGateway(),
};

$sms = new SmsGateway($gateway);
$sms->sendSms($phoneNumber, $message);

Provider Specific Documentation

Twilio

Twilio is a cloud communications platform that allows developers to programmatically make and receive phone calls, send and receive text messages, and perform other communication functions.

Website: twilio.com

Documentation: Twilio API Docs

Trial Credit: $15.50 free credit for testing

Configuration

Add your Twilio credentials to .env:

TWILIO_SID="your_account_sid"
TWILIO_TOKEN="your_auth_token"
TWILIO_SMS_FROM="[phone]"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\TwilioSmsGateway;

$sms = new SmsGateway(new TwilioSmsGateway());
$sms->sendSms('[phone]', 'Hello from Twilio!');

Testing with Magic Numbers

For trial accounts, use Twilio's magic test numbers:

• FROM: [phone]
• TO: [phone], [phone], etc.

Nexmo/Vonage

Nexmo (now Vonage) provides innovative communication SMS and Voice APIs that enable applications and enterprises to easily connect to their customers.

Website: nexmo.com

Documentation: developer.nexmo.com

Trial Credit: 2 EUR free test credit

Configuration

Add your Nexmo credentials to .env:

NEXMO_API_KEY="your_api_key"
NEXMO_API_SECRET="your_api_secret"
NEXMO_SMS_FROM="YourBrand"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\NexmoSmsGateway;

$sms = new SmsGateway(new NexmoSmsGateway());
$sms->sendSms('[phone]', 'Hello from Nexmo!');

MessageBird

MessageBird provides powerful communication APIs and technical resources to help you build your communication solution.

Website: messagebird.com

Documentation: developers.messagebird.com

Trial Credit: 10 free SMS credits

Configuration

Add your MessageBird credentials to .env:

MESSAGE_BIRD_API_KEY="your_api_key"
MESSAGE_BIRD_SMS_FROM="[phone]"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\MessageBirdSmsGateway;

$sms = new SmsGateway(new MessageBirdSmsGateway());
$sms->sendSms('[phone]', 'Hello from MessageBird!');

Dialog (Sri Lanka)

Dialog Axiata PLC provides a Bulk SMS Solution that enables you to communicate via SMS to a mass list of customers/staff through an easy-to-use web portal.

Website: dialog.lk

Configuration

Add your Dialog credentials to .env:

DIALOG_SMS_API_KEY="your_api_key"
DIALOG_SMS_ENDPOINT="your_endpoint"
DIALOG_SMS_FROM="YourBrand"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\DialogSmsGateway;

$sms = new SmsGateway(new DialogSmsGateway());
$sms->sendSms('[phone]', 'Hello from Dialog!');

BulkSMS Bangladesh

BulkSMS Bangladesh is a cost-effective local SMS provider for Bangladesh. It automatically handles Bangladesh phone number formatting.

Phone Number Formats: Accepts [phone], 8801712345678, or 01712345678

Configuration

Add your BulkSMS BD credentials to .env:

BULKSMSBD_API_KEY="your_api_key"
BULKSMSBD_SENDER_ID="8809601000000"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\BulkSmsBdGateway;

$sms = new SmsGateway(new BulkSmsBdGateway());
$sms->sendSms('[phone]', 'Hello from BulkSMS BD!');

SSL Wireless

SSL Wireless is a local enterprise SMS provider for Bangladesh.

Phone Number Format: Requires full international format (+8801XXXXXXXXX)

Configuration

Add your SSL Wireless credentials to .env:

SSL_WIRELESS_USER="your_username"
SSL_WIRELESS_PASS="your_password"
SSL_WIRELESS_SID="your_sender_id"

Usage Example

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\SslWirelessSmsGateway;

$sms = new SmsGateway(new SslWirelessSmsGateway());
$sms->sendSms('[phone]', 'Hello from SSL Wireless!');

Response Handling

All gateways return a ResponseData object with the following methods:

$response = $sms->getResponseData();

// Get response status
$status = $response->getStatus();

// Get unique message ID
$messageId = $response->getMessageId();

// Get message price (if available)
$price = $response->getMessagePrice();

Error Handling

Always wrap SMS sending in try-catch blocks for proper error handling:

use Masum\SmsGateway\SmsGateway;
use Masum\SmsGateway\TwilioSmsGateway;

try {
    $sms = new SmsGateway(new TwilioSmsGateway());
    $sms->sendSms('[phone]', 'Hello World!');

    $response = $sms->getResponseData();
    echo "SMS sent! Message ID: " . $response->getMessageId();
} catch (\Exception $e) {
    // Log the error
    \Log::error("SMS sending failed: " . $e->getMessage());

    // Handle the error gracefully
    echo "Failed to send SMS. Please try again.";
}

Extending the Package

To add support for a new SMS provider:

1. Create a new gateway class implementing SmsGatewayInterface:

namespace Masum\SmsGateway;

class CustomSmsGateway implements SmsGatewayInterface
{
    public function send($to, $message)
    {
        // Implementation
    }

    public function getResponseData(): ResponseData
    {
        // Implementation
    }
}

1. Add configuration to config/sms_gateway.php:

'custom_sms_api_settings' => [
    'API_KEY' => env('CUSTOM_SMS_API_KEY', ''),
    // Other settings
],

1. Use your new gateway:

$sms = new SmsGateway(new CustomSmsGateway());
$sms->sendSms('[phone]', 'Hello!');

Available Gateway Classes

• TwilioSmsGateway - Twilio SMS gateway
• NexmoSmsGateway - Nexmo/Vonage SMS gateway
• MessageBirdSmsGateway - MessageBird SMS gateway
• DialogSmsGateway - Dialog (Sri Lanka) SMS gateway
• BulkSmsBdGateway - BulkSMS Bangladesh gateway
• SslWirelessSmsGateway - SSL Wireless Bangladesh gateway

All classes implement the SmsGatewayInterface.

Requirements

• PHP >= 8.1
• Laravel >= 10.x
• Illuminate HTTP Client (for API requests)

Testing

Test your SMS integration using Laravel Tinker:

php artisan tinker

$sms = new \Masum\SmsGateway\SmsGateway(new \Masum\SmsGateway\TwilioSmsGateway());
$sms->sendSms('[phone]', 'Test message');
$response = $sms->getResponseData();
var_dump($response);

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/new-gateway)
3. Commit your changes (git commit -am 'Add new SMS gateway')
4. Push to the branch (git push origin feature/new-gateway)
5. Create a new Pull Request

You can also contribute by:

• Reporting bugs via Issues
• Suggesting improvements
• Writing tests
• Improving documentation

License

This package is open-sourced software licensed under the MIT license.

Support

For issues, questions, or feature requests:

• Email: [e-mail]
• Issues: GitHub Issues

Credits

• Author: Masum Nishat
• Email: [e-mail]
• GitHub: MasumNishat

Changelog

Version 1.0.0

• Initial release with Twilio, Nexmo, MessageBird, and Dialog support

Version 2.0.0 (Latest)

• Added BulkSMS Bangladesh gateway
• Added SSL Wireless Bangladesh gateway
• Improved phone number formatting for Bangladesh providers
• Updated configuration structure
• Enhanced error handling
• Updated documentation