Referência/Connections/getConnectionStatus
Connections

Consulta o estado da conexão

Consulta o estado da conexão

GEThttp://localhost:8084/instance/{instance}/connection/status

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header
Authorization
Exemplo
Bearer <INSTANCE_TOKEN>

Parâmetros

instancepathobrigatório
string

Nome público da instância

minLength 1

Respostas

application/json
200

Estado da conexão

response 200object
statestringobrigatório
statusReasonintegerobrigatório
instanceNamestringobrigatório
connectionStatusstringobrigatório
connectedbooleanobrigatório
loggedInbooleanobrigatório
ownerJidstring | null
Exemplo 200gerado do schema
{
"state": "string",
"statusReason": 1,
"instanceName": "minha-instancia",
"connectionStatus": "string",
"connected": true,
"loggedIn": true,
"ownerJid": "[email protected]"
}