Sviluppatori

POST/v3/directory/{number}

Inviare un'iscrizione nell'elenco telefonico

Invia un'iscrizione autorizzata all'operatore, comprendi l'addebito previsto dall'implementazione e chiarisci gli esiti incerti prima di riprovare.

Su questa pagina
  1. Inviare un'iscrizione nell'elenco dell'operatore
  2. Requisiti dell'account e del numero
  3. Richiesta POST con dati di modulo
  4. Addebiti e comportamento in caso di nuovi tentativi
  5. Risposta
  6. Errori del sistema precedente
  7. Verifica prima di riprovare

Inviare un'iscrizione nell'elenco dell'operatore

Invia il nome e l'indirizzo da utilizzare per l'iscrizione nell'elenco di un numero telefonico idoneo di tua proprietà in MultiTEL. Si tratta di un aggiornamento a pagamento presso l'operatore, non di una ricerca del nome del chiamante, di una voce in una rubrica privata o di un aggiornamento generale del campo LIDB nell'inventario del portale.

Invia esclusivamente i dati che il cliente ha autorizzato per l'iscrizione nell'elenco. Prima di utilizzare questa rotta del sistema precedente, verifica che l'operatore supporti il numero. Il gestore esaminato non verifica l'idoneità del fornitore né il formato internazionale del numero; la richiesta inviata all'operatore presuppone un numero nordamericano e rimuove la prima cifra memorizzata.

Requisiti dell'account e del numero

Utilizza un account API abilitato tramite HTTPS, da un indirizzo IP di origine consentito. Il numero esatto deve corrispondere a una riga non annullata dei numeri acquistati appartenente a tale account. Utilizza tutte le cifre del numero internazionale presenti nel tuo inventario, ad esempio il formato con prefisso internazionale 1 per un numero nordamericano supportato. Non utilizzare l'identificativo di un piano tariffario, l’identificativo UUID di un numero o un numero appartenente a un altro account.

Richiesta POST con dati di modulo

Imposta NUMBER sul numero di tua proprietà. Sostituisci l'esempio fittizio con le informazioni autorizzate per l'iscrizione. Questa rotta legge i campi del modulo da POST; non analizza un corpo application/json.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode "lastname=EXAMPLE" \
  --data-urlencode "firstname=EXAMPLE" \
  --data-urlencode "streetnum=1" \
  --data-urlencode "streetname=Example" \
  --data-urlencode "streetpredir=N" \
  --data-urlencode "streetpostdir=W" \
  --data-urlencode "city=Example City" \
  --data-urlencode "state=NY" \
  --data-urlencode "postalcode=10001" \
  "https://api.multitel.net/v3/directory/$NUMBER"
Campi del modulo di iscrizione nell'elenco
CampoObbligatorio per questa APISignificato
lastnameSìCognome da inserire nell'elenco o campo del nome dell'iscrizione applicabile.
citySìCittà dell'iscrizione.
postalcodeSìCodice postale dell'iscrizione.
stateSìStato o regione dell'iscrizione accettati dall'operatore supportato.
streetnameSìNome della via.
streetnumSìNumero civico.
firstnameNoComponente aggiuntivo del nome proprio.
streetpredir, streetpostdirNoIndicazioni di direzione prima e dopo il nome della via, ove applicabili.
streettype, locationNoTipo di strada o testo aggiuntivo relativo all'ubicazione, ove applicabili.

Le indicazioni di direzione e l'indirizzo dell'esempio sono segnaposto, non un indirizzo postale consigliato. Non aggiungere un'indicazione di direzione fittizia ai dati reali del cliente. I controlli dei campi obbligatori dell’API sono superficiali: non attestano che un indirizzo sia valido o accettato dall'operatore; inoltre, il sito web precedente applicava requisiti diversi per il modulo.

L'implementazione può generare un avviso di chiave di array mancante quando un'indicazione di direzione facoltativa è assente o vuota. Se la risposta non è correttamente formata o l'operatore rifiuta l'indirizzo, conserva il riferimento della richiesta e chiedi all'assistenza di confermare l'iscrizione, anziché inviare ripetutamente varianti ipotetiche dell'indirizzo.

Addebiti e comportamento in caso di nuovi tentativi

Il gestore esaminato verifica la disponibilità di almeno 10.00 unità di saldo prima di contattare l'operatore. Dopo che sia l'operatore sia l'aggiornamento locale del numero hanno segnalato un esito positivo, detrae 10.00 dal saldo dell'account e registra una transazione di attivazione dell'iscrizione nell'elenco. Questi sono gli importi attualmente previsti dall'implementazione, non una nuova proposta tariffaria; prima dell'invio, verifica la valuta di fatturazione applicabile e il servizio supportato nelle condizioni del tuo account.

L'operazione non dispone di una chiave di idempotenza, di una protezione dagli ordini duplicati o di una transazione che comprenda l'invio all'operatore, l'aggiornamento locale e l'addebito. Una richiesta ripetuta che va a buon fine può causare un ulteriore invio all'operatore e un ulteriore addebito. Un timeout o un errore dell’API non dimostrano che l'operatore abbia rifiutato la richiesta precedente: il fornitore potrebbe averla accettata prima che un aggiornamento locale fallisse.

Risposta

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": ""
}

Nella normale risposta di esito positivo, una stringa vuota è il valore di response e non vengono restituiti né un identificativo dell'iscrizione né dettagli sul completamento. Ciò significa che i percorsi dell'operatore e dell'aggiornamento locale hanno segnalato un esito positivo; non dimostra la pubblicazione in tutti gli elenchi esterni, la propagazione immediata o la futura visualizzazione dell'identificativo del chiamante.

Errori del sistema precedente

Codici di risultato dell’API per l'iscrizione nell'elenco
Codice APISignificato
404Il numero non è stato trovato nell'account oppure uno dei campi obbligatori del modulo era vuoto.
400Il saldo dell'account è inferiore all'addebito previsto dall'implementazione.
500La richiesta all'operatore è fallita oppure l'aggiornamento locale è fallito quando l'operatore potrebbe aver già accettato la richiesta.
200Esito positivo segnalato; la risposta non contiene alcuna conferma di pubblicazione.

Leggi sia lo stato HTTP sia i campi del JSON status.code/status.msg. Anche l'autenticazione e le restrizioni sull'IP di origine possono impedire di ottenere una risposta utilizzabile. Non utilizzare GET o parametri di query per richiedere un aggiornamento solo perché il gestore del sistema precedente non prevede un controllo esplicito del metodo HTTP.

Verifica prima di riprovare

  1. Prima di inviare la richiesta, conferma il numero di tua proprietà, l'idoneità dell'operatore, i dati autorizzati per l'iscrizione e l'addebito.
  2. Invia una sola volta e conserva l'esito disponibile nell'account senza esporre l'indirizzo del cliente in registri pubblici o sistemi di analisi.
  3. Controlla l'iscrizione salvata e la cronologia delle transazioni tramite la procedura supportata dell'account o l'assistenza. Attendi il tempo di elaborazione confermato dall'operatore; questa API non stabilisce alcun termine garantito per la propagazione.
  4. Quando l'esito è incerto, chiedi all'assistenza di riconciliare l'ordine presso l'operatore e gli addebiti locali prima di riprovare. Una richiesta ripetuta non è una verifica di stato idempotente.