# 文本内容安全识别

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：msgSecCheck

该接口用于检查一段文本是否含有违法违规内容。

应用场景：

用户个人资料违规文字检测；
媒体新闻类用户发表文章，评论内容检测；
游戏类用户编辑上传的素材(如答题类小游戏用户上传的问题及答案)检测等。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/msg_sec_check?access_token=ACCESS_TOKEN

支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

# 云调用

调用方法：security.msgSecCheck
出入参和 HTTPS 调用相同，调用方式可查看云调用说明文档

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：18
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	说明
access_token	string	是	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
content	string	是	需检测的文本内容，文本字数的上限为2500字，需使用UTF-8编码
version	number	是	接口版本号，2.0版本为固定值2
scene	number	是	场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
openid	string	是	用户的openid（用户需在近两小时访问过小程序）
title	string	否	文本标题，需使用UTF-8编码
nickname	string	否	用户昵称，需使用UTF-8编码
signature	string	否	个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息
detail	objarray	详细检测结果
trace_id	string	唯一请求标识，标记单次请求
result	object	综合结果

# Res.detail(Array) `Object Payload`

详细检测结果

参数名	类型	说明
strategy	string	策略类型
errcode	number	错误码，仅当该值为0时，该项结果有效
suggest	string	建议，有risky、pass、review三种值
label	number	命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他
keyword	string	命中的自定义关键词
prob	number	0-100，代表置信度，越高代表越有可能属于当前返回的标签（label）

# Res.result `Object Payload`

综合结果

参数名	类型	说明
suggest	string	建议，有risky、pass、review三种值
label	number	命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他

# 4. 注意事项

-1.0 版本接口文档【点击查看】，1.0版本在2021年9月1日停止更新，请尽快更新至2.0

频率限制：单个 appId 调用上限为 4000 次/分钟，2,000,000 次/天。

# 5. 代码示例

# 5.1 HTTPS调用

请求示例

{
  "openid": "OPENID",
  "scene": 1,
  "version": 2,
  "content": "hello world!"
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "result": {
    "suggest": "risky",
    "label": 20001
  },
  "detail": [
    {
      "strategy": "content_model",
      "errcode": 0,
      "suggest": "risky",
      "label": 20006,
      "prob": 90
    },
    {
      "strategy": "keyword",
      "errcode": 0,
      "suggest": "pass",
      "label": 20006,
      "level": 20,
      "keyword": "命中的关键词1"
    },
    {
      "strategy": "keyword",
      "errcode": 0,
      "suggest": "risky",
      "label": 20006,
      "level": 90,
      "keyword": "命中的关键词2"
    }
  ],
  "trace_id": "60ae120f-371d5872-7941a05b"
}

# 5.2 云函数调用

请求示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.security.msgSecCheck({
        "openid": 'OPENID',
        "scene": 1,
        "version": 2,
        "content": 'hello world!'
      })
    return result
  } catch (err) {
    return err
  }
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "result": {
    "suggest": "risky",
    "label": 20001
  },
  "detail": [
    {
      "strategy": "content_model",
      "errcode": 0,
      "suggest": "risky",
      "label": 20006,
      "prob": 90
    },
    {
      "strategy": "keyword",
      "errcode": 0,
      "suggest": "pass",
      "label": 20006,
      "level": 20,
      "keyword": "命中的关键词1"
    },
    {
      "strategy": "keyword",
      "errcode": 0,
      "suggest": "risky",
      "label": 20006,
      "level": 90,
      "keyword": "命中的关键词2"
    }
  ],
  "trace_id": "60ae120f-371d5872-7941a05b"
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	access_token 无效或不为最新获取的 access_token，请开发者确认access_token的有效性
40003	invalid openid	不合法的 OpenID ，请开发者确认 OpenID 的有效性
40129	invalid scene	场景值错误（目前支持场景 1 资料；2 评论；3 论坛；4 社交日志）
43002	require POST method	方法调用错误，请用 post 方法调用
43104	The openid does not match the appid	appid与 openid 不匹配
44002	empty post data	POST 的数据包为空。post请求body参数不能为空。
44991	reach max api minute frequence	超出接口每分钟调用限制
45009	reach max api daily quota limit	超出接口每日调用限制
47001	data format error	解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
61010	code is expired	用户访问记录超时（用户未在近两小时访问小程序）

# 7. 适用范围

本接口在不同账号类型下的可调用情况：

小程序	小游戏
✔	✔

✔：该账号可调用此接口
其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；

# 文本内容安全识别

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# Res.detail(Array) Object Payload

# Res.result Object Payload

# 4. 注意事项

# 5. 代码示例

# 5.1 HTTPS调用

# 5.2 云函数调用

# 6. 错误码

# 7. 适用范围

# 查询参数 `Query String parameters`

# 请求体 `Request Payload`

# 返回体 `Response Payload`

# Res.detail(Array) `Object Payload`

# Res.result `Object Payload`