Envio de HSM

Saiba como configurar e como funciona a criação de template HSM

Introdução

Você pode encontrar sua lista de Templates HSM indo em Configurações / Canal / Templates HSM. Em seguida você terá a listagem dos modelos que você possue, mas lembre-se que para visualizar o exemplo de payload é necessário que seu módulo API ou Notificação esteja habilitado e essa funcionalidade está disponível apenas para canais oficiais.

Abaixo mostraremos como criar seus templates e seus pontos importantes de preenchimento.

Visualização de exemplo de payload

Criando template

Para criar um novo clique em Adicionar template.Listagem de templatesEm seguida você verá esta tela.Tela de criação

​✉Blocos das Mensagem

As mensagens HSM são compostas por campos importantes(Cabeçalho, Corpo, Rodapé e botões), onde cada um possui características de preenchimento único. Atente-se para evitar futuros imprevistos.

Cabeçalho

Seu cabeçalho pode ser do tipo texto, imagem, vídeo ou documento. Lembre-se que para inserir variável e texto é somente possível quando o tipo do cabeçalho for texto.Cabeçalho do template

Corpo

O corpo de seu template é composto por texto livre e com 4 variáveis. Não se esqueça de deixar sua mensagem principal nessa seção 😉.Corpo do template

Rodapé

O rodapé de seu template é simples, ele é composto apenas por texto livre.Rodapé do template

Botões

A seção de botões é composta por dois tipos: Call to action e Resposta rápida.Call to actionO tipo Call to action te permite inserir até dois botões, um botão de telefone com apenas texto livre e um botão de url com texto livre e uma variável.Call to actionResposta rápidaO tipo Resposta rápida te permite inserir até três botões, ambos com texto livre e sem a possibilidade de inserir variáveis.Resposta rápida

Send HSM API

POST https://{SUBDOMAIN}.brpex.com/api/v1 /send-hsm

Utilize esse método sempre que quiser enviar uma mensagem contendo um texto simples via WhatsApp para um determinado contato.

Headers

Name	Type	Description
token*	String	As tokens são geradas na configuração do canal.

Request Body

Name	Type	Description
text*	String	O texto que deseja enviar
phone*	String	Número no formato internacional (DDI + DDD + Número). Exemplo: 5511988887777.

200: OK Mensagem recebida para fila de envios.

{
  "message": "success"
}

401: Unauthorized Erro de autenticação. Verifique o token informado

{
"message": "unauthorized" 
}

422: Unprocessable Entity Informações insuficientes. Você precisa enviar todos os dados obrigatórios

{
    // Response
}