봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 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}}/getMessages 및 https://{{host}}/api/public/getMessages 봇 관리자 콘솔의 경우
매개 변수
| 매개 변수 | 설명 |
|---|---|
| BotID(선택 사항) | 봇 ID입니다. 봇의 일반 설정 페이지에서 액세스할 수 있습니다. |
| userId (POST 호출의 GET 호출에 필수) | 액세스할 대화 기록을 가진 사용자의 ID입니다. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다. |
| skip/offset (선택 사항) | 건너뛸 메시지 수입니다. |
| limit(선택 사항) | 각 페이지에 표시할 메시지 수입니다. |
| forward(선택 사항) |
부울 값을 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가 지정된 경우 선택 사항) |
기본 방향은 정방향입니다. |
| sessionID(선택 사항) | 알려진 경우 특정 세션 ID. 세션 ID를 얻으려면 여기를 참조하세요 |
| tags(선택 사항) | 대화를 필터링하는 메타 태그입니다. |
참고 사항: dateTo와 dateFrom 사이의 기간은 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"
}
]
}