Method: spaces.messages.reactions.list

Stay organized with collections Save and categorize content based on your preferences.

Lists reactions to a message. Requires user authentication and chat.messages, chat.messages.readonly, chat.messages.reactions, or chat.messages.reactions.readonly scope.

HTTP request

GET https://chat.googleapis.com/v1/{parent=spaces/*/messages/*}/reactions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The message users reacted to.

Format: spaces/{space}/messages/{message}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of reactions returned. The service may return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

pageToken

string

Optional. (If resuming from a previous query.)

A page token received from a previous list reactions call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

filter

string

Optional. A query filter.

The API supports filtering by emoji.unicode, emoji.customEmoji.uid, and user.name.

Multiple filters on the same field and on emoji fields (emoji.*) support joins with OR. Filters on different fields support joins with AND.

When a query has both AND and OR joins, group them with parentheses.

For example, the following queries are valid:

emoji.unicode = "🙂"
emoji.customEmoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.customEmoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.customEmoji.uid = "{uid}") AND
user.name = "users/{user}"

The following queries are invalid:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.customEmoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.customEmoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.customEmoji.uid = "{uid}" AND user.name =
"users/{user}"

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "reactions": [
    {
      object (Reaction)
    }
  ],
  "nextPageToken": string
}
Fields
reactions[]

object (Reaction)

List of reactions in the requested (or first) page.

nextPageToken

string

Continuation token to retrieve the next page of results. It will be empty for the last page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

For more information, see the OAuth 2.0 Overview.