HTTP API - URL predložak
Ovaj vodič daje upute o tome kako kreirati URL predložak koji će se koristiti u parametrima redirecturl, continueurl i reporturl metode sendmessage HTTP API-ja.
Uvod
Ako parametri redirecturl ili continueurl budu uključeni u vaš HTTP zahtjev sendmessage, SMS server će vratiti odgovor koji sadrži URL. Ako navedeni URL sadrži određene ključne riječi, one će biti zamijenjene odgovarajućim vrijednostima koje odgovaraju poslanoj poruci. Drugim riječima, URL predložak je URL koji će biti obrađen od strane SMS pristupnika prije nego što se upotrijebi u HTTP odgovoru. Obrada znači da će određene ključne riječi biti zamijenjene u URL-u.
Na primjer, ako navedete sljedeći URL u parametru continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
On će biti modificiran u ovo kada bude vraćen u HTTP odgovoru:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Primijetite da su ključne riječi $messageid i $statusmessage zamijenjene. ID poruke poslanih poruka zamijenjen je za ključnu riječ $messageid u URL-u, a statusna poruka slanja zamijenjena je za ključnu riječ $statusmessage. Ozeki 10 SMS Gateway zamjenjuje ključne riječi navedene u donjoj tablici.
Kako koristiti?
Da biste proslijedili URL predložak u parametrima redirecturl, continueurl ili reporturl, URL predložak mora biti urlkodiran. To je potrebno jer bi inače HTTP sintaksa metode sendmessage bila prekinuta. Za urlkodiranje vašeg URL predloška možete koristiti online alat za url kodiranje (dostupan na http://www.ozeki.hu/index.php?owpn=5679) ili možete izvršiti kodiranje ručno.
URL predložak koji smo koristili u gornjem primjeru izgleda ovako prije kodiranja:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Nakon urlkodiranja izgledat će ovako:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Ako želite uključiti ovaj URL predložak u svoj zahtjev za slanje, vaš zahtjev bi izgledao ovako:
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 riječi
URL predlošci mogu sadržavati sljedeće ključne riječi| Zamijenjena s | Može se koristiti u sljedećim parametrima metode sendmessage HTTP API-ja | |
| statuscode | Rezultirajući kod slanja poruke | redirecturl continueurl reporturl |
| statusmessage | Statusna poruka slanja poruke. (Objašnjenje statuscode-a.) | redirecturl continueurl reporturl |
| messageid | ID poslane poruke | redirecturl continueurl reporturl |
| recipient | Broj telefona primatelja poslane poruke | redirecturl continueurl reporturl |
| originator | Ime pošiljatelja ili broj telefona pošiljatelja poslane poruke | redirecturl continueurl reporturl |
| messagetype | Vrsta poruke poslane poruke | redirecturl continueurl reporturl |
| messagedata | Podaci poruke poslane poruke | redirecturl continueurl reporturl |
| submitdate | Datum i vrijeme događaja slanja poruke. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Datum i vrijeme događaja isporuke poruke u mrežu. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Datum i vrijeme događaja isporuke poruke na uređaj. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Trenutni status poslane poruke.
Moguće vrijednosti:
deliveredtonetwork deliveredtohandset deliveryfailed Ako isporuka ne uspije, parametri statuscode i statusmessage sadrže kod greške i poruku o grešci koju je vratio pružatelj usluge | reporturl |
Ako se više poruka pošalje s jednim HTTP zahtjevom, URL predložak će sadržavati vrijednosti koje odgovaraju posljednjoj poruci na listi.
More information