1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
调用该接口,用于触发话术播报生成,并返回音频播报URL。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GenerateLiveAvatarScriptBroadcast。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| RoomId | 是 | String | 数字人直播间 ID。 示例值:10020 |
| ScriptId | 是 | String | 话术 ID。 示例值:20013 |
| TimbreKey | 否 | String | 音色 Key。如果不填,则默认使用数字人直播已经保存的音色。 示例值:14356 |
| SpeechSpeed | 否 | Float | 语速(1.0为正常语速,范围[0.6-2.5],值为0.6时播报语速最慢,值为2.5时播报语速最快。不传默认使用数字人直播间已设置的语速。 示例值:1.0 |
| SpeechVolume | 否 | Integer | 音量大小,范围[0,10],对应音量大小。默认为5,代表正常音量,值越大音量越高。不传使用数字人直播已设置的音量。 示例值:5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PreviewAudioUrl | String | 音频播报 URL。 示例值:http://audio.com/preview/audio.mp3 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host:live.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: GenerateLiveAvatarScriptBroadcast
<公共请求参数>
{
"RoomId": "10001",
"ScriptId": "20003"
}
输出示例
{
"Response": {
"PreviewAudioUrl": "http://audio.com/avatr/audio.mp3",
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。