봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 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 봇 관리자 콘솔의 경우

매개 변수

참고 사항: 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"
               }
             ]
 }

ボットとユーザーの間で交わされた会話メッセージを、逆の時系列で取得します。このAPIはページネーションに対応しています。オフセット/スキップを行ったり、一度に特定の数のメッセージを取得する制限を設けたりすることができます。これは、まもなく廃止予定の旧APIの新しいバージョンです。この改訂版のAPIは、旧バージョンのBotKitやエージェントへの転送を有効にする際の制限に対応しています。

このAPIを使用するために、アプリは [チャット履歴] にあるボットビルダーのAPIスコープを必要とします。あるいは、[ボット分析] にある [チャット履歴] の管理者のAPIスコープを必要とします。

GEThttps://{{host}}/api/public/bot/{{BotID}}/getMessages?userId={{userID}}&skip=10&limit=10 取得した会話履歴にSession-IdやMetaTagを含める場合に、POST APIコールを使用することもできます。POST https://{{host}}/api/public/bot/{{BotID}}/getMessagesおよびhttps://{{host}}/api/public/getMessagesをボット管理者コンソールに対して

パラメータ

注意：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" (または) "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": 「ありがとうございます！Koreアシスタントのアカウントにアクセスできるようになりました。ご心配はいりません。あなたから何かするように言われない限り、アカウントにアクセスすることはありません。」}, "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" } ] }

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.

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

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

Parameters

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

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}}'

Sample Request for POST call

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	
                                   }
                                  ]	
                       }
           }

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",
                  "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"
               }
             ]
 }