1. 接口描述
接口请求域名: vrs.tencentcloudapi.com 。
本接口用于检测音频的环境和音频质量。
对于一句话声音复刻,音频时长需大于3s,小于15s,文件大小不能超过2MB,音频需为单声道,位深为16bit。建议格式:wav、单声道、采样率48kHz或24kHz
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 公共参数 中签名方法v3。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DetectEnvAndSoundQuality。 |
Version | 是 | String | 公共参数,本接口取值:2020-08-24。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
TextId | 是 | String | 标注文本信息 ID |
AudioData | 是 | String | 语音数据 要使用base64编码(采用python语言时注意读取文件时需要转成base64字符串编码,例如:str(base64.b64encode(open("input.aac", mode="rb").read()), encoding='utf-8') )。 |
TypeId | 是 | Integer | 1:环境检测 2:音质检测 |
Codec | 否 | String | 音频格式,音频类型(wav,mp3,aac,m4a) |
SampleRate | 否 | Integer | 音频采样率。 16000:16k(默认); 24000:24k(仅一句话声音复刻支持); 48000:48k(仅一句话声音复刻支持)。 |
TaskType | 否 | Integer | 复刻类型。 0 - 轻量版声音复刻(默认); 5 - 一句话声音复刻。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DetectionEnvAndSoundQualityRespData | 检测结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 音质检测
音质检测
输入示例
POST / HTTP/1.1
Host: vrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectionEnvAndSoundQuality
<公共请求参数>
{
"TextId": "00020",
"AudioData": "",
"Codec": "wav",
"TypeId": 2
}
输出示例
{
"Response": {
"Data": {
"AudioId": "abc",
"DetectionCode": 0,
"DetectionMsg": "abc",
"DetectionTip": [
{
"PronAccuracy": 0,
"PronFluency": 0,
"Tag": 0,
"Word": "abc"
}
]
},
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.VoiceEvaluateFailed | 检测失败。 |
FailedOperation.VoiceNotQualified | 音频质量差。 |
InvalidParameterValue.AudioData | 音频数据错误。 |
InvalidParameterValue.AudioDurationExceedsLimit | 音频时长超限,时长不可超过15s |
InvalidParameterValue.Codec | Codec非法,请参考Codec参数说明。 |
InvalidParameterValue.SampleRate | SampleRate非法,请参考SampleRate参数说明。 |