Sviluppatori

GET/v3/get_document_number_types/{country}

Elencare i tipi di numero per la registrazione

Trova i nomi dei tipi di numero attualmente presenti nel catalogo di registrazione per un paese.

Su questa pagina
  1. Scegli un tipo in base al nome restituito
  2. Il conteggio dei gruppi non indica la disponibilità di numeri
  3. Richiesta
  4. Risposta
  5. Errori
  6. Disponibilità ed effetti collaterali

Scegli un tipo in base al nome restituito

Usa un paese restituito da get_document_countries. Passa il nome del tipo restituito a get_requirements. L'ID di un tipo nel catalogo non è l'ID di un prefisso, di un numero o di una categoria di documenti giustificativi.

Il conteggio dei gruppi non indica la disponibilità di numeri

available_groups conta i record dei gruppi restituiti da questa consultazione del catalogo. Non conta i numeri di telefono acquistabili, non riserva numeri e non garantisce che il catalogo abbia esaurito tutte le pagine della fonte a monte. Cerca separatamente tra i numeri disponibili pertinenti ed esamina un preventivo.

Richiesta

Usa le credenziali del tuo account API abilitato tramite HTTPS. Sono supportati l'autenticazione Basic e i token bearer degli account API abilitati; si applicano le restrizioni dell'account.

GET con gli eventuali parametri documentati nel percorso dell'URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Parametri del percorso
NomeTipoObbligatorioDescrizione
countrystringSìCodice ISO del paese di due lettere, tratto dal catalogo dei paesi disponibili per la registrazione. Gli spazi iniziali e finali vengono rimossi e il codice viene convertito in maiuscolo.

Risposta

Controlla status.code nel corpo JSON oltre allo stato HTTP. response è un array contenente id, name e available_groups. Usa name come number_type quando chiami get_requirements; non inviare id al suo posto. available_groups è il numero di record dei gruppi restituiti per quel tipo, non il conteggio dei numeri telefonici disponibili né il totale completo di tutte le pagine. I tipi per cui non vengono restituiti gruppi sono omessi. L'ordine preferito è Local, Mobile, National, Toll Free, Shared Cost, Global, seguiti dagli altri nomi del catalogo.

Struttura della risposta a scopo illustrativo; non si tratta di dati dell'account in tempo reale né di un preventivo attuale.

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

Errori

  • 400: country is required: fornisci il codice ISO del paese di registrazione.
  • 400: Invalid country ISO or no available DID registration country found: seleziona un paese dal catalogo di registrazione attuale; questo non dimostra che non siano richiesti documenti.

Disponibilità ed effetti collaterali

  • Questa consultazione del catalogo e dei requisiti non crea un'identità, non carica un documento giustificativo, non registra un numero e non effettua un ordine.
  • Una risposta del catalogo con esito positivo non costituisce un'approvazione dei tuoi documenti né una conferma che un numero selezionato possa essere attivato.