Conectar Sessão - Oxenty API

curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000/qrcode" \
  -H "X-API-Key: YOUR_API_KEY"

await client.sessions.connect('550e8400-e29b-41d4-a716-446655440000');

const qr = await client.sessions.getQRCode('550e8400-e29b-41d4-a716-446655440000');
console.log('Escaneie o QR Code:', qr.qr);

client.sessions.connect('550e8400-e29b-41d4-a716-446655440000')

qr = client.sessions.get_qrcode('550e8400-e29b-41d4-a716-446655440000')
print(f"Escaneie o QR Code: {qr['qr']}")

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "qrCode": "2@ABC123xyz...",
  "status": "QRCODE",
  "message": "Scan the QR code to connect."
}

{
  "statusCode": 404,
  "error": "SESSION_NOT_FOUND",
  "message": "Sessão não encontrada"
}

GET

api

sessions

:id

qrcode

curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000/qrcode" \
  -H "X-API-Key: YOUR_API_KEY"

await client.sessions.connect('550e8400-e29b-41d4-a716-446655440000');

const qr = await client.sessions.getQRCode('550e8400-e29b-41d4-a716-446655440000');
console.log('Escaneie o QR Code:', qr.qr);

client.sessions.connect('550e8400-e29b-41d4-a716-446655440000')

qr = client.sessions.get_qrcode('550e8400-e29b-41d4-a716-446655440000')
print(f"Escaneie o QR Code: {qr['qr']}")

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "qrCode": "2@ABC123xyz...",
  "status": "QRCODE",
  "message": "Scan the QR code to connect."
}

{
  "statusCode": 404,
  "error": "SESSION_NOT_FOUND",
  "message": "Sessão não encontrada"
}

Para conectar uma sessão no WhatsApp, você deve obter o QR Code e escanear pelo aplicativo.

O endpoint principal para obter QR Code é GET /sessions/:id/qrcode.

Path Parameters

string

required

ID da sessão (UUID).

Resposta

qrCode

string

QR Code em formato texto.

sessionId

string

ID da sessão.

status

string

Status atual da sessão.

message

string

Mensagem de status.

curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000/qrcode" \
  -H "X-API-Key: YOUR_API_KEY"

await client.sessions.connect('550e8400-e29b-41d4-a716-446655440000');

const qr = await client.sessions.getQRCode('550e8400-e29b-41d4-a716-446655440000');
console.log('Escaneie o QR Code:', qr.qr);

client.sessions.connect('550e8400-e29b-41d4-a716-446655440000')

qr = client.sessions.get_qrcode('550e8400-e29b-41d4-a716-446655440000')
print(f"Escaneie o QR Code: {qr['qr']}")

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "qrCode": "2@ABC123xyz...",
  "status": "QRCODE",
  "message": "Scan the QR code to connect."
}

{
  "statusCode": 404,
  "error": "SESSION_NOT_FOUND",
  "message": "Sessão não encontrada"
}

Fluxo de Conexão

Obter o QR Code

Chame GET /sessions/:id/qrcode e exiba qrCode para o usuário.

Usuário escaneia

O usuário abre o WhatsApp → Configurações → Dispositivos conectados → Conectar dispositivo.

Conexão estabelecida

A sessão atualiza para status: connected e dispara o webhook session.connected.

O QR Code expira após aproximadamente 60 segundos. Se expirar, chame GET /sessions/:id/qrcode novamente.

Atualizar Sessão QR Code

​Path Parameters

​Resposta

​Fluxo de Conexão

Path Parameters

Resposta

Fluxo de Conexão