Check Widget Status

get
https://{organization_id}.scheduler-rt.getmindful.com
/api/widget/{widget_id}
widget_id
string
required

The ID of the widget to check

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.

Successful response

responses
/
200
data
array[CallObjectStatus]
widget_state
string

The current state of the Widget

Allowed values:
offer_callbackoffer_asap_callbackoffer_scheduled_callbackdisplay_ewt_onlyplatform_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.

Parameters
:
:
Response Example
1
{
2
"data": [
3
{
4
"widget_state": "offer_callback",
5
"message": "string",
6
"offer_asap": true,
7
"offer_scheduled": true,
8
"ewt": 0,
9
"scheduled_timeslots": "string"
10
}
11
]
12
}