自定义关键词查询接口
2024.09.25 11:34:06
接口地址
https://as.dun.163yun.com/v1/keyword/query
接口描述
该接口适用于通过产品id、业务id等条件查询关键词场景。建议您使用POST请求, 且仅接受 application/x-www-form-urlencoded 编码格式。
请求参数
KeywordQueryReq结构如下：
| 参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
|---|---|---|---|---|
| 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 | 见官网签名计算方法 | 请求签名，用来验证此次请求的合法性 |
| id | Long | N | 2^63-1 | 关键词唯一标识id |
| keyword | String | N | 128 | 关键词内容 |
| category | Integer | N | 关键词分类，100: 色情，110: 性感低俗，200: 广告，210: 二维码，260：广告法，300: 暴恐，400: 违禁，500: 涉政，600: 谩骂，700: 灌水 | |
| orderType | Integer | N | 排序类型，1: CreateTime DESC，2: CreateTime ASC，3: ReleaseTime ASC，4: ReleaseTime DESC，5: ID ASC，6: ID DESC | |
| pageNum | Integer | Y | 1-65535 | 分页标号 |
| pageSize | Integer | Y | 1-1000 | 分页大小 |
请求响应
返回通用结构：
| 参数名称 | 数据类型 | 是否必填 | 描述 |
|---|---|---|---|
| code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
| msg | String | Y | 返回错误消息 |
| result | KeywordQueryResp | Y | 关键词查询返回 |
KeywordQueryResp结构：
| 参数名称 | 数据类型 | 是否必填 | 描述 |
|---|---|---|---|
| words | Page |
Y | 关键词查询内容返回 |
Page
| 参数名称 | 数据类型 | 是否必填 | 描述 |
|---|---|---|---|
| count | Long | Y | 数据总量 |
| rows | List |
Y | 分页数据 |
KeywordQueryUnit结构：
| 参数名称 | 数据类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Long | Y | 关键词id |
| word | String | Y | 关键词内容 |
| category | Integer | Y | 关键词垃圾分类，100: 色情，110: 性感低俗，200: 广告，210: 二维码，300: 暴恐，400: 违禁，500: 涉政，600: 谩骂，700: 灌水 |
| subLabel | String | N | 关键词返回的垃圾细分类，详见 sublabel代码表，注意：细分类必须与分类信息对应，自定义细分类请咨询易盾策略经理获取 |
| type | Integer | Y | 关键词类型，1: 普通词，2: 组合词，3: 拼音词 |
| status | Integer | Y | 关键词状态，0: 未生效，1: 已生效 |
| level | Integer | Y | 关键词等级，1: 嫌疑，2: 确定 |
| productId | Long | Y | 产品id |
| targetId | Long | Y | 业务id |
| updateTime | Long | Y | 关键词更新时间 |
请求响应示例
关键词查询接口请求Demo示例详见https://github.com/yidun各语言项目keyword_query接口，请求响应示例如下：
Request: {
"signature": "signature",
"businessId": "your_business_id",
"secretId": "your_secret_id",
"nonce": 16163,
"version": "v1",
"timestamp": 1574653947813,
"id": 163,
"category": 100,
"keyword": "色情关键词",
"orderType": 1,
"pageNum": 1,
"pageSize": 20
}
Response: {
"code": 200,
"msg": "ok",
"result": {
"words": {
"count": 100,
"rows": [{
"id": 163,
"word": "色情关键词",
"category": 100,
"subLabel":100001,
"type":1,
"status": 1,
"updateTime": 1574653947813,
"levle":2,
"productId":"产品编号",
"targetId":"业务id"
}]
}
}
}
