- 06 Sep 2024
- 8 Minutes to read
- Print
- DarkLight
- PDF
Retrieve Call Target details
- Updated on 06 Sep 2024
- 8 Minutes to read
- Print
- DarkLight
- PDF
The call target ID.
For a 200 response code, the response body is an object containing data, which describes a call target.
Describes a call target configuration.
Whether to adaptively call customers before the agent answers.
The call center phone number. Either a SIP address or PSTN number.
Whether to use TLS when dialing the contact center agent.
Whether to connect the agent with the customer for any speech recognition.
Whether to allow extension or phone number.
Whether to allow widget-scheduled callbacks.
Whether to allow widget callback scheduling outside hours.
Whether to allow agent answer voice recognition.
Whether to allow voice-scheduled callbacks.
Whether to allow allow voice callback scheduling outside of business hours.
Whether the system will announce the ANI to the customer and let them use ANI for the callback number.
Whether Callback Double Check (CBDC) is enabled.
If Call Target
, checks for duplicate callback requests only on this call target. If Organization
, checks for duplicate callback requests for all call targets.
Whether to append a UUI string to the Refer-To
header on SIP messages to the contact center.
Whether the system will announce the estimated callback time before the callback offer prompt.
Whether the system will announce the estimated callback time after a successful callback registration.
Whether to announce the time of day for next day callbacks. If null
, either "morning" or "afternoon" will be announced.
Whether to send media traffic through the Mindful platform during the entire customer/agent call.
The number for extension only callbacks. Either a valid PSTN number or a SIP address.
The minimum callback delay, in seconds.
How callback calls should be delivered.
How "choose hold" calls should be delivered.
Whether "choose hold" failover is enabled.
How failover "choose hold" calls should be delivered.
The number to use as the failover for "choose hold" calls.
Describes metadata submitted with a callback registration.
Whether the metadata item is inherited from the global settings.
The maximum length of the recording, in seconds.
The metadata item name.
If false
, metadata will be deleted when a call is finalized.
The partie(s) to which the prompt will be announced.
The slugified metadata key.
The metadata value type.
A comma-separated list of country codes that will be removed from the announced ANI but prefixed to the customer's callback number.
Whether to use a custom callback failover number.
How callback failover calls should be delivered.
The number to use for failover calls.
The number of seconds to ring the customer before hanging up.
The number of times the hailing message is repeated before timing out.
Whether to use TLS when dialing the customer.
Whether to enable in-band DTMF detection on the outbound agent call.
Whether callbacks will use dynamic DNIS mapping to determine how to dial the agent.
The maximum callback time the customer can expect, in seconds.
The minimum callback time the customer can expect, in seconds.
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.
Whether callbacks will be launched for this call target.
Whether callbacks are able to be registered for this call target.
The fixed time margin for end of day handling, in minutes.
Whether callbacks will be offered as soon as possible.
For agent-first calls, whether to leave a voicemail if the agent hangs up within 8 seconds.
The maximum number of simultaneous calls that will be handled at a time.
The maximum number of digits required or allowed in a dial string.
The maximum estimated callback time before disabling callbacks, in minutes. If 0, callbacks will never be disabled.
The maximum number of callbacks that can be scheduled for the next day.
The maximum number of times a callback should be retried when the customer can't be reached.
The maximum number of requested callbacks before disabling callback. If 0, callbacks will never be disabled.
The ID of the media set. If omitted, the "Default English" media set is used.
Whether the customer will be notified via SMS that their callback has been successfully registered.
The ASCII text of the message to be sent to customers to confirm that their callback request has been registered.
The ID of the widget used for sending the confirmation notification to customers.
Whether the customer will be notified via SMS that their callback has failed.
The ASCII text of the message to be sent to the customer when we are no longer going to attempt to retry the callback.
The ID of the widget used for sending the failed notification to customers.
The phone number from which notification messages will be sent.
Whether to enable the voice to text message option.
Whether the customer will be sent an SMS message to remind them 15 minutes prior to a scheduled callback.
The ASCII text of the message to be sent to customers to remind them of their scheduled callback.
The ID of the widget used for sending the reminder notification to customers.
The ASCII text of the message to be sent to customers who have chosen to schedule a callback via Messaging.
The ID of the widget used for sending the scheduled callback text to customers.
Whether the customer will be sent an SMS message after a successful callback is complete.
The ASCII text of the message to be sent to customers after their call.
The ID of the widget used for sending the successful notification to customers.
The ID of the widget used for sending the voice to text message to customers
The minimum number of digits required in a dial string.
The minimum number of options to present to the user when offering a widget-scheduled callback.
The number of minutes from the open time that next day callbacks can be scheduled.
Whether to ask the customer if they would like a callback or if they would like to choose to stay on hold.
Whether to offer next-day callbacks during the end of day period.
Whether to allow the customer to return to hold during the end of day period.
The number to send "choose hold" calls to. Either a valid PSTN number or a SIP address.
Additional digits to navigate an IVR on a callback.
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.
Whether to prompt the customer with options to confirm or cancel upon callback.
Whether to prompt the customer with the option to reschedule the callback for a later time.
The number of simultaneous calls should be placed in queue awaiting agent. If null
, the queue limit is unlimited.
The speech detection confidence level, in a percentage, for recognizing that the agent is connected.
An array of words or phrases that agents can speak to accept a callback.
Whether the system will still register a callback if a customer hangs up before the end of the registration process.
Whether to require the country code to be entered with the callback number.
Whether to process retry attempts after hours.
The number of seconds before retry attempts are launched.
The method by which callbacks will be scheduled.
The maximum number of days from the current date that widget callbacks can be scheduled.
Whether to use SIP REFER to redirect inbound calls to the "choose hold" destination.
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.
The prefix announced to the customer as part of the ANI.
The party that will be connected first.
The time zone of the call target, as an IANA time zone string.
The phone number customers will see when receiving their callback. ^[0-9-]*$
Whether to use a custom WAV file when announcing the callback number.
Whether to use the current estimated callback time as the time margin to determine end of day.
Whether to use the P-Asserted-Identity
header when dialing the agent.
Whether to use the P-Asserted-Identity
header when dialing the customer.
Whether to enable speech recognition. When false
, DTMF will be used instead of speech recognition.
The maximum number of days from the current date that voice callbacks can be scheduled.
Whether to wait for live agent confirmation before connecting calls.
The call target ID.
The name of the call target.
The phone numbers associated with the call target.
The request failed validation
The incoming token has expired. See the Authentication endpoint documentation for information on obtaining a new access token.
No call target exists for the given ID
Internal or system-related error