## 接口说明

通过该接口将自定义的图片名单抄送到易盾，命中名单后，产品可对数据做删除、隐藏处理。

### 鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持 MD5，SHA1，SHA256，SM3 几种加密算法，详细信息，请参见[接口鉴权](https://support.dun.163.com/documents/588434277524447232?docId=588511762054877184)

## 请求

### 请求地址

|名称|值|
|----|----|
|HTTP URL|[http://as.dun.163yun.com/v1/image/list/submit]()|
|HTTP Method|POST|

### 请求头

|名称|类型|描述|
|----|----|----|
|Content-Type|String|固定值："application/x-www-form-urlencoded"|


### 请求参数

请求参数由公共参数和业务参数两部分组成。

#### 公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见[请求公共参数](https://support.dun.163.com/documents/588434277524447232?docId=588517137346338816)


#### 业务参数


| 名称 | 类型 | 是否必填 | 最大长度 | 描述 |
| -------| -------| -------| ------- |------- |
| version | String | 是 | 4 |接口版本号，值为 v1 |
| listType | Integer | 是 |  | 名单分类，1：白名单，2：黑名单 |
| suspectLevel | Integer | 否 |  | 嫌疑级别，listType为2:黑名单时生效，1:嫌疑，2:确定，默认为 2:确定  |
| type | Integer | 是 |  | 名单类型，0：相似名单，1：md5 精确名单 |
| imageLabel | Integer | 是 |  | 名单分类（加黑名单时传），100：色情，110：性感低俗，200：广告，210：二维码，260：广告法，300：暴恐，400：违禁，500：涉政，800：恶心类，900：其他，1100：涉价值观 |
| imageSubLabel | String | 否 |  | 名单细分类，非必传，详细编码请参考标签对照表，请定期通过标签接口获取最新的标签信息，避免遗漏新标签风险 |
| images | String | 是 | 最多 200 条 | 名单列表，json 数组格式 |
| tagGroup | String | 否 |  | 名单分组标识 |
| tagName | String | 否 |  | 名单标识 |
| description | String | 否 |  | 描述 |

### 请求体示例

```
signature=signature&secretId=your_secret_id&businessId=your_businessId_id&nonce=16163&version=v1&timestamp=1574653947813&imageLabel=100&listType=2&type=0&description=test&images=["http://n1.itc.cn/img8/wb/sohulife/2020/09/04/159920645893400468.JPEG"]
```

## 响应

### 响应结果

响应字段如下，响应公共字段已省略，详细见[响应公共字段](https://support.dun.163.com/documents/588434277524447232?docId=588517430350548992)：


| 名称 | 类型 | 是否返回 | 描述 |
|--------|--------|--------|--------|
|result| Object[] | 是 | 提交返回结果 |
| ∟ success | Long | 是 | 成功数量 |
| ∟ fail | Long | 是 | 失败数量 |
| ∟ successImages | Object[] | 是 | 成功的图片信息 |
|  ∟ image | String | 是 | 图片地址 |
|  ∟ uuid | String | 是 | 图片唯一标识 |
|  ∟ md5 | String | 是 | 图片md5 |
| ∟ failImages | Object[] | 是 | 失败的图片信息 |
|  ∟ image | String | 是 | 图片地址 |
|  ∟ failReason | Number | 是 | 失败原因：1000：图片上传失败，1001：相似图库只支持单帧图片 |


### 响应体示例

```
{
    "code": 200,
    "msg": "ok",
    "result": {
        "success": 1,
        "fail": 0,
        "successImages":[
            {
                "image":"http://n1.itc.cn/img8/wb/sohulife/2020/09/04/159920645893400468.JPEG",
                "uuid":"10c2d79984194d0d9dc21de327239d09",
                "md5":"ab26099a9b9ddaa47c16b8b736f23eca"
            }
        ]
    }
}
```
## 示例代码

### 服务端 SDK 接入

推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 [服务端 SDK 接入指引](https://support.dun.163.com/documents/594247746924453888?docId=682781209345695744) 了解更多。


#### Github Demo 地址    

- [Java SDK Demo](https://github.com/yidun/yidun-java-sdk/blob/main/yidun-java-sdk-demo/src/main/java/com/netease/yidun/sdk/antispam/list/imagelist/ImageListSubmitDemo.java)   

#### Gitee Demo 地址（Github 无法访问时选择）

- [Java SDK Demo](https://gitee.com/netease_yidun/yidun-java-sdk/blob/main/yidun-java-sdk-demo/src/main/java/com/netease/yidun/sdk/antispam/list/imagelist/ImageListSubmitDemo.java)

### HTTP API 接入
#### Github Demo 地址

- [Python Demo](https://github.com/yidun/antispam-python-demo/blob/master/image/imagelist_submit.py)
- [Golang Demo](https://github.com/yidun/antispam-go-demo/blob/master/image/list_submit/imagelist_submit.go)
- [Nodejs Demo](https://github.com/yidun/antispam-nodejs-demo/blob/master/imageListSubmitDemo.js)
- [Java Demo](https://github.com/yidun/antispam-java-demo/blob/master/src/main/java/com/netease/is/antispam/demo/image/ImageListSubmitAPIDemo.java)

#### Gitee Demo 地址（Github 无法访问时选择）

- [Python Demo](https://gitee.com/netease_yidun/antispam-python-demo/blob/master/image/imagelist_submit.py)
- [Golang Demo](https://gitee.com/netease_yidun/antispam-go-demo/blob/master/image/list_submit/imagelist_submit.go)
- [Nodejs Demo](https://gitee.com/netease_yidun/antispam-nodejs-demo/blob/master/imageListSubmitDemo.js)
- [Java Demo](https://gitee.com/netease_yidun/antispam-java-demo/blob/master/src/main/java/com/netease/is/antispam/demo/image/ImageListSubmitAPIDemo.java)