API Pengingat
API Daftar pengingat
Dapatkan pengingat di workspace Anda, 50 sekaligus, dari yang terbaru. Gunakan untuk menemukan ID pengingat, mengaudit otomatisasi Anda, atau membuat cadangannya.
https://wbiztool.com/api/v1/reminder/list/Body: JSON atau field formulir
Endpoint ini hanya menerima POST. Request GET, bahkan dengan query string, mengembalikan HTTP 400 dengan Invalid JSON format: Expecting value….
Daftar mencakup pengingat aktif dan yang dijeda dari seluruh workspace, baik yang dibuat melalui API maupun di halaman Reminders (Pengingat). Pengingat yang dibatalkan tidak disertakan.
Contoh singkat#
curl -X POST https://wbiztool.com/api/v1/reminder/list/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"page": 1
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/reminder/list/",
json={"client_id": 12345, "api_key": "YOUR_API_KEY", "page": 1},
timeout=60,
)
try:
result = response.json() # read the body even when the HTTP code is 400
except ValueError:
raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
if result["status"] == 1:
print(f"{result['total']} reminders in total")
for reminder in result["reminders"]:
print(reminder["id"], reminder["name"], reminder["cron_expression"], reminder["is_active"])
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/reminder/list/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ client_id: 12345, api_key: "YOUR_API_KEY", page: 1 }),
});
// Read the body even when the HTTP code is 400. A non-JSON reply means the api_key wasn't found.
const text = await response.text();
let result;
try {
result = JSON.parse(text);
} catch {
throw new Error(`HTTP ${response.status}: not JSON. Check that your api_key exists.`);
}
if (result.status === 1) {
console.log(`${result.total} reminders in total`);
for (const reminder of result.reminders) {
console.log(reminder.id, reminder.name, reminder.cron_expression, reminder.is_active);
}
} else {
console.error("Failed:", result.message);
}<?php
$ch = curl_init('https://wbiztool.com/api/v1/reminder/list/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode([
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'page' => 1,
]),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($result === null) {
echo "HTTP $httpCode: not JSON. Check that your api_key exists.";
} elseif ($result['status'] === 1) {
foreach ($result['reminders'] as $reminder) {
echo $reminder['id'] . ' ' . $reminder['name'] . ' ' . $reminder['cron_expression'] . "\n";
}
} else {
echo 'Failed: ' . $result['message'];
}Ganti 12345 dan YOUR_API_KEY dengan nilai Anda sendiri. Lihat Autentikasi untuk mengetahui di mana menemukannya.
Parameter request#
AuthorizationheaderDisarankanBearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini,client_iddanapi_keyboleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.client_idintegerTanpa header AuthorizationAPI Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.
api_keystringTanpa header AuthorizationKunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header.
pageintegeropsionalNomor halaman, dimulai dari
1(default). Setiap halaman berisi 50 pengingat, dan ukuran halaman tidak dapat diubah. Nilai yang bukan bilangan bulat 1 atau lebih diperlakukan sebagai1.
Respons#
Request yang berhasil mengembalikan HTTP 200:
{
"reminders": [
{
"id": 3187,
"name": "Monthly rent reminder",
"to_number": "919876543210",
"message_template": "Hi Aman, a reminder that your rent is due on {current_date_formatted}.",
"msg_type": 0,
"msg_type_display": "Text",
"img_url": "",
"file_name": "",
"cron_expression": "0 10 1 * *",
"next_run": "2026-10-01 10:00:00 UTC",
"is_active": true,
"whatsapp_client_id": 678,
"created_at": "2026-09-16 04:45:12"
}
],
"total": 1,
"page": 1,
"page_size": 50,
"message": "Success",
"status": 1
}
| Field | Tipe | Deskripsi |
|---|---|---|
status | integer | 1 jika berhasil, 0 jika request gagal. |
message | string | Success, selain itu berisi error. |
reminders | array | Pengingat di halaman ini, dari yang terbaru. Kosong jika halaman melewati akhir daftar. |
total | integer | Jumlah pengingat di workspace, di semua halaman. |
page | integer | Halaman yang dikembalikan. |
page_size | integer | Selalu 50. |
Field pengingat#
| Field | Tipe | Deskripsi |
|---|---|---|
id | integer | ID pengingat. Gunakan dengan Batalkan pengingat. |
name | string | Nama pengingat, atau Unnamed Reminder jika tidak memiliki nama. |
to_number | string | Nomor telepon atau nama grup tujuan pengingat. |
message_template | string | Pesannya, dengan variabel template yang belum diisi. |
msg_type | integer | 0 teks, 1 gambar, 2 file. |
msg_type_display | string | Text, Image, atau File. |
img_url | string atau null | URL gambar untuk pengingat gambar, atau URL file untuk pengingat file yang dibuat melalui API. Selain itu bisa kosong atau null. |
file_name | string atau null | Untuk pengingat file: URL file (pengingat yang dibuat di dashboard) atau nama file (pengingat yang dibuat melalui API, yang URL-nya ada di img_url). Selain itu bisa kosong atau null. |
cron_expression | string | Jadwalnya. Lihat Ekspresi cron. |
next_run | string | Waktu berikutnya jadwal cocok, dalam format YYYY-MM-DD HH:MM:SS UTC, atau Invalid cron jika ekspresi tidak dapat dibaca. Lihat peringatan di bawah. |
is_active | boolean | true jika pengingat berjalan, false jika dijeda. |
whatsapp_client_id | integer atau null | Nomor WhatsApp pengirimnya, atau null jika menggunakan nomor terhubung pertama. |
created_at | string | Waktu pengingat dibuat, dalam UTC, dengan format YYYY-MM-DD HH:MM:SS. |
Error#
Error mengembalikan HTTP 400 dengan status bernilai 0, kecuali disebutkan lain:
{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
| Pesan | Cara memperbaikinya |
|---|---|
Invalid JSON format: … | Body JSON tidak valid. Anda juga mendapatkan error ini untuk request GET atau request formulir tanpa client_id. |
Auth Error - Please send correct API key and Client id | Kirim client_id dan api_key. |
Invalid client id | Kirim client_id sebagai angka. |
Auth Error: invalid api key | Kunci tersebut tidak ada, sudah dihapus, atau milik client_id lain. Uji kunci Anda dengan Cek kredensial. |
Auth Error: please check client id | Kunci tidak terhubung ke workspace. Buat kunci baru di workspace yang ingin Anda gunakan. |
Demo Account cannot access APIs | Gunakan akun biasa. |
Upgrade your plan to use reminders feature | Paket Anda tidak mencakup pengingat. Upgrade paket Anda. Pengingat yang sudah ada tetap berjalan dan mengirim pesan setelah downgrade, dan tidak dapat ditampilkan, dibatalkan, atau dijeda sampai Anda melakukan upgrade. |
Error fetching reminders: … (HTTP 500) | Terjadi masalah di sisi kami. Coba lagi. |
Membaca semua halaman#
Terus minta halaman berikutnya sampai sebuah halaman berisi kurang dari 50 pengingat.
import requests
reminders, page = [], 1
while True:
response = requests.post(
"https://wbiztool.com/api/v1/reminder/list/",
json={"client_id": 12345, "api_key": "YOUR_API_KEY", "page": page},
timeout=60,
)
try:
result = response.json()
except ValueError:
raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
if result["status"] != 1:
raise RuntimeError(result["message"])
reminders += result["reminders"]
if len(result["reminders"]) < result["page_size"]:
break
page += 1
print(len(reminders), "reminders")// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const reminders = [];
let page = 1;
while (true) {
const response = await fetch("https://wbiztool.com/api/v1/reminder/list/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ client_id: 12345, api_key: "YOUR_API_KEY", page }),
});
const text = await response.text();
let result;
try {
result = JSON.parse(text);
} catch {
throw new Error(`HTTP ${response.status}: not JSON. Check that your api_key exists.`);
}
if (result.status !== 1) throw new Error(result.message);
reminders.push(...result.reminders);
if (result.reminders.length < result.page_size) break;
page += 1;
}
console.log(reminders.length, "reminders");Tips#
- Simpan salinan Anda sendiri dari
timezonesetiap pengingat saat Anda membuatnya, karena endpoint ini tidak mengembalikannya. - Temukan pengingat yang dijeda dengan memfilter
is_activeyang bernilaifalse. Lanjutkan kembali di halaman Reminders. - Bersihkan otomatisasi lama: kumpulkan dulu semua ID yang ingin Anda batalkan dari setiap halaman, lalu panggil Batalkan pengingat untuk masing-masing. Membatalkan sambil membaca halaman menggeser pengingat berikutnya ke halaman sebelumnya, sehingga sebagian terlewat.

