任务提交
更新时间:
接口概览
POSThttps://isafe.ilivedata.com/api/v2/image/batchCheck/async
图片异步批量检测接口,图片信息提交后,会对图片进行检测,检测结果会通过回调方式返回,回调配置可在控制台服务配置中配置或者通过参数传入。
图片要求
图片支持类型:URL, BASE64
图片支持格式:jpg, png, bmp, gif, webp, tiff, heic, avif
图片大小:单张 < 10M
gif 图、长图说明:自动将 gif 图、长图(长宽比大于 5 的图片)截帧过检,最多 5 张,gif 图、长图均按照实际截图张数进行计费
请求参数
请求头
Header
值
描述
Content-Type
application/json;charset=UTF-8
请求体类型
Accept
application/json;charset=UTF-8
接受的返回类型
X-AppId
—
项目的唯一标识,此值是 「控制台 → 服务配置」 中的项目编号
X-TimeStamp
—
请求发起时的 UTC 时间,采用 W3C 格式。
格式示例:2026-09-30T02:30:00Z,实际请求需使用当前时间。
Authorization
—
签名值
请求体
参数
类型
是否必需
描述
images
Array
必需
待检测图片数组,数组长度不超过 20,元素结构见下表
requestId
String
可选
请求 ID,用于标识本次批量请求的父级请求 ID;未传入时由服务端随机生成
callbackUrl
String
可选
回调 URL(http 协议);通过接口指定时,必须同时传入 callbackSecretKey
callbackSecretKey
String
可选
回调验签密钥,需与回调验签使用的密钥一致
callbackWaitForAll
Boolean
可选
是否等待所有审核处理完成后再回调。为 true 时回调按照 批量回调协议 推送,否则按照 单条回调协议 推送
images[].type
Number
必需
图片内容类型:1:图片 URL;2:图片 BASE64 值
images[].image
String
必需
图片内容。type=1 时为图片 URL;type=2 时为图片 BASE64 值
images[].strategyId
String
可选
策略编号;不传时使用默认策略 DEFAULT
images[].checkTags
List<Number>
可选
限定检测类别,支持传入策略中开启的一级类别
images[].referImage
String
可选
人脸对比参照图,类型需与 image 一致。支持格式:jpg, png;大小 < 10M
images[].userId
String
可选
唯一的终端用户 ID,不超过 32 个字符
images[].extra
Object
可选
扩展透传字段。不得超过 20 个 key/value,单个 key 不得嵌套超过 3 层;若超出限制,后台审核日志将不会记录本次任务的 extra 值,但不影响 extra 透传响应
请求示例
{
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"images": [
{
"type": 1,
"image": "http://abc.com/a.jpg",
"userId": "123"
},
{
"type": 1,
"image": "http://abc.com/b.jpg",
"userId": "123"
}
],
"callbackUrl": "http://your.callback.url/batchCallback",
"callbackSecretKey": "your-callback-secret",
"callbackWaitForAll": true
}
请求签名
签名计算规则见帮助中心的请求签名。本接口使用以下参数:
签名参数
值
HTTPMethod
POST
HostHeaderInLowercase
isafe.ilivedata.com
HTTPRequestURI
/api/v2/image/batchCheck/async
HTTP 响应
Content-Type: application/json;charset=UTF-8
返回为 JSON 对象,结构如下:
参数
类型
描述
errorCode
Number
错误码:任一单条结果 errorCode 为 0 时为 0;全部非 0 时取第一条结果的 errorCode
requestId
String
请求 ID,标识本次批量请求的父级请求 ID
result
Array
提交结果数组,每个元素对应请求 images 中的一张图片
result 数组元素字段说明
字段名
类型
描述
errorCode
Number
错误码:0 表示成功
errorMessage
String
错误消息
taskId
String
任务 ID,用于关联回调结果
响应示例
{
"errorCode": 0,
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"result": [
{
"errorCode": 0,
"taskId": "ap_99b2bf004d4a4591bfedbba9574e74d4_1702882338368"
},
{
"errorCode": 0,
"taskId": "ap_d8d58cc2ecf14edaafd18692997a1f67_1702882338368"
}
]
}
错误码
详见帮助中心的通用错误码
接口概览
POST
https://isafe.ilivedata.com/api/v2/image/batchCheck/async图片异步批量检测接口,图片信息提交后,会对图片进行检测,检测结果会通过回调方式返回,回调配置可在控制台服务配置中配置或者通过参数传入。
图片要求
图片支持类型:URL, BASE64
图片支持格式:jpg, png, bmp, gif, webp, tiff, heic, avif
图片大小:单张 < 10M
gif 图、长图说明:自动将 gif 图、长图(长宽比大于 5 的图片)截帧过检,最多 5 张,gif 图、长图均按照实际截图张数进行计费
请求参数
请求头
| Header | 值 | 描述 |
|---|---|---|
Content-Type |
application/json;charset=UTF-8 | 请求体类型 |
Accept |
application/json;charset=UTF-8 | 接受的返回类型 |
X-AppId |
— | 项目的唯一标识,此值是 「控制台 → 服务配置」 中的项目编号 |
X-TimeStamp |
— | 请求发起时的 UTC 时间,采用 W3C 格式。 格式示例: 2026-09-30T02:30:00Z,实际请求需使用当前时间。 |
Authorization |
— | 签名值 |
请求体
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
images |
Array | 必需 | 待检测图片数组,数组长度不超过 20,元素结构见下表 |
requestId |
String | 可选 | 请求 ID,用于标识本次批量请求的父级请求 ID;未传入时由服务端随机生成 |
callbackUrl |
String | 可选 | 回调 URL(http 协议);通过接口指定时,必须同时传入 callbackSecretKey |
callbackSecretKey |
String | 可选 | 回调验签密钥,需与回调验签使用的密钥一致 |
callbackWaitForAll |
Boolean | 可选 | 是否等待所有审核处理完成后再回调。为 true 时回调按照 批量回调协议 推送,否则按照 单条回调协议 推送 |
images[].type |
Number | 必需 | 图片内容类型:1:图片 URL;2:图片 BASE64 值 |
images[].image |
String | 必需 | 图片内容。type=1 时为图片 URL;type=2 时为图片 BASE64 值 |
images[].strategyId |
String | 可选 | 策略编号;不传时使用默认策略 DEFAULT |
images[].checkTags |
List<Number> | 可选 | 限定检测类别,支持传入策略中开启的一级类别 |
images[].referImage |
String | 可选 | 人脸对比参照图,类型需与 image 一致。支持格式:jpg, png;大小 < 10M |
images[].userId |
String | 可选 | 唯一的终端用户 ID,不超过 32 个字符 |
images[].extra |
Object | 可选 | 扩展透传字段。不得超过 20 个 key/value,单个 key 不得嵌套超过 3 层;若超出限制,后台审核日志将不会记录本次任务的 extra 值,但不影响 extra 透传响应 |
请求示例
{
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"images": [
{
"type": 1,
"image": "http://abc.com/a.jpg",
"userId": "123"
},
{
"type": 1,
"image": "http://abc.com/b.jpg",
"userId": "123"
}
],
"callbackUrl": "http://your.callback.url/batchCallback",
"callbackSecretKey": "your-callback-secret",
"callbackWaitForAll": true
}
请求签名
签名计算规则见帮助中心的请求签名。本接口使用以下参数:
| 签名参数 | 值 |
|---|---|
HTTPMethod |
POST |
HostHeaderInLowercase |
isafe.ilivedata.com |
HTTPRequestURI |
/api/v2/image/batchCheck/async |
HTTP 响应
Content-Type: application/json;charset=UTF-8
返回为 JSON 对象,结构如下:
| 参数 | 类型 | 描述 |
|---|---|---|
errorCode |
Number | 错误码:任一单条结果 errorCode 为 0 时为 0;全部非 0 时取第一条结果的 errorCode |
requestId |
String | 请求 ID,标识本次批量请求的父级请求 ID |
result |
Array | 提交结果数组,每个元素对应请求 images 中的一张图片 |
result 数组元素字段说明
| 字段名 | 类型 | 描述 |
|---|---|---|
errorCode |
Number | 错误码:0 表示成功 |
errorMessage |
String | 错误消息 |
taskId |
String | 任务 ID,用于关联回调结果 |
响应示例
{
"errorCode": 0,
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"result": [
{
"errorCode": 0,
"taskId": "ap_99b2bf004d4a4591bfedbba9574e74d4_1702882338368"
},
{
"errorCode": 0,
"taskId": "ap_d8d58cc2ecf14edaafd18692997a1f67_1702882338368"
}
]
}
错误码
详见帮助中心的通用错误码