Description
The Genesys Cloud for Salesforce External Routing (unmanaged) package version 1.7 and lower requires manual code change or installation of a newer version of the package to avoid breakage caused by the deprecation and upcoming removal of the open messaging API endpoint. This removal is slated for October 31, 2024, provided there is no customer usage of the endpoint.
Learn more about the deprecation of the open messaging API endpoint.
Note: Customers who have installed the new version of the package, version 1.8 or higher, are not impacted by this change.
Change Category
Informational
API
Change Context
Deprecation: conversations/messages/inbound/open endpoint (UPDATED 18 April 2024)
Genesys Cloud will mark as deprecated the POST /api/v2/conversations/messages/inbound/open endpoint.
The old endpoint confused users who did not know the information to provide when using the endpoint. To remedy this, we have created three new endpoints:
POST /api/v2/conversations/messages/{integrationId}/inbound/open/event if a user want to send typing event
POST /api/v2/conversations/messages/{integrationId}/inbound/open/message if a user want to send a text message
POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt if a user is sending a receipt
Change Impact
Customers who do not manually update their Salesforce External Routing Package OR use the package version 1.8 or higher, will no longer be able to use the external routing solution.
Customers have two options to continue using Salesforce External Routing Package:
-
Install the latest version of the unmanaged package version 1.8 or higher (Note. All custom development created would need to be migrated over manually)
Install and configure the Genesys Cloud for Salesforce External Routing package -
Make manual changes. Details on how to make the manual changes are shown below:
In the OpenMessageService.cls file:
Change the old endpoint to the new endpoint:
Old: /api/v2/conversations/messages/inbound/open
New: /api/v2/conversations/messages/{integrationId}/inbound/open/message
Remove the to and platform properties from the channel object
and the type and direction properties from the request body object
In the OpenMessageServiceTests.cls file:
Update the old endpoint to the new endpoint in the following two unit tests:
testCreate
testCreateWithCustomAttributes
Old: /api/v2/conversations/messages/inbound/open
New: /api/v2/conversations/messages/{integrationId}/inbound/open/message
Date of Change
31 Oct 2024
Impacted APIs
POST /api/v2/conversations/messages/inbound/open
References
[PLT-882]
[PLT-1018]
[PLT-1525]
[CWC-6038]
