Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Moderation

    List muted users in channels by a custom channel type

    Retrieves a list of the muted users in channels with the specified custom channel type.


    HTTP Request

    GET https://api-{application_id}.sendbird.com/v3/applications/settings_by_channel_custom_type/{custom_type}/mute
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    custom_type

    string

    Specifies a custom channel type.

    OptionalTypeDescription

    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. This value must be between 1 and 100. (Default: 10)

    ?token=&limit=5
    

    Response

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

    {
        "muted_list": [
            {
                "user_id": "Sean",
                "nickname": "SeanTheBest",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_56_512px.png",
                "metadata": {
                    "location": "Tokyo",
                    "age": "23"
                },
                "remaining_duration": -1,
                "end_at": -1,
                "description": "Not allowed to talk in the channels of this type."
            },
            {
                "user_id": "Alek",
                "nickname": "Renegade",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_21_512px.png",
                "metadata": {
                    "location": "San Francisco",
                    "age": "30"
                },
                "remaining_duration": 24343000,
                "end_at": 1542722341000,
                "description": "Uncomfortable messages"
            },
            ...  # More muted users
        ],
        "next": "n4eRA3E7RmARFeVpYjVZE43d3R~~"
    }
    

    List of response properties

    Property nameTypeDescription

    muted_list[]

    list

    A list of the muted user.

    next

    string

    The value that can be used in the token parameter to retrieve the next page in the result set.

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