LaravelPackages.net
Acme Inc.
Toggle sidebar
misfit/robisms

Laravel package for Robi/AdaReach Business SMS API integration

379
0
Github Packagist
About misfit/robisms

misfit/robisms is a Laravel package for laravel package for robi/adareach business sms api integration. It currently has 0 GitHub stars and 379 downloads on Packagist. Install it with composer require misfit/robisms. Discover more Laravel packages by misfit or browse all Laravel packages to compare alternatives.

Last updated

AdaReach SMS - Laravel Package & Standalone Library

Latest Version on Packagist Total Downloads License PHP Version

A comprehensive PHP package for integrating with AdaReach (Robi/MobiReach) Business SMS API. Works seamlessly with Laravel or as a standalone PHP library (PHP 7.4+).

πŸ“‘ Table of Contents

✨ Features

Core Features

  • βœ… Send single and bulk SMS messages
  • βœ… Phone auto-normalization (01XXX β†’ 880XXX, +880XXX β†’ 880XXX)
  • βœ… Bangla/Unicode auto-detection
  • βœ… Real-time SMS delivery tracking
  • βœ… Balance checking (API & GUI balance)
  • βœ… PHP 7.4+ compatible
  • βœ… Works without Laravel (Standalone mode)
  • βœ… Token-based authentication with auto-refresh
  • βœ… File-based token caching

Dashboard Features

  • 🎨 Modern, responsive UI with tabs
  • πŸ“Š Character counter with SMS parts calculation
  • πŸ“± Single & Bulk SMS sending
  • πŸ’° Real-time balance display
  • πŸ” Credential management
  • πŸ“„ Message history (Laravel mode)
  • πŸ“ˆ Analytics and statistics (Laravel mode)

Security

  • πŸ”’ Token-based authentication with auto-refresh
  • πŸ” Encrypted credentials (Laravel mode)
  • πŸ’Ύ File-based token caching (Standalone mode)
  • πŸ›‘οΈ Database-backed configuration (Laravel mode)

πŸ“‹ Requirements

Laravel Requirements

  • PHP 8.1 or higher
  • Laravel 10.x or 11.x
  • MySQL/PostgreSQL database
  • Redis (optional, for caching)
  • Node.js 16+ (for dashboard assets)

Standalone Requirements

  • PHP 7.4 or higher (PHP 7.4, 8.0, 8.1, 8.2, 8.3)
  • cURL extension
  • JSON extension
  • Composer

🎯 Laravel Installation

Perfect for Laravel applications with full dashboard, analytics, and database integration.

Step 1: Install Package

composer require chandan07cse/robi-sms

Step 2: Publish Configuration & Assets

# Publish config, migrations, and assets
php artisan vendor:publish --provider="AdaReach\Sms\AdaReachServiceProvider"

# Run migrations
php artisan migrate

# Build dashboard assets (optional)
npm install && npm run build

Step 3: Configure Environment

Add these to your .env file:

ADAREARCH_USERNAME=your_username ADAREARCH_PASSWORD=your_password ADAREARCH_BASE_URL=https://api.mobireach.com.bd ADAREARCH_DEFAULT_SENDER=8801XXXXXXXXX

Step 4: Usage in Laravel

use AdaReach\Sms\Facades\AdaReach;

// Send single SMS
$response = AdaReach::sendSms('01703611094', 'Hello from Laravel!');

// Send bulk SMS
$response = AdaReach::sendBulkSms(
    ['01703611094', '01812345678'],
    'Bulk message'
);

// Check balance
$balance = AdaReach::getBalance();

// Get account info
$info = AdaReach::getAccountInfo();

Step 5: Access Dashboard

Visit your Laravel SMS dashboard:

http://your-laravel-app.test/sms-dashboard

Dashboard Features:

  • πŸ“Š Real-time analytics & statistics
  • πŸ“± Send single & bulk SMS
  • πŸ’° Balance monitoring
  • πŸ“ˆ Message history & tracking
  • πŸ” Credential management
  • πŸ“„ Export message logs

πŸš€ Standalone Installation (Without Laravel)

Perfect for plain PHP projects, WordPress, custom frameworks, or any PHP 7.4+ application.

