Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
User Prompts
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Importing and Exporting
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Machine Learning
Model Validation
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Ranking and Resolver
NLP Detection
Advanced NLP Configurations
Bot Intelligence
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Manage Sessions
Bot Management
Bot Versioning
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Using nlMeta
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. API Guide
  5. Conversation History API

Conversation History API

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.

This is a newer version of the old API which will soon be deprecated. This revised API addresses the limitation of the older version on enabling BotKit or Agent Transfer.

To use this API, app needs the Bot Builder API scope of Chat History.
OR the Admin API Scope of Chat History under Bot Analytics.


A POST API call can also be used to include Session-Id and MetaTags in the retrieved Conversation History.

POST https://{{host}}/api/public/bot/{{BotID}}/getMessages
and https://{{host}}/api/public/getMessages for Bot Admin Console


Parameter Description
BotID (optional) Bot ID. You can access it from the bot’s General Settings page.
userId (mandatory for GET call
optional for POST call)
The ID of the user whose conversation history to access. Can be user email id or enterprise assigned unique id.
skip/offset (optional) The number of messages to be skipped.
limit (optional) The number of messages to be shown on each page.
forward (optional) Takes boolean values true/false. Specifies the direction of the messages to be retrieved.

  • If the value is true, then the conversation history is retrieved in the order old to the most recent one.
  • If the value is false, then the conversation history is retrieved in the reverse order i.e, the most recent to the oldest message
dateFrom (optional) Takes the date format yyyy-mm-dd
(or) yyyy-mm-ddThh:mm:ss.msZ
eg:2019-04-01 (or) 2019-04-01T13:25:58.515ZIf not provided, calculated as 7 days behind dateTo.
Note: This field cannot be used in combination with msgId.
dateTo (optional) Takes the date format yyyy-mm-dd
(or) yyyy-mm-ddThh:mm:ss.msZ
eg:2019-04-01 (or) 2019-04-01 T13:26:05.598ZIf not provided, calculated as 7 days from dateFrom. If dateFrom is also not provided then set to Today.
Note: This field cannot be used in combination with msgId
channelType (optional) Name of the channel of whose conversation history is needed, default is ‘rtm’ .

Accepted channel types are:

  • “skypeforbusiness”,
  • “msteams”,
  • “twitter”,
  • “spark”,
  • “rtm”,
  • “facebook”,
  • “slack”,
  • “skype”,
  • “kore”,
  • “email”,
  • “sms”,
  • “wfacebook”,
  • “ringcentral”,
  • “jabber”,
  • “yammer”,
  • “alexa”,
  • “twiliovoice”,
  • “telegram”,
  • “ivr”,
  • “ivrVoice”,
  • “line”,
  • “liveperson”,
  • “googleactions”,
  • “hangoutchat”,
  • “mattermost”,
  • “rcs”.

Note: In case of multi-webhook channel configuration, “ivr” will give the conversations for the first WebHook instance. For those related to other instance, specify the ivrInstID, you can get it from the WebHook URL which is of the form: {{host_url}}/chatbot/hooks/{{BotId}}/hookInstance/{{ivrInstID}})

msgId (optional) A specific Message-Id if known. This would fetch the records starting from that message either forward or backward depending upon the direction (see below) requested.

In case only the specific conversation is required, set the limit to 1

Note: This field cannot be used in combination with dateFrom and dateTo.

direction (optional when msgId is given)
  • <0 reverse
  • =0 bidirectional
  • >0 forward

Default direction is forward.

sessionId (optional) A specific Session-Id if known. Refer here to obtain the session id
tags (optional) Meta tags to filter the conversations.

Note: The duration between dateTo and dateFrom should be less than 7 days, else an error will be thrown.


Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type


Sample Request

curl -X GET \
channelType=facebook&dateFrom=2019-04-01&dateTo=2019-04-05' \ 

Sample Request for POST call

curl -X POST \ \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '{
        userId           : u-xxxx-xxxxx-xxxx
	skip             : 0,                           
	limit            : 100,                       
	dateFrom         : “2019-04-01”  (or)  “2019-04-01T13:25:58.515Z”,
	dateTo           : “2019-04-01”  (or)  “2019-04-01T13:25:58.515Z”,
	channelType      : “rcs”,
	sessionId        : [“5eadxxxxxxxxxxxxx”,”5ebxxxxxxxxxxxxxxx”],
	tags	         : {
		          and   : [
			              “name”  : ”tagname”,
			              “values”  : [“tagvalue1”,”tagvalue2”],
                                      “type”    : “tagtype” // user/message/session	
                                    “name”  : ”tagname”,
    			            “values”  : [“tagvalue1”,”tagvalue2”],
                                    “type”    : “tagtype”  // user/message/session	

Sample Response

    "total": 1,
    "moreAvailable": false,
    "messages": [
            "_id": "ms-e172XXXXXX9a492cd2",
            "type": "outgoing",
            "status": "pending",
            "lmodifiedOn": "2019-04-01T13:25:58.512Z",
            "createdBy": "u-dfb0a15XXXXXXXXX6afa4c74d",
            "channels": [
                    "type": "rcs"
            "components": [
                    "_id": "cp-4fbXXXXXXXXXX6ebdd586531",
                    "cT": "text",
                    "data": {
                        "text": "Thanks! I now have access to your Kore Assistant account. Don’t worry, I never access your account without you asking me to do something for you."
                    "thumbnails": []
            "botId": "st-fe7XXXXXX6e115e94c",
            "orgId": "o-5a64XXXXXXXXXa58cd43460c3",
            "accountId": "5c9c95bXXXXX23c523dbc",
            "isBB": 1,
            "ms": 1,
            "chnl": "rcs",
            "createdOn": "2019-04-01T13:25:58.515Z",
            "timestampValue": 1554125158515,
            "__v": 0,
            "resourceid": "messagestore",
            "tags": {
                "messageTags": [],
                "userTags": [
                        "value": "+919346804623",
                        "name": "RCSID"
                "sessionTags": []
            }        }

Sample Response from POST call:

  "total": 1,
  "moreAvailable": false,
  "messages"  : [
                  "_id": "ms-xxxxxxxxxxxxxxxxxxxx",
                  "type": "incoming",
                  "status": "sent to cs",
                  "lmodifiedBy": u-xxxxxxxxxxxxxxxxxxx",
                  "lmodifiedOn": "2019-04-10T10:21:45.103Z",
                  "channels": [
                      "type": "rtm"
                  "orgId": “o-xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                  "accountId": "5xxxxxxxxxxxxxxxxxxxxxxxx",
                  "isBB": 0,
                  "ms": 1,
                  "channel": "rtm",
                  "components": [
                      "cT": "text",
                      "data": {
                          "text": "23"
                      "thumbnails": []
                    "createdOn": "2019-04-10T10:21:45.106Z",
                    "timestampValue": 1554891705106,
                    "__v": 0,
                    "sessionId": "5cadbefc6a81a71559f6bece"