שילוב CNAM

מדריך עזר ל-CNAM REST API

בקשו שם מתקשר באמצעות HTTPS וטפלו בתוצאה, בחיוב ובשגיאות.

בחרו את התנהגות הבדיקה

דרגה	מחיר ציבורי לכל שאילתה	מה היא עושה
Starter	‏0.0026 ‏$	משתמשת במידע קנייני ובמידע שמור במטמון על שמות מתקשרים.
Standard	‏0.0037 ‏$	מבצעת בדיקת רשת בזמן אמת עבור כל שאילתה.
Mixed	‏0.004 ‏$	מנסה תחילה בדיקה בזמן אמת, ואז חוזרת לנתוני Starter כאשר לא נמצא שם.

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

שלחו בדיקה מאומתת

נקודת קצה: GET https://api.multitel.net/v3/cnam/NUMBER. השתמשו במספרי טלפון בפורמט בינלאומי, בספרות בלבד וכולל קידומת המדינה, ללא סימני פיסוק וללא סימן פלוס בתחילת המספר. בצעו זאת משרת היישום שלכם באמצעות פרטי הזדהות מאושרים ל-API.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

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

מדריך אימות API ובקשה ראשונה

קראו את תגובת ה-JSON

תגובה זו היא להמחשה בלבד. השם שיוחזר והחיוב תלויים בבדיקה ובשירות שנבחר.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}

status.code: קוד תוצאת היישום; נרמלו ערכי מחרוזת ומספר לפני השוואה ל-200.
status.msg: הודעת התוצאה או הדחייה הנלווית.
response.number: המספר שנבדק.
response.name: שם המתקשר הזמין.
response.cost: החיוב שדווח עבור שאילתה זו; התייחסו אליו כסכום עשרוני.
response.balance: יתרת החשבון שדווחה, כאשר היא קיימת.

תוצאות ללא שם ושגיאות

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

בדקו גם את סטטוס ה-HTTP וגם את status ב-JSON לפני הגישה אל response.name. אובייקט התגובה עשוי להיעדר במקרה של שגיאה. היעדר שם לא אמור למנוע את ניתוב השיחה הרגילה.

חיוב, ניסיונות חוזרים וההבדל מעדכון זיהוי המתקשר

בדיקה חדשה עלולה לגרור חיוב שאילתה. ממשקי הבדיקה הללו אינם מתעדים מפתח אידמפוטנטיות (idempotency key), ולכן ניסיון חוזר חדש עלול להיות שאילתה שנייה בחיוב. השתמשו במספר מוגבל של ניסיונות חוזרים עם השהיה גדלה ביניהם (backoff) עבור כשלי העברה או שירות, פתרו תחילה שגיאות חשבון ובצעו התאמה מול חיובי השאילתות שדווחו. שמרו במטמון רק לפרק זמן המתאים ליישום שלכם; נתוני שם המתקשר עשויים להשתנות.

בדיקת CNAM קוראת שם. היא אינה משנה את השם המוצג בשיחות היוצאות שלכם. עדכון שם מתקשר ב-LIDB הוא פעולה נפרדת, עם שדות, הרשאה, מחיר ועיבוד משלה.

מדריך שילוב CNAM בחשבון קבלו עזרה בשילוב