Como Disparar Um Whatsapp

Sobre a função

As integrações deste grupo possibilitam o envio de mensagens HSM, além de permitirem a consulta do status do envio.

Como fazer

50.01 - Enviar Mensagem

Aproveite esta integração para enviar uma mensagem HSM aos seus contatos.

XML de envio estrutura completa

<main> 
  <emkt trans="50.01">
  <remetente> </remetente>
  <identificador> </identificador>
  <namespace> </namespace>
  <element_name> </element_name>
  <contact>
      <phone></phone>
      <component type="body">
      <parameter type="text"></parameter>
      </component>
   </contact>
   <contact>
      <phone></phone>
      <component type="body">
      <parameter type="text"></parameter>
      </component>
   </contact>
    (...)
   </emkt> 
</main>

Remetente: Código cadastrado na plataforma para o envio de mensagens HSM. Este campo é obrigatório. Exemplo: 0bc8f181-3f84-41dc-90f2-a28dd5f90e73

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.

Namespace: Código da mensagem a ser utilizado no envio. Exemplo: cd551e83_8455_45fd_a2ff_35ef6a51f3c6.

Element_name: Nome da mensagem a ser utilizado. Exemplo: alerta1.

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

Tipo de componente: Neste bloco, devemos incluir todas as variáveis que a mensagem contiver.

Exemplo: Na mensagem abaixo, temos uma variável {{1}} que representa o nome do cliente:

"Olá, {{1}}! Somos da Hi Platform e gostaríamos de falar sobre os nossos canais de atendimento. Escreva 'quero saber mais' para falar com um de nossos representantes."

Assim, o bloco de Tipo de componente ficaria:

<contact>
      <phone></phone>
      <component type="body">
      <parameter type="text">Maria</parameter>
      </component>
   </contact>

XML de envio estrutura básica

<main> 
  <emkt trans="50.01">
  <remetente> </remetente>
  <namespace> </namespace>
  <element_name> </element_name>
  <contact>
      <phone></phone>
      
   </contact>
   (...)
  </emkt> 
</main>

XML de retorno:

<main>
  <emkt trans="50.01" KEY="0b2001e6503dd1acc0d47a8b43fd"> 
      <return>5c3ca43c-4ece-4018-8667-56384bbe5900</return> 
 </emkt> 
</main>

50.02 - Consultar os Status dos Envios

Aproveite esta integração para verificar se houve sucesso ou falha nos envios realizados por meio da integração 50.01.

XML de envio:

<main>
   <emkt trans="50.02"> 
     <codigo>5c3ca43c-4ece-4018-8667-56384bbe5900</codigo>  
  </emkt> 
</main>

O é o valor do campo informado na integração 50.01.

XML de Retorno:

<main>
  <emkt trans="40.03" KEY="09000114b58c4170d5657f4889a0">
    <item>
      <telefone>[TELEFONE DO DESTINATÁRIO]</telefone>
      <status>[STATUS DO ENVIO]</status>
     </item>
  </emkt>
 </main>

O campo status pode retornar um dos valores abaixo:
"FAILED" => "nao_enviados", // não enviados ou falha no envio
"READ" => "entregues_com_confirmacao", // entregues com leitura
"RECEIVED" => "entregues", // entregues
"SENT" => "enviado", // enviado para facebook
"DISPATCH" => "enviando", // enviando
"REPLIED" => "respondidos", // respondido