BotKitのURL、アプリ、イベントを設定します。
このAPIを使用するために、アプリは [BotKit] にあるボットビルダーのAPIスコープを必要とします。
PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例） https://bots.kore.ai |
| BotID | ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 |
本文パラメータ
| パラメータ | 説明 |
|---|---|
| connectorEnabled | コネクタ有効にする（任意） |
| PIIMaskingDisabledForAgentTransfer | PIIマスキングを無効にする（任意）。 |
| sdkClientId | SDK ボットキットに関連付けられるクライアントID |
| sdkHostUri | SDKホストURL |
| subscribedFor | ここでは、「onAgentTransfer」にサブスクライブされる必要のあるイベントの配列が必須です。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X PUT \ https://{{host}}/api/bot/{{BotID}}/sdkSubscription' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -d '{ "connectorEnabled": false, // optional "PIIMaskingDisabledForAgentTransfer": false, //optional "sdkClientId": "cs-xxxxx-xxxx-xxxx-xxxx-xxxxx", "sdkHostUri": "https://example.ngrok.io", "subscribedFor": [ "onMessage", "onHook", "onEvent", "onAlert", "onVariableUpdate", "onAgentTransfer" ]}'
サンプル応答
<Bot info object>