HTTP API - URL šablóna
Tento návod vám poskytuje inštrukcie, ako vytvoriť URL šablónu, ktorá sa použije v parametroch redirecturl, continueurl a reporturl metódy sendmessage HTTP API.
Úvod
Ak sú parametre redirecturl alebo continueurl zahrnuté vo vašej HTTP požiadavke sendmessage, SMS server vráti odpoveď obsahujúcu URL. Ak zadaná URL obsahuje určité kľúčové slová, tieto budú nahradené príslušnými hodnotami zodpovedajúcimi odoslanému správu. Inými slovami, URL šablóna je URL, ktoré bude spracované SMS bránou predtým, ako sa použije v HTTP odpovedi. Spracovanie znamená, že určité kľúčové slová budú v URL nahradené.
Napríklad, ak zadáte nasledujúcu URL v parametri continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Bude upravená takto, keď sa vráti v HTTP odpovedi:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Všimnite si, že kľúčové slová $messageid a $statusmessage boli nahradené. ID správy odoslaných správ je nahradené za kľúčové slovo $messageid v URL a stavová správa odoslania je nahradená za kľúčové slovo $statusmessage. Ozeki 10 SMS Gateway nahradí kľúčové slová uvedené v tabuľke nižšie.
Ako používať?
Ak chcete odoslať URL šablónu v parametri redirecturl, continueurl alebo reporturl, URL šablóna musí byť urlencoded. To je nevyhnutné, pretože inak by sa porušila HTTP syntax metódy sendmessage. Ak chcete zakódovať svoju URL šablónu, môžete použiť online nástroj na kódovanie URL (dostupný na http://www.ozeki.hu/index.php?owpn=5679) alebo môžete kódovanie vykonať manuálne.
URL šablóna, ktorú sme použili v príklade vyššie, vyzerá takto pred kódovaním:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Po zakódovaní bude vyzerať takto:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Ak chcete zahrnúť túto URL šablónu do svojej požiadavky na odoslanie, vaša požiadavka bude vyzerať takto:
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
Kľúčové slová
URL šablóny môžu obsahovať nasledujúce kľúčové slová| Nahradené za | Môže byť použité v nasledujúcom parametri metódy HTTP API sendmessage | |
| statuscode | Výsledný kód odoslania správy | redirecturl continueurl reporturl |
| statusmessage | Stavová správa odoslania správy. (Vysvetlenie statuscode.) | redirecturl continueurl reporturl |
| messageid | ID odoslanej správy | redirecturl continueurl reporturl |
| recipient | Telefónne číslo príjemcu odoslanej správy | redirecturl continueurl reporturl |
| originator | Meno odosielateľa alebo telefónne číslo odosielateľa odoslanej správy | redirecturl continueurl reporturl |
| messagetype | Typ správy odoslanej správy | redirecturl continueurl reporturl |
| messagedata | Dáta správy odoslanej správy | redirecturl continueurl reporturl |
| submitdate | Dátum a čas odoslania správy. Formát dátumu je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Dátum a čas doručenia správy do siete. Formát dátumu je YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Dátum a čas doručenia správy do zariadenia. Formát dátumu je YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Aktuálny stav odoslanej správy.
Možné hodnoty:
deliveredtonetwork deliveredtohandset deliveryfailed Ak doručenie zlyhá, parametre statuscode a statusmessage obsahujú chybový kód a chybovú správu vrátenú poskytovateľom služieb | reporturl |
Ak je viacero správ odoslaných s jednou HTTP požiadavkou, URL šablóna bude obsahovať hodnoty zodpovedajúce poslednej správe v zozname.
More information