Vývojáři

GET/v3/inventory/{number}

Výpis zakoupených telefonních čísel

Načtení konfigurace a uloženého stavu zakoupených čísel s volitelným filtrováním podle telefonního čísla.

Na této stránce
  1. Požadavek
  2. Odpověď
  3. Filtrování a stránkování
  4. Žádná odpovídající čísla
  5. Další kroky

Vypíše záznamy zakoupených čísel, jejichž uložený vlastník odpovídá účtu určenému vašimi přihlašovacími údaji k API. Samotná přítomnost záznamu neznamená úspěšný test skutečného hovoru.

Požadavek

Používejte přihlašovací údaje k API na straně serveru prostřednictvím HTTPS. Příklady načítají přihlašovací údaje z proměnných prostředí; neobsahují žádné funkční přihlašovací údaje. Kontrolujte status.code v těle JSON i stav HTTP. Tyto starší obslužné rutiny nenastavují při chybě aplikace vždy chybový stav HTTP.

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

Chcete-li filtrovat podle jednoho uloženého telefonního čísla, použijte volitelný tvar cesty:

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

Použijte uložené mezinárodní telefonní číslo zapsané číslicemi včetně předvolby země. Nezadávejte místo něj pobočkovou linku ústředny PBX, UUID čísla, ID oblasti ani ID předvolby. Zadané číslo vybere existující záznam; žádné číslo tím nezakoupíte ani nenakonfigurujete.

Odpověď

Položka response je při úspěchu vždy polem, a to i při použití tvaru cesty pro jedno číslo. status.results udává délku pole.

Jde o ukázkovou strukturu odpovědi, nikoli o údaje účtu nebo aktuální cenovou nabídku.

{
  "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"
      }
    }
  ]
}
Vrácená pole čísla
PoleVýznam
number, uuid, description, isocodeUložené telefonní číslo, identifikátor čísla bez interpretovatelné vnitřní struktury, popis a kód země.
configUložená pole pro cíle hlasových hovorů, externí přesměrování, cíl SMS a přesměrování SMS. Tento koncový bod je neupravuje.
featuresUložené příznaky podpory hlasových hovorů, SMS a MMS. U starších uložených příznaků není zaručeno, že jde o logické hodnoty JSON.
status.capacityHodnoty přidělených a využitých kanálů, nastavení přetečení a uložený poplatek za překročení limitu. Jde o uložená metadata, nikoli o aktuální nabídku kapacity nebo test skutečného hovoru.
status.originationUložená metadata o původu hovorů. S identifikátory zacházejte jako s hodnotami bez interpretovatelné vnitřní struktury; neodvozujte logiku aplikace z interních názvů.
status.service_active, force_codec, force_dtmfUložená pole aktivace a konfigurace médií. Samotný příznak nedokazuje úspěšné doručení příchozího hovoru.
billingUložené hodnoty CNAM, přetečení, obnovování, trvalého zachování a vytvoření. Jejich načtení nemění obnovování ani jiné nastavení fakturace.
priceUložené zřizovací, měsíční a minutové ceny a příděly minut. Obslužná rutina neposkytuje pole měny ani aktuální cenovou nabídku. Z ukázkových hodnot neodvozujte měnu a nepoužívejte je jako aktuální cenovou nabídku pro nákup.

Filtrování a stránkování

Tato obslužná rutina nemá stránkování, omezení velikosti stránky ani výslovně stanovené pořadí řazení. Vrací všechny nezneplatněné záznamy vybrané jejím dotazem. Neposkytuje filtr pouze pro čísla s aktivní službou ani samostatný pohled na archivovaná čísla. Nepředpokládejte, že pořadí vrácených záznamů je stálé.

Žádná odpovídající čísla

Pokud účet nemá žádné odpovídající nezneplatněné záznamy, tělo JSON obsahuje status.code 404 a zprávu obsahující no numbers found. Nevrací prázdné pole označené jako úspěšný výsledek. Zpráva obsahuje příponu s odkazem na zdrojový kód, kterou by klienti neměli zpracovávat jako stálý identifikátor.

Další kroky

Použijte numberinfo v případě, že pro jedno číslo potřebujete další pole staršího systému s údaji o registraci a odkazy na číslo. Před změnou jakéhokoli směrování prostřednictvím samostatné konfigurační operace zkontrolujte cíle hlasových hovorů a zpráv.