instance.pair_code

EVENTOinstance.pair_codedesde M3envelope v1

Código de pareamento gerado.

Quando é emitido

Emitido quando POST /pair-phone gera um código para digitar no celular.

Campos de data

Campo	Tipo	Descrição
code	string	Código para digitar em Aparelhos conectados > Conectar com número de telefone.

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_9e4b1d7a3f0c6285",
  "type": "instance.pair_code",
  "version": 1,
  "instance_id": "inst_7f3a9c2e5b1d4086",
  "timestamp": "2026-10-17T13:39:30.718Z",
  "data": {
    "code": "ABCD-EFGH"
  }
}

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.pair_code"] no webhook, ou?types=instance.pair_code no SSE.

Relacionados: instance.status · instance.qr

Equivalente na Z-API: (sem equivalente).