Seznam předvoleb pro oblast

Než začnete

Vyberte oblast pomocí getareas. Zkopírujte ID oblasti z odpovědi nebo z vrácené hodnoty next_function. Pro oblast v USA nebo Kanadě použijte getstates v případě, že chcete výsledky omezit na jeden stát nebo provincii.

Jak číst výsledek

Zkontrolujte status.code v těle JSON i stav HTTP. Výsledky úspěšného požadavku jsou v poli response. Ve výchozím nastavení je odpověď seřazena podle názvu. Hodnota available je odhad a katalogové příznaky nenahrazují ověření skutečných možností vybraného čísla a požadavků na registraci.

Vyberte další krok

Použijte neseskupený výsledek. Pokud má returns_numbers hodnotu 1, vrácená hodnota next_function odkazuje na vyhledávání čísel. Pokud je hodnota 0, čísla se přidělují při objednání a cesta odkazuje na operaci objednání. Před odesláním požadavku si prostudujte operaci a její požadavky: požadavek na objednání může vést ke stržení částky z vašeho účtu. Neodesílejte automaticky požadavky na všechny vrácené cesty.

Cena zde není uvedena. Před nákupem si prostudujte příslušnou cenovou nabídku, požadované dokumenty a pokyny k objednání. Uchovejte vrácená ID jednotlivých předvoleb a cenových nabídek místo toho, abyste je sestavovali ze zobrazené telefonní předvolby.

Pokročilé možnosti zobrazení

compact=1 vrací náhodně seřazený vzorek nejvýše 100 řádků, nikoli stránku z větší sady výsledků. Seskupování vytváří souhrnné řádky a syntetická ID; k výběru jednotlivé předvolby použijte běžnou neseskupenou odpověď. Na základě vzorkovaných nebo seskupených výsledků netvrďte, že nabídka je úplná nebo že možnosti jsou přesně ověřené.

Požadavek

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

Použijte GET a volitelné parametry odešlete v řetězci dotazu. Nespoléhejte na náhradní načítání parametrů z formulářového těla požadavku.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Odpověď

Standardní obálka JSON s položkami status/response. status.results udává počet vrácených řádků, a to i při vzorkování nebo seskupování. response obsahuje objekty předvoleb. Žádná pole s cenami se nevracejí. V běžné neseskupené odpovědi je uuid ID předvolby; area_uuid a country_uuid jsou vrácené identifikátory; prefix a name jsou informace určené k zobrazení; available je odhad dostupnosti, nikoli rezervace; needs_registration a restrictions popisují informace o registraci; sms_coverage, is_mobile a number_type jsou orientační katalogové údaje, nikoli záruka konkrétní funkce čísla. number_type může být prázdné nebo obsahovat jiný katalogový řetězec, proto nevyžadujte pevný výčet hodnot. state je řetězec a může být prázdný nebo obsahovat katalogové formátování. latitude a longitude mohou být prázdné. metered a overflow jsou katalogové příznaky, nikoli peněžní částky. returns_numbers vybírá cestu k výpisu čísel (1) nebo cestu k přidělení čísla při objednání (0). next_function označuje tuto další cestu. Seskupené odpovědi navíc obsahují sloučené vlastnosti včetně náhradních hodnot vlastností; nepovažujte je za ověřené možnosti každého čísla.

Ilustrační podoba odpovědi; nejde o živá data účtu ani aktuální cenovou nabídku.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Chyby

• 404: Invalid area ID: získejte aktuální ID oblasti při procházení nabídky.
• 404: State filter is only available for US and CA: pro ostatní země vynechte state.
• 404: Invalid state: použijte stát či provincii vrácené funkcí getstates pro tuto zemi.
• 404: No prefixes found: nebyly vráceny žádné odpovídající řádky katalogu. To nedokazuje, že určité číslo nebude nikdy možné objednat.
• 500: Chyba: 'Failed loading prefixes': vyhledávání v katalogu selhalo. Zkuste to znovu později a pokud problém přetrvává, kontaktujte podporu.

Dostupnost a vedlejší účinky

• Jde o krok při procházení nabídky, nikoli o potvrzení objednávky. Dostupnost se může aktualizovat pomocí dalších vyhledávání v katalogu, takže doba odezvy se může lišit.
• Ceny se nevracejí. Před zadáním objednávky si vyžádejte příslušnou cenovou nabídku pro číslo nebo objednávku a prostudujte si požadavky na registraci.
• Nepovažujte available za přesný počet dostupných čísel, nulu za všeobecný zákaz objednání ani úspěšné vyhledání za rezervaci. Dostupnost se může před objednáním změnit.