管理聊天敏感词-获取敏感词规则详情

POST

/cgi-bin/externalcontact/get_intercept_rule

企业和第三方应用可以通过此接口获取敏感词规则详情
权限说明:

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

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

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

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_intercept_rule?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"rule_id":"xxx"}'

响应示例

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

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

rule_id

string

规则id

必需

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

rule

object

可选

rule_id

integer <int32>

规则id

可选

rule_name

string

可选

规则名称，长度上限20个字符

applicable_range

object

可选

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

word_list

array[string]

可选

敏感词列表，敏感词不能超过30个字符，列表大小不能超过300个

extra_rule

object

额外的规则

可选

intercept_type

integer <int32>

可选

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

修改于 2022-12-06 09:10:09

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

管理聊天敏感词-修改敏感词规则