Програмери

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 када су вам за један број потребна додатна поља из старог система која се односе на регистрацију и референцу броја. Проверите одредишта говорних позива и порука пре него што промените било коју руту засебном операцијом конфигурације.