自定义关键词查询接口
2024.03.25 10:41:48
接口说明
通过该接口可以查询已抄送的自定义关键词信息
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
接口要求
- 接口需要分页查询
接口耗时
自定义关键词查询接口建议超时时间1s
请求
请求地址
| 名称 | 值 |
|---|---|
| HTTP URL | http://as.dun.163.com/v1/keyword/query |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| Content-Type | String | 是 |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 是否必填 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | 是 | 4 | 接口版本号，可选值v1 |
| id | Number | 否 | 2^63-1 | 关键词唯一标识id |
| keyword | String | 否 | 128 | 关键词内容 |
| category | Number | 否 | 4 | 关键词分类，100：色情，110：性感低俗，200：广告，210：二维码，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水 |
| orderType | Number | 否 | 4 | 排序类型，1：CreateTime DESC，2：CreateTime ASC，3：ReleaseTime ASC，4：ReleaseTime DESC，5：ID ASC，6：ID DESC |
| sceneName | String | 否 | 32 | 产品业务组名称，当该字段传值时，查询该产品业务组下的关键词，查询的产品必须属于这个产品业务组 |
| pageNum | Number | 是 | 4 | 分页标号,从1开始，如果传4代表从第4页返回内容 |
| pageSize | Number | 是 | 4 | 分页大小 |
请求体示例
version=v1&category=100&pageNum=1&pageSize=20&signature=xxx&secretId=xxx&businessId=xxx&nonce=420797907&pageNum=1×tamp=1662011841562
响应
响应结果
响应字段如下，响应通用字段已省略，详细见响应公共字段：
| 名称 | 类型 | 是否返回 | 描述 |
|---|---|---|---|
| result | Object | 是 | 响应结果 |
| ∟ words | Object | 是 | 关键词查询返回 |
| ∟ count | Long | 是 | 数据总量 |
| ∟ rows | Object[] | 否 | 分页数据 |
| ∟ id | Number | 是 | 关键词id |
| ∟ word | String | 是 | 关键词内容 |
| ∟ category | Number | 是 | 关键词垃圾分类，100：色情，110：性感，200：广告，210：二维码，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水 |
| ∟ subLabel | String | 否 | 细分类，详细编码请参考下方对应细分类编码对照表 |
| ∟ type | Number | 是 | 关键词类型，1：普通词，2：组合词，3：拼音词 |
| ∟ status | Number | 是 | 关键词状态，0：未生效，1：已生效 |
| ∟ level | Number | 是 | 关键词等级，1：嫌疑，2：确定 |
| ∟ productId | Number | 是 | 产品id |
| ∟ targetId | Number | 是 | 业务id |
| ∟ updateTime | Number | 是 | 关键词更新时间,时间戳（毫秒单位） |
响应体示例
{
"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"
}
]
}
}
}
响应返回码
响应返回码见：响应返回码
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 服务端 SDK 接入指引 了解更多。
