1. 接口描述
接口请求域名： ags.tencentcloudapi.com 。
查询会话。
查询指定会话的信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSession。 |
| 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-32874915 |
| SessionId | 是 | String | 会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。 示例值：session-order-assistance-20260817-0001 |
| NumRecentEvents | 否 | Integer | 返回最近事件数量，默认为 0，最大值为 200。 示例值：10 |
| AfterTimestamp | 否 | String | 事件起始时间，RFC3339 格式，最大长度 64 字符。 示例值：2026-06-30T00:00:00Z |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Session | SessionInfo | 会话信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询指定会话详情
根据会话空间 ID、用户 ID 和会话 ID，查询指定会话的详细信息。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSession
<公共请求参数>
{
"SpaceId": "space-198577ac-324e-4e1b-bfda-f75a2365c9df",
"UserId": "customer-32874915",
"SessionId": "session-order-assistance-20260817-0001"
}输出示例
{
"Response": {
"Session": {
"CreateTime": "2026-08-17T08:15:18Z",
"EventCount": 0,
"SessionId": "session-order-assistance-20260817-0001",
"SpaceId": "space-198577ac-324e-4e1b-bfda-f75a2365c9df",
"Title": "Order refund assistance",
"UpdateTime": "2026-08-17T08:15:18Z",
"UserId": "customer-32874915"
},
"RequestId": "82581530-d12d-40b2-8e11-9f3c308367c7"
}
}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.Session | ResourceNotFound.Session |
| ResourceNotFound.SessionSpaceNotExist | 指定的会话空间不存在，或不属于当前应用及地域。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |
