GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Docs
  2. Virtual Assistants
  3. API Guide
  4. 대화 기록 API

대화 기록 API

봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 API는 페이지 매김 기능을 지원합니다. 오프셋/건너뛰기를 제공하고 한 번에 특정 메시지 수를 제한할 수 있습니다. 이 버전은 조만간 사용되지 않을 이전 API의 새로운 버전입니다. 이 수정된 API는 이전 버전에서의 BotKit 또는 상담사 전환 활성화의 한계를 해결합니다.

이 API를 사용하려면 앱은 채팅 기록의 봇 빌더 API 범위가 필요합니다. 또는 봇 분석 아래 채팅 기록의 관리자 API 범위가 필요합니다.

GEThttps://{{host}}/api/public/bot/{{BotID}}/getMessages?userId={{userID}}&skip=10&limit=10

POST API 호출은 검색된 대화 기록의 Session-Id 및 MetaTags를 포함하는 데 사용할 수도 있습니다.

POST
https://{{host}}/api/public/bot/{{BotID}}/getMessageshttps://{{host}}/api/public/getMessages 봇 관리자 콘솔의 경우

매개 변수

매개 변수 설명
BotID(선택 사항) 봇 ID입니다. 봇의 일반 설정 페이지에서 액세스할 수 있습니다.
userId (POST 호출의 GET 호출에 필수) 액세스할 대화 기록을 가진 사용자의 ID입니다. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다.
skip/offset (선택 사항) 건너뛸 메시지 수입니다.
limit(선택 사항) 각 페이지에 표시할 메시지 수입니다.
forward(선택 사항)

부울 값을 true/false로 사용합니다. 검색할 메시지의 방향을 지정합니다.

  • 값이 true이면 대화 기록은 오래된 항목부터 최신 항목까지 순서대로 검색됩니다.
  • 값이 false이면 대화 기록이 가장 최근의 메시지부터 가장 오래된 메시지까지, 즉, 역순으로 검색됩니다
dateFrom(선택 사항) Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 날짜 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01T13:25:58.515Z제공되지 않은 경우, dateTo.에서 7일 뒤로 계산합니다).
dateTo(선택 사항) Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01 T13:26:05.598Z제공되지 않은 경우 dateFrom부터 7일로 계산됨). dateFrom도 제공되지 않았다면 Today로 설정합니다.
channelType(선택 사항) 대화 기록이 필요한 채널의 이름으로, 기본값은 'rtm'입니다. 허용되는 채널 유형은 "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"입니다. 참고 사항: 다중 Webhook 채널 설정의 경우 "ivr"이 첫 번째 Webhook 인스턴스에 대한 대화를 제공합니다. 다른 인스턴스와 관련된 경우, ivrInstID를 지정하면, 이를 다음 형식의 Webhook URL에서 가져올 수 있습니다. {{host_url}}/chatbot/hooks/{{BotId}}/hookInstance/{{ivrInstID}})
msgId(선택 사항) 알고 있는 경우 특정 메시지 ID입니다. 이렇게 하면 요청한 방향에 따라 해당 메시지부터 레코드를 앞으로 또는 뒤로 가져옵니다(아래 참조). 특정 대화만 필요한 경우 제한을 1로 설정합니다
direction(msgId가 지정된 경우 선택 사항)
  • <0 역방향
  • =0 양방향
  • >0 정방향

기본 방향은 정방향입니다.

sessionID(선택 사항) 알려진 경우 특정 세션 ID. 세션 ID를 얻으려면 여기를 참조하세요
tags(선택 사항) 대화를 필터링하는 메타 태그입니다.

참고 사항: dateTodateFrom 사이의 기간은 7일 미만이어야 하며, 그렇지 않으면 오류가 발생합니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/JSON

샘플 요청

curl -X GET \
'https://bots.kore.ai/api/public/bot/{{BotId}}/getMessages?userId=u-XXX-XXX&
channelType=facebook&dateFrom=2019-04-01&dateTo=2019-04-05' \ 
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'

POST 호출에 대한 샘플 요청

curl -X POST \
  https://bots.kore.ai/api/public/getMessages \
  -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	
                                   }
                                  ]	
                       }
           }

샘플 응답

{
    "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": []
            }        }
    ]
}

POST 호출의 샘플 응답:

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

대화 기록 API

봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 API는 페이지 매김 기능을 지원합니다. 오프셋/건너뛰기를 제공하고 한 번에 특정 메시지 수를 제한할 수 있습니다. 이 버전은 조만간 사용되지 않을 이전 API의 새로운 버전입니다. 이 수정된 API는 이전 버전에서의 BotKit 또는 상담사 전환 활성화의 한계를 해결합니다.

이 API를 사용하려면 앱은 채팅 기록의 봇 빌더 API 범위가 필요합니다. 또는 봇 분석 아래 채팅 기록의 관리자 API 범위가 필요합니다.

GEThttps://{{host}}/api/public/bot/{{BotID}}/getMessages?userId={{userID}}&skip=10&limit=10

POST API 호출은 검색된 대화 기록의 Session-Id 및 MetaTags를 포함하는 데 사용할 수도 있습니다.

POST
https://{{host}}/api/public/bot/{{BotID}}/getMessageshttps://{{host}}/api/public/getMessages 봇 관리자 콘솔의 경우

매개 변수

매개 변수 설명
BotID(선택 사항) 봇 ID입니다. 봇의 일반 설정 페이지에서 액세스할 수 있습니다.
userId (POST 호출의 GET 호출에 필수) 액세스할 대화 기록을 가진 사용자의 ID입니다. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다.
skip/offset (선택 사항) 건너뛸 메시지 수입니다.
limit(선택 사항) 각 페이지에 표시할 메시지 수입니다.
forward(선택 사항)

부울 값을 true/false로 사용합니다. 검색할 메시지의 방향을 지정합니다.

  • 값이 true이면 대화 기록은 오래된 항목부터 최신 항목까지 순서대로 검색됩니다.
  • 값이 false이면 대화 기록이 가장 최근의 메시지부터 가장 오래된 메시지까지, 즉, 역순으로 검색됩니다
dateFrom(선택 사항) Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 날짜 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01T13:25:58.515Z제공되지 않은 경우, dateTo.에서 7일 뒤로 계산합니다).
dateTo(선택 사항) Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01 T13:26:05.598Z제공되지 않은 경우 dateFrom부터 7일로 계산됨). dateFrom도 제공되지 않았다면 Today로 설정합니다.
channelType(선택 사항) 대화 기록이 필요한 채널의 이름으로, 기본값은 'rtm'입니다. 허용되는 채널 유형은 "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"입니다. 참고 사항: 다중 Webhook 채널 설정의 경우 "ivr"이 첫 번째 Webhook 인스턴스에 대한 대화를 제공합니다. 다른 인스턴스와 관련된 경우, ivrInstID를 지정하면, 이를 다음 형식의 Webhook URL에서 가져올 수 있습니다. {{host_url}}/chatbot/hooks/{{BotId}}/hookInstance/{{ivrInstID}})
msgId(선택 사항) 알고 있는 경우 특정 메시지 ID입니다. 이렇게 하면 요청한 방향에 따라 해당 메시지부터 레코드를 앞으로 또는 뒤로 가져옵니다(아래 참조). 특정 대화만 필요한 경우 제한을 1로 설정합니다
direction(msgId가 지정된 경우 선택 사항)
  • <0 역방향
  • =0 양방향
  • >0 정방향

기본 방향은 정방향입니다.

sessionID(선택 사항) 알려진 경우 특정 세션 ID. 세션 ID를 얻으려면 여기를 참조하세요
tags(선택 사항) 대화를 필터링하는 메타 태그입니다.

참고 사항: dateTodateFrom 사이의 기간은 7일 미만이어야 하며, 그렇지 않으면 오류가 발생합니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/JSON

샘플 요청

curl -X GET \
'https://bots.kore.ai/api/public/bot/{{BotId}}/getMessages?userId=u-XXX-XXX&
channelType=facebook&dateFrom=2019-04-01&dateTo=2019-04-05' \ 
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'

POST 호출에 대한 샘플 요청

curl -X POST \
  https://bots.kore.ai/api/public/getMessages \
  -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	
                                   }
                                  ]	
                       }
           }

샘플 응답

{
    "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": []
            }        }
    ]
}

POST 호출의 샘플 응답:

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