Deprecation: conversations/messages/inbound/open endpoint (UPDATED 18 April 2024)

Description

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 Category

API

Change Context

We are making this change to improve customer experience.

Change Impact

API is annotated as deprecated; it will be removed from service once all customers have migrated away from usage.

Date of Change

Resource removal is slated for 31 October, 2024, provided there is no customer usage of the endpoint

Impacted APIs

POST /api/v2/conversations/messages/inbound/open

References

[PLT-882]
[PLT-1018]
[PLT-1525]

3 Likes

Hi, please note, that if you are using Genesys Cloud Embeddable Framework, it will be updated soon to adopt the changes in Open Messaging endpoints. Please follow the announcements in the Developer Forum.

Hello,

I need to migrate to the new Genesys Cloud API and require the documentation for the old API endpoint POST /api/v2/conversations/messages/inbound/open, which is being deprecated.

Could you please provide the old API documentation to assist with this migration?

Thank you.

Best regards,

It hasn't moved. POST /api/v2/conversations/messages/inbound/open

1 Like

Good afternoon, I have a question, if this would apply only to the use of API, manually, or would it also have an impact on the npm SDK library purecloud-platform-client-v2. If it is affected, which version do you recommend using?

Thank you very much.

The platform client SDKs are simply a reflection of the API. You should always be using the latest SDK version because every older version is inconsistent with the API's current definition in some way.

1 Like

Hello Mikael,

Do you have an ETA on the delivery of Genesys Cloud for Salesforce that will adopt the change in Open Messaging ?

Thank you

Hi,

Checking this deprecation we´ve noted that the API api/v2/conversations/messages/inbound/open is being used from Salesforce in the unmanaged Genesys package we use for external routing, Genesys Cloud for Salesforce External Routing (Unmanaged).

The version we have installed is the latest version listed in this Resource Center article (current version 1.6):

I understand that a new version of this package will be released, right?

Thank you,
Regards

Rubén

Hi Ruben,

That is correct. It will require either a package version upgrade or a manual change. There will be a further announcement on the details shortly for this change in the Salesforce External Routing package.

Thanks
Thomas

1 Like

For Genesys Cloud for Salesforce External Routing customers this is applicable.
We would ask all customers to review and implement the changes no later than the 'Date of Change', indicated above.

1 Like

@thomasprendergast:

Our team is opening a Case with both Genesys & Salesforce, but were curious if anyone else is receiving the following error when attempting to upgrade their External Routing package to version 1.8 as referenced in the resource article. Does version 1.8 actually exist?

Upgrade Genesys Cloud for Salesforce External Routing (Unmanaged)

By Genesys


This app can't be upgraded. There are problems that prevent this package from being installed.

Package Not Found The requested package doesn't yet exist or has been deleted. If this is a recently created package version, please try again in a few minutes or contact the package publisher.


App Name
Genesys Cloud for Salesforce External Routing (Unmanaged)

Publisher
Genesys

Version Name
1.8

Version Number
1.8

Description
This version of the package contains a change to use the new Open Messaging API endpoint.

Hi Brian,
I would guess that you are trying to install the unmanaged package with an already existing one installed.

The correct way to upgrade your package is to uninstall the old version and install the new version as documented here: Install and configure the Genesys Cloud for Salesforce External Routing package - Genesys Cloud Resource Center - 'Upgrade to the latest version of the package'

Thanks
Thomas

Interesting @thomasprendergast - Then I wonder why the error wouldn't articulate it that way. The Salesforce admins are under the impression there is an external routing version 1.8 package to download first, and then they run the install install/upgrade it. You're saying it immediately does the install/upgrade from the URL...right?