You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
直播质检 API
ListAvailableVoiceProfiles - 获取质检项目可用音色
复制全文
下载 pdf
ListAvailableVoiceProfiles - 获取质检项目可用音色

调用 ListAvailableVoiceProfiles 接口,查询指定直播质检项目中已启用的主播音色,包含启用的预置音色及自定义音色。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒。
  • 前提条件:
    • 确保当前账号已开通直播质检服务。若当前账号为子账号,请同时确保主账号已在直播质检平台为该子账号授权,详见为子账号授权。否则账号将提示“暂无使用权限,请联系客服人员申请开通”。
    • 当前账号为火山引擎主账号或具备直播质检主播管理 > 仅查看或可编辑或可管理权限的子账号。

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListAvailableVoiceProfiles&Version=2024-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是ListAvailableVoiceProfiles接口名称。当前 API 的名称为 ListAvailableVoiceProfiles。
VersionString是2024-08-01接口版本。当前 API 的版本为 2024-08-01。
ProjectNameString是1827016328608457直播质检的项目名称。您可通过调用 ListProjects 接口,获取 ProjectName。
PageNumberInteger否1分页查询页码。取值为正整数,默认值为 1。传入 0 时使用默认值。
PageSizeInteger否20分页查询数量。取值范围为 [1,100],默认值为 20。传入 0 时使用默认值。

返回参数

参数类型示例值描述
ItemsArray of Items-当前页的已启用的音色列表。无匹配音色或页码超出范围时返回空数组。
TotalLong1可用音色的总数。

Items

参数类型示例值描述
VoiceProfileIDLong7音色 ID。
VoiceProfileNameString清新女声 2.0音色名称。

VoiceType

String

PRESET

音色类型。取值如下:

  • PRESET:预置音色
  • CUSTOM:自定义音色

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListAvailableVoiceProfiles&Version=2024-08-01&ProjectName=1827016328608457&PageNumber=1&PageSize=20

返回示例

包含预置与已保存的自定义音色。创建任务使用返回的 VoiceProfileID;示例 ID 不保证可直接使用。无可用音色时 Items=[]、Total=0。

{
    "ResponseMetadata": {
        "RequestId": "202610190000000000000000000000000001",
        "Action": "ListAvailableVoiceProfiles",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "Items": [
            {
                "VoiceProfileID": 7,
                "VoiceProfileName": "清新女声 2.0",
                "VoiceType": "PRESET"
            },
            {
                "VoiceProfileID": 18,
                "VoiceProfileName": "主播小明",
                "VoiceType": "CUSTOM"
            }
        ],
        "Total": 2
    }
}

错误码

访问公共错误码和错误码获取详细信息。

最近更新时间:2026.10.30 10:37:37
这个页面对您有帮助吗?
有用
有用
无用
无用