봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 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"
               }
             ]
 }

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

ボットとユーザーの間で交わされた会話メッセージを、逆の時系列で取得します。この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(誤)をとります。取得するメッセージの方向を指定します。

  • この値が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が指定されている場合は任意)
  • <0 逆
  • =0 双方向
  • >0 前方

デフォルトの方向は前方です。

sessionId(任意) 特定のSession-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" (または) "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" } ] }

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

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

Parameter Description
BotID (optional) Bot ID. You can access it from the bot’s General Settings page.
userId (mandatory for GET call

optional for POST call)

The ID of the user whose conversation history to access. Can be 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.
forward (optional) Takes boolean values true/false. Specifies the direction of the messages to be retrieved.

  • If the value is true, then the conversation history is retrieved in the order old to the most recent one.
  • If the value is false, then the conversation history is retrieved in the reverse order i.e, the most recent to the oldest message
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 dateTo.
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.
channelType (optional) Name of the channel of whose conversation history is needed, default is ‘rtm’ .

Accepted channel types are “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”.

Note: In case of multi-webhook channel configuration, “ivr” will give the conversations for the first WebHook instance. For those related to other instance, specify the ivrInstID, you can get it from the WebHook URL which is of the form: {{host_url}}/chatbot/hooks/{{BotId}}/hookInstance/{{ivrInstID}})

msgId (optional) A specific Message-Id if known. This would fetch the records starting from that message either forward or backward depending upon the direction (see below) requested.
In case only the specific conversation is required, set the limit to 1
direction (optional when msgId is given)
  • <0 reverse
  • =0 bidirectional
  • >0 forward

Default direction is forward.

sessionId (optional) A specific Session-Id if known. Refer here to obtain the session id
tags (optional) Meta tags to filter the conversations.

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

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed