מפתחים

GET/v3/cnam/{number}

חיפוש שם המתקשר

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

בעמוד זה
  1. חיפוש שם המתקשר
  2. בקשה
  3. תגובה
  4. חיובים והתאמת רישומים
  5. שגיאות וניסיונות חוזרים
  6. פעולות נוספות במספרי טלפון

חיפוש שם המתקשר

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

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

בקשה

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/cnam/12025550123

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

תגובה

הערכים מיועדים להמחשה בלבד; העלות אינה הצעת מחיר.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE NAME",
    "cost": 0.0037,
    "balance": 9.9963
  }
}
שדות חיפוש שם המתקשר
שדהמשמעות
numberהמספר שעבורו התבקש החיפוש.
nameהשם הזמין או טקסט חלופי. אין בכך אימות זהות.
costמחיר החיפוש המוגדר בחשבון או בשירות, כפי שמדווח במסלול עיבוד זה. השתמשו בתעריף הנוכחי של החשבון, ולא בערך המוצג להמחשה.
balanceהיתרה המחושבת לצורך התגובה. זו אינה שאילתת יתרת חשבון עדכנית המבוססת על עסקאות החשבון.

חיובים והתאמת רישומים

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

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

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

שגיאות וניסיונות חוזרים

בדקו גם את מצב ה־HTTP וגם את status.code/status.msg ב־JSON. קוד API שערכו 403 עשוי לציין יתרה לא מספקת בתשלום מראש, איסור על רכישות, בעיית הרשאות בחשבון או שלא נמצא שם מתקשר. מסלול העיבוד שבו לא נמצא שם עשוי להחזיר את הקוד כמחרוזת. בדקו את ההודעה במקום לפרש כל 403 כפרטי הזדהות שגויים. סתירות בהגדרות עשויות להחזיר קוד API שערכו 500.

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

פעולות נוספות במספרי טלפון

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