Zobrazení požadavků na registraci

Vyberte zemi a typ čísla

Vyberte zemi registrace a poté použijte název vrácený funkcí get_document_number_types. Tento název odešlete jako number_type, nikoli ID typu nebo obecnou kategorii pro vyhledávání čísel.

Přečtěte si vrácené pokyny

Uchovejte ID požadavků a vztahů pro příslušný pracovní postup týkající se identity a dokumentů. Toto volání vrací požadavky; neověřuje ani neodesílá vaše soubory. Řiďte se vrácenými pokyny a veškerými požadavky specifickými pro vybrané číslo.

Nepovažujte chybu za výjimku z povinnosti registrace

Chyba týkající se neplatné země nebo nevyžadovaných registračních dokumentů pro danou zemi spojuje dvě podmínky. Není důkazem, že registrace není nutná. Ani selhání vyhledávání nebo prázdný výsledek neznamená schválení zákazníka či čísla. Pokud je výsledek nejasný, obraťte se na podporu.

Požadavek

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

POST s application/json nebo application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Parametry těla požadavku
Název	Typ	Povinné	Popis
`country`	řetězec	Ano	Kód země podle ISO z get_document_countries.
`number_type`	řetězec	Ano	Název typu z get_document_number_types, například Local; při porovnávání se nerozlišují velká a malá písmena. Zadejte název, nikoli jeho ID.

Odpověď

Zkontrolujte status.code v těle JSON i stav HTTP. response je jediný zdroj požadavků s poli id, type a attributes a také s polem relationships, pokud je vráceno. ID ve zdroji a v datech vztahů jsou neprůhledné identifikátory. Z volitelného textu restriction_message jsou odstraněny značky HTML; se zbývajícím obsahem zacházejte jako s textem, nikoli jako s důvěryhodným HTML. Obslužný kód vrací první zdroj požadavků, proto z této odpovědi nevyvozujte, že jde o úplný seznam. Dostupnost atributů a vztahů závisí na zemi a typu; příklad nepředstavuje úplné pevně dané schéma.

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Chyby

400: Ověření země a number_type se nezdařilo: zadejte obě povinné hodnoty. Text ověření může obsahovat formátování.
400: Invalid country ISO or No country registration documents required.: tato nejednoznačná zpráva sama o sobě nedokazuje výjimku z povinnosti registrace.
400: Invalid number type: použijte vrácený název typu. Starší chybová zpráva uvádí Global, Local, Mobile, National, Shared Cost a Toll Free.
500: Unable to load registration requirements for the specified country and number type.: požadavky se nepodařilo úspěšně vrátit. Zkuste to znovu později nebo se obraťte na podporu.

Dostupnost a vedlejší účinky

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