מפתחים

GET/v3/numberinfo/{number}

קריאת נתונים של מספר שנרכש

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

בעמוד זה
  1. בקשה
  2. תשובה
  3. לא נמצא מספר תואם
  4. שימוש בתוצאה

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

בקשה

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

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/numberinfo/12025550100"

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

תשובה

זהו מבנה תשובה להמחשה בלבד, ולא נתוני חשבון או הצעת מחיר עדכנית.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550100",
    "uuid": "NUMBER_UUID",
    "description": "Main reception",
    "isocode": "US",
    "config": {
      "uri": "sip:reception@example.com",
      "uri2": "",
      "uri3": "",
      "forward_destination": "",
      "sms_uri": "",
      "sms_forward_destination": ""
    },
    "features": {
      "voice": "1",
      "sms": "1",
      "mms": "0"
    },
    "status": {
      "capacity": {
        "assigned_channels": "2",
        "used_channels": "0",
        "overflow": "0",
        "overage_charge": "0.01"
      },
      "origination": {
        "origination_trunk_id": "ORIGINATION_ID",
        "origination_trunk_name": "ORIGINATION_NAME",
        "origination_country_iso": "US",
        "origination_continent_iso": "NA",
        "origination_continent_name": "North America"
      },
      "service_active": "1",
      "force_codec": "",
      "force_dtmf": ""
    },
    "billing": {
      "cnam": "0",
      "overflow": "0",
      "autorenew": "1",
      "persistent": "0",
      "date_created": "2026-01-01 00:00:00"
    },
    "price": {
      "setup_price": "0.00",
      "monthly_price": "1.00",
      "per_minute": "0.01",
      "free_minutes": "0",
      "remaining_minutes": "0",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
שדות המספר המוחזרים
שדהמשמעות
number, uuid, description, isocodeמספר הטלפון השמור, מזהה המספר שאין להסיק משמעות מתוכנו, התיאור וקוד המדינה.
configהשדות השמורים של יעדי השיחות הקוליות, העברת שיחות ליעד חיצוני, יעד ה־SMS והעברת הודעות SMS. נקודת קצה זו אינה עורכת אותם.
featuresדגלי היכולות השמורים לשיחות קוליות, ל־SMS ול־MMS. אין ערובה לכך שהדגלים השמורים הוותיקים הם ערכים בוליאניים של JSON.
status.capacityערכי הערוצים המוקצים והערוצים שבשימוש, הגדרת הגלישה והחיוב השמור בגין חריגה. אלה מטא־נתונים שמורים, ולא הצעת קיבולת עדכנית או בדיקה של שיחה חיה.
status.originationמטא־נתונים שמורים על מקור השיחות. יש להתייחס למזהים כאל ערכים שאין להסיק משמעות מתוכנם; אין לגזור לוגיקה של היישום משמות פנימיים.
status.service_active, force_codec, force_dtmfשדות שמורים של הפעלת השירות ושל תצורת המדיה. דגל לבדו אינו מוכיח שתעבורה נכנסת מגיעה בהצלחה ליעדה.
billingהערכים השמורים של CNAM, גלישה, חידוש, התמדה ויצירה. קריאתם אינה משנה את הגדרות החידוש או הגדרות חיוב אחרות.
priceמחירי ההקמה, המחירים החודשיים, המחירים לדקה ומכסות הדקות השמורים. רכיב הטיפול אינו מספק שדה מטבע או הצעת מחיר עדכנית. אין להסיק מהערכים שבדוגמה באיזה מטבע מדובר או להשתמש בהם כהצעת מחיר עדכנית לרכישה.

בהשוואה ל־inventory, נקודת קצה זו מחזירה גם את needs_registration, vrating, country_id, area_id, provider_id ואת price.perminute_charges. אלה ערכים שמורים ותיקים, ולא תשובה נפרדת בדבר אישור זהות. יש להתייחס למזהי ההפניה כאל ערכים שאין להסיק משמעות מתוכנם; אין לבנות מהם כתובות URL לגילוי או להסיק מהם מיפויים של ספקים ללא תשובת הגילוי המתאימה.

לא נמצא מספר תואם

אם לא נמצאה עבור החשבון המאומת רשומה תואמת שלא בוטלה, בגוף ה־JSON מופיע בשדה status.code הערך 404 והודעה המכילה number not found. אין להסתמך על הסיומת המציינת שורה בקוד המקור. יש לבדוק את המספר השמור ואת inventory לפני ניסיון חוזר.

שימוש בתוצאה

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