tencent cloud

Feature Description

• The app administrator can mute certain group members for a specific period of time.
• The app administrator can unmute certain group members.
• When muted users leave and then enter a group again, they remain muted.

API Call Description

Applicable group types

Above are the IM built-in groups. For more information, please see Group System.

Note：

Private groups (i.e., work groups in the new version）do not support muting members.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/forbid_send_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.

Maximum call frequency

200 calls per second

Sample request packets

• Muting members
  You can set a specific period of time in ShutUpTime to mute specified members.

  {
   "GroupId": "@TGS#2C5SZEAEF",
   "Members_Account": [ // Up to 500 member accounts
       "peter",
       "leckie"
   ],
   "ShutUpTime": 60 // Muting period (unit: second)
  }
  

• Unmuting members
  To unmute members, set ShutUpTime to 0.

  {
   "GroupId": "@TGS#2C5SZEAEF",
   "Members_Account": [ // Up to 500 member accounts
       "peter",
       "leckie"
   ],
   "ShutUpTime": 0 // 0 indicates to unmute members.
  }
  

Request packet fields

Sample response packet

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

Response packet fields

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

Reference

Getting the List of Muted Group Members (v4/group_open_http_svc/get_group_shutted_uin)