דלגו לתוכן
WbizTool

API v2 (בטא)

תזכורות

תזכורת שולחת את אותה הודעה לנמען אחד שוב ושוב לפי לוח זמנים: שכר דירה בכל חודש, שיעור בכל יום שני, דוח בכל ערב. לוח הזמנים הוא ביטוי cron בן 5 חלקים, באזור זמן שאתם בוחרים. תזכורות שנוצרות עם ה-API זהות לאלה שבדף תזכורות בלוח הבקרה.

פעולהEndpointהרשאה
יצירת תזכורתPOST /api/v2/remindersreminders
רשימת תזכורותGET /api/v2/remindersreminders
קבלת תזכורתGET /api/v2/reminders/{id}reminders
שינוי, השהיה או חידושPATCH /api/v2/reminders/{id}reminders
מחיקת תזכורתDELETE /api/v2/reminders/{id}reminders

יצירה ושינוי של תזכורות דורשים תוכנית שכוללת תזכורות; אחרת התגובה היא 403 plan_required. הצגה, קריאה, השהיה ומחיקה עובדות בכל תוכנית. להודעה שיוצאת פעם אחת במועד מסוים, השתמשו במקום זאת ב-send_at בשליחת הודעה.

יצירת תזכורת#

POSThttps://wbiztool.com/api/v2/reminders

גוף הבקשה: 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" }
  }'

תגובה (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"
}

גוף הבקשה

namestringחובה

שם לתזכורת, עד 100 תווים, כפי שהוא מוצג בדף תזכורות.

toobjectחובה

בדיוק אחד מהשדות phone (בפורמט בינלאומי עם +), ‏group (השם המדויק של קבוצת WhatsApp), ‏contact_id או username (Telegram), כמו בהודעות ← נמענים.

frominteger or nullחובה במפתח שמוגבל לחלק מהמספרים

ה-id של המספר ששולח אותה. הוא חייב להיות מחובר כשאתם מגדירים אותו. אם לא תשלחו אותו, או תשלחו null: כל מספר מחובר של סביבת העבודה שולח אותה.

textstringחובה

ההודעה, עד 3,000 תווים. זה גם הכיתוב כשנשלחת media.

mediaobject or nullאופציונלי

תמונה או קובץ לשליחה בכל פעם: url או media_id, ואם תרצו גם type, כמו בהודעות ← מדיה.

scheduleobjectחובה

‏cron (חובה) ו-timezone. ראו לוח זמנים.

activebooleanאופציונלי

‏true (ברירת המחדל) מפעיל אותה; false יוצר אותה מושהית.

לוח זמנים#

ל-schedule.cron יש חמישה חלקים שמופרדים ברווחים: דקה, שעה, יום בחודש, חודש, יום בשבוע. ‏* פירושו "כל". זה חייב להיות לוח זמנים שרץ בשלב כלשהו (לא 31 בפברואר).

cronרץ
0 9 * * 1בימי שני ב-09:00
30 18 * * *כל יום ב-18:30
0 10 1 * *ב-1 בכל חודש ב-10:00
0 9 * * 1-5בימי חול (שני עד שישי) ב-09:00
0 8,20 * * *כל יום ב-08:00 וב-20:00
0 9 15 1 *ב-15 בינואר ב-09:00, בכל שנה

‏schedule.timezone הוא שם של אזור זמן לפי IANA, למשל Asia/Kolkata, ‏Europe/London או America/New_York (ברירת המחדל UTC). זמני ה-cron הם באזור הזה, וגם next_run_at מוצג בו, עם ההיסט שלו. ראו את מדריך אזורי הזמן.

כל הרצה שולחת הודעה כמו כל הודעה אחרת: נדרשות הודעות שנותרו בתוכנית, והיא מופיעה ברשימת הודעות.

שגיאות ביצירה#

