1. 接口描述
接口请求域名： live.tencentcloudapi.com 。
调用该接口，用于启动数字人（包括AIGC数字人）直播间。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：StartLiveAvatarRoom。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| RoomId | 是 | String | 数字人直播间 ID。 示例值：10001 |
| Comment | 是 | String | 目标地址描述。 示例值：推往视频号 |
| ToUrl | 是 | String | 推流目标地址。 示例值：rtmp://5000.livepush.com/live/stream |
| Operator | 否 | String | 操作者。 示例值：admin |
| RoomType | 否 | String | 房间类型。AIGC：AIGC形象房间；PRESET：预设形象房间 枚举值：
示例值：AIGC |
| SessionProtocol | 否 | String | 交互模式下的协议，支持rtmp和trtc，默认是rtmp 示例值：trtc |
| TrtcSdkAppId | 否 | String | 使用trtc协议时，在trtc的appid 示例值：1600098322 |
| TrtcUserSig | 否 | String | 进入房间时需要用UserSign来校验权限 示例值：eJwtzE8LgjAcxvH3smth29pfoUNdKvEiBhV0KZz1o6y5qQXRe2lxfzheeNNmkedcahGNEIo-F-Q2HuDZTQM2GSKS6EHKovrkdroUAxERhjraaU9sW8LDgTnHNOQq1gepnUinJtJCDejiH86WdWpPN02Sx6LdHiam9T7tSvcUNWV2dZFVnYS3X6dZTP0QKnjTIx |
| TrtcRoomId | 否 | String | 要进入的房间 示例值：79059 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host:live.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: StartLiveAvatarRoom
<公共请求参数>
{
"RoomId": "10001",
"Comment": "wx",
"ToUrl": "rtmp://5000.livepush.com/live/stream"
}输出示例
{
"Response": {
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e"
}
}示例2 交互模式测试
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartLiveAvatarRoom
<公共请求参数>
{
"RoomId": "2147485667",
"Comment": "推往trtc",
"ToUrl": "rtmp://5000.livepush.myqcloud.com/live/qloud_push_test_test_50?txSecret=40e467c0e787205b7086c7fa9db0e3fd&txTime=6ba1006a",
"SessionProtocol": "trtc",
"TrtcSdkAppId": "1600098322",
"TrtcUserSig": "eJwtzE8LgjAcxvH3smth29pfoUNdKvEiBhV0KZz1o6y5qQXRe2*lx*fzheeNNmkedcahGNEIo-F-Q2HuDZTQM2GSKS6EHKovrkdroUAxERhjraaU9sW8LDgTnHNOQ*q1gepnUinJtJCDejiH86WdW*pPN02Sx6LdHiam9T7tSvcUNWV2dZFVnY*S3X6dZTP0*QKnjTIx",
"TrtcRoomId": "79059"
}输出示例
{
"Response": {
"RequestId": "79da8b98-8e57-4343-aba0-bc8f614ba8ba"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
