השבתת קמפיין הודעות

השבתת קמפיין הודעות קיים

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

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

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

הסירו תחילה את שיוכי המספרים המושפעים

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

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

שלחו את בקשת ההשבתה הרצויה

לאחר בדיקת מזהה הקמפיין והגדרות השליחה המושפעות, שלחו DELETE ללא גוף JSON:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

תגובת ההצלחה המתועדת היא HTTP 204 עם גוף ריק. בדקו את קוד המצב של HTTP במקום לצפות למעטפת status/response בפורמט JSON. כאשר המחיקה מתקבלת, השירות הנוכחי מסמן את משאב הקמפיין כמחוק וכפג תוקף במערכת המקומית, ומסמן את רשומת הקמפיין במערכת הישנה כפגת תוקף. המחיקה אינה מתפשטת למותג.

השתמשו במפתח אידמפוטנטיות אחד עבור הבקשה הרצויה הזאת, ושמרו במדויק את השיטה, הנתיב, השאילתה והבתים של הגוף לצורך שליחה חוזרת. בקשה כפולה שבקשתה המקורית עדיין בעיבוד עשויה להחזיר 409 עם Retry-After; בבקשות שהושלמו ניתן להחזיר שוב את התוצאה השמורה. שגיאה שנשמרה במטמון או חיבור שנקטע אינם קובעים אם המרשם כבר ביצע את הפעולה. שמרו את מזהה הקמפיין ואת requestId כאשר הוא קיים.

בדקו הן את הרישום והן את השיוכים

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

אם מספר נשאר משויך, הסדירו את השיוך הקיים שלו. אל תיצרו קמפיין נוסף רק כדי לנסות שוב את ההשבתה, ואל תניחו שתגובת HTTP 204 מוכיחה שהניקוי אצל המפעיל בוצע. אם הסנכרון המקומי נכשל לאחר שהמרשם קיבל את הבקשה, ממשק API עשוי להחזיר 500 אף שההשבתה החיצונית כבר בוצעה.

הוצאה משימוש נפרדת מהסדרת החשבון

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

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