Please ensure Javascript is enabled for purposes of website accessibility
Retrieve Call Target details
  • 06 Sep 2024
  • 8 Minutes to read
  • Dark
    Light
  • PDF

Retrieve Call Target details

  • Dark
    Light
  • PDF

Article summary

Get
/v2/callback/callTargets/{id}
Security
OAuth
FlowClient credentials
Token URLhttps://auth.getmindful.com/oauth2/token
Path parameters
id
integerRequired

The call target ID.

Responses
200

For a 200 response code, the response body is an object containing data, which describes a call target.

Expand All
object
data
object
callTarget
object (CallTargetModel)

Describes a call target configuration.

configuration
object
onDeckCallback
boolean

Whether to adaptively call customers before the agent answers.

Defaultfalse
callbackAgentDestination
string

The call center phone number. Either a SIP address or PSTN number.

useTlsForAgentCallLeg
boolean

Whether to use TLS when dialing the contact center agent.

Defaultfalse
allowAnyRecognitionForAgentAnswerRecognition
boolean

Whether to connect the agent with the customer for any speech recognition.

Defaulttrue
allowCallbackExtension
boolean

Whether to allow extension or phone number.

Defaultfalse
offerScheduledCallbackWidget
boolean

Whether to allow widget-scheduled callbacks.

Defaulttrue
enableWidgetScheduledCallbackAfterHours
boolean

Whether to allow widget callback scheduling outside hours.

Defaulttrue
allowAgentAnswerRecognition
boolean

Whether to allow agent answer voice recognition.

Defaultfalse
offerScheduledCallbackVoice
boolean

Whether to allow voice-scheduled callbacks.

Defaultfalse
enableVoiceScheduledCallbackAfterHours
boolean

Whether to allow allow voice callback scheduling outside of business hours.

Defaultfalse
announceAni
boolean | null

Whether the system will announce the ANI to the customer and let them use ANI for the callback number.

Defaulttrue
enableCallbackDoubleCheck
boolean | null

Whether Callback Double Check (CBDC) is enabled.

Defaulttrue
callbackDoubleCheckScope

If Call Target, checks for duplicate callback requests only on this call target. If Organization, checks for duplicate callback requests for all call targets.

AnyOf
string
string
Valid values[ "", "Call Target", "Organization" ]
| null
appendUuiToReferToHeader
boolean | null

Whether to append a UUI string to the Refer-To header on SIP messages to the contact center.

Defaultfalse
announceEcbtBeforeOffer
boolean

Whether the system will announce the estimated callback time before the callback offer prompt.

Defaultfalse
announceEcbtAfterRegistration
boolean | null

Whether the system will announce the estimated callback time after a successful callback registration.

Defaulttrue
announceNextDayCallbackTimeOfDay
boolean | null

Whether to announce the time of day for next day callbacks. If null, either "morning" or "afternoon" will be announced.

Defaultfalse
useBridgeMedia
boolean | null

Whether to send media traffic through the Mindful platform during the entire customer/agent call.

Defaultfalse
numberForExtensionOnlyCallbacks
string

The number for extension only callbacks. Either a valid PSTN number or a SIP address.

minCallbackDelay
integer

The minimum callback delay, in seconds.

Minimum0
Maximum7200
Default30
callbackTelephonyType
string

How callback calls should be delivered.

Valid values[ "PSTN", "SIP" ]
chooseHoldTelephonyType
string

How "choose hold" calls should be delivered.

Valid values[ "PSTN", "SIP" ]
enableChooseHoldFailover
boolean

Whether "choose hold" failover is enabled.

Defaultfalse
chooseHoldFailoverTelephonyType
string

How failover "choose hold" calls should be delivered.

Valid values[ "PSTN", "SIP" ]
chooseHoldFailoverAgentDestination
string | null

The number to use as the failover for "choose hold" calls.

metadata
Array of object

Describes metadata submitted with a callback registration.

object
fromClient
boolean

Whether the metadata item is inherited from the global settings.

maxLength
integer

The maximum length of the recording, in seconds.

Minimum0
Maximum99999999999999
mediaName
string
Valid values[ "account_id", "custom_prompt", "full_name", "reason_for_call" ]
name
string

The metadata item name.

persistForever
boolean

If false, metadata will be deleted when a call is finalized.

Defaultfalse
presentTo
string

The partie(s) to which the prompt will be announced.

Valid values[ "agent", "both", "customer", "neither" ]
slug
string

The slugified metadata key.

type
string

The metadata value type.

Valid values[ "numeric", "record", "sip_header" ]
countryCodes
string

A comma-separated list of country codes that will be removed from the announced ANI but prefixed to the customer's callback number.

