Channel Enablement API¶

To initiate enable a channel for a virtual assistant.

Method	POST
Endpoint	`https://{{host}}/api/public/channels`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	Bot Builder: Not Applicable Admin Console: Channel Management

Query Parameters¶

PARAMETER	DESCRIPTION	MANDATE
host	The environment URL. For example, https://bots.kore.ai	Required

Sample Request¶

Sample Request for Web/Mobile channel:

curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "streamId": "st-xxxxfxxx-edxx-xxxx-xxbb-fxxxexxfxfcx",
    "channelDetails": {
        "displayName": "Web / Mobile Client",
        "type": "rtm",
        "app": {
           "clientId": "cs-xexxdxxx-xbbc-xxex-xxef-xxxxxxxxfxfx",
           "appName": "app_name"
        },
     "enable": true
    },
  "type": "rtm"
}'

Sample Request for MS Teams channel:

curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "streamId": "st-4xx7ccxx-8xx5-5cxx-9xxf-5bxxxxxxxxxx",
    "channelDetails": {
       "botName": "Banking Bot",
       "enable": true,
       "type": "msteams",
       "appId": "cbabcxce-acxb-xxxx-axxf-xabxxxfexxxb",
       "appPassword": ""
     },
   "type": "msteams"
}'

Sample Request for WebHook channel:

curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "streamId": "st-cxfaxxax-xexx-xxex-axxe-xxdxexxxfxex",
    "channelDetails": {
        "app": {
            "clientId": "cs-dxxcxxxc-Xxxx-xxxx-axxx-xxxxcxbexeax",
            "appName": "Banking Bot"
        },
     "createInstance": true,
     "type": "ivr",
     "displayName": "webhook1",
     "enable": true,
     "enablePolling": false,
     "isAsync": false,
    },
    "type": "ivr"
}'

Sample Request for Slack channel:

curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
   "streamId": "st-1bxxxxxx-9xx0-5xxa-abxx-51xxxxxxxxxa",
   "channelDetails": {
       "displayName": "slack",
       "botName":"Banking Bot",
       "enable": true,
       "type": "slack",
       "accessToken": "xoxb-xxxxxxxx-xxxxxx-xxxxxxxxxxxxxxxxxxxxxZ",
       "clientId": "xxxxxx.xxxxxx",
       "clientSecret": "xxexxdxxxdxcxxbxacxxxdfxxxxxex",
       "verificationToken": "abcd"
   },
   "type": "slack"
}'

Body Parameters¶

PARAMETER	DESCRIPTION	MANDATE
streamId	Stream or Bot ID – You can access it from the General Settings page of the bot.	Required
appName	The app associated with this Bot, you can obtain it from the Manage Apps page of the bot	Required
clientId	The client id for the app associated with this Bot, you can obtain it from the Manage Apps page of the bot	Required
type	Channel that you want to enable for this Bot. Following are the channel type details: rtm – for Web/Mobile SDK slack – for Slack ivr – for WebHook msteams – for MS Teams	Required

Sample Response¶

The response from the platform depends on the channel being enabled.

Sample response for web/mobile SDK:

{
    "displayName": "Web / Mobile Client",
    "type": "rtm",
    "enable": true,
    "notification": {
        "acl": []
    },
    "name": "Web/Mobile Client",
    "embedWebClientDetails": {
        "scriptTag": "",
        "cssTag": "     ",
        "domains": [],
        "apiKey": "d3be215756d94803b0a548e594c0e1625b88e873cec9e48eb918add573d738f26stda",
        "testAPIKey": "7e203670dc4d41d5bcc0d58b4e02a164e0b6a0c9438b45c1971c6e703582c88estda",
        "chatURL": "https://preprod-bots.korebots.com/webclient/d3be215756d94803b0548e594c0e162a5b88e873cec9e48eb918add573d738f26stda",
        "isURLEnabled": true
    }
}

Sample response for webhook channel:

{
    "streamId": "st-6f90cbdc-46c7-52f8-a388-8db39b0f4436",
    "channelDetails": {
        "app": {
             "clientId": "cs-ccaa5400-83b9-5a38-897d-0114d2aab521",
             "appName": "try"
        },
        "createInstance": true,
        "type": "ivr",
        "displayName": "webhook11",
        "enable": true,
        "isAsync": false
    },
    "type": "ivr"
}

Sample response for Slack channel:

{
    "streamUserAccountId": "su-5d7c2d17-5fa2-58db-b2fc-83cfe259d14a",
    "type": "slack",
    "enable": true,
    "verificationToken": "a7365",
    "notification": {
        "acl": []
    },
    "name": "Slack"
}

Sample response for MS Teams channel:

{
    "streamId": "st-6f90cbdc-46c7-52f8-a388-8db39b0f4436",
    "channelDetails": {
       "botName": "today",
       "enable": true,
       "type": "msteams",
       "appId": "e51678c4-3c92-4053-8d0e-f9173ec1136e",
       "appPassword": "DLu8Q~oB1BSUOpKcwUp.BWotfOqAagfPCOm4oaXz"
    },
    "type": "msteams"
}