Method: spaces.messages.list

Выводит список сообщений в пространстве, членом которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Системные сообщения, например, сообщения о новых участниках пространства, не включаются. Если вы выводите список сообщений из пространства, в котором нет сообщений, ответ будет пустым объектом. При использовании интерфейса REST/HTTP ответ содержит пустой JSON-объект {} . Пример см. в разделе «Вывод списка сообщений» .

Supports the following types of authentication :

HTTP-запрос

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

The URL uses gRPC Transcoding syntax.

Path parameters

Параметры
parent

string

Обязательно. Имя ресурса пространства, из которого нужно вывести список сообщений.

Формат: spaces/{space}

Параметры запроса

Параметры
pageSize

integer

Optional. The maximum number of messages returned. The service might return fewer messages than this value.

If unspecified, at most 25 are returned.

Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000.

Negative values return an INVALID_ARGUMENT error.

pageToken

string

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

При использовании пагинации все остальные параметры должны соответствовать вызову, предоставившему токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам.

filter

string

Optional. A query filter.

You can filter messages by date ( createTime ) and thread ( thread.name ).

Для фильтрации сообщений по дате их создания укажите createTime с меткой времени в формате RFC-3339 и двойными кавычками. Например, "2023-04-21T11:30:00-04:00" . Для отображения сообщений, созданных после указанной метки времени, можно использовать оператор > , а для отображения сообщений, созданных до указанной метки времени, — оператор < Для фильтрации сообщений в пределах заданного временного интервала используйте оператор AND между двумя метками времени.

To filter by thread, specify the thread.name , formatted as spaces/{space}/threads/{thread} . You can only specify one thread.name per query.

To filter by both thread and date, use the AND operator in your query.

For example, the following queries are valid:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

orderBy

string

Необязательный параметр. Способ упорядочивания списка сообщений. Укажите значение, которое будет упорядочено с помощью операции сортировки. Допустимые значения операции сортировки следующие:

  • ASC означает восходящий.

  • DESC означает «нисходящий».

Порядок по умолчанию: createTime ASC .

showDeleted

boolean

Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

markupSyntax

enum ( MarkupSyntax )

Необязательный параметр. Задает желаемый синтаксис вывода для поля formattedText сообщения чата.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Response message for listing messages.

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

JSON-представление 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Поля
messages[]

object ( Message )

List of messages.

nextPageToken

string

You can send a token as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

For more information, see the Authorization guide .