Change History

Review what's new in this document.

November 2023

The following table lists changes introduced in this version of the document.

Change Type Description

For Agent:

Updates to the operation Added the DEPENDENCY_APPLICATION_TIMEOUT exception code in the response.

August 2023

The following table lists changes introduced in this version of the document.

Change Type Description
Create an engagement for Consumer Updates to the operation

Added the following attributes in the response:

  • cancelledSurveyIdString
  • completedSurveyIdString
  • sendSurveyIdString

Updated the following attributes in the response:

  • cancelledSurveyId
  • completedSurveyId
  • sendSurveyId
Get engagement queue for Consumer Updates to the operation

Added the following attributes in the response:

  • cancelledSurveyIdString
  • completedSurveyIdString
  • sendSurveyIdString

Updated the following attributes in the response:

  • cancelledSurveyId
  • completedSurveyId
  • sendSurveyId
About Establish Sessions Updates to the topic Added the ASYNC_REQUEST_ID key to the auxillaryData request attribute.

May 2023

The following table lists changes introduced in this version of the document.

Change Type Description
Create an engagement for Consumer Updates to the operation Added the following attributes to the response:
  • sendSurveyAuth
  • sendSurveyDelay
  • sendSurveyId
Get engagement queue for Consumer Updates to the operation

Added the following attributes to the response:

  • sendSurveyAuth
  • sendSurveyDelay
  • sendSurveyId

February 2023

The following table lists changes introduced in this version of the document.

Change Type Description
Create an automated agent session for Agent Updates to the operation Added the following attributes to the chatLogonResult object of the CreateAgentSessionResponse:
  • accountId
  • accountIdString
Added the following attribute to CreateAgentSessionRequest:
  • messageDataMap
Get system messages for Agent Updates to the operation Added the following attribute to the ChatEngagementParticipantAdded definition:
  • messageDataMap
Get engagement queue for Consumer Updates to the operation

Added the following attributes to the GetEngagementQueueResponse:

  • cancelledSurveyAuth
  • cancelledSurveyId
  • completedSurveyAuth
  • completedSurveyId
Get system messages for Consumer Updates to the operation Added the RNEngagementSurveyInformationMessage message type.
Added the following attribute to the ParticipantAddedMessage definition:
  • messageDataMap