# 文本内容安全识别

该接口方法需要安装 小程序安全能力,如未安装需要前往安装才可以使用

# 接口英文名

wx_security_msg_sec_check

# 应用场景

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

# 调用方式

# 小程序端云能力初始化

参考使用指南-快速上手中小程序端初始化过程

# 调用 wx_security_msg_sec_check 接口

调用云模板提供的 wx_security_msg_sec_check 接口,来检查一段文本是否含有违法违规内容

例如,进行用户个人资料违规文字检测

wx.cloud.callFunction({
  name: 'cloudbase_module',
  data: {
    name: 'wx_security_msg_sec_check',
    data: {
      scene: 1, // 场景值 1, 代表资料
      version: 2, // 接口版本号,2.0版本为固定值2
      content: 'hello world!', // 要检测的内容
    },
  },
  success: (res) => {
    console.log('详细检测结果', res.result.detail);
    console.log('综合结果', res.result.result);
    console.log('错误码', res.result.errcode);
    console.log('错误信息', res.result.errmsg);
  },
});

# 注意事项

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

# 更多说明和错误码

请参考微信小程序 文本内容安全识别文档

# 入参:

参数 类型 必填 描述
content string 需检测的文本内容,文本字数的上限为2500字,需使用UTF-8编码
version number 接口版本号,2.0版本为固定值2
scene number 场景枚举值(1 资料;2 评论;3 论坛;4 社交日志)
openid string 用户的openid(用户需在近两小时访问过小程序),小程序前端调用时无需传递此参数,默认会用当前登录用户的 openid
title string 文本标题,需使用UTF-8编码
nickname string 用户昵称,需使用UTF-8编码
signature string 个性签名,该参数仅在资料类场景有效(scene=1),需使用UTF-8编码

# 出参:

参数 类型 描述
result object
result.errcode number 错误码
result.errmsg string 错误信息
result.detail array of object
result.detail[].strategy string 策略类型
result.detail[].errcode number 错误码,仅当该值为0时,该项结果有效
result.detail[].suggest string 建议,有risky、pass、review三种值
result.detail[].label number 命中标签枚举值,100 正常;10001 广告;20001 时政;20002 色情;20003 辱骂;20006 违法犯罪;20008 欺诈;20012 低俗;20013 版权;21000 其他
result.detail[].keyword string 命中的自定义关键词
result.detail[].prob number 0-100,代表置信度,越高代表越有可能属于当前返回的标签(label)
result.trace_id string 唯一请求标识,标记单次请求
result.result object
result.result.suggest string 建议,有risky、pass、review三种值
result.result.label number 命中标签枚举值,100 正常;10001 广告;20001 时政;20002 色情;20003 辱骂;20006 违法犯罪;20008 欺诈;20012 低俗;20013 版权;21000 其他
errMsg string 云开发错误信息
requestID string 云开发开发请求 ID