Consultare i requisiti di registrazione

Selezionare il paese e il tipo di numero

Scegliere un paese di registrazione, quindi utilizzare un nome restituito da get_document_number_types. Inviare tale nome come number_type, non un ID di tipo né una categoria generica per la ricerca di numeri.

Leggere le istruzioni restituite

Conservare gli ID dei requisiti e delle relazioni per il relativo flusso di gestione dell’identità e dei documenti. Questa chiamata restituisce i requisiti; non convalida né invia i file. Seguire le istruzioni restituite e gli eventuali requisiti specifici del numero selezionato.

Non interpretare un errore come un’esenzione

L’errore relativo a un paese non valido o all’assenza di documenti di registrazione richiesti per il paese combina due condizioni. Non dimostra che la registrazione non sia necessaria. Anche una ricerca non riuscita o un risultato vuoto non costituiscono un’approvazione del cliente o del numero. Contattare l’assistenza se il risultato non è chiaro.

Richiesta

Utilizzare le credenziali dell’account API abilitato tramite HTTPS. Sono supportati l’autenticazione di base e i token bearer abilitati per l’account API; si applicano le restrizioni dell’account.

POST con application/json o 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"

Risposta

Controllare status.code nel corpo JSON oltre allo stato HTTP. response è una singola risorsa di requisiti con id, type e attributes, oltre a relationships quando restituito. Gli ID nella risorsa e nei dati delle relazioni sono opachi. Dal testo facoltativo di restriction_message vengono rimossi i tag HTML; trattare il contenuto rimanente come testo, non come HTML attendibile. Il gestore restituisce la prima risorsa di requisiti, quindi non dedurre che questa risposta sia un elenco esaustivo. La disponibilità di attributi e relazioni dipende dal paese e dal tipo; l’esempio non rappresenta uno schema completo e fisso.

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

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

Errori

• 400: convalida del paese e di number_type non riuscita: fornire entrambi i valori obbligatori. Il testo di convalida può contenere formattazione.
• 400: Invalid country ISO or No country registration documents required.: questo messaggio ambiguo non dimostra di per sé un’esenzione dalla registrazione.
• 400: Invalid number type: utilizzare un nome di tipo restituito. L’errore della versione precedente elenca Global, Local, Mobile, National, Shared Cost e Toll Free.
• 500: Unable to load registration requirements for the specified country and number type.: i requisiti non sono stati restituiti correttamente. Riprovare più tardi o contattare l’assistenza.

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 documenti né una conferma che un numero selezionato possa essere attivato.