Nesta documentação, mostro como fazer o envio de templates por chamada API da Becon, incluindo o passo a passo de como gerar o código curl, executar em um terminal e ver o log dentro da plataforma.

Para executar o código e transferir as informações pela Integração por chamada API com a Becon, utilizamos o Curl, que é uma ferramenta de linha de comando e biblioteca para transferência de dados com URLs, muito utilizado nos scripts de integração de sistemas.

No exemplo para esta integração, mostro como usar a opção “/simple/sendTemplate” da API pública da Becon, que pode ser consultado no link de exemplo: https://subdominio.becon.com.br/wserver/public

Nota: substitua a palavra “subdominio” no link, pelo que foi criado na Becon.

Exemplo de API pública em um subdomínio para Integração por chamada API.

 

Chave ID

É preciso copiar ou gerar uma chave de API para que seja autorizado na chamada de API. Caso não saiba como gerar ou copiar, clique aqui para ser redirecionado ao artigo.

Nome do template

No exemplo desta documentação, irei utilizar o nome do template na chamada API e para copiar o nome na plataforma da Becon, acesse o menu “Automações”, depois na opção “Templates” e copie o nome do template que será utilizado na coluna “Nome do template”.

Nome do template para envio de templates por chamada API.

/simple/sendTemplate

Para encaminhar o template pela chamada API, neste exemplo utilizo a opção “/simple/sendTemplate”, disponível no subdomínio da Becon.

.Opção "/simple/sendTemplate" para envio de templates por chamada API.

Clique no botão “Try it out”  para que seja liberado o preenchimento de alguns campos.

Será necessário preencher algumas informações para que a mensagem seja enviado, tudo que tiver com asterisco ( “*”) são campos obrigatórios a serem preenchidos, mas mostrei mais dois que serão úteis.

Preencha os campos obrigatórios a seguir:

apiKey – informe o chave API criado na plataforma da Becon;

template – informe o nome do template que será utilizado para o envio da mensagem;

contact – informe o número de telefone que será encaminhado a mensagem.
Informações obrigatórias para envio de templates por chamada API.
Caso o template escolhido tenha uma ou mais propriedades no texto, utilize o “paramList” para criar uma lista de parâmetros, cujo os valores têm que ser separados por ponto e vírgula (“;”). Para este exemplo, as propriedades do template serão preenchidas com os valores “Ewerton” e “Morais”.

parmList para envio de templates por chamada API.

A opção “closeAfterSend” com o seu valor “0”, é utilizado para que o contato apareça com o status “Expirado” no atendimento. Caso não tenha necessidade, pode ignorar esta opção.

closeAfterSend para envio de templates por chamada API.

Campos preenchidos, clique no botão “Execute”, para que o sistema gere o código curl.

Copie o código curl gerado pelo sistema.

Cole o código curl em um terminal e execute para realizar o teste de envio de template por chamada API.

Poderá acompanhar o log da chamada API acessando o menu “Desenvolvedor”, opção “Logs da API”.

Caso a mensagem seja encaminhada com sucesso, poderá verificar no log o status 200 em verde.

O código gerado pela plataforma da Becon, poderá ser usado em sistemas que utilizam chamadas de API para integração ou em scripts.