Wybierz typ na podstawie nazwy zwróconej w odpowiedzi
Użyj kraju z get_document_countries. Przekaż zwróconą nazwę typu do get_requirements. Identyfikator typu w katalogu nie jest identyfikatorem prefiksu, numeru ani kategorii dokumentu potwierdzającego.
Liczba grup nie oznacza liczby dostępnych numerów
available_groups zlicza rekordy grup zwrócone przez to zapytanie do katalogu. Nie zlicza numerów telefonicznych dostępnych do zakupu, nie rezerwuje numerów ani nie gwarantuje, że katalog uwzględnił wszystkie strony danych z systemu źródłowego. Osobno przeszukaj odpowiednią pulę dostępnych numerów i zapoznaj się z wyceną.
Żądanie
Używaj danych uwierzytelniających swojego aktywnego konta API przez HTTPS. Obsługiwane są uwierzytelnianie Basic i aktywne tokeny bearer konta API; obowiązują ograniczenia konta.
GET z dowolnym udokumentowanym parametrem w ścieżce adresu URL.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
country | string | Tak | Dwuliterowy kod ISO kraju z katalogu krajów dostępnych do rejestracji. Białe znaki na początku i końcu są usuwane, a litery zamieniane na wielkie. |
Odpowiedź
Sprawdź status.code w treści JSON oraz status HTTP. response jest tablicą zawierającą id, name i available_groups. Użyj name jako number_type przy wywoływaniu get_requirements; nie wysyłaj zamiast tego id. available_groups to liczba rekordów grup zwróconych dla danego typu, a nie liczba dostępnych numerów telefonicznych ani łączna liczba ze wszystkich stron wyników. Typy, dla których nie zwrócono żadnych grup, są pomijane. Preferowana kolejność to Local, Mobile, National, Toll Free, Shared Cost, Global, a następnie pozostałe nazwy z katalogu.
Przykładowa struktura odpowiedzi; nie przedstawia bieżących danych konta ani aktualnej wyceny.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "NUMBER_TYPE_ID_FROM_RESPONSE",
"name": "Local",
"available_groups": 3
}
]
}Błędy
- 400: country is required: podaj kod ISO kraju dostępnego do rejestracji.
- 400: Invalid country ISO or no available DID registration country found: wybierz kraj z aktualnego katalogu rejestracyjnego; nie oznacza to, że żadne dokumenty nie są wymagane.
Dostępność i skutki uboczne
- To zapytanie do katalogu lub o wymagania nie tworzy tożsamości, nie przesyła dokumentu potwierdzającego, nie rejestruje numeru ani nie składa zamówienia.
- Pomyślna odpowiedź z katalogu nie oznacza zatwierdzenia Twoich dokumentów ani potwierdzenia, że wybrany numer można aktywować.