Documentație API REST
Faceți prima cerere către API-ul MultiTEL
Începeți cu o cerere doar în citire, înțelegeți răspunsul, apoi alegeți referința pentru serviciul pe care doriți să îl construiți.
Alegeți împreună API-ul și credențialul
Conturile aprobate pentru Dezvoltatori și automatizare, Companii și Furnizori de comunicații pot integra serviciile activate. Un dezvoltator individual nu trebuie să pretindă că este o companie. SMS/MMS trimise de aplicații necesită aprobarea de trimitere și înregistrarea aplicabile. Serviciul pentru Persoane fizice și familii nu are un API de inițiere a mesajelor accesibil clienților.
| Familia API | URL de bază | Autentificare și rezultat |
|---|---|---|
| Comunicații v3 | https://api.multitel.net/v3 | Credențiale Basic aprobate; tokenuri provisionate eligibile numai pentru operațiunile care le acceptă. JSON status și response. |
| Înregistrare de urgență | https://api.multi.tel/emergency | Credențiale Basic aprobate sau acces bearer provisionat în mod specific. JSON code, message și data. |
| Integrări REST din portal | Gazda și operațiunea sunt afișate în referința pentru dezvoltatori a contului dumneavoastră | Utilizați credențialele, domeniile de acces și schema documentate pentru acea operațiune. Cererile din sesiunea browserului reprezintă un canal de acces separat. |
Setați MULTITEL_API_USERNAME și MULTITEL_API_PASSWORD prin configurația de secrete a serverului dumneavoastră înainte de a utiliza exemplele. Nu le încorporați niciodată în cod JavaScript public din browser, în URL-uri sau în controlul sursei. Credențialele dedicate sunt gestionate în setările de integrare API.
Prima cerere: citiți-vă soldul
Această citire nu achiziționează un serviciu și nu inițiază un apel sau un mesaj.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API-ul de comunicații v3 returnează un rezultat al aplicației în interiorul corpului JSON. Verificați starea HTTP și status.code înainte de a citi response; o cerere respinsă poate să nu aibă un obiect de răspuns. Valorile de cod pot fi șiruri de caractere sau numere.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Acesta este un exemplu fictiv, nu un sold de cont. Tratați valorile monetare ca sume zecimale. Păstrați mesajul de răspuns al serverului atunci când diagnosticați o cerere respinsă, cu datele de autentificare eliminate.
Utilizați corect datele de facturare
Răspunsul privind soldul conține soldul curent, moneda și condițiile de plată. Nu oferă costul unui apel viitor sau o factură completă. Utilizați operațiunile corespunzătoare de tarife și utilizare pentru aceste întrebări. Numerele existente pot avea planuri diferite față de catalogul actual.
Alegeți următoarea integrare
API REST pentru interogarea rutării LRN
Aflați numărul de rutare și informațiile disponibile despre operator pentru un număr de telefon nord-american, la un preț fix.
Citiți ghidul de integrare →API-uri REST pentru numere de telefon
Descoperiți țările și numerele disponibile, examinați oferta completă și gestionați numerele pe care le dețineți.
Citiți ghidul de integrare →API-uri REST pentru SMS și MMS
Trimiteți mesaje aprobate ale aplicației și gestionați acceptarea, evenimentele de livrare, segmentarea și taxele.
Citiți ghidul de integrare →API-uri REST pentru apeluri de urgență
Înregistrați un număr și o adresă de serviciu, urmăriți starea activării și mențineți înregistrarea la zi pe măsură ce locația se schimbă.
Citiți ghidul de integrare →API-uri REST pentru cont și facturare
Citiți soldul și informațiile de facturare disponibile pentru integrarea dvs. aprobată.
Citiți ghidul de integrare →Interogări CNAM și de rutare
Citiți numele apelanților, înțelegeți nivelurile de interogare și folosiți informațiile de rutare a numerelor.
Referință CNAM REST →PBX găzduit
Începeți cu planurile de servicii disponibile și cu tenantul pe care intenționați să îl configurați.
API pentru planurile de servicii PBX găzduit →Gestionați erorile și reîncercările
- Eșec de autentificare sau de permisiune
- Verificați starea de activare a credențialului API, serviciul permis și restricția de IP sursă. Un cookie de sesiune din portal nu este un credențial de integrare.
- Credit insuficient sau aprobare lipsă
- Rezolvați soldul contului, aprobarea de trimitere sau cerința privind documentele înainte de a repeta operațiunea.
- Niciun rezultat
- Tratați inventarul gol sau lipsa numelui apelantului ca pe un rezultat obișnuit. Nu presupuneți că un număr valid din punct de vedere sintactic beneficiază de toate serviciile.
- Timeout de rețea sau defecțiune a serviciului
- Folosiți reîncercări limitate cu backoff pentru citiri. Pentru o achiziție, trimitere sau înregistrare, inspectați mai întâi starea operațiunii; reîncercarea unei cereri acceptate poate duplica o acțiune facturabilă.
Suportul pentru idempotență aparține fiecărei familii de API. API-ul pentru urgențe acceptă chei de reîncercare; acest lucru nu face ca cererile v3 arbitrare să fie idempotente. Păstrați marcajele de timp, ID-urile returnate și răspunsurile cu datele sensibile eliminate pentru asistență.
Continuați cu referința contului dvs.
Referința accesibilă după autentificare filtrează operațiunile în funcție de permisiunile și serviciile activate ale contului dvs. Folosiți gazda exactă, tipul de credențiale, câmpurile cererii și schema răspunsului indicate acolo. Consolele pot executa operațiuni reale, inclusiv achiziții și mesaje.