跳到主要内容

查询作品(任务)列表

1.接口说明​

请求该接口查询作品(任务)列表，支持分页查询，按创建时间倒序排列。

2.请求地址​

https://digitbot.bokecc.com/api/product/page

3.请求方式​

GET

4.请求参数​

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

(2).接口参数​

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

参数名类型必需说明
versionString是接口版本号，当前支持版本：1.0.0、1.2.0
projectIdString否项目ID。支持批量查询，多个项目ID使用","连接，最多连接10个项目ID。默认不过滤项目。
nameString否作品名称，根据传入参数模糊匹配作品名称进行查询。默认不过滤作品名称。
typeInteger否作品类型，枚举值。0=视频；1=音频。默认不过滤作品类型。
statusInteger否作品(任务)状态，枚举值。默认不过滤作品(任务)状态。1=审核中；2=内容违规(审核不通过)；3=合成中；4=合成失败；5=合成成功；6=已过期。
startDateString否开始日期，yyyy-MM-dd格式，包含。查询创建时间在指定日期及之后的作品。默认不过滤创建时间。
endDateString否结束日期，yyyy-MM-dd格式，包含。查询创建时间在指定日期及之前的作品。默认不过滤创建时间。
pageNumInteger否查询页码，正整数。默认值：1。
pageSizeInteger否分页大小，正整数，取值范围为[1, 100]区间，默认值：25。
  • startDate、endDate：查询时，过滤作品(任务)创建时间范围。
    • startDate：作品创建时间>=begin(startDate)。
    • endDate：作品创建时间<begin(endDate+1)。
    • startDate和endDate区间跨度不超过1年(365天)。
  • projectId、name、type、status、startDate、endDate等参数都设置值时，查询时过滤所有项，取结果集的交集。

5.请求示例​

GET https://digitbot.bokecc.com/api/project/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": 0,
            "name": "示例作品",
            "projectId": "xxxxx",
            "projectName": "演示项目",
            "projectStatus": 0,
            "duration": 1234567,
            "status": 0,
            "progress": 30,
            "createTime": "2024-01-24 09:10:11",
            "finishTime": "2024-01-24 10:00:00",
            "expireDate": "2024-02-23",
            "scenes": [
                {
                    "orderNo": 1,
                    "invalidContent": "xxxxx"
                }
            ],
            "memberId": "xxx"
        }, ...
    ]
}

7.响应说明​

字段名类型说明
countLong符合查询条件的作品(任务)总数量。
itemsArray查询页返回的作品(product)列表，按创建时间倒序排列。

product字段说明​

字段名类型说明版本说明
idString作品(任务)ID。
typeInteger作品类型，枚举值。0=视频；1=音频。
nameString作品名称。
projectIdString项目ID。
projectNameString项目名称。
projectStatusInteger项目状态，枚举值。0=正常；1=已删除。
durationLong作品时长，单位：毫秒。
statusInteger作品(任务)状态，枚举值。1=审核中；2=内容违规(审核不通过)；3=合成中；4=合成失败；5=合成成功；6=已过期。
progressInteger作品(任务)进度，取值[-1, 100]区间，-1表示排队中；0~100表示进度的百分比。status=3时有效。
createTimeString作品(任务)创建时间，yyyy-MM-dd HH:mm:ss格式。
finishTimeString作品(任务)完成时间，yyyy-MM-dd HH:mm:ss格式。
expireDateString作品过期日期，yyyy-MM-dd格式。status=5、6时有效。
previewUrlString作品预览链接。status=5时有效。
scenesArray含有违规内容的场景(scene)列表。status=2时有效。
memberIdString第三方成员ID，iframe方式使用时特有。1.0.0：不返回该字段 1.2.0起：返回该字段
  • duration：作品时长，作品(任务)处理成功后，按合成的结果时长返回，否则按预估时长返回。

scene字段说明​

字段名类型说明
orderNoInteger场景编号，从1开始，按顺序递增。
invalidContentString场景中的违规内容。