Skip to main content
GET
/
session
/
status
Get session status
curl --request GET \
  --url https://wsapi.chat/session/status \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
{
  "isConnected": true,
  "isLoggedIn": true,
  "deviceId": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Response

Session status

​
isConnected
boolean
​
isLoggedIn
boolean
​
deviceId
string