Vývojáři

GET/v3/get_document_number_types/{country}

Výpis typů čísel pro registraci

Zjistěte názvy typů čísel, které jsou aktuálně zastoupeny v registračním katalogu pro danou zemi.

Na této stránce
  1. Vyberte typ podle názvu vráceného v odpovědi
  2. Počty skupin nevyjadřují zásobu telefonních čísel
  3. Požadavek
  4. Odpověď
  5. Chyby
  6. Dostupnost a vedlejší účinky

Vyberte typ podle názvu vráceného v odpovědi

Použijte zemi z get_document_countries. Vrácený název typu předejte funkci get_requirements. ID typu v katalogu není ID předvolby, ID čísla ani ID kategorie dokladu.

Počty skupin nevyjadřují zásobu telefonních čísel

available_groups udává počet záznamů skupin vrácených tímto vyhledáváním v katalogu. Neudává počet telefonních čísel dostupných ke koupi, nerezervuje zásoby ani nezaručuje, že katalog načetl všechny stránky z nadřazeného zdroje. Samostatně vyhledejte příslušnou nabídku čísel a zkontrolujte cenovou nabídku.

Požadavek

Použijte přihlašovací údaje svého aktivovaného účtu API prostřednictvím HTTPS. Podporováno je ověřování Basic a povolené tokeny bearer účtu API; platí omezení účtu.

GET s případným dokumentovaným parametrem v cestě URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Parametry cesty
NázevTypPovinnýPopis
countrystringAnoDvoupísmenný kód ISO země z katalogu zemí pro registraci. Počáteční a koncové bílé znaky se odstraní a kód se převede na velká písmena.

Odpověď

Zkontrolujte status.code v těle JSON i stav HTTP. response je pole obsahující id, name a available_groups. Hodnotu name použijte jako number_type při volání get_requirements; neposílejte místo ní id. available_groups udává počet záznamů skupin vrácených pro daný typ, nikoli počet telefonních čísel v zásobě nebo úplný součet za všechny stránky. Typy, pro které nebyly vráceny žádné skupiny, se vynechávají. Upřednostňované pořadí je Local, Mobile, National, Toll Free, Shared Cost, Global, po nichž následují ostatní názvy z katalogu.

Ukázková struktura odpovědi; nejde o aktuální data účtu ani o aktuální cenovou nabídku.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Chyby

  • 400: country is required: zadejte kód ISO země pro registraci.
  • 400: Invalid country ISO or no available DID registration country found: vyberte zemi z aktuálního registračního katalogu; tato chyba neznamená, že nejsou vyžadovány žádné dokumenty.

Dostupnost a vedlejší účinky

  • Toto vyhledávání v katalogu nebo zjišťování požadavků nevytváří identitu, nenahrává doklad, neregistruje číslo ani nevytváří objednávku.
  • Úspěšná odpověď katalogu neznamená schválení vašich dokumentů ani potvrzení, že lze vybrané číslo aktivovat.