活动白名单

某些活动需要限制某些或者某种类型的用户访问，可以使用该功能。支持导入名单和通过接口动态获取名单两种方式。

Excel导入

根据不同的授权方式导入可参与活动的白名单用户：

公众号授权：openid
手机授权：手机号
自定义授权：访客userId

自定义接口

Excel只能导入固定的白名单，并且只能限制到用户。如果有动态白名单需求，比如根据用户身份、标签等限制访问，则可以通过自定义接口满足。

使用步骤

配置白名单接口，控制台-集成管理-自定义白名单。可配置多个接口，多个接口都会在编辑器展示。

（1）接口地址(标签列表)：用于在编辑器显示所有可供选择的标签列表。在接口地址上拼eqs_uid_open=1参数后，在请求白名单时header中会携带eqsUidOpen(当前员工的openId)。
（2）接口地址(查询用户标签)：用于用户参与活动时查询当前用户所属标签，判断该用户是否在活动白名单内。
配置活动
如果不选则表示都允许参与活动，多个接口只要符合一个条件即可参与活动。
用户参与活动
如果不符合参与条件则会提示“很遗憾，您不符合活动的参与条件请咨询主办方了解活动规则!”

接口规范

标签列表

接口描述：查询标签列表
请求方式：POST
Content-Type：application/json

请求参数

参数名	是否必须	参数类型	参数说明
timestamp	必须	String	请求时的时间戳
nonce	必须	String	随机字符串
signature	必须	String	请求签名
msgEncrypt	必须	String	加密后的消息

msgEncrypt内容如下：

参数名是否必须参数类型参数说明

creationId 必须 Int 活动id

corpOpenId 否 String 企业openId，平台型企业使用
返回参数

字段是否必须类型说明

code 是 String 标签code，标识用户标签的唯一性

name 是 String 标签名称

返回示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": null,
  "list": [
    {
      "code": "001",
      "name": "黄金"
    },
    {
      "code": "002",
      "name": "钻石"
    },
    {
      "code": "003",
      "name": "王者"
    }
  ]
}

查询用户标签

接口描述：查询用户标签
请求方式：POST
Content-Type：application/json

请求参数

参数名	是否必须	参数类型	参数说明
timestamp	必须	String	请求时的时间戳
nonce	必须	String	随机字符串
signature	必须	String	请求签名
msgEncrypt	必须	String	加密后的消息

msgEncrypt内容如下：

参数名	是否必须	参数类型	参数说明
creationId	必须	Int	活动id
openId	否	String	用户id，自定义授权的userId或者微信授权的openId
mobile	否	String	手机号，手机号授权
corpOpenId	否	String	企业openId，平台型企业使用

返回参数

字段是否必须类型说明

list 是 Array 用户所拥有标签的集合

返回示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": null,
  "list": ["001", "002"]
}

查询作品配置的白名单列表

接口描述：查询作品配置的白名单列表
请求方式：GET
Content-Type：application/json
接口地址：/api/v1/editor/hd/whitelist?token=TOKEN
请求参数

参数名是否必须参数类型参数说明

creationId 必须 Long 作品id
返回参数

字段是否必须类型说明

configList 是 Array 作品配置的白名单列表

configId 是 Long 白名单ID

whiteList 是 Array 作品白名单对应的标签

返回示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "configList": [
          {
              "configId": 10001,
              "whiteList": [
                  "001"
              ]
          },
          {
              "configId": 10002,
              "whiteList": [
                  "002"
              ]
          }
      ]
  },
  "map": null,
  "list": null,
  "details": null
}

字段	是否必须	类型	说明
code	是	String	标签code，标识用户标签的唯一性
name	是	String	标签名称

字段	是否必须	类型	说明
configList	是	Array	作品配置的白名单列表
configId	是	Long	白名单ID
whiteList	是	Array	作品白名单对应的标签