OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
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
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
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
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI 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
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

セッション履歴API

This API retrieves the conversation sessions created. This API is available in BT and BAC app scopes.

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

POST https://{{host}}/api/public/bot/{{BotID}}/getSessions?containmentType={{containmentType}}
and https://{{host}}/api/public/getSessions?containmentType={{containmentType}} for Bot Admin Console

Query Parameters

Parameter Description
containmentType Use to filter the results based on the type of the session i.e Self-service vs. Drop-off vs. Agent Transfer
Valid values:

  • dropOff,
  • Selfservice,
  • agent.

Body Parameters

Parameter Description
userId (optional) The ID of the user whose conversation history to access. Can be a 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.
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 dataTo.
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.
tags (optional) Meta tags to filter the conversations.
sessionType (optional)
(introduced in ver8.0)
Type to filter the conversations – can be:

  • non-interactive – sessions that have bot messages presented without any message from the user
  • interactive – sessions that include one or more messages from the user

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

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/JSON

Sample Request

  • Without a body
    curl --location --request POST '{{host}}/api/public/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw ''
  • With a body
    curl --location --request POST '{{host}}/api/public/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw '{
            "skip" : 0,                          
            "limit" : 100,                      
            "dateFrom" : "2020-02-11",
            "dateTo" : "2020-02-12"
     }'
  • For Specific Bot
    curl --location --request POST '{{host}}/api/public/bot/{{BotId}}/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw '{
            "skip" : 0,                          
            "limit" : 100,                      
            "dateFrom" : "2020-02-11",
            "dateTo" : "2020-02-12"
     }'

Sample Response

  • for dropOff sessions
    {
      "total": 1,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "dropOff",
         "isDeveloper": false,
         "tags": {
           "userTags": [
            {
             "value": "newuser",
             "name": "regular"
            }
          ],
          "sessionTags": []
         },
         "noOfMessagesExchanged": 1,
         "noOfTasksExecuted": 0
       }
      ]
    }
  • for Selfservice sessions
    {
      "total": 2,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "selfService",
         "isDeveloper": false,
         "tags": {
           "userTags": [
            {
             "value": "newuser",
             "name": "regular"
            }
           ],
           "sessionTags": []
         },
         "noOfMessagesExchanged": 6,
         "noOfTasksExecuted": 0
        },
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "selfService",
         "isDeveloper": false,
         "tags": {
           "userTags": [
             {
              "value": "newuser",
              "name": "regular"
            }
          ],
         "sessionTags": []
         },
         "noOfMessagesExchanged": 8,
         "noOfTasksExecuted": 0
        }
      ]
    }
  • for agent sessions
    {
      "total": 1,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
    	 "sessionType": "agent",
    	 "isDeveloper": false,
    	 "tags": {
    		"userTags": [],
    		"sessionTags": []
    	 },
    	 "noOfMessagesExchanged": 7,
    	 "noOfTasksExecuted": 2
    	}
      ]
    }
OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
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
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
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
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI 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
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

Sessions History API

This API retrieves the conversation sessions created. This API is available in BT and BAC app scopes.

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

POST https://{{host}}/api/public/bot/{{BotID}}/getSessions?containmentType={{containmentType}}
and https://{{host}}/api/public/getSessions?containmentType={{containmentType}} for Bot Admin Console

Query Parameters

Parameter Description
containmentType Use to filter the results based on the type of the session i.e Self-service vs. Drop-off vs. Agent Transfer
Valid values:

  • dropOff,
  • Selfservice,
  • agent.

Body Parameters

Parameter Description
userId (optional) The ID of the user whose conversation history to access. Can be a 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.
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 dataTo.
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.
tags (optional) Meta tags to filter the conversations.
sessionType (optional)
(introduced in ver8.0)
Type to filter the conversations – can be:

  • non-interactive – sessions that have bot messages presented without any message from the user
  • interactive – sessions that include one or more messages from the user

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

Authorization

Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}

Response content type

application/JSON

Sample Request

  • Without a body
    curl --location --request POST '{{host}}/api/public/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw ''
  • With a body
    curl --location --request POST '{{host}}/api/public/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw '{
            "skip" : 0,                          
            "limit" : 100,                      
            "dateFrom" : "2020-02-11",
            "dateTo" : "2020-02-12"
     }'
  • For Specific Bot
    curl --location --request POST '{{host}}/api/public/bot/{{BotId}}/getSessions?containmentType={{containmentType}}' \
         --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
         --header 'Content-Type: application/json' \
         --data-raw '{
            "skip" : 0,                          
            "limit" : 100,                      
            "dateFrom" : "2020-02-11",
            "dateTo" : "2020-02-12"
     }'

Sample Response

  • for dropOff sessions
    {
      "total": 1,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "dropOff",
         "isDeveloper": false,
         "tags": {
           "userTags": [
            {
             "value": "newuser",
             "name": "regular"
            }
          ],
          "sessionTags": []
         },
         "noOfMessagesExchanged": 1,
         "noOfTasksExecuted": 0
       }
      ]
    }
  • for Selfservice sessions
    {
      "total": 2,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "selfService",
         "isDeveloper": false,
         "tags": {
           "userTags": [
            {
             "value": "newuser",
             "name": "regular"
            }
           ],
           "sessionTags": []
         },
         "noOfMessagesExchanged": 6,
         "noOfTasksExecuted": 0
        },
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
         "sessionType": "selfService",
         "isDeveloper": false,
         "tags": {
           "userTags": [
             {
              "value": "newuser",
              "name": "regular"
            }
          ],
         "sessionTags": []
         },
         "noOfMessagesExchanged": 8,
         "noOfTasksExecuted": 0
        }
      ]
    }
  • for agent sessions
    {
      "total": 1,
      "moreAvailable": false,
      "sessions": [
       {
         "sessionId": "xxxxaxxexxxaxexdxxxdxxxe",
         "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx",
         "channel": "rtm",
         "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx",
         "start_time": "2021-04-26T11:27:25.977Z",
         "end_time": "2021-04-26T11:27:26.145Z",
         "session_lang": [
           "en"
          ],
    	 "sessionType": "agent",
    	 "isDeveloper": false,
    	 "tags": {
    		"userTags": [],
    		"sessionTags": []
    	 },
    	 "noOfMessagesExchanged": 7,
    	 "noOfTasksExecuted": 2
    	}
      ]
    }