添加群成员

POST

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

通过该接口向指定的群中批量添加新成员。单次最多加入 100 人，如需调整，请联系 ZEGO 技术支持。

添加成功后，全体群成员（包括被添加的用户）通过以下 ZIM SDK 的回调接口，收到相关通知：

iOS	Android	macOS	Windows
groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged

Web	小程序	Flutter	React Native
groupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged

Unity3D	uni-app \| uni-app x	HarmonyOS
OnGroupMemberStateChanged	groupMemberStateChanged	groupMemberStateChanged

说明

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

说明

参数 FromUserId、GroupId、NewOwner 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?' ，'@'，'['，']'，'^'，'_'，'{'，'}'，'|'，'~'。

说明

调用频率限制：1 次/秒，群级别限制。如需调整，请联系 ZEGO 技术支持。

Request

Query Parameters

Action string必填

可选值: [InviteUsersIntoGroup]

接口原型参数

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

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必填

操作者用户 ID。用户需已注册 ZIM 服务。

GroupId string必填

群 ID。

UserIds string[]必填

加入群的用户 ID 列表，默认最大支持 100 个用户 ID。

说明

若数组包含与 FromUserId 一样的值，该值会被剔除。

此参数与 GroupMemberInfos 作用相同，二者选其一即可。

此参数仅在 GroupMemberInfos 长度为 0 时有效。

GroupMemberInfos object[]required

加入群的用户信息列表，默认最大支持 100 个用户信息。此参数与 UserIds 作用相同，二者选其一即可。

Array[

UserId string必填

加入群组的用户 ID。

说明

若此参数与 FromUserId 相同，则会被剔除。 example: "userA"

EnterGroupTime number

进群时间戳（毫秒级别）。

0 或不传：使用当前时间戳。
其他：不可以大于当前时间。

IsInvite number

可选值: [0, 1]

用户的入群模式。

0：（默认）邀请用户即可直接将对方拉入群组，无需对方同意。
1：用户收到邀请后，需要同意才能入群。

]

Responses

application/json

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

Schema

Code number

返回码。

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

Code / SubCode	说明	处理建议
660000002	输入参数错误。	请检查输入参数。
660300006	频率限制。	请稍后再试，或了解相关频率限制。
660500002	操作者用户未注册。	请让操作者先注册 ZIM 服务。
660600001	群组不存在。	请确认 GroupId 是否正确。
660000011	用户个数超过限制。	请检查输入的用户列表。

Message string

操作结果描述。

RequestId string

请求 ID。

ErrorUsers object[]

失败列表。

Code 为 0：
ErrorUsers 为空，全部指定用户邀请成功。
ErrorUsers 不为空，表示部分指定用户邀请失败，请参考 SubCode 处理。
Code 不为 0：
ErrorUsers 为空，表示参数错误、接口频率限制、系统错误。
ErrorUsers 不为空，表示全部指定用户邀请失败。

Array[

UserId string

邀请失败的用户 ID。

SubCode number

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

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorUsers": [
    {
      "UserId": "usera",
      "SubCode": 660000002
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorUsers": [
    {
      "UserId": "usera",
      "SubCode": 660000002
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。