后端API接口文档

创建活动 /v2/activities/create POST JSON

参数名 参数类型 参数描述 必选
title string 标题 是
startTime Date 开始时间 否
limitTime Date 结束时间 否
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间 是
cover string 封面 是
link string 链接 是
publishDate Date 发布时间，立即发布时，请将该参数置为当前时间 是
isDraft boolean 是否草稿 是

编辑活动 /v2/activities/update PUT JSON

参数名 参数类型 参数描述 必选
_id string _id 是
title string 标题 是
startTime Date 开始时间 否
limitTime Date 结束时间 否
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间 是
cover string 封面 否
link string 链接 否
publishDate Date 发布时间，立即发布时，请将该参数置为当前时间 是
isDraft boolean 是否草稿 是

暂停/恢复活动 /v2/activities/updateStatus PUT JSON

参数名 参数类型 参数描述 必选
_id string _id 是
status number 状态 1：正常 2：暂停 是

列出活动 /v2/activities/list GET QUERY

参数名 参数类型 参数描述 必选
skipSize number 略过的数目 是
pageSize number 页面大小 是
flag number 查询标记 0：全部 1：未发布 2：已暂停 3：未开始 4：进行中 5：已结束 6：草稿 是
title string 标题，若不使用该条件，将其置为空字符串"" 是

返回结构：

{
  "ret": 0,
  "errCode": 0,
  "errcode": 0,
  "msg": "success",
  "data": {
    "num": 1,
    "activities": [
      {
        "_id": "624d511e9e383e0a482c6279",
        "title": "",
        "startTime": null,
        "limitTime": null,
        "persist": true,
        "cover": "",
        "link": "",
        "publishDate": "2022-04-06T08:36:46.251Z",
        "status": 1,
        "isDraft": true,
        "__v": 0
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

结构参数：

参数名 参数类型 参数描述
_id number _id
title string 标题
startTime Date 开始时间
limitTime Date 结束时间
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间
cover string 封面
link string 链接
publishDate Date 发布时间，立即发布时，请将该参数置为当前时间
status number 状态 1：正常 2：暂停
isDraft boolean 是否草稿

列出非草稿/非已结束的活动 /v2/activities/list2 GET QUERY （返回结构同列出活动）

参数名 参数类型 参数描述 必选
title string 标题，若不使用该条件，将其置为空字符串"" 是

查询活动 /v2/activities/find GET QUERY

参数名 参数类型 参数描述 必选
_id number _id 是

返回结构：

{
  "ret": 0,
  "errCode": 0,
  "errcode": 0,
  "msg": "success",
  "data": {
    "_id": "624d5afd5915985c8c8bb3a3",
    "title": "",
    "startTime": null,
    "limitTime": null,
    "persist": true,
    "cover": "",
    "link": "",
    "publishDate": null,
    "status": 1,
    "isDraft": true,
    "__v": 0
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

结构参数：

参数名 参数类型 参数描述
_id number _id
title string 标题
startTime Date 开始时间
limitTime Date 结束时间
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间
cover string 封面
link string 链接
publishDate Date 发布时间，立即发布时，请将该参数置为当前时间
status number 状态 1：正常 2：暂停
isDraft boolean 是否草稿

← 运营活动接口文档_客户端 →