支付宝小程序API 图片内容安全

2020-09-16 15:50 更新

my.ap.imgRisk

版本需求:基础库 1.14.0 或更高版本,若版本较低,建议做 兼容处理

图片风险任务提交接口,用于识别图片是否有色情、违禁违法等内容。有关图片内容安全的产品和接入介绍。

接口说明

此接口为异步请求接口,首先需要发起风险识别请求,获取任务 ID。等待 500 毫秒(ms)后再通过任务 ID 请求结果。

1. 调用参数说明

  • 通过传输图片内容判断此图片信息中是否包含风险信息,图片需要传输URL。
  • 图片必须是公网可以访问的图片,如果有加密或者限权,则无法返回结果。

2. 返回参数说明

  • REJECTED:拒绝,代表此图片风险程度高,不能发布展示。
  • PASSED:通过,代表此图片的风险程度低,可以发布展示。

3. 图片风险任务提交

示例代码

my.ap.imgRisk
  ({pid:'xxxxxxxxxxxxxxxx',  
    appId:'xxxxxxxxxxxxxxxx',  
    bizContext:
    {"risk_type":"img_risk",
     "content": "http://www.xxxxxx.com.cn//xxxxxx/xxxxxxx/images/xxxx/xx/xxx.png"
    },
  success(e) {
  },
})

入参

Object 类型,属性如下:

属性 类型 必填 描述
pid String 合作者身份 ID。即商户与支付宝签约后,商户获得的支付宝商户唯一识别码。
appId String 小程序的 APPID。
bizContext Map 需要识别的业务参数。
success Function 调用成功的回调函数。
fail Function 调用失败的回调函数。
complete Function 调用结束的回调函数(调用成功、失败都会执行)。

bizContext 属性说明

属性 类型 必填 最大长度 描述 示例值
risk_type String 1024 风险类型。 固定传 img_risk
content String 128 需要验证的图片 URL。 https://ss1.bdstatic.com/70cFvXSh_Q1YnxGkpoWK1HF6hhy/it/u=3180559933,1841450308&fm=26&gp=0.jpg

success 回调函数

Object 类型,属性如下:

属性 类型 最大长度 描述 示例值
riskResult String 128 图片风险识别的任务的任务ID。 \"apply_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\
riskResultDesc String 1024 风险识别结果描述。 返回结果会默认为空,忽略即可
success Boolean - 是否调用成功。 true
uniqueId String 1024 业务唯一识别码。 xxxxxxxxxxxxxxxxx

fail 回调函数

Object 类型,属性如下:

属性 类型 描述
errorCode String 错误码。
errorMessage String 错误信息。

my.ap.imgRiskCallback

版本需求:基础库 1.14.0 或更高版本,若版本较低,建议做 兼容处理

查询图片的风险识别结果。有关图片内容安全的产品和接入介绍。

接口说明

此接口为异步请求接口。首先需要发起风险识别请求,获取任务 ID,等待 500 毫秒(ms)后再通过任务 ID 请求结果。

1. 调用参数说明

  • 通过传输图片内容判断此图片信息中是否包含风险信息,图片需要传输 URL。
  • 图片必须是公网可以访问的图片,如果有加密或者限权,则无法返回结果。

2. 返回参数说明

  • REJECTED:拒绝,代表此图片风险程度高,不能发布展示。
  • PASSED:通过,代表此图片的风险程度低,可以发布展示。

示例代码

my.ap.imgRiskCallback
    ({pid:'xxxxxxxxxxxxxxxx',  
        appId:'xxxxxxxxxxxxxxxx',  
        bizContext:{
            "risk_type": "img_risk_result",
            "apply_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
  success(e) {
  },
})

入参

Object 类型,属性如下:

属性 类型 必填 描述
pid String 小程序的开放平台账号。
appId StringArray 小程序对应的 APPID。
bizContext Map 需要识别的业务参数。
success Function 调用成功的回调函数。
fail Function 调用失败的回调函数。
complete Function 调用结束的回调函数(调用成功、失败都会执行)。

bizContext 属性说明

参数 类型 必填 最大长度 描述 示例值
risk_type String 1024 风险类型。 固定传 img_risk_result
apply_id String 128 需要查询图片的任务 ID。 2eee1a72-4f32-45d6-bfa3-0f7173cde80b

success 回调函数

Object 类型,属性如下:

参数 类型 最大长度 描述 示例值
riskResult String 128 图片风险识别的任务的任务 ID。 \"action\":\"REJECTED\" \"action\":\"PASSED\"
riskResultDesc String 1024 风险识别结果描述。 \"REJECTED\":\"拦截\" \"PASSED\":\"放过\
success Boolean - 是否调用成功。 true
uniqueId String 1024 业务唯一识别码 0b92uueie87636222

fail 回调函数

Object 类型,属性如下:

属性 类型 描述
errorCode String 错误码。
errorMessage String 错误信息。

常见问题

报错说明

错误码(errorMessage) 错误明细 解决方案
serviceNoAuth 服务未授权。 请检查配置的账户是否已签约响应的功能包。
riskTypeNoAuth 场景(risktype)未授权。 请检查配置的账户是否已签约响应的功能包,请检查 risktype 参数是否正确。
bizContentEmpty 风险数据内容为空。 检查入参数据格式。
paramMissingError 参数缺失。 检查必传参数是否传入。
param error 参数错误。 检查入参格式是否符合文档要求。
SYSTEM_OUT_ERROR 系统繁忙。 请稍后再试。
INVALID_PARAMETER 缺少必选参数或参数有误。 检查参数是否正确或者缺失。
OVER_LIMIT 超过调用量限制。 如需增加额度,请发邮件至 RiskGoCSC@service.alipay.com 进行申请。

Q:没有返回识别结果该怎么处理?

A:确认风险识别的任务 ID,为此图片对应的任务 ID。

500ms 后若返回空,建议等待 500ms 后重试。一共重试 3 次,若全为空,尝试重新提交审核任务。

Q:图片说明格式以及大小?

A:

图片格式支持:BMP, PNG, JPEG, TIFF, SVG, ICO

图片大小:0~10MB

图片的 URL 需要可访问。如果出现无法访问,下载失败,非图片格式会返回通过。

Q:调用频率是怎样的?

A:不要并发调用。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号