Langsung ke konten
kirim.idPanduan
kirim.idPanduan

API Kirim Notifikasi

Kirim notifikasi push dari sistemmu: ke semua subscriber atau ke subscriber tertentu, lihat statusnya, dan baca daftar subscriber.

Developer Diperbarui 11 Oktober 2026 2 menit bacaKB-49
Di halaman ini

API Kirim Notifikasi ada di https://api.kirim.id/v1/notif. Autentikasi sama dengan API kirim.id lainnya: header Authorization: Bearer <API key> (lihat Autentikasi API key). Buat key di Notifikasi → API Key & Webhook — key dari menu ini otomatis punya scope notif.

  • Situs dirujuk dengan kode situs (32 karakter, sama dengan di dashboard).

  • Subscriber dirujuk dengan ID publiknya (32 karakter) — dari cookie kirim_push_sid di websitemu, dari GET /subscribers, atau dari webhook push.subscribed.

  • Batas request: 60 per menit per API key.

Daftar situs#

GET/v1/notif/sites

Situs di akunmu beserta jumlah subscriber aktif.

cURL
curl https://api.kirim.id/v1/notif/sites -H "Authorization: Bearer $API_KEY"
JSON
{"data":[{"id":"KODE_SITUS","name":"Toko Rina","origin":"https://www.tokorina.com","status":"installed","subscribers":1250,"created_at":"2026-10-11T03:00:00+00:00"}]}

Daftar subscriber#

GET/v1/notif/subscribers

Subscriber satu situs, terbaru dulu, 100 per halaman. Parameter: site (wajib), status (active, unsubscribed, expired), page.

JSON
{"data":[{"id":"ID_SUBSCRIBER","site":"KODE_SITUS","status":"active","browser":"Chrome","os":"Android","device":"mobile","language":"id-ID","timezone":"Asia/Jakarta","is_tester":false,"subscribed_at":"2026-10-11T03:10:00+00:00","unsubscribed_at":null}],
 "meta":{"current_page":1,"last_page":13,"total":1250}}

Kirim notifikasi#

POST/v1/notif/messages

Kirim ke semua subscriber aktif situs, atau ke subscriber tertentu.

FieldKeterangan
siteWajib. Kode situs.
titleWajib, maks. 80 karakter.
bodyOpsional, maks. 240 karakter.
urlWajib. Tautan saat notifikasi diklik.
buttonsOpsional, maks. 2: [{"title":"Lihat","url":"https://…"}] (judul maks. 30 karakter).
subscribersOpsional, maks. 500 ID subscriber. Kosong = semua subscriber aktif.
nameOpsional, nama internal (maks. 120 karakter).
  • Tanpa subscribers = kampanye ke semua subscriber: dihitung dalam batas 5 kampanye per situs per hari dan tampil di menu Kampanye. Batas tercapai → jawaban 429.

  • Dengan subscribers = notifikasi ke orang tertentu, mis. "pesananmu sudah dikirim". Tiap subscriber paling banyak menerima 10 notifikasi API per 24 jam; yang melewati batas dilewati dan dihitung di meta.skipped_daily_limit. ID yang tidak dikenal atau tidak aktif juga dilewati.

  • Ikon memakai ikon bawaan situs.

curl -X POST https://api.kirim.id/v1/notif/messages \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{"site":"KODE_SITUS","title":"Pesananmu sudah dikirim","body":"Resi JNE 1234567890",
       "url":"https://tokomu.com/akun/pesanan","subscribers":["ID_SUBSCRIBER"]}'

Jawaban 202:

JSON
{"data":{"id":123,"type":"api","site":"KODE_SITUS","status":"sent","title":"Pesananmu sudah dikirim","body":"Resi JNE 1234567890","url":"https://tokomu.com/akun/pesanan","buttons":[],"recipients":1,"sent":1,"failed":0,"expired":0,"clicks":0,"error":null,"created_at":"…","finished_at":"…"},
 "meta":{"requested":1,"skipped_daily_limit":0}}

type bernilai api untuk kiriman ke subscriber tertentu dan broadcast untuk kiriman ke semua subscriber.

Status kiriman#

GET/v1/notif/messages/{id}

Status dan angka satu kiriman: recipients, sent, failed, expired, clicks. Status: sending, sent, failed.

Keranjang (dipakai plugin WordPress)#

Dua endpoint ini dipanggil plugin Kirim.id untuk pengingat keranjang. Toko non-WordPress juga bisa memakainya:

POST/v1/notif/carts

Laporkan isi keranjang: site, subscriber (ID publik), cart_key (maks. 64 karakter: huruf, angka, _, -; jangan pakai data pribadi), items (jumlah barang; 0 = keranjang dikosongkan), total (opsional, rupiah).

POST/v1/notif/carts/complete

Tandai keranjang selesai saat pesanan dibuat: site, cart_key.

Kode error#

HTTPArti
401API key kosong, salah, atau sudah dicabut.
403Key tidak punya scope notif, atau modul Kirim Notifikasi belum aktif.
404Kode situs, kiriman, atau subscriber tidak ditemukan di akunmu.
422Isian tidak valid — lihat errors.
429Batas kampanye harian tercapai, atau terlalu banyak request.

Apakah artikel ini membantu?

Artikel terkait

Masih butuh bantuan?

Tim support kirim.id siap membantu · Senin–Jumat, 09.00–17.00 WIB

API Kirim Notifikasi · Panduan kirim.id