1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
调用该接口,查询数字人直播间信息列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLiveAvatarCloneFigureList。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| TaskId | 否 | String | 待查询的克隆形象的TaskId 示例值:7501606042561581056 |
| Status | 否 | String | 根据状态查询克隆形象 枚举值:
示例值:SUCCESS |
| Limit | 否 | String | 期望返回克隆形象的个数(最多20个) 示例值:10 |
| Offset | 否 | String | 期望返回克隆形象的起始偏移位置(默认为0) 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CloneFigureList | Array of LiveAvatarCloneFigureInfo | 克隆形象列表 |
| TotalCount | Integer | 克隆形象总个数 单位:个 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据TaskId查询克隆形象列表
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveAvatarCloneFigureList
<公共请求参数>
{
"TaskId": "7501606042561581056"
}
输出示例
{
"Response": {
"CloneFigureList": [
{
"AvatarKey": "966163fdc71b4d31b031ae03ffe5587b",
"CreateTime": "2026-09-04 19:44:13",
"EstimatedCompleteTime": "",
"ExpireTime": "",
"FailReason": "",
"FigureImg": "",
"FigureName": "图生测试形象",
"Gender": "UNKNOWN",
"IsExpired": false,
"MaterialUrl": "https://wsh-test-1303333058.cos.ap-guangzhou.myqcloud.com/%E6%95%B0%E5%AD%97%E4%BA%BA%E6%B5%8B%E8%AF%95/%E6%95%B0%E5%AD%97%E4%BA%BA%E5%A5%B3%E4%B8%BB%E6%92%AD.png",
"PhotoVersion": 1,
"Progress": 100,
"RenewStatus": "UNKNOWN",
"SceneType": "PHOTO",
"Status": "SUCCESS",
"TaskId": "7501606042561581056",
"UpdateTime": "2026-09-04 19:49:04"
}
],
"TotalCount": 1,
"RequestId": "dc5e6604-e6e9-427e-ae39-57ef6f903b8b"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。