このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Chat/
サーバー API/
RESTful インターフェース/
グループ関連/
グループメンバーの管理/
発言を禁止されているグループメンバーのリストを取得/

発言を禁止されているグループメンバーのリストを取得

Feature Overview

This API is used by the app admin to get the list of muted users in a group based on the group ID.

API Calling Description

Applicable group types

Group Type ID
RESTful API Support
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as the meeting group (Meeting) in the new version.
AVChatRoom
Yes
Community
Yes
These are the preset group types in Chat. For more information, see Group System.

Sample request URL

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

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/group_open_http_svc/get_group_muted_account
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
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.
contenttype
Request format, which should always be json.

Maximum call frequency

200 calls per second

Sample request

Getting the list of muted members in a group based on the group ID
{
     "GroupId":"@TGS#1KGZ2RAEU"
}

Request fields

Field
Type
Required
Description
GroupId
String
Required
ID of the group for which the list of muted members is to be obtained
TopicId
String
Optional
ID of the topic for which the list of muted members is to be obtained. This field applies only to topic-enabled communities.

Sample response

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "GroupId": "@TGS#2FZNNRAEU",
    "MutedAccountList": [ // List of muted users in the group
        {
            "Member_Account": "tommy", // User ID
            "MutedUntil": 1458115189 // Muting stop time (UTC - Coordinated Universal Time)
        },
        {
            "Member_Account": "peter",
            "MutedUntil": 1458115189
        }
    ]
}

Response fields

Field
Type
Description
ActionStatus
String
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information
MutedAccountList
Array
Array of muted users' information, including user IDs and muting stop time (UTC - Coordinated Universal Time)

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), 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 admin can do so.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Use the correct group ID.

API Debugging Tool

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

References

Bulk Muting and Unmuting (v4/group_open_http_svc/forbid_send_msg)