检查好友关系
POST
https://zim-api.zego.im/
调用此接口，可为一名用户批量检查其与至多 20 名其他用户的好友关系。如需上调（最多可为 50），请联系 ZEGO 技术支持。
ZEGO 支持单边或双边检查好友关系，以检查用户 A 与目标用户 B 的好友关系为例：
- 单边检查：仅检查用户 A 的好友列表是否有用户 B。
- 双边检查：同时检查用户 A 和用户 B 的好友列表是否有对方。
检查好友关系的结果可能有：
| 检查类型 | Relation | 说明 | |
|---|---|---|---|
| A 的好友列表有 B | B 的好友列表有 A | ||
| 单向 | 1 | ✖ | 无法确认 |
| 2 | ✔️ | 无法确认 | |
| 双向 | 3 | ✖ | ✖ |
| 4 | ✔️ | ✖ | |
| 5 | ✖ | ✔️ | |
| 6 | ✔️ | ✔️ | |
说明
参数 FromUserId 和 UserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用 服务端 API 完成注册。
说明
调用频率限制：20 次/秒。
Request
Query Parameters
Action string必填
可选值: [CheckFriendsRelation]
接口原型参数
https://zim-api.zego.im/?Action=CheckFriendsRelation
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
- application/json
Responses
- 200
OK
- application/json