Mute a Specified Group Member

The group service supports muting specified users in a group. Apps can call this API to add users to the mute list. The following capabilities are supported:

• Mute one or more users in a specified group.
• If no group is specified (the groupId can be left empty), the user will be muted in all groups they have joined. Up to 100 users can be set. To check if the limit has been reached, you can call the Query Group Member Mute List interface (/group/user/gag/list.json) with groupId left empty.
• Supports setting the mute duration, which can be a fixed duration (up to 43,200 minutes) or permanent.
• Once a user is added to the mute list, the mute status takes effect immediately. A muted group member can receive and view chat messages in the group but cannot send messages to the group via the client SDK.

The mute data is not cleared when a user leaves the group:

• A user who has been set to a permanent mute will retain the mute status if they rejoin the group.
• A user who has been set to a temporary mute will retain the mute status if they rejoin the group within the mute duration.

tip

The server-side (Server API) group message sending interface is not restricted by the group-wide mute status. Muted users can send messages to the group via the Server API. For details, see Send Group Messages.

Request Method

POST: https://Data Center Domain/group/user/gag/add.json

Signature Rule: All server API requests require signature verification. For details, see API Request Signature.

Rate Limit: 100 requests per second

Body Parameters

The HTTP request body can include the following HTTP form parameters:

Parameter	Type	Required	Description
userId	String	Yes	User ID, with a maximum of 20 users per request.
groupId	String	No	Group ID. If left empty, the user will be muted in all groups they joined.
minute	String	Yes	Mute duration in minutes, with a maximum of 43,200 minutes. 0 indicates permanent mute.

Request Example

POST /group/user/gag/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=2582&userId=2583&groupId=16&minute=1

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Type	Description
code	Number	Return code, 200 indicates success.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}