批量删除关键词
大约 2 分钟
REST API
批量删除关键词
功能说明
批量删除关键词名单中的关键词。
调用频率上限
100 次/秒/App Key
请求 URL
DELETE https://{host}/{org_name}/{app_name}/moderation/text/list/(list_id)/word/batch
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
list_id | String | 是 | 关键词名单 ID。 |
关于请求 URL 中的其他参数说明,详见 请求 URL 参数介绍。
请求示例
# 将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE 'https://XXXX/XXXX/XXXX/moderation/text/list/{list_id}/word/batch' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YourAppToken>' \
-d '{
"wordIds": ["1xXXXXUjdvN1LE68wFeILywpks2", "1xXXXXNiiIOSZmGNMBGgNEZ6jj9"]
}'
请求 header 参数
关于 Content-Type、Accept 和 Authorization 字段的说明,详见 请求 header 参数说明。
请求 body
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
wordIds | Array | 是 | 要删除的关键词的 ID。一次最多可删除 100 个关键词。 |
响应示例
{
"status": "OK",
"entity": 0
}
响应 body 字段
如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中包含以下字段:
| 字段 | 类型 | 描述 |
|---|---|---|
status | String | 请求状态。若请求成功,返回 OK。 |
entity | Int | 是否删除成功: - 0:删除成功 - 1:删除失败 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 错误码 了解可能的原因。
错误码
如果返回的 HTTP 状态码非 200,表示请求失败,可能提示以下错误码:
| HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 |
|---|---|---|---|---|
| 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法,可能过期或 token 错误。 | 使用新的 token 访问。 |
| 400 | Bad Request | request data is empty | 参数为空。 | 添加正确参数。 |
| 400 | Bad Request | textList data is empty | 名单 ID 不存在。 | 传输正确的名单 ID。 |
关于其他错误,你可以参考 错误码页面 了解可能的原因。
