Skip to content

Back to API List

Enabling Agent Transfer API

This API is used to configure the Botkit Url, App, and events.

Method PUT
Endpoints https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription
Content Type application/json
Authorization auth: {{JWT}}
See How to generate the JWT Token.
API Scope BotKit

Query Parameters

PARAMETER DESCRIPTION
host Environment URL, for example, https://platform.kore.ai
BotID Bot ID or Stream ID. You can access it from the General Settings page.

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.

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>