同步批量检测
更新时间:
请求规范
- 请求 URL:
https://isafe.ilivedata.com/api/v2/image/batchCheck
-
图片要求:
- 图片支持类型：URL, BASE64
- 图片支持格式：jpg, png, bmp, gif, webp, tiff, heic
- 图片大小：单张 < 10M
- gif 图、长图说明：自动将 gif 图、长图（长宽比大于 5 的图片）截帧过检，最多 5 张，gif 图、长图均按照实际截图张数进行计费
-
HTTP 请求 Header:
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。 (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization
签名值
-
请求方法：POST
-
请求体 JSON 对象：
参数
是否必需
类型
描述
images
必需
json 数组
待检测图片数组，数组长度不超过 20，元素结构见下表
requestId
可选
String
请求 ID，用于标识本次批量请求的父级请求 ID；未传入时由服务端随机生成
- images 数组元素结构：
参数
是否必需
类型
描述
type
必需
Number
图片内容类型：1：图片 URL；2：图片 BASE64 值
image
必需
String
图片内容。type=1 时为图片 URL；type=2 时为图片 BASE64 值
strategyId
可选
String
策略编号；不传时使用默认策略 DEFAULT
checkTags
可选
List<Number>
限定检测类别，支持传入策略中开启的一级类别
referImage
可选
String
人脸对比参照图，类型需与 image 一致。支持格式：jpg, png；大小 < 10M
userId
可选
String
唯一的终端用户 ID，不超过 32 个字符
extra
可选
json
扩展透传字段。不得超过 20 个 key/value，单个 key 不得嵌套超过 3 层；若超出限制，后台审核日志将不会记录本次任务的 extra 值，但不影响 extra 透传响应
- 请求体示例：
{
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"images": [
{
"type": 1,
"image": "http://abc.com/a.jpg",
"userId": "testUser1"
},
{
"type": 2,
"image": "T2dnUwACAAAAAAAAAAAd8pVTAAAAAGsIvpMBE...",
"userId": "testUser2"
}
]
}
- 请求签名：
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。HTTPRequestURI 使用 /api/v2/image/batchCheck。
HTTP 响应
Content-Type: application/json;charset=UTF-8
返回为 JSON 对象，结构如下：
参数
类型
描述
errorCode
Number
错误码：任一单条结果 errorCode 为 0 时为 0；全部非 0 时取第一条结果的 errorCode
requestId
String
请求 ID，标识本次批量请求的父级请求 ID
result
json 数组
检测结果数组，每个元素对应请求 images 中的一张图片
- result 数组元素结构：
结构同单条检测响应，并额外包含以下字段：
参数
类型
描述
index
Number
对应请求参数 images 的数组下标
其余字段（errorCode、errorMessage、result、taskId、mediaType、snapshotUrl、imageSpams、ocr、personInfo、labels、extra）说明详见 同步单条检测（V2）- HTTP 响应。
- 返回结果示例：
{
"errorCode": 0,
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"result": [
{
"index": 0,
"errorCode": 0,
"result": 2,
"taskId": "ap_634e686ef7e54447af7463f4dd060d6d_1783514588456",
"imageSpams": {
"tags": [
{
"tag": 130,
"level": 2,
"confidence": 100,
"nameZh": "色情",
"nameEn": "porn",
"subTags": [
{
"subTag": 130001,
"level": 2,
"confidence": 100,
"nameZh": "女胸裸露",
"nameEn": "bare breasts"
}
]
}
]
},
"personInfo": {
"human": { "number": 1 },
"face": { "number": 4 }
},
"extra": {}
},
{
"index": 1,
"errorCode": 0,
"result": 0,
"taskId": "ap_a868a01f9d8a45648df79a03cfa25bcb_1783514588456",
"imageSpams": { "tags": [] },
"extra": {}
}
]
}
错误码
详见帮助中心的常见异常码
请求规范
- 请求 URL:
https://isafe.ilivedata.com/api/v2/image/batchCheck
-
图片要求:
- 图片支持类型：URL, BASE64
- 图片支持格式：jpg, png, bmp, gif, webp, tiff, heic
- 图片大小：单张 < 10M
- gif 图、长图说明：自动将 gif 图、长图（长宽比大于 5 的图片）截帧过检，最多 5 张，gif 图、长图均按照实际截图张数进行计费
-
HTTP 请求 Header:
| 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。 (http://www.w3.org/TR/xmlschema-2/#dateTime)。 | |
| Authorization | 签名值 |
-
请求方法：POST
-
请求体 JSON 对象：
| 参数 | 是否必需 | 类型 | 描述 |
|---|---|---|---|
| images | 必需 | json 数组 | 待检测图片数组，数组长度不超过 20，元素结构见下表 |
| requestId | 可选 | String | 请求 ID，用于标识本次批量请求的父级请求 ID；未传入时由服务端随机生成 |
- images 数组元素结构：
| 参数 | 是否必需 | 类型 | 描述 |
|---|---|---|---|
| type | 必需 | Number | 图片内容类型：1：图片 URL；2：图片 BASE64 值 |
| image | 必需 | String | 图片内容。type=1 时为图片 URL；type=2 时为图片 BASE64 值 |
| strategyId | 可选 | String | 策略编号；不传时使用默认策略 DEFAULT |
| checkTags | 可选 | List<Number> | 限定检测类别，支持传入策略中开启的一级类别 |
| referImage | 可选 | String | 人脸对比参照图，类型需与 image 一致。支持格式：jpg, png；大小 < 10M |
| userId | 可选 | String | 唯一的终端用户 ID，不超过 32 个字符 |
| extra | 可选 | json | 扩展透传字段。不得超过 20 个 key/value，单个 key 不得嵌套超过 3 层；若超出限制，后台审核日志将不会记录本次任务的 extra 值，但不影响 extra 透传响应 |
- 请求体示例：
{
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"images": [
{
"type": 1,
"image": "http://abc.com/a.jpg",
"userId": "testUser1"
},
{
"type": 2,
"image": "T2dnUwACAAAAAAAAAAAd8pVTAAAAAGsIvpMBE...",
"userId": "testUser2"
}
]
}
- 请求签名：
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。HTTPRequestURI 使用 /api/v2/image/batchCheck。
HTTP 响应
Content-Type: application/json;charset=UTF-8
返回为 JSON 对象，结构如下：
| 参数 | 类型 | 描述 |
|---|---|---|
| errorCode | Number | 错误码：任一单条结果 errorCode 为 0 时为 0；全部非 0 时取第一条结果的 errorCode |
| requestId | String | 请求 ID，标识本次批量请求的父级请求 ID |
| result | json 数组 | 检测结果数组，每个元素对应请求 images 中的一张图片 |
- result 数组元素结构：
结构同单条检测响应，并额外包含以下字段：
| 参数 | 类型 | 描述 |
|---|---|---|
| index | Number | 对应请求参数 images 的数组下标 |
其余字段（errorCode、errorMessage、result、taskId、mediaType、snapshotUrl、imageSpams、ocr、personInfo、labels、extra）说明详见 同步单条检测（V2）- HTTP 响应。
- 返回结果示例：
{
"errorCode": 0,
"requestId": "batch_f1a2556604274a35831c0f07d4ecc8c2",
"result": [
{
"index": 0,
"errorCode": 0,
"result": 2,
"taskId": "ap_634e686ef7e54447af7463f4dd060d6d_1783514588456",
"imageSpams": {
"tags": [
{
"tag": 130,
"level": 2,
"confidence": 100,
"nameZh": "色情",
"nameEn": "porn",
"subTags": [
{
"subTag": 130001,
"level": 2,
"confidence": 100,
"nameZh": "女胸裸露",
"nameEn": "bare breasts"
}
]
}
]
},
"personInfo": {
"human": { "number": 1 },
"face": { "number": 4 }
},
"extra": {}
},
{
"index": 1,
"errorCode": 0,
"result": 0,
"taskId": "ap_a868a01f9d8a45648df79a03cfa25bcb_1783514588456",
"imageSpams": { "tags": [] },
"extra": {}
}
]
}
错误码
详见帮助中心的常见异常码