1. 接口描述
接口请求域名: adp.tencentcloudapi.com 。
获取会话历史消息
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeConversationMessageList。 |
| Version | 是 | String | 公共参数,本接口取值:2026-05-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ConversationId | 是 | String | 会话 ID 示例值:4abd149a-e010-4a6c-bc52-1132658f149d |
| Type | 是 | Integer | 会话类型 枚举值: 0-CONVERSATION_TYPE_UNSPECIFIED(未指定;列表查询时表示全部), 1-CONVERSATION_TYPE_VISITOR(访客端体验), 2-CONVERSATION_TYPE_EVALUATION(评测), 5-CONVERSATION_TYPE_API(API 接入), 10-CONVERSATION_TYPE_WORKFLOW(工作流调试), 20-CONVERSATION_TYPE_SHARE(分享链接) 示例值:2 |
| AppKey | 否 | String | Type=CONVERSATION_TYPE_API 时必填,应用密钥 示例值:1 |
| Limit | 否 | Integer | 返回记录总数量,默认 10,最大 50。向前或向后查询时,不包含record_id指定记录的消息,查询方向中心向前后查询时,包含record_id指定的记录消息,返回记录数量为前后各limit / 2条,向上取整 示例值:50 |
| LoginSubAccountUin | 否 | String | 子用户Uin 示例值:700001046587 |
| LoginUin | 否 | String | 主用户Uin 示例值:700001046587 |
| RecordId | 否 | String | 查询锚点记录 ID 示例值:msg_db8387b0-8b9f-49c9-9d05-253c7e9748a6_1 |
| RecordQueryDirection | 否 | Integer | 相对于 record_id 的查询方向 枚举值: 0-RECORD_QUERY_DIRECTION_UNSPECIFIED(未指定,兼容旧逻辑,默认向前查询), 1-RECORD_QUERY_DIRECTION_BACKWARD(从 record_id 向前查询更早的消息), 2-RECORD_QUERY_DIRECTION_FORWARD(从 record_id 向后查询更新的消息), 3-RECORD_QUERY_DIRECTION_BIDIRECTIONAL(以 record_id 为中心,同时向前后查询) 示例值:1 |
| ShareCode | 否 | String | Type=CONVERSATION_TYPE_SHARE 时必填,分享码 示例值:1 |
| UserId | 否 | String | Type=CONVERSATION_TYPE_API 时必填,访客ID 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FirstRecordId | String | 第一个记录 ID 示例值:req_2f90efac-e51f-4c6e-b1b4-2e1234c1319d |
| HasMoreAfter | Boolean | 更新消息方向是否还有更多 示例值:false |
| HasMoreBefore | Boolean | 更早消息方向是否还有更多 示例值:false |
| LastRecordId | String | 最后一个记录 ID 示例值:rcd_db8387b0-8b9f-49c9-9d05-253c7e9748a6 |
| MessageList | Array of ConversationMessage | 消息列表 |
| Messages | Array of ConversationMessage | 消息列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 ClawAgent模式会话消息查询
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConversationMessageList
<公共请求参数>
{
"ConversationId": "4abd149a-e010-4a6c-bc52-1132658f149d",
"Type": 2,
"AppKey": "1",
"RecordId": "msg_db8387b0-8b9f-49c9-9d05-253c7e9748a6_1",
"RecordQueryDirection": 1,
"ShareCode": "1",
"UserId": "1",
"Limit": 50,
"LoginSubAccountUin": "700001046587",
"LoginUin": "700001046587"
}
输出示例
{
"Response": {
"FirstRecordId": "req_2f90efac-e51f-4c6e-b1b4-2e1234c1319d",
"HasMoreAfter": false,
"HasMoreBefore": false,
"LastRecordId": "rcd_db8387b0-8b9f-49c9-9d05-253c7e9748a6",
"Messages": [
{
"Contents": [
{
"CustomParams": [],
"OptionCards": [],
"QuoteInfos": [],
"References": [],
"Tasks": [],
"Text": "你好",
"Type": "text"
}
],
"ConversationId": "4abd149a-e010-4a6c-bc52-1132658f149d",
"Icon": "",
"MessageId": "user_2f90efac-e51f-4c6e-b1b4-2e1234c1319d_content",
"Name": "question",
"RecordId": "req_2f90efac-e51f-4c6e-b1b4-2e1234c1319d",
"Role": "user",
"Status": "success",
"StatusDesc": "回复完成",
"Title": "用户提问",
"Type": "question"
}
],
"RequestId": "59eb048d-7ad3-486b-85e5-e44f38178bba"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。