Feature Description

• The app admin can mute certain group members for a specific period of time.
• The app admin can unmute certain group members.
• After muted users exit from and then enter a group again, they remain muted.

API Invocation Description

Applicable group types

IM provides the preceding five built-in group types. For details on these types, see Group Systems.

• Private group members cannot be muted.
• In a BChatRoom group, only the app admin can send messages. Therefore, muting and unmuting are unnecessary in this case.

Request URL example

https://console.tim.qq.com/v4/group_open_http_svc/forbid_send_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes only the parameters that are modified when this API is invoked. For details on other parameters, see RESTful API Overview.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet example

• Configuring muting
  Set ShutUpTime to a specific period of time to mute specified users.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Members_Account": [ // Support a maximum of 500 accounts.
        "peter",
        "leckie"
    ],
    "ShutUpTime": 60 // Set the muting period in seconds.
  }

• Canceling muting
  To cancel muting, set ShutUpTime to 0.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Members_Account": [ // Support a maximum of 500 accounts.
        "peter",
        "leckie"
    ],
    "ShutUpTime": 0 // The 0 value indicates that muting is canceled.
  }

Request packet fields

Response packet example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:

API Commissioning Tool

Use the RESTful online commissioning tool for APIs to commission this API.

References

Obtaining the list of muted group members (v4/group_open_http_svc/get_group_shutted_uin)