Interaction

Note: Some of the following properties may not be available on all instances of Interactions the PTK returns.

Properties:

• id: Identifier for this call
• tenant: Tenant
• queue: VHT queue
• segment: PTK Segment
• contact: Phone number
• interaction_type: Type of interaction
• information: Key-value pairs of interaction information
• user_data: Key-value pairs of attached user data

Segment

Note: Some of the following properties may not be available on all instances of Segment the PTK returns.

Properties:

• tenant: Tenant
• queue: VHT queue
• name: PTK segment
• stateData: Segment state data
• variables: Segment variables

Methods:

• scheduledCallbackEnabled: Helper method for evaluating queueVariables call, returns true if scheduled callback is enabled
• rescheduledCallbackEnabled: Helper method for evaluating queueVariables call, returns true if rescheduled callback is enabled
• virtualQueueMenuEnabled: Helper method for evaluating queueVariables call, returns true if virtual queue menu is enabled
• speakMaxEwt: Helper method for evaluating queueVariables call, returns true if the system is configured to speak the maximum EWT
• speakMinEwt: Helper method for evaluating queueVariables call, returns true if the system is configured to speak the minimum EWT

Status

Note: Some of the following properties may not be available on all instances of Status the PTK returns.

Properties:

• code: Numeric code for status result
• result: Short name for status result
• description: Description of status result
• error_message: Extended error message returned with some errors

Methods:

• isValid: Helper method for evaluating whether the return value from the PTK was valid. If code is 107000 or 107001, Status is considered valid.