Accesso all'account e al progetto
Utilizzare un account API abilitato tramite HTTPS da un indirizzo IP consentito. Il progetto deve appartenere a tale account e non deve essere stato eliminato. Utilizzare l'identificativo univoco del progetto ottenuto dal flusso di ordinazione della portabilità, non il suo identificativo numerico nel database né un numero di telefono. Applicare la codifica URL all'identificativo del progetto quando si costruisce una richiesta.
Richiesta
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"Questo endpoint non legge alcun corpo della richiesta, parametro di paginazione o filtro per data.
Risposta
Esempio di risposta fittizio.
{
"status": {
"code": 200,
"msg": "Project Status"
},
"response": {
"uniqueid": "PROJECT_EXAMPLE",
"status": 2,
"status_str": "Completed",
"counts": {
"total": 2,
"pending": 0,
"in_progress": 0,
"completed": 1,
"rejected": 1
}
}
}Il campo esterno status.code riporta l'esito dell'API. Il campo distinto response.status è il riepilogo della portabilità derivato dai dati del progetto. Non confondere i due campi.
Un riepilogo non è un esito valido per tutti i numeri
Il riepilogo seleziona In Progress se almeno un numero presenta tale stato; altrimenti seleziona, in ordine di priorità, Pending, Completed o Rejected. Se non trova alcuno stato noto corrispondente, assume il valore predefinito Pending. Un progetto che contiene sia numeri con portabilità completata sia numeri rifiutati riporta quindi Completed, pur contenendo ancora numeri rifiutati.
Controllare sempre i conteggi e l'elenco dei singoli numeri prima di considerare concluso l'intero progetto. counts.total include tutte le righe relative ai numeri del progetto; gli altri contatori riguardano soltanto i quattro valori di stato noti e la loro somma potrebbe non coincidere con il totale quando sono presenti altri valori. Un progetto senza numeri riporta contatori pari a zero e un riepilogo con stato Pending.
Interpretare lo stato della portabilità
| Valore | Etichetta |
|---|---|
| 0 | Pending |
| 1 | In Progress |
| 2 | Completed |
| 9 | Rejected |
Conservare lo stato numerico e gestire anche i valori sconosciuti. Per le etichette sconosciute viene restituito il valore memorizzato, senza garantire una nuova etichetta. Uno stato di completamento memorizzato o una data pianificata non costituiscono, di per sé, una verifica dell'instradamento in entrata o di tutti i servizi associati al numero.
Errori e limiti
Controllare sia la risposta HTTP sia status.code/status.msg. Un progetto inesistente, eliminato o non appartenente all'account restituisce il codice API 404 con un messaggio che indica che il progetto non è stato trovato. Si applicano anche l'autenticazione e le restrizioni sull'indirizzo IP di origine. Gli esempi non eseguono una richiesta reale e una risposta riuscita non dimostra che un operatore abbia accettato o completato un trasferimento.
Effetti
Questo endpoint legge i conteggi memorizzati del progetto. Nel gestore esaminato non invia richieste di trasferimento, non modifica stati, non avvia chiamate e non addebita importi all'account. Non offre interrogazioni periodiche dell'operatore in tempo reale né sottoscrizioni a webhook.