HTTP API - URL predloga
Ta vodič vsebuje navodila, kako ustvariti URL predlogo, ki se uporablja v parametrih redirecturl, continueurl in reporturl metode sendmessage HTTP API.
Uvod
Če parametra redirecturl ali continueurl vključite v svojo HTTP zahtevo sendmessage, bo SMS strežnik vrnil odziv, ki vsebuje URL. Če navedeni URL vsebuje določene ključne besede, bodo te ključne besede zamenjane z ustreznimi vrednostmi, ki ustrezajo poslanemu sporočilu. Z drugimi besedami, URL predloga je URL, ki ga SMS prehod obdela, preden se uporabi v HTTP odzivu. Obdelava pomeni, da bodo določene ključne besede v URL-ju zamenjane.
Na primer, če v parametru continueurl določite naslednji URL:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Ko se vrne v HTTP odzivu, bo spremenjen v tole:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Opazite, da sta bili ključni besedi $messageid in $statusmessage zamenjani. ID sporočila poslanih sporočil je nadomeščen za ključno besedo $messageid v URL-ju, statusno sporočilo pošiljanja pa je nadomeščeno za ključno besedo $statusmessage. Ozeki 10 SMS Gateway nadomesti ključne besede, navedene v spodnji tabeli.
Kako uporabljati?
Če želite poslati URL predlogo v parametru redirecturl, continueurl ali reporturl, mora biti URL predloga kodirana (urlencoded). To je potrebno, ker bi sicer sintaksa metode sendmessage HTTP prekinila. Za kodiranje URL predloge lahko uporabite spletno orodje za kodiranje URL-jev (na voljo na http://www.ozeki.hu/index.php?owpn=5679) ali lahko kodiranje opravite ročno.
URL predloga, ki smo jo uporabili v zgornjem primeru, je pred kodiranjem videti takole:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Po kodiranju bo videti takole:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Če želite to URL predlogo vključiti v svojo zahtevo za pošiljanje, bi bila vaša zahteva videti takole:
http://127.0.0.1:9501/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World&redirecturl=
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Ključne besede
URL predloge lahko vsebujejo naslednje ključne besede| Nadomeščena z | Lahko se uporablja v naslednjem parametru metode sendmessage HTTP API | |
| statuscode | Koda rezultata pošiljanja sporočila | redirecturl continueurl reporturl |
| statusmessage | Statusno sporočilo pošiljanja sporočila. (Razlaga statuscode.) | redirecturl continueurl reporturl |
| messageid | ID poslanega sporočila | redirecturl continueurl reporturl |
| recipient | Telefonska številka prejemnika poslanega sporočila | redirecturl continueurl reporturl |
| originator | Ime pošiljatelja ali telefonska številka pošiljatelja poslanega sporočila | redirecturl continueurl reporturl |
| messagetype | Vrsta sporočila poslanega sporočila | redirecturl continueurl reporturl |
| messagedata | Podatki sporočila poslanega sporočila | redirecturl continueurl reporturl |
| submitdate | Datum in čas dogodka pošiljanja sporočila. Oblika datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Datum in čas dogodka dostave sporočila v omrežje. Oblika datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Datum in čas dogodka dostave sporočila na napravo. Oblika datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Trenutni status poslanega sporočila.
Možne vrednosti:
deliveredtonetwork deliveredtohandset deliveryfailed Če dostava spodleti, parametra statuscode in statusmessage vsebujeta kodo napake in sporočilo o napaki, ki ga vrne ponudnik storitve | reporturl |
Če je z eno samo HTTP zahtevo poslanih več sporočil, bo URL predloga vsebovala vrednosti, ki ustrezajo zadnjemu sporočilu na seznamu.
More information