文档首页/语音交互服务 SIS/API参考/声音复刻接口/查询接口
更新时间：2026-02-03 GMT+08:00
查看PDF
分享

查询接口

功能介绍

查询已注册的声音列表。

URI

GET /v1/{project_id}/vcs/voices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见认证鉴权。响应消息头中X-Subject-Token的值即为Token

表3 请求Body参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询已注册的声音列表，每页查询显示的条目数量，默认：10

offset

否

Integer

查询已注册的声音列表，页码偏移量，表示从此页码偏移量开始查询，offset大于等于0， 默认：0

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

trace_id

String

服务内部的令牌，可用于在日志中追溯具体流程，调用失败无此字段。

result

Object

注册声音响应，详见表5。

表5 result结构

参数

参数类型

描述

voices

List

注册成功的声音列表，详见表6。

表6 voices结构

参数

参数类型

描述

voice_name

String

注册成功的声音名称。

language

String

注册成功的声音语种。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码。 调用成功时无此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点，当前支持上海一。

  • 调用查询API，查询已注册的声音列表 
    GET https://{endpoint}/v1/{project_id}/vcs/voices

Request Header:
Content-Type: application/json 
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码：200

成功响应示例 
{ 
   "trace_id": "567e8537-a89c-13c3-a882-826321939651", 
   "result":{ 
     "voices": [
        {
          "voice_name": "test_xiaoming",
          "language": "chinese"
        }
   } 
 }
父主题：声音复刻接口

相关文档