Instâncias
Cada instância representa um número de WhatsApp. Conecte por QR ou pareamento, configure webhooks e acompanhe o status do socket.
15 endpoints
/instances
→
Listar instâncias do workspace
Lista os números do workspace com status, telefone, webhook e filtros configurados. Com a chave mestra, pode listar todas as instâncias.
/instances
→
Criar uma instância
O webhookSecret só é retornado na criação. Guarde-o para validar a assinatura HMAC.
/instances/:id
→
Detalhe da instância
Retorna o detalhe de uma instância e sua configuração atual.
/instances/:id
→
Editar nome, webhook e filtros
Edita nome, URL de webhook, eventos assinados e a opção de incluir mensagens enviadas por você. A URL passa por validação SSRF.
/instances/:id
→
Remover a instância e a sessão
Remove a instância, encerra o socket, apaga a sessão Baileys e descarta o histórico local.
/instances/:id/webhook-secret
→
Revelar o segredo HMAC
Revela o segredo HMAC da instância para validar assinaturas. Restrito a administradores quando autenticado por sessão.
/instances/:id/connect-link
→
Gerar link/iframe temporário de conexão
Gera um link HMAC de 15 minutos para uma página pública de conexão, além do trecho de iframe para incorporar em sites de clientes.
/instances/:id/connect
→
Abrir o socket
Abre o socket da instância. Se houver sessão salva, reconecta sem QR; caso contrário, gera um novo QR code.
/instances/:id/disconnect
→
Desconectar mantendo a sessão
Fecha o socket mantendo as credenciais salvas. Um próximo connect reconecta sem novo QR.
/instances/:id/logout
→
Desvincular o aparelho e apagar a sessão
Desvincula o aparelho no WhatsApp e apaga a sessão local. É necessário escanear um novo QR para voltar.
/instances/:id/qr
→
Status e QR code atual
Retorna o status atual e, quando a instância aguarda conexão, o QR code em data URL pronta para exibir.
/instances/:id/pair
→
Pareamento por código
Solicita um código de pareamento por telefone para conectar sem câmera. O código é usado no WhatsApp em Aparelhos conectados.
/instances/:id/on-whatsapp
→
Verificar números no WhatsApp
Verifica até 50 números e informa quais possuem conta no WhatsApp.
/instances/:id/capabilities
→
Capacidades e configuração da instância
Capacidades e configuração da instância.
/instances/:id/media
→
Limpar cache de mídia da instância
Restrito a gestor/máquina; confirm=true obrigatório. Preserva instância, histórico e credenciais.