Skip to main content
GET
Status de conexão do número

Autorizações

x-api-key
string
header
obrigatório

Sua chave de API ps_

Parâmetros de caminho

id
string
obrigatório

Id do número/instância.

Resposta

Status

id
string

Id público do número.

Exemplo:

"num_01HZX..."

state
enum<string>

OPEN = conectado. PENDING/EXPIRED = número Meta aguardando (ou já fora d)a janela do Embedded Signup.

Opções disponíveis:
OPEN,
CONNECTING,
CLOSE,
PENDING,
EXPIRED
Exemplo:

"OPEN"

stale
boolean

false = leitura ao vivo (com checkedAt); true = último estado lembrado (com lastKnownAt).

Exemplo:

false

checkedAt
string

ISO 8601. Só quando stale é false.

Exemplo:

"2026-07-22T12:34:56.000Z"

lastKnownAt
string

ISO 8601. Só quando stale é true.

Exemplo:

"2026-07-22T12:34:56.000Z"

expiresAt
string

ISO 8601, fim da janela de pareamento. Só em PENDING/EXPIRED.

Exemplo:

"2026-08-04T18:27:31.000Z"