HTTP API - Modelo de URL
Este guia fornece instruções sobre como criar um modelo de URL para ser usado nos parâmetros redirecturl, continueurl e reporturl do método sendmessage da API HTTP.
Introdução
Se os parâmetros redirecturl ou continueurl forem incluídos na sua requisição HTTP sendmessage, o servidor SMS irá retornar uma resposta contendo a URL. Se a URL especificada contiver certas palavras-chave, elas serão substituídas pelos valores apropriados correspondentes à mensagem enviada. Em outras palavras, um modelo de URL é uma URL que será processada pelo gateway SMS antes de ser usada na resposta HTTP. Processar significa que certas palavras-chave serão substituídas na URL.
Por exemplo, se você especificar a seguinte URL no parâmetro continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Ela será modificada assim quando retornada na resposta HTTP:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Observe que as palavras-chave $messageid e $statusmessage foram substituídas. O ID da mensagem enviada é substituído pela palavra-chave $messageid na URL e a mensagem de status do envio é substituída pela palavra-chave $statusmessage. O Ozeki 10 SMS Gateway substitui as palavras-chave especificadas na tabela abaixo.
Como usar?
Para passar um modelo de URL nos parâmetros redirecturl, continueurl ou reporturl, o modelo de URL deve ser codificado em URL. Isso é necessário porque, caso contrário, a sintaxe HTTP do método sendmessage seria quebrada. Para codificar seu modelo de URL, você pode usar a ferramenta online de codificação de URL (disponível em http://www.ozeki.hu/index.php?owpn=5679) ou pode fazer a codificação manualmente.
O modelo de URL que usamos no exemplo acima fica assim antes da codificação:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Após a codificação, ficará assim:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Se você quiser incluir este modelo de URL na sua requisição de envio, sua requisição ficaria
assim:
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
Palavras-chave
Modelos de URL podem conter as seguintes palavras-chave| Substituído por | Pode ser usado no seguinte parâmetro do método sendmessage da API HTTP | |
| statuscode | O código de resultado do envio da mensagem | redirecturl continueurl reporturl |
| statusmessage | A mensagem de status do envio da mensagem. (O statuscode explicado.) | redirecturl continueurl reporturl |
| messageid | O ID da mensagem enviada | redirecturl continueurl reporturl |
| recipient | O número de telefone do destinatário da mensagem enviada | redirecturl continueurl reporturl |
| originator | O nome do remetente ou número de telefone do remetente da mensagem enviada | redirecturl continueurl reporturl |
| messagetype | O tipo de mensagem da mensagem enviada | redirecturl continueurl reporturl |
| messagedata | Os dados da mensagem da mensagem enviada | redirecturl continueurl reporturl |
| submitdate | A data e hora do evento de envio da mensagem. O formato da data é AAAA-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | A data e hora do evento de entrega da mensagem à rede. O formato da data é AAAA-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | A data e hora do evento de entrega da mensagem ao aparelho. O formato da data é AAAA-MM-DD hh:mm:ss. | reporturl |
| status | O status atual da mensagem enviada.
Valores possíveis:
deliveredtonetwork deliveredtohandset deliveryfailed Se a entrega falhar, os parâmetros statuscode e statusmessage conterão o código de erro e a mensagem de erro retornados pelo provedor de serviço | reporturl |
Se mais de uma mensagem for enviada com uma única requisição HTTP, o modelo de URL conterá os valores correspondentes à última mensagem da lista.
More information