黑名单 API
黑名单模块提供加入、移出与列表查询三个幂等接口;黑名单关系用于阻断被拉黑用户的消息投递。
模块概览
| 项目 | 值 |
|---|---|
| 接口数量 | 3 |
| 幂等接口 | 2 |
| 路径前缀 | /im/v2 |
| 请求方法 | POST(JSON 请求体) |
| 鉴权方式 | App-Key / Nonce / Timestamp / Signature(见 鉴权与签名) |
| 响应信封 | { code, msg?, data?, requestId? } |
接口列表
| 接口 | 方法 | 路径 | 说明 | 幂等 |
|---|---|---|---|---|
| 加入黑名单 | POST | /im/v2/blacklist/add | 加入黑名单(幂等)。 | 是 |
| 移出黑名单 | POST | /im/v2/blacklist/remove | 移出黑名单(幂等)。 | 是 |
| 黑名单列表 | POST | /im/v2/blacklist/list | 黑名单列表。 | 否 |
接口约定
- 完整请求地址 = 部署域名 +
/im/v2+ 接口路径;所有接口使用POST。 - 请求头必须携带 App-Key / Nonce / Timestamp / Signature;签名规则见鉴权与签名。
- 响应统一为
{ code, msg?, data?, requestId? };code = 0表示成功。 - 列表类接口使用
limit分页,单页上限见限频与限制。