Carregando...

Controle de Envio de HSM (Whatsapp)

Disparo de mensagens de HSM (Whatsapp)

 

As integrações desse grupo permitem o disparo de uma mensagem de HSM, assim como a consulta do status do envio.

 

50.01 - Enviar Mensagem

 

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

XML de Envio:

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

*Itens em negrito são obrigatórios.

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

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.

Namespace: Código da mensagem que será utilizada no envio. Exemplo: cd551e83_8455_45fd_a2ff_35ef6a51f3c6.

Element_name: Nome da mensagem que será utilizada. Exemplo: alerta1.

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

Component type: Nesse bloco devemos colocar todas as variáveis que a mensagem contiver.

Exemplo:

Na mensagem abaixo temos uma variável {{1}} que seria 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.

Sendo assim o bloco do Component type ficaria:

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

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

 

Utilize essa integração para consultar se houve sucesso ou falha nos envios efetuadas com a integração 50.01

XML  de Envio:

<main>
   <emkt trans="50.02"> 
     <codigo>5c3ca43c-4ece-4018-8667-56384bbe5900</codigo>  
  </emkt> 
</main>
*Itens em negrito são obrigatórios.

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

XML de Retorno:

<main>
  <emkt trans="40.03" KEY="09000114b58c4170d5657f4889a0">
    <item>
      <telefone>[TELEFONE DO DESTINATÁRIO]</telefone>
      <status>[MENSAGEM ENVIADA PELO DESTINATÁRIO]</status>
     </item>
  </emkt>
 </main>
Este conteúdo foi útil?30