修改关键词

功能说明

修改单个关键词。

调用频率上限

100 次/秒/App Key

请求 URL

PUT https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id}/word

参数	类型	是否必需	描述
list_id	String	是	关键词名单 ID。要修改该名单中的关键词。

关于请求 URL 中的其他参数说明，详见 请求 URL 参数介绍。

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X PUT 'https://XXXX/XXXX/XXXX/moderation/text/list/{list_id}/word' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YourAppToken>' \
-d '{
      "id": "1xDQ86NiiXXXXmGNMBGgNEZ6jj9", 
      "word": "music",
      "userId": "v1"
}' 

请求 header 参数

关于 Content-Type、Accept 和 Authorization 字段的说明，详见 请求 header 参数说明。

请求 body 参数

参数	类型	是否必需	描述
id	String	是	要修改的关键词 ID。
word	String	是	修改后的关键词。
userId	String	是	修改关键词的用户 ID。

响应示例

{
    "status": "OK",
    "entity": {
        "id": "1xDQ86NiiXXXXmGNMBGgNEZ6jj9",
        "appId": "1DHFtAi7wabrqsrjCV449Kljh98",
        "word": "music",
        "userId": "v1",
        "listId": "1r14XXXXZ3iSBbR3WTczWj92qsq",
        "status": true,
        "createDateTime": 1752489316741,
        "updateDateTime": 1752490995382
    }
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

字段	类型	描述
status	String	请求状态。若请求成功，返回 OK。
entity	JSON	修改后的关键词的详情。
- id	String	修改后的关键词的 ID。
- appId	String	应用 ID。开发者可忽略该参数。
- word	String	修改后的关键词。
- userId	String	修改关键词的用户 ID。
- listId	String	关键词名单 ID。
- status	String	关键词状态。开发者可忽略该参数。
- createDateTime	Long	关键词的创建时间。
- updateDateTime	Long	关键词的修改时间。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
400	Bad request	textList id is empty	关键词名单 ID 参数 list_id 为空，App Key 与 list_id 无法对应。	请传入正确的关键词名单 ID list_id。
400	Bad request	the param can not be empty	请求 body 中的关键词 ID id 为空，App Key 与 id 无法对应。	请传入正确的关键词 ID id。

关于其他错误，你可以参考 错误码页面 了解可能的原因。