Zender PHP & Laravel SDK

A modern, fluent, feature-complete PHP SDK and Laravel Package for the Zender Messaging Platform (SMS, WhatsApp, OTP, USSD, Gateway Devices & Contacts management).

Features

• ⚡ Full API Coverage: 100% support for all 54 Zender REST API endpoints.
• 📱 SMS Integration: Single SMS, Bulk SMS, SMS Campaigns (Start/Stop), Sent/Received/Pending message logs.
• 💬 WhatsApp Integration: Text chats, Media attachments (Images, Audio, Video), Documents (PDF, XML, DOC, XLSX), Group Messaging, WhatsApp Number Validation, Linked Accounts & QR status.
• 🔐 OTP Engine: Send auto-expiring OTP codes via SMS or WhatsApp and verify them with a single call.
• 📞 USSD Automation: Send USSD codes and inspect response logs.
• 📇 Contacts & Groups: Manage contact books, groups, and unsubscribed contact lists.
• 🤖 Android Gateways: Fetch gateway devices, manage notifications.
• 🚀 Laravel Ready: Auto-discovery, configuration publishing, container binding, and fluent Facade syntax (Zender::sms()->send(...)).
• 🛠️ Pure PHP Supported: Works seamlessly in standard PHP applications without framework dependencies.

Requirements

• PHP ^8.1 or higher
• guzzlehttp/guzzle: ^7.5
• For Laravel integration: Laravel ^9.0, ^10.0, ^11.0, or ^12.0

Installation

Install the package via Composer:

composer require limon/laravel-zender

Laravel Setup

1. Configuration

If using Laravel, the service provider and facade will be automatically registered via Package Auto-Discovery.

Publish the configuration file using:

php artisan vendor:publish --tag=zender-config

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

2. Environment Variables

Add your Zender Site URL and API Secret (copied from your Zender Dashboard under Tools -> API Keys) to your .env file:

ZENDER_SITE_URL=https://sms.yourdomain.com/
ZENDER_API_SECRET=your_api_secret_here
ZENDER_TIMEOUT=30
ZENDER_VERIFY_SSL=true

Laravel Usage Examples

1. Send SMS Messages

use Zender\Laravel\Facades\Zender;

// Send Single SMS via Gateway Device
$response = Zender::sms()->send([
    'mode' => 'devices',
    'phone' => '+1234567890',
    'message' => 'Hello! {Your order #1001 is now shipped.|Thank you for your purchase!}',
    'device' => 'DEVICE_UNIQUE_ID',
    'sim' => 1,
    'priority' => 1, // 1 = Immediate, 2 = Queued
]);

// Send Bulk SMS
$response = Zender::sms()->sendBulk([
    'mode' => 'gateways',
    'campaign' => 'Summer Discount Campaign',
    'message' => 'Special offer for you!',
    'numbers' => '+1234567890,+9876543210',
    'gateway' => 5,
]);

2. Send WhatsApp Messages & Attachments

// Send WhatsApp Text Message
$response = Zender::whatsapp()->send([
    'account' => 'WA_ACCOUNT_UNIQUE_ID',
    'recipient' => '+1234567890',
    'message' => 'Hello via WhatsApp!',
]);

// Send WhatsApp Image/Media via Direct URL
$response = Zender::whatsapp()->send([
    'account' => 'WA_ACCOUNT_UNIQUE_ID',
    'recipient' => '+1234567890',
    'type' => 'media',
    'message' => 'Check out our new catalog!',
    'media_url' => 'https://example.com/catalog.jpg',
    'media_type' => 'image', // image, audio, or video
]);

// Send WhatsApp PDF Document from local file
$response = Zender::whatsapp()->send([
    'account' => 'WA_ACCOUNT_UNIQUE_ID',
    'recipient' => '+1234567890',
    'type' => 'document',
    'message' => 'Attached invoice',
    'document_file' => storage_path('app/invoices/inv_1001.pdf'),
]);

// Validate if a number exists on WhatsApp
$validation = Zender::whatsapp()->validate('WA_ACCOUNT_UNIQUE_ID', '+1234567890');

3. Send & Verify OTP Codes

// Send OTP via SMS
$otp = Zender::otp()->send([
    'type' => 'sms',
    'phone' => '+1234567890',
    'message' => 'Your security code is {otp}. Valid for 5 minutes.',
    'expire' => 5,
    'mode' => 'devices',
    'device' => 'DEVICE_UNIQUE_ID',
]);

// Verify User Inputted OTP
$verification = Zender::otp()->verify('543210');

if ($verification['status'] === 200) {
    // OTP is valid!
}

4. Check Account Balance & Credits

$credits = Zender::account()->getCredits();
$subscription = Zender::account()->getSubscription();

Standalone PHP Usage

You can also use this package in pure PHP projects without Laravel:

require_once 'vendor/autoload.php';

use Zender\Zender;

$zender = new Zender([
    'site_url' => 'https://sms.yourdomain.com/',
    'api_secret' => 'your_api_secret_here',
    'timeout' => 30,
    'verify_ssl' => true,
]);

// Send SMS
$result = $zender->sms()->send([
    'mode' => 'devices',
    'phone' => '+1234567890',
    'message' => 'Hello from pure PHP!',
    'device' => 'DEVICE_UNIQUE_ID',
]);

Complete API Reference

Exception Handling

The package throws Zender\Exceptions\ZenderApiException for HTTP errors or API status failures.

use Zender\Exceptions\ZenderApiException;
use Zender\Laravel\Facades\Zender;

try {
    $response = Zender::sms()->send([
        'mode' => 'devices',
        'phone' => '+1234567890',
        'message' => 'Hello!',
        'device' => 'INVALID_DEVICE_ID',
    ]);
} catch (ZenderApiException $e) {
    echo "API Error Code: " . $e->getStatusCode() . "\n";
    echo "Error Message: " . $e->getMessage() . "\n";
    print_r($e->getResponseBody());
}

Testing

Run unit tests using PHPUnit:

vendor/bin/phpunit

License

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