Documentazione dell’API REST
Effettua la tua prima richiesta API a MultiTEL
Inizia con una richiesta di sola lettura, comprendi la risposta, poi scegli il riferimento per il servizio che vuoi sviluppare.
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.
Prima richiesta: leggere il saldo
Questa lettura non acquista un servizio né origina una chiamata o un messaggio.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"L’API comunicazioni v3 restituisce il risultato applicativo all’interno del corpo JSON. Controlla lo stato HTTP e status.code prima di leggere response; una richiesta rifiutata potrebbe non avere alcun oggetto di risposta. I valori dei codici possono essere stringhe o numeri.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Questo è un esempio fittizio, non il saldo di un account. Tratta i valori monetari come importi decimali. Quando diagnostichi una richiesta rifiutata, conserva il messaggio di risposta del server, rimuovendo le credenziali.
Usare correttamente i dati di fatturazione
La risposta sul saldo contiene il saldo corrente, la valuta e le condizioni di pagamento. Non indica il costo di una chiamata futura né una fattura completa. Per queste esigenze usa le operazioni corrispondenti su tariffe e utilizzo. I numeri esistenti possono avere piani diversi da quelli del catalogo attuale.
Scegli la tua prossima integrazione
API REST di ricerca dell’instradamento LRN
Cerca il numero di instradamento e le informazioni disponibili sull’operatore per un numero di telefono nordamericano a un prezzo fisso.
Leggi la guida all’integrazione →API REST per i numeri di telefono
Individua i paesi e i numeri disponibili, esamina l’offerta completa e gestisci i numeri che possiedi.
Leggi la guida all’integrazione →API REST per SMS e MMS
Invia messaggi applicativi approvati e gestisci accettazione, eventi di consegna, segmentazione e addebiti.
Leggi la guida all’integrazione →API REST per le chiamate di emergenza
Registra un numero e un indirizzo di servizio, segui lo stato di attivazione e mantieni aggiornato il record quando cambia la posizione.
Leggi la guida all’integrazione →API REST per account e fatturazione
Leggi il saldo e le informazioni di fatturazione disponibili per la tua integrazione approvata.
Leggi la guida all’integrazione →Ricerche CNAM e di instradamento
Leggi i nomi dei chiamanti, comprendi i livelli di ricerca e usa le informazioni di instradamento dei numeri.
Riferimento REST CNAM →PBX ospitato
Inizia dai piani di servizio disponibili e dal tenant che intendi configurare.
API dei piani di servizio PBX ospitato →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.