跳到主要内容

查询自定义图片背景列表

1.接口说明​

请求该接口查询用户上传的自定义图片背景列表，支持分页查询，按创建时间倒序排列。

  • 只返回上传成功且有效的图片背景。

2.请求地址​

https://digitbot.bokecc.com/api/background/image/custom/page

3.请求方式​

GET

4.请求参数​

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

(2).接口参数​

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

参数名类型必需说明
versionString是接口版本号，当前支持版本：1.0.0。
projectIdString是项目ID。
pageNumInteger否查询页码，正整数。默认值：1。
pageSizeInteger否分页大小，正整数，取值范围为[1, 100]区间，默认值：25。

5.请求示例​

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

6.响应示例​

{
    "count": 100,
	"items": [{
        "id": "xxx",
		"createTime": "2024-01-29 11:00:00",
        "imageUrl": "https://xxxx.xxxxx/xx",
		"filename": "xxxxx.png",
		"size": 1234567,
        "width": 1920,
		"height": 1080
    }, ...]
}

7.响应说明​

字段名类型说明
countLong符合查询条件的自定义图片背景总数量。
itemsArray查询页返回的图片背景(background)列表。

background字段说明​

字段名类型说明
idString背景ID。
createTimeString创建时间，yyyy-MM-dd HH:mm:ss格式。
imageUrlString背景图片链接。
filenameString背景图片文件名。
sizeLong背景图片文件大小，单位：B(字节)。
widthInteger背景图片宽度，像素值。
heightInteger背景图片高度，像素值。