管理聊天敏感词-新建敏感词规则

POST

/cgi-bin/externalcontact/add_intercept_rule

企业内部开发服务端API第三方应用开发

企业和第三方应用可以通过此接口新建敏感词规则
注：企业敏感词规则条数上限为100个。
权限说明:

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。

第三方应用或者代开发自建应用调用需要企业授权客户联系下管理敏感词的权限

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"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": 0,
  "errmsg": "ok",
  "rule_id": "xxx"
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

rule_name

string

必需

规则名称，长度1~20个utf8字符

applicable_range

object

必需

附件类型，仅支持image，userid与department不能同时为不填

department_list

array[integer <int32>]

可选

user_list

array[string]

可选

word_list

array[string]

必需

敏感词列表，敏感词长度1~32个utf8字符，列表大小不能超过300个

intercept_type

integer <int32>

必需

拦截方式，1:警告并拦截发送；2:仅发警告

semantics_list

array[integer <int32>]

可选

额外的拦截语义规则，1：手机号、2：邮箱地:、3：红包

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

rule_id

string

规则id

可选

errmsg

string

可选

对返回码的文本描述内容

修改于 2022-12-06 09:08:04

概述

管理聊天敏感词-获取敏感词规则列表