チャネル有効化API

ボットのチャネルの有効化を開始するために使用されます。

このAPIを使用するために、アプリは [ChannelManagement] の [チャネル管理] の管理APIスコープを必要とします。

ポスト https://{{host}}/api/public/bot/channels

クエリパラメータ

パラメータ	必須/任意	説明
ホスト	必須	環境URL（例： https://bots.kore.ai）

本文パラメータ

パラメータ	必須/任意	説明
BotId	必須	ボットID – ボットの [一般設定] ページからアクセスすることができます。
AppName	必須	このに関連するアプリは、ボットの [アプリを管理] ページから取得することができます。
ClientId	必須	このボットに関連するアプリのクライアントIDは、ボットの [アプリを管理] ページから取得することができます。
type	必須	このボットで有効にしたいチャネルです。チャネルタイプの詳細は以下の通りです。 rtm – ウェブ/モバイルSDK用 slack – Slack用 webhook – Webhook用 msteams – MS Teams用

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

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" }'

サンプル応答

プラットフォームからの応答は、有効になっているチャネルによって異なります。ウェブ/モバイルSDKのサンプル応答：

{ "displayName": "Web / Mobile Client", "type": "rtm", "name": "Web / Mobile Client", "isAlertsEnabled": false, "enable": true, "sttEnabled": false, "sttEngine": "kore" }

Webhookチャネルのサンプル応答：

{ "displayName": "webhook", "enable": true, "isAsync": false, "type": "ivr", "url": "<webhook-url>" }

Slackチャネルのサンプル応答：

{ "streamUserAccountId": "su-bxxxxfax-exba-xxeb-xxxc-xxxacxxxxxx", "type": "slack", "enable": false, "verificationToken": "mxSxdWXcQxEFxrRPEdeoCC" }

MSTeamsチャネルのサンプル応答：

{ "type": "msteams", "enable": false, "accountId": "su-bcf9xxxfc-dxxx-xxxc-xexa-bxxexxxxxxx", "app_id": "xxebcfxf-xxxd-xxca-xxea-bxxxxxxaxxx" }

On this Page

Channel Enablement API

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: rtm – for Web/Mobile SDK slack – for Slack webhook – for WebHook msteams – for MS Teams

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 web/mobile SDK:

{
	"displayName": "Web / Mobile Client",
	"type": "rtm",
	"name": "Web / Mobile Client",
	"isAlertsEnabled": false,
	"enable": true,
	"sttEnabled": false,
	"sttEngine": "kore"
}

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"
}

On this Page