REST API dokumentacija
SMS ir MMS REST API
Siųskite patvirtintas programų žinutes ir tvarkykite priėmimą, pristatymo įvykius, segmentavimą ir mokesčius.
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.
Paruoškite SMS užklausą
Naudokite paskyrai priklausantį patvirtintą numerį su įjungtu SMS siuntimu, gavėją, sutikusį gauti žinutę, ir reikalaujamą prekės ženklo bei kampanijos arba nemokamo skambinimo numerio patikrą. Toliau pateiktas pavyzdys su veikiančiais prisijungimo duomenimis ir numeriais siunčia tikrą žinutę; tai nėra bandymų aplinka.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Siuntėjo ir gavėjo vietaženklius pakeiskite tarptautinio numerio skaitmenimis, įskaitant šalies kodą. MMS atveju lauke media pateikite palaikomą viešai pasiekiamą medijos URL ir pirmiausia patikrinkite MMS tinkamumą bei kainas.
Priėmimas nėra pristatymas
Patikrinkite ir išorinę programos būseną, ir grąžintą žinutės rezultatą. Užfiksuokite paslaugos pateiktą žinutės identifikatorių ir stebėkite pristatymo būseną bei webhook įvykius. Sėkmingas pateikimas neįrodo, kad gavėjo telefonas gavo žinutę.
SMS apmokestinamos pagal segmentus. Dėl koduotės ir žinutės ilgio gali susidaryti keli segmentai; medijos ir operatorių mokesčiai gali skirtis nuo SMS mokesčių. Prieš siųsdami, perskaitykite paskyrai taikomą dabartinę pardavimo kainą. Aklai nekartokite siuntimo, kurio laukimo laikas baigėsi: pirmiausia patikrinkite užfiksuotą rezultatą.
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ą.