HTTPקודמתי
400validation_failedשדה חובה חסר או ריק, שדה לא מוכר או ארוך מדי (name, ‏to.group), או ש-media לא תקין
400text_required‏text ריק
400text_too_long‏text ארוך מ-3,000 תווים
400invalid_cronב-schedule.cron אין 5 חלקים, או שהוא אף פעם לא רץ
400invalid_timezone‏schedule.timezone אינו אזור זמן של IANA
403plan_requiredהתוכנית לא כוללת תזכורות
403number_not_allowedהמפתח מוגבל לחלק מהמספרים, ו-from אינו אחד מהם, או חסר
422invalid_phone‏to.phone אינו מספר תקין בפורמט בינלאומי עם +
422invalid_username‏to.username אינו שם משתמש, קישור או מזהה tg: של Telegram
422username_needs_telegramשם משתמש של Telegram, אבל from אינו חשבון Telegram (או, בלי from, אין חשבון Telegram מחובר)
422contact_not_foundאין איש קשר עם ה-to.contact_id הזה
422media_not_foundאין קובץ עם ה-media.media_id הזה
422invalid_media_url‏media.url אינו קישור http(s) ציבורי
422number_not_connected‏from אינו מספר מחובר של סביבת העבודה הזו

רשימת תזכורות#

GEThttps://wbiztool.com/api/v2/reminders

התזכורות של סביבת העבודה, מהחדשה לישנה, בדפים (limit מ-1 עד 100, ברירת המחדל 25, ו-cursor). גם תזכורות מושהות כלולות, עם "active": false. מפתח שמוגבל לחלק מהמספרים רואה רק את התזכורות שנשלחות מהם.

curl "https://wbiztool.com/api/v2/reminders?limit=50" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

התגובה היא {"data": [Reminder, …], "next_cursor": "…" or null}.

קבלת תזכורת#

GEThttps://wbiztool.com/api/v2/reminders/{id}
curl https://wbiztool.com/api/v2/reminders/812 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

תזכורת שלא קיימת, שנמחקה, או שנשלחת ממספר שהמפתח לא רשאי להשתמש בו מחזירה 404 reminder_not_found.

שינוי, השהיה או חידוש של תזכורת#

PATCHhttps://wbiztool.com/api/v2/reminders/{id}

גוף הבקשה: JSON (application/json)

שלחו רק את השדות שמשתנים; השאר שומרים על הערכים שלהם. השדות הם אלה של יצירת תזכורת. התגובה היא 200 עם התזכורת כפי שהיא עכשיו.

  • השהיה: {"active": false}. היא מפסיקה לרוץ ו-next_run_at הופך ל-null. השהיה עובדת בכל תוכנית.
  • חידוש: {"active": true}. היא רצה שוב מהמועד הבא שלה. חידוש דורש תוכנית עם תזכורות.
  • ‏schedule מוחלף כולו: שלחו איתו את cron. בלי timezone, התזכורת שומרת על אזור הזמן הנוכחי שלה.
# 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."}'

שינוי מחזיר את אותן שגיאות כמו יצירה, וגם 404 reminder_not_found. אם שדה אחד שגוי, שום דבר לא משתנה.

מחיקת תזכורת#

DELETEhttps://wbiztool.com/api/v2/reminders/{id}

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

curl -X DELETE https://wbiztool.com/api/v2/reminders/812 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{ "id": 812, "deleted": true }

האובייקט Reminder#

שדהסוגתיאור
idintegerהמזהה של התזכורת.
namestringהשם שלה.
activeboolean‏true כשהיא רצה, false כשהיא מושהית.
toobjectהנמען: phone (עם +), ‏group או username. תזכורת שנוצרה עם contact_id מציגה את המספר או את הקבוצה של איש הקשר.
frominteger or nullה-id של המספר השולח, או null לכל מספר מחובר.
textstringההודעה.
mediaobject or null‏type (image או file), ‏url ו-file_name.
scheduleobject‏cron ו-timezone.
next_run_atstring or nullמתי היא רצה בפעם הבאה, באזור הזמן שלה עם ההיסט, למשל 2026-10-19T09:00:00+05:30. ‏null כשהיא מושהית.
created_atstringמתי היא נוצרה (UTC).

מדריכים קשורים#