{"id":56313,"date":"2023-03-29T08:18:47","date_gmt":"2023-03-29T07:18:47","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=56313"},"modified":"2023-04-17T07:47:10","modified_gmt":"2023-04-17T06:47:10","slug":"adding-the-smartassist-gateway-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-smartassist-gateway-channel\/","title":{"rendered":"Adding the SmartAssist Gateway 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><b>SmartAssist<\/b> is a Kore.ai Contact Center Automation Solution. It helps enterprises manage their contact center infrastructure from the omnichannel interface, voice infrastructure, gateway, and live agent interactions, including agent assistance. <a href=\"https:\/\/docs.kore.ai\/smartassist\/getting-started\/introduction\/\" rel=\"noopener noreferrer\" target=\"_blank\">Learn more<\/a>.<\/p>\n<p>Applications built on SmartAssist use the Kore.ai XO Platform\u2019s <b>IVR-Audiocodes<\/b> channel via the underlying voice gateway interface for virtual assistant interactions. Kore.ai\u2019s native voice gateway, <b>SmartAssist Gateway<\/b>, is now configured as a new Kore.ai XO platform channel to drive and manage virtual assistant conversations using open-source components.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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<h2><span class=\"ez-toc-section\" id=\"Important_Considerations\">Important Considerations<\/span><\/h2>\n<ol>\n<li>SmartAssist Gateway, when configured as a new channel, lets you set up <b>Voice Call Properties<\/b>, and the channel overrides on SmartAssist.<\/li>\n<li>You cannot enable this channel via the XO Platform. Alternatively, you must enable the channel for the required app on SmartAssist.<\/li>\n<li>However, you should configure channel overrides from the XO Platform in the <b>Voice Call Properties<\/b> section for the new channel.<\/li>\n<li>The channel supports the channel-level Voice Call Properties supported by the <b>IVR-AudioCodes<\/b> channel. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/dialog-task\/voice-call-properties\/\" rel=\"noopener noreferrer\" target=\"_blank\">Learn more<\/a>.<\/li>\n<li>The <i>Telephony Welcome<\/i> event applies to the channel.<\/li>\n<li>The system behavior for <i>End of task<\/i> event is the same as that of AudioCodes.<\/li>\n<li>Channel overrides are supported for prompts.<\/li>\n<li>Node-level (Dialog, FAQ, Standard Responses, Events, etc.) <b>Voice Call Properties<\/b> are supported for the channel.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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<h2><span class=\"ez-toc-section\" id=\"Configuration_Overview\">Configuration Overview<\/span><\/h2>\n<p>To accomplish the channel enablement, you must do the following:<\/p>\n<ol>\n<li>Create a new SmartAssist Application to associate with the channel or select an existing app for the association. The <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-ivr-audiocodes-channel-2\/#Step_1_Associate_an_App\" rel=\"noopener noreferrer\" target=\"_blank\">steps<\/a> are similar to the <b>IVR-Audiocodes<\/b> channel.<\/li>\n<li><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-ivr-audiocodes-channel-2\/#Step_3_Configure_Voice_Call_Properties\" rel=\"noopener noreferrer\" target=\"_blank\">Configure<\/a> the <b>Voice Call Properties<\/b>, and define the <b>Channel-specific Prompts<\/b> and <b>Messages<\/b> for any Virtual Assistants connected to your SmartAssist application.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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<h2><span class=\"ez-toc-section\" id=\"Prerequisites\">Prerequisites<\/span><\/h2>\n<p>Before configuring the <b>SmartAssist Gateway<\/b> channel, please ensure the following:<\/p>\n<ol>\n<li>You have a SmartAssist account.<\/li>\n<li>You&#8217;ve completed the voice channel configurations on SmartAssist. <a href=\"https:\/\/docs.kore.ai\/smartassist\/channels\/voice\/\" rel=\"noopener noreferrer\" target=\"_blank\">Learn more<\/a>.<\/li>\n<li>You have associated an app with the channel.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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<h2><span class=\"ez-toc-section\" id=\"Configuration_Steps\">Configuration Steps<\/span><\/h2>\n<p>Once you&#8217;ve created a SmartAssist app on SmartAssist, follow the steps below to complete the channel configuration:<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-message color_yellow\"><div class=\"w-message-body\"><p><b>Note<\/b>:  This channel is auto-enabled when you create a new SmartAssist application.<\/p><\/div><\/div>\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=\"Define_the_Voice_Call_Properties\">Define the Voice Call Properties<\/span><\/h3>\n<p>To define the voice call properties specific to the SmartAssist Gateway, follow the steps below:<\/p>\n<ol>\n<li>Navigate to <b>DEPLOY<\/b> > <b>CHANNELS<\/b>, and click <b>SmartAssist Gateway<\/b> under <b>Voice Channels<\/b>.<\/li>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329112915\/sa-gateway-3.png\" alt=\"\" width=\"1358\" height=\"441\" class=\"alignnone size-full wp-image-56357\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329112915\/sa-gateway-3.png\" alt=\"\" width=\"500\" height=\"350\" class=\"alignnone size-full wp-image-56357\" \/><\/a><\/p>\n<li>Click the <b>Voice Call Properties<\/b> tab in the <b>SmartAssist Gateway<\/b> window. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/dialog-task\/voice-call-properties\/\" rel=\"noopener noreferrer\" target=\"_blank\">Learn more<\/a> on <b>Voice Call Properties<\/b>.<\/li>\n<\/ol>\n<p>In this section, follow the steps mentioned below:<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_1_Configure_the_End_of_Task_Behavior\">Step 1: Configure the End of Task Behavior<\/span><\/h3>\n<p>Select one of the following options for <i>End of Task Behavior<\/i> to define the bot behavior on reaching the <i>End of task<\/i> flow:<\/p>\n<ul>\n<li><b>Trigger End of Task Event<\/b>: When this event is triggered, the bot ends the call and initiates any task like Feedback Survey, Fallback, Dialog generation, etc., linked to the event.<\/li>\n<li><b>Terminate call<\/b>: The bot ends the call without triggering any event-based tasks.<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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<h3><span class=\"ez-toc-section\" id=\"Step_2_Event_Configuration\">Step 2: Event Configuration<\/span><\/h3>\n<p>To define the follow-up task when an event is detected, follow these steps:<\/p>\n<ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-message color_yellow\"><div class=\"w-message-body\"><p><b>Note<\/b>: You can also manage this event from the <b>Natural Language<\/b> > <b>Event Handlers<\/b> page.<\/p><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<ol>\n<li>Select one of the following options:<\/li>\n<\/ol>\n<ul>\n<li><b>Initiate Task<\/b>: Initiates the task you select from the list.<\/li>\n<li><b>Run Script<\/b>: Runs the script code you define.<\/li>\n<li><b>Show Message<\/b>: Displays the response message you define. To define the response message, follow the steps below:\n<ul>\n<li>After selecting <b>Show Message<\/b>, click the <b>+ Add Response<\/b> button.<\/li>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329105112\/add-response.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329105112\/add-response.png\" alt=\"\" width=\"500\" height=\"200\" class=\"alignnone size-full wp-image-56349\" \/><\/a><\/p>\n<li>Select <b>SmartAssist Gateway<\/b> from the list for <b>Channel<\/b> in the <b>Add Response<\/b> window.<\/li>\n<li>Add the response text in the input field for <b>Response<\/b>.<\/li>\n<li>Click <b>Done<\/b>.<\/li>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329102755\/sa-gateway-2.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329102755\/sa-gateway-2.png\" alt=\"\" width=\"400\" height=\"350\" class=\"alignnone size-full wp-image-56345\" \/><\/a><\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-message color_blue with_icon\"><div class=\"w-message-icon\"><i class=\"fas fa-lightbulb\"><\/i><\/div><div class=\"w-message-body\"><p><b>Pro Tip<\/b>: You can use any value currently stored in the <code>context<\/code> variable of your message construction with <code>{{variable brackets}}<\/code>. For example, &#8216;Hello <code>{{context.session.UserContext.firstName}}<\/code>. How can I help you?&#8217; This helps personalize the response message.<\/p><\/div><\/div>\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=\"Step_3_Select_the_Call_Termination_Handler\">Step 3: Select the Call Termination Handler<\/span><\/h3>\n<p>Select the intent(dialog) you previously created from the list to handle the <b>Call Termination<\/b> event. This initiates the relevant task for the event flow.<\/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=\"Step_4_Define_the_Call_Control_Parameters\">Step 4: Define the Call Control Parameters<\/span><\/h3>\n<p>Define the parameters to control the call flow behavior by following the steps below:<\/p>\n<ol>\n<li>Click <b>Add Parameter<\/b>.<\/li>\n<li>In the <b>Add Call Control Parameter<\/b> window, input the <b>Parameter name<\/b> and <b>Parameter value<\/b>.<\/li>\n<li>Click <b>Save<\/b>.<\/li>\n<p>The new <b>call control parameter<\/b> is listed on the <b>SmartAssist Gateway<\/b> window, as shown below.<\/p>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329110747\/call-control.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230329110747\/call-control.png\" alt=\"\" width=\"400\" height=\"200\" class=\"alignnone size-full wp-image-56352\" \/><\/a><\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Step_5_Define_the_Timeout_Prompt\">Step 5: Define the Timeout Prompt<\/span><\/h3>\n<p>To define the prompt played when the user input is not received within the timeout period, follow the steps below:<\/p>\n<ol>\n<li>First, provide the text in the <b>Timeout prompt<\/b> input field.<\/li>\n<li>Next, hit enter.<\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Step_6_Define_User_Input_Parameters\">Step 6: Define User Input Parameters<\/span><\/h3>\n<p>To define the key parameters for user input management, follow the steps below:<\/p>\n<ol>\n<li>First, provide values for the following fields:<\/li>\n<\/ol>\n<ul>\n<li><b>Barge-in<\/b>: Select <i>YES<\/i> to allow the user&#8217;s input while a prompt is in progress. Otherwise, select <i>No<\/i>.<\/li>\n<li><b>Timeout<\/b>: Select an option from the list (0 seconds to 60 seconds) to define the maximum wait time to receive the user&#8217;s input.<\/li>\n<li><b>No. of Retries<\/b>: Select an option from the list (1 to 10) to define the maximum number of user input retries allowed.<\/li>\n<\/ul>\n<ol start=\"2\">\n<li>Next, click <b>Save<\/b>.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-message color_yellow\"><div class=\"w-message-body\"><p><b>Note<\/b>: You don&#8217;t have to enable the channel explicitly since it is auto-enabled.<\/p><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p><span style=\"font-weight: 400\">After the channel is enabled and all configurations are verified, you can optionally publish the assistant to make it available for end users with the new channel. Learn more about<\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/publish\/publishing-bot\/\"><span style=\"font-weight: 400\"> Publishing your Virtual Assistant<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/p>\n<p><span style=\"font-weight: 400\">To learn more about working with Channels within the Kore.ai XO Platform, please see<\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-channels-to-your-bot\/\"><span style=\"font-weight: 400\"> Channel Enablement.<\/span><\/a><\/p>\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":"SmartAssist is a Kore.ai Contact Center Automation Solution. It helps enterprises manage their contact center infrastructure from the omnichannel interface, voice infrastructure, gateway, and live agent interactions, including agent assistance. Learn more. Applications built on SmartAssist use the Kore.ai XO Platform\u2019s IVR-Audiocodes channel via the underlying voice gateway interface for virtual assistant interactions. Kore.ai\u2019s native...","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-56313","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\/56313","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=56313"}],"version-history":[{"count":16,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/56313\/revisions"}],"predecessor-version":[{"id":56558,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/56313\/revisions\/56558"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=56313"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=56313"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=56313"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}