Botkit URL, 앱 및 이벤트를 구성합니다.

이 API를 사용하려면 앱에 BotKit의 봇 빌더 API 범위가 필요합니다.

PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription

쿼리 매개 변수,

매개 변수 설명
host 환경 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>

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

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>

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

To configuring the Botkit Url, App, and events.

To use this API, app needs the Bot Builder API scope of BotKit.

PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
BotID Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter Description
connectorEnabled To enable connector (optional)
PIIMaskingDisabledForAgentTransfer To disable PII masking (optional).
sdkClientId Client Id to be associated with the SDK bot kit
sdkHostUri SDK host URL
subscribedFor array of events that need to be subscribed for

onAgentTransfer” is mandatory here.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

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

Sample Response

<Bot info object>

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed