Resumo

O Wati oferece Interfaces de Programação de Aplicações (APIs) que permitem conectar o Wati aos seus sistemas existentes, automatizar mensagens, gerenciar contatos, executar campanhas e acessar outros recursos do Wati de forma programática.

Este guia fornece uma visão geral das APIs do Wati disponíveis, incluindo seus endpoints, versões de API suportadas e links para recursos adicionais para desenvolvedores.

Importante: A v3 é recomendada para todas as novas integrações. Os endpoints legados v1 e v2 permanecem disponíveis onde houver suporte.

Instruções

1. Entenda as versões e endpoints da API do Wati

Os endpoints da API do Wati usam formatos de URL diferentes, dependendo da versão da API.

URL base: https://live-mt-server.wati.io

Versão da API	Formato do caminho da URL	ID do inquilino (Tenant ID) necessário no caminho?
v3	`/api/ext/v3/...`	Não
v1	`/{tenantId}/api/v1/...`	Sim
v2	`/{tenantId}/api/v2/...`	Sim

Para endpoints v1 e v2, substitua {tenantId} pelo seu ID de inquilino (tenant ID) do Wati. Para endpoints v3, o ID do inquilino não é incluído no caminho da URL.

Use a v3 para novas integrações sempre que a operação necessária for suportada. Use os endpoints legados quando a operação necessária não estiver disponível na v3.

2. Criar um token de API

Você precisa de um token de API para autenticar solicitações aos endpoints da API do Wati.

Para criar um token de API:

Faça login na sua conta Wati.
Vá para Connector > API.
Selecione Create API Token.
Crie um token com as permissões apropriadas para as operações de API que você deseja realizar.

Para endpoints v3, selecione o escopo de token necessário:

Escopo do token	Usado para
`contactsv3:*`	Operações de contato
`conversationsv3:*`	Operações de conversação
`messagetemplatev3:write`	Envio de modelos de mensagem

Certifique-se de que seu token tenha o escopo necessário para o endpoint que você deseja usar.

3. Explore as APIs do Wati disponíveis

As seções a seguir agrupam as APIs do Wati por funcionalidade. Cada tabela lista as operações disponíveis e os caminhos de endpoint documentados.

3.1 API de Canais

Use a API de Canais para recuperar informações sobre seus números de WhatsApp conectados.

Operação	Método	Endpoint v3	Endpoint v1
Listar números de WhatsApp conectados	GET	`/api/ext/v3/channels`	`/{tenantId}/api/v1/whatsApp/phoneNumbers`

3.2 API de Mensagens

Use a API de Mensagens para enviar mensagens, recuperar o histórico de conversas e gerenciar conversas.

Operação	Método	Endpoint v3	Endpoint v1
Obter histórico de mensagens de um contato	GET	`/api/ext/v3/conversations/{target}/messages`	`/{tenantId}/api/v1/getMessages/{target}`
Enviar uma mensagem de texto de sessão	—	v3 disponível	`/{tenantId}/api/v1/sendSessionMessage/{whatsappNumber}`
Enviar um arquivo de sessão	—	v3 disponível	`/{tenantId}/api/v1/sendSessionFile/{whatsappNumber}`
Enviar um arquivo de sessão via URL	—	v3 disponível	`/{tenantId}/api/v1/sendSessionFileViaUrl/{whatsappNumber}`
Enviar uma mensagem de modelo	—	v3 disponível	`/{tenantId}/api/v1/sendTemplateMessage`
Enviar mensagens de modelo em massa	—	v3 disponível	`/{tenantId}/api/v1/sendTemplateMessages`
Enviar mensagens de modelo usando um arquivo CSV	POST	—	`/{tenantId}/api/v1/sendTemplateMessageCSV`
Enviar uma mensagem de botão interativo	—	v3 disponível	`/{tenantId}/api/v1/sendInteractiveButtonsMessage/{whatsappNumber}`
Enviar uma mensagem de lista interativa	—	v3 disponível	`/{tenantId}/api/v1/sendInteractiveListMessage/{whatsappNumber}`
Enviar uma mensagem de chamada para ação (CTA) URL interativa	POST	—	`/{tenantId}/api/v1/sendInteractiveCtaUrlMessage`
Atualizar status da conversa	PUT	`/api/ext/v3/conversations/{target}/status`	`/{tenantId}/api/v1/updateChatStatus`
Atribuir um operador a uma conversa	PUT	`/api/ext/v3/conversations/{target}/operator`	`/{tenantId}/api/v1/assignOperator`

Observações importantes:

A API de Obter Histórico de Mensagens recupera o histórico de conversas para um contato específico. Ela não recupera todas as mensagens recebidas pelo seu número de WhatsApp.
Uma resposta HTTP 200 bem-sucedida de uma API de envio de mensagens significa que a solicitação foi aceita. Isso não confirma que a mensagem foi entregue ao destinatário.
Use o evento de webhook sentMessageDELIVERED_v2 para rastrear a entrega da mensagem. O evento templateMessageFailed relata falhas no envio de mensagens.

