Category: API
Summary:
There are breaking changes being made to the response of the GET journey/sessions/{sessionId}/events endpoint, which is currently in preview status. These are:
- customerId field is now optional
- customerIdType field is now optional
- externalContact field is being removed
- conversationAbandonedEvent field is being removed
- conversationAgentConnectedEvent field is being removed
- conversationAgentWrappedupEvent field is being removed
- conversationIvrDisposedEvent field is being removed
- conversationIvrMilestoneEvent field is being removed
- conversationRoutingEvent field is being removed
- com.genesys.conversation.ConversationAbandonedEvent is being removed as a valid EventType
- com.genesys.conversation.ConversationAgentConnectedEvent is being removed as a valid EventType
- com.genesys.conversation.ConversationAgentWrappedupEvent is being removed as a valid EventType
- com.genesys.conversation.ConversationIvrDisposedEvent is being removed as a valid EventType
- com.genesys.conversation.ConversationIvrMilestoneEvent is being removed as a valid EventType
- com.genesys.conversation.ConversationRoutingEvent is being removed as a valid EventType
Context:
The Predictive Engagement platform is being made more contact-centric. As a result of this work, customerId and customerIdType will not be set on some event types so the API contract is being updated to reflect that by making those fields optional. Further to this, externalContact will not be part of the GET events API response; it will continue to be supported on the GET sessions API response.
The conversation related fields were introduced as part of a conversation journey beta and are not required on this events API for the feature to operate, hence they are being removed.
Impact:
As this API is in preview status and therefore subject to change without notice, we are making these changes to it immediately. There will be no end-user impact.
Date of Change: Imminent.