דלגו לתוכן
Wbiztool

API לתזכורות

ממשק API לרשימת תזכורות

קבלו את התזכורות בסביבת העבודה שלכם, 50 בכל פעם, מהחדשה לישנה. השתמשו בו כדי למצוא מזהי תזכורות, לבקר את האוטומציות שלכם או לגבות אותן.

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

גוף הבקשה: JSON או שדות טופס

ה-endpoint הזה מקבל רק POST. בקשת GET, גם עם query string, מחזירה HTTP 400 עם Invalid JSON format: Expecting value….

הרשימה כוללת תזכורות פעילות ומושהות מכל סביבת העבודה, בין אם נוצרו דרך ה-API ובין אם בדף Reminders (תזכורות). תזכורות שבוטלו לא כלולות.

דוגמה מהירה#

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

החליפו את 12345 ו-YOUR_API_KEY בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.

פרמטרי הבקשה#

client_idintegerחובה

מזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.

api_keystringחובה

מפתח ה-API שלכם מאותו דף.

pageintegerאופציונלי

מספר הדף, החל מ-1 (ברירת מחדל). כל דף מכיל 50 תזכורות, ואי אפשר לשנות את גודל הדף. ערך שאינו מספר שלם של 1 ומעלה מטופל כ-1.

תגובה#

בקשה מוצלחת מחזירה 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
}
שדהסוגתיאור
statusinteger1 בהצלחה, 0 אם הבקשה נכשלה.
messagestringSuccess, אחרת השגיאה.
remindersarrayהתזכורות בדף הזה, מהחדשה לישנה. ריק אם הדף נמצא אחרי סוף הרשימה.
totalintegerמספר התזכורות בסביבת העבודה, בכל הדפים.
pageintegerהדף שהוחזר.
page_sizeintegerתמיד 50.

שדות של תזכורת#

שדהסוגתיאור
idintegerמזהה התזכורת. השתמשו בו עם ביטול תזכורת.
namestringשם התזכורת, או Unnamed Reminder אם אין לה שם.
to_numberstringמספר הטלפון או שם הקבוצה שאליהם התזכורת נשלחת.
message_templatestringההודעה, כשמשתני התבנית עדיין לא מולאו.
msg_typeinteger0 טקסט, 1 תמונה, 2 קובץ.
msg_type_displaystringText, Image או File.
img_urlstring or nullכתובת ה-URL של התמונה בתזכורות עם תמונה, או כתובת ה-URL של הקובץ בתזכורות עם קובץ שנוצרו דרך ה-API. בתזכורות אחרות יכול להיות ריק או null.
file_namestring or nullבתזכורות עם קובץ: כתובת ה-URL של הקובץ (בתזכורות שנוצרו בלוח הבקרה) או שם הקובץ (בתזכורות שנוצרו דרך ה-API, שכתובת ה-URL שלהן נמצאת ב-img_url). בתזכורות אחרות יכול להיות ריק או null.
cron_expressionstringלוח הזמנים. ראו ביטויי cron.
next_runstringהפעם הבאה שבה לוח הזמנים מתאים, בפורמט YYYY-MM-DD HH:MM:SS UTC, או Invalid cron אם אי אפשר לקרוא את הביטוי. ראו את האזהרה שלמטה.
is_activebooleantrue אם התזכורת פועלת, false אם היא מושהית.
whatsapp_client_idinteger or nullמספר ה-WhatsApp שממנו היא נשלחת, או null אם היא משתמשת במספר המחובר הראשון.
created_atstringמתי התזכורת נוצרה, לפי UTC, בפורמט YYYY-MM-DD HH:MM:SS.

שגיאות#

שגיאות מחזירות HTTP 400 עם status שמוגדר ל-0, אלא אם צוין אחרת:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
הודעהאיך לתקן
Invalid JSON format: …גוף ה-JSON לא תקין. תקבלו את השגיאה הזו גם בבקשת GET או בבקשת טופס בלי client_id.
Auth Error - Please send correct API key and Client idשלחו גם client_id וגם api_key.
Invalid client idשלחו את client_id כמספר.
Auth Error: invalid api keyהמפתח שייך ל-client_id אחר.
Auth Error: please check client idהמפתח לא מקושר לסביבת עבודה. צרו מפתח חדש בסביבת העבודה שבה אתם רוצים להשתמש.
Demo Account cannot access APIsהשתמשו בחשבון רגיל.
Upgrade your plan to use reminders featureהחבילה שלכם לא כוללת תזכורות. שדרגו את החבילה. תזכורות קיימות ממשיכות לרוץ ולנצל קרדיטים אחרי שנמוך, ואי אפשר להציג, לבטל או להשהות אותן עד שתשדרגו.
Error fetching reminders: … (HTTP 500)משהו השתבש אצלנו. נסו שוב.

אם ה-api_key לא קיים או נמחק, התגובה היא דף שגיאה ב-HTML עם HTTP 500 במקום JSON. בדקו את המפתח שלכם עם בדיקת פרטי התחברות.

קריאת כל הדפים#

המשיכו לבקש את הדף הבא עד שמתקבל דף עם פחות מ-50 תזכורות.

שליפת כל התזכורות
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")

טיפים#

  • שמרו עותק משלכם של ה-timezone של כל תזכורת כשאתם יוצרים אותה, כי ה-endpoint הזה לא מחזיר אותו.
  • מצאו תזכורות מושהות על ידי סינון לפי is_active שערכו false. חדשו אותן בדף Reminders.
  • נקו אוטומציות ישנות: קודם אספו מכל הדפים את המזהים שאתם רוצים לבטל, ואז קראו ל-ביטול תזכורת עבור כל אחד מהם. ביטול תוך כדי מעבר על הדפים מזיז תזכורות מאוחרות יותר לדפים מוקדמים יותר, כך שחלקן מדולגות.