Method: spaces.messages.list

Список сообщений в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Пример см. в разделе Список сообщений . Требуется аутентификация пользователя и область авторизации chat.messages или chat.messages.readonly .

Этот метод поддерживается только в пространствах, которые не позволяют пользователям, не входящим в организацию Workspace, присоединяться.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
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

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

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит данные со следующей структурой:

Представление 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

Дополнительные сведения см. в руководстве по авторизации .