Create a new Call Target

post
https://{api-gateway-hostname}
/v2/callback/callTargets

An object containing data, an object describing the call target to be created

data
object
required

Describes a call target configuration.

configuration
object
required
id
integer

The call target ID.

name
string
required

The name of the call target.

phoneNumbers
dictionary[string, string]

The phone numbers associated with the call target.

For a 201 response code, the response body is an object containing data, an object describing the newly-created call target.

data
object
configuration
object
id
integer

The call target ID.

name
string

The name of the call target.

phoneNumbers
dictionary[string, string]

The phone numbers associated with the call target.

Auth
:
Server Variables
:
Body
curl --request POST \
--url https://api.getmindful.com/v2/callback/callTargets \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"configuration": {
"agentAnswerRecognitionConfidenceLevel": 80,
"agentAnswerRecognitionKeywords": [
"connect"
],
"allowAgentAnswerRecognition": true,
"allowAnyRecognitionForAgentAnswerRecognition": true,
"allowCallbackExtension": true,
"allowRetryAfterHours": false,
"announceAni": true,
"announceEcbtAfterRegistration": true,
"announceEcbtBeforeOffer": false,
"announceNextDayCallbackTimeOfDay": false,
"appendUuiToReferToHeader": true,
"callbackAgentDestination": "string",
"callbackCallerId": 0,
"callbackDoubleCheckScope": "Call Target",
"callbackFailoverAgentDestination": "string",
"callbackRetryDelay": 300,
"callbackTelephonyType": "PSTN",
"callerInput": false,
"chooseHoldAgentDestination": "string",
"chooseHoldFailoverAgentDestination": "string",
"chooseHoldFailoverTelephonyType": "PSTN",
"chooseHoldTelephonyType": "PSTN",
"countryCodes": "",
"customerDialTimeout": 120,
"customerPromptLoops": 3,
"dynamicDnisMapping": [
{
"callbackAgentDestination": "string",
"callbackCallerId": "string",
"callbackFailoverAgentDestination": "string",
"callbackFailoverTelephonyType": "PSTN",
"callbackTelephonyType": "PSTN",
"chooseHoldAgentDestination": "string",
"chooseHoldFailoverAgentDestination": "string",
"chooseHoldFailoverTelephonyType": "PSTN",
"chooseHoldTelephonyType": "PSTN",
"key": {
"header": "string",
"type": "Diversion",
"value": "string"
}
}
],
"dynamicDnisMappingEnabled": false,
"ecbtPlaybackType": "range",
"enableCallbackDoubleCheck": true,
"enableCallbackFailover": false,
"enableCallbackProcessing": true,
"enableCallbackRegistration": true,
"enableChooseHoldFailover": false,
"enableVoiceScheduledCallbackAfterHours": false,
"enableWidgetScheduledCallbackAfterHours": true,
"endOfDayTimeMargin": 0,
"firstPartyCalled": "agent",
"leaveVoicemailOnEarlyHangup": true,
"maxActiveCalls": 0,
"maxCallbackNumberLength": 11,
"maxCallbackRetries": 2,
"maxCallbacksToDisableCallback": 0,
"maxEcbtPlayback": 14400,
"maxEcbtToDisableCallback": 0,
"maxNextDayCallbacks": 0,
"mediaSetId": "string",
"messaging": {
"confirmationNotification": {
"enabled": false,
"text": "string",
"widgetId": "string"
},
"failedNotification": {
"enabled": false,
"text": "string",
"widgetId": "string"
},
"handle": "string",
"offerMessageIntercept": true,
"reminderNotification": {
"enabled": false,
"text": "string",
"widgetId": "string"
},
"scheduledCallbackNotification": {
"text": "string",
"widgetId": "string"
},
"successfulNotification": {
"enabled": false,
"text": "string",
"widgetId": "string"
},
"voiceToMessage": {
"text": "string",
"widgetId": "string"
}
},
"metadata": [
{
"maxLength": 0,
"mediaName": "account_id",
"terminator": "string",
"type": "numeric",
"fromClient": true,
"name": "string",
"persistForever": true,
"presentTo": "agent",
"slug": "string"
}
],
"minCallbackDelay": 30,
"minCallbackNumberLength": 10,
"minEcbtPlayback": 60,
"minSchedulingSlots": 10,
"nextDayCallbackOffset": 60,
"numberForExtensionOnlyCallbacks": "string",
"offerAsapCallback": true,
"offerChooseHold": false,
"offerEndOfDayReturnToHold": false,
"offerNextDayCallback": false,
"offerRescheduleCallback": true,
"offerScheduledCallbackVoice": true,
"offerScheduledCallbackWidget": true,
"onDeckCallback": false,
"postDialDtmf": "string",
"priorityQueueTimeout": 0,
"promptCustomerToConfirmCallback": true,
"registerEarlyHangup": false,
"requireCountryCode": false,
"scheduledCallbackExperience": "Voice",
"sipTerminationUri": "string",
"spokenAniPrefix": "string",
"timezone": "string",
"useBridgeMedia": false,
"useCustomCallerIdAudio": false,
"useEcbtForEndOfDay": true,
"useInBandDtmfDetectionForAgentCallLeg": false,
"usePaiForAgentDial": false,
"usePaiForCustomerDial": false,
"useSipRefer": true,
"useSrvFailover": false,
"useTlsForAgentCallLeg": false,
"useTlsForCustomerCallLeg": false,
"voiceScheduledDaysAvailable": 0,
"waitForLiveAgent": true,
"widgetScheduledDaysAvailable": 0
},
"id": 0,
"name": "string",
"phoneNumbers": {
"property1": "string",
"property2": "string"
}
}
}'
Response Example
1
{
2
"data": {
3
"configuration": {
4
"agentAnswerRecognitionConfidenceLevel": 80,
5
"agentAnswerRecognitionKeywords": [
6
"connect"
7
],
8
"allowAgentAnswerRecognition": true,
9
"allowAnyRecognitionForAgentAnswerRecognition": true,
10
"allowCallbackExtension": true,
11
"allowRetryAfterHours": false,
12
"announceAni": true,
13
"announceEcbtAfterRegistration": true,
14
"announceEcbtBeforeOffer": false,
15
"announceNextDayCallbackTimeOfDay": false,
16
"appendUuiToReferToHeader": true,
17
"callbackAgentDestination": "string",
18
"callbackCallerId": 0,
19
"callbackDoubleCheckScope": "Call Target",
20
"callbackFailoverAgentDestination": "string",
21
"callbackRetryDelay": 300,
22
"callbackTelephonyType": "PSTN",
23
"callerInput": false,
24
"chooseHoldAgentDestination": "string",
25
"chooseHoldFailoverAgentDestination": "string",
26
"chooseHoldFailoverTelephonyType": "PSTN",
27
"chooseHoldTelephonyType": "PSTN",
28
"countryCodes": "",
29
"customerDialTimeout": 120,
30
"customerPromptLoops": 3,
31
"dynamicDnisMapping": [
32
{
33
"callbackAgentDestination": "string",
34
"callbackCallerId": "string",
35
"callbackFailoverAgentDestination": "string",
36
"callbackFailoverTelephonyType": "PSTN",
37
"callbackTelephonyType": "PSTN",
38
"chooseHoldAgentDestination": "string",
39
"chooseHoldFailoverAgentDestination": "string",
40
"chooseHoldFailoverTelephonyType": "PSTN",
41
"chooseHoldTelephonyType": "PSTN",
42
"key": {
43
"header": "string",
44
"type": "Diversion",
45
"value": "string"
46
}
47
}
48
],
49
"dynamicDnisMappingEnabled": false,
50
"ecbtPlaybackType": "range",
51
"enableCallbackDoubleCheck": true,
52
"enableCallbackFailover": false,
53
"enableCallbackProcessing": true,
54
"enableCallbackRegistration": true,
55
"enableChooseHoldFailover": false,
56
"enableVoiceScheduledCallbackAfterHours": false,
57
"enableWidgetScheduledCallbackAfterHours": true,
58
"endOfDayTimeMargin": 0,
59
"firstPartyCalled": "agent",
60
"leaveVoicemailOnEarlyHangup": true,
61
"maxActiveCalls": 0,
62
"maxCallbackNumberLength": 11,
63
"maxCallbackRetries": 2,
64
"maxCallbacksToDisableCallback": 0,
65
"maxEcbtPlayback": 14400,
66
"maxEcbtToDisableCallback": 0,
67
"maxNextDayCallbacks": 0,
68
"mediaSetId": "string",
69
"messaging": {
70
"confirmationNotification": {
71
"enabled": false,
72
"text": "string",
73
"widgetId": "string"
74
},
75
"failedNotification": {
76
"enabled": false,
77
"text": "string",
78
"widgetId": "string"
79
},
80
"handle": "string",
81
"offerMessageIntercept": true,
82
"reminderNotification": {
83
"enabled": false,
84
"text": "string",
85
"widgetId": "string"
86
},
87
"scheduledCallbackNotification": {
88
"text": "string",
89
"widgetId": "string"
90
},
91
"successfulNotification": {
92
"enabled": false,
93
"text": "string",
94
"widgetId": "string"
95
},
96
"voiceToMessage": {
97
"text": "string",
98
"widgetId": "string"
99
}
100
},
101
"metadata": [
102
{
103
"maxLength": 0,
104
"mediaName": "account_id",
105
"terminator": "string",
106
"type": "numeric",
107
"fromClient": true,
108
"name": "string",
109
"persistForever": true,
110
"presentTo": "agent",
111
"slug": "string"
112
}
113
],
114
"minCallbackDelay": 30,
115
"minCallbackNumberLength": 10,
116
"minEcbtPlayback": 60,
117
"minSchedulingSlots": 10,
118
"nextDayCallbackOffset": 60,
119
"numberForExtensionOnlyCallbacks": "string",
120
"offerAsapCallback": true,
121
"offerChooseHold": false,
122
"offerEndOfDayReturnToHold": false,
123
"offerNextDayCallback": false,
124
"offerRescheduleCallback": true,
125
"offerScheduledCallbackVoice": true,
126
"offerScheduledCallbackWidget": true,
127
"onDeckCallback": false,
128
"postDialDtmf": "string",
129
"priorityQueueTimeout": 0,
130
"promptCustomerToConfirmCallback": true,
131
"registerEarlyHangup": false,
132
"requireCountryCode": false,
133
"scheduledCallbackExperience": "Voice",
134
"sipTerminationUri": "string",
135
"spokenAniPrefix": "string",
136
"timezone": "string",
137
"useBridgeMedia": false,
138
"useCustomCallerIdAudio": false,
139
"useEcbtForEndOfDay": true,
140
"useInBandDtmfDetectionForAgentCallLeg": false,
141
"usePaiForAgentDial": false,
142
"usePaiForCustomerDial": false,
143
"useSipRefer": true,
144
"useSrvFailover": false,
145
"useTlsForAgentCallLeg": false,
146
"useTlsForCustomerCallLeg": false,
147
"voiceScheduledDaysAvailable": 0,
148
"waitForLiveAgent": true,
149
"widgetScheduledDaysAvailable": 0
150
},
151
"id": 0,
152
"name": "string",
153
"phoneNumbers": {
154
"property1": "string",
155
"property2": "string"
156
}
157
}
158
}