注册接口
功能介绍
用户上传一段录音,并指定voice_name,在系统中注册声音。
约束与限制
- 一个用户最多注册1000个声音。
URI
POST /v1/{project_id}/vcs/voices
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号。获取方法,请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。响应消息头中X-Subject-Token的值即为Token |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
config |
是 |
Object |
配置信息 |
|
data |
是 |
String |
录音数据,使用base64编码,大小不超过6MB。支持wav、mp3、m4a格式,采样率不小于16kHz,时长在5-25秒,支持单、双通道。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
voice_name |
是 |
String |
注册声音的名称,不能以数字、下划线开头。仅包含大、小写英文字母、数字和下划线,且长度不超过20个字符。一个project id下的声音名称不能重复。 |
|
language |
否 |
String |
data中语音数据的语种,取值“chinese”、“english”;默认是chinese。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
trace_id |
String |
服务内部的令牌,可用于在日志中追溯具体流程。 |
|
result |
Object |
注册声音响应,详见表6。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码。 调用成功时无此字段。 |
|
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 调用声音注册API,将声音注册到系统中
POST https://{endpoint}/v1/{project_id}/vcs/voices Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "data": "/+MgxAAUeHpMAUkQAANhuRAC...", "config": { "voice_name": "test_xiaoming", "language": "chinese" } }
响应示例
状态码:200
成功响应示例
{
"trace_id": "567e8537-a89c-13c3-a882-826321939651",
"result":{
"voice_name": "test_xiaoming"
}
}
状态码:400
失败响应示例
{
"error_code": "SIS.1225",
"error_msg": "input 'voice_name' is empty"
}
