API do Zynzap

Envie e receba mensagens de WhatsApp, opere o atendimento, o CRM e as campanhas do Zynzap a partir do seu sistema, com chaves de permissão mínima, webhooks assinados e custo conhecido antes de cada envio.

A API do Zynzap faz pelo seu sistema (ERP, loja virtual, CRM, n8n, um script) o mesmo que você faz no painel: conectar números, enviar mensagens, responder conversas, criar contatos e oportunidades, disparar campanhas e ouvir eventos em tempo real. Ela usa as mesmas permissões e regras de cobrança do painel.

Guia rápido

Sua primeira mensagem em 5 minutos.

Autenticação

Chaves, permissões, números e IPs permitidos.

Webhooks

Receba mensagens e status no seu endpoint, com assinatura HMAC.

Referência da API

Todas as operações, com playground e exemplos em 8 linguagens.

Como a API funciona

Base: https://api.zynzap.com.br/v1 (HTTPS). Todas as rotas abaixo são relativas a ela.
Autenticação: Authorization: Bearer <sua chave> em toda chamada. Veja Autenticação.
Operações: POST /rpc/{Operação} com o corpo {"request": {...}}. São mais de 170 operações (por exemplo SendMessage, ListConversations, CreateCrmOpportunity), todas documentadas na referência. Os campos seguem o contrato do Zynzap em snake_case.
Operações pagas (envios, campanhas, aquecimento e IA) exigem uma cotação antes: você sabe o custo máximo e só então executa. Veja Cobrança e cotações.
Tempo real: receba eventos por webhooks (o Zynzap faz POST no seu endpoint) ou pelo stream SSE GET /events.
Erros têm um formato único com code, reason, message e requestId. Veja Erros.

curl -X POST "https://api.zynzap.com.br/v1/rpc/ListSessions" \
  -H "Authorization: Bearer $ZYNZAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "request": {
    "pagination": {
      "page": 1,
      "page_size": 20
    }
  }
}'

Rotas

Rota	Para que serve
`GET /`	Descreve a API: operações disponíveis, limites e rotas (sem chave).
`POST /rpc/{Operação}`	Executa qualquer operação liberada.
`POST /messages/send`	Atalho de `SendMessage`.
`POST /billing/quotes`	Cota uma operação paga.
`GET /events`	Stream SSE de eventos, com retomada por cursor.
`POST /sessions/create` · `POST /sessions/resume`	Cria/reconecta um número e transmite o QR Code ou o código de pareamento por SSE.
`GET /media/{id}`	Baixa um arquivo da biblioteca de mídias.

Antes de começar

Uma conta no Zynzap com autenticação em duas etapas ativa (obrigatória para criar chaves).
Pelo menos um número conectado (pelo painel ou pela API).
Saldo ou franquia para operações pagas. Leituras são gratuitas.

API não oficial do WhatsApp

O Zynzap conecta números como um aparelho vinculado (como o WhatsApp Web), não pela API oficial da Meta. Isso dá liberdade e custo baixo, mas exige cuidado: números novos precisam de aquecimento e envios em massa sem consentimento levam a banimento. Leia as boas práticas antes de ir para produção.