{"id":42594,"date":"2022-07-12T08:20:33","date_gmt":"2022-07-12T07:20:33","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=42594"},"modified":"2023-12-18T07:40:58","modified_gmt":"2023-12-18T07:40:58","slug":"adding-the-sunshine-conversations-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-sunshine-conversations-channel\/","title":{"rendered":"Adding the Sunshine Conversations Channel"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\"><div class=\"w-separator size_medium\"><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>Virtual Assistants built on the Kore.ai XO Platform can be deployed on the <b>Sunshine Conversations<\/b> platform. This channel integration supports conversations with virtual assistants and provides a seamless hand-off to agents on <b>Zendesk<\/b>.<\/p>\n<h2><span class=\"ez-toc-section\" id=\"Authorizing_the_Koreai_Integration_to_Sunshine_Conversations\">Authorizing the Kore.ai Integration to Sunshine Conversations<\/span><\/h2>\n<p>To enable the integration, you need to provide authorization using your Zendesk credentials. Follow the steps below to complete the <b>OAuth-based authorization<\/b>:<\/p>\n<ol>\n<li>Log into the Kore.ai XO Platform.<\/li>\n<li>Navigate to <strong>Deploy<\/strong> \u2192 <strong>Channels<\/strong> \u2192 <strong>Sunshine Conversations<\/strong> Channel.<\/li>\n<li>Click the <b>Authorize<\/b> button under <b>Configurations<\/b> on the <b>Sunshine Conversations<\/b> panel.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221020101645\/Sunshine-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48421\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221020101645\/Sunshine-1.png\" alt=\"\" width=\"400\" height=\"200\" \/><\/a><\/li>\n<li>On the <b>Zendesk subdomain<\/b> page, provide the subdomain and click <b>Sign in<\/b>.<\/li>\n<li>On the Zendesk sign-in page, provide your login credentials and click <b>Sign in<\/b>.<\/li>\n<li>After you have signed in successfully, a pop-up window will appear asking you to allow Kore.ai to access your Zendesk account. Click on <b>Allow<\/b>.<\/li>\n<li>Once the integrated is created successfully, you\u2019ll be redirected to the Kore.ai XO Platform to complete the channel enablement process.<\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Switchboard_Integration_for_Agent_Handoff\">Switchboard Integration for Agent Handoff<\/span><\/h2>\n<p><span style=\"font-weight: 400;\">The Kore.ai XO Platform lets you hand off the conversation to your Zendesk agents via the <\/span><b>Zendesk Switchboard<\/b><span style=\"font-weight: 400;\"> using the <\/span><b>Agent Transfer<\/b><span style=\"font-weight: 400;\"> node.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">The <\/span><b>Switchboard Integration API<\/b><span style=\"font-weight: 400;\"> is used to route the user\u2019s conversations from Zendesk to the XO platform. This API has a pass control system to decide whether the conversation is to be routed to a Bot or a live agent.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">The <\/span><b>Pass Control<\/b><span style=\"font-weight: 400;\"> action is triggered as a part of the event where the conversation is switched to the Bot or the agent helpdesk, and also during conversation closure.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Developers can define custom metadata to be sent with the existing metadata from the XO Platform to Zendesk. The additional metadata can also be used to create a Zendesk ticket. <\/span><\/p>\n<p><b>Capturing the Session Closure Metadata<\/b><\/p>\n<p><span style=\"font-weight: 400;\">The Zendesk Sunshine Configuration flow lets you enable the <\/span><b>Session Closure Metadata <\/b><span style=\"font-weight: 400;\">field to let Kore.ai capture the metadata and share it with Zendesk <\/span><span style=\"font-weight: 400;\">as part of the pass control event triggered <\/span><span style=\"font-weight: 400;\">when the conversation is transferred to the agent\u2019s helpdesk,<\/span><span style=\"font-weight: 400;\"> or when closing a conversation session. The metadata is captured <\/span><span style=\"font-weight: 400;\">using the <\/span><b>key-value <\/b>pair <span style=\"font-weight: 400;\">you provide during the configuration.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">However, providing the key and value inputs when you enable <strong>Session Closure Metadata<\/strong> is <\/span><b>optional<\/b><span style=\"font-weight: 400;\">.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">For example:<\/span> <span style=\"font-weight: 400;\">When you provide <\/span><code>SessionKey<\/code> as <b>key<\/b> and <code>apikeyvalue<\/code><span style=\"font-weight: 400;\"> as <\/span><b>value<\/b><span style=\"font-weight: 400;\">, Kore.ai generates the field variable <\/span><code>SessionKey.apikeyvalue<\/code><span style=\"font-weight: 400;\"> to fetch the <\/span><i><span style=\"font-weight: 400;\">session API key<\/span><\/i><span style=\"font-weight: 400;\"> and pass it to Zendesk as metadata. Please refer to <\/span><b>Step 7<\/b><span style=\"font-weight: 400;\"><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-sunshine-conversations-channel\/#Steps_to_Set_up_Agent_Handoff\" target=\"_blank\" rel=\"noopener noreferrer\"> here<\/a> for configuring <\/span><b>Session Closure Metadata<\/b><span style=\"font-weight: 400;\">.<\/span><\/p>\n<p><strong>Important Information on Session Closure Metadata<\/strong><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">The Platform does not trigger the session closure message when the Agent transfer is initiated, and the conversation is not handed over back to the platform again.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">When the Conversation is handed over to the Platform after the agent transfer, the session closure functionality works as usual.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">For all the new bots or existing bots that do not have at least one <\/span><b>SessionClosure <\/b><span style=\"font-weight: 400;\">metadata tag, the <\/span><b>SessionClosure <\/b><span style=\"font-weight: 400;\">switch is turned off by default.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">For all the existing bots that have at least one<\/span><b> SessionClosure<\/b><span style=\"font-weight: 400;\"> metadata tag, the switch is turned on by default.<\/span><\/li>\n<li>\u00a0The Platform introduces the <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/koreutil-libraries\/#koreUtilgetSunshineConversationsMetadata\">KoreUtil.getSunshineConversationsMetadata() <\/a> function to let a Bot developer fetch the stored metadata (Get API operation), and use it for the following:\n<ul>\n<li>Entities where JavaScript is supported like advanced messages for a prompt, script nodes, etc.<\/li>\n<li>Simple messages like plain text prompts.<\/li>\n<\/ul>\n<\/li>\n<li>Any additional changes or updates to the channel configurations should go through the <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/publish\/publishing-bot\/\">Bot Publish<\/a> cycle.<\/li>\n<\/ul>\n<p><b>Selecting the Default and Next Integrations for Transferring Control<\/b><\/p>\n<p><span style=\"font-weight: 400;\">When you have a pre-existing switchboard integration, the XO Platform allows you to configure it as the default for the initial pass control during conversation initiation. Alternatively, you can select the Kore switchboard integration to designate the pass control.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">You can review and edit these Switchboard integrations for newly created or pre-existing channel configurations in the <\/span><b>Switchboard Configuration<\/b><span style=\"font-weight: 400;\"> window. The Switchboard Configuration includes the <\/span><b>Default Switchboard Integration<\/b><span style=\"font-weight: 400;\"> for initiating conversations and the<\/span><b> Next Switchboard Integration <\/b><span style=\"font-weight: 400;\">to transfer control after conversation session closure and the completion of agent conversations<\/span><b>. <\/b><span style=\"font-weight: 400;\">Please refer to<\/span><b> Step 4\u00a0 <\/b><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-sunshine-conversations-channel\/#Steps_to_Set_up_Agent_Handoff\" target=\"_blank\" rel=\"noopener noreferrer\">here<\/a><span style=\"font-weight: 400;\">\u00a0for more information<\/span><b>.<\/b><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Steps_to_Set_up_Agent_Handoff\"><span style=\"font-weight: 400;\">Steps to Set up Agent Handoff<\/span><\/span><\/h3>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Enable the <\/span><b>Enable Agent Handoff<\/b><span style=\"font-weight: 400;\"> option under <\/span><b>Configurations<\/b><span style=\"font-weight: 400;\"> in the <\/span><b>Sunshine Conversations<\/b><span style=\"font-weight: 400;\"> panel.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">From the <\/span><a href=\"https:\/\/support.zendesk.com\/hc\/en-us\/articles\/4581766374554#topic_hfg_dyz_1hb\"><span style=\"font-weight: 400;\">Zendesk Admin Center,<\/span><\/a><span style=\"font-weight: 400;\"> navigate to <\/span><b>Apps &amp; Integrations<\/b><span style=\"font-weight: 400;\"> and click the <\/span><b>Conversations API<\/b><span style=\"font-weight: 400;\"> menu option to get your <\/span><b>API Key<\/b><span style=\"font-weight: 400;\"> and <\/span><b>API Secret<\/b><span style=\"font-weight: 400;\">. Please get in touch with your Zendesk sales representative if you don\u2019t see this menu.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Paste these values in their respective fields on the Kore.ai platform under <\/span><b>Sunshine Conversations<\/b><span style=\"font-weight: 400;\"> &gt; <\/span><b>Configurations<\/b><span style=\"font-weight: 400;\"> &gt; <\/span><b>OAuth<\/b><span style=\"font-weight: 400;\"> &gt; <\/span><b>Enable Agent Handoff<\/b><span style=\"font-weight: 400;\"> section.<\/span><br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217072525\/agent-handoff.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-60602\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217072525\/agent-handoff.png\" alt=\"\" width=\"500\" height=\"600\" \/><\/a><\/li>\n<li>Click <b>Configure<\/b> for Switchboard Integration to set up the integrations available in your Sunshine Conversations account app.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217072903\/configure-switchboard-integration.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-60605\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217072903\/configure-switchboard-integration.png\" alt=\"\" width=\"530\" height=\"200\" \/><\/a><\/li>\n<li>Select the required option for the following integrations in the <strong>Switchboard Configuration<\/strong> window:\n<ul>\n<li><strong>Default Switchboard Integration<\/strong>: Select the primary contact point for users in your Sunshine Conversations application.<\/li>\n<li><strong>Next Switchboard Integration to Kore.ai<\/strong>: Select the next switchboard integration to which the control of a VA conversation is passed from Kore.ai.<\/li>\n<li><strong>Next Switchboard Integration to Agen<\/strong>t: Select the next switchboard integration to which control is transferred after an agent conversation with a user.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217073159\/switchboard-configuration-window.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-60608\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217073159\/switchboard-configuration-window.png\" alt=\"\" width=\"450\" height=\"600\" \/><\/a><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p>The options listed include the default mapped integrations and others available in your Sunshine Developer account.<\/p>\n<ul>\n<li>After selecting the above fields, click <strong>Done<\/strong>.<\/li>\n<li>On the <b>Zendesk Sunshine Configurations<\/b> window, follow either step below to set <b>Session Closure Metadata<\/b>:<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<ul>\n<li>Disable the toggle switch if you don\u2019t want the Platform to pass the session metadata to Zendesk.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217073757\/disable-toggle-switch.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-60611\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217073757\/disable-toggle-switch.png\" alt=\"\" width=\"600\" height=\"220\" \/><\/a><\/li>\n<li>Enable <strong>SessionClosure Metadata<\/strong>, and do one of the following:\n<ul>\n<li>Provide at least one <strong>Key<\/strong> and <strong>Value<\/strong> input (optional) to allow Kore.ai to capture the session metadata using the switchboard integration API and share it with Zendesk.<br \/>\nAdding these parameters and saving the configuration will create a Zendesk ticket with the conversation details and close it.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074114\/configure-session-closure-metadata.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-60614\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074114\/configure-session-closure-metadata.png\" alt=\"\" width=\"600\" height=\"300\" \/><\/a><\/li>\n<li>Skip the <strong>Key-Value<\/strong> input and move to the next step.<br \/>\nNot adding these parameters will create a Zendesk ticket with the conversation details but not close it.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ol start=\"8\">\n<li>Select <b><i>Yes<\/i><\/b> for <b>Enable Channel<\/b>.<\/li>\n<li>Click <b>Save<\/b>.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074542\/enable-sunshine-agent-handoff.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-60617\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074542\/enable-sunshine-agent-handoff.png\" alt=\"\" width=\"304\" height=\"158\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074542\/enable-sunshine-agent-handoff.png 528w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20231217074542\/enable-sunshine-agent-handoff-300x156.png 300w\" sizes=\"auto, (max-width: 304px) 100vw, 304px\" \/><\/a><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_medium\"><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Virtual Assistants built on the Kore.ai XO Platform can be deployed on the Sunshine Conversations platform. This channel integration supports conversations with virtual assistants and provides a seamless hand-off to agents on Zendesk. Authorizing the Kore.ai Integration to Sunshine Conversations To enable the integration, you need to provide authorization using your Zendesk credentials. Follow the...","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-42594","post","type-post","status-publish","format-standard","hentry","category-channel-enablement"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/42594","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=42594"}],"version-history":[{"count":76,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/42594\/revisions"}],"predecessor-version":[{"id":60712,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/42594\/revisions\/60712"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=42594"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=42594"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=42594"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}