Documentation
In-app Chat
Server APIs
Group related
Add group members

Add group members

Last updated：2024-04-12 15:12

Overview

You can call this operation to batch add up to 100 users to a specified group chat. If you need a higher limit, contact ZEGOCLOUD technical support.

After users are added, all group members, including newly added ones, receive the notification in the following ZIM SDK callbacks.

iOS	Android	macOS	Windows	Web
groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged
Flutter	Unity3D	React Native
onGroupMemberStateChanged	OnGroupMemberStateChanged	groupMemberStateChanged

Operation prototype

Request method: POST
Request URL: https://zim-api.zego.im/?Action=InviteUsersIntoGroup
Protocol: HTTPS
QPS limit: 1 call per second, applicable to group chats only. If you need a higher limit, contact ZEGOCLOUD technical support.

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Public request parameters section of the Accessing Server APIs topic.

Parameter	Type	Required	Description
FromUserId	String	Yes	Operator user ID. Users need to have registered for the ZIM service.
GroupId	String	Yes	Group ID.
UserIds	Array of String	Yes	List of user IDs to join the group. By default, a maximum of 100 user IDs are supported. This parameter has the same effect as `GroupMemberInfos`, just choose one of the two. This parameter is only valid when `GroupMemberInfos` length is 0.
GroupMemberInfos	Array of Object	Yes	List of user information that joins the group. By default, it supports a maximum of 100 user information.
UserId	String	Yes	The ID of the user joining the group.
EnterGroupTime	Number	No	Group entry timestamp (millisecond level). 0 or not passed: use the current timestamp. Other: cannot be greater than the current time.
IsInvite	Number	No	The user's group joining mode. 0: (Default) Invite users to directly add them to the group without their consent. 1: After receiving the invitation, the user needs to agree to join the group.

The FromUserId, GroupId, and UserIds parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

Sample request

Request URL

https://zim-api.zego.im/?Action=InviteUsersIntoGroup
&<Common request parameters>

Request body

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

Response parameters

Parameter	Type	Description
Code	Number	The return code.
Message	String	The description of the operation result.
RequestId	String	The request ID.
ErrorList	Array of Object	The list of failed results. If `Code` is `0`: If `ErrorList` is empty, all specified users are successfully added. If `ErrorList` is not empty, some specified users fail to be added. In this case, see `SubCode`. If `Code` is not `0`: If `ErrorList` is empty, one or more parameters are invalid, the QPS limit is exceeded, or a system error occurs. If `ErrorList` is not empty, all specified users fail to be added.
UserId	String	The ID of the user who fails to be added.
SubCode	Number	The code returned when the request fails.

Sample response

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

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.

Return Code	Description	Solution
660000002	Invalid parameter.	Check the input parameter.
660300006	The QPS limit is exceeded.	Please try again later, or check the QPS limit.
660500002	The operator is not registered.	Register the operator.
660600001	The group chat does not exist.	Check whether the value of the `GroupID` parameter is valid.
660000011	Too many users are included in the list.	Check the number of users.

ZEGO UIKits

Cloud Communications Products

Low-Code Products

AIGC

Supporting Services