1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
查询事件列表。
查询指定会话的事件流,支持按作者和起始时间筛选。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEvents。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。 |
| SpaceId | 是 | String | 会话所属空间 ID。 示例值:space-198577ac-324e-4e1b-bfda-f75a2365c9df |
| UserId | 是 | String | 用户 ID。可通过调用方业务系统接口获取。 示例值:customer-32874234 |
| SessionId | 是 | String | 会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。 示例值:9e527749-0313-4871-85dc-4b9055561c06 |
| Author | 否 | String | 事件作者。取值示例:user、assistant、tool。 示例值:assistant |
| AfterTimestamp | 否 | String | 起始时间,仅返回该时间之后的事件,使用 RFC3339 格式,最大长度 64 字符。 示例值:2026-07-07T11:30:01.53Z |
| Offset | 否 | Integer | 分页偏移量,默认为 0。 示例值:0 |
| Limit | 否 | Integer | 返回数量,默认为 50,最大值为 200。 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | Array of EventInfo | 事件列表。 |
| TotalCount | Integer | 符合条件的事件总数。 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询事件列表
查询指定会话空间下的指定会话事件列表。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEvents
<公共请求参数>
{
"SpaceId": "space-198577ac-324e-4e1b-bfda-f75a2365c9df",
"UserId": "customer-32874234",
"SessionId": "9e527749-0313-4871-85dc-4b9055561c06"
}
输出示例
{
"Response": {
"Events": [
{
"Actions": {
"StateDelta": "{\"currentTask\":\"refund_status_lookup\",\"user:lastChannel\":\"web\"}"
},
"Author": "user",
"Content": {
"Parts": [
{
"FunctionCall": "null",
"FunctionResponse": "null",
"Text": "Please help me check the refund status for my order."
}
],
"Role": "user"
},
"EventId": "event-refund-status-20260817-0001",
"Extensions": "{\"Source\":\"customer-portal\"}",
"InvocationId": "invocation-order-assistance-20260817-0001",
"Metadata": "{\"Channel\":\"web\",\"TurnComplete\":true}",
"Timestamp": "2026-08-17T09:28:54.216Z"
}
],
"TotalCount": 1,
"RequestId": "909e1ece-2cea-426f-ad67-d98b0393c676"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InternalError | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| ResourceNotFound.SessionNotExist | Session 不存在,或 UserId 无权限访问该 Session |
| ResourceNotFound.SessionSpaceNotExist | 指定的会话空间不存在,或不属于当前应用及地域。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |