Check Widget Status

Updated on 12 Jan 2024
1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/widget/{widget_id}

Path parameters

widget_id

stringRequired

The ID of the widget to check

Query parameters

time_zone

number

(Optional) Represents the supported time zone values of either the UTC offset in minutes or the time zone name. The time_zone parameter is used to format the appointment-time and projected-answer-time components in the response message for the client’s local time zone. If left blank, the response message will return times in the UTC time zone.

Responses

200

Successful response

Expand All

object

data

Array of object (CallObjectStatus)

object

widget_state

string

The current state of the Widget

Valid values[ "offer_callback", "offer_asap_callback", "offer_scheduled_callback", "display_ewt_only", "platform_unavailable" ]

message

string

The API message configured for the Call Target's current conditions and state

offer_asap

boolean

Indicates whether the Widget is offering ASAP callbacks or not

offer_scheduled

boolean

Indicates whether the widget is offering scheduled callbacks or not

ewt

number

The ECBT for the associated Call Target, in seconds. If null, then the widget or associated Call Target is in a state where ECBT is not relevant

scheduled_timeslots

string

A list of appointment times available for scheduling a callback. Appointment times are listed in UTC and represented as Unix timestamps.

Was this article helpful?

Check Widget Status

What's Next