קודי שגיאה
בעת אינטראקציה עם ה-API של SMSBAT, אתה עלול להיתקל בשגיאות. אנו משתמשים בקודי תגובה קונבנציונליים של HTTP כדי לציין הצלחה או כישלון של בקשת API.
באופן כללי:
- קודים בטווח '2xx' מצביעים על הצלחה.
- קודים בטווח 4xx מציינים שגיאה שנכשלה בהתחשב במידע שסופק (למשל, פרמטר נדרש הושמט, סוג הודעה אינו חוקי וכו').
- קודים בטווח '5xx' מציינים שגיאה בשרתים שלנו.
קודי מצב HTTP
| קוד | סטטוס | תיאור |
|---|---|---|
| 200 | בסדר |
הבקשה הצליחה. |
| 400 | בקשה גרועה |
הבקשה לא הייתה מקובלת, לעתים קרובות עקב חסר פרמטר נדרש או JSON שגוי. |
| 401 | לא מורשה |
לא סופק מפתח API חוקי, או שהאימות נכשל. |
| 403 | אסור |
למפתח ה-API אין הרשאות לבצע את הבקשה, או שהחשבון שלך מושעה. |
| 404 | לא נמצא |
המשאב המבוקש אינו קיים. |
| 415 | סוג מדיה לא נתמך |
הכותרת 'Content-Type' חסרה או לא מוגדרת ל'application/json'. |
| 422 | ישות בלתי ניתנת לעיבוד |
הבקשה עוצבה כהלכה אך הכילה שגיאות סמנטיות (למשל, פורמט לא חוקי של מספר טלפון). |
| 429 | יותר מדי בקשות |
יותר מדי בקשות פוגעות ב-API מהר מדי. אנו ממליצים על ביטול אקספוננציאלי של הבקשות שלך. |
| 500, 502, 503, 504 | שגיאות שרת |
משהו השתבש בקצה של SMSBAT. |
פורמט תגובה לשגיאה
כאשר בקשת API גורמת לשגיאה, גוף התגובה מכיל אובייקט JSON עם פרטים נוספים על הבעיה.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
קודי שגיאה של לוגיקה עסקית (קודים פנימיים)
בנוסף לקודי מצב HTTP, אנו עשויים להחזיר 'קוד' פנימי ספציפי כדי לעזור לך לזהות את הסיבה המדויקת לכשל.
| קוד פנימי | תיאור | פעולה מוצעת |
|---|---|---|
| 1001 | פורמט בקשה לא חוקי |
ודא שגוף הבקשה שלך הוא JSON חוקי. |
| 1002 | חסר שדה חובה |
בדוק את המאפיין 'הודעה' בתגובה כדי לראות איזה שדה חסר. |
| 1003 | מספר טלפון לא חוקי |
ודא שמספר הנמען הוא בפורמט E.164 (לדוגמה, 380501234567). |
| 1004 | שם אלפא לא רשום |
הפרמטר 'מאת' מכיל שם אלפא שלא אושר עבור חשבונך. |
| 1005 | לא מספיק איזון |
לחשבון שלך אין מספיק כספים כדי לעבד את מסע הפרסום להעברת הודעות. |
| 1006 | סוג הודעה לא חוקי |
הפרמטר 'סוג' חייב להיות אחד מהסוגים הנתמכים (לדוגמה, 'sms', 'viber_promo'). |
| 1007 | תבנית לא נמצאה |
מזהה תבנית Viber/OTP המבוקש אינו חוקי או לא אושר. |
| 1008 | פריטי קרוסלה לא חוקיים |
קרוסלת Viber חייבת להכיל בין 2 ל-5 פריטים. |
[!טיפ] אם אתה נתקל בקוד שגיאה שאינו מופיע כאן, או אם אתה סבור ששגיאה הוחזרה בטעות, אנא צור קשר עם [email protected] וספק את מטען התגובה המדויק ואת הכותרות.