功能说明
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/im_msg_audit_mgr/get_cloud_audit_keywords?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | 当前仅支持中国站，SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/im_msg_audit_mgr/get_cloud_audit_keywords | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
{"SdkAppId":1400187352,"Offset":0,"Limit":10,"LibID":"1cd0d0ed-0e2c-4d35-ae86-2a1a8697706d","Content":"test123456xyz1"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
SdkAppId | Integer | 必填 | 应用 ID。 |
Offset | Integer | 必填 | 偏移。 |
Limit | Integer | 必填 | 本次最大请求数量，最多不超过100个。 |
LibID | String | 必填 | 当前操作的词库 ID。 |
Content | String | 选填 | 如果不为空，则返回对应模糊匹配敏感词；如果为空，则分页拉取相应敏感词。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "a2b6ab9c-ac0d-4627-b9fd-d3c7525048f9","TotalCount": 1,"Infos": [{"ID": "10756913","Content": "test123456xyz1","CreateTime": "2023-06-24 23:45:04"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
ErrorInfo | String | 错误信息。 |
RequestId | String | 当前请求唯一标识。 |
TotalCount | Integer | 应用敏感词总数。 |
LocalAuditWords | Array | 返回的敏感词以及相关属性。 |
Infos | Array | 返回的敏感词以及相关属性。 |
ID | String | 敏感词 ID。 |
Content | String | 敏感词内容。 |
Content | String | 敏感词内容。 |
CreateTime | String | 敏感词创建时间。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：
错误码 | 描述 |
2001 | 服务器内部错误。 |
2002 | 暂不支持该命令字。 |
2003 | 请求参数无效。 |
2004 | 该请求没有权限。 |
2015 | 未开启审核服务。 |
2016 | 添加脏词超过每次请求的限制。 |
