Register a Callback

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

Unique Widget identifier that can be retrieved from the Widget API Endpoints modal window

contact_number
string
required

Telephone number to be dialed when the callback is launched

appointment_time
string

(Optional) UTC time to launch the callback, encoded as a Unix timestamp. The input time must be one of the values of scheduled_timeslots returned with the widget status. If omitted, an ASAP callback will be requested. If included, a scheduled callback will be requested.

user_data
object

(Optional) JSON object representing user data key-value pairs. Only keys that are allowed by the Widget?s User Data Set are submitted to Mindful Callback.

channel
string

(Optional) Specifies the origin of the callback request. For example, if the callback request was made during an interaction with a mobile app or chatbot, the values "mobile" or "chatbot" could be passed to differentiate the calls in analytics or reporting.

Requested - The submitted callback request has been accepted. Expect to receive a callback at the indicated time.

(one of)
data
array[CallObjectRequestASAP]
status
string

Status of the callback request

message
string

Provides the API Message configured to be returned by the Widget in response to a successful callback request

callback_request_id
string

Callback Request identifier. Can be used for your application?s logging. This item is only included in the response to a successfully requested ASAP or scheduled callback.

requested_at
number

The time the callback request was made (in UTC), encoded as a Unix Timestamp. This item is only included in the response to a successfully requested ASAP or scheduled callback.

ewt
number

The ECBT for the call, in seconds. This item is only included in the response to a successfully requested ASAP callback.

Body
Response Example
1
{
2
"data": [
3
{
4
"status": "string",
5
"message": "string",
6
"callback_request_id": "string",
7
"requested_at": 0,
8
"ewt": 0
9
}
10
]
11
}