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

\nTo 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\/
\nOptional<\/th>\n		Description<\/th>\n<\/tr>\n<\/thead>\n
BotId<\/td>\nRequired<\/td>\nBot 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
  • slack – for Slack<\/li>\n
  • webhook – 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
    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    \"botId\":\"{{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
    The response from the platform depends on the channel being enabled.<\/p>\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 BotId Required Bot ID - You can access it from...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-26458","post","type-post","status-publish","format-standard","hentry","category-channel-enablement"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/26458","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=26458"}],"version-history":[{"count":11,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/26458\/revisions"}],"predecessor-version":[{"id":26595,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/26458\/revisions\/26595"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=26458"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=26458"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=26458"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}