MuteGroupMembers
https://zim-api.zego.im/
By calling this API, you can mute or unmute specific members in a group.
After the API is successfully called, all users in the group will learn which group members cannot speak in the group or have been unmuted through the following ZIM SDK callback interfaces:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| groupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupMemberInfoUpdated | groupMemberInfoUpdated | groupMemberInfoUpdated |
FromUserId and UserId have logged in to the ZIM service by calling the login method on the client, or have completed registration by calling the server-side API.'!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'.Request
Query Parameters
- -1: Permanent.
- 0: Unmute.
- Greater than 0: Mute duration in seconds. Maximum support is 30 days (2,592,000 seconds).
Possible values: [MuteGroupMembers]
API prototype parameter
https://zim-api.zego.im/?Action=MuteGroupMembers
💡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
Operator user ID (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).
Note
Since the mute operation will trigger a group tips message, when FromUserId is not a group member, developers need to hide the message or implement other processing to avoid confusion among group users.
Possible values: <= 32 characters
Group ID.
Possible values: <= 20
List of user IDs of group members to mute or unmute. A single request can include up to 20 user IDs.
Possible values: >= -1 and <= 2592000
Mute duration. Defaults to 0 if not passed.
If this API is called again to update the mute duration during the mute validity period of a group user, the mute time will be recalculated from the moment of this request.
Responses
- 200
- application/json