Step 1: Install via Composer

composer require chandan07cse/robi-sms

Step 2: Basic Setup

<?php
require_once __DIR__ . '/vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

// Initialize client
$client = new StandaloneClient(
    'your_username',
    'your_password',
    'YourSenderID'  // Optional but recommended
);

// Send SMS
try {
    $response = $client->sendSms('01703611094', 'Hello from PHP!');
    
    if ($response['status'] === 'SUCCESS') {
        echo "βœ… SMS sent! Message ID: " . $response['id'];
    }
} catch (Exception $e) {
    echo "❌ Error: " . $e->getMessage();
}

Send Bulk SMS

$phones = ['01703611094', '01812345678', '01956789012'];
$message = 'Hello everyone!';

$response = $client->sendBulkSms($phones, $message);

echo "Sent to " . count($response['successful']) . " numbers";
foreach ($response['failed'] as $failed) {
    echo "Failed: {$failed['phone']} - {$failed['error']}\n";
}

Check Balance

// Get current balance
$balance = $client->getBalance();
echo "Current balance: {$balance} BDT\n";

// Get detailed account info
$accountInfo = $client->getAccountInfo();
print_r($accountInfo);

Advanced Configuration

$client = new StandaloneClient(
    'username',
    'password',
    'SenderID',
    'https://api.mobireach.com.bd',  // Custom base URL
    '/path/to/cache'                  // Custom cache directory
);

// Change sender ID dynamically
$client->setSender('NewSenderID');

// Get current sender
$currentSender = $client->getSender();

Dashboard Setup (Optional)

Add ONE line to your index.php or routing file:

require __DIR__ . '/vendor/chandan07cse/robi-sms/routes/sms-dashboard.php';

Then visit: http://yoursite.com/sms-dashboard

Alternative Methods:

Using .htaccess (Apache):

RewriteEngine On
RewriteRule ^sms-dashboard$ vendor/chandan07cse/robi-sms/public/sms-dashboard.php [L]

Using Nginx:

location /sms-dashboard {
    rewrite ^/sms-dashboard$ /vendor/chandan07cse/robi-sms/public/sms-dashboard.php last;
}

PHP Built-in Server (Development):

cd vendor/chandan07cse/robi-sms/public
php -S localhost:8080 sms-dashboard.php

Environment Configuration:

Create .env file in your project root:

ADAREARCH_USERNAME=your_username ADAREARCH_PASSWORD=your_password ADAREARCH_DEFAULT_SENDER=8801XXXXXXXXX

πŸ“± Phone Number Formats

The package automatically normalizes phone numbers. All these formats work:

// All these are normalized to: 8801703611094

$client->sendSms('01703611094', 'Test');       // βœ… Auto-adds 880
$client->sendSms('1703611094', 'Test');        // βœ… Auto-adds 880
$client->sendSms('8801703611094', 'Test');     // βœ… Works as-is
$client->sendSms('+8801703611094', 'Test');    // βœ… Auto-removes +

How it Works

  1. Starts with +880 β†’ Removes + β†’ 8801703611094
  2. Starts with 880 β†’ No change β†’ 8801703611094
  3. Starts with 01 β†’ Replaces with 880 β†’ 8801703611094
  4. Starts with 1 β†’ Adds 880 prefix β†’ 8801703611094

πŸ‡§πŸ‡© Bangla/Unicode SMS

The package automatically detects Bangla/Unicode characters and sets the correct content type.

Auto-Detection

// English SMS (contentType=1, 160 chars/SMS)
$client->sendSms('01703611094', 'Hello World');

// Bangla SMS (contentType=2, 70 chars/SMS) - AUTO-DETECTED
$client->sendSms('01703611094', 'হ্যালো বাংলা!');

// Mixed content (Unicode auto-detected)
$client->sendSms('01703611094', 'Hello হ্যালো 123');

// Emoji (Unicode auto-detected)
$client->sendSms('01703611094', 'Hello πŸ‘‹ World 🌍');

Character Limits

| Content Type | Characters per SMS | Detection | |--------------|-------------------|-----------| | English/ASCII | 160 characters | Automatic | | Bangla/Unicode | 70 characters | Automatic | | Emoji/Special | 70 characters | Automatic |

