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 the General Settings page of the bot. |
| AppName | Required | The app associated with this Bot, you can obtain it from the Manage Apps page of the bott |
| ClientId | Required | The client id for the app associated with this Bot, you can obtain it from the Manage Apps page of the bott |
| type | Required |
Channel that you want to enable for this Bot. Following are the channel type details:
|
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response content type
application/json
Sample Request
curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"botId":"{{bot Id}}",
"channelDetails":{
"app": {
"appName": "App Name",
"clientId": "cs-fxxxfxd-bxee-xaxx-bxaf-dxxxxe2c26e3"
},
"createInstance": false,
"displayName": "Web / Mobile Client",
"enable": true,
"isAsync": false,
"type": "rtm"
},
"type":"rtm"
}'
Sample Response
The response from the platform depends on the channel being enabled.
Sample response for webhook channel:
{
"displayName": "webhook",
"enable": true,
"isAsync": false,
"type": "ivr",
"url": "<webhook-url>"
}
Sample response for slack channel:
{
"streamUserAccountId": "su-bxxxxfax-exba-xxeb-xxxc-xxxacxxxxxx",
"type": "slack",
"enable": false,
"verificationToken": "mxSxdWXcQxEFxrRPEdeoCC"
}
Sample response for msteams channel:
{
"type": "msteams",
"enable": false,
"accountId": "su-bcf9xxxfc-dxxx-xxxc-xexa-bxxexxxxxxx",
"app_id": "xxebcfxf-xxxd-xxca-xxea-bxxxxxxaxxx"
}