sensitiveword API
sensitiveword模块共 4 个接口。
模块概览
| 项目 | 值 |
|---|---|
| 接口数量 | 4 |
| 幂等接口 | 4 |
| 路径前缀 | /im/v2 |
| 请求方法 | POST(JSON 请求体) |
| 鉴权方式 | App-Key / Nonce / Timestamp / Signature(见 鉴权与签名) |
| 响应信封 | { code, msg?, data?, requestId? } |
接口列表
| 接口 | 方法 | 路径 | 说明 | 幂等 |
|---|---|---|---|---|
| 增量添加敏感词 | POST | /im/v2/sensitiveword/add | 增量添加敏感词(不覆盖既有词,重复添加幂等;单词 <=32 字符,总数 <=500)。覆盖融云 /sensitiveword/add.json;replaceWord 会把应用处置动作切换为 replace。 | 是 |
| 批量增量添加敏感词 | POST | /im/v2/sensitiveword/batch/add | 批量增量添加敏感词(1..=50 条,合并既有列表,总数 <=500)。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。 | 是 |
| 移除单个敏感词 | POST | /im/v2/sensitiveword/delete | 移除单个敏感词(幂等;不存在时 removed=false)。覆盖融云 /sensitiveword/delete.json。 | 是 |
| 批量移除敏感词 | POST | /im/v2/sensitiveword/batch/delete | 批量移除敏感词(1..=50 条,幂等)。覆盖融云 /sensitiveword/batch/delete.json。 | 是 |
接口约定
- 完整请求地址 = 部署域名 +
/im/v2+ 接口路径;所有接口使用POST。 - 请求头必须携带 App-Key / Nonce / Timestamp / Signature;签名规则见鉴权与签名。
- 响应统一为
{ code, msg?, data?, requestId? };code = 0表示成功。 - 列表类接口使用
limit分页,单页上限见限频与限制。