REST API dokumentacija
Pateikite pirmąją MultiTEL API užklausą
Pradėkite nuo tik skaitymo užklausos, supraskite atsakymą, tada pasirinkite žinyną paslaugai, kurią norite kurti.
Kartu pasirinkite API ir prisijungimo duomenis
Patvirtintos kūrėjų ir automatizavimo, verslo bei ryšių paslaugų teikėjų paskyros gali integruoti įjungtas paslaugas. Individualiam kūrėjui nereikia apsimesti įmone. Programų SMS/MMS siuntimui reikia atitinkamo siuntimo patvirtinimo ir registracijos. Asmeninių ir šeimos poreikių paslauga neturi klientui prieinamos žinučių siuntimo inicijavimo API.
| API šeima | Bazinis URL | Autentifikavimas ir rezultatas |
|---|---|---|
| Ryšių v3 | https://api.multitel.net/v3 | Patvirtinti Basic prisijungimo duomenys; tinkami suteikti prieigos raktai naudojami tik juos palaikančioms operacijoms. JSON status ir response. |
| Registracija skambinimui pagalbos tarnyboms | https://api.multi.tel/emergency | Patvirtinti Basic prisijungimo duomenys arba specialiai suteikta bearer prieiga. JSON code, message ir data. |
| Portalo REST integracijos | Serveris ir operacija nurodyti jūsų paskyros kūrėjų žinyne | Naudokite tos operacijos dokumentacijoje nurodytus prisijungimo duomenis, prieigos apimtis ir schemą. Naršyklės sesijos užklausos yra atskiras prieigos būdas. |
Prieš naudodami pavyzdžius, nustatykite MULTITEL_API_USERNAME ir MULTITEL_API_PASSWORD serverio paslapčių konfigūracijoje. Niekada jų neįtraukite į viešą naršyklės JavaScript kodą, URL adresus ar versijų valdymo sistemą. Specialūs prisijungimo duomenys valdomi skiltyje API integravimo nustatymai.
Pirmoji užklausa: perskaitykite likutį
Ši skaitymo operacija neperka paslaugos ir neinicijuoja skambučio ar žinutės.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Ryšių v3 API grąžina programos rezultatą JSON atsakymo turinyje. Prieš skaitydami response, patikrinkite HTTP būseną ir status.code; atmetus užklausą, atsakymo objekto gali nebūti. Kodų reikšmės gali būti eilutės arba skaičiai.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Tai išgalvotas pavyzdys, o ne paskyros likutis. Pinigines reikšmes tvarkykite kaip dešimtaines sumas. Nagrinėdami atmestą užklausą, išsaugokite serverio atsakymo pranešimą, pašalinę prisijungimo duomenis.
Tinkamai naudokite atsiskaitymo duomenis
Likučio atsakyme pateikiamas dabartinis likutis, valiuta ir mokėjimo sąlygos. Jame nėra būsimo skambučio kainos ar visos sąskaitos faktūros. Tam naudokite atitinkamas tarifų ir naudojimo operacijas. Esamiems numeriams gali būti taikomi kitokie planai nei dabartiniame kataloge.
Pasirinkite kitą integraciją
LRN maršrutizavimo užklausų REST API
Gaukite Šiaurės Amerikos telefono numerio maršrutizavimo numerį ir galimą operatoriaus informaciją už fiksuotą kainą.
Skaitykite integravimo vadovą →Telefono numerių REST API
Raskite galimas šalis ir numerius, peržiūrėkite visą pasiūlymą ir valdykite jums priklausančius numerius.
Skaitykite integravimo vadovą →SMS ir MMS REST API
Siųskite patvirtintas programų žinutes ir tvarkykite priėmimą, pristatymo įvykius, segmentavimą ir mokesčius.
Skaitykite integravimo vadovą →Skambinimo pagalbos tarnyboms REST API
Užregistruokite numerį ir paslaugos adresą, stebėkite jo aktyvavimo būseną ir atnaujinkite įrašą keičiantis vietai.
Skaitykite integravimo vadovą →Paskyros ir atsiskaitymo REST API
Skaitykite likutį ir atsiskaitymo informaciją, prieinamą jūsų patvirtintai integracijai.
Skaitykite integravimo vadovą →CNAM ir maršrutizavimo užklausos
Skaitykite skambintojo vardus, supraskite užklausų lygius ir naudokite numerių maršrutizavimo informaciją.
CNAM REST žinynas →Talpinama PBX
Pradėkite nuo prieinamų paslaugų planų ir PBX aplinkos (tenant), kurią ketinate konfigūruoti.
Talpinamos PBX paslaugų planų API →Klaidų tvarkymas ir pakartotiniai bandymai
- Autentifikavimo arba leidimų klaida
- Patikrinkite, ar API prisijungimo duomenys aktyvūs, kokia paslauga leidžiama ir koks taikomas šaltinio IP apribojimas. Portalo sesijos slapukas nėra integracijai skirti prisijungimo duomenys.
- Nepakankamas likutis arba trūkstamas patvirtinimas
- Prieš kartodami operaciją, išspręskite paskyros likučio, siuntimo patvirtinimo ar reikalaujamo dokumento klausimą.
- Rezultato nėra
- Tuščią numerių pasiūlą arba nerastą skambintojo vardą laikykite įprastu rezultatu. Nemanykite, kad taisyklingo formato numeriui prieinamos visos paslaugos.
- Tinklo laukimo laikas baigėsi arba paslauga sutriko
- Skaitymo užklausoms taikykite ribotą pakartojimų skaičių su didinamais laukimo tarpais. Pirkdami, siųsdami ar registruodami pirmiausia patikrinkite operacijos būseną; pakartojus jau priimtą užklausą, apmokestinamas veiksmas gali būti atliktas dar kartą.
Idempotentiškumo palaikymas priklauso nuo API šeimos. Pagalbos tarnybų API palaiko pakartojimo raktus; tai nereiškia, kad bet kokia v3 užklausa yra idempotentiška. Pagalbai išsaugokite laiko žymas, grąžintus identifikatorius ir atsakymus su pašalintais neskelbtinais duomenimis.
Tęskite savo paskyros žinyne
Prisijungus rodomas žinynas filtruoja operacijas pagal jūsų teises ir įjungtas paslaugas. Naudokite jame nurodytą tikslų pagrindinį kompiuterį (host), prisijungimo duomenų tipą, užklausos laukus ir atsakymo schemą. Konsolėse galima vykdyti realias operacijas, įskaitant pirkimus ir žinučių siuntimą.