instance.qr

EVENTOinstance.qrdesde M3envelope v1

Novo QR de pareamento.

Quando é emitido

Emitido a cada novo QR enquanto a instância está em qr_pending. Mostre code como QR (qualquer biblioteca de QR serve) em vez de fazer polling em GET /qr. timeout_ms é a validade aproximada deste código.

Campos de data

Campo	Tipo	Descrição
code	string	Conteúdo do QR.
timeout_ms	integer	Validade do código em milissegundos (opcional).

O envelope (id, type, version, instance_id, timestamp,data) está em Visão geral. Campos novos podem ser adicionados emdata sem mudar a versão: ignore os que não conhecer.

Exemplos

Corpo do POST

{
  "id": "evt_1c8f3a6e9d2b4057",
  "type": "instance.qr",
  "version": 1,
  "instance_id": "inst_7f3a9c2e5b1d4086",
  "timestamp": "2026-10-17T13:39:10.004Z",
  "data": {
    "code": "2@kQ3x...,Zm9v...,YmFy...,MQ==",
    "timeout_ms": 20000
  }
}

Entrega e ordem

• Por webhook: pelo menos uma vez, com retry por até 24 horas. O mesmo evento pode chegar duas vezes: deduplique porX-LiteZap-Event-Id. Veja Entrega e retentativas.
• A ordem entre eventos não é garantida (retentativas reordenam): use timestamp.
• Por SSE: ao vivo, sem replay. Veja Tempo real com SSE.
• Para assinar só este tipo: "events": ["instance.qr"] no webhook, ou?types=instance.qr no SSE.

Relacionados: instance.status · instance.pair_code

Equivalente na Z-API: (sem equivalente; QR por polling).