查询 App 自定义脏字

最近更新时间:2019-08-02 18:38:08

背景说明

  • 脏字指即时通信 IM 为 App 配置的敏感词,如果检查的内容包含脏字将拒绝请求,并返回错误码 300054000580001
  • 脏字检查的内容包括单聊和群组消息(只检查文本消息 TIMTextElem,不支持对自定义消息 TIMCustomElem 的过滤)、群名片、群组资料(群名称、群简介、群公告)用户资料和好友关系链中 bytes 类型的数据(如昵称、好友备注和好友分组等)。
  • 即时通信 IM 的脏字集已经涵盖了一批默认脏字(主要是政治、色情等领域)。
  • 如果 App 有除默认脏字集之外的自定义脏字需求,可以通过脏字管理的 REST API 进行配置。

功能说明

App 管理员可以通过该接口查询已设置的自定义脏字。

接口调用说明

请求 URL 示例

https://console.tim.qq.com/v4/openim_dirty_words/get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/openim_dirty_words/get 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

此接口为 GET 请求,不需要请求体。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "DirtyWordsList": [
        "回收金币",
        "代刷人气",
        "抽奖"
    ]
}

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,“OK” 表示处理成功,“FAIL” 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
DirtyWordsList Array 返回结果是已经设置的自定义脏字

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
10002 服务器内部错误,请重试
10003 请求命令字非法
10007 操作权限不足,该API只有 App 管理员才有权限调用

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考