Langkau ke kandungan
Wbiztool

API peringatan

API Senarai Peringatan

Dapatkan peringatan dalam ruang kerja anda, 50 pada satu masa, yang terbaharu dahulu. Gunakannya untuk mencari ID peringatan, mengaudit automasi anda atau membuat sandarannya.

POSThttps://wbiztool.com/api/v1/reminder/list/

Body: JSON atau medan borang

Endpoint ini hanya menerima POST. Permintaan GET, walaupun dengan rentetan pertanyaan, memulangkan HTTP 400 dengan Invalid JSON format: Expecting value….

Senarai ini termasuk peringatan aktif dan yang dijeda dari seluruh ruang kerja, sama ada dicipta melalui API atau di halaman Reminders (Peringatan). Peringatan yang dibatalkan tidak disertakan.

Contoh ringkas#

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
  }'

Gantikan 12345 dan YOUR_API_KEY dengan nilai anda sendiri. Lihat Pengesahan identiti untuk mengetahui di mana nilai ini boleh didapati.

Parameter permintaan#

client_idintegerwajib

API Client ID anda dari Settings → API keys (Tetapan → Kunci API).

api_keystringwajib

Kunci API anda dari halaman yang sama.

pageintegerpilihan

Nombor halaman, bermula dari 1 (lalai). Setiap halaman memuatkan 50 peringatan, dan saiz halaman tidak boleh diubah. Nilai yang bukan nombor bulat 1 atau lebih dianggap sebagai 1.

Respons#

Permintaan yang berjaya memulangkan 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
}
MedanJenisPenerangan
statusinteger1 jika berjaya, 0 jika permintaan gagal.
messagestringSuccess, jika tidak, mesej ralat.
reminderstatasusunanPeringatan pada halaman ini, yang terbaharu dahulu. Kosong jika halaman melepasi penghujung.
totalintegerBilangan peringatan dalam ruang kerja, merentasi semua halaman.
pageintegerHalaman yang dipulangkan.
page_sizeintegerSentiasa 50.

Medan peringatan#

MedanJenisPenerangan
idintegerID peringatan. Gunakannya dengan Batal peringatan.
namestringNama peringatan, atau Unnamed Reminder jika tiada nama.
to_numberstringNombor telefon atau nama kumpulan yang menerima peringatan.
message_templatestringMesej, dengan pemboleh ubah templat yang belum diisi.
msg_typeinteger0 teks, 1 imej, 2 fail.
msg_type_displaystringText, Image atau File.
img_urlstring atau nullURL imej untuk peringatan imej, atau URL fail untuk peringatan fail yang dicipta melalui API. Boleh kosong atau null dalam kes lain.
file_namestring atau nullUntuk peringatan fail: URL fail (peringatan yang dicipta dalam papan pemuka) atau nama fail (peringatan yang dicipta melalui API, yang URL-nya dalam img_url). Boleh kosong atau null dalam kes lain.
cron_expressionstringJadual. Lihat Ungkapan cron.
next_runstringMasa seterusnya jadual sepadan, sebagai YYYY-MM-DD HH:MM:SS UTC, atau Invalid cron jika ungkapan tidak dapat dibaca. Lihat amaran di bawah.
is_activebooleantrue jika peringatan sedang berjalan, false jika ia dijeda.
whatsapp_client_idinteger atau nullNombor WhatsApp yang digunakan untuk menghantar, atau null jika ia menggunakan nombor pertama yang disambungkan.
created_atstringMasa peringatan dicipta, dalam UTC, sebagai YYYY-MM-DD HH:MM:SS.

Ralat#

Ralat memulangkan HTTP 400 dengan status ditetapkan kepada 0, kecuali dinyatakan sebaliknya:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MesejCara membetulkannya
Invalid JSON format: …Badan JSON tidak sah. Anda juga menerima ralat ini untuk permintaan GET atau permintaan borang tanpa client_id.
Auth Error - Please send correct API key and Client idHantar kedua-dua client_id dan api_key.
Invalid client idHantar client_id sebagai nombor.
Auth Error: invalid api keyKunci itu milik client_id yang lain.
Auth Error: please check client idKunci tidak dipautkan ke mana-mana ruang kerja. Cipta kunci baharu dalam ruang kerja yang anda mahu gunakan.
Demo Account cannot access APIsGunakan akaun biasa.
Upgrade your plan to use reminders featurePelan anda tidak termasuk peringatan. Naik taraf pelan anda. Peringatan sedia ada terus dijalankan dan menggunakan kredit selepas pelan diturunkan, dan tidak boleh disenaraikan, dibatalkan atau dijeda sehingga anda menaik taraf.
Error fetching reminders: … (HTTP 500)Berlaku masalah di pihak kami. Cuba lagi.

Jika api_key tidak wujud atau telah dipadam, respons ialah halaman ralat HTML dengan HTTP 500 dan bukannya JSON. Uji kunci anda dengan Semak kelayakan.

Membaca setiap halaman#

Teruskan meminta halaman seterusnya sehingga sesuatu halaman mempunyai kurang daripada 50 peringatan.

Dapatkan semua peringatan
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")

Petua#

  • Simpan salinan anda sendiri bagi timezone setiap peringatan semasa anda menciptanya, kerana endpoint ini tidak memulangkannya.
  • Cari peringatan yang dijeda dengan menapis is_active yang bernilai false. Sambung semula di halaman Reminders.
  • Kemas automasi lama: mula-mula kumpulkan ID yang anda mahu batalkan merentasi setiap halaman, kemudian panggil Batal peringatan untuk setiap satu. Membatalkan semasa anda membaca halaman menganjakkan peringatan kemudian ke halaman yang lebih awal, jadi sesetengahnya akan terlangkau.