enableCallbackFailover
boolean | null

Whether to use a custom callback failover number.

Defaultfalse
callbackFailoverTelephonyType
string

How callback failover calls should be delivered.

Valid values[ "PSTN", "SIP" ]
callbackFailoverAgentDestination
string

The number to use for failover calls.

customerDialTimeout
integer

The number of seconds to ring the customer before hanging up.

Minimum5
Maximum120
customerPromptLoops
integer

The number of times the hailing message is repeated before timing out.

Minimum1
Maximum10
useTlsForCustomerCallLeg
boolean | null

Whether to use TLS when dialing the customer.

Defaultfalse
useInBandDtmfDetectionForAgentCallLeg
boolean | null

Whether to enable in-band DTMF detection on the outbound agent call.

Defaultfalse
dynamicDnisMappingEnabled
boolean

Whether callbacks will use dynamic DNIS mapping to determine how to dial the agent.

Defaultfalse
maxEcbtPlayback
integer

The maximum callback time the customer can expect, in seconds.

Minimum60
Maximum86400
Default14400
minEcbtPlayback
integer

The minimum callback time the customer can expect, in seconds.

Minimum60
Maximum86400
Default60
ecbtPlaybackType
string

If exact, the current estimated callback time will be announced to the customer. If range, a timespan encompassing the estimated callback time will be announced to the customer.

Valid values[ "exact", "range" ]
enableCallbackProcessing
boolean

Whether callbacks will be launched for this call target.

Defaulttrue
enableCallbackRegistration
boolean | null

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

Defaulttrue
endOfDayTimeMargin
integer

The fixed time margin for end of day handling, in minutes.

Minimum0
Maximum1440
offerAsapCallback
boolean

Whether callbacks will be offered as soon as possible.

Defaulttrue
leaveVoicemailOnEarlyHangup
boolean

For agent-first calls, whether to leave a voicemail if the agent hangs up within 8 seconds.

Defaulttrue
maxActiveCalls
integer | null

The maximum number of simultaneous calls that will be handled at a time.

maxCallbackNumberLength
integer

The maximum number of digits required or allowed in a dial string.

Minimum4
Maximum25
Default11
maxEcbtToDisableCallback
integer

The maximum estimated callback time before disabling callbacks, in minutes. If 0, callbacks will never be disabled.

Minimum0
Maximum86400
Default0
maxNextDayCallbacks
integer

The maximum number of callbacks that can be scheduled for the next day.

Minimum0
Maximum99999999999999
Default0
maxCallbackRetries
integer

The maximum number of times a callback should be retried when the customer can't be reached.

Minimum0
Maximum40
Default2
maxCallbacksToDisableCallback
integer

The maximum number of requested callbacks before disabling callback. If 0, callbacks will never be disabled.

Minimum0
Maximum1000000
Default0
mediaSetId
string

The ID of the media set. If omitted, the "Default English" media set is used.

messaging
object
confirmationNotication
object
enabled
boolean

Whether the customer will be notified via SMS that their callback has been successfully registered.

Defaultfalse
text
string

The ASCII text of the message to be sent to customers to confirm that their callback request has been registered.

widgetId
string

The ID of the widget used for sending the confirmation notification to customers.

failedNotification
object
enabled
boolean

Whether the customer will be notified via SMS that their callback has failed.

Defaultfalse
text
string

The ASCII text of the message to be sent to the customer when we are no longer going to attempt to retry the callback.

widgetId
string

The ID of the widget used for sending the failed notification to customers.

handle
string

The phone number from which notification messages will be sent.

Pattern^(\\+[\\d-]{10,15})?$
offerMessageIntercept
boolean

Whether to enable the voice to text message option.

Defaultfalse
reminderNotification
object
enabled
boolean

Whether the customer will be sent an SMS message to remind them 15 minutes prior to a scheduled callback.

Defaultfalse
text
string

The ASCII text of the message to be sent to customers to remind them of their scheduled callback.

widgetId
string

The ID of the widget used for sending the reminder notification to customers.

scheduledCallbackNotication
object
text
string

The ASCII text of the message to be sent to customers who have chosen to schedule a callback via Messaging.

widgetId
string

The ID of the widget used for sending the scheduled callback text to customers.

successfulNotification
object
enabled
boolean

Whether the customer will be sent an SMS message after a successful callback is complete.

Defaultfalse
text
string

The ASCII text of the message to be sent to customers after their call.

widgetId
string

The ID of the widget used for sending the successful notification to customers.

voiceToMessage
object
text
string
widgetId
string

The ID of the widget used for sending the voice to text message to customers

minCallbackNumberLength
integer

