{"id":23822,"date":"2020-07-03T17:00:20","date_gmt":"2020-07-03T16:00:20","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=23822"},"modified":"2022-10-05T07:03:00","modified_gmt":"2022-10-05T06:03:00","slug":"enabling-agent-transfer-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/enabling-agent-transfer-api\/","title":{"rendered":"Enabling Agent Transfer API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

This API is used to configure the Botkit Url, App, and events.<\/p>\n\n\n\n
Note<\/strong>: To use this API, app needs the XO Platform API scope of BotKit<\/em>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Syntax:<\/span><\/h2>\n

PUT <\/strong>https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/sdkSubscription<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h2>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/code><\/td>\n<\/tr>\n
BotID<\/td>\nBot ID or Stream ID. You can access it from the assistant’s General Settings page.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
\r\n\t\t
\r\n\t\t\t

\u00a0<\/span><\/h3>\n

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
connectorEnabled<\/td>\nTo enable connector (optional)<\/td>\n<\/tr>\n
PIIMaskingDisabledForAgentTransfer<\/td>\nTo disable PII masking (optional).<\/td>\n<\/tr>\n
sdkClientId<\/td>\nClient Id to be associated with the SDK bot kit<\/td>\n<\/tr>\n
sdkHostUri<\/td>\nSDK host URL<\/td>\n<\/tr>\n
subscribedFor<\/td>\n\n

array of events that need to be subscribed for<\/p>\n

“onAgentTransfer<\/em>” is mandatory here.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h2>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h2>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h2>\n
curl -X PUT \\\r\n   https:\/\/{{host}}\/api\/bot\/{{BotID}}\/sdkSubscription' \\  \r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -d '{\r\n       \"connectorEnabled\": false, \/\/ optional\r\n       \"PIIMaskingDisabledForAgentTransfer\": false, \/\/optional\r\n       \"sdkClientId\": \"cs-xxxxx-xxxx-xxxx-xxxx-xxxxx\",\r\n       \"sdkHostUri\": \"https:\/\/example.ngrok.io\",\r\n       \"subscribedFor\": [             \r\n\t   \"onMessage\",\r\n\t   \"onHook\",\r\n\t   \"onEvent\",\r\n\t   \"onAlert\",\r\n\t   \"onVariableUpdate\",\r\n           \"onAgentTransfer\"\r\n\t]}'\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h2>\n
<Bot info object><\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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....","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-23822","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/23822","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=23822"}],"version-history":[{"count":8,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/23822\/revisions"}],"predecessor-version":[{"id":48148,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/23822\/revisions\/48148"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=23822"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=23822"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=23822"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}