文档中心
即时通讯
服务端 API
群组相关
添加群成员

添加群成员

更新时间：2024-04-23 16:43

描述

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

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

iOS	Android	macOS	Windows	Web
groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged
小程序	Flutter	Unity3D	uni-app	React Native
groupMemberStateChanged	onGroupMemberStateChanged	OnGroupMemberStateChanged	groupMemberStateChanged	groupMemberStateChanged

接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=InviteUsersIntoGroup
传输协议：HTTPS
调用频率限制：1 次/秒，群级别限制。如需调整，请联系 ZEGO 技术支持。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	操作者用户 ID。用户需已注册 ZIM 服务。
GroupId	String	是	群 ID。
UserIds	Array of String	是	加入群的用户 ID 列表，默认最大支持 100 个用户 ID。此参数与 `GroupMemberInfos` 作用相同，二者选其一即可。此参数仅在 `GroupMemberInfos` 长度为 0 时有效。
GroupMemberInfos	Array of Object	是	加入群的用户信息列表，默认最大支持 100 个用户信息。
UserId	String	是	加入群组的用户 ID。
EnterGroupTime	Number	否	进群时间戳（毫秒级别）。 0 或不传：使用当前时间戳。其他：不可以大于当前时间。
IsInvite	Number	否	用户的入群模式。 0：（默认）邀请用户即可直接将对方拉入群组，无需对方同意。 1：用户收到邀请后，需要同意才能入群。

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

请求示例

请求地址

https://zim-api.zego.im/?Action=InviteUsersIntoGroup
&<公共请求参数>

请求消息体

{
    "FromUserId": "zego_user",
    "GroupId": "groupA",
    "UserIds": [
        "usera",
        "userb"
    ]
}

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
ErrorList	Array of Object	失败列表。 Code 为 0： ErrorList 为空，全部指定用户邀请成功。 ErrorList 不为空，表示部分指定用户邀请失败，请参考 SubCode 处理。 Code 不为 0： ErrorList 为空，表示参数错误、接口频率限制、系统错误。 ErrorList 不为空，表示全部指定用户邀请失败。
UserId	String	邀请失败的用户 ID。
SubCode	Number	邀请失败返回码。

响应示例

{
    "FromUserId": "zego_user",
    "GroupId": "groupA",
    "GroupMemberInfos": [
        {
            "UserId": "user_a",
            "EnterGroupTime": 123
        },
        {
            "UserId": "user_b",
            "EnterGroupTime": 0
        }
    ]
}

返回码

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

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

云通讯产品

AIGC

扩展服务

低代码互动产品

标准 AI 产品

AIGC

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公

物联网