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

    List banned users in channels by a custom channel type

    Retrieves a list of users banned from 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}/ban
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    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=QnYDpDRsPRl1WAXe3RlVaFd2A&limit=5
    

    Response

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

    {
        "banned_list": [
            {
                "user": {
                    "user_id": "Joe",
                    "nickname": "Numbers",
                    "profile_url": "https://sendbird.com/main/img/profiles/profile_67_512px.png",
                    "metadata": {
                        "location": "San Mateo",
                        "marriage": "Y"
                    }
                },
                "start_at": 1543211891000,
                "end_at": 1543223391000,
                "description": "Too many messages"
            },
            ...  # More bans
        ],
        "next": "d4R5lDaWR1nRFnPOelVaRy4s"
    }
    

    List of response properties

    Property nameTypeDescription

    banned_list[]

    array of objects

    An array of JSON objects that contain information about the banned user, the duration of ban, and the reason for ban.

    (ban).user

    nested object

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

    (ban).start_at

    long

    The timestamp of when the ban starts. The value is in Unix milliseconds format.

    (ban).end_at

    long

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

    (ban).description

    string

    The reason for ban.

    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.