Modify group specification limits

Description

You can call this method to modify the following group settings:

Group joining mode
Inviter mode
Invitee mode
The maximum number of group members

After the modification is successful, group members can receive notifications of the group specification limit changes through the following ZIM SDK callback interface:

iOS	Android	macOS	Windows
groupVerifyInfoUpdated	onGroupVerifyInfoUpdated	groupVerifyInfoUpdated	onGroupVerifyInfoUpdated
Web	Flutter	React Native
groupVerifyInfoUpdated	onGroupVerifyInfoUpdated	groupVerifyInfoUpdated

Request method and endpoint

Request method: GET
Request URL: https://zim-api.zego.im/?Action=ModifyGroupLimit
Protocol: HTTPS
Rate limit: 20 request/second

Request parameters

The following table describes only the method-specific request parameters and some common request parameters. For the complete list of common request parameters, see Accessing Server APIs - Common parameters.

Parameter	Type	Required	Description
FromUserId	String	Yes	Modify the operator's user ID (registered).
GroupId	String	Yes	The ID of the target group.
JoinMode	Number	No	Mode for joining the group: 0: (Default value) No verification is required, anyone can join the group directly. 1: The user needs to initiate an application to join the group, and the user can join the group only after the group owner or group administrator approves it. 2: External users must be invited by members of the group to join the group.
InviteMode	Number	No	Invitation mode: 0: (Default value) All group members can invite external users to the group. 1: Only the group owner or group administrator can initiate invitations.
BeInvitedMode	Number	No	Invited mode: 0: (Default value) External users can be directly invited to the group without the other party's consent. 1: After inviting someone to join the group, the other party’s consent is required.
MemberCountLimit	Number	No	The maximum number of group members, the default value is 0.

Note

The FromUserID and GroupId parameters can contain only digits, letters, and the following characters: '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，'{'，'}'，'|'，'~'.
If there is no need to modify JoinMode, InviteMode or BeInvitedMode, please do not carry this parameter in the Request endpoint. If a parameter is carried but no value is assigned, the value of the parameter may be modified to 0.

Sample request

https://zim-api.zego.im/?Action=ModifyGroupLimit
&<Common request parameters>
&FromUserId=zego
&GroupId=group
&JoinMode=1
&MemberCountLimit=100

https://zim-api.zego.im/?Action=ModifyGroupLimit
&<Common request parameters>
&FromUserId=zego
&GroupId=group
&JoinMode=1
&MemberCountLimit=100

Request parameters

Parameter	Type	Description
Code	Number	Return codes.
Message	String	Description of operation results.
RequestId	String	Request ID.

Sample request

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
 }

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
 }

Return codes

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

Return code	Description	Solution
660000001	Server error.	Try again or contact ZEGOCLOUD technical support.
660000002	Missing or invalid parameter.	Check the input parameter.
660300005	The QPS limit specified in `AppID` is exceeded.	Try again later.
660500002	The operator is not registered.	Register the operator.
660600001	The group does not exist.	Check whether the value of the `GroupId` parameter is valid.
660600009	Failed to obtain group information.	Check whether the value of the `GroupID` parameter is valid. If it is valid, contact ZEGOCLOUD Technical Support.