跳到主要内容

查询定制声音列表

1.接口说明​

请求该接口查询客户定制的自定义声音数字人列表，支持分页查询。按创建时间倒序排列。

2.请求地址​

https://digitbot.bokecc.com/api/voice/custom/page

3.请求方式​

GET

4.请求参数​

(1).公共参数，参考服务说明。​

(2).接口参数​

①.Query参数：通过URL参数传递。​

参数名类型必需说明版本说明
versionString是接口版本号，当前支持版本：1.0.0、1.1.0。
nameString否数字人名称，根据传入参数模糊匹配数字人名称进行查询。默认不过滤数字人名称。
genderInteger否性别，枚举值。0=女；1=男。默认不过滤数字人性别。
statusInteger否数字人状态，枚举值。1=审核中；2=审核不通过；3=训练中；4=训练失败；5=训练成功；6=已过期。
pageNumInteger否查询页码，正整数。默认值：1。
pageSizeInteger否分页大小，正整数，取值范围为[1, 100]区间，默认值：25。
modelInteger否声音模型，1=专属定制版模型，2=多语言版模型，不传查询全部模型1.0.0：不支持该参数，查询结果只返回多语言版模型1.1.0起：支持该参数

5.请求示例​

GET https://digitbot.bokecc.com/api/voice/custom/page?pageNum=1&pageSize=50&accountId=xxx&version=1.1.0&hash=xxx&time=xxx HTTP/1.1

6.响应示例​

{
    "count": 100,
	"items": [{
        "id": "xxx",
        "name": "声音",
		"gender": 0,
		"createTime": "2024-01-29 09:00:00",
		"finishTime": "2024-01-31 10:00:00",
		"status": 5,
		"refusedReason": "",
		"progress": 100,
		"expireDate": "2025-01-30",
        "auditionUrl": "https://xxxx.xxxxx.xx/xxx",
        "models": [1]
    }, ...]
}

7.响应说明​

字段名类型说明
countLong符合查询条件的自定义声音(任务)总数量。
itemsArray查询页返回的自定义声音(voice)列表。

voice字段说明​

字段名类型说明版本说明
idString数字人ID。
nameString数字人名称。
genderInteger数字人性别，枚举值。0=女；1=男。
statusInteger数字人(任务)状态，枚举值。1=审核中；2=审核不通过；3=训练中；4=训练失败；5=训练成功；6=已过期。
progressInteger数字人训练进度，取值[-1, 100]区间，-1表示排队中；0~100表示进度的百分比。status=3时有效。
refusedReasonString审核不通过的原因。status=2时有效。
createTimeString创建时间，yyyy-MM-dd HH:mm:ss格式。
finishTimeString完成时间，yyyy-MM-dd HH:mm:ss格式。
expireDateString数字人过期日期，yyyy-MM-dd格式。status=5、6时有效。
auditionUrlString声音试听音频链接。
modelsArray声音模型数组，示例: [1, 2] , 1=专属定制版模型，2=多语言版模型, 至少包含一个值。1.0.0：不返回该字段1.1.0起：返回该字段