ボットのチャネルの有効化を開始するために使用されます。
このAPIを使用するために、アプリは [ChannelManagement] の [チャネル管理] の管理APIスコープを必要とします。
ポスト https://{{host}}/api/public/bot/channels
クエリパラメータ
パラメータ | 必須/任意 | 説明 |
---|---|---|
ホスト | 必須 | 環境URL(例: https://bots.kore.ai) |
本文パラメータ
パラメータ | 必須/任意 | 説明 |
---|---|---|
BotId | 必須 | ボットID – ボットの [一般設定] ページからアクセスすることができます。 |
AppName | 必須 | このに関連するアプリは、ボットの [アプリを管理] ページから取得することができます。 |
ClientId | 必須 | このボットに関連するアプリのクライアントIDは、ボットの [アプリを管理] ページから取得することができます。 |
type | 必須 | このボットで有効にしたいチャネルです。チャネルタイプの詳細は以下の通りです。
|
認証
以下の構文を使用して、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" }