API v2 (beta)
Pengingat
Pengingat mengirim pesan yang sama ke satu penerima berulang kali sesuai jadwal: sewa setiap bulan, kelas setiap Senin, laporan setiap sore. Jadwalnya berupa ekspresi cron 5 bagian di zona waktu yang Anda pilih. Pengingat yang dibuat dengan API sama dengan pengingat di halaman Pengingat di dashboard.
| Operasi | Endpoint | Scope |
|---|---|---|
| Membuat pengingat | POST /api/v2/reminders | reminders |
| Daftar pengingat | GET /api/v2/reminders | reminders |
| Mengambil pengingat | GET /api/v2/reminders/{id} | reminders |
| Mengubah, menjeda, atau melanjutkan | PATCH /api/v2/reminders/{id} | reminders |
| Menghapus pengingat | DELETE /api/v2/reminders/{id} | reminders |
Membuat dan mengubah pengingat memerlukan paket yang mencakup pengingat; jika tidak, dijawab dengan 403 plan_required. Menampilkan, membaca, menjeda, dan menghapus berfungsi di paket apa pun. Untuk pesan yang dikirim sekali pada waktu tertentu, gunakan send_at di Mengirim pesan.
Membuat pengingat#
https://wbiztool.com/api/v2/remindersBody: JSON (application/json)
curl -X POST https://wbiztool.com/api/v2/reminders \
-H "Authorization: Bearer $WBIZTOOL_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: rent-flat-4b" \
-d '{
"name": "Weekly rent",
"from": 101,
"to": { "phone": "+919876543210" },
"text": "Hi, a reminder that the rent is due on Friday.",
"schedule": { "cron": "0 9 * * 1", "timezone": "Asia/Kolkata" }
}'import os
import requests
response = requests.post(
"https://wbiztool.com/api/v2/reminders",
headers={
"Authorization": f"Bearer {os.environ['WBIZTOOL_API_KEY']}",
"Idempotency-Key": "rent-flat-4b",
},
json={
"name": "Weekly rent",
"from": 101,
"to": {"phone": "+919876543210"},
"text": "Hi, a reminder that the rent is due on Friday.",
"schedule": {"cron": "0 9 * * 1", "timezone": "Asia/Kolkata"},
},
timeout=30,
)
reminder = response.json()
print(response.status_code, reminder.get("id"), reminder.get("next_run_at"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v2/reminders", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.WBIZTOOL_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "rent-flat-4b",
},
body: JSON.stringify({
name: "Weekly rent",
from: 101,
to: { phone: "+919876543210" },
text: "Hi, a reminder that the rent is due on Friday.",
schedule: { cron: "0 9 * * 1", timezone: "Asia/Kolkata" },
}),
});
const reminder = await response.json();
console.log(response.status, reminder.id, reminder.next_run_at);<?php
$ch = curl_init('https://wbiztool.com/api/v2/reminders');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('WBIZTOOL_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: rent-flat-4b',
],
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Weekly rent',
'from' => 101,
'to' => ['phone' => '+919876543210'],
'text' => 'Hi, a reminder that the rent is due on Friday.',
'schedule' => ['cron' => '0 9 * * 1', 'timezone' => 'Asia/Kolkata'],
]),
CURLOPT_RETURNTRANSFER => true,
]);
$reminder = json_decode(curl_exec($ch), true);
curl_close($ch);
echo $reminder['id'] . ' next: ' . $reminder['next_run_at'];Respons (201):
{
"id": 812,
"name": "Weekly rent",
"active": true,
"to": { "phone": "+919876543210" },
"from": 101,
"text": "Hi, a reminder that the rent is due on Friday.",
"media": null,
"schedule": { "cron": "0 9 * * 1", "timezone": "Asia/Kolkata" },
"next_run_at": "2026-10-19T09:00:00+05:30",
"created_at": "2026-10-18T10:20:11.004Z"
}
Body
namestringwajibNama pengingat, hingga 100 karakter, seperti yang tampil di halaman Pengingat.
toobjectwajibTepat satu dari
phone(format internasional dengan+),group(nama persis grup WhatsApp),contact_id, atauusername(Telegram), seperti di Pesan → Penerima.frominteger or nullWajib untuk kunci yang dibatasi ke sebagian nomoridnomor yang mengirimnya. Nomor itu harus terhubung saat Anda mengaturnya. Jika tidak dikirim ataunull: nomor terhubung mana pun di workspace yang mengirimnya.textstringwajibIsi pesan, hingga 3.000 karakter. Ini juga menjadi keterangan saat
mediadikirim.mediaobject or nullopsionalGambar atau file yang dikirim setiap kali:
urlataumedia_id, dan opsionaltype, seperti di Pesan → Media.scheduleobjectwajibcron(wajib) dantimezone. Lihat Jadwal.activebooleanopsionaltrue(default) menjalankannya;falsemembuatnya dalam keadaan dijeda.
Jadwal#
schedule.cron memiliki lima bagian yang dipisahkan spasi: menit, jam, tanggal, bulan, hari dalam seminggu. * berarti "setiap". Jadwalnya harus benar-benar berjalan pada suatu waktu (bukan 31 Februari).
cron | Berjalan |
|---|---|
0 9 * * 1 | Setiap Senin pukul 09.00 |
30 18 * * * | Setiap hari pukul 18.30 |
0 10 1 * * | Tanggal 1 setiap bulan pukul 10.00 |
0 9 * * 1-5 | Hari kerja pukul 09.00 |
0 8,20 * * * | Setiap hari pukul 08.00 dan 20.00 |
0 9 15 1 * | 15 Januari pukul 09.00, setiap tahun |
schedule.timezone adalah nama zona waktu IANA, seperti Asia/Kolkata, Europe/London, atau America/New_York (default UTC). Waktu cron mengikuti zona itu, dan next_run_at juga diberikan dalam zona itu, beserta offset-nya. Lihat referensi zona waktu.
Setiap kali berjalan, pengingat mengirim pesan seperti pesan lainnya: memerlukan sisa pesan di paket dan muncul di Daftar pesan.
Error saat membuat#
| HTTP | Kode | Kapan |
|---|---|---|
400 | validation_failed | Field wajib tidak ada atau kosong, ada field yang tidak dikenal atau terlalu panjang (name, to.group), atau media tidak valid |
400 | text_required | text kosong |
400 | text_too_long | text lebih dari 3.000 karakter |
400 | invalid_cron | schedule.cron tidak terdiri dari 5 bagian, atau tidak pernah berjalan |
400 | invalid_timezone | schedule.timezone bukan zona waktu IANA |
403 | plan_required | Paket tidak mencakup pengingat |
403 | number_not_allowed | Kunci dibatasi ke sebagian nomor dan from bukan salah satunya, atau tidak dikirim |
422 | invalid_phone | to.phone bukan nomor yang valid dalam format internasional dengan + |
422 | invalid_username | to.username bukan username, tautan, atau ID tg: Telegram |
422 | username_needs_telegram | Username Telegram, tetapi from bukan akun Telegram (atau, tanpa from, tidak ada akun Telegram yang terhubung) |
422 | contact_not_found | Tidak ada kontak dengan to.contact_id tersebut |
422 | media_not_found | Tidak ada file dengan media.media_id tersebut |
422 | invalid_media_url | media.url bukan tautan http(s) publik |
422 | number_not_connected | from bukan nomor terhubung di workspace ini |
Daftar pengingat#
https://wbiztool.com/api/v2/remindersPengingat workspace, yang terbaru lebih dulu, dalam halaman (limit 1 hingga 100, default 25, dan cursor). Pengingat yang dijeda ikut ditampilkan, dengan "active": false. Kunci yang dibatasi ke sebagian nomor hanya melihat pengingat yang dikirim dari nomor-nomor itu.
curl "https://wbiztool.com/api/v2/reminders?limit=50" \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
Responsnya {"data": [Reminder, …], "next_cursor": "…" or null}.
Mengambil pengingat#
https://wbiztool.com/api/v2/reminders/{id}curl https://wbiztool.com/api/v2/reminders/812 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
Pengingat yang tidak ada, sudah dihapus, atau dikirim dari nomor yang tidak boleh digunakan oleh kunci dijawab dengan 404 reminder_not_found.
Mengubah, menjeda, atau melanjutkan pengingat#
https://wbiztool.com/api/v2/reminders/{id}Body: JSON (application/json)
Kirim hanya field yang berubah; field lain tetap dengan nilainya. Field-nya sama dengan Membuat pengingat. Responsnya 200 dengan pengingat sebagaimana kondisinya sekarang.
- Menjeda:
{"active": false}. Pengingat berhenti berjalan dannext_run_atmenjadinull. Menjeda berfungsi di paket apa pun. - Melanjutkan:
{"active": true}. Pengingat berjalan lagi mulai dari waktu berikutnya. Melanjutkan memerlukan paket yang mencakup pengingat. schedulediganti secara keseluruhan: kirimcronbersamanya. Tanpatimezone, pengingat tetap memakai zona waktunya saat ini.
# Pause
curl -X PATCH https://wbiztool.com/api/v2/reminders/812 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"active": false}'
# Move it to Fridays at 10:00 and change the text
curl -X PATCH https://wbiztool.com/api/v2/reminders/812 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"schedule": {"cron": "0 10 * * 5"}, "text": "Hi, the rent is due today."}'import os
import requests
headers = {"Authorization": f"Bearer {os.environ['WBIZTOOL_API_KEY']}"}
url = "https://wbiztool.com/api/v2/reminders/812"
paused = requests.patch(url, headers=headers, json={"active": False}, timeout=30).json()
print(paused["active"], paused["next_run_at"]) # False None
resumed = requests.patch(url, headers=headers, json={"active": True}, timeout=30).json()
print(resumed["active"], resumed["next_run_at"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v2/reminders/812", {
method: "PATCH",
headers: { Authorization: `Bearer ${process.env.WBIZTOOL_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ active: false }),
});
const reminder = await response.json();
console.log(reminder.active, reminder.next_run_at); // false null<?php
$ch = curl_init('https://wbiztool.com/api/v2/reminders/812');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('WBIZTOOL_API_KEY'), 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['active' => false]),
CURLOPT_RETURNTRANSFER => true,
]);
$reminder = json_decode(curl_exec($ch), true);
curl_close($ch);
var_dump($reminder['active']);Perubahan dijawab dengan error yang sama seperti saat membuat, ditambah 404 reminder_not_found. Jika satu field salah, tidak ada yang diubah.
Menghapus pengingat#
https://wbiztool.com/api/v2/reminders/{id}Menghapus pengingat: pengingat tidak akan pernah berjalan lagi. Pesan yang sudah dikirimnya tetap ada di riwayat. Untuk menghentikannya sementara, jeda pengingat.
curl -X DELETE https://wbiztool.com/api/v2/reminders/812 \
-H "Authorization: Bearer $WBIZTOOL_API_KEY"
{ "id": 812, "deleted": true }
Objek Reminder#
| Field | Jenis | Keterangan |
|---|---|---|
id | integer | ID pengingat. |
name | string | Namanya. |
active | boolean | true selama berjalan, false selama dijeda. |
to | object | Penerima: phone (dengan +), group, atau username. Pengingat yang dibuat dengan contact_id menampilkan nomor atau grup kontak tersebut. |
from | integer or null | id nomor pengirim, atau null untuk nomor terhubung mana pun. |
text | string | Isi pesan. |
media | object or null | type (image atau file), url, dan file_name. |
schedule | object | cron dan timezone. |
next_run_at | string or null | Kapan pengingat berjalan berikutnya, dalam zona waktunya beserta offset, seperti 2026-10-19T09:00:00+05:30. null selama dijeda. |
created_at | string | Kapan pengingat dibuat (UTC). |
Terkait#
- Pengingat di dashboard
- Referensi zona waktu
- Pesan: satu pesan pada waktu tertentu dengan
send_at - Error
