HTTP API - Szablon URL
Ten przewodnik zawiera instrukcje dotyczące tworzenia szablonu URL, który może być używany w parametrach redirecturl, continueurl i reporturl metody sendmessage HTTP API.
Wprowadzenie
Jeśli parametry redirecturl lub continueurl są zawarte w żądaniu HTTP sendmessage, serwer SMS zwróci odpowiedź zawierającą URL. Jeśli określony URL zawiera pewne słowa kluczowe, zostaną one zastąpione odpowiednimi wartościami odpowiadającymi wysłanej wiadomości. Innymi słowy, szablon URL to URL, który zostanie przetworzony przez bramkę SMS przed użyciem w odpowiedzi HTTP. Przetwarzanie oznacza, że pewne słowa kluczowe zostaną zastąpione w URL.
Na przykład, jeśli określisz następujący URL w parametrze continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Zostanie on zmodyfikowany w ten sposób, gdy zostanie zwrócony w odpowiedzi HTTP:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Zauważ, że słowa kluczowe $messageid i $statusmessage zostały zastąpione. Identyfikator wiadomości wysłanych wiadomości jest podstawiany za słowo kluczowe $messageid w URL, a komunikat statusu przesyłania jest podstawiany za słowo kluczowe $statusmessage. Ozeki 10 SMS Gateway zastępuje słowa kluczowe określone w poniższej tabeli.
Jak używać?
Aby przekazać szablon URL w parametrach redirecturl, continueurl lub reporturl, szablon URL musi być zakodowany w URL. Jest to konieczne, ponieważ w przeciwnym razie składnia HTTP metody sendmessage zostałaby naruszona. Aby zakodować swój szablon URL, możesz użyć narzędzia do kodowania URL online (dostępnego pod adresem http://www.ozeki.hu/index.php?owpn=5679) lub możesz wykonać kodowanie ręcznie.
Szablon URL, którego użyliśmy w powyższym przykładzie, wygląda tak przed kodowaniem:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Po zakodowaniu będzie wyglądać tak:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Jeśli chcesz uwzględnić ten szablon URL w swoim żądaniu przesyłania, Twoje żądanie będzie wyglądać tak:
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
Słowa kluczowe
Szablony URL mogą zawierać następujące słowa kluczowe| Zastąpione przez | Może być używane w następujących parametrach metody sendmessage HTTP API | |
| statuscode | Kod wyniku przesyłania wiadomości | redirecturl continueurl reporturl |
| statusmessage | Komunikat statusu przesyłania wiadomości. (Wyjaśnienie statuscode.) | redirecturl continueurl reporturl |
| messageid | Identyfikator wysłanej wiadomości | redirecturl continueurl reporturl |
| recipient | Numer telefonu odbiorcy wysłanej wiadomości | redirecturl continueurl reporturl |
| originator | Nazwa nadawcy lub numer telefonu nadawcy wysłanej wiadomości | redirecturl continueurl reporturl |
| messagetype | Typ wiadomości wysłanej wiadomości | redirecturl continueurl reporturl |
| messagedata | Dane wiadomości wysłanej wiadomości | redirecturl continueurl reporturl |
| submitdate | Data i godzina zdarzenia przesyłania wiadomości. Format daty to YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Data i godzina zdarzenia dostarczenia wiadomości do sieci. Format daty to YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Data i godzina zdarzenia dostarczenia wiadomości do telefonu. Format daty to YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Bieżący status wysłanej wiadomości.
Możliwe wartości:
deliveredtonetwork deliveredtohandset deliveryfailed Jeśli dostarczenie nie powiedzie się, parametry statuscode i statusmessage zawierają kod błędu i komunikat błędu zwrócony przez dostawcę usług | reporturl |
Jeśli więcej niż jedna wiadomość jest wysyłana w jednym żądaniu HTTP, szablon URL będzie zawierał wartości odpowiadające ostatniej wiadomości na liście.
More information