Programiści

GET/v3/numberinfo/{number}

Odczytaj dane jednego zakupionego numeru

Odczytaj zapisaną konfigurację, flagi obsługiwanych funkcji i starsze pola referencyjne zakupionego numeru telefonu.

Na tej stronie
  1. Żądanie
  2. Odpowiedź
  3. Brak pasującego numeru
  4. Wykorzystaj wynik

Odczytaj jeden rekord zakupionego numeru i jego zapisaną konfigurację. Ta operacja zwraca obiekt zamiast tablicy zwracanej przez punkt końcowy inventory.

Żądanie

Używaj danych uwierzytelniających API po stronie serwera 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/numberinfo/12025550100"

Wymaganym segmentem ścieżki jest zapisany numer telefonu w formacie międzynarodowym, a nie jego UUID ani numer wewnętrzny centrali PBX. Ta procedura obsługi nie korzysta z parametrów zapytania ani treści żądania.

Odpowiedź

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

{
  "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"
  }
}
Zwracane pola numeru
PoleZnaczenie
number, uuid, description, isocodeZapisany numer telefonu, identyfikator numeru bez znaczenia interpretowanego przez klienta, opis i kod kraju.
configZapisane pola miejsc docelowych połączeń głosowych, przekierowania zewnętrznego, miejsca docelowego wiadomości SMS i przekierowania wiadomości SMS. Ten punkt końcowy ich nie edytuje.
featuresZapisane flagi obsługi połączeń głosowych oraz wiadomości SMS i MMS. Nie ma gwarancji, że zapisane flagi starszego formatu są wartościami logicznymi JSON.
status.capacityLiczby przydzielonych i używanych kanałów, ustawienie obsługi przekroczenia pojemności oraz zapisana opłata za przekroczenie limitu. Są to zapisane metadane, a nie aktualna wycena pojemności ani test połączenia na żywo.
status.originationZapisane metadane źródła połączeń. Traktuj identyfikatory jako wartości bez interpretowanej struktury; 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 skutecznego dostarczania ruchu przychodzącego.
billingZapisane wartości dotyczące CNAM, obsługi przekroczenia pojemności, odnawiania, trwałości i utworzenia. Ich odczyt nie zmienia ustawień odnawiania ani innych ustawień rozliczeniowych.
priceZapisane ceny aktywacji, miesięczne i za minutę oraz limity minut. Procedura obsługi nie udostępnia pola waluty ani aktualnej wyceny. Nie ustalaj waluty na podstawie przykładowych wartości ani nie używaj ich jako aktualnej wyceny zakupu.

W porównaniu z inventory, ten punkt końcowy zwraca również needs_registration, vrating, country_id, area_id, provider_id i price.perminute_charges. Są to zapisane wartości starszego formatu, a nie odrębna odpowiedź zatwierdzająca tożsamość. Identyfikatory referencyjne należy traktować jako wartości bez interpretowanej struktury; bez odpowiedniej odpowiedzi mechanizmu wykrywania nie twórz na ich podstawie adresów URL tego mechanizmu ani nie wywnioskuj przypisań do dostawców.

Brak pasującego numeru

Jeśli dla uwierzytelnionego konta nie zostanie znaleziony pasujący, nieunieważniony rekord, treść JSON zawiera status.code 404 oraz komunikat zawierający number not found. Nie polegaj na przyrostku wskazującym wiersz kodu źródłowego w tym komunikacie. Przed ponowieniem próby sprawdź zapisany numer i inventory.

Wykorzystaj wynik

Jest to odczyt zapisanych danych. Nie powoduje zakupu numeru, zatwierdzenia dokumentów tożsamości ani zmiany miejsca docelowego i nie gwarantuje dostarczenia połączenia, faksu ani wiadomości. Podczas konfigurowania numeru przetestuj osobno każdą włączoną usługę.