Carregando...

Controle de Envio de SMS

Disparo de ações SMS Corporativo (Transacional)

 

As integrações desse grupo permitem o disparo de uma ação de SMS, assim como a consulta do status do envio, consulta das respostas dos contatos e a geração de um relatório de cliques.

 

40.01 - Cadastrar Ação de SMS Corporativo

 

Utilize essa integração para enviar uma mensagem de  SMS para os seus contatos.

XML de Envio:

<main> 
  <emkt trans="40.01">
   <remetente></remetente>
  <identificador></identificador>
  <encurtar_url>S</encurtar_url>
     <sms>
       <telefone></telefone>
       <mensagem></mensagem>
     </sms> 
    <sms>
       <telefone></telefone>
      <mensagem></mensagem>
     </sms>
    (...)
   </emkt> 
</main>

*Itens em negrito são obrigatórios.

Remetente: Remetente cadastrado na plataforma para envio de mensagens SMS. Esse campo é obrigatório para envio do SMS somente se existir mais de um remetente cadastrado em sua conta.

Identificador: Código alfanumérico com até treze caracteres para identificar a integração. No caso de não ser enviado será gerado automaticamente e não é obrigatório.

 Encurtar URL: Esta tag precisa ser usada (valor ‘S’) para que o link possa ser rastreado e assim poder gerar um relatório referente aos cliques que ocorreram nas mensagens.

Telefone: Número do telefone celular do contato. Campo obrigatório e deve ser enviado no seguinte formato DDD + Número do telefone. Exemplo: "11987554321".

Mensagem: Texto da mensagem a ser enviada ao contato.

XML de Retorno:

<MAIN> 
  <EMKT TRANS="40.01" KEY="0950014941cbc070d30aee01e982">
     <RETURN ID="00">5672fa9f43cea</RETURN>
   </EMKT> 
</MAIN>
Atenção: O Valor informado na tag RETURN é necessário para a utilização das Integrações 40.02 e 40.03.

 

40.02 - Consultar o Status do Envio

 

Utilize essa integração para consultar o status dos envios após executar a integração 40.01.

XML de Envio:

<main>
  <emkt trans="40.02"> 
    <sms> 
      <codigo>5672fa9f43cea</codigo> 
    </sms>  
 </emkt> 
</main>

*Itens em negrito são obrigatórios.

O <codigo> é o valor do campo informado na integração 40.01.

XML de Retorno:

<MAIN>
  <EMKT TRANS="40.02" KEY="0c0001f53cbaa770d631a8f9f98e">
    <SMS>
      <TELEFONE>[NÚMERO DO TELEFONE]</TELEFONE>
      <STATUS>[SITUAÇÃO DO ENVIO]</STATUS>
    </SMS>
  </EMKT>
</MAIN>
Atenção: Os status retornados na integração 40.02 podem sofrer alterações num prazo de até 24 horas.

 

40.03 - Consultar as Respostas dos Destinatários

 

Utilize essa integração para consultar as respostas dos contatos que receberam o SMS enviado através da integração 40.01.

XML  de Envio:

<main>
   <emkt trans="40.03"> 
    <sms>     
     <codigo>5672fa9f43cea</codigo>  
    </sms>  
  </emkt> 
</main>
*Itens em negrito são obrigatórios.

O <codigo> é o valor do campo informado na integração 40.01.

XML de Retorno:

<MAIN>
  <EMKT TRANS="40.03" KEY="09000114b58c4170d5657f4889a0">
    <SMS>
      <TELEFONE>[TELEFONE DO DESTINATÁRIO]</TELEFONE>
      <MENSAGEM>[MENSAGEM ENVIADA PELO DESTINATÁRIO]</MENSAGEM>
      <DATA_RECEBIMENTO>AAAA-MM-DD HH:MM:SS</DATA_RECEBIMENTO>
    </SMS>
  </EMKT>
</MAIN>

 

40.04 - Solicitação de relatório de Cliques de SMS Transacional

 

Utilize essa integração para gerar um relatório com  os cliques que ocorreram em suas mensagens de  SMS.

Para a busca por esses cliques é possível utilizar: o identificador da ação (posso passar mais de um), o número do celular (também posso informar mais de um número), a data do envio (início e fim), ou a data dos cliques (início e fim).

XML de Envio:

<main>
    <emkt trans="40.04">
        <sms>
            <identificador>[identificador1],[identificador2], ...</identificador>
            <telefone>[telefone1],[telefone2], ...</telefone>
            <envio>
                <inicio>2020-01-03 12:00:00</inicio>
                <fim>2020-01-03 12:30:00</fim>
            </envio>
            <clique>
                <inicio>2020-01-03 10:00:00</inicio>
                <fim>2020-01-03 11:00:00</fim>
            </clique>
        </sms>
    </emkt>
</main>	
*Itens em negrito são obrigatórios.

Os períodos informados não podem ser maiores que 48 horas.

XML de Retorno:

<main>
  <emkt trans="40.04" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <processo>[CODIGO MD5]</processo>
  </emkt>
</main>

 

40.05 - Acompanhar o Progresso da Geração do Relatório

 

Utilize essa integração para consultar o processo de geração do relatório solicitado na integração 40.04.

  XML de Envio:

<main>
    <emkt trans="40.05">
        <processo>[CODIGO MD5]</processo>
    </emkt>
</main>

*Itens em negrito são obrigatórios.

XML de Retorno:

<main>
  <emkt trans="40.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <progresso>[PERCENTUAL]</progresso>
    <resultado>
      <erro>[MENSAGEM DE ERRO]</erro>
    </resultado>
  </emkt>
</main>


*Itens em negrito são obrigatórios.

 

40.06  - Realizar o Download Arquivo Zipado (.zip)

 

Utilize essa integração para fazer o download do arquivo gerado na integração 40.04.

XML de Envio:

<main>
    <emkt trans="40.06">
        <processo>00ccc3b7dcd22dd396d39b5e665a22a1</processo>
    </emkt>
</main>
*Itens em negrito são obrigatórios.

O retorno dessa integração é um arquivo .zip com o relatório de cliques solicitado na integração 40.04.

Este conteúdo foi útil?30