Technical requirements for participating in the multi-conversations beta program
In order to use the multi-conversation feature, customers must upgrade to the v2.10.0 or a later version of the Zendesk SDKs. Note that end users with older versions of the Zendesk SDK will not be able to use the multi-conversation feature. These customers will continue to have the existing single conversation experience in messaging.
Enabling and disabling the multi-conversations
As part of your onboarding to the program we will enable the feature for your account. Throughout the program, you will have the control to disable it and enable again anytime by using our Sunshine Conversations API.
Please see more information in this article about how end user experience and agent experience get impacted when multi-conversations is disabled.
Here is the API documentation for the endpoint customers need to use in order to enable/disable multi-conversations. Configuring the 'canUserCreateMoreConversations' parameter to FALSE will disable the feature, and TRUE will enable it.
Note that using the API requires a Conversations API key which can be created inside the Admin Center. (Visit this help centre article for more information on creating a Conversations API key.)
Presenting the messaging screen for multi-conversations (for iOS)
With the multi-conversations feature enabled, calling the messagingViewController() method will return a view controller that either displays a particular conversation screen or the conversations list screen, depending on the use case. You can use your preferred presentation style (push, modal) to present the view controller. Note that you must embed the view controller in a UINavigationController if presenting modally.
How to test the feature before rolling it out to your customer base
Beta participants can test the feature via their Sandbox test accounts. Once the beta program is enabled by us for your test account, you can configure the 'canUserCreateMoreConversations' parameter as explained above, by using the Conversations API key you will get for your test account from the Admin Center.
Technical limitations of the beta program
Below are some limitations for customers who use Sunshine Conversations APIs.
- Our V1 Sunshine Conversations APIs don’t support multi-conversations feature, and they shouldn’t be used by Multi-conversation Beta participants as it would cause unexpected results.
- Customers should not merge users, as the multi-conversations feature currently doesn’t support user merging. Merging users will cause unexpected results.