{"id":26453,"date":"2021-01-15T06:29:29","date_gmt":"2021-01-15T06:29:29","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-2\/?p=26453"},"modified":"2021-01-25T08:30:23","modified_gmt":"2021-01-25T08:30:23","slug":"channel-enablement-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/channel-enablement\/channel-enablement-api\/?lang=ja","title":{"rendered":"Channel Enablement API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to initiate enable a channel for a bot.<\/p>\n

\nTo use this API, app needs the Bot Builder API Scope of Channel Management<\/em> under ChannelManagement<\/em>.<\/p>\n

POST<\/strong> https:\/\/{{host}}\/api\/public\/bot\/channels<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
BotId<\/td>\nBot ID – You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n
AppName<\/td>\nThe app associated with this Bot, you can obtain it from the Manage Apps page of the bott<\/td>\n<\/tr>\n
ClientId<\/td>\nThe client id for the app associated with this Bot, you can obtain it from the Manage Apps page of the bott<\/td>\n<\/tr>\n
type<\/td>\nChannel that you want to enable for this Bot, see below for details<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
\r\n\t\t
\r\n\t\t\t

Channel Types<\/h4>\n
    \n
  • skypeforbusiness – for Skype for Business<\/li>\n
  • msteams – for Microsoft Teams<\/li>\n
  • twitter – for Twitter<\/li>\n
  • spark – for Cisco Spark<\/li>\n
  • rtm – for Web\/Mobile Client<\/li>\n
  • Facebook – for Facebook Messenger<\/li>\n
  • slack – for Slack<\/li>\n
  • skype – for Skype<\/li>\n
  • kore – for Kore Messenger<\/li>\n
  • email – for Email<\/li>\n
  • sms – for SMS<\/li>\n
  • wfacebook – for Workplace by Facebook<\/li>\n
  • ringcentral – for RingCentral Glip<\/li>\n
  • jabber – for Cisco Jabber<\/li>\n
  • yammer – for Microsoft Yammer<\/li>\n
  • alexa – for Amazon Alexa<\/li>\n
  • twiliovoice – for Twilio Voice<\/li>\n
  • telegram – for Telegram<\/li>\n
  • ivr – for Webhook<\/li>\n
  • ivrVoice – for IVR<\/li>\n
  • line – for Line Messenger<\/li>\n
  • liveperson – for Liveperson<\/li>\n
  • googleactions – for Google Assistant<\/li>\n
  • wechat – for WeChat<\/li>\n
  • hangoutchat – for Hangout Chat<\/li>\n
  • mattermost – for Mattermost<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Authorization<\/span><\/h3>\n

    Invoke the API with JWT in the header with the following syntax:<\/p>\n

    auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Response content type<\/span><\/h3>\n

    application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h3>\n
    curl --location --request POST 'https:\/\/{{host}}\/api\/public\/channels' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n--header 'Content-Type: application\/json' \\\r\n--data-raw '{\r\n    \"streamId\":\"{{bot Id}}\",\r\n    \"channelDetails\":{\r\n        \t\"app\": {\r\n          \t\"appName\": \"App Name\",\r\n          \t\"clientId\": \"cs-fxxxfxd-bxee-xaxx-bxaf-dxxxxe2c26e3\"\r\n        \t},\r\n        \t\"createInstance\": false,\r\n        \t\"displayName\": \"Web \/ Mobile Client\",\r\n        \t\"enable\": true,\r\n        \t\"isAsync\": false,\r\n        \t\"type\": \"rtm\"\r\n    \t},\r\n\t\"type\":\"rtm\"\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h3>\n
    {\r\n    \"_id\": \"st-182ea004-cd39-57d6-9a48-c9d27ac4019d\",\r\n    \"visibility\": {\r\n        \"namespace\": \"enterpriseNpublic\",\r\n        \"namespaceIds\": [\r\n            \"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660\"\r\n        ]\r\n    },\r\n    \"autoApprovalSettings\": {\r\n        \"newChannels\": false,\r\n        \"newTasks\": false,\r\n        \"channelUpgrades\": false,\r\n        \"taskUpgrades\": false,\r\n        \"autoPublishAll\": false\r\n    },\r\n    \"clustering\": {\r\n        \"enabled\": false,\r\n        \"requestsPerDay\": 0\r\n    },\r\n    \"approvedChannels\": [\r\n        \"ivr\",\r\n        \"rtm\"\r\n    ],\r\n    \"notifyUserViaEmail\": true,\r\n    \"workbenchConfigurable\": false,\r\n    \"purpose\": \"customer\",\r\n    \"hasUserEndpoint\": false,\r\n    \"codevelopers\": [],\r\n    \"offKoraConfirmation\": false,\r\n    \"state\": \"configured\",\r\n    \"type\": \"default\",\r\n    \"universalBotState\": \"configured\",\r\n    \"canTryOut\": false,\r\n    \"showInMp\": false,\r\n    \"defaultLanguage\": \"en\",\r\n    \"supportedLanguages\": [\r\n        \"en\"\r\n    ],\r\n    \"taskApprovedLanguages\": [\r\n        \"en\"\r\n    ],\r\n    \"publishedDisabledLangs\": [],\r\n    \"allowInheritance\": true,\r\n    \"inheritanceType\": 1,\r\n    \"status\": 1,\r\n    \"isDeflect\": false,\r\n    \"parentId\": \"false\",\r\n    \"sessionClosureProcess\": 0,\r\n    \"sessionInactiveTime\": 900000,\r\n    \"skipSessionMessage\": false,\r\n    \"vNameSpace\": [\r\n        \"ns-b822b9ce-d6de-5ce5-b49a-9dd5aadb468a\"\r\n    ],\r\n    \"languageConfigurations\": {\r\n        \"en\": {\r\n            \"enabled\": true\r\n        }\r\n    },\r\n    \"lastModifiedOn\": \"2021-01-12T11:10:36.817Z\",\r\n    \"accountId\": \"5e81ba854b3b29780134c7fb\",\r\n    \"verify_token\": \"025b98323fb5bd334d93d47206e962b8f5b58cab3cce4bc8eabfdc97a082c84b\",\r\n    \"createdBy\": \"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660\",\r\n    \"lastModifiedBy\": \"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660\",\r\n    \"createdOn\": \"2021-01-12T08:47:18.113Z\",\r\n    \"configuredBots\": [],\r\n    \"fallbackConfiguredBots\": [],\r\n    \"awaitingApprovalBots\": [],\r\n    \"publishedBots\": [],\r\n    \"fallbackPublishedBots\": [],\r\n    \"unpublishedBots\": [],\r\n    \"awaitingUnpublishedBots\": [],\r\n    \"suspendedBots\": [],\r\n    \"awaitingFallbackBots\": [],\r\n    \"upgradedBots\": [],\r\n    \"rejectedBots\": [],\r\n    \"inclusiveConfiguredBots\": [],\r\n    \"inclusivePublishedBots\": [],\r\n    \"awaitingInclusiveBots\": [],\r\n    \"variables\": [],\r\n    \"channelStatus\": {\r\n        \"rtm\": {\r\n            \"name\": \"Web \/ Mobile Client\",\r\n            \"state\": \"update\"\r\n        }\r\n    },\r\n    \"appPreferences\": {\r\n        \"rtmAppId\": \"cs-f3333f0d-b4ee-5a57-b7af-d5278e2c26e3\"\r\n    },\r\n    \"requestedBy\": \"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660\",\r\n    \"versionComment\": \"new update\",\r\n    \"license\": {\r\n        \"extraSessions\": 0,\r\n        \"extraCredits\": 0,\r\n        \"sessionsUsed\": 0,\r\n        \"creditsUsed\": 0,\r\n        \"planId\": \"trial\",\r\n        \"planName\": \"Free\",\r\n        \"startDate\": \"2021-01-12T08:47:48.504Z\",\r\n        \"endDate\": \"2021-02-11T08:47:48.504Z\",\r\n        \"subscriptionId\": \"sc-9eb6b501-343c-5a59-b832-705172b7e4df\",\r\n        \"baseAllowedSessions\": 3000,\r\n        \"billedSessions\": 3000,\r\n        \"unBilledSessions\": 0,\r\n        \"billingType\": \"free\",\r\n        \"nextRunAt\": \"2021-01-12T08:47:48.504Z\",\r\n        \"product\": \"Bots\",\r\n        \"licenseId\": \"ls-7869eb1a-9b7f-5bbb-b663-555650389494\"\r\n    },\r\n    \"audioCodesSettings\": {\r\n        \"enable\": true,\r\n        \"timeout\": 5000,\r\n        \"retry_limit\": 3,\r\n        \"callTerminationHandler\": \"\",\r\n        \"bargein\": false,\r\n        \"timeoutPrompts\": [\r\n            [\r\n                {\r\n                    \"type\": \"text\",\r\n                    \"value\": \"I have not received any input. Please provide your input\"\r\n                }\r\n            ]\r\n        ]\r\n    },\r\n    \"ivrSettings\": null,\r\n    \"twilioVoiceSettings\": {\r\n        \"enable\": true,\r\n        \"timeout\": 5000,\r\n        \"retry_limit\": 3,\r\n        \"callTerminationHandler\": \"\",\r\n        \"bargein\": false,\r\n        \"timeoutPrompts\": [\r\n            [\r\n                {\r\n                    \"type\": \"text\",\r\n                    \"value\": \"I have not received any input. Please provide your input\"\r\n                }\r\n            ]\r\n        ]\r\n    },\r\n    \"resourceid\": \"btstreams\",\r\n    \"errorCodes\": {\r\n        \"pollError\": []\r\n    },\r\n    \"name\": \"ConsumerAutomationBot748368\",\r\n    \"hasTenant\": true,\r\n    \"tenancy\": {\r\n        \"helpHint\": \"tenant url\"\r\n    },\r\n    \"languagePreferences\": {\r\n        \"type\": \"lifeTime\"\r\n    },\r\n    \"baseUrl\": \"https:\/\/{tenant}\",\r\n    \"color\": \"#009dab\",\r\n    \"botEvents\": {\r\n        \"ON_CONNECT_EVENT\": {\r\n            \"enabled\": true,\r\n            \"action\": \"showMsg\",\r\n            \"task\": null,\r\n            \"script\": \".\",\r\n            \"msg\": [],\r\n            \"welcomeIvrOptions\": []\r\n        },\r\n        \"TASK_FAILURE_EVENT\": {\r\n            \"enabled\": true,\r\n            \"action\": \"showMsg\",\r\n            \"task\": null,\r\n            \"script\": \".\",\r\n            \"msg\": [],\r\n            \"welcomeIvrOptions\": []\r\n        }\r\n    },\r\n    \"icon\": \"https:\/\/dlnwzkim0wron.cloudfront.net\/f-9a504aaf-065b-579d-a68a-db219d18ce66.png\",\r\n    \"universalBotVersion\": 1,\r\n    \"description\": \"ConsumerAutomationBot712202\",\r\n    \"nlMeta\": {\r\n        \"mlUtterances\": 5,\r\n        \"patterns\": 0,\r\n        \"synonyms\": 19\r\n    },\r\n    \"evVNameSpace\": [],\r\n    \"krVNameSpace\": [],\r\n    \"channels\": [\r\n        {\r\n            \"displayName\": \"Web \/ Mobile Client\",\r\n            \"type\": \"ivr\",\r\n            \"isAsync\": false,\r\n            \"enable\": true,\r\n            \"url\": \"https:\/\/bots.kore.ai\/chatbot\/hooks\/st-182ea004-cd39-57d6-9a48-c9d27ac4019d\"\r\n        },\r\n        {\r\n            \"displayName\": \"Web \/ Mobile Client\",\r\n            \"type\": \"rtm\",\r\n            \"enable\": true\r\n        }\r\n    ],\r\n    \"sdkSubscription\": {\r\n        \"sdkClientId\": \"cs-f3333f0d-b4ee-5a57-b7af-d5278e2c26e3\",\r\n        \"sdkHostUri\": \"https:\/\/43cbee12.ngrok.io\",\r\n        \"subscribedFor\": [\r\n            \"onMessage\",\r\n            \"onHook\",\r\n            \"onEvent\",\r\n            \"onAlert\",\r\n            \"onVariableUpdate\",\r\n            \"onAgentTransfer\"\r\n        ],\r\n        \"clientSecret\": \"7EJjY4rpyIGf+S0ROembjwfq1hmB55dZ7uU9g4SuoDw=\",\r\n        \"createdBy\": \"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660\",\r\n        \"appName\": \"Testone\",\r\n        \"algorithm\": \"HS256\"\r\n    },\r\n    \"_resolve\": [\r\n        \"createdBy\",\r\n        \"codevelopers\",\r\n        \"sdkSubscription.createdBy\"\r\n    ],\r\n    \"defaultDialogId\": null,\r\n    \"detectMultiIntent\": false,\r\n    \"enableAutoUtteranceAddition\": null,\r\n    \"enableMLNER\": null,\r\n    \"recentBotLimit\": null,\r\n    \"assignAllChildBots\": null,\r\n    \"interruptOptions\": {\r\n        \"interruptsEnabled\": true,\r\n        \"numTasksToHold\": \"1\",\r\n        \"type\": {\r\n            \"option\": \"developer\",\r\n            \"message\": \"\"\r\n        },\r\n        \"holdUxOptions\": {\r\n            \"option\": \"holdCurrTask\",\r\n            \"message\": \"\"\r\n        },\r\n        \"resumeUxOptions\": {\r\n            \"option\": \"notifyUser\",\r\n            \"message\": \"Resuming interrupted task\"\r\n        }\r\n    },\r\n    \"isCsMatchEnabled\": false,\r\n    \"enableNegativePatterns\": null,\r\n    \"amendConfig\": {},\r\n    \"permissions\": {\r\n        \"BOTBUILDER_TASKS\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_NATURAL_LANGUAGE\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_KNOWLEDGE_GRAPH\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_BATCH_TESTING\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_BOT_DEVELOPERS\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_BOT_SETTINGS\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_BOT_IMPORT\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_EXTENSIONS\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_PUBLISH_BOT\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_CHANNELS\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_DASHBOARD\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_BOT_ANALYTICS\": [\r\n            \"YES\"\r\n        ],\r\n        \"BOTBUILDER_CUSTOM_DASHBOARDS\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_STORYBOARD\": [\r\n            \"FULL\"\r\n        ],\r\n        \"BOTBUILDER_APPS_AND_SCOPES\": [\r\n            \"YES\"\r\n        ]\r\n    },\r\n    \"taskCounts\": {\r\n        \"alerts\": [\r\n            {\r\n                \"state\": \"published\",\r\n                \"count\": 4,\r\n                \"deletedCount\": 0\r\n            }\r\n        ],\r\n        \"actions\": [\r\n            {\r\n                \"state\": \"published\",\r\n                \"count\": 2,\r\n                \"deletedCount\": 0\r\n            }\r\n        ],\r\n        \"ktasks\": [],\r\n        \"dialogs\": [\r\n            {\r\n                \"state\": \"published\",\r\n                \"visibility\": \"enterprise\",\r\n                \"count\": 80,\r\n                \"deletedCount\": 0\r\n            }\r\n        ],\r\n        \"smalltalks\": [],\r\n        \"informationTasks\": [\r\n            {\r\n                \"state\": \"published\",\r\n                \"count\": 1,\r\n                \"deletedCount\": 0\r\n            }\r\n        ],\r\n        \"panels\": [],\r\n        \"widgets\": [],\r\n        \"forms\": [],\r\n        \"flows\": {\r\n            \"paramMaps\": [],\r\n            \"taskDGParamMaps\": []\r\n        }\r\n    }\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Used to initiate enable a channel for a bot. To use this API, app needs the Bot Builder API Scope of Channel Management under ChannelManagement. POST https:\/\/{{host}}\/api\/public\/bot\/channels Query Parameters Parameter Description host Environment URL, for example, https:\/\/bots.kore.ai Body Parameters Parameter Description BotId Bot ID - You can access it from the General Settings page of...","protected":false},"author":9,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-26453","post","type-post","status-publish","format-standard","hentry","category-channel-enablement"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/26453","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/comments?post=26453"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/26453\/revisions"}],"predecessor-version":[{"id":26454,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/26453\/revisions\/26454"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/media?parent=26453"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/categories?post=26453"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/tags?post=26453"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}