This API is used to configure the Botkit Url, App, and events.
Note: To use this API, app needs the XO Platform API scope of BotKit. |
Syntax:
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 assistant’s 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. |
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>