请求规范

请求地址

POST https://isafe.ilivedata.com/api/v1/image/check

图片要求

  • 支持传入图片 URL 或 Base64 编码。
  • 支持格式:jpgpngbmpgifwebptiffheic
  • 单张图片不超过 10 MB。
  • GIF 和长图(长宽比大于 5)会自动截帧检测,最多检测 5 帧,并按实际截帧数量计费。

请求头

Header 说明
Content-Type application/json;charset=UTF-8 请求体类型
Accept application/json;charset=UTF-8 期望的响应类型
X-AppId 项目编号 控制台「服务配置」中的项目唯一标识
X-TimeStamp UTC 时间戳 W3C 日期时间格式,例如 2010-01-31T23:59:59Z
Authorization 签名值 按下文规则计算

请求体参数

参数 必填 类型 说明
type Number 图片来源:1 表示 URL,2 表示 Base64。图片资源与审核服务不在同一区域时,建议使用 Base64,避免因网络问题导致下载慢或失败。
image String 图片内容。type=1 时为图片 URL;type=2 时为图片 Base64 值。
strategyId String 策略编号;不传时使用默认策略 DEFAULT
checkTags List<Number> 限定检测类别。仅支持传入当前策略已开启的一级类别;未开启的类别会被忽略。
referImage String 人脸对比参考图。类型必须与 image 一致;支持 jpgpng,大小不超过 10 MB。
userId String 终端用户唯一 ID,最长 32 个字符。
userIP String 用户 IP 地址。
did String 用户设备 ID。
dtype String 设备类型:1 iPhone、2 Android、3 iPad、4 Windows Phone、5 PC、6 Web、7 WAP。
id String 用户设备 ID。
extra Object 透传扩展字段,可包含多个键值对。

请求示例

{
  "type": 2,
  "image": "T2dnUwACAAAAAAAAAAAd8pVTAAAAAGsIvpMBE...",
  "strategyId": "123",
  "userId": "testUser",
  "did": "868034031518269",
  "dtype": "1",
  "extra": {
    "server": "123",
    "version": "456"
  }
}

请求签名

使用控制台「服务配置」中的 appIdsecretKey 对请求签名,并将签名值放入 Authorization 请求头:

Authorization: <signature>

签名计算步骤和示例请参见统一签名规则。签名不一致或当前 appId 无权访问请求资源时,接口会返回 401

HTTP 响应

响应类型为 application/json;charset=UTF-8

顶层字段

参数 类型 说明
errorCode Number 错误码;0 表示成功。
errorMessage String 错误消息。
imageSpams Array 单图检测结果数组。
labels Array 标签信息。
code Number 状态码:0 检测成功、1 图片下载失败、2 图片格式错误、3 其他错误。
result Number 检测结论:0 通过、1 建议审核、2 不通过。
taskId String 任务 ID。
extraInfo Object 扩展检测信息。

imageSpams 字段

参数 类型 说明
code Number 状态码:0 检测成功、1 图片下载失败、2 图片格式错误、3 其他错误。
result Number 检测结论:0 通过、1 建议审核、2 不通过。
tags Array 分类信息。

labels 字段

参数 类型 说明
id Number 标签唯一标识。
name String 标签名称。
nameEn String 标签英文名称。
score Number 模型得分;数值越高,置信度越高。

extraInfo 字段

参数 类型 说明
cartoonScore Number 卡通画风得分,范围为 0–100;越高越接近卡通画风。
genderResult Array 人脸性别及对应置信度。每项包含 gendermalefemale)和 confidence(性别置信度)。
numHuman Number 检出的人体数量。
numFace Number 检出的人脸数量。

tags 字段

参数 类型 说明
tag Number 一级分类编码:100 涉政、110 暴恐、120 违禁、130 色情、140 性感、150 广告、160 涉价值观、180 未成年保护、200 二维码、230 无人脸挂机、232 图片质量、300 图标、400 图文、666 恶心、800 标签、888 人脸对比、900 其他、999 用户自定义。
level Number 分类级别:0 正常、1 疑似、2 异常。
confidence Number 置信度,范围为 0–100。对于疑似或异常结果,数值越高表示命中风险的可能性越高。
tagName String 命中的一级类型名称。
tagNameEn String 命中的一级类型英文名称。
subTags Array 敏感信息的二级分类。
wordList Array<String> 命中图文时返回(tag=400)。

subTags 字段

参数 类型 说明
subTag Number 二级分类编码,详见分类编码对照表
subTagName String 命中的二级类型名称。
subTagNameEn String 命中的二级类型英文名称。
level Number 分类级别:0 正常、1 疑似、2 异常。
confidence Number 置信度,范围为 0–100。对于疑似或异常结果,数值越高表示命中风险的可能性越高。
terTags Array 命中的三级分类信息。
wordList Array<String> 命中图文时返回(tag=400)。

terTags 字段

参数 类型 说明
terTag Number 三级分类编码。
terTagName String 命中的三级类型名称。
terTagNameEn String 命中的三级类型英文名称。
level Number 分类级别:0 正常、1 疑似、2 异常。
confidence Number 置信度,范围为 0–100。对于疑似或异常结果,数值越高表示命中风险的可能性越高。

响应示例

{
  "errorCode": 0,
  "code": 0,
  "result": 2,
  "imageSpams": [
    {
      "code": 0,
      "result": 2,
      "tags": [
        {
          "tag": 200,
          "level": 2,
          "confidence": 76
        }
      ]
    }
  ],
  "gender": [],
  "taskId": "Telnet-test_d56b5c2d38614be3bf1a1e98663d3c29_1653017203620",
  "extraInfo": {
    "cartoonScore": 7,
    "genderResult": [],
    "numHuman": 0,
    "numFace": 0
  }
}

错误码

HTTP 状态码 错误码 错误消息
200 0 此字段省略
405 1004 Method Not Allowed
411 1007 Not Content Length
400 1002 API Not Found
400 1003 Bad Request
401 1102 Unauthorized Client
401 1106 Missing Access Token
401 1107 Invalid Token
401 1108 Expired Token
401 1110 Invalid Client
401 2000 Missing Parameter
401 2001 Invalid Parameter
429 1104 Out of Rate Limit
429 1105 Bandwidth limit exceeded