ボットとユーザーの間で交わされた会話メッセージを、逆の時系列で取得します。この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をボット管理者コンソールに対して
パラメータ
| パラメータ | 説明 |
|---|---|
| BotID（オプション） | ボットID。ボットの [一般設定] ページからアクセスすることができます。 |
| userId（GETの場合は必須、POSTの場合は任意） | 会話履歴にアクセスするユーザーのIDです。ユーザーのメールIDまたは企業に割り当てられた一意のIDになります。 |
| skip/offset（任意） | スキップするメッセージ数です。 |
| limit（任意） | 各ページに表示されるメッセージ数です。 |
| forward（任意） | ブール値のTrue（正）/False（誤）をとります。取得するメッセージの方向を指定します。
|
| dateFrom（任意） | 日付のフォーマットはyyyy-mm-dd（または）yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01（または）2019-04-01T13:25:58.515Zです 指定されていない場合は、dateToから7日遅れで計算されます。 |
| dateTo（任意） | 日付のフォーマットはyyyy-mm-dd（または）yyyy-mm-ddThh:mm:ss.msZ eg: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（任意） | 特定のMessage-Id（あれば）です。これにより、リクエストされた方向（下記参照）に応じて、そのメッセージから始まるレコードを前方または後方に取得することができます。特定の会話のみを必要とする場合は、制限を1に設定します。 |
| direction（msgIdが指定されている場合は任意） |
デフォルトの方向は前方です。 |
| sessionId（任意） | 特定のSession-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" (または) "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" } ] }