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

    View a muted member in a group channel

    Retrieves information on a muted member in a group channel.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the target channel.

    muted_user_id

    string

    Specifies the unique ID of the user to check.


    Response

    If successful, this action returns information on the mute in the response body.

    {
        "is_muted": true,
        "remaining_duration": 38126218,
        "start_at": 1543287589000,
        "end_at": 1543331132000,
        "description": "relationless messages"
    }
    

    List of response properties

    Property nameTypeDescription

    is_muted

    boolean

    Indicates whether the user is muted in the channel.

    remaining_duration

    long

    The remaining duration, measured in Unix milliseconds, from the start of the muting to the end_at below which indicates when the user becomes unmuted in the channel. A value of -1 indicates that no time limit is imposed on the muted user. (Default: -1)

    start_at

    long

    The time when the user becomes muted in the channel. The value is in Unix milliseconds format.

    end_at

    long

    The time when the user becomes unmuted in the channel. The value is in Unix milliseconds format. A value of -1 indicates that no time limit is imposed on the muted user. (Default: -1)

    description

    string

    The reason for mute.

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