QR Code

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

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

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

{
  "qrCode": "2@ABC123xyz...",
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "expiresAt": "2024-01-15T10:01:00.000Z"
}

{
  "statusCode": 400,
  "error": "SESSION_NOT_IN_QR_STATE",
  "message": "Sessão não está aguardando escaneamento de QR Code"
}

{
  "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?format=base64" \
  -H "X-API-Key: YOUR_API_KEY"

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

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

{
  "qrCode": "2@ABC123xyz...",
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "expiresAt": "2024-01-15T10:01:00.000Z"
}

{
  "statusCode": 400,
  "error": "SESSION_NOT_IN_QR_STATE",
  "message": "Sessão não está aguardando escaneamento de QR Code"
}

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

Retorna o QR Code atual da sessão se ela estiver em estado de aguardando escaneamento. Útil para obter um QR Code atualizado sem reiniciar a conexão.

Path Parameters

string

required

ID da sessão (UUID).

string

default:"base64"

Formato do QR Code.Valores:

string

QR Code em formato texto.

string

QR Code como imagem base64 PNG.

string

Timestamp de quando o QR Code expira.

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

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

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

{
  "qrCode": "2@ABC123xyz...",
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "expiresAt": "2024-01-15T10:01:00.000Z"
}

{
  "statusCode": 400,
  "error": "SESSION_NOT_IN_QR_STATE",
  "message": "Sessão não está aguardando escaneamento de QR Code"
}

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

Este endpoint só retorna QR Code se a sessão estiver em estado qr. Se a sessão estiver disconnected, você precisa chamar /connect primeiro.