The minimum number of digits required in a dial string.

Minimum4
Maximum25
Default10
minSchedulingSlots
integer

The minimum number of options to present to the user when offering a widget-scheduled callback.

Minimum0
Maximum100
Default10
nextDayCallbackOffset
integer

The number of minutes from the open time that next day callbacks can be scheduled.

Minimum0
Maximum1440
Default60
offerChooseHold
boolean

Whether to ask the customer if they would like a callback or if they would like to choose to stay on hold.

Defaultfalse
offerNextDayCallback
boolean

Whether to offer next-day callbacks during the end of day period.

Defaultfalse
offerEndOfDayReturnToHold
boolean

Whether to allow the customer to return to hold during the end of day period.

Defaultfalse
chooseHoldAgentDestination
string

The number to send "choose hold" calls to. Either a valid PSTN number or a SIP address.

postDialDtmf
string | null

Additional digits to navigate an IVR on a callback.

Pattern^[0-9w;]*$
priorityQueueTimeout
integer | null

The limit on the length of time that a callback can remain in the high-priority holding queue without being accepted by an agent, in seconds.

Minimum0
Maximum300
promptCustomerToConfirmCallback
boolean

Whether to prompt the customer with options to confirm or cancel upon callback.

Defaulttrue
offerRescheduleCallback
boolean

Whether to prompt the customer with the option to reschedule the callback for a later time.

Defaulttrue
maxQueuedCalls
integer | null

The number of simultaneous calls should be placed in queue awaiting agent. If null, the queue limit is unlimited.

Minimum1
Maximum1000
agentAnswerRecognitionConfidenceLevel
integer | null

The speech detection confidence level, in a percentage, for recognizing that the agent is connected.

Minimum0
Maximum100
Default80
agentAnswerRecognitionKeywords
Array of string

An array of words or phrases that agents can speak to accept a callback.

Default[ "connect" ]
string
registerEarlyHangup
boolean | null

Whether the system will still register a callback if a customer hangs up before the end of the registration process.

Defaultfalse
requireCountryCode
boolean | null

Whether to require the country code to be entered with the callback number.

Defaultfalse
allowRetryAfterHours
boolean

Whether to process retry attempts after hours.

Defaultfalse
callbackRetryDelay
integer

The number of seconds before retry attempts are launched.

Minimum0
Maximum7200
Default300
scheduledCallbackExperience
string

The method by which callbacks will be scheduled.

Valid values[ "Notification", "Voice" ]
Default"'voice'"
widgetScheduledDaysAvailable
integer

The maximum number of days from the current date that widget callbacks can be scheduled.

Minimum0
Maximum365
useSipRefer
boolean | null

Whether to use SIP REFER to redirect inbound calls to the "choose hold" destination.

Defaulttrue
sipTerminationUri
string

Overriding SIP settings allows you to designate different behavior for Call Targets that face unique requirements for SIP communication. If your company uses its own SIP Trunk Termination URI to save money on toll charges compared to standard phone lines, you can enter it here to instruct Mindful to use it.

spokenAniPrefix
string | null

The prefix announced to the customer as part of the ANI.

Pattern^[0-9]*$
firstPartyCalled
string

The party that will be connected first.

Valid values[ "agent", "customer" ]
Default"'agent'"
timezone
string

The time zone of the call target, as an IANA time zone string.

callbackCallerId
integer

The phone number customers will see when receiving their callback. ^[0-9-]*$

useCustomCallerIdAudio
boolean

Whether to use a custom WAV file when announcing the callback number.

Defaultfalse
useEcbtForEndOfDay
boolean | null

Whether to use the current estimated callback time as the time margin to determine end of day.

Defaulttrue
usePaiForAgentDial
boolean | null

Whether to use the P-Asserted-Identity header when dialing the agent.

Defaultfalse
usePaiForCustomerDial
boolean | null

Whether to use the P-Asserted-Identity header when dialing the customer.

Defaultfalse
callerInput
boolean | null

Whether to enable speech recognition. When false, DTMF will be used instead of speech recognition.

Defaulttrue
voiceScheduledDaysAvailable
integer

The maximum number of days from the current date that voice callbacks can be scheduled.

Minimum0
Maximum7
waitForLiveAgent
boolean

Whether to wait for live agent confirmation before connecting calls.

Defaulttrue
id
integer

The call target ID.

name
string

The name of the call target.

phoneNumbers
Array of string

The phone numbers associated with the call target.

string
400

The request failed validation

401

The incoming token has expired. See the Authentication endpoint documentation for information on obtaining a new access token.

404

No call target exists for the given ID

500

Internal or system-related error


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.