Manual Override

// Force Unicode (not recommended, auto-detection is better)
$response = $client->sendSms('01703611094', 'Test', null, true);

πŸ“š API Reference

StandaloneClient

Constructor

public function __construct(
    string $username,
    string $password,
    string $sender = null,
    string $baseUrl = 'https://api.mobireach.com.bd',
    string $cacheDir = null
)

Methods

sendSms()

Send SMS to a single recipient.

public function sendSms(
    string $phone,
    string $message,
    string $sender = null,
    bool $isUnicode = null
): array

Parameters:

  • $phone - Phone number (auto-normalized)
  • $message - SMS content
  • $sender - Sender ID (optional, uses default if not provided)
  • $isUnicode - Force Unicode mode (optional, auto-detected if null)

Returns:

[
    'status' => 'SUCCESS',
    'id' => 'message_id',
    'phone' => '8801703611094',
    'message' => 'Your message',
    'sender' => 'SenderID'
]
sendBulkSms()

Send SMS to multiple recipients.

public function sendBulkSms(
    array $phones,
    string $message,
    string $sender = null,
    bool $isUnicode = null
): array

Returns:

[
    'status' => 'SUCCESS',
    'successful' => ['8801703611094', '8801812345678'],
    'failed' => [],
    'total' => 2
]
getBalance()

Check account balance.

public function getBalance(): float

Returns: Balance amount (float)

getAccountInfo()

Get detailed account information.

public function getAccountInfo(): array

Returns:

[
    'balance' => 1000.50,
    'username' => 'your_username',
    'api_url' => 'https://api.mobireach.com.bd'
]
setSender()

Set or change the sender ID.

public function setSender(string $sender): self
getSender()

Get current sender ID.

public function getSender(): ?string

πŸ’‘ Examples

Example 1: Simple SMS Sending

<?php
require 'vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

$client = new StandaloneClient('username', 'password', 'MySender');

try {
    $result = $client->sendSms('01703611094', 'Hello from AdaReach!');
    echo "Success! Message ID: " . $result['id'];
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}

Example 2: Bulk SMS with Loop

<?php
require 'vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

$client = new StandaloneClient('username', 'password', 'MySender');

// Read phones from database or CSV
$users = [
    ['phone' => '01703611094', 'name' => 'John'],
    ['phone' => '01812345678', 'name' => 'Jane'],
    ['phone' => '01956789012', 'name' => 'Bob']
];

foreach ($users as $user) {
    $message = "Hello {$user['name']}, Welcome to our service!";
    
    try {
        $result = $client->sendSms($user['phone'], $message);
        echo "βœ… Sent to {$user['name']}: {$result['id']}\n";
    } catch (Exception $e) {
        echo "❌ Failed for {$user['name']}: {$e->getMessage()}\n";
    }
    
    // Rate limiting (optional)
    sleep(1);
}

Example 3: Check Balance Before Sending

<?php
require 'vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

$client = new StandaloneClient('username', 'password', 'MySender');

// Check balance first
$balance = $client->getBalance();
echo "Current balance: {$balance} BDT\n";

if ($balance < 10) {
    die("Insufficient balance! Please recharge.\n");
}

// Send SMS
$result = $client->sendSms('01703611094', 'Your OTP is: 123456');
echo "OTP sent! Message ID: " . $result['id'];

Example 4: Bangla SMS with Error Handling

<?php
require 'vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

$client = new StandaloneClient('username', 'password', 'MySender');

$phones = ['01703611094', '01812345678'];
$message = 'আΰ¦ͺনার অর্঑ার সফল হয়েছেΰ₯€ ধন্যবাদ!';

foreach ($phones as $phone) {
    try {
        $result = $client->sendSms($phone, $message);
        
        if ($result['status'] === 'SUCCESS') {
            echo "βœ… Sent to {$phone}\n";
        } else {
            echo "❌ Failed to {$phone}: " . ($result['error'] ?? 'Unknown error') . "\n";
        }
    } catch (Exception $e) {
        echo "❌ Exception for {$phone}: {$e->getMessage()}\n";
    }
}

Example 5: Using with Database

