修改敏感词接口

  • 接口说明： 修改敏感词
  • 接口地址： /api/stop-words/{id}
  • 请求方式： PATCH

请求参数

参数名称类型是否必须描述
dataobject是基础数据
typestring是数据类型，固定值 stop-words
attributesobject是数据属性
attributes.ugcstring是用户内容处理方式，”{MOD}”,”{BANNED}”,”{REPLACE}” 之一，分别表示“审核”，“禁用”，“替换”
attributes.usernamestring是用户名处理方式，”{MOD}”,”{BANNED}”,”{REPLACE}” 之一，分别表示“审核”，“禁用”，“替换”
attributes.findstring是敏感词或敏感词查找正则
attributes.replacementstring是待替换的内容

请求示例

  1. {
  2.   "data": {
  3.     "type": "stop-words",
  4.     "attributes": {
  5.       "ugc": "{MOD}",
  6.       "username": "{REPLACE}",
  7.       "find": "abc",
  8.       "replacement": "xyz"
  9.     }
  10.   }
  11. }

返回说明

  • 成功，http 状态码 201
  • 失败，http 状态码 500

返回结果

关联数据模型字段释义请参见相应文档

参数名称类型出现要求描述
dataobject基础数据
typestring数据类型
idint数据 id
attributesobject数据属性
attributes.ugcstring针对用户内容的处理方式
attributes.usernamestring针对用户名的处理方式
attributes.findstring敏感词或敏感词查找正则
attributes.replacementstring待替换的内容
attributes.created_atdatetime创建时间
attributes.updated_atdatetime修改时间
relationshipsobject关联关系
includedobject关联数据

返回示例

  1. {
  2.   "data": {
  3.     "type": "stop-words",
  4.     "id": "39",
  5.     "attributes": {
  6.       "ugc": "{MOD}",
  7.       "username": "{REPLACE}",
  8.       "find": "calculating Texas",
  9.       "replacement": "well-modulated Checking Account",
  10.       "created_at": "2019-11-06T10:51:28+08:00",
  11.       "updated_at": "2019-11-13T10:31:08+08:00"
  12.     },
  13.     "relationships": {
  14.       "user": {
  15.         "data": {
  16.           "type": "users",
  17.           "id": "1"
  18.         }
  19.       }
  20.     }
  21.   },
  22.   "included": [
  23.     {
  24.       "type": "users",
  25.       "id": "1",
  26.       "attributes": {
  27.         "username": "username",
  28.         "nickname": null,
  29.         "mobile": "",
  30.         "unionId": "",
  31.         "lastLoginIp": "127.0.0.1",
  32.         "createdAt": "2019-10-11T00:00:00+08:00",
  33.         "updatedAt": "2019-11-11T14:51:34+08:00"
  34.       }
  35.     }
  36.   ]
  37. }