Get chat window status

Check whether the 24-hour customer service window is open for a customer on a WhatsApp number or Instagram account.

Before you call

  • For WhatsApp, customerPhoneNumber and wabaNumber are required, with country code.
  • For Instagram, set channelType to INSTAGRAM; customerHandle and channelHandle (usernames, without the @) are required.

How it works

  • isOpen is true if the customer messaged in the last 24 hours. You can then send any message type.
  • When isOpen is false, only template messages can be sent on WhatsApp, and no message on Instagram.
  • The response echoes customerPhoneNumber and wabaNumber, or for Instagram channelType, customerHandle and channelHandle.
  • Returns 404 if there is no chat between that customer and channel.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The customer's phone number. Required for WhatsApp.

string

The WhatsApp Business Account (WABA) number. Required for WhatsApp.

string
enum

INSTAGRAM for an Instagram customer. Left out, the customer is on WhatsApp.

Allowed:
string

With channelType INSTAGRAM: the customer's Instagram username, without the @. Required for Instagram.

string

With channelType INSTAGRAM: your connected Instagram account's username, without the @. Required for Instagram.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json