Kirimi API Documentation
Integrasikan WhatsApp ke aplikasi Anda dalam hitungan menit. Kirim pesan, OTP, broadcast, dan kelola device melalui REST API.
Getting Started
Selamat datang di dokumentasi API Kirimi! Panduan ini akan membantu Anda memulai integrasi WhatsApp dengan aplikasi Anda.
Base URL
https://api.kirimi.idAutentikasi
Setiap request API memerlukan kredensial berikut:
- user_code - Kode pengguna unik Anda dari dashboard
- secret - Kunci rahasia untuk autentikasi API
- device_id - ID perangkat WhatsApp yang terhubung (untuk endpoint tertentu)
Penting
- Jaga kerahasiaan Secret Key Anda
- Regenerate Secret Key secara berkala untuk keamanan
- Gunakan HTTPS untuk semua API request
Dua jalur pengiriman
Kirimi punya dua jalur yang aturannya berbeda, dan endpoint-nya tidak saling menggantikan:
- Perangkat QR Scan - dipakai endpoint
/v1/send-messagedan/v1/broadcast-message. Butuhdevice_id, bisa mengirim teks bebas kapan saja, dan bisa mengirim ke grup. - WhatsApp Business API resmi - dipakai endpoint
/v1/waba/*. Butuhwaba_id, bukandevice_id. Pesan yang Anda mulai duluan wajib memakai template yang disetujui Meta, balasan bebas teks hanya dalam 24 jam sejak pesan masuk terakhir, dan tidak bisa mengirim ke grup.
Response Format
Semua response API memakai amplop yang sama. Periksa nilai success, jangan hanya kode HTTP:
{
"success": true,
"message": "Pesan berhasil dikirim",
"data": {
"message_id": "msg_123456",
"status": "sent"
}
}API Endpoints
API untuk mengirim pesan teks dan media (gambar, video, dokumen) ke nomor WhatsApp.
Send Message
https://api.kirimi.id/v1/send-messageRequest Payload
{
"user_code": "YOUR-USER-CODE",
"device_id": "YOUR-DEVICE-ID",
"receiver": "6281234567890",
"message": "Hello from Kirimi API!",
"secret": "YOUR-SECRET-KEY"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| device_id | string | Required | ID perangkat yang sudah terdaftar |
| receiver | string | Required | Nomor WhatsApp penerima (format: 6281234567890). Bisa juga dikirim sebagai "phone". Untuk grup, pakai ID grup. |
| message | string | Optional | Pesan teks (maksimal 15.000 karakter). Wajib diisi kecuali media_url disertakan. |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| media_url | string | Optional | URL file media (gambar/video/audio/dokumen). Wajib bila message kosong. |
| fileName | string | Optional | Nama file yang ditampilkan saat mengirim dokumen |
| quotedMessageId | string | Optional | ID pesan yang ingin dibalas (reply) |
Broadcast Message
https://api.kirimi.id/v1/broadcast-messageRequest Payload
{
"user_code": "YOUR-USER-CODE",
"device_id": "YOUR-DEVICE-ID",
"label": "Campaign Name",
"numbers": [
"6281234567890",
"6289876543210"
],
"message": "Broadcast message content",
"secret": "YOUR-SECRET-KEY",
"delay": 30
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| device_id | string | Required | ID perangkat terdaftar Anda |
| label | string | Required | Label broadcast untuk identifikasi |
| numbers | array | Required | Array nomor telepon penerima |
| message | string | Required | Pesan yang akan dikirim |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| delay | number | Optional | Jeda antar pesan dalam detik. Nilai di bawah 30 otomatis dinaikkan ke 30, maksimal 3600. Default 30. |
| delayMin | number | Optional | Batas bawah jeda acak antar pesan (detik). Berlaku aturan minimum 30 yang sama. |
| delayMax | number | Optional | Batas atas jeda acak antar pesan (detik), maksimal 3600. |
| media_url | string | Optional | URL file media yang ikut dikirim ke seluruh penerima |
| started_at | string | Optional | Jadwal mulai broadcast (format datetime). Kosongkan untuk mengirim sekarang. |
API untuk mengirim dan memvalidasi kode OTP melalui WhatsApp.
Send OTP (v2)
https://api.kirimi.id/v2/otp/sendRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"phone": "6281234567890",
"app_name": "MyApp",
"method": "whatsapp"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| phone | string | Required | Nomor telepon target (format: 6281234567890) |
| app_name | string | Optional | Nama aplikasi untuk ditampilkan dalam pesan OTP |
| method | string | Optional | Metode pengiriman: "whatsapp" (bayar per OTP terkirim, potong saldo; alias "waba") atau "device" (gratis, pakai perangkat sendiri) |
Verify OTP (v2)
https://api.kirimi.id/v2/otp/verifyRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"phone": "6281234567890",
"otp_code": "123456"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| phone | string | Required | Nomor telepon yang menerima OTP |
| otp_code | string | Required | Kode OTP 6 digit yang diterima |
API untuk mengelola perangkat WhatsApp yang terhubung.
Device Status
https://api.kirimi.id/v1/device-statusRequest Payload
{
"user_code": "YOUR-USER-CODE",
"device_id": "YOUR-DEVICE-ID",
"secret": "YOUR-SECRET-KEY"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| device_id | string | Required | ID perangkat untuk mengecek status |
| secret | string | Required | Kunci rahasia untuk autentikasi |
List Devices
https://api.kirimi.id/v1/list-devicesRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"page": 1,
"limit": 10
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| page | number | Optional | Nomor halaman untuk paginasi |
| limit | number | Optional | Jumlah perangkat per halaman |
API untuk nomor yang tersambung lewat jalur resmi Meta. Pesan yang Anda mulai duluan wajib memakai template yang sudah disetujui Meta; balasan bebas teks hanya boleh dalam 24 jam sejak pesan masuk terakhir. Endpoint WABA memakai waba_id, bukan device_id, dan tidak bisa mengirim ke grup.
Kirim Template (business-initiated)
https://api.kirimi.id/v1/waba/send-messageRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"waba_id": "YOUR-WABA-ID",
"to": "6281234567890",
"template_name": "nama_template_approved",
"language": "id",
"variables": [
"Budi",
"10 September"
],
"header": {
"type": "document",
"link": "https://example.com/invoice.pdf",
"filename": "invoice.pdf"
},
"buttons": [
{
"type": "url",
"index": 0,
"value": "INV-1001"
}
]
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| waba_id | string | Required | WABA ID dari akun WhatsApp Business Anda (lihat di dashboard, menu Akun WhatsApp) |
| to | string | Required | Nomor tujuan (format: 6281234567890). Tidak mendukung grup. |
| template_name | string | Required | Nama template yang sudah berstatus APPROVED di Meta. Tanpa ini permintaan ditolak. |
| language | string | Optional | Kode bahasa template, contoh "id", "en_US", "pt_BR". Dipakai bila ada template bernama sama dalam beberapa bahasa. Dikosongkan: dipakai template APPROVED yang tersimpan. Format salah ditolak HTTP 400. Bahasa yang tersedia bisa dilihat lewat Detail Template. |
| variables | array | Optional | Isi variabel body template, berurutan sesuai {{1}}, {{2}}, dan seterusnya. Jumlahnya harus sama dengan jumlah variabel di template, kalau tidak Meta menolak dengan error #132000. |
| header | object | Optional | Wajib bila template punya header DOCUMENT, IMAGE, VIDEO, atau header TEXT dengan variabel: { type: "document" | "image" | "video" | "text", link (URL https publik), id (Meta media ID, alternatif link), filename (khusus document), text (khusus text) }. Gambar WebP ditolak. Tanpa header yang dibutuhkan, Meta menolak dengan #131008. |
| buttons | array | Optional | Wajib bila template punya tombol URL dengan {{n}} atau tombol Copy Code. Tiap item: { type: "url" | "copy_code", index: posisi tombol mulai dari 0, value }. Untuk url, value adalah bagian dinamis pengganti {{1}} di URL, bukan URL penuh. Untuk copy_code, value adalah kode kupon. |
Balas Bebas Teks (dalam window 24 jam)
https://api.kirimi.id/v1/waba/messages/replyRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"waba_id": "YOUR-WABA-ID",
"to": "6281234567890",
"message": {
"type": "text",
"text": "Terima kasih sudah menghubungi kami."
}
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| waba_id | string | Required | WABA ID dari akun WhatsApp Business Anda |
| to | string | Required | Nomor tujuan yang menghubungi Anda lebih dulu |
| message | object | Required | Objek pesan. type: text, image, document, audio, video, atau interactive. Untuk text isi "text"; untuk media isi "media_url" dan opsional "caption" serta "filename". |
Daftar Percakapan Aktif
https://api.kirimi.id/v1/waba/conversationsRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"limit": 50,
"page": 1
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| limit | number | Optional | Jumlah data per halaman (1 sampai 200, default 50) |
| page | number | Optional | Nomor halaman, default 1 |
Sinkronkan Template dari Meta
https://api.kirimi.id/v1/waba/templates/syncRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"waba_id": "YOUR-WABA-ID"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| waba_id | string | Required | WABA ID yang templatenya ingin disegarkan. Batas 10 sync per jam. Respons berisi daftar template akun itu: name, category, language, status (belum berisi isi template; untuk itu pakai Detail Template). Hanya template APPROVED yang bisa dikirim. |
Detail Template
https://api.kirimi.id/v1/waba/templates/detailRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"waba_id": "YOUR-WABA-ID",
"template_name": "nama_template_approved",
"language": "id"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| waba_id | string | Required | WABA ID pemilik template |
| template_name | string | Required | Nama template persis seperti di daftar template. Dibaca dari salinan tersimpan, tanpa memanggil Meta (jalankan Sync dulu bila baru dibuat). Respons berisi name, language, category, status, available_languages, header, body, footer, buttons, serta body_variable_count (jumlah variabel yang harus dikirim di variables), header_param ("media", "text", atau null) dan button_params_required (index dan type tombol yang wajib dikirim di buttons). Batas 60 permintaan per menit. |
| language | string | Optional | Kode bahasa, contoh "id" atau "en_US". Dikosongkan: dipilih template APPROVED lebih dulu; bahasa lain tercantum di available_languages. |
API untuk menyimpan dan mengelola kontak.
Save Contact
https://api.kirimi.id/v1/save-contactRequest Payload
{
"user_code": "YOUR-USER-CODE",
"secret": "YOUR-SECRET-KEY",
"nama": "John Doe",
"nomor": "6281234567890",
"device_id": "YOUR-DEVICE-ID"
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_code | string | Required | Kode pengguna Anda dari akun Kirimi |
| secret | string | Required | Kunci rahasia untuk autentikasi |
| nama | string | Required | Nama kontak |
| nomor | string | Required | Nomor telepon kontak (format: 6281234567890) |
| device_id | string | Optional | ID perangkat yang dikaitkan dengan kontak ini |
Contoh Kode
Berikut adalah contoh implementasi untuk mengirim pesan menggunakan berbagai bahasa pemrograman.
cURL - Contoh Implementasi
curl -X POST https://api.kirimi.id/v1/send-message \
-H "Content-Type: application/json" \
-d '{
"user_code": "YOUR-USER-CODE",
"device_id": "YOUR-DEVICE-ID",
"receiver": "6281234567890",
"message": "Hello from Kirimi API!",
"secret": "YOUR-SECRET-KEY"
}'Penjelasan:
Menggunakan cURL untuk mengirim pesan WhatsApp melalui command line.
Catatan Penting:
- Pastikan cURL telah terinstall di sistem Anda
- Untuk Windows, gunakan double quotes dan escape internal quotes
Pertanyaan Umum
Ya, dan batasnya berbeda per endpoint, bukan satu angka untuk semuanya. Yang paling sering dipakai: Send Message 300 request per 10 menit, Send Message Fast 500 per 10 menit, Broadcast 5 per menit, Save Contact 20 per menit, Save Contacts Bulk 3 per 5 menit, Device Status dan List Devices 60 dan 30 per menit, OTP kirim 100 per menit dan verifikasi 200 per menit, Create Device 5 per jam, WABA Reply 60 per menit, WABA Templates Sync 10 per jam. Batas dihitung per alamat IP sekaligus per user_code. Bila terlampaui, API menjawab HTTP 429. Selain itu broadcast dibatasi maksimal 10 kali per jam dan 1000 nomor per broadcast (500 untuk paket dasar).
Anda dapat mengirim media (gambar, video, audio, dokumen) dengan menambahkan parameter media_url pada endpoint /v1/send-message. Fitur ini tersedia untuk paket Lite, Basic, dan Pro.
API mendukung berbagai format media:
Gambar: JPEG, PNG, GIF, WebP
Video: MP4, AVI, MOV
Audio: MP3, WAV, OGG
Dokumen: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX
Pastikan ukuran file tidak melebihi 64MB.
Gunakan endpoint /v2/otp/send untuk mengirim kode OTP dan /v2/otp/verify untuk memvalidasi. OTP berlaku selama 5 menit dan hanya bisa digunakan sekali.
Ya, API mendukung webhook untuk menerima notifikasi status pengiriman pesan dan balasan dari pengguna. Konfigurasi webhook dapat dilakukan melalui dashboard.
API Playground
Test API Kirimi langsung dari browser. Credentials disimpan di localStorage.
Kirim pesan teks/media ke satu penerima
Response akan muncul di sini
Siap untuk memulai?
Daftar sekarang dan dapatkan akses ke semua fitur API Kirimi untuk mengintegrasikan WhatsApp dengan aplikasi Anda.
