{"id":18060,"date":"2018-08-24T11:55:13","date_gmt":"2018-08-24T11:55:13","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?post_type=docs&p=15189"},"modified":"2021-03-18T10:38:48","modified_gmt":"2021-03-18T10:38:48","slug":"conversation-history-api-old","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/api-guide\/conversation-history-api-old\/","title":{"rendered":"Conversation History API (old)"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Fetches the conversational messages between the bot and user in reverse chronological order. This API supports pagination. You can provide offset\/skip and limit to get a certain number of messages at a time.<\/p>\n

Note<\/strong>: This API is currently accessible only if BotKit SDK or Agent Transfer is enabled for a bot.<\/em><\/p>\n

This API will soon be deprecated<\/span><\/strong>, use this API instead: Conversation History API<\/a>.<\/p>\n

Get <\/b> \/api\/botsdk\/stream\/{{stream_id}}\/getMessages?userId={{user_id}}&skip={{numberOfMessagesToBeSkipped}}&limit={{numberOfMessagesTobeFetched}}<\/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

Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
stream_id<\/td>\nBot ID. You can access it from the bot\u2019s General Settings page.<\/td>\n<\/tr>\n
user_id<\/td>\nThe ID of the user whose conversation history to access.<\/td>\n<\/tr>\n
skip<\/td>\nThe number of messages to be skipped.<\/td>\n<\/tr>\n
limit<\/td>\nThe number of messages to be shown on each page.<\/td>\n<\/tr>\n<\/thead>\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><\/h3>\n

Invoke the API with JWT in the header with the following syntax:
\nauth: {{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><\/h3>\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><\/h3>\n
curl -X GET \\ 'https:\/\/bots.kore.ai\/api\/botsdk\/stream\/{{stream_id}}\/getMessages?userId= u-XXX-XXX' \\\r\n-H 'auth: YOUR_JWT_ACCESS_TOKEN'<\/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><\/h3>\n
{\r\n   \"total\":1,\r\n   \"moreAvailable\":false,\r\n   \"messages\":[\r\n      {\r\n         \"_id\":\"ms-eb23XXXXX7075f28b\",\r\n         \"type\":\"outgoing\",\r\n         \"status\":\"pending\",\r\n         \"createdBy\":\"u-6dd4XXXXXXXXXf-1f75b054f6dc\",\r\n         \"botId\":\"st-db4c106XXXXXXXXX05-350518802fd6\",\r\n         \"orgId\":\"o-232b5XXXXXXXded-d8d5131aa62c\",\r\n         \"lmodifiedOn\":\"2017-09-28T13:18:04.395Z\",\r\n         \"createdOn\":\"2017-09-28T13:18:04.401Z\",\r\n         \"components\":[\r\n            {\r\n               \"_id\":\"cp-905c82aXXXXXXX360499c39a\",\r\n               \"cT\":\"text\",\r\n               \"data\":{\r\n                  \"text\":\"Thanks! I now have access to your Kore Assistant account. Don\u2019t worry, I never access your account without you asking me to do something for you.\"\r\n               },\r\n               \"thumbnails\":[\r\n               ]\r\n            }\r\n         ],\r\n         \"channels\":[\r\n            {\r\n               \"to\":\"u-6dd4XXXXXXXXX75b054f6dc\",\r\n               \"type\":\"rtm\",\r\n               \"requestId\":\"ms-dfabXXXXXXX7704b79b21\"\r\n            }\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><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Fetches the conversational messages between the bot and user in reverse chronological order. This API supports pagination. You can provide offset\/skip and limit to get a certain number of messages at a time. Note: This API is currently accessible only if BotKit SDK or Agent Transfer is enabled for a bot. This API will soon...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18060","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/18060","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=18060"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/18060\/revisions"}],"predecessor-version":[{"id":21336,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/18060\/revisions\/21336"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=18060"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=18060"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=18060"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}