SendFriendApplication

POST

https://zim-api.zego.im/

调用此接口，可为一名用户批量向至多 20 名其他用户发送好友申请。如需上调（最多可为 50），请联系 ZEGO 技术支持。

说明

当用户已为目标用户的单向好友时，如果调用此接口向目标用户发起好友申请，目标用户会直接成为用户的好友。

例如，用户 A 与 B 原本是双向好友。A 单向删除了 B，则 A 为 B 的单向好友，B 不是 A 的好友。调用此接口向 B 发起好友申请后，B 直接成为 A 的好友，无需 B 同意。

每名用户最多可以拥有 3000 名好友。

发送好友申请后，目标用户的客户端将通过以下 ZIM SDK 的回调接口接收申请通知：

iOS	Android	macOS	Windows
friendApplicationListChanged	onFriendApplicationListChanged	friendApplicationListChanged	onFriendApplicationListChanged

Web	小程序	Flutter	React Native
friendApplicationListChanged	friendApplicationListChanged	onFriendApplicationListChanged	friendApplicationListChanged

uni-app \| uni-app x	HarmonyOS
friendApplicationListChanged	friendApplicationListChanged

说明

参数 FromUserId 和 UserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册。

说明

参数 FromUserId 和 UserId 仅支持数字，英文字符和

'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'

。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [SendFriendApplication]

接口原型参数

https://zim-api.zego.im/?Action=SendFriendApplication

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

Body

required

FromUserId string必填

可选值: <= 32 characters

为此 UserId 发送好友申请。

FriendInfos object[]required

Possible values: <= 20

好友结构体对象。默认上限为 20。

Array[

UserId string必填

可选值: <= 32 characters

目标用户 ID。长度上限为 32 字节。

Wording string

可选值: <= 256 characters

FromUserId 对目标用户成为好友时的附言，长度上限为 256 字符。

FriendAlias string

可选值: <= 256 characters

FromUserId 对目标用户的备注，长度上限为 256 字符。

CreateTime number

申请创建时间。此参数可在数据迁移时用于导入好友列表。

为 0 时，ZIM 服务端以当前时间为准。
不为 0 时，此参数需为 MS 时间戳，且不晚于当前时间。

UpdateTime number

申请更新时间。此参数可在数据迁移时用于导入好友列表。

为 0 时，ZIM 服务端以当前时间为准。
不为 0 时，此参数需为 MS 时间戳，且不晚于当前时间。

Attributes object[]

Possible values: <= 5

好友属性，上限 5 个。

说明

Key 的总长度与 Value 的总长度上限为 1024 字节。如需上调，请联系 ZEGO 技术支持。建议不要将上限设置过大。

Array[

Key string必填

可选值: [k0, k1, k2, k3, k4]

好友属性的键。取值仅能为 k0、k1、k2、k3、k4。

Value string必填

好友属性的值。

]

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码。

以下仅列出了接口业务逻辑相关的 Code 和 SubCode ，完整返回码请参考全局返回码。

说明

当您发起请求同时向多名用户发送好友申请时：

如果成功向 1 名或更多用户发送申请，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。

如果全部好友申请发送失败，Code 会返回相关返回码，具体请参考全局返回码。

Code / SubCode	描述	处理建议
660000002	输入参数错误。	请检查输入的参数。
660000011	输入的用户列表过大。	请检查输入的用户列表。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660500002	FromUserId 未注册。	请先注册 FromUserId。
660700015	如果为 code：FromUserId 未注册。如果为 subCode：目标用户未注册。	如果为 code：请先注册 FromUserId。如果为 subCode：请先注册目标用户。
660800019	单次批量操作数量超过上限。	减少单次批量操作数量。
660800020	不能将 FromUserId 添加为好友，即 FriendInfos 中的 UserId 不能与 FromUserId 相同。	请修改 FriendInfos 中与 FromUserId 相同的 UserId。
660800021	FriendAlias 或 Wording 超过长度上限。	请缩减相关字段的内容长度。
660800022	参数中的用户 ID 相关参数重复。	请删除或修改重复参数。
660800023	Attributes 的 Key 取值不属于 k0 ~ k4。	请修改 Key 的值。
660800024	Attributes 的所有 Key、Value 总长度超过长度上限。	请缩减相关字段的内容长度。
660800025	所有目标用户均未注册过，接口调用失败。	请先注册目标用户。
660800026	Attributes 参数错误。	请检查输入的参数。
660800027	目标用户已经是好友，无需发起好友申请。	无需操作。
660800028	FromUserId 的好友数量到达上限。	无法添加更多好友。
660800032	Attributes 有重复的 Key。	请修改 Key。
660800046	传递的时间戳大于当前时间。	可以不填，默认是当前时间。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

ErrorList object[]

失败信息列表。

Code 为 0：
ErrorList 为空，成功发送所有好友申请。
ErrorList 不为空，表示部分好友申请发送失败，请参考 SubCode 处理。
Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示添加全部好友申请发送失败。

Array[

UserId string

向该 UserID 发送好友申请失败。

SubCode integer

具体失败返回码，完整返回码请参考 Code 说明或者全局返回码。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "usera2",
      "SubCode": 660800022
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "usera2",
      "SubCode": 660800022
    }
  ]
}

SendFriendApplication

https://zim-api.zego.im/

Request

Query Parameters

Body

Responses​

Responses