{"id":32358,"date":"2022-02-24T04:54:42","date_gmt":"2022-02-24T04:54:42","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=32358"},"modified":"2023-07-22T06:20:15","modified_gmt":"2023-07-22T05:20:15","slug":"add-the-syniverse-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/channel-enablement\/add-the-syniverse-channel\/","title":{"rendered":"Add the Syniverse 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\">\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;\">To set up Syniverse as a channel, the developer needs to associate the bot with a Syniverse app, set up a subscription, and enable the delivery events for this app. This document explains the steps to add the Syniverse as a channel to your bot.<\/span><\/p>\n<h2><span class=\"ez-toc-section\" id=\"Create_an_App\">Create an App<\/span><\/h2>\n<p><span style=\"font-weight: 400;\">To create the Syniverse app, follow the steps below:<\/span><\/p>\n<ol>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Log in to the <\/span><a href=\"https:\/\/developer.syniverse.com\/\"><span style=\"font-weight: 400;\">Syniverse developer portal<\/span><\/a><span style=\"font-weight: 400;\"> and navigate to the <\/span><strong>Applications<\/strong><span style=\"font-weight: 400;\"> section.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong><span style=\"font-weight: 400;\">Click <\/span>Create New<span style=\"font-weight: 400;\"> if you want to create your first app. If you want to access existing apps, click <\/span>Your App<\/strong>.<br \/>\n<strong><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32571\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse1.png\" alt=\"\" width=\"640\" height=\"221\" \/><\/strong><\/li>\n<li><span style=\"font-weight: 400;\">In the <\/span><strong>Create App<\/strong><span style=\"font-weight: 400;\"> screen, enter the app name, description, select account, and click <\/span><strong>Save<\/strong><span style=\"font-weight: 400;\">.<br \/>\n<\/span><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32574\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse2-1024x478.png\" alt=\"\" width=\"640\" height=\"299\" \/><\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Capture_Auth_Keys\">Capture Auth Keys<\/span><\/h2>\n<p>Once you create an app, to capture Auth keys, follow the steps below:<\/p>\n<ol>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Navigate to the created app in the <\/span><strong>Applications<\/strong><span style=\"font-weight: 400;\"> section and open the app.<\/span><\/li>\n<li style=\"font-weight: 400;\">Use the <strong>Auth Keys <\/strong>(see the following screenshot) to complete the configuration in the Kore.ai platform and send the SMS via bot.<\/li>\n<\/ol>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32623\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse3-1-1024x450.png\" alt=\"\" width=\"640\" height=\"281\" \/><\/p>\n<h2><span class=\"ez-toc-section\" id=\"Delivery_Configurations\"><a name=\"DeliveryConfigs\"><\/a>Delivery Configurations<\/span><\/h2>\n<p>The next step is to configure how messages will be delivered via the Webhook URL configured on the XO Platform for Syniverse. To set up the delivery configurations, follow the steps below:<\/p>\n<ol>\n<li>Navigate to the <strong>Event Manager<\/strong> on the top menu bar and select <strong>Delivery Configurations<\/strong>.<br \/>\n<span style=\"font-weight: 400;\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-32580\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse4-1024x329.png\" alt=\"\" width=\"640\" height=\"206\" \/><\/span><\/li>\n<li><span style=\"font-weight: 400;\">\u00a0If you want to use an existing delivery configuration to set up the bot\u2019s webhook URL, select one of the configurations from the displayed table (see the following screenshot), else, click <\/span><strong>New Delivery Configuration.<br \/>\n<\/strong><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32583\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse5-1024x418.png\" alt=\"\" width=\"640\" height=\"261\" \/><\/li>\n<li><span style=\"font-weight: 400;\">In the <\/span><strong>Create Delivery Configuration <\/strong><span style=\"font-weight: 400;\">pop-up, enter the following values:<\/span><\/li>\n<\/ol>\n<ul>\n<li><span style=\"font-weight: 400;\">Provide a <\/span><strong>Delivery Configuration Name<\/strong><span style=\"font-weight: 400;\">.<\/span><\/li>\n<li><strong>Address: <\/strong><span style=\"font-weight: 400;\">Copy and paste the webhook URL value from the XO Platform&#8217;s Syniverse Channel <b>Configuration<\/b> section.<\/span><\/li>\n<li>Set <strong>Is Active:<\/strong><span style=\"font-weight: 400;\"> to <i>Yes<\/i>.<\/span><\/li>\n<\/ul>\n<ol start=\"4\">\n<li>Click <strong>Create<\/strong>.<\/li>\n<li style=\"list-style-type: none;\"><\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Subscriptions\">Subscriptions<\/span><\/h2>\n<p><span style=\"font-weight: 400;\">To set up subscriptions, follow the steps below:<\/span><\/p>\n<ol>\n<li><span style=\"font-weight: 400;\">Navigate to the <\/span><strong>Event Manager<\/strong><span style=\"font-weight: 400;\"> on the top menu bar and select <\/span><strong>Subscriptions<\/strong><span style=\"font-weight: 400;\">.<br \/>\n<\/span><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32586\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse6-1024x325.png\" alt=\"\" width=\"640\" height=\"203\" \/><\/li>\n<li>\u00a0If there are existing subscriptions, select one from the table to set up the event subscription (see the following screenshot), else, click <strong>New Subscription<\/strong>.<br \/>\n<strong><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32589\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/Syniverse7-1024x465.png\" alt=\"\" width=\"640\" height=\"291\" \/><\/strong><\/li>\n<li>In the <strong><strong>New Topic Subscription <\/strong><span style=\"font-weight: 400;\">pop-up, enter the following values:<\/span><\/strong><\/li>\n<\/ol>\n<ul>\n<li><strong>Topic:<\/strong><span style=\"font-weight: 400;\"> Select <\/span><strong>SCG Message<\/strong><span style=\"font-weight: 400;\"> from the drop-down.<\/span><\/li>\n<li><strong>Event Type: <\/strong><span style=\"font-weight: 400;\">Select <\/span><strong>mo_message_received<\/strong><span style=\"font-weight: 400;\"> from the drop-down.<\/span><\/li>\n<li><strong>Delivery Configuration:<\/strong><span style=\"font-weight: 400;\"> Select delivery configuration configured in the <a href=\"#DeliveryConfigs\">Delivery Configurations<\/a> section.<\/span><\/li>\n<li><strong>Start Date: <\/strong><span style=\"font-weight: 400;\">Select a date from when this subscription has to be active.<\/span><\/li>\n<li><strong>End Date:<\/strong><span style=\"font-weight: 400;\"> Select an end date. Leave it blank if you want this event subscription to work for a lifetime.<\/span><\/li>\n<\/ul>\n<ol start=\"4\">\n<li>Click <strong>Create<\/strong>.<\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Capture_Sender_ID\">Capture Sender ID<\/span><\/h2>\n<p>To ensure that messages flow between the two systems, you should obtain the <b>Sender ID<\/b> from Syniverse, and provide it on the XO Platform. To obtain the <b><i>Sender ID<\/i><\/b>, follow the steps below:<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol>\n<li><span style=\"font-weight: 400;\">Navigate to the <strong>Voice and Messaging Console<\/strong> on the top menu bar of your Syniverse Developer Portal account, and double click <strong>Sender ID<\/strong> from the <strong>Messaging Accounts<\/strong> in left Navigation Menu. Click <\/span><strong>+Purchase or Migrate Sender Address<\/strong><span style=\"font-weight: 400;\"> button to purchase a new Sender ID.<\/span><\/li>\n<li>Scroll down to <b>Alias<\/b>, and copy the value.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\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\/20230720105312\/syniverse-sender-alias.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-58079\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230720105312\/syniverse-sender-alias.png\" alt=\"\" width=\"500\" height=\"350\" \/><\/a><\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol>\n<li><span style=\"font-weight: 400;\">Paste this value in the <strong>Syniverse<\/strong> <strong>Configurations<\/strong> panel of the Kore.ai platform.<\/span><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-32618\" src=\"https:\/\/multisite.korebots.com\/wp-content\/uploads\/sites\/35\/10-1024x562.png\" alt=\"\" width=\"640\" height=\"351\" \/><\/p>\n<ol>\n<li>Select <b><i>Yes<\/i><\/b> for <b>Enable Channel<\/b>.<\/li>\n<li>Click <b>Save<\/b>.<\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Configuring_the_Request_and_Response\">Configuring the Request and Response<\/span><\/h2>\n<ul>\n<li>Internally, the XO Platform integration extracts and uses the <code><i>sender_id_alias<\/i><\/code> value (from Syniverse) in the API call to send the messages.<\/li>\n<li>To identify the source channel, the system trims the <code><i>sender_id_alias<\/i><\/code> from the format <code>Channel type_Channel ID (if present)_sending number<\/code>, and considers <b>Channel Type<\/b> as the source.<\/li>\n<li>To identify whether the request came through <i>Channel Id<\/i> or <i>Sender Id<\/i>, and also respond to Syniverse accordingly, the following is considered:\n<ul>\n<li>If the <code><i>sender_id_alias<\/i><\/code> has the format <code>Channel type_Channel ID_sending number<\/code>, then the request is from the Channel. This information is used to reply to the Channel. In this case, the <code>sender_id_id<\/code> field which contains the value of sender id is not used to respond.<\/li>\n<li>If the <code><i>sender_id_alias<\/i><\/code> has the format <code>Channel type_sending number<\/code>, then the request is from the Sender Id. This information is used to reply to the Sender Id. In this case, the <code>sender_id_id<\/code> field is used to respond.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\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":"To set up Syniverse as a channel, the developer needs to associate the bot with a Syniverse app, set up a subscription, and enable the delivery events for this app. This document explains the steps to add the Syniverse as a channel to your bot. Create an App To create the Syniverse app, 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-32358","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\/32358","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=32358"}],"version-history":[{"count":13,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/32358\/revisions"}],"predecessor-version":[{"id":58106,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/32358\/revisions\/58106"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=32358"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=32358"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=32358"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}