1. 接口描述
接口请求域名： vrs.tencentcloudapi.com 。
本接口服务对提交音频进行声音复刻任务创建接口，异步返回复刻结果。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 公共参数 中签名方法v3。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateVRSTask。 |
| Version | 是 | String | 公共参数，本接口取值：2020-08-24。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SessionId | 是 | String | 唯一请求 ID |
| VoiceName | 是 | String | 音色名称 |
| VoiceGender | 是 | Integer | 音色性别: 1-male 2-female |
| VoiceLanguage | 是 | Integer | 语言类型： 1-中文 |
| AudioIdList.N | 是 | Array of String | 音频ID集合 |
| SampleRate | 否 | Integer | 音频采样率： 16000：16k |
| Codec | 否 | String | 音频格式，音频类型(wav,mp3,aac,m4a) |
| CallbackUrl | 否 | String | 回调 URL，用户自行搭建的用于接收结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。 回调采用POST请求方式，Content-Type为application/json，回调数据格式如下:{"TaskId":"xxxxxxxxxxxxxx","Status":2,"StatusStr":"success","VoiceType":xxxxx,"ErrorMsg":""} |
| ModelType | 否 | Integer | 模型类型 1:在线 2:离线 默认为1 |
| TaskType | 否 | Integer | 复刻类型。 0 - 轻量版声音复刻（默认）。 |
| VPRAudioId | 否 | String | 校验音频ID。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CreateVRSTaskRespData | 创建任务结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 声音复刻任务创建
声音复刻任务创建
输入示例
POST / HTTP/1.1
Host: vrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVRSTask
<公共请求参数>
{
"SessionId": "63f8xxx1897281d556df60b0",
"VoiceName": "小娥",
"SampleRate": 16000,
"VoiceGender": 1,
"VoiceLanguage": 1,
"Codec": "wav",
"CallbackUrl": "http://example.com/callback",
"AudioIdList": [
"63f89bb"
]
}输出示例
{
"Response": {
"RequestId": "63f89bb1897281d556df60b0",
"Data": {
"TaskId": "ce68122c-0ca8-4fa6-99b1-90a28670626b"
}
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.FailAccessDatabase | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.Codec | Codec非法，请参考Codec参数说明。 |
| InvalidParameterValue.SampleRate | SampleRate非法，请参考SampleRate参数说明。 |
| InvalidParameterValue.VoiceGender | 音色性别错误。 |
| InvalidParameterValue.VoiceLanguage | 音色语言错误。 |
| InvalidParameterValue.VoiceName | 音色名称错误。 |
| UnsupportedOperation.VRSQuotaExhausted | 无声音复刻任务配额 |