第三方应用开发 服务端API 客户联系 管理聊天敏感词
管理聊天敏感词
最后更新:2024/03/07
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
管理聊天敏感词
最后更新:2024/03/07

目录

  • 概述
  • 权限说明
  • 新建敏感词规则
  • 获取敏感词规则列表
  • 获取敏感词规则详情
  • 修改敏感词规则
  • 删除敏感词规则
  • 概述

    企业与第三方应用可通过该接口管理聊天敏感词

     

    权限说明

    调用接口的应用需要满足如下的权限:

    应用类型权限要求
    自建应用配置到「客户联系 可调用接口的应用」中
    代开发应用具有「管理敏感词」权限
    第三方应用具有「管理敏感词」权限

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

    新建敏感词规则

    企业和第三方应用可以通过此接口新建敏感词规则
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"rule_name":"rulename",
    	"word_list":[
    	  "敏感词1","敏感词2"
    	],
    	"semantics_list":[1,2,3],
    	"intercept_type":1,
    	"applicable_range":{
    		"user_list":["zhangshan"],
    		"department_list":[2,3]
    	}
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    rule_name规则名称,长度1~20个utf8字符
    word_list敏感词列表,敏感词长度1~32个utf8字符,列表大小不能超过300个
    semantics_list额外的拦截语义规则,1:手机号、2:邮箱地址、3:红包
    intercept_type拦截方式,1:警告并拦截发送;2:仅发警告
    applicable_range敏感词适用范围,userid与department不能同时为不填
    applicable_range.user_list可使用的userid列表。必须为应用可见范围内的成员;最多支持传1000个节点
    applicable_range.department_list可使用的部门列表,必须为应用可见范围内的部门;最多支持传1000个节点
    注:企业敏感词规则条数上限为100个。

     

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok",
    	"rule_id" : "xxx"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    rule_id规则id

    获取敏感词规则列表

    企业和第三方应用可以通过此接口获取敏感词规则列表
    请求方式:GET(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_intercept_rule_list?access_token=ACCESS_TOKEN
    参数说明:

    参数必须说明
    access_token调用接口凭证

    权限说明:

    • 可获取企业所有敏感词规则

     

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok",
    	"rule_list":[
    		{
    			"rule_id":"xxxx",
    			"rule_name":"rulename",
    			"create_time":1600000000
    		}
    	]
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    rule_id规则id
    rule_name规则名称,长度上限20个字符
    create_time创建时间

    获取敏感词规则详情

    企业和第三方应用可以通过此接口获取敏感词规则详情
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_intercept_rule?access_token=ACCESS_TOKEN
    请求示例:

    {
    	"rule_id":"xxx"
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    rule_id规则id

     

    权限说明:

    • 使用范围只返回应用可见范围内的成员跟部门

     

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok",
    	"rule":{
    		"rule_id":1,
    		"rule_name":"rulename",
    		"word_list":[
    	 	 "敏感词1","敏感词2"
    		],
    		"semantics_list":[1,2,3],
    		"intercept_type":1,
    		"applicable_range":{
    			"user_list":["zhangshan"],
    			"department_list":[2,3]
    		}
    	}
    
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    rule_id规则id
    rule_name规则名称,长度上限20个字符
    word_list敏感词列表,敏感词不能超过30个字符,列表大小不能超过300个
    extra_rule额外的规则
    semantics_list额外的拦截语义规则,1:手机号、2:邮箱地:、3:红包
    intercept_type拦截方式,1:警告并拦截发送;2:仅发警告
    applicable_range敏感词适用范围
    applicable_range.user_list可使用的userid列表,只返回应用可见范围内的用户
    applicable_range.department_list可使用的部门列表,只返回应用可见范围内的部门
    create_time创建时间

    修改敏感词规则

    企业和第三方应用可以通过此接口修改敏感词规则
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"rule_id":"xxxx",
    	"rule_name":"rulename",
    	"word_list":[
    	  "敏感词1","敏感词2"
    	],
    	"extra_rule":{
    			"semantics_list":[1,2,3],
    	},
    	"intercept_type":1,
    	"add_applicable_range":{
    		"user_list":["zhangshan"],
    		"department_list":[2,3]
    	},
    	"remove_applicable_range":{
    		"user_list":["zhangshan"],
    		"department_list":[2,3]
    	}
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    rule_id规则id
    rule_name规则名称,长度1~20个utf8字符
    word_list敏感词列表,敏感词长度1~32个utf8字符,列表大小不能超过300个;若为空忽略该字段
    extra_rule额外的规则
    semantics_list额外的拦截语义规则,1:手机号、2:邮箱地:、3:红包;若为空表示清除所有的语义规则
    intercept_type拦截方式,1:警告并拦截发送;2:仅发警告
    add_applicable_range需要新增的使用范围
    add_applicable_range.user_list可使用的userid列表,必须为应用可见范围内的成员;每次最多支持传1000个节点;该规则最多可包含的userid总数上限为10000个。若超过建议设置部门id
    add_applicable_range.department_list可使用的部门列表,必须为应用可见范围内的部门;最多支持传1000个节点
    remove_applicable_range需要删除的使用范围
    remove_applicable_range.user_list可使用的userid列表,必须为应用可见范围内的成员;最多支持传1000个节点
    remove_applicable_range.department_list可使用的部门列表,必须为应用可见范围内的部门;最多支持传1000个节点
    注:除rule_id外,需要更新的字段才填,不需更新的字段可不填。

    权限说明:

    • 应用只可修改应用自己创建的敏感词规则

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

    删除敏感词规则

    企业和第三方应用可以通过此接口修改敏感词规则
    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_intercept_rule?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"rule_id":"xxx"
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    rule_id规则id

    权限说明:

    • 应用只可删除应用自己创建的敏感词规则

    返回结果:

    {
        "errcode":0,
        "errmsg":"ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    上一篇
    管理商品图册
    下一篇
    上传附件资源