{"id":23138,"date":"2020-02-07T11:44:04","date_gmt":"2020-02-07T11:44:04","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=23138"},"modified":"2023-12-04T05:54:42","modified_gmt":"2023-12-04T05:54:42","slug":"adding-the-whatsapp-business-messaging-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/","title":{"rendered":"Adding the WhatsApp Business Messaging 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=\"ult-spacer spacer-6ae8721b7142e\" data-id=\"6ae8721b7142e\" data-height=\"10\" data-height-mobile=\"10\" data-height-tab=\"10\" data-height-tab-portrait=\"\" data-height-mobile-landscape=\"\" style=\"clear:both;display:block;\"><\/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=\"Adding_the_WhatsApp_Channel_using_Infobip_Application\">Adding the WhatsApp Channel using Infobip Application<\/span><\/h2>\n<p>To complete this procedure, you must already have an <b>Infobip<\/b> account. This is one of the messaging providers for enabling <b>WhatsApp Business Messaging<\/b> on the Kore Platform.<\/p>\n<p>Steps to configure <b>Infobip<\/b>:<\/p>\n<ol>\n<li>Login to the <b>Infobip<\/b> developer portal.<\/li>\n<li>On the left navigation menu, click the <b>Channels and Numbers<\/b> option and select the <b>WhatsApp<\/b> channel on the <b>Channel Essentials<\/b> panel.<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\/20221018090555\/WA-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48335\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018090555\/WA-1.png\" alt=\"\" width=\"600\" height=\"180\" \/><\/a><\/li>\n<li>To configure a new number for the <b>Infobip<\/b> and <b>WhatsApp<\/b> messaging platforms\u2019 integration, follow one of the steps given below:\n<ol>\n<li>Scan the QR code under <b>Overview<\/b> &gt; <b>Connect<\/b> on the <b>WhatsApp<\/b> page on the Infobip portal using the camera or QR scanner on your mobile device.<\/li>\n<li>Follow the instructions for steps 2 and 3 shown in the image below.<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\/20221018090921\/WA-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48339\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018090921\/WA-2.png\" alt=\"\" width=\"600\" height=\"180\" \/><\/a><\/li>\n<li>Alternatively, add the number shown on the screen of the Infobip sender to your WhatsApp contacts.<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\/20221018091318\/WA-3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48342\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018091318\/WA-3.png\" alt=\"\" width=\"600\" height=\"180\" \/><\/a><\/p>\n<div class=\"alert alert-info\"><b>Note<\/b>: The mobile number should have the country code preceded by a plus (+) sign to activate the <b>Infobip<\/b> and <b>WhatsApp<\/b> connections.<\/div>\n<\/li>\n<\/ol>\n<\/li>\n<li>Once the number is associated, select the <b>Senders<\/b> tab to view or edit the numbers for <b>WhatsApp<\/b> messaging.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018091643\/WA-4.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48345\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018091643\/WA-4.png\" alt=\"\" width=\"600\" height=\"180\" \/><\/a><\/li>\n<li>Click the <b>ellipses<\/b> icon under <b>Action<\/b> and select <b>Edit Configuration<\/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\/20221018091908\/WA-5.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48348\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018091908\/WA-5.png\" alt=\"\" width=\"600\" height=\"180\" \/><\/a><\/li>\n<\/ol>\n<ol start=\"6\">\n<li>On the <b>Edit Configuration<\/b> page, click the <b>edit<\/b> icon, add the <b>URL for incoming messages<\/b> (copy the Webhook URL from the Kore Platform under <b>Deploy<\/b> &gt; <b>Channels<\/b> &gt; <b>WhatsApp Business Messaging<\/b> &gt; <b>Configurations<\/b> tab) and click <b>Back<\/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\/20221018092214\/WA-6.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48351\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018092214\/WA-6.png\" alt=\"\" width=\"500\" height=\"160\" \/><\/a><\/li>\n<li>Next, to add Infobip\u2019s <b>Base URL<\/b>, follow these steps:\n<ol start=\"1\">\n<li>On the Kore.ai Platform, click the <b>Virtual Assistants<\/b> tab, and select the published virtual assistant to add the <b>WhatsApp Business Message<\/b> channel.<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\/20221018092501\/WA-7.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48354\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018092501\/WA-7.png\" alt=\"\" width=\"600\" height=\"230\" \/><\/a><\/li>\n<li>Under <b>Deploy<\/b> &gt; <b>Channels<\/b>, click <b>WhatsApp Business Messaging<\/b>.<\/li>\n<li>On the <b>WhatsApp Business Messaging<\/b> panel, click the <b>Configurations<\/b> tab and provide inputs for the following fields:\n<ol start=\"1\">\n<li><b>Messaging Partner<\/b> &#8211; Select <b>Infobip<\/b> from the dropdown list.<\/li>\n<li><b>Phone Number<\/b> \u2013 Copy and paste the number displayed on the <b>Infobip<\/b> portal for your account under the <b>Connect<\/b> section (please refer to step 3). The Platform now supports <b>adding multiple phone numbers on the WhatsApp Messaging Channel<\/b> for the same Virtual Assistant. The Virtual Assistant responds to only the source number from which it receives the message rather than a common phone number. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/whatsapp-messaging-channel-support-for-multiple-phone-numbers\/\"> Learn more<\/a>.<\/li>\n<li><b>Base URL<\/b>: Copy the Base URL from this page. This URL will be used on Kore.ai to send the messages when the <b>WhatsApp Business Messaging<\/b> channel is enabled.<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\/20221018092738\/WA-8.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48357\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018092738\/WA-8.png\" alt=\"\" width=\"500\" height=\"200\" \/><\/a><\/li>\n<li><b>Username and Password<\/b>: The username and password of the <b>Infobip<\/b> account holder. Infobip\u2019s API requires authentication and uses the basic authorization for sending and receiving messages over the API with these values.<\/li>\n<li><b>Webhook URL<\/b>: Copy the webhook URL provided in the configuration tab and update the same on the <b>Infobip developer portal<\/b> for Infobip to send the received messages from the subscriber (WhatsApp Business Messaging).<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\/20221018093103\/WA-9.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48360\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018093103\/WA-9.png\" alt=\"\" width=\"450\" height=\"380\" \/><\/a><\/li>\n<\/ol>\n<\/li>\n<li>Select <b>Yes<\/b>\u00a0to enable the <b>WhatsApp Business Messaging<\/b> channel.<\/li>\n<li>Click <b>Save<\/b> to complete the integration setup.<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\/20221018093454\/WA-10.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48365\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018093454\/WA-10.png\" alt=\"\" width=\"450\" height=\"380\" \/><\/a><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<div class=\"alert alert-info\"><b>Note<\/b>: If you\u2019re using the development sandbox on <b>Infobip<\/b>, once the channel is enabled and published, you will need to send messages in the format \u201c<i><b>[Keyword on infobip]<\/b><\/i> <b>(User input)<\/b>\u201d For example, \u201cKore Hi.\u201d<\/div>\n<h3><span class=\"ez-toc-section\" id=\"Viewing_WhatsApp_Message_Logs_on_Infobip\">Viewing WhatsApp Message Logs on Infobip<\/span><\/h3>\n<p>Once you\u2019ve sent a message to <b>Infobip<\/b> using the <b>WhatsApp Business Messaging<\/b> channel, you can track the text, Virtual Assistant responses, delivery status, and errors (if any) on your <b>Infobip<\/b> account under <b>Channels and Numbers<\/b> &gt; <b>Channel Essentials<\/b> &gt; <b>WhatsApp<\/b> &gt; <b>Overview<\/b> &gt; <b>View Logs<\/b>.<\/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\/20221018093746\/WA-11.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48368\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018093746\/WA-11.png\" alt=\"\" width=\"500\" height=\"150\" \/><\/a><\/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\/20221018093939\/WA-12.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48372\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221018093939\/WA-12.png\" alt=\"\" width=\"500\" height=\"180\" \/><\/a><\/p>\n<h3><span class=\"ez-toc-section\" id=\"Messaging_Templates\">Messaging Templates<\/span><\/h3>\n<p>WhatsApp for business communications supports the following messaging types for the Infobip channel:<\/p>\n<ul>\n<li><b>Templates<\/b>: Formatted, non-editable, and pre-registered messages approved by WhatsApp.<\/li>\n<li><b>Free-Form texts<\/b>: Free-flowing text messages.<\/li>\n<\/ul>\n<p>The Kore.ai XO Platform now supports public APIs for WhatsApp templates on the Infobip channel. These templates can be used during virtual assistant conversations to structure the messages exchanged. Since global UI\/rich template formats are not supported, the bot designer should register the required templates with Infobip and get them approved.<\/p>\n<p>The Platform automatically decides the payload to be sent to the channels after parsing Advanced Messages (JS) that include one of the following:<\/p>\n<ul>\n<li><b>String<\/b>: A free-form text message template is used if the JS result is a string.<\/li>\n<li><b>Object<\/b>: A message template is used if the JS result is an object.<\/li>\n<\/ul>\n<p><b>Additional Information<\/b><\/p>\n<ul>\n<li>To learn more about creating and managing templates, please refer to this <a href=\"https:\/\/www.infobip.com\/docs\/whatsapp\/manage-connection#manage-templates-manage-senders\">link<\/a>.<\/li>\n<li>To know more about various message types and the structure of templates, please refer to this <a href=\"https:\/\/www.infobip.com\/docs\/whatsapp\/message-types#guidelines-amp-best-practices\">link<\/a>.<\/li>\n<li>To learn more about sending template messages, please refer to this <a href=\"https:\/\/www.infobip.com\/docs\/api\/channels\/whatsapp\/whatsapp-outbound-messages\/send-whatsapp-template-message\">link<\/a>.<\/li>\n<\/ul>\n<h2><span class=\"ez-toc-section\" id=\"Adding_the_WhatsApp_Channel_Using_GupShup_Application\">Adding the WhatsApp Channel Using GupShup Application<\/span><\/h2>\n<p>The Platform supports integration with <b>GupShup<\/b> to enable WhatsApp business as a channel. In this integration, the platform provides a Webhook URL to be called by GupShup during a conversation to enable events and exchange messages.<\/p>\n<div class=\"alert alert-info\"><strong>Note<\/strong>: To enable WhatsApp Messaging on this channel, you must have a GupShup enterprise account.<\/div>\n<p>The important steps in completing this channel enablement are as follows:<\/p>\n<p>1. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_1_Create_a_GupShup_Application\">Create a GupShup Application<\/a>.<br \/>\n2. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_2_Configure_the_Channel_Enablement\">Configure the Channel Enablement<\/a>.<\/p>\n<ol>\n<li><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_2a_Create_a_new_WhatsApp_Business_Account\">Create a WABA (WhatsApp Business Account)<\/a>.<\/li>\n<li><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_2b_Set_up_the_WABA_Parameters_on_the_Platform\">Set up the WABA Parameters on the Platform<\/a>.<\/li>\n<li><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_2c_Configure_the_Callback_URLWebhook_URL\">Configure the Callback URL\/Webhook URL<\/a>.<\/li>\n<\/ol>\n<p>3. <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/adding-the-whatsapp-business-messaging-channel\/#Step_3_Secure_the_Integration\">Secure the Integration<\/a>.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_1_Create_a_GupShup_Application\">Step 1: Create a GupShup Application<\/span><\/h3>\n<p>The first step in the WhatsApp Messaging Channel integration is to create a GupShup application, To create an app, follow the steps below:<\/p>\n<ol>\n<li>Log in to the <a href=\"https:\/\/www.gupshup.io\/whatsapp\/dashboard\">GupShup portal<\/a> and navigate to the <strong>Dashboard \u2192 WhatsApp<\/strong> section.<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\/20221229061423\/gs-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50084\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229061423\/gs-1.png\" alt=\"\" width=\"500\" height=\"250\" \/><\/a><\/li>\n<li>Click the <b>+ Create App<\/b> button.<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\/20221229061752\/gs-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50087\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229061752\/gs-2.png\" alt=\"\" width=\"500\" height=\"250\" \/><\/a><\/li>\n<li>On the <b>Create App<\/b> screen, click <b>Access API<\/b> to select the app type.<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\/20221229062047\/gs-3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50090\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229062047\/gs-3.png\" alt=\"\" width=\"500\" height=\"250\" \/><\/a><\/li>\n<li>Provide a unique name for the application and click <b>Submit<\/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\/20221229062226\/gs-4.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50093\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229062226\/gs-4.png\" alt=\"\" width=\"500\" height=\"300\" \/><\/a><\/li>\n<li>For <b><i>Step 2: Onboard your Users<\/i><\/b>, click <b>Next<\/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\/20221229062504\/gs-5.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50096\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229062504\/gs-5.png\" alt=\"\" width=\"500\" height=\"400\" \/><\/a><\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Step_2_Configure_the_Channel_Enablement\">Step 2: Configure the Channel Enablement<\/span><\/h3>\n<p>To send messages to your GupShup users on the WhatsApp Business Messaging Channel, follow the steps below:<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_2a_Create_a_new_WhatsApp_Business_Account\">Step 2(a): Create a new WhatsApp Business Account<\/span><\/h3>\n<p>Once you have created a GupShup app, you need to create a <b>WABA<\/b> to set up the integration with a number. To create a WABA, follow the steps below:<\/p>\n<ol>\n<li>Navigate to the WhatsApp Dashboard on your GupShup Developer Console.<\/li>\n<li>Click the <b>Go Live<\/b> button of the desired app in the list.<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\/20221229063433\/gs-6.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50099\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229063433\/gs-6.png\" alt=\"\" width=\"500\" height=\"300\" \/><\/a><\/li>\n<\/ol>\n<ol start=\"3\">\n<li>On the <b>Let\u2019s Get Started<\/b> window, select the <b>New Number<\/b> option under <b>Managed onboarding with Gupshup<\/b>.<\/li>\n<li>Click <b>Proceed<\/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\/20221229063712\/gs-7.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50102\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229063712\/gs-7.png\" alt=\"\" width=\"500\" height=\"400\" \/><\/a><\/li>\n<\/ol>\n<ol start=\"5\">\n<li>Enter your details to set up your WhatsApp Business account and click <b>Next<\/b>.<\/li>\n<li>Follow all the instructions on the screen to <b>Setup the WhatsApp Account, Get WhatsApp Approvals<\/b>, and <b>Complete Verification<\/b>.<\/li>\n<li>Once the account is verified with your <i>Facebook Business ID<\/i>, the <b>WABA ID<\/b>, <b>Mobile number<\/b>, and <b>Password<\/b> are displayed.<\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Step_2b_Set_up_the_WABA_Parameters_on_the_Platform\">Step 2(b): Set up the WABA Parameters on the Platform<\/span><\/h3>\n<p>To integrate your GupShup service using the WBM channel to the Kore.ai XO Platform, follow the steps below:<\/p>\n<ol>\n<li>Copy the <b>Mobile number<\/b>, <b>WABA ID<\/b>, and the <b>Password<\/b> from the GupShup WhatsApp Dashboard.<\/li>\n<li>On the Kore.ai Bot Builder, navigate to <b>Deploy<\/b> &gt; <b>Channels<\/b> &gt; <b>WhatsApp Business Messaging<\/b> (under <b>Enterprise Channels<\/b>).<\/li>\n<li>Click the <b>Configurations<\/b> tab on the <b>WhatsApp Business Messaging<\/b> window.<\/li>\n<li>Select <b>GupShup<\/b> from the dropdown list for <b>Messaging Partner<\/b>.<\/li>\n<li>Paste the copied values for <b>Mobile number<\/b>, <b>WABA ID<\/b>, and &lt;b.Password in the respective input fields.<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\/20221229064456\/gs-8.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50105\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229064456\/gs-8.png\" alt=\"\" width=\"500\" height=\"400\" \/><\/a><\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Step_2c_Configure_the_Callback_URLWebhook_URL\">Step 2(c): Configure the Callback URL\/Webhook URL<\/span><\/h3>\n<p>To link to your bot on the Kore.ai Platform to receive inbound messages\/events, you must configure the <b>Callback\/Webhook URL<\/b> on your <b>GupShup WhatsApp Dashboard<\/b>.<br \/>\nTo set up the <b>Callback URL<\/b>, follow the steps below:<\/p>\n<ol>\n<li>On the Kore.ai Bot Builder, navigate to <b>Deploy<\/b> &gt; <b>Channels<\/b> &gt; <b>WhatsApp Business Messaging<\/b> (under <b>Enterprise Channels<\/b>).<\/li>\n<li>Click the <b>Configurations<\/b> tab on the <b>WhatsApp Business Messaging<\/b> window.<\/li>\n<li>Ensure you have selected <b>GupShup<\/b> for the <b>Messaging Partner<\/b> field. Click <b>Copy<\/b> to copy the <b>Webhook URL<\/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\/20221229065803\/gs-9.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50108\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229065803\/gs-9.png\" alt=\"\" width=\"500\" height=\"400\" \/><\/a><\/li>\n<li>Navigate to your <b>GupShup WhatsApp Dashboard<\/b>.<\/li>\n<li>Click the <b>Settings<\/b> icon for your app of type <b>Access API<\/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\/20221229081544\/gs-10.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50127\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229081544\/gs-10.png\" alt=\"\" width=\"500\" height=\"250\" \/><\/a><\/li>\n<\/ol>\n<ol start=\"6\">\n<li>On the <b>Settings<\/b> page, scroll down to the <b>Test Access API and set callback URL <\/b> section.<\/li>\n<li>Click the <b>Callback URL \/ Link your Bot<\/b> tab.<\/li>\n<li>Turn on the toggle switch and paste the <b>Webhook URL<\/b> you copied from the Bot Builder in the <b>Enter your Callback URL<\/b> input field.<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\/20221229082125\/gs-11.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50130\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229082125\/gs-11.png\" alt=\"\" width=\"500\" height=\"300\" \/><\/a><\/li>\n<\/ol>\n<ol start=\"9\">\n<li>Click <b>Set<\/b>.<br \/>\nRefer to this <a href=\"https:\/\/www.gupshup.io\/developer\/docs\/bot-platform\/guide\/whatsapp-api-documentation#setupcallbackURL\" target=\"_blank\" rel=\"noopener noreferrer\">link<\/a> for more information on setting up the Callback\/Webhook URL on the Gupshup Dashboard.<\/p>\n<div class=\"alert alert-info\"><b>Note<\/b>: Contact the Gupshup customer support team to help configure the Kore.ai webhook URL on GupShup and enable inbound messages to the bot.<\/div>\n<\/li>\n<li>Once the callback is set successfully on the Kore.ai XO Platform <b>WhatsApp Business Messaging<\/b> window, follow the steps below:<\/li>\n<\/ol>\n<ul>\n<li style=\"list-style-type: none;\">\n<ol>\n<li>(Optional) Enable the <b>Associate an App<\/b> option, if required, and follow the configuration steps.<\/li>\n<li>Select <b>YES<\/b> for the <b>Enable Channel<\/b> option.<\/li>\n<li>Click <b>Save<\/b>.<\/li>\n<\/ol>\n<\/li>\n<\/ul>\n<h3><span class=\"ez-toc-section\" id=\"Step_3_Secure_the_Integration\">Step 3: Secure the Integration<\/span><\/h3>\n<p>The Webhook URL used on the WhatsApp Business Messaging Channel for GupShup is a public URL that may cause security vulnerabilities. The Kore.ai XO Platform enforces an authentication mechanism by securing the webhook URL and associating it with a Kore.ai App. The <b>Associate an App<\/b> feature is used for this purpose.<\/p>\n<p>This feature is available under <b>Deploy<\/b> &gt; <b>Channels<\/b> &gt; <b>WhatsApp Business Messaging<\/b> &gt; <b>Configurations<\/b>.<\/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\/20221229082313\/gs-12.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-50133\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221229082313\/gs-12.png\" alt=\"\" width=\"500\" height=\"400\" \/><\/a><\/p>\n<p><b>How it Works<\/b><\/p>\n<p>When <b>Associate an App<\/b> is enabled, the following happens:<\/p>\n<ol>\n<li>The URL is called by <b>GupShup<\/b> (the Callback URL you configure under Settings) where the channel passes the authorization token as the header information.<\/li>\n<li>The Platform checks for the JWT Token of the associated app in the Header and accepts the Webhook API call(s).<\/li>\n<li>However, if the Token is missing, the Platform rejects the incoming API call(s) and responds with an error code.<\/li>\n<\/ol>\n<p>Once you enable <b>Associate an App<\/b>, you must manually select an app and configure it for the GupShup app (by clicking <b>Copy<\/b> and pasting the <i>Client ID<\/i> and <i>Client Secret<\/i> (shown above) from the Kore.ai XO Platform).<\/p>\n<div class=\"alert alert-info\"><b>Note<\/b>: This channel configuration is not a part of the Bot Import\/Export feature. The user should manually enable the channel for the target Bot. The integration flow remains the same even with the <b>App Association<\/b> feature.<\/div>\n<h3><span class=\"ez-toc-section\" id=\"Messaging_Templates-2\"><b>Messaging Templates<\/b><\/span><\/h3>\n<p><span style=\"font-weight: 400;\">As part of the GupShup WhatsApp channel integration, the Platform supports the following Gupshup outbound message types to provide an engaging, interactive end-user experience:\u00a0<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>Templates:<\/b><span style=\"font-weight: 400;\"> WhatsApp-approved, pre-formatted messages that are not editable.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>Free-flowing<\/b><span style=\"font-weight: 400;\">: Messages that support all media types are known as \u201cfree-form.\u201d<\/span><\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">You may have to switch between these message types depending on the timing and initiation of the chat.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Whether you are messaging clients inside the messaging window determines the type of message you send. When messaging customers outside of this window, you must follow pre-approved message template rules<\/span>. <a href=\"https:\/\/docs.gupshup.io\/docs\/message-types-templates#message-templates\">Learn more<\/a>.<\/p>\n<p><span style=\"font-weight: 400;\">Message templates for outbound messages play a crucial role in ensuring businesses adhere to WhatsApp policies when initiating communications. These templates come preformatted with predefined text, providing a structured framework for messages sent to end users. Their reusability is particularly valuable when sending the same message multiple times.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Instead of transmitting the actual message content, the template name serves as the identifier for the message content when sending a message template.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Templates can incorporate placeholders, allowing for the inclusion of values or customized information before sending the template message. Additionally, template headers may include media that provides more detailed information. Introducing buttons to messages further enhances interactivity and engagement.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Message templates typically consist of the following sections. For detailed information on each element, click on the respective section to understand its usage guidelines and limitations:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/docs.gupshup.io\/docs\/whatsapp-message-types-outbound-templates#header\"><span style=\"font-weight: 400;\">Header<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/docs.gupshup.io\/docs\/whatsapp-message-types-outbound-templates#body\"><span style=\"font-weight: 400;\">Body<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/docs.gupshup.io\/docs\/whatsapp-message-types-outbound-templates#footer\"><span style=\"font-weight: 400;\">Footer<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/docs.gupshup.io\/docs\/whatsapp-message-types-outbound-templates#buttons\"><span style=\"font-weight: 400;\">Buttons<\/span><\/a><\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">The <\/span><b>Document with Text <\/b><span style=\"font-weight: 400;\">template is also supported for outbound messages. <\/span><span style=\"font-weight: 400;\">With this template, developers can send a document along with informative text for end users to download.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">A sample template script is given below:<\/span><\/p>\n<pre><span style=\"font-weight: 400;\">var msg = {\r\n\r\n\"type\": \"document\",\r\n\r\n\"message_text\":\"This is document caption\",\r\n\r\n\"caption\":\"This document talks about Gupshup features\",\r\n\r\n\"filename\": \"Developer.pdf\",\r\n\r\n\"document\": {\"url\":\"http:\/\/enterprise.smsgupshup.com\/help\/in\/EnterpriseAPIDocument.pdf\"}\r\n\r\n};\r\n\r\nprint(JSON.stringify(msg))\r\n\r\n<\/span><\/pre>\n<p><span style=\"font-weight: 400;\">Prior to submitting notifications through the WhatsApp Business Solution or the WhatsApp Cloud Business Solution, it is imperative to create and register your message templates. This step ensures that the templates comply with WhatsApp&#8217;s review requirements, facilitating effective communication within the platform.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">The Kore.ai XO Platform supports public APIs for the integration and utilization of WhatsApp Outbound Templates on the GupShup channel. <a href=\"https:\/\/kore.ai\/contact-us\/\" target=\"_blank\" rel=\"noopener noreferrer\">Contact<\/a> our experts to learn more.\u00a0<\/span><\/p>\n<h3><span class=\"ez-toc-section\" id=\"Support_for_WhatsApp_Pay\"><b>Support for WhatsApp Pay<\/b><\/span><\/h3>\n<p><span style=\"font-weight: 400;\">The XO Platform supports WhatsApp Pay, a digital payment service that enables instant money transfers between banks through mobile devices using the Unified Payments Interface (UPI) system for the GupShup channel. GupShup, as a WhatsApp Business integration provider, supports outbound message types <\/span><b>Order Details [Text]<\/b><span style=\"font-weight: 400;\"> and<\/span><b> Order Status<\/b><span style=\"font-weight: 400;\"> templates, which are also supported on the XO Platform via APIs.<\/span><\/p>\n<p><b>How it Works<\/b><\/p>\n<ol>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">When the end user completes the transaction using the WhatsApp Pay template rendered on the WhatsApp channel, the Platform receives an inbound message.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">The Inbound message is in the form of a JSON Object containing payment details and their respective status.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">The Platform automatically decides the payload to be sent to the channels after parsing Advanced Messages (JS) that include one of the following:<\/span><\/li>\n<\/ol>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>String<\/b><span style=\"font-weight: 400;\">: A free-form text message template is used if the JS result is a string.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>Object<\/b><span style=\"font-weight: 400;\">: A message template is used if the JS result is an object.<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ol start=\"4\">\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">The Platform accepts this JSON object format as the <\/span><b>Composite <\/b><span style=\"font-weight: 400;\">entity type and stores it in the context object under the respective entity.<\/span><\/li>\n<\/ol>\n<p><span style=\"font-weight: 400;\">An example of a success payload is given below:<\/span><\/p>\n<pre><span style=\"font-weight: 400;\">  {\r\n   \"waNumber\": \"919XXXXXXXX3\",<\/span>\r\n<span style=\"font-weight: 400;\">\u00a0 \u00a0\"mobile\": \"919XXXXXXXX\",<\/span>\r\n<span style=\"font-weight: 400;\">\u00a0\u00a0\"interactive\": \"{\\\"payment\\\":{\\\"transaction_id\\\":\\\"31706099xxxx\\\",\\\"reference_id\\\":\\\"fastag091-12xx\\\",\\\"total_amount\\\":{\\\"offset\\\":100,\\\"value\\\":300},\\\"currency\\\":\\\"INR\\\",\\\"transaction_type\\\":\\\"upi\\\",\\\"status\\\":\\\"success\\\"},\\\"type\\\":\\\"payment\\\"}\",<\/span>\r\n<span style=\"font-weight: 400;\">\u00a0\u00a0\"name\": \"\u0279\u0250\u029esxxxxx sxxxxx\u0279\u0265S\",<\/span>\r\n<span style=\"font-weight: 400;\">\u00a0\u00a0\"type\": \"interactive\",<\/span>\r\n<span style=\"font-weight: 400;\">\u00a0\u00a0\"timestamp\": \"1687160320000\"\r\n}<\/span><\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Adding_the_WhatsApp_Channel_Using_Karix_Application\">Adding the WhatsApp Channel Using Karix Application<\/span><\/h2>\n<p>To integrate <strong>Karix<\/strong> to your <em>WhatsApp Business Messaging<\/em> channel and enable it for a bot, you&#8217;ll need to perform the following setup under the <strong>Configuration<\/strong> tab.<\/p>\n<div class=\"alert alert-info\"><strong>Note<\/strong>: To complete this procedure, you must already have a <em>Karix <\/em>account. This is one of the messaging provider for enabling WhatsApp Business Messaging.<\/div>\n<h3><span class=\"ez-toc-section\" id=\"Prerequisites\">Prerequisites<\/span><\/h3>\n<ol>\n<li>Gather the following details from the <span style=\"font-weight: 400;\">the <strong>Karix support team<\/strong>.<\/span><\/li>\n<\/ol>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul>\n<li>Vendor<\/li>\n<li>Account Key<\/li>\n<li>From<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ol start=\"2\">\n<li>Copy the <em>Webhook URL<\/em> from the <strong>Kore.ai Platform<\/strong> and share it with the <strong>Karix support team<\/strong>. The Karix support team will need to configure this URL on their platform for a successful handshake between <em>Kore.ai<\/em> and <em>Karix<\/em>.<\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Configuration_Steps\">Configuration Steps<\/span><\/h3>\n<p>On the WhatsApp Business Messaging platform, follow the below steps:<\/p>\n<ol>\n<li>Select <em>Karix<\/em> from the list for <strong>Messaging Partner<\/strong>.<\/li>\n<li>Enter the <strong>Phone Number<\/strong> to map to the WhatsApp Business Messaging channel.<\/li>\n<li>Provide the <strong>Account Key<\/strong> you&#8217;ve received from the Karix support team.<\/li>\n<li>Provide the <strong>Webhook URL\u00a0<\/strong> shared with the Karix support team.<\/li>\n<li>Select <strong>Yes<\/strong>\u00a0for <strong>Enable Channel<\/strong>.<\/li>\n<li>Click <strong>Save<\/strong>.<br \/>\n<img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-37041\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/wBS-karix.png\" alt=\"\" width=\"634\" height=\"551\" \/><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"ult-spacer spacer-6ae8721b72548\" data-id=\"6ae8721b72548\" data-height=\"10\" data-height-mobile=\"10\" data-height-tab=\"10\" data-height-tab-portrait=\"\" data-height-mobile-landscape=\"\" style=\"clear:both;display:block;\"><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Adding the WhatsApp Channel using Infobip Application To complete this procedure, you must already have an Infobip account. This is one of the messaging providers for enabling WhatsApp Business Messaging on the Kore Platform. Steps to configure Infobip: Login to the Infobip developer portal. On the left navigation menu, click the Channels and Numbers option...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-23138","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\/23138","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=23138"}],"version-history":[{"count":86,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/23138\/revisions"}],"predecessor-version":[{"id":60473,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/23138\/revisions\/60473"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=23138"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=23138"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=23138"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}