黑名单管理

在ECMP后台，控制台->黑名单管理，添加对应企业的黑名单。

注意：
1、黑名单设置立即生效
2、黑名单设置针对所有作品，一旦用户命中黑名单，则不可参与互动

可手动添加或Excel导入

手动添加
excel导入，可同时设置多列，多种格式

作品展示效果

黑名单接口

获取企业黑名单列表

接口描述：获取企业黑名单列表
接口地址：/api/v1/biz/customer/blacklist/list?token=TOKEN
请求方式：GET

接口入参：

参数名	必须	参数类型	参数说明
keywords	否	String	查询关键词，例如手机号，公众号openId,自定义用户ID等
authType	否	int	黑名单用户授权类型 1:公众号授权，2:手机号授权，3:自定义授权
pageNo	是	int	分页参数
pageSize	是	int	分页参数

返回值

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": {
      "pageNo": 1,
      "count": 1,
      "pageSize": 10,
      "end": true
  },
  "list": [{
      "id": 25,
      "corpId": "97937990100349b6aa254c06bcbd54f1",
      "authType": 1,
      "authUniqueId": "111",
      "remark": "111",
      "optStaffId": "f5a8d9b09a71400cafdf921339779405",
      "createTime": "2022-11-25 10:54:49",
      "updateTime": "2022-11-25 10:54:49"
  }]
}

返回值说明

字段	类型	说明
corpId	String	企业ID
authType	int	黑名单用户授权类型 1:公众号授权，2:手机号授权，3:自定义授权
authUniqueId	String	黑名单用户唯一标识，分别与授权类型相对应
remark	String	黑名单用户备注
optStaffId	String	黑名单操作用户
createTime	int	创建时间
updateTime	int	更新时间

黑名单添加

接口描述：黑名单添加
接口地址：/api/v1/biz/customer/blacklist/add?token=TOKEN&openId=openId
请求方式：post
传参方式：content-type:application/json

接口入参：

参数名	必须	参数类型	参数说明
authType	是	int	黑名单用户授权类型 1:公众号授权，2:手机号授权，3:自定义授权
authUniqueId	是	String	黑名单用户唯一标识，分别与授权类型相对应
remark	是	String	黑名单用户备注

返回值

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "id": 25,
      "corpId": "97937990100349b6aa254c06bcbd54f1",
      "authType": 1,
      "authUniqueId": "111",
      "remark": "111",
      "optStaffId": "f5a8d9b09a71400cafdf921339779405",
      "createTime": "2022-11-25 10:54:49",
      "updateTime": "2022-11-25 10:54:49"
  }
}

返回值说明

字段类型说明

黑名单修改备注

接口描述：黑名单修改备注
接口地址：/api/v1/biz/customer/blacklist/remark?token=TOKEN&openId=openId
请求方式：post
传参方式：content-type:application/json
接口入参：

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

blacklistId 是 long 黑名单唯一标识

remark 是 String 黑名单用户备注

返回值

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "id": 25,
      "corpId": "97937990100349b6aa254c06bcbd54f1",
      "authType": 1,
      "authUniqueId": "111",
      "remark": "111",
      "optStaffId": "f5a8d9b09a71400cafdf921339779405",
      "createTime": "2022-11-25 10:54:49",
      "updateTime": "2022-11-25 10:54:49"
  }
}

返回值说明

字段类型说明

黑名单删除
接口描述：黑名单删除
接口地址：/api/v1/biz/customer/blacklist/del?token=TOKEN&openId=openId
请求方式：get
接口入参：

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

blacklistId 是 long 黑名单唯一标识

返回值

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "id": 25,
      "corpId": "97937990100349b6aa254c06bcbd54f1",
      "authType": 1,
      "authUniqueId": "111",
      "remark": "111",
      "optStaffId": "f5a8d9b09a71400cafdf921339779405",
      "createTime": "2022-11-25 10:54:49",
      "updateTime": "2022-11-25 10:54:49"
  }
}

返回值说明

字段类型说明

黑名单导入
接口描述：黑名单导入
接口地址：/api/v1/biz/customer/blacklist/import?token=TOKEN&openId=openId
请求方式：port
接口入参：form表单

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

blacklistFile 是 file 黑名单excel 名单excel

返回值

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "result": true,
      "errorCode": ,
      "errorMessage": "",
      "successCount": 1,
      "failCount": 0
  }
}

返回值说明

字段	类型	说明
result	boolean	导入结果 true 成功，部分失败也是成功，完全失败才是失败，false 失败
errorCode	String	导入失败时错误码
errorMessage	String	导入失败时错误信息
successCount	int	导入成功条数
failCount	int	导入失败条数

参数名	必须	参数类型	参数说明
blacklistId	是	long	黑名单唯一标识
remark	是	String	黑名单用户备注

黑名单管理

黑名单管理

黑名单接口

获取企业黑名单列表

黑名单添加

黑名单修改备注

黑名单删除

黑名单导入