List muted participants in an open channel

Retrieves a list of muted participants in an open channel.

HTTP request

GET https://api-{application_id}.sendbird.com/v3/open_channels/{channel_url}/mute

Parameters

The following table lists the parameters that this action supports.

Parameters

Required	Type	Description
channel_url	string	Specifies the URL of the channel.

Optional	Type	Description
show_total_mute_count	boolean	Determines whether to include the number of all muted users in the response. (Default: false)
token	string	Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.
limit	int	Specifies the number of results to return per page. Acceptable values are 0 to 100, inclusive. (Default: 10)

Query string example

?token=&limit=5&show_total_mute_count=true

Response

If successful, this action returns a list of muted user resources and mute information in the response body.

Status: 200 OK

{
    "muted_list": [
        {
            "user_id": "Jeremy",
            "nickname": "Bishop",
            "profile_url": "https://sendbird.com/main/img/profiles/profile_48_512px.png",
            "metadata": {
                "font_preference": "times new roman",
                "font_color": "black"
            },
            "remaining_duration": -1,
            "end_at": -1,
            "description": "too many abnormal messages in the channel"
        },
        {
            "user_id": "Oliver",
            "nickname": "Han Solo",
            "profile_url": "https://sendbird.com/main/img/profiles/profile_65_512px.png",
            "metadata": {
                "font_preference": "times new roman",
                "font_color": "black"
            },
            "remaining_duration": 21253000,
            "end_at": 1542722786000,
            "description": "relationless messages"
        },
        ... # More muted users
    ],
    "total_mute_count" : 10,
    "next": "a3YUS1E8Q1FMFEVfWlVZEGJyGQ~~"
}

List of response properties

Property name	Type	Description
muted_list[]	array of objects	An array of `JSON` objects that contain information on the muted user.
next	string	The value that can be used in the `token` parameter to retrieve the next page in the result set.
total_mute_count	int	The number of all muted users.

In the case of an error, an error object is returned. A detailed list of error codes is available here.

On this page

HTTP request Parameters Response