同步单条检测

提交一条文本，在同一次请求中获取审核结论、命中分类和敏感词信息。

POSThttps://tsafe.ilivedata.com/api/v1/text/check

文本使用 UTF-8 编码，每次最多 2,048 个字符。请求与响应均为 JSON，使用 Authorization 签名鉴权。

请求参数

请求头

以下请求头均为必需。

Header	值	说明
`Content-Type`	`application/json; charset=UTF-8`	请求体格式
`Accept`	`application/json; charset=UTF-8`	响应格式
`X-AppId`	—	控制台「服务配置」中的项目编号
`X-TimeStamp`	—	请求发起时的 UTC 时间，采用 W3C 格式。格式示例：`2026-09-30T02:30:00Z`，实际请求需使用当前时间。
`Authorization`	—	签名值，计算方式见下文「请求签名」

请求体

仅 content 为必填参数。未传 strategyId 时，使用 DEFAULT 策略。

参数	类型	必需	说明
`content`	`String`	必需	检测的文本。此文本为不超过2048个字符的UTF-8编码字符串。
`strategyId`	`String`	可选	策略编号，不传时使用 `DEFAULT`。
`country`	`String`	可选	国家代码。不传时使用默认。
`checkTags`	`Array`	可选	指定需要检测的一级分类，取值见下方「可选检测类别」。
`userId`	`String`	可选	唯一的终端用户ID。用户ID应当不超过64个字符。
`userName`	`String`	可选	用户名、昵称。用户名应当不超过32个字符。
`userLevel`	`Number`	可选	用户等级
`userIp`	`String`	可选	用户IP地址
`sessionId`	`String`	可选	用户会话ID。会话ID应当不超过64个字符。
`receiverId`	`String`	可选	接收者ID。接收者ID应当不超过64个字符。
`totalPay`	`Number`	可选	用户充值金额。最多支持小数点后2位。
`registrationDate`	`Number`	可选	用户注册时间。 10位数时间戳。
`msgCount`	`Number`	可选	消息发送次数
`msgType`	`String`	可选	消息类型
`pkgChannel`	`String`	可选	安装包渠道
`did`	`String`	可选	用户设备ID
`dtype`	`String`	可选	设备类型：`1` iPhone、`2` Android、`3` iPad、`4` Windows Phone； `5` PC、`6` Web、`7` WAP。
`extra`	`Object`	可选	附加键值数据，例如 `{"server":"123","version":"456"}`。

可选检测类别

checkTags 支持以下一级分类代码。

代码	类别
`100`	涉政
`110`	暴恐
`120`	违禁
`130`	色情
`150`	广告
`160`	辱骂
`170`	仇恨言论
`180`	未成年保护
`190`	敏感热点
`220`	私人交易
`410`	违规表情
`420`	昵称相关
`999`	自定义

请求示例

{
  "content": "fuck you",
  "userId": "1234556",
  "strategyId": "123"
}

请求签名

按照帮助中心的请求签名计算 Authorization，使用以下接口参数。

签名参数	值
`HTTPMethod`	`POST`
`HostHeaderInLowercase`	`tsafe.ilivedata.com`
`HTTPRequestURI`	`/api/v1/text/check`

HTTP 响应

Content-Type: application/json;charset=UTF-8

errorCode 表示接口调用是否成功；textSpam.result 表示审核结论：0 通过、1 建议审核、2 不通过。顶层 code 为预留字段，可忽略。

响应字段

字段	类型	说明
`errorCode`	`Number`	错误码，0表示成功
`errorMessage`	`String`	错误消息
`code`	`Number`	预留字段(忽略)
`textSpam`	`Object`	结果信息
`warning`	`Boolean`	自定义广告词的报警信息，在控制台上添加黑名单时配置
`taskId`	`String`	区分不同次调用的唯一标识
`language`	`String`	语种
`startTime`	`Number`	时间戳，代表检测文本调用时间
`endTime`	`Number`	时间戳，代表检测文本结果返回时间

`textSpam`

字段	类型	说明
`content`	`String`	检测完成后，如果含有敏感词，敏感词会变星，其他内容正常返回；
`result`	`Number`	0:通过，1:建议审核，2:不通过
`tags`	`Array`	分类信息
`wordList`	`String[]`	敏感词列表

`tags[]`

所属字段：textSpam.tags，表示一级分类列表。

字段	类型	说明
`tag`	`Number`	一级分类代码，参见分类编码对照表。
`tagName`	`String`	检测文本命中的一级类型名称
`tagNameEn`	`String`	检测文本命中的一级类型名称（英文）
`level`	`Number`	分类级别，0：正常，1：疑似，2：异常
`confidence`	`Number`	置信度，0～100之间的值，数值越大，表示检测文本为广告的可能性越大。（仅tag为150时，返回该字段）
`subTags`	`Array`	敏感信息的二级分类

`subTags[]`

所属字段：textSpam.tags[].subTags，表示二级分类列表。

字段	类型	说明
`subTag`	`Number`	二级分类详细编码请参考分类编码对照表
`subTagName`	`String`	检测文本命中的二级类型名称
`subTagNameEn`	`String`	检测文本命中的二级类型名称（英文）
`wordList`	`String[]`	命中词数组
`wordPosition`	`Map<String, Position[]>`	命中词到位置数组的映射。

`Position`

wordPosition 中每个命中词对应一个位置数组，数组元素结构如下。

字段	类型	说明
`start`	`Number`	命中词开始位置
`end`	`Number`	命中词结束位置
`offset`	`Number`	命中词长度

响应示例

{
  "errorCode": 0,
  "textSpam": {
    "content": "****",
    "result": 2,
    "tags": [
      {
        "tag": 160,
        "level": 2,
        "tagName": "辱骂",
        "tagNameEn": "insults",
        "subTags": [
          {
            "subTag": 160001,
            "subTagName": "谩骂人身攻击",
            "subTagNameEn": "insults and personal attacks",
            "wordList": [
              "fuck"
            ]
          }
        ]
      }
    ],
    "wordList": [
      "fuck"
    ]
  },
  "taskId": "c01b212f-3e31-4a2e-8346-b6f6ce3a3456",
  "language": "English",
  "startTime": 1660103900367,
  "endTime": 1660103900374
}

错误码

通用请求错误和鉴权错误请参考帮助中心的通用错误码。本接口补充说明如下：

HTTP 状态码	错误码	错误消息	本接口触发条件
400	2000	Missing Parameter	请求体 JSON 缺少 `content`。
400	2102	Input Too Long	`content` 超过 2,048 个字符。
429	1104	Out of Rate Limit	请求频率超过 20 条/秒，或长度超过 100 个字符的文本，其字符总数超过 1K 字符/秒。

以上限额为文档中的默认值；项目已扩容时，以实际配置为准。