Referência da API
Todas as operações da API pública, geradas da especificação OpenAPI 3.1, com playground e exemplos em 8 linguagens.
A referência é gerada de openapi.yaml, que por sua vez é gerado do código do Zynzap: o que está aqui é exatamente o que a API aceita. Use o playground de cada página para testar com a sua chave (prefira uma chave zz_test_).
- Formato:
POST /rpc/{Operação}com{"request": {...}}; campos emsnake_case, inteiros de 64 bits como string, enums como string e arquivos em Base64. - Operações pagas pedem
billing.quoteId: veja Cobrança e cotações. - Erros seguem um formato único: veja Erros.
Visão geral
Descoberta da API e identidade da chave.
Cobrança e cotações
Cotação obrigatória antes de qualquer operação paga.
Números (sessões)
Criar, parear, listar, desconectar e excluir números de WhatsApp.
Mensagens
Enviar texto, imagem, áudio, vídeo e documento; presença; apagar; visualização única.
Eventos
Stream SSE em tempo real e histórico de eventos.
Mídias
Biblioteca de mídias: enviar, listar, baixar e excluir arquivos.
Contatos
Contatos da conta e importação a partir do WhatsApp.
Grupos
Ler e administrar grupos do WhatsApp.
Atendimento
Conversas, histórico, envio pela conversa, responsáveis, notas e status.
Chamadas
Histórico e controle das chamadas de voz e vídeo do atendimento.
CRM
Etiquetas, campos, funis, oportunidades e tarefas.
Público
Listas, segmentos, regras de envio e sequências de recuperação.
Campanhas
Disparos em massa, presets, resultados e entregas.
Aquecimento
Aquecimento de números com diálogos entre os seus próprios números.
Modelos e diálogos
Modelos de mensagem e diálogos em árvore do aquecimento.
Fluxos (bots)
Fluxos de atendimento automatizado e suas execuções.
IA
Correção, resumo, sugestão de resposta e classificação com IA (cotadas).
Indicadores e retenção
Indicadores do atendimento, SLA, retenção e exclusão de dados.