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

    List participants of an open channel

    Retrieves a list of participants of an open channel. A participant is a user who has entered an open channel and is currently online.

    Note: See this page to learn more about channel types.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_url

    string

    Specifies the URL of the channel.

    OptionalTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of a chunk 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 1 to 100, inclusive. (Default: 10)

    ?token=&limit=5
    

    Response

    If successful, this action returns a list of user resources that are participating in the open channel in the response body.

    {
        "participants": [
            {
                "user_id": "Carlos",
                "nickname": "Wholla",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_52_512px.png",
                "last_seen_at": 0,
                "is_muted": false,
                "is_online": true
            },
            ... # More participants
        ],
        "next": "YnQSRDpSRl1AEE1WXlVaF2R3"
    }
    

    List of response properties

    Property nameTypeDescription

    participants[]

    array of objects

    An array of user objects that are participating in the open channel.

    next

    string

    The value for the token parameter to retrieve the next page in the result.

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