Aqui aprenderemos como usar a API Botmaker para ativar notificações do WhatsApp através de uma integração.

Leitura estimada: 10 minutos

Como obter credenciais para acessar a API?

Se você não tiver credenciais da API Botmaker para o seu projeto, precisará obter um token de acesso seguindo estas etapas:

• Vá para Configurações>Integrações>API Botmaker.
• Gere as credenciais ou use uma já gerada.
• Insira o token de acesso no cabeçalho da sua solicitação HTTP.

Ao clicar em Botmaker API Docs, você será redirecionado para o Botmaker API swagger para aprender e testar todos os módulos da API.

Modelos de mensagens do WhatsApp

O WhatsApp permite que empresas enviem mensagens até 24 horas após a última mensagem enviada pelo usuário. Fora desse período, a empresa deverá utilizar modelos de mensagens para retomar a conversa. Para submeter novos modelos para aprovação, você pode acessar Menu > Mecanismo de Notificações > Modelos. Aqui você pode criá-los clicando“+”" na parte superior da tela.

Para obter informações detalhadas sobre a criação de modelos do WhatsApp, consulte nosso artigo relacionado.Como criar modelos de WhatsApp através do Notifications Engine?

Assim que o modelo for aprovado (você pode verificá-lo em Menu > Mecanismo de Notificações > Modelos), você pode ativar esse modelo por meio da API.

Envio de modelos usando a API intent/v2 do Botmaker.

Campos de API

• chatPlataforma - será sempre “Whatsapp”;
• chatChannelNumber - corresponde ao WhatsApp de origem da notificação, ou seja, o WhatsApp da sua empresa;
• plataformaContactId - corresponde ao número do WhatsApp do destinatário, ou seja, seu nome de usuário. Não esqueça de incluir sempre o DDI e o DDD;
• regraNameOrId - corresponde ao nome do seu modelo;
• parâmetros - corresponde às variáveis ​​do seu template.

Exemplo de chamada

curl -X POST --header 'Tipo de conteúdo: aplicativo/json' --header 'Aceitar: aplicativo/json' --header 'token de acesso: token' -d '{ \

   "chatPlatform": "whatsapp", \

   "chatChannelNumber": "551132303506", \

   "plataformaContactId": "5511983812119",\

   "ruleNameOrId": "confirmacao_pedido", \ 

   "clientPayload": "string", \

   "params": {"nome":"Gabriel", "nroPedido":"11234", "totalPedido":"R$ 404,00", "nroBoleto":"1232131232131"} \ 

 }' 'https://go.botmaker.com/api/v1.0/intent/v2'

Se o seu modelo contiver um cabeçalho de mídia, adicione os seguintes parâmetros em parâmetros:

Documento

• headerDocumentUrl: corresponde a uma URL pública onde seu documento está hospedado;
• headerDocumentCaption: corresponde ao nome do documento que será apresentado ao usuário.

Imagem

• headerImageUrl: corresponde a uma URL pública onde sua imagem está hospedada;

Vídeo

• headerImageUrl: corresponde a uma URL pública onde seu vídeo está hospedado. Preste atenção ao limite de 16MB imposto pelo WhatsApp.

Escrito pela equipe Botmaker

Atualizado em: 05/02/2024