查询预置图片背景列表
1.接口说明
请求该接口查询系统预置的图片背景列表,支持分页查询。
2.请求地址
https://digitbot.bokecc.com/api/background/image/preset/page
3.请求方式
GET
4.请求参数
(1).公共参数,参考服务说明。
(2).接口参数
①.Query参数:通过URL参数传递。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| version | String | 是 | 接口版本号,当前支持版本:1.0.0。 |
| pageNum | Integer | 否 | 查询页码,正整数。默认值:1。 |
| pageSize | Integer | 否 | 分页大小,正整数,取值范围为[1, 100]区间,默认值:25。 |
5.请求示例
GET https://digitbot.bokecc.com/api/background/image/preset/page?pageNum=1&pageSize=50&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
6.响应示例
{
"count": 100,
"items": [{
"id": "xxx",
"width": 1920,
"height": 1080
}, ...]
}
7.响应说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| count | Long | 符合查询条件的预置图片背景总数量。 |
| items | Array | 查询页返回的图片背景(background)列表。 |
background字段说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | String | 背景ID。 |
| imageUrl | String | 背景图片链接。 |
| width | Integer | 背景图片宽度,像素值。 |
| height | Integer | 背景图片高度,像素值。 |