Platform Toolkit glossary

Overview

Some terms are used with the Platform Toolkit differently than they might otherwise be used. This topic describes how these terms are used with the Platform Toolkit.

TermDefinition
Action
  • The change that you want to perform to an interaction. Valid values are AppointmentTime and Result. You can use AppointmentTime to change the time of a scheduled interaction or Result to change the result code for the interaction.
  • A parameter used in Platform Toolkit requests.
AppointmentTime
  • The time of day that a scheduled interaction occurs. When you use this term as a parameter to select an appointment time, the system checks and allocates time slots during the next 7 days.Important: You must use Coordinated Universal Time (UTC) format, yyyy-mm-ddTHH:mm:ssZ.If you do not use this element, the request submits the default value which is the Queue Manager server time.
  • An element used in Platform Toolkit request parameters.
AppointmentTimes
  • The time slots that are available during the submitted time frame. See AppointmentTime in this glossary.Important: The Platform Toolkit uses Coordinated Universal Time (UTC) format, yyyy-mm-ddTHH:mm:ssZ.
  • A response to Platform Toolkit requests.
CBDC
  • Callback Double Check
ClientId
  • An ID code that the client application can pass through to the VHT Callback® system. This element is useful when you want to track an interaction through the entire process from client application to Callback and back again.
  • An element used in Platform Toolkit request parameters.
Contact
  • The number or address at which a caller should be contacted for an interaction, usually a telephone number.
  • A parameter used in Platform Toolkit Requests.
  • An element used in Platform Toolkit Request parameters.
ContactURI
  • The URI that contains the contact number as well as the appointment time (if needed). It designates the interaction to be an ASAP callback or an appointment call depending on how it is formatted when calling InteractionRequestContact.
  • ASAP callbacks must contain only the phone number in the URI. An example of this format is: voice://3305551212.

"voice://" must be entered before the phone number.

  • Appointment callbacks contain the phone number as well as the date in the URI. An example of this format is: voice://3305551212/?appt=2012-03-23T15:20:00Z.

"voice://" must be entered before the phone number and date.

DataType
  • The type of object that you are submitting. Valid DataTypes are String, Number, BulkData and List.Important: If you are submitting a list, you must use the List DataType. Otherwise, this value is optional.
  • A value for an element used in Platform Toolkit request parameters.
GUID
  • Globally Unique Identifier. A unique ID number assigned to an item in a computer system.
Id
  • A GUID created by Callback for each request that is made to the Platform Toolkit. This element is useful for tracking an interaction through the entire Callback system, including the Platform Toolkit. It is helpful during troubleshooting and appears in the Callback logs.
  • An element used in Platform Toolkit responses.
Information
  • Important facts about the interaction. Valid values are AppointmentTime and EWT. Submit AppointmentTime to retrieve the time for a scheduled interaction. Use EWT to retrieve the estimated wait time for a first-available interaction.
  • An element used in Platform Toolkit responses.
Interaction
  • An interaction is an event in a Callback queue that will take place at either the first available time, or for a specific time in the future. The most common interaction is a callback.
InteractionId
  • An ID code generated by Queue Manager for each interaction. This code is useful for tracking an interaction through the entire Callback system, including the Platform Toolkit. In Callback, InteractionIds are often referred to as VH Call IDs.
  • A parameter used in Platform Toolkit requests.
  • An element used in Platform Toolkit request parameters.
Interactions
  • See Interaction in this glossary.
  • A response to Platform Toolkit requests.
InteractionType
  • Identified whether the interaction is a first-available interaction or an appointment. An interaction with a FIFO InteractionType is a first-available interaction. An interaction with an Appointment InteractionType is a scheduled interaction.
  • An element used in Platform Toolkit responses.
Name
  • The name of the object that you requested or that you submitted.For example, when you use GetSegmentVariables, the name is the Queue Variable. When you use AddInteraction, the name is the key name in the key value pair.
  • An element used in Platform Toolkit request parameters.
  • An element used in Platform Toolkit responses.
  • A value used in elements to Platform Toolkit request parameters.
NumberofAppointments
  • The desired number of available appointments to retrieve when submitting GetNextAvailableAppointmentTimes.
  • If you do not submit this element, the value defaults to 4.
  • If the submitted value is greater than the total number of available appointments, the complete list of available appointments AND an error message (about partial task completion) are returned. Response to this error message is unnecessary.
  • An element used in Platform Toolkit Request parameters.
Options
  • Additional information about the request. These values tell the Callback Platform to perform actions that are outside of the standard actions typically performed as a result of the request.
  • A parameter used in Platform Toolkit requests.
  • A response to Platform Toolkit requests.
Queue
  • A list of interactions that are waiting for Callback treatment.
  • When returned as a response, the list or queue that the interaction or segment exists in.
  • An element used in Platform Toolkit responses.
Reason
  • The reason that you want to remove the interaction. Valid values are Web Cancelled and Admin Cancelled.
  • A parameter used in Platform Toolkit requests.
Result
  • A custom value that identifies how the call completed. It is used to communicate call-progress results to the Callback Platform. You might use this value, for example, if you use a third party IVR or another method to fulfill interactions.The client application sends this value to the Platform Toolkit, which translates the value to the standard Callback result code and then sends the translated code on to Queue Manager.Important: These codes must be configured in the message bus.
  • An element used in Platform Toolkit Request parameters.
Segment
  • Segments are labels for the different types of interactions that are handled in each of your Callback queues. The segments that you use in the Platform Toolkit mirror the segments that you have in your telephony system. In the Callback Platform, segments are often called Incoming Extensions.
  • A parameter used in Platform Toolkit requests.
  • An element used in Platform Toolkit responses.
Segments
  • See Segment in this glossary.
  • A response to Platform Toolkit requests.
StateData
  • Information about the current state of the queue including estimated wait time, operation mode, recommended destination, and whether customer should be offered Callback treatment.
  • An element used in Platform Toolkit responses.
Tenant
  • A tenant identifies a single installation of Callback. In the Callback Platform, tenants are called Site Names and are set when you install Callback.
  • A parameter used in Platform Toolkit requests.
  • An element used in Platform Toolkit request parameters.
  • An element used in Platform Toolkit responses.
UserData
  • User Data is data associated with an interaction, typically screen pop data. When you use the Platform Toolkit, you can use this element to attach user data to an interaction.
  • An element used in Platform Toolkit request parameters.
Value
  • The chosen setting for a variable in Callback.
  • A value used in elements to Platform Toolkit request parameters.
Variable
  • The settings that control what services Callback offers and how Callback offers the services. In Callback, variables are called Queue Variables.
  • An element used in Platform Toolkit parameters.
Variables
  • The Queue Variables that you requested the values for. See Variable and Value in this glossary.
  • An element used in Platform Toolkit responses.