# ZapData API

> API de WhatsApp com mensagens, grupos e ligações de voz. Documentação em PT-BR.

## Fontes

- [Guia completo (Markdown)](https://docs.zapdata.dev/guia.md)
- [OpenAPI 3.1 (YAML)](https://docs.zapdata.dev/openapi.yaml)
- [Guia e resumo de cada endpoint, num arquivo só](https://docs.zapdata.dev/llms-full.txt)

## Guia

- [Começo rápido](https://docs.zapdata.dev/#/guia/comeco-rapido)
- [Chaves](https://docs.zapdata.dev/#/guia/chaves)
- [Números e conexão](https://docs.zapdata.dev/#/guia/numeros)
- [Webhooks](https://docs.zapdata.dev/#/guia/webhooks)
- [Mensagens](https://docs.zapdata.dev/#/guia/mensagens)
- [Chats, contatos e grupos](https://docs.zapdata.dev/#/guia/chats)
- [Ligações](https://docs.zapdata.dev/#/guia/ligacoes)
- [Erros](https://docs.zapdata.dev/#/guia/erros)
- [Limites](https://docs.zapdata.dev/#/guia/limites)

## Contas

- [POST /v1/accounts](https://docs.zapdata.dev/#/endpoint/POST/v1/accounts): Criar conta (administrador)
- [GET /v1/accounts/{id}](https://docs.zapdata.dev/#/endpoint/GET/v1/accounts/{id}): Ver conta

## Números

- [POST /v1/instances](https://docs.zapdata.dev/#/endpoint/POST/v1/instances): Criar número
- [GET /v1/instances](https://docs.zapdata.dev/#/endpoint/GET/v1/instances): Listar números da conta
- [GET /v1/instances/{id}](https://docs.zapdata.dev/#/endpoint/GET/v1/instances/{id}): Ver número
- [DELETE /v1/instances/{id}](https://docs.zapdata.dev/#/endpoint/DELETE/v1/instances/{id}): Apagar número
- [GET /v1/instances/{id}/status](https://docs.zapdata.dev/#/endpoint/GET/v1/instances/{id}/status): Status do número
- [POST /v1/instances/{id}/connect](https://docs.zapdata.dev/#/endpoint/POST/v1/instances/{id}/connect): Conectar (QR, código ou retomar)
- [POST /v1/instances/{id}/disconnect](https://docs.zapdata.dev/#/endpoint/POST/v1/instances/{id}/disconnect): Desconectar (sair do aparelho)
- [PUT /v1/instances/{id}/proxy](https://docs.zapdata.dev/#/endpoint/PUT/v1/instances/{id}/proxy): Definir proxy do número
- [GET /v1/instances/{id}/settings](https://docs.zapdata.dev/#/endpoint/GET/v1/instances/{id}/settings): Ver configurações
- [PUT /v1/instances/{id}/settings](https://docs.zapdata.dev/#/endpoint/PUT/v1/instances/{id}/settings): Mudar configurações

## Webhook

- [PUT /v1/instances/{id}/webhook](https://docs.zapdata.dev/#/endpoint/PUT/v1/instances/{id}/webhook): Definir webhook
- [GET /v1/instances/{id}/webhook](https://docs.zapdata.dev/#/endpoint/GET/v1/instances/{id}/webhook): Ver webhook
- [POST /v1/instances/{id}/webhook/retry](https://docs.zapdata.dev/#/endpoint/POST/v1/instances/{id}/webhook/retry): Reenviar os que falharam

## Mensagens

- [POST /v1/messages/text](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/text): Enviar texto
- [POST /v1/messages/media](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/media): Enviar mídia
- [POST /v1/messages/location](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/location): Enviar localização
- [POST /v1/messages/contact](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/contact): Enviar contato
- [POST /v1/messages/poll](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/poll): Enviar enquete
- [POST /v1/messages/buttons](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/buttons): Enviar botões
- [POST /v1/messages/list](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/list): Enviar lista
- [POST /v1/messages/carousel](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/carousel): Enviar carrossel
- [POST /v1/messages/pix](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/pix): Enviar botão PIX
- [POST /v1/messages/payment-request](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/payment-request): Enviar cobrança

## Ações na mensagem

- [POST /v1/messages/{msg}/react](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/{msg}/react): Reagir
- [POST /v1/messages/{msg}/edit](https://docs.zapdata.dev/#/endpoint/POST/v1/messages/{msg}/edit): Editar
- [DELETE /v1/messages/{msg}](https://docs.zapdata.dev/#/endpoint/DELETE/v1/messages/{msg}): Apagar para todos
- [GET /v1/messages/{msg}/media](https://docs.zapdata.dev/#/endpoint/GET/v1/messages/{msg}/media): Baixar mídia recebida

## Chats e contatos

- [POST /v1/chats/{jid}/read](https://docs.zapdata.dev/#/endpoint/POST/v1/chats/{jid}/read): Marcar como lida
- [POST /v1/chats/{jid}/presence](https://docs.zapdata.dev/#/endpoint/POST/v1/chats/{jid}/presence): Mostrar "digitando" ou "gravando"
- [POST /v1/chats/{jid}/history](https://docs.zapdata.dev/#/endpoint/POST/v1/chats/{jid}/history): Pedir mensagens antigas ao celular
- [POST /v1/contacts/check](https://docs.zapdata.dev/#/endpoint/POST/v1/contacts/check): Quais números têm WhatsApp
- [GET /v1/contacts/{jid}](https://docs.zapdata.dev/#/endpoint/GET/v1/contacts/{jid}): Ver contato

## Grupos

- [GET /v1/invites/{code}](https://docs.zapdata.dev/#/endpoint/GET/v1/invites/{code}): Ver grupo de um convite (sem entrar)
- [POST /v1/invites/{code}/join](https://docs.zapdata.dev/#/endpoint/POST/v1/invites/{code}/join): Entrar no grupo pelo convite
- [POST /v1/groups](https://docs.zapdata.dev/#/endpoint/POST/v1/groups): Criar grupo
- [GET /v1/groups](https://docs.zapdata.dev/#/endpoint/GET/v1/groups): Listar grupos
- [GET /v1/groups/{jid}](https://docs.zapdata.dev/#/endpoint/GET/v1/groups/{jid}): Ver grupo
- [PATCH /v1/groups/{jid}](https://docs.zapdata.dev/#/endpoint/PATCH/v1/groups/{jid}): Mudar grupo
- [PUT /v1/groups/{jid}/photo](https://docs.zapdata.dev/#/endpoint/PUT/v1/groups/{jid}/photo): Trocar foto
- [DELETE /v1/groups/{jid}/photo](https://docs.zapdata.dev/#/endpoint/DELETE/v1/groups/{jid}/photo): Tirar foto
- [POST /v1/groups/{jid}/participants](https://docs.zapdata.dev/#/endpoint/POST/v1/groups/{jid}/participants): Adicionar, remover, promover ou rebaixar
- [POST /v1/groups/{jid}/invite](https://docs.zapdata.dev/#/endpoint/POST/v1/groups/{jid}/invite): Link de convite
- [GET /v1/groups/{jid}/requests](https://docs.zapdata.dev/#/endpoint/GET/v1/groups/{jid}/requests): Pedidos de entrada
- [POST /v1/groups/{jid}/requests](https://docs.zapdata.dev/#/endpoint/POST/v1/groups/{jid}/requests): Aprovar ou recusar pedidos
- [POST /v1/groups/{jid}/leave](https://docs.zapdata.dev/#/endpoint/POST/v1/groups/{jid}/leave): Sair do grupo

## Etiquetas e perfil

- [GET /v1/labels](https://docs.zapdata.dev/#/endpoint/GET/v1/labels): Listar etiquetas (WhatsApp Business)
- [POST /v1/labels](https://docs.zapdata.dev/#/endpoint/POST/v1/labels): Criar, mudar ou apagar etiqueta
- [PUT /v1/chats/{jid}/labels](https://docs.zapdata.dev/#/endpoint/PUT/v1/chats/{jid}/labels): Pôr ou tirar etiquetas de um chat
- [PUT /v1/profile/name](https://docs.zapdata.dev/#/endpoint/PUT/v1/profile/name): Trocar o nome do perfil
- [PUT /v1/profile/photo](https://docs.zapdata.dev/#/endpoint/PUT/v1/profile/photo): Trocar ou tirar a foto do perfil

## Ligações

- [POST /v1/calls](https://docs.zapdata.dev/#/endpoint/POST/v1/calls): Ligar
- [GET /v1/calls](https://docs.zapdata.dev/#/endpoint/GET/v1/calls): Listar ligações
- [GET /v1/calls/{call}](https://docs.zapdata.dev/#/endpoint/GET/v1/calls/{call}): Ver ligação
- [POST /v1/calls/{call}/hangup](https://docs.zapdata.dev/#/endpoint/POST/v1/calls/{call}/hangup): Desligar
- [POST /v1/calls/{call}/answer](https://docs.zapdata.dev/#/endpoint/POST/v1/calls/{call}/answer): Atender ligação recebida
- [POST /v1/calls/{call}/reject](https://docs.zapdata.dev/#/endpoint/POST/v1/calls/{call}/reject): Recusar ligação recebida
- [POST /v1/calls/{call}/webrtc](https://docs.zapdata.dev/#/endpoint/POST/v1/calls/{call}/webrtc): Lado do navegador (modo browser)
- [POST /v1/calls/{call}/takeover](https://docs.zapdata.dev/#/endpoint/POST/v1/calls/{call}/takeover): Humano assume
- [GET /v1/calls/{call}/stream](https://docs.zapdata.dev/#/endpoint/GET/v1/calls/{call}/stream): Áudio ao vivo (WebSocket, modo stream)
- [GET /v1/calls/{call}/recording](https://docs.zapdata.dev/#/endpoint/GET/v1/calls/{call}/recording): Gravação
- [GET /v1/calls/{call}/transcript](https://docs.zapdata.dev/#/endpoint/GET/v1/calls/{call}/transcript): Transcrição

## Agentes de voz

- [POST /v1/voice-agents](https://docs.zapdata.dev/#/endpoint/POST/v1/voice-agents): Criar agente
- [GET /v1/voice-agents](https://docs.zapdata.dev/#/endpoint/GET/v1/voice-agents): Listar agentes
- [GET /v1/voice-agents/{agent}](https://docs.zapdata.dev/#/endpoint/GET/v1/voice-agents/{agent}): Ver agente
- [PUT /v1/voice-agents/{agent}](https://docs.zapdata.dev/#/endpoint/PUT/v1/voice-agents/{agent}): Mudar agente
- [DELETE /v1/voice-agents/{agent}](https://docs.zapdata.dev/#/endpoint/DELETE/v1/voice-agents/{agent}): Apagar agente

## Sistema

- [GET /healthz](https://docs.zapdata.dev/#/endpoint/GET/healthz): Saúde do servidor

## Webhooks

- [connection.update](https://docs.zapdata.dev/#/webhook/connection.update): Conexão mudou, QR novo ou código de pareamento
- [message.received](https://docs.zapdata.dev/#/webhook/message.received): Mensagem recebida
- [message.sent](https://docs.zapdata.dev/#/webhook/message.sent): Mensagem enviada pelo número (por esta API ou pelo celular)
- [message.status](https://docs.zapdata.dev/#/webhook/message.status): Entregue, lida, ouvida ou falhou
- [call.incoming](https://docs.zapdata.dev/#/webhook/call.incoming): Alguém ligou para o número
- [call.ringing](https://docs.zapdata.dev/#/webhook/call.ringing): A ligação feita está tocando no celular do lead
- [call.answered](https://docs.zapdata.dev/#/webhook/call.answered): Atendida
- [call.answered_elsewhere](https://docs.zapdata.dev/#/webhook/call.answered_elsewhere): Atendida em outro aparelho do número
- [call.rejected](https://docs.zapdata.dev/#/webhook/call.rejected): Recusada
- [call.missed](https://docs.zapdata.dev/#/webhook/call.missed): Ninguém atendeu
- [call.ended](https://docs.zapdata.dev/#/webhook/call.ended): Fim da ligação
- [call.agent.tool](https://docs.zapdata.dev/#/webhook/call.agent.tool): O agente chamou uma ferramenta
- [label.updated](https://docs.zapdata.dev/#/webhook/label.updated): Etiqueta criada, mudada ou apagada
- [chat.label.updated](https://docs.zapdata.dev/#/webhook/chat.label.updated): Etiqueta posta ou tirada de um chat
- [outros](https://docs.zapdata.dev/#/webhook/outros): Demais eventos do número