API HTTP - ação 'receivemessage'

Esta ação pode ser usada para receber mensagens SMS do Gateway SMS usando polling HTTP. Polling HTTP significa que você baixa mensagens SMS da pasta de entrada do gateway como faria com uma página da web. Nesta seção, você pode obter informações sobre como usar a ação receivemessage, quais são os parâmetros e será apresentado um exemplo de solicitação HTTP para baixar mensagens recebidas.

Descrição

Para baixar mensagens de texto recebidas, use o seguinte formato de URL:

https://127.0.0.1:9508/api?action=receivemessage&username=UUUUU&password=PPPPP&
folder=inbox&limit=2&afterdownload=delete

Para 127.0.0.1, você deve substituir pelo nome do host ou endereço IP do computador onde o gateway SMS está instalado. O número da porta 9508 é o padrão HTTP do gateway SMS Ozeki. Seu número de porta pode ser configurado na interface do usuário do Ozeki 10 SMS Gateway, clicando no botão Avançado na barra de ferramentas.

O nome de usuário e a senha devem ser substituídos por "UUUUU" e "PPPPP". O nome de usuário e senha identificam o usuário que você criou no gateway SMS. Quando você invoca a ação receivemessage ao chamar a URL, você baixará mensagens da caixa de entrada do usuário especificado na consulta com o nome de usuário e senha.

O parâmetro folder da mensagem deve ser definido como inbox.

O parâmetro limit especifica o número de mensagens que serão baixadas. É recomendado baixar menos de 1000 mensagens em uma única solicitação. Você pode baixar as mensagens restantes em solicitações subsequentes.

O parâmetro afterdownload pode ser usado para remover mensagens do gateway SMS após serem baixadas com sucesso.

Exemplo de Solicitação URL

https://127.0.0.1:9508/api?action=receivemessage&username=admin&password=abc123&
folder=inbox&limit=2&afterdownload=delete

Exemplo de Resposta 
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 824

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/response.xml">
<response>
   <action>receivemessage</action>
   <data>
   <message>
   <messageid>ERFAV23D</messageid>
   <originator>06301234567</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Olá mundo</messagedata>
         <senttime>2008-01-16 10:04:00</senttime>
         <receivedtime>2008-01-18 20:58:04</receivedtime>
      </message>
      <message>
         <messageid>GYT4455D</messageid>
         <originator>06209994444</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Segunda mensagem</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>
Parâmetros da Solicitação
Parâmetro Descrição Valores Possíveis Exemplo O/M*
action Especifica o comando da API HTTP receivemessage action=receivemessage M
username Especifica o nome de usuário. Os parâmetros username e password são usados para autenticar o usuário. Uma vez autenticado, as mensagens serão baixadas de sua caixa de entrada. O valor deve ser codificado em URL. valor string, comprimento máximo de 16 caracteres username=admin M
password Especifica a senha. Os parâmetros username e password são usados para autenticar o usuário. Uma vez autenticado, as mensagens serão baixadas de sua caixa de entrada. O valor deve ser codificado em URL. valor string, comprimento máximo de 16 caracteres password=abc123 M
folder Especifica o nome da pasta. Por padrão, as mensagens serão baixadas da pasta de entrada. Você pode usar a ação receivemessage para baixar mensagens de outras pastas também. inbox (padrão)
outbox
deliveredtonetwork
deliveredtohandset
deliveryfailed
 folder=inbox O
limit Especifica o número máximo de mensagens a serem baixadas do servidor dentro da solicitação. Você pode baixar as mensagens restantes com solicitações subsequentes. valor inteiro, o limite padrão é 1000 limit=10 O
afterdownload Especifica como as mensagens devem ser tratadas após um download bem-sucedido. As mensagens podem ser excluídas do gateway SMS; elas podem ser marcadas como baixadas ou podem ser deixadas inalteradas. Se forem deixadas inalteradas, na próxima vez que você iniciar uma solicitação de download, elas serão baixadas novamente.
 delete (padrão)
mark
untouch
 afterdownload=delete O
responseformat Você pode especificar o formato das mensagens recebidas do usuário. xml, html, url-encoded responseformat=xml O

* M = Parâmetro obrigatório, O = Parâmetro opcional

Parâmetros de resposta
(formato de resposta xml)

Parâmetro Descrição Valores possíveis Exemplo
message Contém uma única mensagem. A seção de dados pode conter várias mensagens. O número de mensagens nos dados da mensagem pode ser menor ou igual ao valor do parâmetro limit.   
<message>
    <messageid>ERFAV23D</messageid>
    <originator>06301234567</originator>
    <recipient>06201112222</recipient>
    <messagetype>SMS:TEXT</messagetype>
    <messagedata>Hello world</messagedata>
    <senttime>2028-01-16 10:04:00</senttime>
    <receivedtime>2028-01-18 20:58:04</receivedtime>
</message>
message.messageid Contém uma referência de mensagem que pode ser usada para rastrear a mensagem no gateway SMS. Esta referência também é usada para identificar relatórios de entregue na rede e entregue no aparelho ou para consultar informações sobre a mensagem. valor string, comprimento máximo de 16 caracteres <messageid>ERFAV23D</messageid>
message.originator Contém o número de telefone do remetente. Este é o número de telefone do celular que enviou a mensagem. valor string, comprimento máximo de 16 caracteres <recipient>06301234567</recipient>
message.recipient Contém o endereço do destinatário. Este é o número de telefone que foi usado para enviar a mensagem. valor string, comprimento máximo de 16 caracteres <recipient>06201112222</recipient>
message.messagetype Contém o identificador do tipo de mensagem especificado na Especificação de Tipo de Mensagem Móvel. Na maioria dos casos, será SMS:TEXT. valor string, comprimento máximo de 1024 caracteres <recipient>SMS:TEXT</recipient>
message.messagedata Contém os dados da mensagem. Para mensagens de texto, este é o texto da mensagem SMS. Para outros tipos de mensagens, é uma estrutura XML especificada na Especificação de Tipo de Mensagem Móvel. Os dados da mensagem são codificados como UTF8. valor string <messagedata>Hello world</messagedata>
message.senttime Contém o timestamp que indica quando a mensagem foi enviada do telefone do remetente. Valor de data e hora no seguinte formato: AAAA-MM-DD hh:mm:ss <senttime>2028-01-16 10:04:00</senttime>
message.receivedtime Contém o timestamp que indica quando a mensagem foi recebida pelo gateway SMS. Valor de data e hora no seguinte formato: AAAA-MM-DD hh:mm:ss <senttime>2028-01-18 20:58:04</senttime>
Resumo

Neste artigo, você encontrou todas as informações necessárias para usar a ação ‘receivemessage’ com nossa API HTTP SMS.

Com esta solução, você pode utilizar os benefícios do polling http para receber as mensagens de texto recebidas. Fizemos o nosso melhor para torná-lo simples e guiá-lo por todos os detalhes da forma mais fácil possível. Se você já concluiu as etapas, viu os benefícios de usar nossa API HTTP SMS. Se você ainda não começou a trabalhar na conclusão do seu sistema SMS usando a API, não perca tempo. Comece agora!

Se você quiser conhecer mais insights úteis sobre as vantagens de outras soluções SMS semelhantes, por favor, abra a página sobre enviar mensagens com o mesmo sistema.

Espero que esta página seja útil para todos os leitores, especialmente para iniciantes.

More information