Programiści

GET/v3/inventory/{number}

Lista zakupionych numerów

Odczytaj konfigurację i zapisany stan zakupionych numerów, opcjonalnie filtrując według numeru telefonu.

Na tej stronie
  1. Żądanie
  2. Odpowiedź
  3. Filtrowanie i stronicowanie
  4. Brak pasujących numerów
  5. Następne kroki

Wyświetl rekordy zakupionych numerów, których zapisany właściciel odpowiada kontu wskazanemu przez Twoje dane uwierzytelniające API. Obecność rekordu nie oznacza pomyślnego wyniku testu rzeczywistego połączenia.

Żądanie

Używaj danych uwierzytelniających API po stronie serwera i przesyłaj je przez HTTPS. Przykłady odczytują dane uwierzytelniające ze zmiennych środowiskowych; nie zawierają działających danych uwierzytelniających. Sprawdzaj status.code w treści JSON, a także status HTTP. Te starsze procedury obsługi nie zawsze ustawiają status błędu HTTP w przypadku błędu aplikacji.

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

Aby filtrować według jednego zapisanego numeru telefonu, użyj opcjonalnego wariantu ścieżki:

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

Podaj zapisany międzynarodowy numer telefonu w postaci cyfr, łącznie z numerem kierunkowym kraju. Nie podawaj w jego miejsce numeru wewnętrznego centrali PBX, identyfikatora UUID numeru, identyfikatora obszaru ani identyfikatora prefiksu. Podany numer wybiera istniejący rekord; nie powoduje zakupu ani konfiguracji numeru.

Odpowiedź

Pole response w przypadku powodzenia zawsze jest tablicą, również w wariancie ścieżki dla pojedynczego numeru. status.results określa długość tablicy.

To przykładowa struktura odpowiedzi, a nie dane konta ani aktualna wycena.

{
  "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"
      }
    }
  ]
}
Zwracane pola numeru
PoleZnaczenie
number, uuid, description, isocodeZapisany numer telefonu, identyfikator numeru, którego struktury nie należy interpretować, opis i kod kraju.
configZapisane pola miejsc docelowych połączeń głosowych, przekierowania zewnętrznego, miejsca docelowego SMS i przekierowania SMS. Ten punkt końcowy ich nie modyfikuje.
featuresZapisane flagi obsługi połączeń głosowych, SMS i MMS. Nie ma gwarancji, że zapisane flagi ze starszego systemu są wartościami logicznymi JSON.
status.capacityLiczby przydzielonych i używanych kanałów, ustawienie obsługi nadmiarowych połączeń oraz zapisana opłata za przekroczenie limitu. Są to zapisane metadane, a nie aktualna wycena przepustowości ani test rzeczywistego połączenia.
status.originationZapisane metadane dotyczące źródła połączeń. Nie interpretuj struktury identyfikatorów; nie opieraj logiki aplikacji na wewnętrznych nazwach.
status.service_active, force_codec, force_dtmfZapisane pola aktywacji i konfiguracji mediów. Sama flaga nie potwierdza pomyślnego dostarczenia połączenia przychodzącego.
billingZapisane wartości dotyczące CNAM, obsługi nadmiarowych połączeń, odnawiania, trwałości i utworzenia. Ich odczyt nie zmienia ustawień odnawiania ani innych ustawień rozliczeniowych.
priceZapisane ceny aktywacji, opłaty miesięczne, stawki za minutę i limity minut. Procedura obsługi nie udostępnia pola waluty ani aktualnej wyceny. Nie określaj waluty na podstawie przykładowych wartości ani nie traktuj ich jako aktualnej wyceny zakupu.

Filtrowanie i stronicowanie

Ta procedura obsługi nie zapewnia stronicowania, limitu liczby rekordów na stronie ani jawnie określonej kolejności sortowania. Zwraca wszystkie nieunieważnione rekordy wybrane przez jej zapytanie. Nie udostępnia filtra ograniczającego wyniki do numerów z aktywną usługą ani osobnego widoku numerów zarchiwizowanych. Nie zakładaj, że kolejność zwracanych rekordów jest stała.

Brak pasujących numerów

Jeśli konto nie ma pasujących nieunieważnionych rekordów, treść JSON zawiera pole status.code o wartości 404 oraz komunikat zawierający no numbers found. Nie jest zwracana pusta tablica oznaczająca powodzenie. Komunikat zawiera przyrostek z odwołaniem do źródła, którego aplikacje klienckie nie powinny analizować jako stałego identyfikatora.

Następne kroki

Użyj numberinfo wtedy, gdy potrzebujesz dodatkowych pól rejestracji i odwołań do numeru ze starszego systemu dla pojedynczego numeru. Sprawdź miejsca docelowe połączeń głosowych i wiadomości przed zmianą jakiejkolwiek trasy za pomocą odrębnej operacji konfiguracji.