תיעוד REST API
שלחו את בקשת ה-API הראשונה שלכם אל MultiTEL
התחילו בבקשת קריאה בלבד, הבינו את התגובה ולאחר מכן בחרו את מדריך העזר לשירות שברצונכם לבנות.

בחירת ה-API ופרטי ההזדהות יחד
חשבונות מאושרים מסוג מפתחים ואוטומציה, עסקי וספקי תקשורת יכולים לשלב שירותים שהופעלו. מפתח יחיד אינו צריך להתחזות לחברה. שליחת SMS/MMS מאפליקציה מחייבת את אישור השליחה והרישום הרלוונטיים. בשירותים ליחידים ולמשפחות אין API ללקוחות ליזום הודעות.
| משפחת API | כתובת בסיס (Base URL) | אימות ותוצאה |
|---|---|---|
| תקשורת v3 | https://api.multitel.net/v3 | פרטי הזדהות מאושרים מסוג Basic; אסימונים (tokens) שהוקצו ומתאימים לשימוש, רק בפעולות שתומכות בהם. JSON עם status ו-response. |
| רישום לשירותי חירום | https://api.multi.tel/emergency | פרטי הזדהות מאושרים מסוג Basic או גישת bearer שהוקצתה במיוחד. JSON עם code, message ו-data. |
| אינטגרציות REST של הפורטל | המארח והפעולה כפי שמוצגים בתיעוד המפתחים של החשבון שלך | יש להשתמש בפרטי ההזדהות, בהיקפי ההרשאה (scopes) ובסכמה המתועדים של אותה פעולה. בקשות מסשן דפדפן משתמשות בממשק נפרד. |
יש להגדיר את MULTITEL_API_USERNAME ואת MULTITEL_API_PASSWORD בהגדרות הסודות של השרת שלך לפני השימוש בדוגמאות. אין להטמיע אותם ב-JavaScript ציבורי בדפדפן, בכתובות URL או בבקרת גרסאות. פרטי הזדהות ייעודיים מנוהלים ב-הגדרות שילוב API.
בקשה ראשונה: קריאת היתרה שלך
קריאה זו אינה רוכשת שירות ואינה יוזמת שיחה או הודעה.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"ה-API של התקשורת בגרסה v3 מחזיר את תוצאת האפליקציה בתוך גוף ה-JSON. יש לבדוק את סטטוס ה-HTTP ואת status.code לפני קריאת response; בבקשה שנדחתה ייתכן שלא יהיה אובייקט response. ערכי קוד יכולים להיות מחרוזות או מספרים.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}זוהי דוגמה בדיונית, ולא יתרת חשבון אמיתית. יש להתייחס לערכים כספיים כסכומים עשרוניים. בעת אבחון בקשה שנדחתה, יש לשמור את הודעת התגובה של השרת לאחר הסרת פרטי ההזדהות.
שימוש נכון בנתוני החיוב
תגובת היתרה כוללת את היתרה הנוכחית, את המטבע ואת תנאי התשלום. היא אינה מציינת את עלות שיחה עתידית ואינה חשבונית מלאה. לשאלות אלה יש להשתמש בפעולות התעריפים והשימוש המתאימות. למספרים קיימים יכולות להיות תוכניות שונות מהקטלוג של היום.
בחירת האינטגרציה הבאה שלך
ממשק REST API לבדיקת ניתוב LRN
אתרו את מספר הניתוב ואת מידע הספק הזמין עבור מספר טלפון בצפון אמריקה במחיר קבוע.
קריאת מדריך האינטגרציה ←ממשקי REST API למספרי טלפון
גלו מדינות ומספרים זמינים, בדקו את ההצעה המלאה ונהלו את המספרים שבבעלותכם.
קריאת מדריך האינטגרציה ←ממשקי REST API ל-SMS ול-MMS
שלחו הודעות יישום מאושרות וטפלו בקבלת הבקשות, באירועי מסירה, בפיצול למקטעים ובחיובים.
קריאת מדריך האינטגרציה ←ממשקי REST API לשיחות חירום
רשמו מספר וכתובת שירות, עקבו אחר סטטוס ההפעלה שלהם ותחזקו את הרשומה כשהמיקום משתנה.
קריאת מדריך האינטגרציה ←ממשקי REST API לחשבון ולחיוב
קראו את היתרה ואת פרטי החיוב הזמינים לשילוב המאושר שלכם.
קריאת מדריך האינטגרציה ←בדיקות CNAM וניתוב
קראו שמות מתקשרים, הבינו את דרגות הבדיקה והשתמשו במידע על ניתוב מספרים.
מדריך עזר ל-CNAM REST ←PBX מתארח
התחילו בתוכניות השירות הזמינות ובדייר (tenant) שבכוונתכם להגדיר.
ממשק API של תוכניות שירות ל-PBX מתארח ←טיפול בשגיאות ובניסיונות חוזרים
- כשל באימות או בהרשאה
- יש לבדוק שפרטי ההזדהות של ה-API פעילים, שהשירות מותר ושמגבלות כתובת ה-IP של המקור מתקיימות. עוגיית סשן בפורטל אינה פרטי הזדהות לאינטגרציה.
- קרדיט לא מספיק או אישור שלא התקיים
- יש לטפל ביתרת החשבון, באישור השליחה או בדרישת המסמכים לפני שחוזרים על הפעולה.
- אין תוצאה
- יש לטפל במלאי ריק או בשם מתקשר חסר כתוצאה רגילה. אין להניח שלמספר תקין מבחינה תחבירית יש את כל השירותים.
- פסק זמן ברשת או כשל בשירות
- בפעולות קריאה יש להשתמש בניסיונות חוזרים מוגבלים עם השהיה גדלה (backoff). ברכישה, בשליחה או ברישום, יש לבדוק תחילה את מצב הפעולה; ניסיון חוזר של בקשה שהתקבלה עלול לשכפל פעולה בחיוב.
התמיכה באידמפוטנטיות (idempotency) תלויה בכל משפחת API. ה-API לשירותי חירום תומך במפתחות לניסיון חוזר; אין זה הופך בקשות v3 שרירותיות לאידמפוטנטיות. יש לשמור חותמות זמן, מזהים שהוחזרו ותגובות לאחר הסרת פרטים רגישים לצורך פנייה לתמיכה.
המשיכו עם מדריך העזר של החשבון שלכם
מדריך העזר למשתמשים מחוברים מסנן את הפעולות לפי ההרשאות והשירותים המופעלים בחשבונכם. השתמשו במארח המדויק, בסוג פרטי ההזדהות, בשדות הבקשה ובסכמת התגובה המופיעים בו. הקונסולות יכולות לבצע פעולות בפועל, כולל רכישות ושליחת הודעות.