/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    List reactions

    Copy link

    Retrieves a list of reactions made to a specific message.

    HTTP request

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/messages/{message_id}/reactions

    Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_type

    string

    Specifies the type of the channel. Currently, the only acceptable value is group_channels.

    channel_url

    string

    Specifies the URL of the target channel.

    message_id

    long

    Specifies the unique ID of the target message.

    OptionalTypeDescription

    list_users

    boolean

    Determines whether to list the IDs of users who added a reaction to the message. If set to false, this parameter shows the count of each reaction. (Default: false)

    ?list_users=true

    Response

    Copy link

    If successful, this action returns a list of reactions made to the message in the response body.

    {
    "smile": [
        "Katherine", "Julia", "Debbie", "Jeff"
    ],
    "delightful": [
        "Jay", "Kay", "Katherine"
    ]
}

    If the list_users parameter is set to false, this action returns the counts of reactions made to the message in the response body.

    {
    "smile": 4,
    "delightful": 3
}

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

    On this page
    HTTP requestParametersResponse