跳到主要内容

查询定制人像详情

1.接口说明​

请求该接口查询客户定制的自定义人像详情数据。

2.请求地址​

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

3.请求方式​

GET

4.请求参数​

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

(2).接口参数​

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

参数名类型必需说明
versionString是接口版本号，当前支持版本：1.0.0、1.3.0。
idString是数字人ID。

5.请求示例​

GET https://digitbot.bokecc.com/api/portrait/custom/get?id=xxx&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1

6.响应示例​

{
  "id": "xxx",
  "type": 0,
  "name": "定制人像",
  "gender": 1,
  "matting": 0,
  "status": 3,
  "progress": 30,
  "refusedReason": "",
  "createTime": "2024-01-24 09:10:11",
  "finishTime": "2024-01-24 10:00:00",
  "expireDate": "2025-01-23",
  "snapshotUrl": "https://xxxxx.xxxxx",
  "width": 376,
  "height": 798
}

7.响应说明​

字段名类型说明版本说明
idString数字人ID。
typeInteger人像定制类型，枚举值。0=专属口型人像；2=图片数字人；4=通用口型人像。1.0.0：不返回该字段1.3.0起：返回该字段
nameString数字人名称。
genderInteger数字人性别，枚举值。0=女；1=男。
mattingInteger人像类型，枚举值。0=实景；1=绿幕；2=普通。1.0.0：查询专属口型人像，按实际返回1.3.0起：type=2时，不返回该字段
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时有效。
snapshotUrlString人像图片链接。status=5时有效。
widthInteger人像(图片)宽度，像素值。
heightInteger人像(图片)高度，像素值。