봇과 사용자 간의 대화 메시지를 시간 역순으로 가져옵니다. 이 API는 페이지 매김 기능을 지원합니다. 오프셋/건너뛰기를 제공하고 한 번에 특정 메시지 수를 제한할 수 있습니다.
참고 사항: 이 API는 봇에 대해 BotKit SDK 또는 상담사 전환이 활성화된 경우에만 액세스할 수 있습니다. 이 API는 곧 사용할 수 없으며, 대신 이 API를 사용하세요. 대화 기록 API.
GET /api/botsdk/stream/{{stream_id}}/getMessages?userId={{user_id}}&skip={{numberOfMessagesToBeSkipped}}&limit={{numberOfMessagesTobeFetched}}
| 매개 변수 | 설명 |
|---|---|
| stream_id | 봇 ID입니다. 봇의 일반 설정 페이지에서 액세스할 수 있습니다. |
| user_id | 액세스할 대화 기록을 가진 사용자의 ID입니다. |
| skip | 건너뛸 메시지 수입니다. |
| limit | 각 페이지에 표시할 메시지 수입니다. |
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
application/JSON
curl -X GET \ 'https://bots.kore.ai/api/botsdk/stream/{{stream_id}}/getMessages?userId= u-XXX-XXX' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN'
{
"total":1,
"moreAvailable":false,
"messages":[
{
"_id":"ms-eb23XXXXX7075f28b",
"type":"outgoing",
"status":"pending",
"createdBy":"u-6dd4XXXXXXXXXf-1f75b054f6dc",
"botId":"st-db4c106XXXXXXXXX05-350518802fd6",
"orgId":"o-232b5XXXXXXXded-d8d5131aa62c",
"lmodifiedOn":"2017-09-28T13:18:04.395Z",
"createdOn":"2017-09-28T13:18:04.401Z",
"components":[
{
"_id":"cp-905c82aXXXXXXX360499c39a",
"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":[
]
}
],
"channels":[
{
"to":"u-6dd4XXXXXXXXX75b054f6dc",
"type":"rtm",
"requestId":"ms-dfabXXXXXXX7704b79b21"
}
]
}
]
}
ボットとユーザーの間で交わされた会話メッセージを、逆の時系列で取得します。このAPIはページネーションに対応しています。オフセット/スキップを行ったり、一度に特定の数のメッセージを取得する制限を設けたりすることができます。注意：このAPIは現在、ボットに対してBotKit SDKまたはエージェントへの転送が有効になっている場合にのみアクセス可能です。このAPIは近日中に廃止される予定ですので、代わりに会話履歴APIを使用してください。GET /api/botsdk/stream/{{stream_id}}/getMessages?userId={{user_id}}&skip={{numberOfMessagesToBeSkipped}}&limit={{numberOfMessagesTobeFetched}}
| パラメータ | 説明 |
|---|---|
| stream_id | ボットID。ボットの [一般設定] ページからアクセスすることができます。 |
| user_id | 会話履歴にアクセスするユーザーのIDです。 |
| skip | スキップするメッセージ数です。 |
| limit | 各ページに表示されるメッセージ数です。 |
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
application/JSON
curl -X GET \ 'https://bots.kore.ai/api/botsdk/stream/{{stream_id}}/getMessages?userId= u-XXX-XXX' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN'
{ "total":1, "moreAvailable":false, "messages":[ { "_id":"ms-eb23XXXXX7075f28b", "type":"outgoing", "status":"pending", "createdBy":"u-6dd4XXXXXXXXXf-1f75b054f6dc", "botId":"st-db4c106XXXXXXXXX05-350518802fd6", "orgId":"o-232b5XXXXXXXded-d8d5131aa62c", "lmodifiedOn":"2017-09-28T13:18:04.395Z", "createdOn":"2017-09-28T13:18:04.401Z", "components":[ { "_id":"cp-905c82aXXXXXXX360499c39a", "cT":"text", "data":{ "text":"Thanks! Koreアシスタントのアカウントにアクセスできるようになりました。ご心配はいりません。あなたから何かするように言われない限り、アカウントにアクセスすることはありません。」}, "thumbnails":[ ] } ], "channels":[ { "to":"u-6dd4XXXXXXXXX75b054f6dc", "type":"rtm", "requestId":"ms-dfabXXXXXXX7704b79b21" } ] } ] }
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.
Note: This API is currently accessible only if BotKit SDK or Agent Transfer is enabled for a bot.
This API will soon be deprecated, use this API instead: Conversation History API.
Get /api/botsdk/stream/{{stream_id}}/getMessages?userId={{user_id}}&skip={{numberOfMessagesToBeSkipped}}&limit={{numberOfMessagesTobeFetched}}
| Parameter | Description |
|---|---|
| stream_id | Bot ID. You can access it from the bot’s General Settings page. |
| user_id | The ID of the user whose conversation history to access. |
| skip | The number of messages to be skipped. |
| limit | The number of messages to be shown on each page. |
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
application/JSON
curl -X GET \ 'https://bots.kore.ai/api/botsdk/stream/{{stream_id}}/getMessages?userId= u-XXX-XXX' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN'
{
"total":1,
"moreAvailable":false,
"messages":[
{
"_id":"ms-eb23XXXXX7075f28b",
"type":"outgoing",
"status":"pending",
"createdBy":"u-6dd4XXXXXXXXXf-1f75b054f6dc",
"botId":"st-db4c106XXXXXXXXX05-350518802fd6",
"orgId":"o-232b5XXXXXXXded-d8d5131aa62c",
"lmodifiedOn":"2017-09-28T13:18:04.395Z",
"createdOn":"2017-09-28T13:18:04.401Z",
"components":[
{
"_id":"cp-905c82aXXXXXXX360499c39a",
"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":[
]
}
],
"channels":[
{
"to":"u-6dd4XXXXXXXXX75b054f6dc",
"type":"rtm",
"requestId":"ms-dfabXXXXXXX7704b79b21"
}
]
}
]
}