Pular para o conteúdo principal
O PanÐá Zap oferece uma API REST para integração com CRMs, ERPs, plataformas de e-commerce e ferramentas de automação. Através dela você pode enviar e receber mensagens, abrir e atualizar tickets, gerenciar contatos, executar campanhas, consultar análises e muito mais, tudo a partir de qualquer sistema externo.

URL Base

Todas as rotas da API seguem este padrão:

Autenticação

Toda requisição deve incluir um token Bearer no cabeçalho Authorization:
A única exceção é o envio de mensagem por parâmetros na URL (GET /params/): nessa rota o cabeçalho é ignorado e o token vai obrigatoriamente no parâmetro bearertoken (veja Enviar Mensagens). Como vai na URL, o token dessa rota fica gravado nos logs de acesso do servidor (e de proxies no caminho). Para não expor o token, prefira as rotas POST de envio, como o envio de texto, com o token no cabeçalho Authorization. Gere seu token no menu Configuração → API, botão Nova API. Consulte a página de Autenticação para instruções completas de configuração.

Formato da Resposta

A maioria das rotas devolve success: true e um bloco data, cujo conteúdo varia por rota (muitas listagens trazem também um bloco pagination):
A maioria dos erros vem assim:
Nem toda rota segue esse formato de erro: algumas recusas vêm só com error (ex.: { "error": "ERR_QUEUE_TICKET_EXISTS" } ao excluir uma fila com atendimentos) ou com message e statusCode (ex.: ERR_TAG_HAS_ASSIGNMENTS ao excluir uma tag em uso). Por isso, confira sempre primeiro o código HTTP.

Códigos de Status HTTP

Códigos de Erro Comuns

  • ERR_TICKET_CLOSED (HTTP 409): no envio por ticket, o atendimento de destino está fechado. Envie "reopen": true no corpo da requisição para reabri-lo e enviar.
  • ERR_NUMBER_AMBIGUOUS: na mesclagem de contatos por número (mergecontacts), o número informado corresponde a mais de um contato; a linha volta com a lista de candidatos. Refaça esse par usando os IDs (primaryId / duplicateId).
  • ERR_WAPP_CONTACT_UNVERIFIED (HTTP 424): nos envios por número nos canais whatsapp e baileys, o número não tem WhatsApp ou a consulta ao WhatsApp está indisponível no momento. Pode tentar de novo.
  • ERR_CHANNEL_DISCONNECTED (HTTP 400): no canal baileys, a sessão está aguardando a leitura do QR Code e o envio é recusado.
  • ERR_API_CONFIG_NOT_FOUND (HTTP 404): o {ApiID} da URL não existe na sua empresa. Confira o ID no fim da URL de integração, no cartão da integração em Configuração → API. Aparece, por exemplo, nas rotas de agendamentos, lembretes, formulários, Google Agenda e Agentes de IA.

Limites e Restrições

  • Corpo JSON com conteúdo base64: até 50 MB por requisição.
  • mediaUrl: deve usar http ou https, não pode redirecionar, e hosts internos/privados são bloqueados.
  • Mesclagem de contatos: até 150 pares por requisição.
  • Limite de taxa: as rotas externas não têm limite de taxa, exceto as do Google Agenda: até 120 chamadas por minuto por empresa, somando as cinco rotas. Acima disso, a resposta é 429 com ERR_RATE_LIMITED, o campo retryAfterSeconds e o cabeçalho Retry-After (segundos de espera). Use o campo externalKey para deduplicar tentativas e evitar operações duplicadas.

Recursos Disponíveis

A Referência da API está organizada em oito grupos, cobrindo mais de 200 endpoints:

Mensagens

Enviar Mensagens

Texto, arquivos, base64, áudio, localização, vCard e consulta por ID.

Enviar por Ticket

Envie mensagens via ID de ticket em qualquer canal conectado.

Envio em Lote

Dispare mensagens para listas de contatos e acompanhe os disparos em lote.

Mensagens em Grupo

Envie texto e arquivos diretamente para grupos do WhatsApp.

Templates WABA

Envie templates aprovados pela Meta em canais WABA oficiais.

Mensagens Interativas

Interativo WhatsApp

Botões, listas, enquetes, carrossel, PIX e CTAs (Baileys, Zapo, UazAPI e WABA).

Interativo Instagram e Messenger

Quick replies, templates de botão, cards, recibos, ice breakers e personas.

Tickets e Contatos

Tickets

Crie, atualize, pause, marque com tags e compartilhe tickets de atendimento.

Contatos

Criar, atualizar, mesclar, desfazer mesclagem e buscar contatos.

Formulários

Envie as respostas de um formulário e abra o atendimento como pela página do formulário.

Campanhas e CRM

Campanhas

Gerencie todo o ciclo de vida das campanhas de disparo.

CRM

Pipelines, etapas, oportunidades, agendamentos e lembretes.

Google Agenda

Consulte as contas e os calendários do Google conectados no painel e liste, crie e apague eventos.

Canais e Recursos

Canais e Sessões

Crie, inicie e consulte canais WhatsApp via QR Code.

Grupos do WhatsApp

Crie e administre grupos, participantes e links de convite.

Galeria de Mídia

Envie, liste e remova arquivos da biblioteca de mídia e consulte as pastas.

Organização e Produtividade

Kanban, Tags, Motivos e Filas

CRUD completo das entidades de organização do atendimento.

Usuários

Crie, liste e atualize contas de agentes.

Tarefas (To-Do List)

Crie e acompanhe pendências internas da equipe.

Agentes de IA

Crie, edite, duplique e exclua agentes de IA e cuide da base de conhecimento: artigos, documentos, links e perguntas frequentes.

Dados e Relatórios

Métricas do Dashboard

Volume, tempos, evolução e distribuição de tickets por período.

Listagens Gerais

Descubra canais, filas, tags, fluxos e respostas cadastradas.

Logs de Chamadas

Histórico do Log de Ligações e das chamadas feitas pelo WaVoIP.

Eventos em Tempo Real

Webhooks

Receba eventos em tempo real do PanÐá Zap.