Documentație API REST
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.
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.
Citiți catalogul de țări disponibil
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"Răspunsul v3 conține status și un tablou response. Intrările de țară includ isocode, name, countrycode, informații despre capabilități și next_function. Disponibilitatea depinde de cont și de inventar; o țară nu reprezintă o promisiune că fiecare prefix sau tip de număr este în stoc.
{
"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"
}
]
}De la descoperire la activare
- Alegeți țara, subdiviziunea unde este necesară, zona și tipul de număr utilizând operațiunile geografice corespunzătoare.
- Citiți prețurile de instalare, lunare și de utilizare ale numărului selectat, canalele, alocația și cerințele de înregistrare.
- Trimiteți documentele necesare ale utilizatorului final și verificați starea acestora. Un număr poate rămâne în așteptare până la aprobare.
- Comandați o singură dată cu selecția exactă de inventar/preț. Dacă răspunsul este incert, inspectați-vă inventarul înainte de a trimite o altă comandă.
- Configurați independent rutarea vocală și livrarea mesajelor, apoi testați ruta completă intenționată.
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.