跳到主要内容

查询项目列表

1.接口说明​

请求该接口查询项目列表，支持分页查询，按更新时间倒序排列。

  • 通过该接口只能查询到状态正常的项目。

2.请求地址​

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

3.请求方式​

GET

4.请求参数​

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

(2).接口参数​

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

参数名类型必需说明版本说明
versionString是接口版本号，当前支持版本：1.0.0、1.2.0、1.6.1、1.6.2
nameString否项目名称，根据传入参数模糊匹配项目名称进行查询。默认不过滤项目名称。
memberIdString否第三方成员ID，iframe方式使用时特有。1.0.0：不支持该参数1.2.0起：新增该参数
memberIdMatchTypeString否memberId查询匹配类型，默认为1，取值：1 =全模糊查询，2 =右模糊查询（按前缀查询），3= 左模糊查询（按后缀查询），4=等值匹配。1.6.2起：新增该参数
pageNumInteger否查询页码，正整数。默认值：1。
pageSizeInteger否分页大小，正整数，取值范围为[1, 100]区间，默认值：25。

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",
            "name": "演示项目",
            "duration": 1234567,
            "createTime": "2024-01-24 09:10:11",
            "updateTime": "2024-01-24 10:00:00",
            "memberId": "xxxx",
            "memberIdMatchType": 2,
            "previewComponents": [
                {
                    "type": 0,
                    "color": "#FFFFFF",
                    "width": 1920,
                    "height": 1080,
                    "x": 0,
                    "y": 0
                },
                {
                    "type": 1,
                    "width": 376,
                    "height": 999,
                    "x": 156,
                    "y": 81
                }, ...
            ]
        }, ...
    ]
}

7.响应说明​

字段名类型说明
countLong符合查询条件的项目总数量。
itemsArray查询页返回的项目(project)列表，按更新时间倒序排列。

items[*]说明​

字段名类型说明版本说明
idString项目ID。
nameString项目名称。
memberIdString第三方成员ID，iframe方式使用时特有。1.0.0：不返回该字段 1.2.0起：返回该字段
durationLong项目预估时长，单位：毫秒。
createTimeString创建时间，yyyy-MM-dd HH:mm:ss格式。
updateTimeString更新时间，yyyy-MM-dd HH:mm:ss格式。
videoWidthInteger视频宽度，像素值，即项目画面宽。1.6.1起：新增返回
videoHeightInteger视频高度，像素值，即项目画面高。1.6.1起：新增返回
previewComponentsArray项目预览组件数据，包含第1个场景中的背景、人像、贴纸等信息。列表元素按图层由远及近排序。1.6.1起：新增返回

items[*].previewComponents[*]说明（1.6.1起：新增）​

字段名类型说明
typeInteger预览组件类型，枚举值。0=颜色；1=图片；2=视频。
colorString预览组件颜色，十六进制RGB颜色代码，如：#FFFFFF。type=0时有效。
imageUrlString预览组件图片链接。type!=0时有效。type=1时，表示预览组件相关的图片链接，如人像、图片背景、贴图等。type=2时，表示预览组件相关的截图链接，如视频背景。
videoUrlString预览组件视频链接。type=2时有效。
originWidthInteger预览组件素材的原始宽度，像素值。type!=0时有效。
originHeightInteger预览组件素材的原始高度，像素值。type!=0时有效。
widthInteger预览组件素材的目标宽度，像素值。指在输出视频中，组件经过缩放后的宽度。
heightInteger预览组件素的材目标高度，像素值。指在输出视频中，组件经过缩放后的高度。
xInteger预览组件的坐标x，像素值。指在输出视频中，组件的水平方向位置。以视频左上角为原点，向右为正方向，组件左上角顶点到原点的水平距离。
yInteger预览组件的坐标y，像素值。指在输出视频中，组件的垂直方向位置。以视频左上角为原点，向下为正方向，组件左上角顶点到原点的垂直距离。