Отримання переліку придбаних номерів

Отримайте перелік записів про придбані номери, збережений власник яких відповідає обліковому запису, визначеному вашими обліковими даними API. Наявність запису не означає, що перевірка реальним дзвінком пройшла успішно.

Запит

Використовуйте облікові дані API на стороні сервера та передавайте їх через HTTPS. У прикладах облікові дані зчитуються зі змінних середовища; дійсних облікових даних у них немає. Перевіряйте status.code у тілі JSON, а також статус HTTP. Ці застарілі обробники не завжди встановлюють статус помилки HTTP у разі помилки застосунку.

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

Для фільтрування за одним збереженим телефонним номером скористайтеся необов’язковим варіантом шляху:

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

Укажіть збережений телефонний номер у міжнародному форматі цифрами, включно з кодом країни. Не передавайте замість нього внутрішній номер АТС, UUID номера, ідентифікатор зони або ідентифікатор префікса. Указаний номер використовується для вибору наявного запису; це не призводить до придбання чи налаштування номера.

Відповідь

Поле response у разі успіху завжди містить масив, зокрема й при використанні варіанта шляху для одного номера. status.results — це довжина масиву.

Це приклад структури відповіді, а не дані облікового запису чи актуальна цінова пропозиція.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "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"
      }
    }
  ]
}

Поля номера у відповіді
Поле	Значення
`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`	Збережені ціни за підключення, за місяць і за хвилину, а також ліміти включених хвилин. Обробник не надає поля валюти чи актуальної цінової пропозиції. Не визначайте валюту за значеннями з прикладу й не використовуйте їх як актуальну цінову пропозицію для придбання.

Фільтрування та розбиття на сторінки

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

Немає номерів, що відповідають умовам

Якщо в обліковому записі немає неанульованих записів, що відповідають умовам, тіло JSON містить status.code 404 і повідомлення з текстом no numbers found. Порожній масив як успішна відповідь не повертається. Повідомлення містить суфікс із посиланням на джерело, який клієнтські застосунки не повинні розбирати як сталий ідентифікатор.

Подальші кроки

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