1. 接口描述
接口请求域名： adp.tencentcloudapi.com 。
获取会话列表
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConversationList。 |
| Version | 是 | String | 公共参数，本接口取值：2026-05-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | Integer | 会话类型，传 CONVERSATION_TYPE_UNSPECIFIED 表示全部 枚举值: 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 |
| AppId | 否 | String | 应用 ID 示例值：2056226819910862592 |
| AppKey | 否 | String | Type=CONVERSATION_TYPE_API 时必填，应用密钥 示例值：0 |
| Keyword | 否 | String | 关键词 示例值：0 |
| Limit | 否 | Integer | 限制数目（整型），配合Offset使用 示例值：1 |
| LoginSubAccountUin | 否 | String | 子账户Uin 示例值：700000963993 |
| LoginUin | 否 | String | 主账户Uin 示例值：700000963993 |
| Offset | 否 | Integer | 偏移量（整型），配合Limit使用，从0开始 示例值：20 |
| ShareCode | 否 | String | Type=CONVERSATION_TYPE_SHARE 时必填，分享码 示例值：0 |
| UserId | 否 | String | Type=CONVERSATION_TYPE_API 时必填，访客ID 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConversationList | Array of Conversation | 会话列表 |
| Conversations | Array of Conversation | 会话列表 |
| TotalCount | String | 总数 示例值：4 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeConversationList
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConversationList
<公共请求参数>
{
"Type": 2,
"AppId": "2056226819910862592"
}输出示例
{
"Response": {
"ConversationList": [
{
"AppId": "2056226819910862592",
"ConversationId": "1038a37e-93b6-4f1f-b4cc-a73ce87a1c39",
"CreateTime": "2026-05-18T21:58:38+08:00",
"Type": 2,
"UpdateTime": "2026-05-19T16:12:32+08:00"
}
],
"TotalCount": "4",
"RequestId": "9b13a60e-39cc-4390-8a09-f6741b2c73f1"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
