דלגו לתוכן
Wbiztool

API לתזכורות

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

עצרו תזכורת חוזרת כך שלא תרוץ יותר לעולם. השתמשו בו כשלקוח משלם, כשמנוי מסתיים או כשאוטומציה כבר לא נחוצה.

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

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

אתם צריכים את ה-reminder_id שהוחזר מ-יצירת תזכורת. אם אין לכם אותו, מצאו אותו באמצעות רשימת תזכורות.

דוגמה מהירה#

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "reminder_id": "3187"
  }'

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

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

client_idintegerחובה

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

api_keystringחובה

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

reminder_idstringחובה

המזהה של התזכורת לביטול, כפי שהוחזר מ-יצירת תזכורת או מ-רשימת תזכורות. הוא חייב להשתייך לאותה סביבת עבודה כמו מפתח ה-API.

שליחת שדות טופס עוקפת את הבעיה, כי כל ערך בטופס הוא מחרוזת:

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -d client_id=12345 \
  -d api_key=YOUR_API_KEY \
  -d reminder_id=3187

תגובה#

בקשה מוצלחת מחזירה HTTP 200:

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
שדהסוגתיאור
statusinteger1 אם התזכורת בוטלה, 0 אם הבקשה נכשלה.
messagestringReminder cancelled successfully, אחרת השגיאה.

שגיאות#

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

{ "status": 0, "message": "Reminder not found" }
הודעהאיך לתקן
Invalid JSON format: …גוף ה-JSON לא תקין. תקבלו את השגיאה הזו גם בבקשת טופס בלי client_id, או בכל בקשת GET.
Reminder ID cannot be nullהוסיפו reminder_id.
Auth Error - Please send correct API key and Client idשלחו גם client_id וגם api_key.
Invalid client idשלחו את client_id כמספר.
Invalid reminder idהשדה reminder_id חייב להיות מספר שלם, כמו 3187.
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החבילה שלכם לא כוללת תזכורות. תזכורות שנוצרו קודם ממשיכות לרוץ ולצרוך קרדיטים, ואי אפשר לבטל או להשהות אותן, לא דרך ה-API ולא ממרכז הבקרה, עד שתשדרגו.
Reminder not found (HTTP 404)המזהה לא קיים, נמצא בסביבת עבודה אחרת, או שהתזכורת כבר בוטלה.
Error cancelling reminder: … (HTTP 500)משהו השתבש אצלנו. נסו שוב.

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

מה הביטול עושה#

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

טיפים#

  • ביטול כפול מחזיר Reminder not found. אם אתם שולחים בקשות שוב, התייחסו להודעה הזו כ„כבר בוטלה“.
  • השהיה לא זמינה דרך ה-API. כדי לעצור תזכורת באופן זמני, השהו אותה במקום זאת בדף Reminders.
  • שינוי לוח זמנים: אין API לעדכון. בטלו את התזכורת וצרו תזכורת חדשה עם ה-cron_expression החדש.