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

    View a banned member of a group channel

    Retrieves information about a member banned from a group channel.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/ban/{banned_user_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of a channel.

    banned_user_id

    string

    Specifies the ID of a banned user.


    Response

    If successful, this action returns a banned user resource and ban information in the response body.

    {
        "user": {
            "user_id": "John",
            "nickname": "Sendbirdian",
            "profile_url": "https://sendbird.com/main/img/profiles/profile_02_512px.png",
            "metadata": {
                "location": "San Mateo",
                "marriage": "Y"
            }
        },
        "start_at": 1543211671000,
        "end_at": 1543211731000,
        "description": "Too much talking"
    }
    

    List of response properties

    Property nameTypeDescription

    user

    object

    The user resource that contains brief information about the banned user.

    start_at

    long

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

    end_at

    long

    The timestamp of when the ban is scheduled to end. The value is in Unix milliseconds format.

    description

    string

    The reason for the ban.

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