# 获取防骚扰规则

[异步回调] 获取防骚扰规则

说明:

  • 成员设置防骚扰规则,在客户群开启防骚扰后,当客户群内非企业成员触发规则,比如在群内发广告、刷屏时,将会被自动移出群聊或被警告;

  • 规则类型分企业创建和个人创建。管理员还可创建企业的规则,由企业成员选择使用;具有客户联系和客户群使用权限的成员,都可以配置自己的防骚扰规则,个人创建的防骚扰规则只可以运用于成员个人创建客户群。

请求方式:POST

请求地址:https://api.aquanliang.com/gateway/qopen/GetAntiHarassmentRules

body参数

{
    "robot_id": "机器人id"
}
字段 类型 必填 说明
robot_id string 机器人id

返回值:

{
    "data": {
        "serial_no": "xxxxxx"
    },
    "errcode": 0,
    "errmsg": ""
}

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
serial_no string 操作序列号

处理结果,异步返回值:

{
	"event_type": 300042,
	"err_code": 0,
	"err_msg": "",
	"serial_no": "操作序列号",
	"robot_id": "机器人id",
	"data": {
		"rules": [
			{
				"rule_id": "防骚扰规则编号",
				"rule_name": "防骚扰规则名称",
				"base64_rule_name": "base64加密后的防骚扰规则名称",
				"type": 1,
				"msg_keyword_switch": true,
				"msg_keywords": [
					"关键词"
				],
				"webpage_switch": true,
				"webpage_whitelist": [
					"网页白名单"
				],
				"miniprogram_switch": true,
				"miniprogram_whitelist": [
					"小程序白名单"
				],
				"file_msg_switch": true,
				"video_msg_switch": true,
				"card_msg_switch": true,
				"name_keyword_switch": true,
				"name_keywords": [
					"名称关键词"
				],
				"msg_length": 1,
				"msg_line": 2,
				"msg_fre_switch": true,
				"msg_count": 1,
				"msg_interval": 1,
				"removal_type": 1,
				"warning_message": "警告消息",
				"restricted_from_joining_groups": true
			}
		]
	}
}

返回说明

字段 类型 说明
event_type int 事件类型,300042
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
serial_no string 操作序列号
robot_id string 机器人编号
rules array 返回数据

rules 字段

字段 类型 说明
rule_id string 防骚扰规则编号
rule_name string 防骚扰规则名称
base64_rule_name string base64加密后的防骚扰规则名称
type int 规则类型:0 企业创建 1 个人创建
msg_keyword_switch bool 关键词开关是否开启:true开启 false关闭
msg_keywords array 关键词列表
webpage_switch bool 踢发网页开关是否开启:true开启 false关闭
webpage_whitelist array 网页白名单列表
miniprogram_switch bool 踢发小程序开关是否开启:true开启 false关闭
miniprogram_whitelist array 小程序白名单列表
file_msg_switch bool 踢发文件开关是否开启:true开启 false关闭
video_msg_switch bool 踢发视频开关是否开启:true开启 false关闭
card_msg_switch bool 踢发名片开关是否开启:true开启 false关闭
name_keyword_switch bool 昵称包含关键词踢出群聊开关是否开启:true开启 false关闭
name_keywords array 名称关键词列表
msg_length int 踢消息长度超过字数
msg_line int 踢消息换行超过行数
msg_fre_switch bool 踢消息刷屏开关是否开启:true开启 false关闭
msg_count int 消息刷屏条数
msg_interval int 消息刷屏时间
removal_type int 触发规则处理方式: 1.踢出群聊 2.警告并踢出群聊 3.仅发警告 4.警告三次后,触碰规则时踢出群聊
warning_message string 警告消息
restricted_from_joining_groups bool 踢出后设为禁止加入群聊的客户开关是否开启:true开启 false关闭

完整请求示例:

curl -X POST \
  https://api.aquanliang.com/gateway/qopen/GetAntiHarassmentRules \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
         "robot_id": "机器人id"
      }'