Query muted members list

Retrieve the list of muted users in a specified community channel or subchannel.

If the subchannel ID (subchannelId) is empty, returns all users muted at the community channel level.

If API behavior does not match expectations, see Legacy mute behavior.

Request method

POST: https://Base URL/v4/community-channel/mute-list/get

Rate limit: 100 requests per second

Signature required: All server API requests require signature verification. See API request signature.

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
channelId	String	Yes	The community channel ID.
subchannelId	String	No	The subchannel ID.
page	Number	No	Page number. Defaults to 1.
pageSize	Number	No	Items per page. Defaults to 50. Maximum 200.

Request example

HTTP

POST /v4/community-channel/mute-list/get HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{"channelId":"16"}

Response

The response body contains a JSON object with the following structure:

Field	Type	Description
code	Number	Status code. 0 indicates success.
result.mutedMembers	Object[]	List of muted members.
result.mutedMembers[].userId	String	The user ID.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 0,
    "result": {
        "mutedMembers": [
            {
                "userId": "userId_001"
            }
        ]
    }
}