{"id":26458,"date":"2021-01-15T06:56:05","date_gmt":"2021-01-15T06:56:05","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?p=26458"},"modified":"2021-06-15T10:25:05","modified_gmt":"2021-06-15T09:25:05","slug":"channel-enablement-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/api-guide\/channel-enablement-api\/","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

To use this API, app needs the Admin 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>\nRequired\/
\nOptional<\/th>\n		Description<\/th>\n<\/tr>\n<\/thead>\n
host<\/td>\nRequired<\/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>\nRequired\/
Optional<\/th>\n		Description<\/th>\n<\/tr>\n<\/thead>\n
streamId<\/td>\nRequired<\/td>\nStream or Bot ID – You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n
appName<\/td>\nRequired<\/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>\nRequired<\/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>\nRequired<\/td>\n\n

Channel that you want to enable for this Bot. Following are the channel type details:<\/p>\n

    \n
  • rtm – for Web\/Mobile SDK<\/li>\n
  • slack – for Slack<\/li>\n
  • ivr – for WebHook<\/li>\n
  • msteams – for MS Teams<\/li>\n<\/ul>\n<\/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

    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

    Sample Request for Web\/Mobile channel<\/strong>:<\/p>\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\": \"st-xxxxfxxx-edxx-xxxx-xxbb-fxxxexxfxfcx\",\r\n    \"channelDetails\": {\r\n        \"displayName\": \"Web \/ Mobile Client\",\r\n        \"type\": \"rtm\",\r\n        \"app\": {\r\n           \"clientId\": \"cs-xexxdxxx-xbbc-xxex-xxef-xxxxxxxxfxfx\",\r\n           \"appName\": \"app_name\"\r\n        },\r\n     \"enable\": true\r\n    },\r\n  \"type\": \"rtm\"\r\n}'<\/pre>\n
    Sample Request for MS Teams channel<\/strong>:<\/p>\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\": \"st-42d7cc4e-8385-5c70-9e1f-5b68f521aabd\",\r\n    \"channelDetails\": {\r\n       \"botName\": \"Banking Bot\",\r\n       \"enable\": true,\r\n       \"type\": \"msteams\",\r\n       \"appId\": \"cbabcxce-acxb-xxxx-axxf-xabxxxfexxxb\",\r\n       \"appPassword\": \"\"\r\n     },\r\n   \"type\": \"msteams\"\r\n}'<\/pre>\n
    Sample Request for WebHook channel<\/strong>:<\/p>\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\": \"st-cxfaxxax-xexx-xxex-axxe-xxdxexxxfxex\",\r\n    \"channelDetails\": {\r\n        \"app\": {\r\n            \"clientId\": \"cs-dxxcxxxc-Xxxx-xxxx-axxx-xxxxcxbexeax\",\r\n            \"appName\": \"Banking Bot\"\r\n        },\r\n     \"createInstance\": true,\r\n     \"type\": \"ivr\",\r\n     \"displayName\": \"webhook1\",\r\n     \"enable\": true,\r\n     \"isAsync\": false,\r\n    },\r\n    \"type\": \"ivr\"\r\n}'<\/pre>\n
    Sample Request for Slack channel<\/strong>:<\/p>\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\": \"st-1b845445-9380-5fda-abb0-51a4423971ca\",\r\n   \"channelDetails\": {\r\n       \"displayName\": \"slack\",\r\n       \"botName\":\"Banking Bot\",\r\n       \"enable\": true,\r\n       \"type\": \"slack\",\r\n       \"accessToken\": \"xoxb-xxxxxxxx-xxxxxx-xa5FhuuDvOta4Bhlv7PfWZ\",\r\n       \"clientId\": \"xxxxxx.xxxxxx\",\r\n       \"clientSecret\": \"xxexxdxxxdxcxxbxacxxxdfxxxxxex\",\r\n       \"verificationToken\": \"abcd\"\r\n   },\r\n   \"type\": \"slack\"\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
    The response from the platform depends on the channel being enabled.<\/p>\n
    Sample response for web\/mobile SDK<\/strong>:<\/p>\n
    {\r\n\t\"displayName\": \"Web \/ Mobile Client\",\r\n\t\"type\": \"rtm\",\r\n\t\"name\": \"Web \/ Mobile Client\",\r\n\t\"isAlertsEnabled\": false,\r\n\t\"enable\": true,\r\n\t\"sttEnabled\": false,\r\n\t\"sttEngine\": \"kore\"\r\n}\r\n<\/pre>\n
    Sample response for webhook channel<\/strong>:<\/p>\n
    {\r\n    \"displayName\": \"webhook\",\r\n    \"enable\": true,\r\n    \"isAsync\": false,\r\n    \"type\": \"ivr\",\r\n    \"url\": \"<webhook-url>\"\r\n}<\/pre>\n
    Sample response for slack channel<\/strong>:<\/p>\n
    {\r\n    \"streamUserAccountId\": \"su-bxxxxfax-exba-xxeb-xxxc-xxxacxxxxxx\",\r\n    \"type\": \"slack\",\r\n    \"enable\": false,\r\n    \"verificationToken\": \"mxSxdWXcQxEFxrRPEdeoCC\"\r\n}<\/pre>\n
    Sample response for msteams channel<\/strong>:<\/p>\n
    {\r\n    \"type\": \"msteams\",\r\n    \"enable\": false,\r\n    \"accountId\": \"su-bcf9xxxfc-dxxx-xxxc-xexa-bxxexxxxxxx\",\r\n    \"app_id\": \"xxebcfxf-xxxd-xxca-xxea-bxxxxxxaxxx\"\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 Admin API Scope of Channel Management under ChannelManagement. POST https:\/\/{{host}}\/api\/public\/bot\/channels Query Parameters Parameter Required\/ Optional Description host Required Environment URL, for example, https:\/\/bots.kore.ai Body Parameters Parameter Required\/Optional Description streamId Required Stream or Bot ID - You can access it...","protected":false},"author":14,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-26458","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/26458","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/14"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=26458"}],"version-history":[{"count":16,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/26458\/revisions"}],"predecessor-version":[{"id":27244,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/26458\/revisions\/27244"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=26458"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=26458"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=26458"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}