Group Type ID | Support for This RESTful API |
---|---|
Private | No. Same as work groups (Work) in the new version. |
Public | Yes. |
ChatRoom | Yes. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | Yes. |
Community | Yes. |
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.
https://xxxxxx/v4/group_open_http_svc/forbid_send_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.
Parameter | Description |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | The country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com |
v4/group_open_http_svc/forbid_send_msg | Request API |
sdkappid | The SDKAppID assigned by the IM console when an application is created |
identifier | The app administrator account. For more information, please see the App Admin section in Login Authentication. |
usersig | The signature generated in the app administrator account. For details on how to generate the signature, please see Generating UserSig. |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format. The value is always json . |
200 calls per second
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.
}
Field | Type | Required | Description |
---|---|---|---|
GroupId | String | Yes | The ID of the group to be queried |
Members_Account | Array | Yes | The member accounts to be muted. A maximum of 500 accounts are supported. |
ShutUpTime | Integer | Yes | Unsigned type. The muting period in seconds. 0 indicates to unmute members. 4294967295 indicates to permanently mute members. |
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
Field | Type | Description |
---|---|---|
ActionStatus | String | Request result. OK : successful. FAIL : failed. |
ErrorCode | Integer | Error code. 0 : successful. Other values: failed. |
ErrorInfo | String | Detailed error information |
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:
Error Code | Description |
---|---|
10002 | Internal server error. Try again. |
10003 | Invalid command word. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app administrator can do so. |
10010 | The group does not exist or has been deleted. |
10015 | Invalid group ID. Make sure to use the correct group ID. |
Use the RESTful API online debugging tool to debug this API.
Getting the List of Muted Group Members (v4/group_open_http_svc/get_group_shutted_uin)
Was this page helpful?