HTTP API - Šablona URL

Tento průvodce vám poskytuje instrukce, jak vytvořit šablonu URL, která bude použita v parametrech redirecturl, continueurl a reporturl metody sendmessage HTTP API.

Úvod

Pokud jsou parametry redirecturl nebo continueurl zahrnuty ve vašem HTTP požadavku sendmessage, SMS server vrátí odpověď obsahující URL. Pokud zadané URL obsahuje určité klíčové slova, budou tato klíčová slova nahrazena příslušnými hodnotami odpovídajícími odeslané zprávě. Jinými slovy, šablona URL je URL, které bude zpracováno SMS bránou před tím, než bude použito v HTTP odpovědi. Zpracování znamená, že určitá klíčová slova budou v URL nahrazena.

Například, pokud zadáte následující URL v parametru continueurl:

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

Bude upraveno takto, když bude vráceno v HTTP odpovědi:

http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery

Všimněte si, že klíčová slova $messageid a $statusmessage byla nahrazena. ID zprávy odeslaných zpráv je nahrazeno za klíčové slovo $messageid v URL a stavová zpráva odeslání je nahrazena za klíčové slovo $statusmessage. Ozeki 10 SMS Gateway nahrazuje klíčová slova uvedená v tabulce níže.

Jak používat?

Pro předání šablony URL v parametrech redirecturl, continueurl nebo reporturl musí být šablona URL zakódována. To je nutné, protože jinak by se porušila syntaxe HTTP metody sendmessage. Pro zakódování vaší šablony URL můžete použít online nástroj pro URL kódování (dostupný na http://www.ozeki.hu/index.php?owpn=5679) nebo můžete kódování provést ručně.

Šablona URL, kterou jsme použili v příkladu výše, vypadá takto před zakódováním:

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

Po zakódování bude vypadat takto:

http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage

Pokud chcete tuto šablonu URL zahrnout do vašeho odesílacího požadavku, váš požadavek bude vypadat 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

Klíčová slova

Šablony URL mohou obsahovat následující klíčová slova

Klíčové slovo
Nahrazeno za Lze použít v následujícím parametru metody sendmessage HTTP API
statuscode Výsledný kód odeslání zprávy redirecturl
continueurl
reporturl
statusmessage Stavová zpráva odeslání zprávy. (Vysvětlení statuscode.) redirecturl
continueurl
reporturl
messageid ID odeslané zprávy redirecturl
continueurl
reporturl
recipient Telefonní číslo příjemce odeslané zprávy redirecturl
continueurl
reporturl
originator Jméno odesílatele nebo telefonní číslo odesílatele odeslané zprávy redirecturl
continueurl
reporturl
messagetype Typ zprávy odeslané zprávy redirecturl
continueurl
reporturl
messagedata Obsah zprávy odeslané zprávy redirecturl
continueurl
reporturl
submitdate Datum a čas události odeslání zprávy. Formát data je YYYY-MM-DD hh:mm:ss. reporturl
deliveredtonetworkdateDatum a čas události doručení zprávy do sítě. Formát data je YYYY-MM-DD hh:mm:ss. reporturl
deliveredtohandsetdateDatum a čas události doručení zprávy do zařízení. Formát data je YYYY-MM-DD hh:mm:ss. reporturl
statusAktuální stav odeslané zprávy. Možné hodnoty:

deliveredtonetwork
deliveredtohandset
deliveryfailed

Pokud se doručení nezdaří, parametry statuscode a statusmessage obsahují kód chyby a chybovou zprávu vrácenou poskytovatelem služby 		reporturl

Pokud je více než jedna zpráva odeslána s jedním HTTP požadavkem, šablona URL bude obsahovat hodnoty odpovídající poslední zprávě v seznamu.

More information