Kirim Pesan Template

Endpoint

POST /messages/send-template

Base URL

https://dash.ngirimwa.com/api/v1

Headers

x-api-key: API_KEY_ANDA
Content-Type: application/json
Idempotency-Key: <uuid-unik-per-request>

Idempotency-Key opsional tapi sangat disarankan — mencegah pesan terkirim ganda saat retry. Lihat Autentikasi → Idempotency-Key.

Apa itu Template?

Template adalah pesan yang sudah disimpan di dashboard dengan variabel yang dapat diganti. Sangat berguna untuk:

Notifikasi order
Reminder pembayaran
Konfirmasi booking
Broadcast promo

Request

{
  "to": "628123456789",
  "template_id": "550e8400-e29b-41d4-a716-446655440000",
  "variables": {
    "nama": "Budi Santoso",
    "nomor_pesanan": "ORD-12345",
    "total": "Rp 150.000"
  }
}

Parameter

Parameter	Tipe	Wajib	Deskripsi
`to`	string	✅	Nomor penerima — semua format didukung (lihat format nomor)
`template_id`	string (UUID)	✅	ID template dari Dashboard
`variables`	object	❌	Mapping `{ "nama_variabel": "nilai" }`

Batasan

Field	Limit
Format `to`	Indonesia (`628xxx`, `08xxx`, `8xxx`), internasional (`<country-code>xxx`), atau ID grup (`<id>@g.us`) — semua dinormalisasi otomatis.
`template_id`	UUID v4 valid
`variables`	Hanya value bertipe string. Variabel yang tidak diisi muncul apa adanya (`{{nama}}`) di pesan terkirim.

Cara Kerja Variabel

Template di Dashboard

Halo {{nama}},

Pesanan Anda {{nomor_pesanan}} telah dikonfirmasi.
Total pembayaran: {{total}}

Terima kasih telah berbelanja!

Request dengan Variabel

{
  "to": "628123456789",
  "template_id": "uuid-template",
  "variables": {
    "nama": "Budi Santoso",
    "nomor_pesanan": "ORD-12345",
    "total": "Rp 150.000"
  }
}

Hasil Pesan yang Dikirim

Halo Budi Santoso,

Pesanan Anda ORD-12345 telah dikonfirmasi.
Total pembayaran: Rp 150.000

Terima kasih telah berbelanja!

Mendapatkan Template ID

Buka Dashboard NgirimWA → menu Template.
Di baris template yang ingin dipakai, klik ikon 📋 Salin di kolom Aksi. Template ID (UUID) langsung tersalin ke clipboard.
Alternatif: klik Edit pada template — UUID tampil di header halaman edit beserta tombol salin di sebelahnya.

Mengetahui Variabel yang Dipakai Template

Di halaman Templates, setiap baris menampilkan badge variabel di bawah nama template — misalnya {{nama}} {{nomor_pesanan}} {{total}}. Itu daftar pasti yang harus Anda kirim di field variables saat call API. Variabel yang tidak diisi tetap muncul apa adanya {{nama}} di pesan yang terkirim.

Contoh cURL

curl -X POST https://dash.ngirimwa.com/api/v1/messages/send-template \
  -H "x-api-key: API_KEY_ANDA" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "628123456789",
    "template_id": "550e8400-e29b-41d4-a716-446655440000",
    "variables": {
      "nama": "Budi",
      "nomor_pesanan": "ORD-001"
    }
  }'

Tips Penggunaan Template

Gunakan nama variabel yang jelas - {{nama_pelanggan}} lebih baik dari {{n}}

Test template sebelum production - Kirim ke nomor Anda sendiri dulu

Sediakan fallback - Variabel yang tidak diisi akan tetap muncul sebagai {{variabel}}

Kirim Pesan Template

On this page