Skip to main content
GET
Obter o QR code de uma sessão
Depois de criar uma sessão unofficial, conecte-a escaneando o QR code no WhatsApp do celular (Aparelhos conectados → Conectar um aparelho). Use ?image=1 para receber o QR diretamente como imagem PNG. Sem o parâmetro, a resposta traz os dados do QR em JSON, ideais para renderizar o código no seu próprio front-end.
O QR code expira em segundos e é renovado automaticamente. Consulte o endpoint novamente para obter um código atualizado enquanto a sessão não conecta.

Authorizations

Authorization
string
header
required

API Key para autenticação. Formato: <API_KEY>

Path Parameters

sessionId
string
required

Session identifier

Query Parameters

image
enum<string>

Set to "1" to return PNG image directly instead of JSON

Available options:
1

Response

QR code data (JSON) or PNG image (when ?image=1)

sessionId
string
required

Session identifier

status
string
required

Session connection status

qrCode
string

Raw QR code text for WhatsApp connection

qrCodeImage
string

Base64 data URL of QR code PNG image

qrCodeUpdatedAt
string<date-time>

Timestamp when QR code was last updated