Como Disparar Um SMS Transacional

Sobre a função

As integrações deste grupo possibilitam o envio de ações por SMS, além de permitirem a consulta do status do envio, a verificação das respostas dos contatos e a criação de um relatório de cliques.

Como fazer

40.01 - Cadastrar Ação de SMS Corporativo

Aproveite esta integração para enviar mensagens SMS aos seus contatos.

XML de envio estrutura completa

<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>

Remetente: Informe o remetente registrado na plataforma para o envio de mensagens SMS. Este campo é obrigatório apenas se houver mais de um remetente cadastrado em sua conta.

Identificador: Código alfanumérico com até treze caracteres usado para identificar a integração. Caso não seja fornecido, será gerado automaticamente, não sendo obrigatório.

Encurtar URL: Utilize esta tag (valor 'S') para rastrear links e gerar relatórios de cliques nas mensagens.

Telefone: Informe o número de telefone celular do contato. Este campo é obrigatório e deve ser enviado no formato DDD + Número do telefone. Exemplo: "11987554321".

Mensagem: Insira o texto da mensagem a ser enviada ao contato.

XML de envio estrutura básica

<main> 
  <emkt trans="40.01">
    <sms>
       <telefone></telefone>
       <mensagem></mensagem>
     </sms> 
    </emkt> 
</main

XML de Retorno:

<MAIN> 
  <EMKT TRANS="40.01" KEY="0950014941cbc070d30aee01e982">
     <RETURN ID="00">5672fa9f43cea</RETURN>
   </EMKT> 
</MAIN>

40.02 - Consultar o Status do Envio

Aproveite esta integração para verificar o status dos envios após a execução da integração 40.01.

XML de envio:

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

O é 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>

40.03 - Consultar as Respostas dos Destinatários

Aproveite esta integração para verificar as respostas dos contatos que receberam o SMS enviado por meio da integração 40.01.

XML de envio:

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

O é 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

Aproveite esta integração para criar um relatório com os cliques que ocorreram em suas mensagens de SMS.

Para a busca desses cliques, é possível utilizar o identificador da ação (é possível fornecer mais de um), o número do celular (também é possível 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>	

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

Aproveite esta integração para verificar o andamento do 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>

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>

40.06 - Realizar o Download Arquivo Zipado (.zip)

Aproveite esta integração para realizar o download do arquivo gerado na integração 40.04.

XML de envio:

<main>
    <emkt trans="40.06">
        <processo>00ccc3b7dcd22dd396d39b5e665a22a1</processo>
    </emkt>
</main>

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