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

    List reactions

    Retrieves a list of reactions made to a specific message.

    Note: Currently, this action is only available in group channels.


    HTTP request

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

    Parameters

    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 message to add a reaction.

    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

    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 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.