Get chat active window status

Tells you whether the 24-hour customer service window is open for a contact on a given WhatsApp API number. Free-form and interactive messages are only delivered while the window is active.

Identify the contact by phoneNumber or email. If you send both, phoneNumber takes precedence.

GET

https://api.zacx.io/v1/chat/active

View as Markdown

Authorisation

bearerAuthHTTPrequired

Query parameters

wabaNumberstringrequired
Your WhatsApp API number, with country code.
phoneNumberoptionalstring
The contact's phone number, with country code.
emailoptionalstring
The contact's email address. Ignored when phoneNumber is present.

format: email

Returns

200

The window state for this contact.

JSON

statusstringrequired
dataobjectrequired
1 properties
- statusactiveorinactiverequired
  active when the contact messaged this number within the last 24 hours.

400

One or more parameters are missing or invalid.

JSON

statusstringrequired
codestringrequired
Stable machine-readable error code.
messagestringrequired
Human-readable explanation.