ModifyGroupLimit
https://zim-api.zego.im/
By calling this API, you can modify the following specification limits of a group:
- Join mode;
- Invite mode;
- Be invited mode;
- Group member count limit (not exceeding the package limit, for details please refer to Pricing - Version Differences).
After successful modification, group members can receive notifications of group specification limit modifications through the following ZIM SDK callback interfaces:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupVerifyInfoUpdated | onGroupVerifyInfoUpdated | groupVerifyInfoUpdated | onGroupVerifyInfoUpdated |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| groupVerifyInfoUpdated | groupVerifyInfoUpdated | onGroupVerifyInfoUpdated | groupVerifyInfoUpdated |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupVerifyInfoUpdated | groupVerifyInfoUpdated | groupVerifyInfoUpdated |
The parameters FromUserID and GroupId only support numbers, English characters, and '!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'.
If you do not need to modify JoinMode, InviteMode, or BeInvitedMode, please do not include these parameters in the request URL. If the parameter is included but not assigned a value, the parameter value may be modified to 0.
Request
Query Parameters
- 0: (Default) No verification required, anyone can join the group directly.
- 1: Users need to initiate a join request, and can only join the group after approval by the group owner or group administrator.
- 2: External users can only join the group through invitation by group members.
- 0: (Default) All group members can invite external users to join the group.
- 1: Only the group owner or group administrator can initiate invitations.
- 0: (Default) External users can be directly invited to join the group without their consent.
- 1: After inviting someone to join the group, their consent is required.
Possible values: [ModifyGroupLimit]
API prototype parameter
https://zim-api.zego.im/?Action=ModifyGroupLimit
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
Possible values: <= 32 characters
User ID of the modification operator (who has logged in to the ZIM service by calling the login method on the client, or has completed registration by calling the server-side API).
Possible values: <= 32 characters
Target group ID.
Possible values: [0, 1, 2]
Join mode:
Possible values: [0, 1]
Invite mode:
Possible values: [0, 1]
Be invited mode:
Group member count limit, default value is 0.
Responses
- 200
- application/json