Retrieve callback offer decision attributes

get
https://{api-gateway-hostname}
/v2/callback/callTargets/{id}/offerDecision
id
integer
required

The call target ID.

sourceType
string

The filter type to apply to the value of shouldOffer. When 'voice', shouldOffer is true if offeringAsap, offeringScheduleVoice, or offeringTextIntercept is true. When 'digital', shouldOffer is true if offeringAsap or offeringScheduleWidget is true.

Allowed values:
voicedigital

For a 200 response code, the response body is an object containing data, an object with current offer decision attributes.

data
object
afterHours
boolean

Whether the estimated callback time falls outside of the current business hours.

availableTimeslots
boolean

Whether there are available timeslots for scheduled callbacks within the current business hours.

estimatedCallbackTime
integer or null

An estimate of the duration, in seconds, that a customer would be waiting for their callback.

id
number

The unique identifier for this call target.

isEndOfDay
boolean

Whether the estimated callback time falls within the end of day time period.

offeringAsap
boolean

Whether the call target is currently offering ASAP callbacks.

offeringChooseHold
boolean

Whether the call target is currently offering customers the "choose hold" option.

offeringNextDay
boolean

Whether the call target is currently offering next-day callbacks.

offeringScheduleVoice
boolean

Whether the call target is currently offering voice-scheduled callbacks.

offeringScheduleWidget
boolean

Whether the call target is currently offering widget-scheduled callbacks.

offeringTextIntercept
boolean

Whether the call target is currently offering customers the voice to text message option.

processingEnabled
boolean

Whether the call target is currently processing callbacks.

registrationEnabled
boolean

Whether callbacks are able to be registered for this call target.

shouldOffer
boolean

Whether the call target is currently offering callbacks.

Auth
:
Server Variables
:
Parameters
:
:
curl --request GET \
--url https://api.getmindful.com/v2/callback/callTargets/id/offerDecision \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123'
Response Example
1
{
2
"data": {
3
"afterHours": true,
4
"availableTimeslots": true,
5
"estimatedCallbackTime": 0,
6
"id": 0,
7
"isEndOfDay": true,
8
"offeringAsap": true,
9
"offeringChooseHold": true,
10
"offeringNextDay": true,
11
"offeringScheduleVoice": true,
12
"offeringScheduleWidget": true,
13
"offeringTextIntercept": true,
14
"processingEnabled": true,
15
"registrationEnabled": true,
16
"shouldOffer": true
17
}
18
}