Contatos cadastrados automaticamente via API da Becon

Usando nossas APIs públicas, você poderá integrar seus sistemas com a sua conta da Becon WhatsApp e salvar Contatos do seu novo número oficial direto naqueles sistemas.

Visão Geral

Está na hora de ter Contatos cadastrados automaticamente via API, integrando sua conta da Becon WhatsApp à sua operação, mais especificamente, ao seu sistema preferido. Alimente sistemas, seu CRM, controles internos facilmente adicionando um contato que te procurou no número oficial da Becon.

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. Verificando se o Contato existe

a. Para começarmos, você deverá obter o companyId e o phonenumberId no menu Desenvolvedor -> Dicionários de IDs – conforme o Passo 1 acima;

b. Na url da api informe o endereço do seu servidor, no seguinte formato:

https://<Seu sub-dominio>.becon.com.br/wserver/rest/contact/[COMPANY_ID]/[PHONENUMBER_ID]/contactWaIdOrCreate

c. Só para exemplificar, se a ACME fosse cliente da Becon, o endereço dela seria assim: https://acme.becon.com.br/wserver/rest/contact/123/456/contactWaIdOrCreate

d. Os campos devem ser enviados no padrão  x-www-form-urlenconded;

e. Os seguintes parâmetros são aceitos pela API:

i. Authorization (Obrigatório): Deve ser enviado no cabeçalho da requisição com a constante ‘Bearer’ na frente;

ii. countryNumber (Obrigatório): Código do país do número desejado. Por exemplo: 55 pra o Brasil;

iii. phonenumber (Obrigatório): Numero de telefone do contato desejado, composto por DDD + número. Por exemplo: 47984124491

e. Segue abaixo um exemplo em curl:

curl --location --request POST 'https://acme.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/d6158e66-6282-4612-914a-4ba43a13d569/contactWaIdOrCreate' \
--header 'Authorization: Bearer 9fd60151-cbc0-400e-be7c-8d338be50406' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'countryNumber=55' \
--data-urlencode 'phonenumber=47984124491'

f. Por fim, existem dois potenciais retornos para este caso:

i. HTTP 200 – No conteúdo será retornado o waId do telefone, sendo o identificador único do contato no whatsapp. O contato será salvo na plataforma para uso futuro;

ii. HTTP 404 – O Número informado, mesmo que válido, não existe no Whatsapp. Isso por acontecer com números bloqueados, ou simplesmente que não possuem uma conta no WhatsApp.

Passo 3. Obtenha o id do contato na plataforma da Becon

a. Novamente, para começarmos, você deverá obter o companyId e o phonenumberId no menu Desenvolvedor -> Dicionários de IDs – conforme o Passo 1 acima;

b. Novamente na url da api informe o endereço do seu servidor, no seguinte formato:

https://<Seu sub-dominio>.becon.com.br/wserver/rest/contact/[COMPANY_ID]/[WAID]/contactByWaId

c. Só para exemplificar, se a ACME fosse cliente da Becon, o endereço dela seria assim: https://acme.becon.com.br/wserver/rest/contact/123]/455547984124491/contactByWaId

d. Segue abaixo um exemplo em curl:

curl --location --request GET 'https://acme.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/5547984124491/contactByWaId' \
--header 'Authorization: Bearer 9fd60151-cbc0-400e-be7c-8d338be50406'

e. O retorno dessa chamada deverá ser:

{“data”:{“contactId”:”1bc0c0ae-5bd5-4fa7-8f46-a8261d58219c”,”companyId”:”e8431a56-2d10-434c-995b-aee08390650d”,”name”:”Lucas”,”waId”:”5547984124491″,”email”:””,”status”:0,”propertyCount”:1,”createdTime”:0,”userIdCreator”:”d6158e66-6282-4612-914a-4ba43a13d569″}}

f. A partir de agora, considere o id do contato na plataforma da Becon, para fins de integrações outras, como sendo o atributo contactId.

Passo 4. Altere o nome e/ou propriedades de Contatos cadastrados automaticamente

Passo 4.1. Alterar nome do Contato

a. Para alterar o nome do Contato cadastrado automaticame, você deverá obter os dados abaixo:

i. companyId: No menu Desenvolvedor, opção Dicionários de IDs;

ii. contactId: Conforme ensinado acima, no passo 3.

b. Novamente na url da api informe o endereço do seu servidor, no seguinte formato:

https://<Seu sub-dominio>.becon.com.br/wserver/rest/contact/[COMPANY_ID]/[CONTACT_ID]/name

c. Usando nossa fiel cliente ACME como exemplo, o endereço dela seria assim: https://acme.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/1bc0c0ae-5bd5-4fa7-8f46-a8261d58219c/name

d. Os campos devem ser enviados no padrão  x-www-form-urlenconded;

e. Os seguintes parâmetros são aceitos pela API:

i. Authorization (Obrigatório): Deve ser enviado no cabeçalho da requisição com a constante ‘Bearer’ na frente;

ii. name (Obrigatório): O novo nome do contato.

f. Segue abaixo um exemplo em curl:

curl --location --request POST 'https://wadev.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/1bc0c0ae-5bd5-4fa7-8f46-a8261d58219c/name' \
--header 'Authorization: Bearer 9fd60151-cbc0-400e-be7c-8d338be50406' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=My new name'

Passo 4.2. Alterar uma propriedade do Contato

a. Para alterar o nome do Contato cadastrado automaticame, você deverá obter os dados abaixo:

i. companyId: No menu Desenvolvedor, opção Dicionários de IDs;

ii. contactId: Conforme ensinado acima, no passo 3.

iii. propertyName; Em Configurações, selecione a opção Propriedades

b. Novamente na url da api informe o endereço do seu servidor, no seguinte formato:

https://<Seu sub-dominio>.becon.com.br/wserver/rest/contact/[COMPANY_ID]/[WAID]/propertyData

c. Usando nossa fiel cliente ACME como exemplo, o endereço dela seria assim: https://acme.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/1bc0c0ae-5bd5-4fa7-8f46-a8261d58219c/propertyData

d. Os campos devem ser enviados no padrão  x-www-form-urlenconded;

e. Os seguintes parâmetros são aceitos pela API:

i. Authorization (Obrigatório): Deve ser enviado no cabeçalho da requisição com a constante ‘Bearer’ na frente;

ii. propertyName (Obrigatório): O nome da propriedade escolhida;

iii. propertyValue (Obrigatório): O valor que você quer atribuir à propriedade escolhida.

f. Segue abaixo um exemplo em curl:

curl --location --request POST 'https://wadev.becon.com.br/wserver/rest/contact/e8431a56-2d10-434c-995b-aee08390650d/1bc0c0ae-5bd5-4fa7-8f46-a8261d58219c/name' \
--header 'Authorization: Bearer 9fd60151-cbc0-400e-be7c-8d338be50406' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'propertyName=sabores' \
--data-urlencode 'propertyValue=Palmito'

Passo 5. 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 levar contatos que te procuram em seu número oficial de WhatsApp, direto para esses sistemas!

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.