List muted members

Retrieve the list of muted members in a specified group channel.

If channelId is empty, returns the list of users muted across all group channels.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/group-channel/user/mute-list-get

Rate limit: 100 per second

Signature: Required. See API request signature.

Request body

Content type: application/json

Parameter	Type	Required	Description
channelId	String	No	Group channel ID. If empty, returns users muted across all group channels.

Request example

HTTP

POST /v4/group-channel/user/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

Field	Type	Description
code	Number	Return code. 0 indicates success.
result	Object	Result data.
result.mutedMembers	Object[]	Array of muted members.
result.mutedMembers[i].userId	String	Muted user ID.
result.mutedMembers[i].mutedAt	String	Mute start time, format: YYYY-MM-DD HH:MM:SS. Note: UTC.
result.mutedMembers[i].muteExpiresAt	String	Mute expiration time, format: YYYY-MM-DD HH:MM:SS. Note: UTC.

Response example

HTTP

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

{
  "code": 0,
  "result": {
    "mutedMembers": [
      {
        "userId": "u02",
        "mutedAt": "2024-02-07 18:25:12",
        "muteExpiresAt": "2024-02-07 18:55:12"
      },
      {
        "userId": "u01",
        "mutedAt": "2024-02-07 18:25:12",
        "muteExpiresAt": "2024-02-07 18:55:12"
      }
    ]
  }
}