README

A clean, modern, PSR-12 compliant, production-ready Laravel wrapper package for the BulkSMSBD SMS Gateway API.

Features

Core Class (BulkSmsBd\Laravel\BulkSmsBd): Formats and enriches every API response with status_message mapped from response_code and is_success indicator.
One-to-Many SMS (/api/smsapi): Accepts single, comma-separated string, or array of numbers with message content.
Many-to-Many SMS (/api/smsapimany): Accepts array of recipient objects [['to' => '...', 'message' => '...']].
Balance Check API (/api/getBalanceApi): Retrieves remaining credit balance (supports GET and POST methods).
Status Code Resolution: Dedicated BulkSmsBdException::$statusCodes and BulkSmsBdException::getMessageForCode($code) resolver.

Requirements

PHP: 8.1 or higher
Laravel Framework: 9.x, 10.x, or 11.x

Installation

Install the package via Composer:

composer require munshiprodip/bulksmsbd-laravel

Environment Setup (.env)

Add your BulkSMSBD credentials and settings directly into your project's .env file:

BULKSMSBD_API_KEY="your_bulksmsbd_api_key_here"
BULKSMSBD_SENDER_ID="your_approved_sender_id"
BULKSMSBD_BASE_URL="http://bulksmsbd.net"
BULKSMSBD_TIMEOUT=15
BULKSMSBD_THROW_EXCEPTIONS=true

Configuration Publishing (Optional)

Publish the package configuration file if you need to customize default settings:

php artisan vendor:publish --tag="bulksmsbd-config"

This generates config/bulksmsbd.php:

return [
    'api_key' => env('BULKSMSBD_API_KEY', ''),
    'sender_id' => env('BULKSMSBD_SENDER_ID', ''),
    'base_url' => env('BULKSMSBD_BASE_URL', 'http://bulksmsbd.net'),
    'timeout' => (int) env('BULKSMSBD_TIMEOUT', 15),
    'throw_exceptions' => (bool) env('BULKSMSBD_THROW_EXCEPTIONS', true),
];

3. Usage Examples in Laravel

use BulkSmsBd\Laravel\Facades\BulkSmsBd;

// 1. Check Credit Balance
$balanceInfo = BulkSmsBd::getBalance();
/*
  Returns: 
  [
    "response_code" => 202,
    "balance" => 49.65,
    "status_message" => "SMS Submitted Successfully",
    "is_success" => true
  ]
*/

// 2. Send Single / Bulk SMS
$response = BulkSmsBd::send('88016xxxxxxxx', 'Your OTP is 1234');

if ($response['is_success']) {
    // SMS Sent successfully
} else {
    // Show user-friendly error
    echo $response['status_message']; // e.g., "Insufficient Balance"
}

// 3. Send Many-to-Many SMS (Distinct messages to different numbers)
$manyResponse = BulkSmsBd::sendMany([
    ['to' => '8801711111111', 'message' => 'Hello User 1, your invoice is ready.'],
    ['to' => '8801822222222', 'message' => 'Hello User 2, your invoice is ready.'],
]);

Direct Status Code Resolution

use BulkSmsBd\Laravel\Exceptions\BulkSmsBdException;

$message = BulkSmsBdException::getMessageForCode(1007);
// Returns: "Insufficient Balance"

Support & Rating Request ⭐

If you find this package helpful for your Laravel applications, please take a moment to Star ⭐ the repository on GitHub and share your rating! Your support helps other developers discover this package and encourages active maintenance.

GitHub Repository: munshiprodip/bulksmsbd-laravel
Packagist Package: munshiprodip/bulksmsbd-laravel

Author

Prodip Munshi - munshiprodip@gmail.com

License

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

munshiprodip / bulksmsbd-laravel

Maintainers

Package info

Statistics

Security