Разработчици

GET/v3/inventory/{number}

Списък на закупените номера

Преглед на конфигурацията и съхраненото състояние на закупените номера с възможност за филтриране по телефонен номер.

На тази страница
  1. Заявка
  2. Отговор
  3. Филтриране и разделяне на страници
  4. Няма съответстващи номера
  5. Следващи стъпки

Извежда списък на записите за закупени номера, чийто съхранен собственик съответства на акаунта, към който принадлежат вашите данни за удостоверяване за 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"

Използвайте съхранения международен телефонен номер като поредица от цифри, включително кода на държавата. Не подавайте вместо него вътрешен номер на PBX, 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 когато са ви необходими допълнителните полета от наследената система за регистрация и препратки към един номер. Проверявайте направленията за гласови повиквания и съобщения, преди да промените който и да е маршрут чрез отделна операция за конфигуриране.