PHPackages                             kirimi/laravel-kirimi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kirimi/laravel-kirimi

ActiveLibrary[API Development](/categories/api)

kirimi/laravel-kirimi
=====================

Official Laravel package for the Kirimi WhatsApp API — Facade, Notification channel, and Artisan commands.

01↓100%PHP

Since Apr 14Pushed 1mo agoCompare

[ Source](https://github.com/kiriminow/kirimi-laravel)[ Packagist](https://packagist.org/packages/kirimi/laravel-kirimi)[ RSS](/packages/kirimi-laravel-kirimi/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Laravel Kirimi
==============

[](#laravel-kirimi)

Official Laravel package for the [Kirimi WhatsApp API](https://kirimi.id). Provides a Facade, Notification channel, Artisan command, and helper function to send WhatsApp messages from any Laravel 10/11/12 application.

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10, 11, or 12

Installation
------------

[](#installation)

```
composer require kirimi/laravel-kirimi
```

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

Configuration
-------------

[](#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_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
-----

[](#usage)

### Facade

[](#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');

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

// List devices
$devices = Kirimi::listDevices();

// Check device status
$status = Kirimi::deviceStatus('device_001');
```

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

### Notification Channel

[](#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:

```
return KirimiMessage::create('Hello via WABA')->to($notifiable->phone)->waba();
```

Trigger the notification as usual:

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

### Artisan Command

[](#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

[](#helper-function)

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

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

License
-------

[](#license)

MIT License. Copyright (c) 2026 Kirimi. See [LICENSE](LICENSE) for details.

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance59

Moderate activity, may be stable

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/52d71cf053bae0423f3ad95153012f9d4fb5a3eb59407d1e01a787d2bdb6630e?d=identicon)[yolkmonday](/maintainers/yolkmonday)

---

Top Contributors

[![yolkmonday](https://avatars.githubusercontent.com/u/32402214?v=4)](https://github.com/yolkmonday "yolkmonday (1 commits)")

### Embed Badge

![Health badge](/badges/kirimi-laravel-kirimi/health.svg)

```
[![Health](https://phpackages.com/badges/kirimi-laravel-kirimi/health.svg)](https://phpackages.com/packages/kirimi-laravel-kirimi)
```

###  Alternatives

[facebook/php-business-sdk

PHP SDK for Facebook Business

90923.5M35](/packages/facebook-php-business-sdk)[exsyst/swagger

A php library to manipulate Swagger specifications

35916.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)