好友关系链 API
好友模块提供双向好友关系的建立与删除、好友列表与关系校验、批量清理、添加好友验证等级以及好友备注/扩展属性。
模块概览
| 项目 | 值 |
|---|---|
| 接口数量 | 8 |
| 幂等接口 | 4 |
| 路径前缀 | /im/v2 |
| 请求方法 | POST（JSON 请求体） |
| 鉴权方式 | App-Key / Nonce / Timestamp / Signature（见 鉴权与签名） |
| 响应信封 | { code, msg?, data?, requestId? } |
接口列表
| 接口 | 方法 | 路径 | 说明 | 幂等 |
|---|---|---|---|---|
| 直接建立双向好友关系 | POST | /im/v2/friend/add | 直接建立双向好友关系（应用服务器代操作，不经过申请流程）。 | 是 |
| 删除双向好友关系 | POST | /im/v2/friend/remove | 删除双向好友关系。 | 是 |
| 好友列表 | POST | /im/v2/friend/list | 好友列表。 | 否 |
| 检查两人是否为好友关系 | POST | /im/v2/friend/check | 检查两人是否为好友关系。 | 否 |
| 批量清理好友关系 | POST | /im/v2/friend/clean | 批量清理好友关系（单向/双向）。 | 否 |
| 设置添加好友验证等级 | POST | /im/v2/friend/permission/set | 设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。 | 是 |
| 查询添加好友验证等级 | POST | /im/v2/friend/permission/get | 查询添加好友验证等级。 | 否 |
| 设置好友自定义属性 | POST | /im/v2/friend/profile/set | 设置好友自定义属性（备注名/扩展字段，仅本人可见）。 | 是 |
接口约定
- 完整请求地址 = 部署域名 +
/im/v2+ 接口路径；所有接口使用POST。 - 请求头必须携带 App-Key / Nonce / Timestamp / Signature；签名规则见鉴权与签名。
- 响应统一为
{ code, msg?, data?, requestId? }；code = 0表示成功。 - 列表类接口使用
limit分页，单页上限见限频与限制。