Instance status

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/status \
  --header 'Client-Token: <api-key>'

{
  "connected": true,
  "error": "<string>",
  "smartphoneConnected": true
}

GET

instances

{instanceId}

token

{token}

status

Instance status

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/status \
  --header 'Client-Token: <api-key>'

{
  "connected": true,
  "error": "<string>",
  "smartphoneConnected": true
}

Overview

This method allows you to check whether your instance is connected to a WhatsApp account or not.

instanceId

string

required

Your instance ID. Available in the Z-API panel under Instances.

token

string

required

Your Z-API instance token.

connected

boolean

Indicates whether your number is connected to Z-API

error

string

Returns status details, such as “You are already connected”, “You need to restore the session” or “You are not connected”

smartphoneConnected

boolean

Indicates whether the phone is connected to the internet

{
  "connected": true,
  "error": "You are already connected",
  "smartphoneConnected": true
}

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.