/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Get an open channel

    Copy link

    This action retrieves information about a specific open channel.


    HTTP request

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

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_url

    string

    Specifies the URL of the channel.

    OptionalTypeDescription

    include_operators

    boolean

    Determines whether to include a list of operators in the response. (Default: false)


    Responses

    Copy link

    If successful, this action returns an open channel resource in the response body.

    {
        "name": "Live streaming show on channel 5!",
        "channel_url": "monday_channel5_at_10_pm",
        "custom_type": "live",
        "is_ephemeral": false,
        "participant_count": 0,
        "max_length_message": 5000,
        "created_at": 1484787758,
        "cover_url": "https://sendbird.com/main/img/cover/cover_02.jpg",
        "data": "{event_trigger:100,500,1000,2000}",
        "operators": [
            {
                "user_id": "Alek",
                "nickname": "Alexander the Great",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_26_512px.png"
            },
            {
                "user_id": "Leslie",
                "nickname": "Crystal",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_27_512px.png"
            }
        ],
        "freeze": false
    }
    

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"Channel\" not found.",
        "code": 400201,
        "error": true
    }