Skip to main content
GET
/
app
/
status
Connection Status
curl --request GET \
  --url https://api.example.com/app/status \
  --header 'Authorization: <authorization>'
{
  "400": {},
  "500": {},
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "results": {
    "is_connected": true,
    "is_logged_in": true,
    "device_id": "<string>"
  }
}
Retrieve the current status of your WhatsApp connection to verify if the device is connected and logged in.

​
Authentication

​
Authorization
string
required
Basic authentication credentials (username:password in base64)

​
Headers

​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.

​
Response

​
status
integer
HTTP status codeExample: 200
​
code
string
Response code indicating success or failureExample: SUCCESS
​
message
string
Human-readable response messageExample: Connection status retrieved
​
results
object
Connection status details
​
is_connected
boolean
Whether the device is connected to WhatsApp serversExample: true
​
is_logged_in
boolean
Whether the device is logged in to WhatsAppExample: true
​
device_id
string
The device identifier (JID format)Example: [email protected]

​
Example Request

curl -X GET 'http://localhost:3000/app/status' \
  -u 'username:password' \
  -H 'X-Device-Id: my-device-id'

​
Response Example

{
  "status": 200,
  "code": "SUCCESS",
  "message": "Connection status retrieved",
  "results": {
    "is_connected": true,
    "is_logged_in": true,
    "device_id": "[email protected]"
  }
}

​
Error Responses

​
400
object
Bad Request
{
  "code": "400",
  "message": "Invalid device ID",
  "results": null
}
​
500
object
Internal Server Error
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Failed to retrieve status",
  "results": null
}

​
Status States

is_connectedis_logged_inMeaning
falsefalseDevice is not connected or logged in
truefalseDevice is connected but not logged in
truetrueDevice is fully operational

​
Usage Notes

  • Use this endpoint to verify connection before sending messages
  • Poll this endpoint periodically to monitor connection health
  • If is_logged_in is false, you need to login again
  • The device_id returned is in JID format (WhatsApp identifier)

Build docs developers (and LLMs) love

Get started for freeTalk to us