Envie Templates automaticamente via API da Becon

Usando nossas APIs públicas, você poderá integrar seus sistemas com a sua conta da Becon WhatsApp e enviar templates automaticamente, com o conteúdo que for necessário.

Visão Geral

Está na hora de enviar templates automaticamente via API, integrando sua conta da Becon WhatsApp à sua operação, mais especificamente, ao seu sistema preferido.

Nossas mais calorosas boas vindas, se for sua primeira vez, ou então é sempre um prazer ajudar, caso esteja apenas refazendo alguma configuração. Sem mais delongas, vamos ao guia que você está procurando!

Premissas:

Índice

Passo 1. Obtendo os dados da plataforma Becon WhatsApp 

a. Acesse sua plataforma Becon Whatsapp;

b. No menu superior, clique em Desenvolvedor e em seguida em Chaves de API;

i. Clique em adicionar Chave de API;

ii. Informe o nome e a descrição da chave;

  • Neste exemplo vamos chamar de Integração via Pluga ambos os campos.
Desenvolvedor > Chaves de API

 

iii. Após criar, você será redirecionado para a listagem de API. Copie o código do Token e salve para utilizar na sequência;

Id necessário para que envie templates automaticamente via API.

Passo 2. Escolhendo o Template

a. Em Automações, no menu superior, clique em Templates e no template que deseja usar, clique no título ou em “Visualizar Template”;

b. Você irá verificar que existem dois atributos que são necessários para o envio das mensagens – daqui em diante, os chamaremos de “propriedades”. Eles podem ser facilmente identificados por estarem entre chaves. Neste nosso exemplo, as propriedades são {name} e {sabores};

c. Propriedades são customizações das mensagens com o objetivo que cada envio tenha um conteúdo único e/ou mais personalizado;

d. Salve o título (ou também “id”) do template para ser utilizado na integração. No caso do exemplo será ‘exemplo_sabores’.

e. Agora você tem todos os dados necessários para criar no Pluga.

Visualizando template

Passo 3. Enviando o Template automaticamente via API

a. Agora, na URL da API, informe o endereço do seu servidor, no seguinte formato:

https://<Seu sub-dominio>.becon.com.br/wserver/rest/simple/sendTemplate

b. Só para exemplificar, se a ACME fosse cliente da Becon, o endereço dela seria assim: https://acme.becon.com.br/wserver/rest/simple/sendTemplate

c. Os campos devem ser enviados no padrão form-data;

d. Ainda, os seguintes parâmetros são aceitos pela API:

i. apiKey (Obrigatório): Código da API coletado anteriormente – Passo 1;

ii. contact: (Obrigatório): Número do telefone do contato;

iii. Template (Obrigatório): Nome ou id do Template – conforme Passo 2;

iv. paramList (Opcional): Deve ser informado separado por ponto-e-vírgula (“;”) de acordo com as propriedades existentes no template;

v. department (Opcional): Id do departamento que será direcionado o contato caso ele responda a mensagem.

  • Pode ser obtido no menu desenvolvedor -> Dicionário de Ids;

vi. closeAfterSend (Opcional): Informação binária que define se o atendimento ficará na caixa de entrada como expirado ou ficará como finalizado.

e. Segue abaixo um exemplo em curl:

curl --location --request POST 'https://acme.becon.com.br/wserver/rest/simple/sendTemplate' \
--form 'apiKey="9fd60151-cbc0-400e-be7c-8d338be50406"' \
--form 'contact="47996512877"' \
--form 'template="exemplo_sabores"' \
--form 'paramList="Lucas;Alho e brócolis"'

f. Por fim, caso a API retorne o erro 400, o número não existe no WhatsApp.

{“data”:”Contact 5547996512812 not exists at Whatsapp”}

Passo 4. Logs da API

a. Pelo relatório de API, toda API autenticada com sucesso ficará no registro por até 90 (noventa) dias para sua revisão/auditoria;

b. Para acessar esse relatório, autentique-se na plataforma, acessando o seu subdomínio, e então acesse a opção Desenvolvedor, no menu superior, e em seguida, Logs de API, no menu lateral:

Envie templates automaticamente via API, e audite os envios e erros desse novo processo.
Audite sua mais nova integração!

c. A resposta enviada pelo servidor também será armazenada.

PARABÉNS!

Ao seguir o nosso manual, você poderá integrar qualquer sistema da sua operação com sua conta da Becon WhatsApp, e assim enviar Templates automáticos via API, facilitando seu trabalho, otimizando suas rotinas e criando uma experiência ainda mais incrível e com mais qualidade para seus clientes!

Escrito por:

Philippe Silveira

Philippe Silveira

Auto-proclamado desenhista, escritor, contador de histórias, sonhador, e nascido brasileiro, hoje também é responsável por Sucesso do Cliente na Becon,

últimos posts

A Becon quer ajudar você a conseguir Leads qualificados, de forma orgânica, prontos para mexerem o ponteiro das suas estratégias de marketing online e offline. A Becon é sua parceira para tudo isso – e de acordo com a LGPD e o Marco Civil da Internet.