Pular para o conteúdo

QR code como imagem

GET/tenants/{id}/connections/{connId}/qr

Como GET /connections/{id}/qr, com o QR code já renderizado como imagem PNG em data URL (data:image/png;base64,…), pronto para usar como fonte de uma imagem. Escopo necessário: connections:read.

Ver em Markdown

Parâmetros de caminho

idstring · uuidobrigatório

Identificador do projeto (tenantId).

connIdstring · uuidobrigatório

Identificador da conexão (o número) no projeto.

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200O QR code em qrCode (enquanto a conexão pareia) e o status.
400FST_ERR_VALIDATIONid ou connId não é um UUID; message diz o que está errado.
401Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. A chave de um projeto desativado também responde 401.
402subscription_inactiveA organização dona do projeto não pode usar o WhatsApp agora: o período de teste acabou, ou uma fatura venceu e passou do prazo de carência. O corpo traz error e code; regularize a assinatura no painel.
403A chave não tem o escopo connections:read; a mensagem de erro cita o escopo que falta.
404O projeto ou a conexão não existe, ou não é de quem chama (Tenant not found, Connection not found). A conexão precisa ser do projeto do caminho.
429Requisições demais deste IP de origem, ou autenticações com falha demais: espere os segundos de Retry-After. Veja Limites.Cabeçalho: Retry-After
503A instância do gateway que roda a conexão está mudando (um reinício, um failover) ou não responde: espere os segundos de Retry-After e tente de novo.Cabeçalho: Retry-After

Detalhes

O QR code só vem para quem tem o escopo connections:write, porque escaneá-lo conecta um número à conexão. Só com connections:read, qrCode vem null e o status continua disponível. qrCode também é null quando não há QR code para escanear.

status é o atual, da instância do gateway que roda a conexão, ou, sem ele, o gravado; sempre em minúsculas. passkey_required: o QR code foi escaneado, mas o celular pediu uma passkey e o pareamento parou; veja Parear um número.

Guia: Parear um número

Esta página ajudou? · Atualizado em 28 set 2026