查看音色列表

请求地址

权限

listVoice
确保调用该接口使用的个人令牌开通了 listVoice 权限，详细信息参考鉴权方式。

接口说明

查看可用的音色列表，包括系统预置音色和自定义音色。

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。

Content-Type

application/json

解释请求正文的方式。

filter_system_voice

Boolean

可选

false

查看音色列表时是否过滤掉系统音色。

• true：过滤系统音色
• false：（默认）不过滤系统音色

model_type

String

可选

big

音色模型的类型，如果不填，默认都返回。可选值包括：

• big：大模型
• small：小模型

voice_state

String

可选

cloned

音色克隆状态，用于筛选特定状态的音色。可选值包括：

• init：待克隆。
• cloned：（默认值）已克隆。
• all：全部。

page_num

Integer

可选

1

查询结果分页展示时，此参数用于设置查看的页码。最小值为 1，默认为 1。

page_size

Integer

可选

100

查询结果分页展示时，此参数用于设置每页返回的数据量。取值范围为 1~100，默认为 100。

code

Long

0

状态码。
0代表调用成功。

data

Object of ListVoiceData

参见响应参数

音色的详细信息。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时，msg 默认为空。

detail

Object of ResponseDetail

{ “logid”: “2024102916355736DC98FBC4D32FD7E59C” }

本次请求的详细信息。

has_more

Boolean

false

标识是否还有未返回的音色数据。

• true ：当前返回的音色列表未包含所有符合条件的音色。
• false：表示已返回所有符合条件的音色数据。

voice_list

Array of OpenAPIVoiceData

参见响应参数

音色列表详情。

name

String

开朗大男孩

音色的名称。

state

String

cloned

音色克隆状态。枚举值：

• init：待克隆。
• cloned：已克隆。

voice_id

String

734829333445931****

音色的 ID。

model_name

String

模型类型字符串

model_type

String

big

音色模型的类型，枚举值：

• big：大模型
• small：小模型

create_time

Integer

1729686510

音色的创建时间，格式为 11 位的 Unixtime 时间戳。

update_time

Integer

1729686510

音色的更新时间，格式为 11 位的 Unixtime 时间戳。

preview_text

String

你好呀

此音色预览音频对应的文案。

language_code

String

zh

此音色的语种代号。

language_name

String

中文

此音色的语种名称。

preview_audio

String

https://lf3-appstore-sign.oceancloudapi.com/ocean-cloud-tos/VolcanoUserVoice/xxxxxx.mp3?lk3s=da27ec82&x-expires=1730277357&x-signature=xu2O6Gp5RvTyJOawqjAfsJZvifc%3D

此音色的预览音频。通常是一个公开可访问的网络地址。

is_system_voice

Boolean

false

标识当前音色是否为系统预置音色。

• true：系统预置音色。
• false：用户自定义音色。

support_emotions

Array of EmotionInfo

[{“emotion”:“happy”,“display_name”:“开心”,“emotion_scale_interval”:{“max”:5,“min”:1,“default”:4}},{“emotion”:“sad”,“display_name”:“悲伤”,“emotion_scale_interval”:{“max”:5,“min”:1,“default”:3}}]

音色支持的情感类型列表，仅当音色为多情感音色时返回。

available_training_times

Integer

6

当前音色还可训练的次数。包括首次复刻音色在内，每个自定义音色最多被训练 10 次。

emotion

String

happy

音色支持的情感类型标识符，仅当音色为多情感音色时返回。枚举值如下：

• happy：开心。
• sad：悲伤。
• angry：愤怒。
• surprised：惊讶。
• fear：恐惧。
• hate：厌恶。
• excited：兴奋。
• coldness：冷漠。
• neutral：中性。

display_name

String

开心

音色支持的情感类型的中文显示名称，用于直观展示情感类型。

emotion_scale_interval

Object of Interval

{“max”:5,“min”:1,“default”:4}

情感强度的取值范围，用于量化情感的强度。

max

Double

5

情感强度的最大值。

min

Double

1

情感强度的最小值。

default

Double

4

情感强度的默认值。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。