Create Reminder Items
Buka di CMSSebuah reminder item mewakili satu notifikasi terjadwal untuk satu penerima. Setiap item menentukan siapa yang diberi notifikasi, template mana yang dipakai, dan kapan pesan dikirim.
Buka Tools → Plugins, buka plugin Reminder, lalu masuk ke bagian Items untuk mengelola reminder item dari UI admin.
Field Reminder Item
| Field | Deskripsi |
|---|---|
| Country Code | Kode telepon internasional untuk nomor penerima, misalnya +62 untuk Indonesia. |
| Phone Number | Nomor telepon penerima tanpa kode negara. |
| Recipient Name | Opsional. Nama tampilan penerima, dipakai di logging dan history. |
| Notification Template Name | Identifier template notifikasi yang dipakai untuk pesan. Harus sama dengan template yang dikonfigurasi di akun messaging Anda. |
| Template Parameters | Daftar nilai yang mengisi placeholder template, misalnya {{1}}, {{2}}. Urutannya harus sesuai dengan urutan parameter template. |
| Send Times | Satu atau beberapa timestamp terjadwal kapan reminder harus dikirim. Minimal satu wajib diisi. |
| Timezone | Zona waktu yang dipakai untuk menafsirkan Send Times, misalnya Asia/Jakarta, America/New_York. Default-nya UTC. |
Send Times dan Pengulangan
Field Send Times menerima daftar timestamp. Processor mengirim pesan pada setiap waktu terjadwal secara berurutan:
- Saat waktu kirim pertama tiba, pesan dikirim dan item beralih ke waktu kirim berikutnya.
- Saat semua waktu kirim sudah habis, status berubah menjadi
completed. - Jika sebuah waktu kirim terlewat tanpa pengiriman berhasil setelah lima percobaan, processor melewatinya dan beralih ke waktu terjadwal berikutnya.
Contoh: rangkaian follow-up tiga hari:
{
"sendTimes": [
"2025-06-01T09:00:00+07:00",
"2025-06-02T09:00:00+07:00",
"2025-06-03T09:00:00+07:00"
],
"timezone": "Asia/Jakarta"
}
Siklus Status Reminder
| Status | Deskripsi |
|---|---|
active | Reminder sudah dijadwalkan dan menunggu waktu kirim berikutnya. |
completed | Semua waktu kirim sudah berhasil diproses. |
expired | Reminder tidak terkirim dalam rentang waktu yang diharapkan dan tidak bisa diproses lagi. |
cancelled | Reminder dibatalkan secara manual sebelum dikirim. |
Perubahan status terjadi otomatis selama pemrosesan. Anda juga dapat mengubah status secara manual melalui operasi massal.
Membuat Reminder melalui API
POST /api/reminder/item/create
Request body:
{
"id": "unique-reminder-id",
"countryCode": "+62",
"phoneNumber": "81234567890",
"recipientName": "Budi Santoso",
"notificationTemplateName": "appointment_reminder",
"templateParameters": ["Dr. Sari", "Senin, 2 Juni", "09:00"],
"sendTimes": ["2025-06-01T18:00:00+07:00", "2025-06-02T07:00:00+07:00"],
"timezone": "Asia/Jakarta"
}
Field id ditentukan oleh pemanggil. Gunakan UUID atau string unik apa pun untuk mengenali reminder di kemudian hari.
Memperbarui Reminder
PUT /api/reminder/item/update
Anda dapat memperbarui semua field, termasuk sendTimes dan status. Mengubah reminder yang completed atau cancelled kembali menjadi active akan menjadwalkannya ulang mulai dari waktu kirim berikutnya yang belum terkirim.
Menghapus Reminder
DELETE /api/reminder/item/{reminderId}
Reminder yang dihapus akan hilang secara permanen. Untuk pembatalan tanpa menghapus data, ubah status menjadi cancelled.
Mengambil Reminder
GET /api/reminder/item/{reminderId}
GET /api/reminder/item/list?status=active&pageSize=20&skip=0
Endpoint list mendukung filter berikut:
| Parameter | Deskripsi |
|---|---|
status | Filter berdasarkan status reminder (active, completed, expired, cancelled). |
phoneNumber | Filter berdasarkan nomor telepon penerima. |
dateFrom | Hanya sertakan reminder yang dibuat pada atau setelah tanggal ini. |
dateTo | Hanya sertakan reminder yang dibuat pada atau sebelum tanggal ini. |
pageSize | Jumlah hasil per halaman. |
skip | Jumlah hasil yang dilewati untuk paginasi. |
History Reminder
Setiap aksi pada reminder dicatat di history-nya:
| Aksi | Terjadi saat |
|---|---|
Created | Reminder item pertama kali disimpan. |
Sent | Pesan berhasil dikirim. |
SendFailed | Sebuah percobaan pengiriman gagal. Menambah penghitung percobaan. |
SendError | Terjadi error tak terduga selama pengiriman. |
History terlihat di tampilan detail item dan berguna untuk mendiagnosis masalah pengiriman.
Halaman Terkait
- Processing and Delivery
- Integration API: membuat reminder dari sistem eksternal.
- AI Function Tool: membiarkan AI membuat reminder selama percakapan.
- Reminder Overview