API למחיקת קמפיין מתוזמן
ממשק מחיקת הקמפיין של מיקרופיי מאפשר למחוק שליחה שתזמנת, לפי קוד הקמפיין. ניתן למחוק רק קמפיינים בסטטוס "בהמתנה", לפני תחילת השליחה.
המחיקה מתבצעת על אותו ממשק בדיקת הסטטוס (taskStatus.php) עם הפרמטר act=del. הפנייה מתבצעת ב-HTTPS, ב-GET/POST או JSON, ומאומתת באמצעות טוקן.
סקירת הממשק
ניתן לבצע מחיקה של שליחה שביצעת, לפי קוד הקמפיין שהוקצה לה. את קוד הקמפיין המערכת מחזירה בתשובת בקשת השליחה: הוא מופיע אחרי הערך
OK כשהשליחה התקבלה בהצלחה (ובמצב JSON בשדה data.taskId). המחיקה מתבצעת על כתובת ממשק בדיקת הסטטוס, taskStatus.php, עם הפרמטר act=del.
כתובת הממשק ושיטת השליחה
הכתובת למחיקת קמפיין היא:
https://www.micropay.co.il/extApi/taskStatus.php
יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.
אימות וטוקן
הממשק מוחק קמפיינים מכל הסוגים: סמס, הודעות קוליות ווואטסאפ. הבקשה דורשת פרמטר token, טוקן שיצרת במערכת עם הרשאת שירותי סמס, שירותי טלפוניה או שירותי וואטסאפ.
פרמטרים
| פרמטר | חובה | תיאור |
|---|---|---|
token | חובה | טוקן הזדהות שיצרת במערכת, עם הרשאת שירותי סמס, שירותי טלפוניה או שירותי וואטסאפ. |
tid | חובה | קוד הקמפיין שברצונך למחוק (התקבל בתשובת השליחה). |
act | חובה | יש לשלוח עם הערך del כדי לבצע את המחיקה. |
get / post | חובה | מציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. הפרמטר אינו משנה את שיטת השליחה בפועל, אלא רק מצהיר עליה. (בפורמט JSON אין צורך בפרמטר זה.) |
דוגמאות קוד
curl "https://www.micropay.co.il/extApi/taskStatus.php?get=1&token=XXXXX&tid=34556&act=del"curl -X POST https://www.micropay.co.il/extApi/taskStatus.php \ -H "Content-Type: application/json" \ -d '{"token":"XXXXX","tid":"34556","act":"del"}'
Content-Type: application/json, כפי שמופיע בדוגמאות.
אם אינך יכול לקבוע כותרות בבקשה, תוכל במקום זאת להוסיף json=1 בכתובת ה-URL ולשלוח את גוף ה-JSON ב-POST.
תשובת השרת
בהצלחה המערכת מחזירה OK. במצב JSON, message הוא OK, שדה action הוא del, ו-data כולל את remoteIP.
תשובה רגילה (טקסט)
# הקמפיין נמחק OK # שגיאה ERROR --> Description: tid parameter, campaign not found or not pending
תשובה ב-JSON
// נמחק בהצלחה {"status":1,"action":"del","message":"OK","data":{"remoteIP":"203.0.113.10"}} // שגיאת פרמטר {"status":0,"action":"del","message":"ERROR","data":{"description":"tid parameter, campaign not found or not pending","remoteIP":"203.0.113.10"}}
טבלת קודי תשובה
| ערך | status ב-JSON | משמעות |
|---|---|---|
OK | 1 | הקמפיין נמחק בהצלחה. |
ERROR | 0 | שגיאה באחד הפרמטרים, או שהקמפיין אינו קיים או אינו בסטטוס "בהמתנה". בטקסט מופיע רווח ותיאור; ב-JSON התיאור נמצא ב-data.description. |
שאלות נפוצות
אילו קמפיינים ניתן למחוק?
רק קמפיינים בסטטוס "בהמתנה" (pending), כלומר לפני שהשליחה החלה. קמפיין שכבר רץ או הסתיים אינו ניתן למחיקה.
מאיפה מקבלים את קוד הקמפיין למחיקה?
קוד הקמפיין מתקבל בתשובת בקשת השליחה: הוא מופיע אחרי הערך OK (וב-JSON בשדה data.taskId). שולחים אותו בפרמטר tid יחד עם act=del.
איך מוחקים קמפיין של תת מנהל?
שולחים טוקן המשויך לתת המנהל, יחד עם קוד הקמפיין שלו בפרמטר tid ו-act=del.