1. Authentication & API Credentials

Semua request REST API diautentikasi menggunakan API Key perangkat yang valid. Sertakan token Anda di HTTP Header Authorization: Bearer <API_KEY> atau x-api-key: <API_KEY>.

https://qirim.web.id/api/v1

Authorization: Bearer YOUR_DEVICE_API_KEY
Content-Type: application/json

Kirim pesan teks personal atau grup WhatsApp dengan simulasi mengetik manusia (anti-ban delay) dan dukungan variasi teks Spintax {Halo|Hai|Selamat Pagi}.

Request Body (JSON):

• cURL
• PHP / Laravel
• Node.js
• Python

curl -X POST https://qirim.web.id/api/v1/send-message \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "message": "{Halo|Hai} Kak! Pesanan Anda telah kami terima dan sedang diproses."
  }'

<?php
use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
    'Authorization' => 'Bearer ' . env('QIRIM_API_KEY'),
])->post('https://qirim.web.id/api/v1/send-message', [
    'target' => '081234567890',
    'message' => 'Halo Kak, tagihan Anda sebesar Rp 150.000 telah terbit.',
]);

return $response->json();

const axios = require('axios');

const res = await axios.post('https://qirim.web.id/api/v1/send-message', {
  target: '081234567890',
  message: 'Hello from Node.js!'
}, {
  headers: { 'Authorization': 'Bearer ' + process.env.QIRIM_API_KEY }
});

console.log(res.data);

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "target": "081234567890",
    "message": "Halo dari Python script!"
}
response = requests.post("https://qirim.web.id/api/v1/send-message", json=payload, headers=headers)
print(response.json())

{
  "status": true,
  "message": "Message sent successfully",
  "data": {
    "id": "3EB09F2184912...",
    "target": "081234567890",
    "device_id": 1,
    "timestamp": "2026-09-06T09:00:00.000Z"
  }
}

Kirim file media (Gambar JPG/PNG, Video MP4, Audio Rekaman/Voice Note, Dokumen/PDF Faktur) menggunakan URL publik file Anda.

curl -X POST https://qirim.web.id/api/v1/send-media \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "url": "https://example.com/files/invoice-INV8821.pdf",
    "type": "document",
    "caption": "Berikut e-invoice pembayaran Anda.",
    "filename": "Invoice-INV8821.pdf"
  }'

Kirim pin koordinat lokasi Google Maps langsung ke chat WhatsApp.

curl -X POST https://qirim.web.id/api/v1/send-location \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "latitude": -6.200000,
    "longitude": 106.816666,
    "name": "Alula Headquarters",
    "address": "Jl. Sudirman Kav 25, Jakarta Selatan"
  }'

Kirim kartu kontak (vCard) interaktif yang bisa langsung disimpan ke buku kontak penerima dengan satu ketukan.

curl -X POST https://qirim.web.id/api/v1/send-contact \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "contact_name": "Customer Support Alula",
    "contact_phone": "628999888777"
  }'

Kirim pesan menggunakan template tersimpan dengan penggantian variabel dinamis seperti {name}, {order_id}, {total}.

curl -X POST https://qirim.web.id/api/v1/send-template \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "template_name": "Konfirmasi Pembayaran",
    "variables": {
      "name": "Budi Santoso",
      "order_id": "INV-2026-001",
      "total": "Rp 250.000"
    }
  }'

Kirim pesan massal ke banyak nomor sekaligus secara asynchronous di background dengan proteksi anti-ban interval.

curl -X POST https://qirim.web.id/api/v1/broadcast \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": ["081234567890", "081234567891", "081234567892"],
    "message": "{Halo|Hai} Pelanggan setia, dapatkan diskon 30% hari ini!",
    "delay_seconds": 3
  }'

Jadwalkan pengiriman pesan di masa depan (one-time) atau berulang otomatis (daily, weekly, monthly).

curl -X POST https://qirim.web.id/api/v1/schedule-message \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "message": "Pengingat: Tagihan internet Anda jatuh tempo besok.",
    "schedule_time": "2026-09-10 09:00:00",
    "recurring_type": "monthly"
  }'

Endpoint Jadwal Lainnya:

Engine pengiriman dan verifikasi kode OTP / 2FA sekali pakai dengan kedaluwarsa otomatis.

curl -X POST https://qirim.web.id/api/v1/otp/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "length": 6,
    "expiry_minutes": 5,
    "type": "2fa"
  }'

curl -X POST https://qirim.web.id/api/v1/otp/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "081234567890",
    "otp_code": "849201"
  }'

10. Manajemen Perangkat & Session WhatsApp

Integrasi manajemen perangkat langsung dari aplikasi 3rd party Anda tanpa perlu membuka dashboard qirim.

11. Phonebook Contacts & Grouping API

Kelola buku kontak dan pengelompokan pelanggan Anda via REST API.

12. Auto-Reply Chatbot Rules API

Kelola aturan respon otomatis bot WhatsApp untuk perangkat Anda.

{
  "keyword": "info produk",
  "response": "Halo {name}, katalog produk kami ada di https://katalog.web.id",
  "match_type": "contains", // exact, contains, starts_with
  "is_default": 0
}

13. Message Templates API

Kelola template pesan siap pakai untuk kampanye dan notifikasi.

{
  "name": "Invoice Notifikasi",
  "category": "billing",
  "content": "Halo {name}, invoice #{order_id} sebesar {total} sudah diterbitkan."
}

Cek profil akun, paket langganan aktif, fitur yang diizinkan oleh paket, dan akumulasi penggunaan kuota pesan.

curl -X GET https://qirim.web.id/api/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY"

15. Webhooks & Event Payloads

Qirim by alula mengirimkan HTTP POST event real-time ke URL webhook yang Anda daftarkan setiap kali terjadi interaksi WhatsApp.

{
  "event": "messages.received",
  "data": {
    "device_id": 1,
    "device_name": "Customer Support",
    "sender": "6281234567890",
    "message": "Halo, apakah stok barang ini masih ada?",
    "is_group": false,
    "timestamp": 1725537600
  }
}

{
  "event": "device.connected",
  "data": {
    "device_id": 1,
    "phone": "6281234567890",
    "status": "connected",
    "timestamp": "2026-09-06T09:00:00.000Z"
  }
}