Sessões
Controle sessões de WhatsApp na Wazend: ciclo de vida, estados, QR, código de emparelhamento e mais.
Uma sessão representa uma conta de WhatsApp (número de telefone) conectada à Wazend, que você pode usar para enviar e receber mensagens.
Ciclo de vida
Antes de poder enviar ou receber mensagens, você deve iniciar uma sessão e autenticá-la mediante código QR ou código de emparelhamento.
Estados da sessão
STOPPED— a sessão está parada.STARTING— a sessão está iniciando.SCAN_QR_CODE— é necessário escanear o QR ou iniciar sessão mediante número de telefone. Sempre que este estado é emitido, o QR muda e você deve obter o QR atualizado novamente.PASSKEY_REQUIRED— o WhatsApp solicita uma passkey (WebAuthn) para concluir o emparelhamento.PASSKEY_CONFIRMATION_REQUIRED— o usuário deve verificar um código antes de concluir o emparelhamento.WORKING— a sessão funciona e está pronta para uso.FAILED— a sessão falhou por um erro. Costuma significar que é necessária autorização novamente ou que o dispositivo foi desconectado da conta.
Sessão no estado FAILED
No estado FAILED, tente reiniciar a sessão. Se não funcionar, feche a sessão e inicie-a novamente.
Atualizar sessão
Atualiza uma sessão com uma nova configuração completa.
PUT /api/sessions/{session}{
"config": {
"webhooks": [
{
"url": "https://tu-servidor.com/webhook",
"events": ["message"]
}
]
}
}A sessão é reiniciada
Se a sessão não estiver no estado STOPPED, ela será parada e iniciada com a nova configuração.
Iniciar sessão
POST /api/sessions/{session}/startInformação
Operação idempotente: você pode chamá-la várias vezes; ela só inicia se não estiver em execução.
Parar sessão
POST /api/sessions/{session}/stopInformação
Parar não fecha a sessão nem exclui nada. Operação idempotente.
Reiniciar sessão
POST /api/sessions/{session}/restartAviso
Se a sessão já estiver em execução (não em STOPPED), ela será parada e iniciada novamente.
Fechar sessão (Logout)
POST /api/sessions/{session}/logoutAviso
Fechar a sessão exclui as informações de autenticação e os dados, mas conserva a configuração. Se a sessão estiver em WORKING, também remove o dispositivo da lista de Dispositivos vinculados.
Listar sessões
GET /api/sessionsObter sessão
GET /api/sessions/{session}Obter QR
Obtenha o código QR para autenticar a sessão escaneando com o app do WhatsApp.
GET /api/{session}/auth/qr?format=rawUse format=raw para obter a string do código ou format=image para o PNG.
Código de emparelhamento
Obtenha um código numérico para vincular a sessão a partir do app do WhatsApp.
POST /api/{session}/auth/request-codeObter informações do perfil (Me)
GET /api/sessions/{session}/me{
"id": "5215551234567@c.us",
"pushName": "Mi Nombre",
"reachoutTimelock": null,
"messageCapping": null
}Passkey
Em alguns emparelhamentos, o WhatsApp solicita uma passkey (WebAuthn). Os estados PASSKEY_REQUIRED e PASSKEY_CONFIRMATION_REQUIRED indicam que o usuário deve concluir este passo para terminar o emparelhamento.
Eventos
A sessão emite eventos que você pode receber mediante Eventos ou WebSockets. O evento principal é session.status; consulte o detalhe do payload na página de Eventos.