Pobieranie wymagań rejestracyjnych

Wybierz kraj i typ numeru

Wybierz kraj rejestracji, a następnie użyj nazwy zwróconej przez get_document_number_types. Prześlij tę nazwę jako number_type, a nie identyfikator typu ani ogólną kategorię wyszukiwania numerów.

Przeczytaj zwrócone instrukcje

Zachowaj identyfikatory wymagań i relacji na potrzeby odpowiedniego procesu obsługi tożsamości lub dokumentów. To wywołanie zwraca wymagania; nie sprawdza poprawności plików ani ich nie przesyła. Postępuj zgodnie ze zwróconymi instrukcjami oraz wszelkimi wymaganiami dotyczącymi wybranego numeru.

Nie traktuj błędu jako zwolnienia z obowiązku rejestracji

Komunikat błędu dotyczący nieprawidłowego kraju lub braku wymaganych dokumentów rejestracyjnych dla kraju łączy dwa warunki. Nie dowodzi, że rejestracja jest zbędna. Nieudane wyszukiwanie ani pusty wynik również nie oznaczają zatwierdzenia klienta lub numeru. Jeśli wynik jest niejasny, skontaktuj się z pomocą techniczną.

Żądanie

Użyj danych uwierzytelniających aktywowanego konta API przez HTTPS. Obsługiwane są uwierzytelnianie podstawowe HTTP oraz aktywowane tokeny okaziciela dla kont API; obowiązują ograniczenia konta.

POST z application/json lub 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 treści żądania
Nazwa	Typ	Wymagany	Opis
`country`	ciąg znaków	Tak	Kod ISO kraju z get_document_countries.
`number_type`	ciąg znaków	Tak	Nazwa typu z get_document_number_types, na przykład Local; dopasowanie nie uwzględnia wielkości liter. Podaj nazwę, a nie jej identyfikator.

Odpowiedź

Sprawdź zarówno status.code w treści JSON, jak i status HTTP. response to pojedynczy zasób wymagań zawierający id, type i attributes, a także relationships, jeśli zostaną zwrócone. Identyfikatory w danych zasobu i relacji są nieprzezroczyste i nie należy interpretować ich struktury. Z opcjonalnego tekstu restriction_message usuwane są znaczniki HTML; pozostałą zawartość traktuj jako tekst, a nie zaufany kod HTML. Procedura obsługi zwraca pierwszy zasób wymagań, więc nie zakładaj, że odpowiedź stanowi wyczerpującą listę. Dostępność atrybutów i relacji zależy od kraju i typu; przykład nie stanowi kompletnego, stałego schematu.

Przykładowa struktura odpowiedzi; nie są to bieżące dane konta ani aktualna wycena.

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

Błędy

400: Walidacja kraju i number_type nie powiodła się: podaj obie wymagane wartości. Tekst walidacji może zawierać formatowanie.
400: Invalid country ISO or No country registration documents required.: ten niejednoznaczny komunikat sam w sobie nie dowodzi zwolnienia z obowiązku rejestracji.
400: Invalid number type: użyj zwróconej nazwy typu. Starszy komunikat błędu wymienia Global, Local, Mobile, National, Shared Cost i Toll Free.
500: Unable to load registration requirements for the specified country and number type.: nie udało się zwrócić wymagań. Spróbuj ponownie później lub skontaktuj się z pomocą techniczną.

Dostępność i skutki uboczne

To wyszukiwanie w katalogu lub pobieranie wymagań nie tworzy tożsamości, nie przesyła dokumentu potwierdzającego, nie rejestruje numeru ani nie składa zamówienia.
Pomyślna odpowiedź katalogu nie oznacza zatwierdzenia dokumentów ani potwierdzenia, że wybrany numer można aktywować.