GET /admin/devices/status

Get live connection status for all devices across all API keys. Checks actual WhatsApp connection state in real-time.

Responses

  • 200 application/json

    Device statuses retrieved successfully

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data array[object]
      Hide data attributes Show data attributes object
      • device_id string
      • device_name string
      • whatsmeow_jid string
      • db_status string
      • client_loaded boolean
      • connected boolean
      • is_connected boolean
      • is_logged_in boolean
      • error string
  • 401 application/json

    Unauthorized - Invalid admin secret

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
GET /admin/devices/status
curl \
 --request GET 'http://localhost:7001/admin/devices/status' \
 --header "X-Admin-Secret: $API_KEY"
Response examples (200)
{
  "code": 200,
  "data": [
    {
      "error": "",
      "connected": true,
      "db_status": "active",
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "device_name": "Production Phone",
      "is_connected": true,
      "is_logged_in": true,
      "client_loaded": true,
      "whatsmeow_jid": "6281234567890@s.whatsapp.net"
    },
    {
      "error": "Connection timeout",
      "connected": false,
      "db_status": "disconnected",
      "device_id": "660e8400-e29b-41d4-a716-446655440001",
      "device_name": "Support Phone",
      "is_connected": false,
      "is_logged_in": true,
      "client_loaded": false,
      "whatsmeow_jid": "6289876543210@s.whatsapp.net"
    }
  ],
  "status": true,
  "message": "Device statuses retrieved successfully"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Device statuses retrieved successfully",
  "data": [
    {
      "device_id": "string",
      "device_name": "string",
      "whatsmeow_jid": "string",
      "db_status": "string",
      "client_loaded": true,
      "connected": true,
      "is_connected": true,
      "is_logged_in": true,
      "error": "string"
    }
  ]
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or missing admin secret",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to retrieve device statuses",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}