이 API는 세션 ID와 봇 ID를 기반으로 현재 활성 세션을 활성화합니다. 이 API는 BT 앱 범위에서 사용할 수 있습니다.
이 API를 사용하려면 앱은 봇 세션의 봇 빌더 API 범위가 필요합니다.
PUT https://{{host}}/api/public/bot/{{BotID}}/session
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL(예: https://bots.kore.ai) |
| BottId | 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다. |
본문 매개 변수
| 매개 변수 | 설명 |
|---|---|
| userId (선택 사항) | 액세스할 대화 기록을 가진 사용자의 ID입니다. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다. |
| status (선택 사항) | '비활성'으로 설정 |
| channel (선택 사항) | 대화가 발생한 채널입니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/JSON
샘플 요청
curl -X PUT \
{{host}}/api/public/{{BotId}}/sessions' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'Content-Type: application/json' \
-d '{
userId : “u-Id”,
status : “inactive”,
channel : “rtm”
}'
샘플 응답
{
“success” : true
}
このAPIは、セッションIDとボットIDに基づいて、現在の有効なセッションを無効にします。このAPIは、BTのアプリスコープで利用可能です。
このAPIを使用するために、アプリは [ボットセッション] の [ボットビルダーのAPIスコープ] を必要とします。
PUT https://{{host}}/api/public/bot/{{BotID}}/session
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例： https://bots.kore.ai） |
| BotId | ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 |
本文パラメータ
| パラメータ | 説明 |
|---|---|
| userId（任意） | 会話履歴にアクセスするユーザーのIDです。ユーザーのメールIDまたは企業に割り当てられた一意のIDになります。 |
| status（任意） | 「無効」に設定する |
| channel（任意） | 会話が行われたチャネルです。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/JSON
サンプルリクエスト
curl -X PUT \ {{host}}/api/public/{{BotId}}/sessions' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'Content-Type: application/json' \ -d '{ userId : “u-Id”, status : “inactive”, channel : “rtm” }'
サンプル応答
{ “success” : true }
Leave a Reply
This API In-activates current active session based on session Id and bot Id. This API is available in the BT app scopes.
To use this API, the app needs the Bot Builder API scope of Bot sessions.
PUT https://{{host}}/api/public/bot/{{BotID}}/session
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 |
|---|---|
| userId (optional) | The ID of the user whose conversation history to access. Can be user email id or enterprise assigned unique id. |
| status (optional) | Set to ‘inactive‘ |
| channel (optional) | Channel on which the conversation took place. |
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 \
{{host}}/api/public/{{BotId}}/sessions' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'Content-Type: application/json' \
-d '{
userId : “u-Id”,
status : “inactive”,
channel : “rtm”
}'
Sample Response
{
“success” : true
}