Documentazione dell’API REST
API REST per i numeri di telefono
Individua i paesi e i numeri disponibili, esamina l’offerta completa e gestisci i numeri che possiedi.
Scegli insieme l’API e la credenziale
Gli account approvati per Sviluppatori e Automazione, Aziende e Fornitori di comunicazioni possono integrare i servizi abilitati. Uno sviluppatore individuale non deve fingere di essere un’azienda. Gli SMS/MMS delle applicazioni richiedono l’approvazione all’invio e la registrazione previste. Il servizio per Privati e famiglie non offre un’API di invio dei messaggi accessibile ai clienti.
| Famiglia di API | URL di base | Autenticazione e risultato |
|---|---|---|
| Comunicazioni v3 | https://api.multitel.net/v3 | Credenziali Basic approvate; token predisposti idonei solo per le operazioni che li supportano. JSON status e response. |
| Registrazione per le emergenze | https://api.multi.tel/emergency | Credenziali Basic approvate oppure accesso bearer predisposto in modo specifico. JSON code, message e data. |
| Integrazioni REST del portale | Host e operazione indicati nel riferimento per sviluppatori del tuo account | Usa la credenziale, gli ambiti e lo schema documentati per quell’operazione. Le richieste di sessione del browser costituiscono una superficie separata. |
Imposta MULTITEL_API_USERNAME e MULTITEL_API_PASSWORD tramite la configurazione dei segreti del tuo server prima di usare gli esempi. Non inserirli mai nel JavaScript pubblico del browser, negli URL o nel controllo del codice sorgente. Le credenziali dedicate si gestiscono nelle impostazioni di integrazione API.
Leggere il catalogo dei paesi disponibili
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"La risposta v3 contiene status e un array response. Le voci dei paesi includono isocode, name, countrycode, le informazioni sulle funzionalità e next_function. La disponibilità dipende dall’account e dall’inventario; un paese non è una promessa che ogni prefisso o tipo di numero sia in magazzino.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Dalla ricerca all’attivazione
- Scegli il paese, la suddivisione ove richiesta, l’area e il tipo di numero usando le operazioni geografiche corrispondenti.
- Leggi i prezzi di attivazione, mensili e di utilizzo del numero selezionato, i canali, la quota inclusa e i requisiti di registrazione.
- Invia i documenti richiesti dell’utente finale e controlla il loro stato. Un numero può restare in sospeso fino all’approvazione.
- Ordina una sola volta con l’esatta selezione di inventario e prezzo. Se la risposta è incerta, controlla il tuo inventario prima di inviare un altro ordine.
- Configura separatamente l’instradamento vocale e la consegna dei messaggi, quindi testa l’intero percorso previsto.
Gestire errori e nuovi tentativi
- Errore di autenticazione o di autorizzazione
- Verifica lo stato di abilitazione della credenziale API, il servizio consentito e la restrizione sull’IP di origine. Il cookie di sessione del portale non è una credenziale di integrazione.
- Credito insufficiente o approvazione mancante
- Risolvi il problema del saldo dell’account, dell’approvazione all’invio o del requisito documentale prima di ripetere l’operazione.
- Nessun risultato
- Gestisci un inventario vuoto o un nome del chiamante mancante come un esito ordinario. Non dare per scontato che un numero sintatticamente valido disponga di tutti i servizi.
- Timeout di rete o guasto del servizio
- Per le letture usa tentativi limitati con backoff. Per un acquisto, un invio o una registrazione, controlla prima lo stato dell’operazione: ripetere una richiesta già accettata può duplicare un’azione a pagamento.
Il supporto all’idempotenza dipende da ciascuna famiglia di API. L’API per le emergenze supporta chiavi di ripetizione; questo non rende idempotenti richieste v3 arbitrarie. Conserva marcature temporali, ID restituiti e risposte oscurate per l’assistenza.
Continua con il riferimento del tuo account
Il riferimento dopo l’accesso filtra le operazioni in base alle tue autorizzazioni e ai servizi abilitati. Usa l’host esatto, il tipo di credenziale, i campi della richiesta e lo schema della risposta che indica. Le console possono eseguire operazioni reali, inclusi acquisti e messaggi.