1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
创建会话空间。
为当前应用在指定地域创建会话空间,创建成功后返回会话空间信息。会话空间用于隔离不同业务场景下的用户、会话、事件及状态数据。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSessionSpace。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。 |
| Name | 是 | String | 会话空间名称,用于标识会话空间的业务用途。 入参限制:必填;去除首尾空白后不能为空;最大长度为 128 个字符。 建议名称包含业务和环境信息,便于识别和管理。 示例值:Customer Service Production Space |
| Description | 否 | String | 会话空间描述,用于补充说明会话空间的业务用途。 入参限制:选填;最大长度为 512 个字符。 未传入时创建为空描述。 示例值:Stores sessions for the production customer service application. |
| Tags.N | 否 | Array of Tag | 创建 SessionSpace 时为资源绑定标签。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SessionSpace | SessionSpaceInfo | 创建成功后的会话空间完整信息。 接口成功时一定返回;接口失败时返回 Error,不会返回该字段。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建生产环境会话空间
为生产环境的客服应用创建独立会话空间,用于隔离会话、事件和用户状态数据。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSessionSpace
<公共请求参数>
{
"Name": "Customer Service Production Space",
"Description": "Stores sessions for the production customer service application."
}
输出示例
{
"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": "5bf9b472-8e6d-453f-ab2f-f2b7c332fc5c"
}
}
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 |