Skip to main content

​
Sessões

Uma sessão representa uma conexão ativa com uma conta do WhatsApp. Cada sessão permite enviar e receber mensagens, gerenciar contatos e grupos de uma conta específica.

​
Conceitos Principais

Multi-dispositivo

A API usa o protocolo multi-dispositivo do WhatsApp, que não requer o telefone online após a conexão inicial.

QR Code

Para conectar uma sessão, é necessário escanear um QR Code com o WhatsApp do dispositivo que será vinculado.

​
Ciclo de Vida

​
Status da Sessão

StatusDescrição
disconnectedSessão criada mas não conectada
qrQR Code disponível para escaneamento
connectingEstabelecendo conexão com WhatsApp
connectedSessão ativa e pronta para uso

​
Endpoints

Criar Sessão

POST /sessions

Listar Sessões

GET /sessions

Obter Sessão

GET /sessions/:id

Atualizar Sessão

PUT /sessions/:id

Reconectar

POST /sessions/:id/reconnect

QR Code

GET /sessions/:id/qrcode

Desconectar

POST /sessions/:id/disconnect

Deletar Sessão

DELETE /sessions/:id

​
Configurações de Webhook

Cada sessão pode ter seu próprio webhook configurado para receber eventos em tempo real. Configure os campos:
  • webhookUrl - URL que receberá os eventos
  • webhookEvents - Array de eventos para receber
  • webhookSecret - Secret para validar assinaturas
Veja o guia de Webhooks para mais detalhes.