# OnZap

> API HTTP de WhatsApp. Cada instância é um número conectado (por QR Code na API OnZap ou pela API oficial da Meta): envie mensagens, leia conversas e receba os eventos por webhook assinado.

- Endereço base: `https://app.onzap.io/v1/instances/{instanceId}`
- Autenticação: header `X-Instance-Token` (e `Client-Token`, se a conta exigir). Só servidor a servidor.
- Erros: `{"error": {"code", "message", "details"}}`; trate pelo `code`.
- Webhooks: envelope `{id, event, instanceId, provider, timestamp, payload, me}`, assinado em `X-OnZap-Signature`.

## Começando

- [Introdução](https://developer.onzap.io/introducao.md): O que é a API da OnZap, os dois tipos de instância e a sua primeira requisição.
- [Autenticação](https://developer.onzap.io/autenticacao.md): Token da instância, Client-Token da conta e como guardar as credenciais.
- [Primeiros passos](https://developer.onzap.io/primeiros-passos.md): Do zero à primeira mensagem enviada e recebida, em poucos minutos.
- [Erros e limites](https://developer.onzap.io/erros-e-limites.md): Formato dos erros, códigos, o que tentar de novo e os limites da API.
## Guias

- [Conversas e números](https://developer.onzap.io/conversas-e-numeros.md): Como identificar contatos e grupos no chatId, e o que são LID e BSUID.
- [Mensagens e mídia](https://developer.onzap.io/mensagens-e-midia.md): Tipos de envio, arquivos por URL ou base64, respostas, reações e a mídia recebida.
- [Fila de mensagens](https://developer.onzap.io/fila.md): Envios com intervalo, "digitando…" e espera enquanto o celular está desconectado.
- [Webhooks](https://developer.onzap.io/webhooks.md): Receba os eventos da instância no seu sistema, confira a assinatura e trate repetições.
- [API oficial (Meta)](https://developer.onzap.io/api-oficial.md): Instâncias da WhatsApp Cloud API: conexão, janela de 24 horas, templates e diferenças.
## IA e agentes

- [Use com IA](https://developer.onzap.io/ia.md): llms.txt, Markdown de cada página e instruções para assistentes de programação.

## Referência da API

- [Instância](https://developer.onzap.io/referencia/instancia.md): Status, configurações e ciclo de vida da conexão.
- [Pareamento](https://developer.onzap.io/referencia/pareamento.md): Conectar o número: QR Code, código por telefone ou passkey.
- [Perfil](https://developer.onzap.io/referencia/perfil.md): Nome, recado e foto do número conectado.
- [Mensagens](https://developer.onzap.io/referencia/mensagens.md): Envio de mensagens de todos os tipos, reações, leitura e "digitando…".
- [Chats](https://developer.onzap.io/referencia/chats.md): Conversas: listar, ler o histórico, editar e apagar mensagens, marcar como lidas.
- [Contatos](https://developer.onzap.io/referencia/contatos.md): Agenda, verificação de números e foto de perfil.
- [Grupos](https://developer.onzap.io/referencia/grupos.md): Criar e administrar grupos, participantes e convites.
- [Canais](https://developer.onzap.io/referencia/canais.md): Canais (newsletters): criar, seguir e buscar.
- [Status (stories)](https://developer.onzap.io/referencia/status-stories.md): Publicar status de texto, imagem, voz e vídeo.
- [Etiquetas](https://developer.onzap.io/referencia/etiquetas.md): Etiquetas do WhatsApp Business.
- [Presença](https://developer.onzap.io/referencia/presenca.md): Online, digitando e visto por último.
- [Chamadas](https://developer.onzap.io/referencia/chamadas.md): Recusar chamadas recebidas.
- [Mídia](https://developer.onzap.io/referencia/midia.md): Converter áudio e vídeo para o formato do WhatsApp.
- [Integrações](https://developer.onzap.io/referencia/integracoes.md): Integrações prontas (ex.: Chatwoot) ligadas à instância.
- [Fila](https://developer.onzap.io/referencia/fila.md): Fila de envio da instância: intervalo entre mensagens, "digitando…" e espera por reconexão.
- [Webhooks](https://developer.onzap.io/referencia/webhooks.md): Endereços que recebem os eventos da instância, com histórico de entregas.
- [Eventos de webhook](https://developer.onzap.io/referencia/eventos-de-webhook.md): Tudo o que pode chegar no seu webhook, com o formato do payload de cada evento.
- [Eventos](https://developer.onzap.io/referencia/eventos.md): Eventos dos últimos 7 dias, no mesmo formato entregue aos webhooks.
- [Templates](https://developer.onzap.io/referencia/templates.md): Modelos de mensagem aprovados pela Meta (obrigatórios fora da janela de 24 h).
- [Perfil comercial](https://developer.onzap.io/referencia/perfil-comercial.md): Descrição, endereço, site e foto do perfil comercial.
- [Número](https://developer.onzap.io/referencia/numero.md): Dados do número na Meta: qualidade, limite de envio e status.

## Opcional

- [Documentação completa em um arquivo](https://developer.onzap.io/llms-full.txt): todos os guias e a referência inteira
- [OpenAPI 3.1](https://developer.onzap.io/openapi.json): contrato da API, para gerar clientes e SDKs