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

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?

Hi Everyone,

I wanted to check in with the community and encourage those who haven’t yet switched to the new API endpoints to do so in the near future. Our statistics show that there are still 236 unique organizations using the old endpoint. Please don’t hesitate to ask any questions here if you encounter challenges during the migration.

Considering the work that remains, we’ve decided to move the deprecation date to January 30th, 2025.

Best regards,
Mike

Hello All,

When I try to run the new APIs it's give me Not found using the old body request

what could be the reason for that

Thanks,
Mohamed Tag

Hi @Mohamed_Tag_Eldin the old endpoint (single resource that contained text/media and receipt types. both) and the new endpoints (that are now split into 3 separate resources), are not exactly the same body. Please review the documentation to make sure you are formatting your requests correctly. inbound-open-message
As for your 404 (not found) it could be different things. It may likely be that your integrationId you provided is not correct. Either way you should receive more information than just "not found" response. Please review this documentation statuses and look at the whole error object to help you understand what happened (specifically the message). If you still have issues, you can open up a case with Customer Care

Hello @Mikael_Cohen , @Ademola_Kazeem ,
CC received a case from us-west-2 customer asking when the old API will stop working.
Do I understand it correctly that they are supposed to migrate to a new API by Jan 30 2025?
Thanks

If using the .NET SDK, what is the latest version that will point to the new endpoint? We have customers using older versions of the SDK and upgrading to a later version from the version they are on, could be problematic. I understand that being on the latest version is always the best, but due to other dependencies of the SDK, updating is not always straight forward.

Hi Lenard,

We automatically build the SDKs whenever a new API is released. So whenever that new endpoint becomes available you should see a corresponding SDK release shortly after.

Thanks,
John Carnell
Director, Developer Engagement

I guess what I am asking is if I am using version 148.0.2 of the .NET SDK will it continue working after January 30th, or will we need to update to the latest version before then to ensure continued service?

Hi Lenard,

If the old endpoints are removed and you are using them in the old .NET SDK you will need to upgrade. If you are not using the endpoints being removed you can still use the old SDK. I hope that helps clarify things.

Thanks,
John Carnell
Director, Developer Engagement

It does, thanks.

Hi,

We have a question about the customAttributes. In the old endpoint, we have the object metadata/customAttributes; in the new endpoint, we have only the metadata object. We don't have the customAttributes inside the metadata.

When I create a new conversationid I can't see the attributes on Participant Data.

How can we pass this information when I create the new conversationid?

API: https://api.sae1.pure.cloud/api/v2/conversations/messages/{integrationid}/inbound/open/message

Request:

{
"channel": {
"from": {
"firstName": "name",
"lastName": "lastname",
"idType": "Phone",
"id": "5531999999",
"nickname": "nickname"
},
"time": "2025-01-10T18:37:16.274Z"
},
"text": "Teste ola 2222222",
"metadata": {
"brokerin": "55888888888",
"tipo": "open"
}
}

@vmh.falcao the request body channel.metadata.customattributes is the same in the old endpoint and the new one (api/v2/conversations/messages/{integrationid}/inbound/open/message). you should be able to pass it exactly the same as you did before.