## 接口地址
[https://as.dun.163.com/v1/keyword/submit](https://as.dun.163.com/v1/keyword/submit)

## 接口描述
可以通过此接口将自定义的关键词抄送到易盾，命中关键词后默认返回不通过，产品可对数据做删除隐藏处理。建议您使用POST请求, 且仅接受 application/x-www-form-urlencoded 编码格式。

## 请求参数
KeywordBatchSubmitReq结构如下：

| 参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
|-----------|-------|------|-------------------|-------|
| secretId | String | Y |  | 产品秘钥 id ，由易盾内容安全服务分配，产品标识 |
| businessId | String | Y |  | 业务id ，由易盾内容安全服务分配，业务标识 |
| timestamp | Long | Y | 13位时间毫秒数 | 请求当前 UNIX 时间戳，请注意服务器时间是否同步 |
| nonce | Integer | Y | 1-65535 | 随机正整数，与 timestamp 联合起来，用于防止重放攻击 |
| version | String | Y | v1 | 接口版本号，可选值 v1 |
| signature | String | Y | [见官网签名计算方法](https://support.dun.163.com/documents/2018041901?docId=150425561197629440) | 请求签名，用来验证此次请求的合法性 |
| category | Integer | Y |  | 关键词返回的垃圾分类，100: 色情，200: 广告，210: 二维码，260：广告法，300: 暴恐，400: 违禁，500: 涉政，600: 谩骂，700: 灌水，1100：涉价值观 |
| subLabel | String | N |  | 关键词返回的垃圾细分类，详见 [sublabel代码表](https://support.dun.163.com/documents/2018041901?docId=444281309180616704)，注意：细分类必须与分类信息对应，自定义细分类请咨询易盾策略经理获取 |
| keywords | Set<String> | Y | 200条/次，128位/条 | 关键词检测列表 |
| level | Integer | Y |  | 关键词等级，1: 嫌疑，2: 不通过 |
| type | Integer | Y | | 关键词类型，1: 普通词，2: 组合词，3: 拼音词  |
	
### 关键词类型说明
   
	组合关键词添加，选择关键词类型：普通组合词，添加格式: (关键词1+关键词2+关键词3...)，多个词同时出现时会命中，组合关键词个数限制为2-5个，其中关键词格式支持 纯中文/纯英文字母/纯数字或中文、英文字母与数字任意组合，关键词之间不允许重复。
 
	拼音关键词添加，选择关键词类型：拼音词，格式仅支持中文填写，中文长度必须大于1。
	
	单次提交只能指定一种关键词类型提交，不支持混合提交，例如提交组合词，需要全部提交组合词类型。

## 请求响应
返回通用结构：

| 参数名称 | 数据类型 | 是否必填 | 描述 |
|-----------|-------|------|------|
| code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
| msg | String | Y | 返回错误消息 |
| result | List<BatchSubmitKeywordResp> | Y | 提交关键词内容、id列表 |

BatchSubmitKeywordResp结构：

| 参数名称 | 数据类型 | 是否必填 |       描述       |
|-----------|-------|------|------|
| keyword  |  String  |    Y     | 提交的关键词内容 |
|    id    |   Long   |    Y     |  提交的关键词id  |
	
## 请求响应示例
关键词提交接口请求Demo示例详见[https://github.com/yidun](https://github.com/yidun)各语言项目keyword_submit接口，请求响应示例如下：

```
Request: {
    "signature": "signature",
    "businessId": "your_business_id",
    "secretId": "your_secret_id",
    "nonce": 16163,
    "version": "v1",
    "timestamp": 1574653947813,
    "category": 100,
    "subLabel":"100001",
    "level":2,
    "type":2,
    "keywords": [
        "(色情关键词1+色情关键词2+色情关键词3)",
    ]
}

Response: {
    "code": 200,
    "msg": "ok",
    "result": [
    		{
    		   keyword: "(色情关键词1+色情关键词2+色情关键词3)",
    		   id: 163
    		}
    ]
}
```