README

Official Laravel package for the Kirimi WhatsApp API. Provides a Facade, Notification channel, Artisan command, and helper function to send WhatsApp messages from any Laravel 10/11/12 application.

Requirements

PHP 8.1+
Laravel 10, 11, or 12

Installation

composer require kirimi/laravel-kirimi

The service provider is auto-discovered. No manual registration needed.

Configuration

Add the following variables to your .env file:

KIRIMI_USER_CODE=your_user_code
KIRIMI_SECRET=your_secret_key
KIRIMI_DEVICE_ID=your_default_device_id   # optional
KIRIMI_WABA_ID=your_default_waba_id       # optional, for WABA (Meta Cloud API) messages
KIRIMI_BASE_URL=https://api.kirimi.id      # optional
KIRIMI_TIMEOUT=30                          # optional, seconds

To publish the config file:

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

This creates config/kirimi.php where you can review and customize all options.

Usage

Facade

Import the facade and call any method from KirimiClient:

use Kirimi\Laravel\Facades\Kirimi;

// Send a regular message
Kirimi::sendMessage('device_001', '628123456789', 'Hello from Kirimi!');

// Send a message with media
Kirimi::sendMessage('device_001', '628123456789', 'Check this out!', 'https://example.com/image.jpg');

// Send fast (no typing effect)
Kirimi::sendMessageFast('device_001', '628123456789', 'Quick message');

// Broadcast to many recipients (numbers is an array, label is required)
Kirimi::broadcastMessage('device_001', 'flash-sale', ['628123456789', '628987654321'], 'Sale starts now!');

// Send a WABA (Meta Cloud API) template message — uses waba_id, not device_id
Kirimi::sendWabaMessage('waba_001', '628123456789', 'order_update', ['variables' => ['A1', 'B2']]);

// Free-form WABA reply (only within the 24h customer service window)
Kirimi::wabaReply('waba_001', '628123456789', ['type' => 'text', 'text' => 'Hi there!']);

// Generate OTP
Kirimi::generateOTP('device_001', '628123456789', ['otp_length' => 6]);

// Send OTP v2 (whatsapp | device | waba_user)
Kirimi::sendOtpV2('628123456789', ['method' => 'whatsapp']);
Kirimi::sendOtpV2('628123456789', ['method' => 'device', 'device_id' => 'device_001', 'custom_message' => 'Your code is {{otp}}']);
Kirimi::sendOtpV2('628123456789', ['method' => 'waba_user', 'waba_id' => 'waba_001', 'template_name' => 'otp_login']);

// Save a contact (nama + nomor)
Kirimi::saveContact('Budi', '628123456789');

// Devices
$devices = Kirimi::listDevices();
$status = Kirimi::deviceStatus('device_001');
$newDevice = Kirimi::createDevice(1);

// Packages & deposits
$packages = Kirimi::listPackages();
$deposit = Kirimi::createDeposit(50000);
$status = Kirimi::depositStatus($deposit['ref']);

All methods from kirimi/kirimi-php KirimiClient are available through the facade.

Notification Channel

Create a notification class and use the kirimi channel:

use Illuminate\Notifications\Notification;
use Kirimi\Laravel\Messages\KirimiMessage;

class OrderPaid extends Notification
{
    public function __construct(private string $orderNumber) {}

    public function via($notifiable): array
    {
        return ['kirimi'];
    }

    public function toKirimi($notifiable): KirimiMessage
    {
        return (new KirimiMessage)
            ->to($notifiable->phone)
            ->device($notifiable->kirimi_device_id)  // optional, falls back to config default
            ->message("Order #{$this->orderNumber} has been paid. Thank you!");
    }
}

With media attachment:

public function toKirimi($notifiable): KirimiMessage
{
    return KirimiMessage::create('Your invoice is ready.')
        ->to($notifiable->phone)
        ->mediaUrl('https://example.com/invoice.pdf');
}

Fast mode (no typing effect):

return KirimiMessage::create('OTP: 123456')->to($notifiable->phone)->quick();

WABA (WhatsApp Business API) mode — requires a WABA id and a Meta-approved template name:

return KirimiMessage::create()
    ->to($notifiable->phone)
    ->waba()
    ->wabaId('waba_001')            // optional, falls back to config default
    ->template('order_update')
    ->variables(['A1', 'B2'])
    ->header(['type' => 'text', 'text' => 'Order update']);

Broadcast mode — numbers is an array and label is required:

return KirimiMessage::create('Flash sale starts now!')
    ->device('device_001')
    ->broadcast('flash-sale', ['628123456789', '628987654321']);

Contact mode — both nama and nomor are required:

return KirimiMessage::create()
    ->device('device_001')
    ->nama('Budi')
    ->nomor('628123456789');

Trigger the notification as usual:

$user->notify(new OrderPaid($order->number));
// or
Notification::send($users, new OrderPaid($order->number));

Artisan Command

Send a message directly from the terminal:

# Basic
php artisan kirimi:send 628123456789 "Hello from CLI"

# With specific device
php artisan kirimi:send 628123456789 "Hello" --device=device_001

# With media URL
php artisan kirimi:send 628123456789 "Check this" --media=https://example.com/img.jpg

# Fast mode
php artisan kirimi:send 628123456789 "Quick hello" --fast

Helper Function

Resolve the client from anywhere using the global kirimi() helper:

kirimi()->sendMessage('device_001', '628123456789', 'Hello!');
kirimi()->generateOTP('device_001', '628123456789');

kirimi / laravel-kirimi

Package info

Security

Statistics