Release Notes
Product Announcement
Domain name for API request: lke.intl.tencentcloudapi.com.
This API is used to obtain chat history based on the session ID (only historical session data within the past 180 days will be retained).
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetMsgRecord. |
| Version | Yes | String | Common Params. The value used for this API: 2023-11-30. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta. |
| Type | Yes | Integer | Type. |
| Count | Yes | Integer | Quantity. |
| SessionId | Yes | String | Session ID. |
| BotAppKey | No | String | Application AppKey. When Type=5 [API Visitor], this field is required. How to obtain it: 1. After the application is released, obtain it at [Application Page]-[Release Management]-[Call Information]-[API Management]. 2. Refer to item 2 in https://www.tencentcloud.com/document/product/1759/109469?from_cn_redirect=1. |
| Scene | No | Integer | Scenario, experience: 1; formal: 2. |
| LastRecordId | No | String | Last record ID. Retrieve messages in reverse order. You can only select either MidRecordId or LastRecordId. |
| MidRecordId | No | String | If this value is input, it means pulling a total of count message records before and after the record ID. You can only select either MidRecordId or LastRecordId. |
| Parameter Name | Type | Description |
|---|---|---|
| Records | Array of MsgRecord | Session record. |
| SessionDisassociatedTimestamp | String | The time when session cleared associated context, in milliseconds. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: lke.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetMsgRecord
<Common request parameters>
{
"Type": 2,
"Count": 15,
"SessionId": "your session id",
"LastRecordId": ""
}{
"Response": {
"Records": [
{
Content": "User query"
"RecordId": "9415678e-1ac5-4987-ac86-d8f9c001c93c",
"RelatedRecordId": "H9I_20241107_201302_963_b8oJXfpL",
"IsFromSelf": true,
FromName": "User A"
"FromAvatar": "https://qidian-qbot-xxxxxx.cos.ap-guangzhou.myqcloud.com/public/174434244193038090240/1801166482343244637056/image/jNVJvoXsTsBzo2324324121HZdgd-1816016475183120384.png",
"Timestamp": "1730981587",
"HasRead": true,
"Score": 1,
"CanRating": true,
"Type": 1,
"References": [
{
"Id": "1856329177919861888",
"Url": "",
"Type": 2,
Name": "My document"
"DocId": "25395"
}
],
"Reasons": [
"Reason information" ],
"IsLlmGenerated": true,
"ImageUrls": [
""
]
}
],
"RequestId": "47d378d4-49b5-454b-a381-088e7015f411"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback