Skip to main content
Mudanças incompatíveis são anunciadas aqui com antecedência e, quando possível, mantidas por período de convivência. Campos novos em respostas e webhooks não são considerados incompatíveis: escreva o seu cliente ignorando campos desconhecidos.
​
Documentação pública
  • Documentação em developer.wabox.me com Documentação e API Reference geradas do código da API.
  • Referência com 120 endpoints canônicos (mais aliases de compatibilidade com a z-api) e 6 webhooks documentados a partir dos contratos.
  • Playground com instance_id/token persistidos no navegador.
​
Business e etiquetas
  • Perfil comercial, catálogo (produtos, coleções), pedidos e send-product/send-catalog/send-order/order-status-update — best effort.
  • Etiquetas (/labels) em contas Business, com aliases /tags.
  • Webhook received com blocos product e order.
​
Interativos, comunidades, canais e privacidade
  • Botões, OTP, PIX, lista, carrossel, eventos de calendário e status (stories).
  • Comunidades, canais (newsletters) e configurações de privacidade.
  • Assinatura HMAC X-Wabox-Signature em todos os webhooks e POST /webhooks/secret para rotação.
​
Chats, contatos, perfil e grupos
  • GET /chats, ações de chat, mensagens temporárias; contatos, verificação de números em lote e bloqueio; perfil; grupos completos (participantes, links de convite, pedidos de entrada).
​
Mídia e mensagens ricas
  • Imagem, áudio (voice note com forma de onda), vídeo, PTV, GIF, documento, sticker — URL ou base64, com conversões por ffmpeg.
  • Localização, contatos, link com prévia, reações, encaminhar, fixar, apagar, enquetes e votos, ler, presença.
  • Endpoints de fila (GET/DELETE /queue).
​
Lançamento da API
  • Instâncias com QR code e código de pareamento, send-text, webhooks received, delivery, message_status, connected, disconnected, chat_presence.
  • Convenção snake_case, formato de erro { error: { code, message } }, rate limit por instância.