查询定制人像列表

1.接口说明

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

2.请求地址

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

3.请求方式

GET

4.请求参数

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

(2).接口参数

⑤.Query参数：通过URL参数传递。

参数名	类型	必需	说明	版本说明
version	String	是	接口版本号，当前支持版本：1.0.0、1.3.0。
type	Integer	否	人像定制类型，枚举值。0=专属口型人像；2=图片数字人；4=通用口型人像。	1.0.0：不支持该参数，查询结果只包含专属口型人像数字人1.3.0起：该参数必需，查询指定定制类型的人像数字
name	String	否	数字人名称，根据传入参数模糊匹配数字人名称进行查询。默认不过滤数字人名称。
gender	Integer	否	性别，枚举值。0=女；1=男。默认不过滤数字人性别。
status	Integer	否	数字人状态，枚举值。1=审核中；2=审核不通过；3=训练中；4=训练失败；5=训练成功；6=已过期。
pageNum	Integer	否	查询页码，正整数。默认值：1。
pageSize	Integer	否	分页大小，正整数，取值范围为[1, 100]区间，默认值：25。

5.请求示例

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

6.响应示例

{
    "count": 100,
	"items": [{
        "id": "xxx",
		"type": 2,
        "name": "人像",
		"gender": 0,
        "matting": 1,
		"status": 5,
		"progress": 100,
		"refusedReason": "",
		"createTime": "2024-01-29 09:00:00",
		"finishTime": "2024-01-31 10:00:00",
		"expireDate": "2025-01-30",
        "snapshotUrl": "https://xxxx.xxxxx.xx/xxx",
        "width": 376,
		"height": 798
    }, ...]
}

7.响应说明

字段名	类型	说明
count	Long	符合查询条件的自定义人像(任务)总数量。
items	Array	查询页返回的自定义人像(portrait)列表。

portrait字段说明

字段名	类型	说明	版本说明
id	String	数字人ID。
type	Integer	人像定制类型，枚举值。0=专属口型人像；2=图片数字人；4=通用口型人像。	1.0.0：不返回该字段1.3.0起：返回该字段
name	String	数字人名称。
gender	Integer	数字人性别，枚举值。0=女；1=男。
matting	Integer	人像类型，枚举值。0=实景；1=绿幕；2=普通。	1.0.0：按人像实际返回1.3.0起：type=2时，不返回该字段
status	Integer	数字人(任务)状态，枚举值。1=审核中；2=审核不通过；3=训练中；4=训练失败；5=训练成功；6=已过期。
progress	Integer	数字人训练进度，取值[-1, 100]区间，-1表示排队中；0~100表示进度的百分比。status=3时有效。
refusedReason	String	审核不通过的原因。status=2时有效。
createTime	String	创建时间，yyyy-MM-dd HH:mm:ss格式。
finishTime	String	完成时间，yyyy-MM-dd HH:mm:ss格式。
expireDate	String	数字人过期日期，yyyy-MM-dd格式。status=5、6时有效。
snapshotUrl	String	人像图片链接。
width	Integer	人像(图片)宽度，像素值。
height	Integer	人像(图片)高度，像素值。