Passar para o conteúdo principal

Perguntas Frequentes Gerais: APIs & Webhooks do Wati

Resumo

Este artigo aborda perguntas comuns sobre o uso da API e webhooks do Wati, incluindo como adicionar contatos via API, onde encontrar seu token de API, como habilitar confirmações de leitura usando eventos de webhook e como gerenciar webhooks via API.

Importante: Os Webhooks Globais são suportados apenas para mensagens do WhatsApp. Para receber alertas ou acionar ações para mensagens do Instagram ou Facebook Messenger, use o nó de Webhook dentro de um fluxo de chatbot.

Perguntas Frequentes (FAQs)

1. Posso adicionar um contato via API?

Sim. Use um dos seguintes endpoints:

  • v3 (recomendado): POST https://live-mt-server.wati.io/api/ext/v3/contacts

  • v1 legado: POST https://live-mt-server.wati.io/{tenantId}/api/v1/addContact/{whatsappNumber}

A versão v3 é recomendada para todas as novas integrações. A versão v1 é legada, mas ainda é suportada.

2. Onde posso encontrar meu token de API do Wati?

Vá para Connector > API > Create API Token (Conector > API > Criar Token de API) em sua conta Wati. Você encontrará seu Token de Acesso e a URL do endpoint da API lá.

Para endpoints v3, crie um token com o escopo apropriado:

Escopo

Usado para

contactsv3:*

Operações de contato

conversationsv3:*

Operações de conversa

messagetemplatev3:write

Envio de templates

3. Como habilito as confirmações de leitura?

Habilite o evento de webhook sentMessageREAD_v2 para receber um callback quando uma mensagem enviada por você for lida pelo destinatário.

Para configurar isso:

  • Vá para Connector > Webhooks na sua conta Wati.

  • Adicione sua URL de webhook.

  • Habilite o evento sentMessageREAD_v2.

Os webhooks do Wati podem notificá-lo via URL de callback sobre o seguinte:

  • Mensagens recebidas

  • Mensagens enviadas (Template e Sessão)

  • Atualizações de status de mensagem (Enviada / Entregue / Lida)

sentMessageREAD_v2 — Exemplo de Payload

{
"eventType": "sentMessageREAD_v2",
"statusString": "Read",
"id": "1a2b3b4d5e6f7g8h9i10j",
"localMessageId": "...",
"whatsappMessageId": "abcdefghi_jklmnop",
"conversationId": "a1b2c3d4e5f6g7h8i9j10",
"ticketId": "m1n2o3p4q5r6s7t8u9v10",
"channelId": "...",
"channelPhoneNumber": "85264318722",
"text": null,
"type": "template",
"timestamp": "1665645642",
"assigneeId": null,
"operatorEmail": "[email protected]",
"bsuid": "...",
"parentBsuid": "...",
"username": "..."
}

Variantes de evento BSUID

O Wati suporta variantes _bsuid de eventos de webhook. Esses payloads incluem os campos bsuid, parentBsuid e username para identificar contatos pelo seu BSUID — útil quando os contatos são referenciados pelo BSUID no seu sistema em vez do número de telefone.

4. Como gerencio webhooks via API?

Você pode criar, listar, atualizar e excluir webhooks programaticamente.

Criar um webhook (v2):

POST https://live-mt-server.wati.io/{tenantId}/api/v2/webhookEndpoints

Listar, obter, atualizar e excluir webhooks (v3 — recomendado):

https://live-mt-server.wati.io/api/ext/v3/webhooks

O gerenciamento de webhooks v3 não inclui /{tenantId}/ no caminho. A v3 é recomendada para todas as novas integrações.

Para detalhes completos, consulte a Documentação de Webhooks do Wati.

Respondeu à sua pergunta?