Skip to main content
GET
cURL

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

token
string
required

Token da instância. Trate como senha.

Response

Status atual da instância. Desconectada: { "connected": false, "smartphone_connected": false, "status": "qr", "phone": null, "error": "You need to scan the QR code" }.

connected
boolean
required
smartphone_connected
boolean
required

Se o celular está alcançável.

status
enum<string>
required
Available options:
created,
starting,
qr,
connecting,
connected,
disconnected,
logged_out,
banned,
stopped
phone
string | null
required

Número conectado (só dígitos) ou null.

error
string | null
required

null quando conectada; caso contrário uma frase com o motivo.