1. 接口描述
接口请求域名： live.tencentcloudapi.com 。
调用该接口，查询数字人直播间信息列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAvatarEditingLive。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ChannelId | 是 | String | 通道ID，通常是待编辑的直播流的源ID 示例值：vidu_s2_editing_test_2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ChannelId | String | 通道ID，通常是待编辑的直播流的源ID 示例值：vidu_s2_editing_test_2 |
| LiveId | String | 实时编辑会话ID 示例值：1008224608114978816 |
| Status | String | 实时编辑会话的状态 枚举值：
示例值：on_live |
| Phase | String | 内部模块会话状态 示例值：active |
| CallMode | String | 输出Mode 示例值：video |
| CreatedAt | String | 创建时间 示例值：1792050995 |
| StartTime | String | 开播时刻 示例值：1792050998 |
| EndTime | String | 结束时间，如果还没结束则该值为0 示例值：0 |
| TraceId | String | 跟踪ID，用于查日志 示例值：82e7b0074f492b41ca0152ae7e608ef3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实时会话状态
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAvatarEditingLive
<公共请求参数>
{
"ChannelId": "vidu_s2_editing_test_2"
}输出示例
{
"Response": {
"CallMode": "video",
"ChannelId": "vidu_s2_editing_test_2",
"CreatedAt": "1792050995",
"EndTime": "0",
"LiveId": "1008224608114978816",
"Phase": "active",
"StartTime": "1792050998",
"Status": "on_live",
"TraceId": "82e7b0074f492b41ca0152ae7e608ef3",
"RequestId": "e568960c-4894-4670-9e30-e3242f0ee5da"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
