{% block pageTitile %}

检测违规图片、音频、文本

{% endblock pageTitile %}

当小程序中有允许用户上传图片或输入文本的场景时,SDK 封装了微信小程序“内容安全”检测图片、文本的合法性的 API。

关于这两个接口的频次限制及效果说明,请参阅微信官方文档:内容安全-小程序

{% block tips1 %}

info 以下操作仅适用于 SDK version >= 1.7.0

使用此 API 前需要配置 AppSecret,请前往 设置 - 小程序 中配置 AppSecret。

如果您使用的是文件版 sdk,请在微信后台将您的 request 合法域名中知晓云域名(形如 xxx.myminapp.com)添加到 uploadFile 合法域名中,如下图所示: 配置 uploadFile 域名

{% endblock tips1 %}

{% block censorImageSign %}

检测违规图片

wx.BaaS.wxCensorImage(filePath)

参数说明

参数名 类型 说明
filePath String 文件路径

返回参数说明

参数名 类型 说明
risky Boolean 是否为违规内容,true 为风险,false 为未检测到风险,null 为微信尚未推送检查结果

{% endblock censorImageSign %}

返回示例

  1. {
  2. risky: true
  3. }

{% block censorImageCode %}

示例代码

  1. wx.chooseImage({
  2. success: function(res) {
  3. wx.BaaS.wxCensorImage(res.tempFilePaths[0]).then(res => {
  4. console.log(res.data.risky)
  5. }, err => {
  6. // HError 对象
  7. })
  8. }})

HError 对象结构请参考错误码和 HError 对象

{% endblock censorImageCode %}

{% block censorTextSign %}

检测违规文本

wx.BaaS.wxCensorText(text) {% endblock censorTextSign %}

参数说明

参数名 类型 说明
text String 要检测的文本

返回参数说明

参数名 类型 说明
risky Boolean 是否为违规内容,true 为风险,false 为未检测到风险,null 为微信尚未推送检查结果

返回示例

  1. {
  2. risky: true
  3. }

示例代码

{% block censorTextCode %}

  1. wx.BaaS.wxCensorText("测试文本").then(res => {
  2. console.log(res.data.risky)
  3. }, err => {
  4. // HError 对象
  5. })

HError 对象结构请参考错误码和 HError 对象

{% endblock censorTextCode %}

{% block censorAsync %}

{% macro returns() %} 返回参数说明

参数名 类型 说明
id String 检测记录 id
error_code Integer 错误码
error_message String 错误信息
status_code Number 默认为:0,4294966288(-1008)为链接无法下载
risky Boolean 是否为违规内容,true 为风险,false 为未检测到风险,null 为微信尚未推送检查结果

{% endmacro %}

异步检测图片、音频

异步校验图片/音频是否含有违法违规内容。

检测请求

wx.BaaS.censorAsync(fileID)

参数说明

参数名 类型 说明
fileID String 文件 ID

{{returns()}}

返回示例

  1. {
  2. "error_message": "ok",
  3. "error_code": 0,
  4. "risky": null,
  5. "status_code": null,
  6. "id": 1
  7. }

状态码

状态码 说明
201 成功
400 失败(参数错误)
402 当前应用已欠费
404 文件不存在
500 服务错误

HError 对象结构请参考错误码和 HError 对象

示例代码

  1. wx.BaaS.censorAsync("...").then(res => {
  2. console.log(res.data.risky)
  3. }, err => {
  4. // HError 对象
  5. })

获取异步检测结果

wx.BaaS.getCensorResult(id)

参数说明

参数名 类型 说明
id String 检测记录 id

{{returns()}}

返回示例

  1. {
  2. "error_message": "ok",
  3. "error_code": 0,
  4. "risky": null,
  5. "status_code": null,
  6. "id": 1
  7. }

状态码

状态码 说明
200 成功
404 检测记录不存在

HError 对象结构请参考错误码和 HError 对象

示例代码

  1. wx.BaaS.getCensorResult("...").then(res => {
  2. console.log(res.data.risky)
  3. }, err => {
  4. // HError 对象
  5. })

{% endblock censorAsync %}