自定义忽略词接口说明
2024.09.25 11:34:06
忽略词提交接口
请求URL
https://as.dun.163.com/v2/pretreatment/add
请求公共参数
建议您使用POST请求, 且仅接受form表单编码格式。
参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
---|---|---|---|---|
secretId | String | Y | 产品秘钥 id ,由易盾内容安全服务分配,产品标识 | |
businessId | String | Y | 业务唯一标识,由易盾内容安全服务分配,业务标识 | |
timestamp | Long | Y | 13位时间毫秒数 | 请求当前 UNIX 时间戳,请注意服务器时间是否同步 |
nonce | Integer | Y | 1-65535 | 随机正整数,与 timestamp 联合起来,用于防止重放攻击 |
version | String | Y | v1 | 接口版本号,可选值 v2 |
signature | String | Y | 见官网签名计算方法 | 请求签名,用来验证此次请求的合法性 |
忽略词添加接口参数
忽略词添加接口私有参数
参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
---|---|---|---|---|
description | String | N | 添加描述 | |
entitys | String | Y | 最多200条 | 忽略词列表,逗号分隔 |
请求响应
返回通用结构:
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
msg | String | Y | 返回错误消息 |
result | jsonobject | Y | 提交返回结果 |
result数据结构
参数名称 | 数据类型 | 描述 |
---|---|---|
pretreatmentAddResult | Boolean | true:添加成功,false:添加失败 |
entityMap | jsonobject | 返回内容id:entity1,如果添加多个逗号分隔返回 |
请求响应示例
请求参数:
{
"signature": "signature",
"secretId": "your_secret_id",
"businessId": "your_businessId_id",
"nonce": 16163,
"version": "v2",
"timestamp": 1574653947813,
"description": "test",
"entitys": "entity1,entity2"
}
结果响应:
"code":200,
"msg":"ok",
"result":{
"pretreatmentAddResult":true,
"entityMap":{
"1990074":"entity1",
"1990075":"entity2"
}
}
}
忽略词查询接口
接口地址
https://as.dun.163.com/v1/pretreatment/pageQuery
忽略词查询接口请求参数
公共参数请参考请求公共参数说明
忽略词查询接口提交参数,建议您使用POST请求, 且仅接受form表单编码格式。
参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
---|---|---|---|---|
pageNum | Integer | Y | 页数,大于等于1 | |
pageSize | Integer | Y | 每页大小,大于等于1,限制每页最多500 | |
startTime | Long | Y | 开始时间,ms级别 | |
endTime | Long | Y | 结束时间,ms级别 | |
entity | String | N | 忽略词 | |
id | Long | N | 忽略词id |
请求响应
返回通用结构:
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
msg | String | Y | 返回错误消息 |
result | 分页结果对象 | Y | 提交返回结果(见下面示例) |
result返回结构
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
count | Long | Y | 数据总量 |
rows | List |
Y | 分页数据 |
KeywordQueryUnit结构:
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
id | Long | Y | 关键词id |
productId | Long | Y | 产品id |
targetId | Long | Y | 业务id |
entityType | Long | Y | 1:忽略词 |
entity | String | Y | 忽略词内容 |
lastModifyTime | Long | Y | 最近一次修改时间 |
insertTime | Long | Y | 忽略词插入时间 |
source | Long | Y | 忽略词添加来源 1:用户添加 |
creator | String | Y | 创建账号 |
lastOperator | String | Y | 最后修改账号 |
description | String | Y | 返回提交时描述内容 |
请求响应示例
请求参数:
{
"signature": "signature",
"secretId": "your_secret_id",
"businessId": "your_businessId_id",
"nonce": 16163,
"version": "v1",
"timestamp": 1574653947813,
"pageNum": 1,
"pageSize": 20,
"startTime": 1598951727666,
"endTime": 1598961727666,
}
结果响应:
{
"code": 200,
"msg": "ok",
"result": {
"count": 1,
"rows": [
{
"id": 127008,
"productId": 18375,
"targetId": 19008,
"entityType": 1,
"entity": "entity",
"lastModifyTime": 1599185739743,
"insertTime": 1599184967534,
"source": 1,
"creator": "na_pretreatmentlist@163.com",
"lastOperator": "na_pretreatmentlist@163.com",
"description": "0"
}
]
}
}
忽略词删除接口
接口地址
https://as.dun.163.com/v1/pretreatment/batchDelete
忽略词删除接口请求参数说明
公共参数请参考请求公共参数说明
忽略词删除接口提交参数,建议您使用POST请求, 且仅接受form表单编码格式。
参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
---|---|---|---|---|
ids | String | Y | 最多200条 | 忽略词id列表,逗号分隔 |
请求响应
返回通用结构:
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
msg | String | Y | 返回错误消息 |
result | Boolean | Y | 提交返回结果 |
请求响应示例(form表单形式请求)
请求参数:
{
"signature": "signature",
"secretId": "your_secret_id",
"businessId": "your_businessId_id",
"nonce": 16163,
"version": "v1",
"timestamp": 1574653947813,
"ids": "5855099,5855098"
}
结果响应:
{
"code": 200,
"msg": "ok",
"result": true
}
忽略词更新接口
接口地址
https://as.dun.163.com/v1/pretreatment/update
忽略词更新接口请求参数说明
公共参数请参考请求公共参数说明
忽略词更新接口提交参数,建议您使用POST请求, 且仅接受form表单编码格式。
参数名称 | 数据类型 | 是否必填 | 取值范围 | 描述 |
---|---|---|---|---|
entity | String | Y | 忽略词 | |
id | Long | Y | 忽略词id | |
description | String | N | 描述 |
请求响应
返回通用结构:
参数名称 | 数据类型 | 是否必填 | 描述 |
---|---|---|---|
code | Integer | Y | 返回错误码, 取值见官网公共返回错误码定义 |
msg | String | Y | 返回错误消息 |
result | Boolean | Y | 提交返回结果 |
请求响应示例
请求参数:
{
"signature": "signature",
"secretId": "your_secret_id",
"businessId": "your_businessId_id",
"nonce": 16163,
"version": "v1",
"timestamp": 1574653947813,
"entity": "entity",
"id": 5855099,
"description": "test"
}
结果响应:
{
"code": 200,
"msg": "ok",
"result": true
}