Pular para o conteúdo

Conexões do projeto

GET/tenants/{id}/connections

Todas as conexões do projeto, da mais recente à mais antiga, com o status gravado, em maiúsculas: PENDING (criada, esperando o pareamento), CONNECTING (pareando ou conectando), OPEN (conectada e pronta para enviar), CLOSE (desconectada; pode reconectar sozinha), FAILED (falhou de vez, por exemplo um número banido) e PASSKEY_REQUIRED (o pareamento parou porque o celular pediu uma passkey; espera uma nova conexão). Escopo necessário: connections:read.

Ver em Markdown

Parâmetros de caminho

idstring · uuidobrigatório

Identificador do projeto (tenantId).

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200As conexões em connections, da mais recente à mais antiga, e o total em count.
400FST_ERR_VALIDATIONid 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.
403A chave não tem o escopo connections:read; a mensagem de erro cita o escopo que falta.
404O projeto não existe ou não é de quem chama (Tenant not found): uma chave de API alcança só o próprio projeto, e o de outra pessoa responde igual a um que não existe.
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

Detalhes

Cada conexão traz tenantName, o nome do projeto, e o externalId que você deu a ela. Para o status ao vivo e o QR code, use GET /tenants/{id}/connections/{connId}/qr ou GET /connections/{id}/qr.

Guia: Projetos e conexões

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