1. 添加文本特征接口

接口说明

通过该接口添加自定义文本特征，支持按业务维度或产品维度添加。特征添加后将在文本检测时生效，命中特征的内容将返回对应的垃圾分类结果。

鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权

接口要求

• 单次添加的文本内容数量不超过100个。
• 文本内容长度限制为10到10000个字符。
• 特征描述最大长度为500个字符。
• 接口调用频率受限，具体限制根据服务配置。

接口耗时

添加文本特征接口建议超时时间1s

请求

请求地址

名称	值
HTTP URL	http://as.dun.163.com/v1/text-feature/add
HTTP Method	POST

请求头

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

请求参数

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

公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数

业务参数

名称	类型	是否必传	最大长度	描述
version	String	是	4	接口版本号，可选值v1
featureType	Number	是	-	特征类型，1：白名单，2：黑名单
level	Number	是（当featureType为2时）	-	1：嫌疑，2：不通过（仅当featureType为2 黑名单时有效）
matchType	Number	是	-	匹配类型，1-精确匹配 2-模糊匹配
spamType	Number	是	-	垃圾类型，100：色情，200：广告，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水，1100：涉价值观
subLabel	String	否	-	细分类标签，需与spamType一致，支持文本业务的二级或三级标签
description	String	否	500	特征描述
entities	String	是	-	文本特征内容列表，JSON格式数组字符串，数量限制为100个
scope	Number	是	-	作用域，0-给指定业务添加（业务级别） businessId必填，1-给指定产品添加（产品级）

请求体示例

version=v1&featureType=1&level=2&matchType=1&spamType=100&subLabel=100001&description=色情文本特征&entities=["色情文本1","色情文本2"]&scope=1&signature=xxx&businessId=xxx&secretId=xxx&timestamp=xxx&nonce=xxx

响应

响应结果

响应字段如下，响应通用字段已省略，详细见响应公共字段：

名称	类型	是否返回	描述
无特定业务字段	Void	-	添加成功无特定返回数据

响应体示例

{
    "code": 200,
    "msg": "ok"
}

2. 删除文本特征接口

接口说明

通过该接口删除指定的文本特征，删除后的特征将不再在文本检测时生效。支持批量删除多个特征。

鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权

接口要求

• 单次删除的特征数量不超过100个。
• 接口调用频率受限，具体限制根据服务配置。

接口耗时

删除文本特征接口建议超时时间1s

请求

请求地址

名称	值
HTTP URL	http://as.dun.163.com/v1/text-feature/delete
HTTP Method	POST

请求头

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

请求参数

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

公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数

业务参数

名称	类型	是否必传	最大长度	描述
version	String	是	4	接口版本号，可选值v1
uuids	String	是	-	待删除特征的UUID列表，JSON格式数组字符串，数量限制为100个

请求体示例

version=v1&uuids=["uuid1","uuid2"]&signature=xxx&businessId=xxx&secretId=xxx&timestamp=xxx&nonce=xxx

响应

响应结果

响应字段如下，响应通用字段已省略，详细见响应公共字段：

名称	类型	是否返回	描述
无特定业务字段	Void	-	删除成功无特定返回数据

响应体示例

{
    "code": 200,
    "msg": "ok"
}

3. 查询文本特征接口

接口说明

通过该接口可以查询文本特征，支持多种条件组合查询，返回分页结果。查询条件包括时间范围、特征类型、匹配类型、垃圾类型、状态等。

鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权

接口要求

• 分页大小限制为1到200条。
• 接口调用频率受限，具体限制根据服务配置。

接口耗时

查询文本特征接口建议超时时间1s

请求

请求地址

名称	值
HTTP URL	http://as.dun.163.com/v1/text-feature/query
HTTP Method	POST

请求头

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

请求参数

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

公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数

业务参数

名称	类型	是否必传	最大长度	描述
version	String	是	4	接口版本号，可选值v1
startTime	Long	否	-	查询开始时间，时间戳单位为ms
endTime	Long	否	-	查询结束时间，时间戳单位为ms
featureType	Number	否	-	特征类型，1：白名单，2：黑名单
level	Number	否	-	1：嫌疑，2：不通过（仅当featureType为2 黑名单时有效）
matchType	Number	否	-	匹配类型，1-精确匹配 2-模糊匹配
spamType	Number	否	-	垃圾类型，100：色情，200：广告，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水，1100：涉价值观
status	Number	否	-	特征状态，1：有效，2：失效
pageNum	Number	是	-	页码，从1开始
pageSize	Number	是	-	每页大小，限制1到200
scope	Number	是	-	作用域，0-给指定业务添加（业务级别） businessId必填，1-给指定产品添加（产品级）

请求体示例

version=v1&startTime=1625097600000&endTime=1625184000000&featureType=1&level=2&matchType=1&spamType=100&status=1&pageNum=1&pageSize=20&scope=1&signature=xxx&businessId=xxx&secretId=xxx&timestamp=xxx&nonce=xxx

响应

响应结果

响应字段如下，响应通用字段已省略，详细见响应公共字段：

名称	类型	是否返回	描述
result	Object	是	分页查询结果
∟ count	Number	是	总记录数
∟ rows	Object[]	是	特征列表
∟∟ uuid	String	是	特征唯一标识UUID
∟∟ content	String	是	特征内容
∟∟ featureType	Number	是	特征类型，1：白名单，2：黑名单
∟∟ level	Number	是	特征等级，1：嫌疑，2：不通过
∟∟ matchType	Number	是	匹配类型
∟∟ spamType	Number	是	垃圾类型
∟∟ subLabel	String	否	细分类标签
∟∟ description	String	否	特征描述
∟∟ status	Number	是	特征状态
∟∟ insertTime	Long	是	创建时间，时间戳ms
∟∟ editTime	Long	是	修改时间，时间戳ms
∟∟ scope	Number	是	作用域，1：业务级，2：产品级

响应体示例

{
    "code": 200,
    "msg": "ok",
    "result": {
        "count": 100,
        "rows": [
            {
                "uuid": "uuid1",
                "content": "色情文本1",
                "featureType": 1,
                "level": 2,
                "matchType": 1,
                "spamType": 100,
                "subLabel": "100001",
                "description": "色情文本特征",
                "status": 1,
                "insertTime": 1625097600000,
                "editTime": 1625097600000,
                "scope": 1
            }
        ]
    }
}

4. 修改文本特征状态接口

接口说明

通过该接口可以批量修改指定ID文本特征的启用/禁用状态。支持将状态修改为有效或失效。

鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权

接口要求

• 单次修改的特征数量不超过100个。
• 状态值只能为有效(1)或失效(2)。
• 接口调用频率受限，具体限制根据服务配置。

接口耗时

修改文本特征状态接口建议超时时间1s

请求

请求地址

名称	值
HTTP URL	http://as.dun.163.com/v1/text-feature/edit-status
HTTP Method	POST

请求头

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

请求参数

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

公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数

业务参数

名称	类型	是否必传	最大长度	描述
version	String	是	4	接口版本号，可选值v1
uuids	String	是	-	待修改特征的UUID列表，JSON格式数组字符串，数量限制为100个
status	Number	是	-	目标状态，1：有效，2：失效

请求体示例

version=v1&uuids=["uuid1","uuid2"]&status=2&signature=xxx&businessId=xxx&secretId=xxx&timestamp=xxx&nonce=xxx

响应

响应结果

响应字段如下，响应通用字段已省略，详细见响应公共字段：

名称	类型	是否返回	描述
无特定业务字段	Void	-	修改成功无特定返回数据

响应体示例

{
    "code": 200,
    "msg": "ok"
}