1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
调用该接口,查询数字人直播间信息列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLiveAvatarRooms。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| RoomId | 否 | String | 数字人直播间 ID。 示例值:10002 |
| Name | 否 | String | 数字人直播间名称。 示例值:live |
| PageIndex | 否 | Integer | 分页查询的页数。 示例值:1 |
| PageSize | 否 | Integer | 分页查询的每页个数。 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InfoList | Array of AvatarRoomInfo | 数字人直播间信息列表。 |
| LimitCreateNum | Integer | 限制可创建的数字人直播间总数。 示例值:100 |
| TotalNum | Integer | 当前数字人直播间总个数。 示例值:3 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host:live.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: DescribeLiveAvatarRooms
<公共请求参数>
{
"PageIndex": 1,
"PageSize": 10
}
输出示例
{
"Response": {
"InfoList": [
{
"AvatarKey": "9a7a2894ebd44ad3877ce98caac9a7cc",
"CreateTime": "2025-07-02T07:19:08Z",
"RoomId": "10002",
"Name": "测试直播间",
"TimbreKey": "male_1",
"ToUrl": "rtmp://5000.livepush.myqcloud.com/live/testavatar?txSecret=9f84eb128c7414074e9b14651b6d03e0&txTime=68629cf1",
"UpdateTime": "2025-07-02T07:19:08Z"
}
],
"LimitCreateNum": 100,
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
"TotalNum": 1
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。