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
}