<?php
require 'vendor/autoload.php';

use AdaReach\Sms\StandaloneClient;

$client = new StandaloneClient('username', 'password', 'MySender');

// Connect to database
$pdo = new PDO('mysql:host=localhost;dbname=mydb', 'user', 'pass');

// Get pending SMS from database
$stmt = $pdo->query("SELECT id, phone, message FROM pending_sms WHERE sent = 0 LIMIT 100");

while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
    try {
        $result = $client->sendSms($row['phone'], $row['message']);
        
        // Update database
        $update = $pdo->prepare("UPDATE pending_sms SET sent = 1, message_id = ?, sent_at = NOW() WHERE id = ?");
        $update->execute([$result['id'], $row['id']]);
        
        echo "βœ… Sent SMS ID: {$row['id']}\n";
    } catch (Exception $e) {
        // Log error
        $error = $pdo->prepare("UPDATE pending_sms SET error = ? WHERE id = ?");
        $error->execute([$e->getMessage(), $row['id']]);
        
        echo "❌ Failed SMS ID: {$row['id']}\n";
    }
}

πŸ”§ Troubleshooting

Common Issues

1. Error 1510: "New API Other Error"

Cause: Using old API parameter names.

Solution: Update to latest version:

composer update chandan07cse/robi-sms

2. Phone Number Not Working

Cause: Invalid phone format.

Solution: Use any of these formats (auto-normalized):

'01703611094'      // βœ… Recommended
'8801703611094'    // βœ… Also works
'+8801703611094'   // βœ… Also works

3. Bangla SMS Not Sending

Cause: Old version without Unicode detection.

Solution: Update to latest version. Unicode is now auto-detected:

composer update chandan07cse/robi-sms

4. Dashboard Not Loading

Cause: Route not registered or .env not configured.

Solution:

  1. Add route include: 
    require __DIR__ . '/vendor/chandan07cse/robi-sms/routes/sms-dashboard.php';
  2. Create .env file with credentials

5. Token Cache Issues

Cause: No write permissions on cache directory.

Solution:

# Create cache directory
mkdir -p storage/cache/sms

# Set permissions
chmod -R 755 storage/cache/sms

Debug Mode

Enable debug mode to see detailed API responses:

$client = new StandaloneClient('user', 'pass', 'sender');

try {
    $result = $client->sendSms('01703611094', 'Test');
    print_r($result);  // See full response
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
    echo "\nTrace: " . $e->getTraceAsString();
}

πŸ“ Changelog

[v2.1.0] - 2026-01-31

πŸ› Critical Bug Fix - SMS Sending Now Works!

Fixed Error 1510 - Standalone client was using incorrect API parameter names.

Fixed:

  • βœ… Corrected AdaReach API parameter names in StandaloneClient
    • Changed recipients β†’ receiver (API requirement)
    • Changed text β†’ content (API requirement)
    • Added msgType = 'T' (Transactional/Promotional flag)
    • Added requestType = 'S'/'B' (Single/Bulk detection)
    • Added contentType = 1/2 (Regular text/Unicode flag)

Impact:

  • βœ… SMS sending now works correctly in standalone mode
  • βœ… Fixes Error 1510 "New API Other Error"
  • βœ… No breaking changes - existing code works as-is

[v2.0.0] - 2026-01-31

πŸŽ‰ Major Release - PHP 7.4+ Support & Standalone Mode

Added:

  • βœ… Standalone Client for use without Laravel
  • βœ… PHP 7.4, 8.0, 8.1, 8.2, 8.3 support
  • βœ… Phone number auto-normalization (01XXX β†’ 880XXX)
  • βœ… Bangla/Unicode auto-detection
  • βœ… Ready-to-use SMS dashboard
  • βœ… File-based token caching
  • βœ… cURL-based HTTP client

πŸ“„ License

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

🀝 Support

πŸ™ Credits

Made with ❀️ for the PHP community

Comments
chandan07cse
chandan07cse's Packages Github Profile
Get paid by clients abroad Affiliate link

Wise gives you local bank details in several currencies and converts at the mid-market rate. Useful when your invoices are not in your own currency.

Try Wise

Star History Chart