3.3 API de Contatos

Use a API de Contatos para criar, recuperar, atualizar, excluir e organizar contatos no Wati.

Operação	Método	Endpoint v3	Endpoint v1
Listar contatos	GET	`/api/ext/v3/contacts`	`/{tenantId}/api/v1/getContacts`
Adicionar um contato	POST	`/api/ext/v3/contacts`	`/{tenantId}/api/v1/addContact/{whatsappNumber}`
Atualizar atributos de contato	PUT	`/api/ext/v3/contacts`	`/{tenantId}/api/v1/updateContactAttributes/{whatsappNumber}`
Atualizar múltiplos contatos	POST	—	`/{tenantId}/api/v1/updateContactAttributesForMultiContacts`
Obter detalhes do contato	GET	`/api/ext/v3/contacts/{target}`	—
Obter a contagem total de contatos	GET	`/api/ext/v3/contacts/count`	—
Excluir um contato	—	v3 disponível	—
Atribuir contatos a equipes	PUT	`/api/ext/v3/contacts/teams`	—

Requisito de plano: Atualizar múltiplos contatos por meio do endpoint v1 requer um plano Business.

3.4 API de Modelos de Mensagem

Use a API de Modelos de Mensagem para recuperar, criar e excluir modelos de mensagem do WhatsApp.

Operação	Método	Endpoint v3	Endpoint v1
Listar modelos de mensagem	GET	`/api/ext/v3/messageTemplates`	`/{tenantId}/api/v1/getMessageTemplates`
Obter um modelo por ID	GET	`/api/ext/v3/messageTemplates/{template_id}`	—
Criar um modelo	POST	—	`/{tenantId}/api/v1/whatsApp/templates`
Excluir um modelo	DELETE	—	`/{tenantId}/api/v1/whatsApp/templates/{wabaId}/{name}/{language}`

3.5 API de Campanhas

Use a API de Campanhas para recuperar informações de campanha, estimar custos de campanha e gerenciar transmissões agendadas.

Operação	Método	Endpoint v3	Endpoint v1
Listar campanhas	GET	`/api/ext/v3/broadcasts`	—
Obter detalhes da campanha	GET	`/api/ext/v3/broadcasts/{broadcast_id}`	—
Obter destinatários da campanha	GET	`/api/ext/v3/broadcasts/{broadcast_id}/recipients`	—
Obter visão geral da campanha	GET	`/api/ext/v3/broadcasts/overview`	—
Estimar custo da campanha	POST	`/api/ext/v3/broadcasts/estimate-cost`	—
Agendar uma campanha	POST	—	`/{tenantId}/api/v1/broadcast/scheduleBroadcast`
Excluir uma campanha agendada	DELETE	—	`/{tenantId}/api/v1/broadcast/deleteScheduledBroadcast/{broadcastId}`

3.6 API de Tags

Use a API de Tags para organizar conversas adicionando ou removendo tags.

Operação	Disponibilidade v3
Adicionar uma tag a uma conversa	Disponível
Remover uma tag de uma conversa	Disponível

Consulte a documentação da API Wati para os caminhos de endpoint relevantes e detalhes da solicitação.

3.7 API de Indicador de Digitação

Use a API de Indicador de Digitação para exibir um indicador de digitação para um contato durante uma sessão de mensagens ativa.

Operação	Disponibilidade v3
Enviar um indicador de digitação	Disponível

Consulte a documentação da API Wati para detalhes sobre o endpoint.

3.8 API de Chamadas

Use a API de Chamadas para recuperar registros de chamadas, gravações, transcrições e resumos.

Operação	Método	Endpoint v3
Obter registros de chamadas	GET	`/api/ext/v3/calls`
Obter uma gravação de chamada	GET	`/api/ext/v3/calls/{call_id}/recording`
Obter uma transcrição de chamada	GET	`/api/ext/v3/calls/{call_id}/transcript`
Obter um resumo de chamada	GET	`/api/ext/v3/calls/{call_id}/summary`
Recuperar múltiplas gravações, transcrições ou resumos	—	v3 disponível

Consulte a documentação da API Wati para detalhes sobre a solicitação para operações em lote.

3.9 API de Chatbots

Use a API de Chatbots para recuperar chatbots disponíveis e iniciar fluxos de chatbot.

Operação	Método	Endpoint v3	Endpoint v1
Listar chatbots	GET	`/api/ext/v3/chatbots`	`/{tenantId}/api/v1/chatbots`
Iniciar um chatbot	POST	`/api/ext/v3/chatbots/start`	`/{tenantId}/api/v1/chatbots/start`

Requisito de plano: A API de Chatbots requer um plano Pro ou Business.

3.10 API de Segmentos

Use a API de Segmentos para recuperar segmentos de contato, avaliar filtros de segmento e criar segmentos personalizados.

