API/Instâncias/Status da instância

Status da instância

Retorna o status atual de uma instância específica, incluindo informações sobre a conexão e o perfil do WhatsApp.

GET/instance/:name/status

Path Parameters

namestringrequired

Nome da instância

Response

200Status da instância retornado com sucesso
CampoTipoDescrição
successbooleanIndica se a operação foi bem-sucedida
data.statusstringStatus da conexão (disconnected, connecting, qrcode, connected, error)
data.phone_numberstringNúmero de telefone conectado (se disponível)
data.profile_namestringNome do perfil do WhatsApp
200 - application/json
{
  "success": true,
  "data": {
    "status": "connected",
    "phone_number": "5511999999999",
    "profile_name": "Minha Empresa",
    "profile_pic": "https://pps.whatsapp.net/...",
    "device_jid": "5511999999999:123@s.whatsapp.net"
  }
}
404Instância não encontrada
404 - application/json
{
  "success": false,
  "error": {
    "code": "INSTANCE_NOT_FOUND",
    "message": "Instância não encontrada"
  }
}
GET/instance/:name/status
Retorna o status atual de uma instância específica, incluindo informações sobre a conexão e o perfil do WhatsApp.

Example Response

200
{
  "success": true,
  "data": {
    "status": "connected",
    "phone_number": "5511999999999",
    "profile_name": "Minha Empresa"
  }
}