帮你快速理解、总结文档立即下载

查询会话空间详情

最近更新时间:2026-09-24 01:08:55
我的收藏

1. 接口描述

接口请求域名: ags.tencentcloudapi.com 。

查询会话空间详情。
查询指定会话空间的详细信息,查询成功后返回会话空间的名称、描述、状态、所属地域及创建时间等信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeSessionSpace。
Version 是 String 公共参数,本接口取值:2025-09-20。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。
SpaceId 是 String

需要查询的会话空间唯一标识。

入参限制:必填,不能为空。

可通过 CreateSessionSpace 或 DescribeSessionSpaces 获取,不应自行构造。


示例值:space-198577ac-324e-4e1b-bfda-f75a2365c9df

3. 输出参数

参数名称 类型 描述
SessionSpace SessionSpaceInfo

查询到的会话空间信息。

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指定会话空间详情

根据会话空间 ID 查询生产客服会话空间的详细信息。

输入示例

POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSessionSpace
<公共请求参数>

{
    "SpaceId": "space-198577ac-324e-4e1b-bfda-f75a2365c9df"
}

输出示例

{
    "Response": {
        "SessionSpace": {
            "CreateTime": "2026-08-17T03:35:11.868Z",
            "Default": false,
            "Description": "Stores sessions for the production customer service application.",
            "Name": "Customer Service Production Space",
            "SpaceId": "space-198577ac-324e-4e1b-bfda-f75a2365c9df",
            "Status": "Active",
            "UpdateTime": "2026-08-17T03:35:11.868Z"
        },
        "RequestId": "7764a908-369a-4bab-8ffb-6446c86b54d6"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError.InternalError InternalError.InternalError
InvalidParameter.InvalidParameter InvalidParameter.InvalidParameter
ResourceNotFound.SessionSpaceNotExist 指定的会话空间不存在,或不属于当前应用及地域。