Messages APIs: GenericTemplate replaced by Card

Description

For APIs that use normalized messages, the GenericTemplate class was used to represent a rich media card that would be presented by a bot to a messaging consumer. Instead of using GenericTemplate, a dedicated Card type has been added. This functionality has not been released to GA so there should me minimal customer impact.

Change Category

API

Change Context

With the original design of Rich Media Cards we used the "GenericTemplate" type, but this presented some design issues. In order to improve the design we created a dedicated “Card” type to replace the “GenericTemplate.”

Change Impact

For bot providers that use cards, the message transcript will return data using the Card type instead of GenericTemplate. For Bot Connector users use the new cards structure instead of the Generic Template. More information can be found here: https://developer.genesys.cloud/commdigital/textbots/examples/botconnector-card-example

For any developers using the messaging APIs the Generic object has been deprecated and a new Card structure has been added for use with Rich Media Cards.

Date of Change

Jul 13, 2022

Impacted APIs

GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
GET /api/v2/conversations/messages/{messageId}/details
POST /api/v2/conversations/messages/{conversationId}/messages/bulk
POST /api/v2/textbots/bots/execute

References

MSG-3721, MSG-3876, CW-2775, CW-2774, CW-2692

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.