Tencent Cloud

search by keyword

Recent Pages

Documentation

Download PDF

Obtaining Muted Users in a Group

Last updated: 2020-03-12 15:02:55

Download PDF

Feature Description

The app admin uses this API to obtain the list of muted users in a group based on the group ID.

API Calling Description

Applicable group types

Group Type	Support This RESTful API
Private	Yes
Public	Yes
ChatRoom	Yes
AVChatRoom	Yes
BChatRoom	No

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

Request URL example

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

Request parameters

The following table lists only the parameters to be modified when this API is called. For details on other parameters, see RESTful API Overview.

Parameter	Description
v4/group_open_http_svc/get_group_shutted_uin	Request API
sdkappid	SDKAppID assigned by the IM console when an app is created
identifier	The value must be the app admin account. For details, see App Admins.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295

Maximum calling frequency

The maximum calling frequency is 200 times per second.

Request packet example

In the following example, the API is used to obtain the list of muted users in a group, and only the group ID is specified.

{
     "GroupId":"@TGS#1KGZ2RAEU"
}

Request packet fields

Field	Type	Attribute	Description
GroupId	String	Required	ID of the group, in which the list of muted members needs to be obtained

Response packet example

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "GroupId": "@TGS#2FZNNRAEU",
    "ShuttedUinList": [ // List of muted users in the group
        {
            "Member_Account": "tommy", // User ID
            "ShuttedUntil": 1458115189 // Muting period (UTC time)
        },
        {
            "Member_Account": "peter",
            "ShuttedUntil": 1458115189
        }
    ]
}

Response packet fields

Field	Type	Description
ActionStatus	String	Request processing result. OK: succeeded. FAIL: failed.
ErrorCode	Integer	Error code. 0: succeeded. Others: failed.
ErrorInfo	String	Error information
ShuttedUinList	Array	The returned result is the array of muted users, which includes the ID and of each muted member and the muting period (UTC time).

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.

Error Code	Description
10002	An internal server error occurred. To correct it, try again.
10003	The request command word is invalid.
10004	A parameter is invalid. To correct it, check whether request parameters are correct based on the error description.
10007	Operation permissions are insufficient. For example, a common member in a public group attempts to remove a member from the group, but only the app admin has the permission to do so.
10010	The group does not exist or has been dismissed.
10015	The group ID is invalid. To correct it, check whether the group ID is correct.