User Tools

Site Tools


br-121-api-smsg


Solicitação API / SMSG

O comando SMSG solicita ao webservice, por meio de POST, o envio de mensagens para assinantes do canal.



Variáveis POST

id Código de identificação do canal solicitante, sem criptografia (Channel-ID)
key Chave AES (temporária), criptografada com a chave pública do canal e codificada em Base64 / URL Encode.
frame String criptografado com a chave AES (temporária), contendo o XML de solicitação (comando, número de sequência da solicitação e parâmetros), e codificado em Base64 / URL Encode.



XML de resposta do POST

Após o processamento da solicitação contida no POST, o webservice retorna o seguinte XML para o solicitante:

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<retcode>código-de-retorno</retcode>
<retframe>xml-de-resposta-da-solicitação</retframe>
<retmd5>md5-de-resposta</retmd5>
</followzup>

Onde:

  • código-de-retorno: String não criptografado, contendo o valor “0” (zero) para as solicitações executadas com sucesso, ou o código de erro correspondente, composto por 4 dígitos numéricos.
  • xml-de-resposta-da-solicitação: String criptografado com a mesma chave AES utilizada no envio da solicitação (chave temporária), e codificado em Base64.
  • md5-de-resposta: String contendo o hash md5 do campo acima.



XML de solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<com>smsg</com>
<seq>sequência-da-solicitação</seq>
<urs>destinatário</urs>
<hrs>tempo-de-vida</hrs>
<msg>texto-da-mensagem</msg>
<url>url-da-mensagem</url>
</followzup>

Onde:

  • Literal smsg: Comando para envio de mensagens (Send Message);
  • sequência-da-solicitação: Número de sequência da solicitação;
  • destinatário: Literal “all” para envio de mensagens em broadcast ou lista de destinatários separados pelo caracter “,” (virgula). A lista pode conter o e-mail ou o USER-ID dos destinatários;
  • tempo-de-vida: Valor numérico em horas referente ao tempo de vida da mensagem, limitado a 960 horas;
  • texto-da-mensagem: String contendo o texto da mensagem, com até 200 caracteres e codificado em Base64;
  • url-da-mensagem: String contendo a URL de destino da mensagem, com até 200 caracteres e codificado em Base64.



XML de resposta da solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<snt>total-sent</snt>
<nsb>total-nosubs</nsb>
<inv>total-invalid</inv>
</followzup>

Onde:

  • total-sent: Número total de mensagens enviadas;
  • total-nosubs: Número total de destinatários informados que não correspondem a assinantes do canal (esse total não é apresentado em mensagens de broadcast);
  • total-invalid: Número total de destinatários inválidos (esse total não é apresentado em mensagens de broadcast).


XML de resposta da solicitação (sequência inválida):

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<seq>Last-sequence</seq>
</followzup>

Onde:

  • Last-sequence: Número de sequência utilizado na última solicitação.



Códigos de Retorno

0 Execução com sucesso
6101 Sequência inválida (deve ser tratado pela API)
6102 Frame inválido
6103 Comando inválido
6104 Channel-ID inválido
6108 Mensagem nula
6109 Lista de destinatários com mais de 200 entradas
6110 URL inválida
6999 Webservice em manutenção


br-121-api-smsg.txt · Last modified: 2017/03/08 08:57 by admin

Page Tools