HTTP API - URL šablon
Ovaj vodič vam daje uputstva o tome kako kreirati URL šablon koji će se koristiti u parametrima redirecturl, continueurl i reporturl metode sendmessage HTTP API-ja.
Uvod
Ako uključite parametre redirecturl ili continueurl u vaš HTTP zahtev sendmessage, SMS server će vratiti odgovor koji sadrži URL. Ako navedeni URL sadrži određene ključne reči, one će biti zamenjene odgovarajućim vrednostima koje odgovaraju poslatoj poruci. Drugim rečima, URL šablon je URL koji će biti obradjen od strane SMS gateway-a pre nego što se upotrebi u HTTP odgovoru. Obrada znači da će određene ključne reči biti zamenjene u URL-u.
Na primer, ako navedete sledeći URL u parametru continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
On će biti modifikovan u ovo kada se vrati u HTTP odgovoru:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Primetite da su ključne reči $messageid i $statusmessage zamenjene. ID poruke poslatih poruka je zamenjen za $messageid ključnu reč u URL-u, a statusna poruka slanja je zamenjena za $statusmessage ključnu reč. Ozeki 10 SMS Gateway zamenjuje ključne reči navedene u tabeli ispod.
Kako koristiti?
Da biste prosledili URL šablon u parametrima redirecturl, continueurl ili reporturl, URL šablon mora biti urlkodiran. Ovo je neophodno jer bi inače HTTP sintaksa metode sendmessage bila prekinuta. Da biste urlkodirali svoj URL šablon, možete koristiti online alat za url kodiranje (dostupan na http://www.ozeki.hu/index.php?owpn=5679) ili možete ručno izvršiti kodiranje.
URL šablon koji smo koristili u gornjem primeru izgleda ovako pre kodiranja:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Nakon urlkodiranja, izgledaće ovako:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Ako želite da uključite ovaj URL šablon u svoj zahtev za slanje, vaš zahtev 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 reči
URL šabloni mogu sadržati sledeće ključne reči| Zamenjuje se sa | Može se koristiti u sledećim parametrima metode sendmessage HTTP API-ja | |
| statuscode | Rezultujući kod slanja poruke | redirecturl continueurl reporturl |
| statusmessage | Statusna poruka slanja poruke. (Objašnjenje statuscode-a.) | redirecturl continueurl reporturl |
| messageid | ID poslate poruke | redirecturl continueurl reporturl |
| recipient | Broj telefona primaoca poslate poruke | redirecturl continueurl reporturl |
| originator | Ime pošiljaoca ili broj telefona pošiljaoca poslate poruke | redirecturl continueurl reporturl |
| messagetype | Tip poruke poslate poruke | redirecturl continueurl reporturl |
| messagedata | Podaci poruke poslate poruke | redirecturl continueurl reporturl |
| submitdate | Datum i vreme događaja slanja poruke. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Datum i vreme događaja isporuke poruke mreži. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Datum i vreme događaja isporuke poruke na uređaj. Format datuma je YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Trenutni status poslate poruke.
Moguće vrednosti:
deliveredtonetwork deliveredtohandset deliveryfailed Ako isporuka ne uspe, parametri statuscode i statusmessage sadrže kod greške i poruku o grešci koju je vratio provajder usluge | reporturl |
Ako se više poruka pošalje sa jednim HTTP zahtevom, URL šablon će sadržati vrednosti koje odgovaraju poslednjoj poruci na listi.
More information