Розробникам

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.

Використання результату

Ця операція зчитує збережені дані. Вона не купує номер, не схвалює документи, що посвідчують особу, не змінює напрямок і не гарантує доставлення виклику, факсу чи повідомлення. Під час налаштування номера перевіряйте кожну ввімкнену послугу окремо.