Method: spaces.messages.list

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

Поддерживает следующие типы аутентификации:

  • Аутентификация приложения с одобрением администратора и следующей областью авторизации:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. При использовании этой области аутентификации метод возвращает только общедоступные сообщения в чат-группе. Личные сообщения не учитываются.

  • Аутентификация пользователя с одной из следующих областей авторизации:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (только для чат-групп в режиме импорта)

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Параметры пути

Параметры
parent

string

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

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

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

Параметры
pageSize

integer

Необязательное поле. Максимальное количество возвращаемых сообщений. Сервис может вернуть меньше сообщений, чем указано в этом значении.

Если значение не указано, возвращается не более 25 результатов.

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

Если указать отрицательное значение, возвращается ошибка INVALID_ARGUMENT.
pageToken

string

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

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

string

Необязательное поле. Фильтр запросов.

Вы можете фильтровать сообщения по дате (createTime) и цепочке (thread.name).

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

Чтобы отфильтровать по цепочке, укажите thread.name в формате spaces/{space}/threads/{thread}. В одном запросе можно указать только один параметр thread.name.

Чтобы отфильтровать результаты по цепочке и дате, используйте в запросе оператор AND.

Например, допустимы следующие запросы:

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

string

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

  • ASC – по возрастанию;

  • DESC – по убыванию.

По умолчанию используется createTime ASC.
showDeleted

boolean

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

enum (MarkupSyntax)

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

Тело запроса

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

Тело ответа

Ответное сообщение для вывода списка сообщений.

Ниже приведена структура данных в ответе, полученном на запрос.

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

object (Message)

Список сообщений.
nextPageToken

string

Чтобы получить следующую страницу результатов, вы можете отправить токен в качестве pageToken. Если поле пустое, значит, последующих страниц нет.

Области авторизации

Требует одной из следующих областей применения 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

Подробную информацию можно найти в руководстве по авторизации.