Operação	Método	Endpoint v3	Endpoint v1
Listar segmentos	GET	`/api/ext/v3/segments`	—
Obter um segmento	GET	`/api/ext/v3/segments/{segmentId}`	—
Avaliar filtros de segmento	—	v3 disponível	—
Criar um segmento personalizado	POST	—	`/{tenantId}/api/v1/createCustomSegment`

Requisito de plano: Criar um segmento personalizado por meio do endpoint v1 requer um plano Pro ou Business.

3.11 API de Gerenciamento de Webhooks

Webhooks permitem que o Wati envie notificações de eventos para uma URL que você configurar. Você pode usar a API de Gerenciamento de Webhooks para gerenciar assinaturas de webhook de forma programática.

Operação	Método	Endpoint v3	Endpoint v2
Listar assinaturas de webhook	GET	`/api/ext/v3/webhooks`	—
Obter uma assinatura de webhook	GET	`/api/ext/v3/webhooks/{id}`	—
Atualizar uma assinatura de webhook	PUT	`/api/ext/v3/webhooks/{id}`	—
Excluir uma assinatura de webhook	DELETE	`/api/ext/v3/webhooks/{id}`	—
Listar tipos de evento de webhook disponíveis	—	v3 disponível	—
Criar uma assinatura de webhook	POST	—	`/{tenantId}/api/v2/webhookEndpoints`

Para obter instruções sobre como configurar e lidar com eventos de webhook, consulte a Documentação de Webhooks do Wati.

3.12 API do Instagram

Use a API do Instagram para recuperar publicações e comentários do Instagram e responder a comentários.

Operação	Método	Endpoint v3
Listar publicações do Instagram	GET	`/api/ext/v3/posts`
Obter uma publicação do Instagram	GET	`/api/ext/v3/posts/{post_id}`
Listar comentários em uma publicação	GET	`/api/ext/v3/posts/{post_id}/comments`
Obter a contagem de comentários não lidos	GET	`/api/ext/v3/posts/{post_id}/unreadCount`
Responder a um comentário	POST	`/api/ext/v3/comments/{comment_id}/replies`
Enviar uma resposta privada a um comentário	POST	`/api/ext/v3/comments/{comment_id}/privateReply`

3.13 API de Créditos da Conta

Use a API de Créditos da Conta para verificar o saldo de créditos da sua conta Wati.

Operação	Método	Endpoint v3
Obter créditos da conta	GET	`/api/ext/v3/account/credits`

3.14 APIs de Gerenciamento de Mídia e Token

Use as APIs de Mídia para recuperar arquivos de mídia e a API de gerenciamento de token para bloquear um token de API.

Operação	Método	Endpoint v3	Endpoint v1
Obter mídia por nome de arquivo	GET	—	`/{tenantId}/api/v1/getMedia`
Obter mídia por ID de mensagem	GET	`/api/ext/v3/conversations/messages/file/{message_id}`	—
Bloquear um token	POST	—	`/{tenantId}/api/v1/rotateToken`

Importante: O endpoint v1 rotateToken bloqueia o token especificado. Ele não gera um token substituto. Para criar um novo token de API, vá para Connector > API > Create API Token em sua conta Wati.

3.15 Servidor de Protocolo de Contexto de Modelo (MCP)

O Wati fornece um servidor de Protocolo de Contexto de Modelo (MCP) que permite que ferramentas de IA e agentes se conectem diretamente aos recursos do Wati.

Para obter instruções de configuração, consulte a documentação para desenvolvedores do Wati.

4. Recursos adicionais

Use os recursos a seguir para explorar endpoints de API, configurar webhooks e testar solicitações de API.

Documentação da API Wati — Explore endpoints de API e detalhes de solicitação.
Documentação de Webhooks do Wati — Aprenda como configurar webhooks e lidar com notificações de eventos.
Coleção Postman do Wati — Encontre uma coleção para testar solicitações da API Wati usando o Postman.

5. Notas importantes sobre a API

Tenha em mente os seguintes pontos ao integrar com o Wati:

Escolha a versão da API correta: Use a v3 para novas integrações sempre que a operação necessária for suportada. Os endpoints legados v1 e v2 permanecem disponíveis onde documentados.
Use o formato de URL correto: Os endpoints v3 não incluem o ID do inquilino no caminho. Os endpoints v1 e v2 documentados incluem /{tenantId}/.
Use o escopo de token correto: Crie um token de API com as permissões necessárias para suas operações v3.
Verifique a entrega da mensagem separadamente: Uma resposta HTTP 200 bem-sucedida de um endpoint de envio de mensagens não confirma a entrega. Use o evento de webhook relevante para rastrear a entrega ou falha.
Entenda a rotação de token: O endpoint v1 rotateToken bloqueia um token em vez de criar um novo.

Para parâmetros específicos de endpoint, formatos de solicitação, respostas e exemplos, consulte a documentação da API Wati.

Visão geral das APIs do Wati