{"id":60388,"date":"2023-11-28T12:53:00","date_gmt":"2023-11-28T12:53:00","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=60388"},"modified":"2023-11-28T13:34:03","modified_gmt":"2023-11-28T13:34:03","slug":"import-bot-functions-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/import-bot-functions-api\/","title":{"rendered":"Import Bot Functions API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

This API allows you to import bot functions from a specified file.<\/span><\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/botId\/import\/botfunctions<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Not Applicable<\/li>\n
  • Admin Console: Bot Definition > Bot Import<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    host<\/td>\nRequired<\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\n<\/tr>\n
    botID<\/td>\nRequired<\/td>\nThe Bot ID or Stream ID of the bot into which you want to import the functions. You can get it under General Settings<\/strong> on the Bot Builder.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n
    curl -X POST \\\r\n'https:\/\/{{host}}\/api\/public\/bot\/botId\/import\/botfunctions' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data '[{\"fileName\":\"BotFunctions.js\",\"fileId\":\"6565d8fea4fa7f2827b225f3\"}]'\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    fileId<\/td>\nRequired<\/span><\/td>\nThe unique identifier (ID) of the file to be imported. This ID can be retrieved from the response of the <\/span>Upload File API <\/span><\/a>after uploading the Bot Functions file.<\/span><\/td>\n<\/tr>\n
    fileName<\/td>\nRequired<\/span><\/td>\nThe name of the file containing the bot functions to import.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    Success<\/p>\n
    {\r\n    \"requestType\": \"BotImport\",\r\n    \"status\": \"Success\",\r\n    \"createdOn\": \"2023-11-28T12:14:59.215Z\",\r\n    \"_id\": \"6565d9c378438bc41a6cfxxx\",\r\n    \"createdBy\": \"u-37bc3853-76fd-5a25-b307-1af2e8f1bxxx\",\r\n    \"__v\": 0,\r\n    \"fileId\": \"6565d8fea4fa7f2827b225f3\",\r\n    \"fileName\": \"BotFunctions.js\"\r\n}\r\n<\/pre>\n
    Failure<\/p>\n
    {\r\n    \"errors\": [\r\n        {\r\n            \"msg\": \"Invalid file id\",\r\n            \"code\": 400\r\n        }\r\n    ]\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>
    <\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"This API allows you to import bot functions from a specified file. Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/botId\/import\/botfunctions Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Import Query Parameters Parameter Required Description host Required The environment URL. For example, https:\/\/bots.kore.ai...","protected":false},"author":26,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-60388","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\/60388","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\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=60388"}],"version-history":[{"count":5,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/60388\/revisions"}],"predecessor-version":[{"id":60395,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/60388\/revisions\/60395"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=60388"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=60388"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=60388"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}