Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON {} . Пример см. в разделе Список сообщений . Требует аутентификации пользователя .
HTTP-запрос
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
Необходимый. Имя ресурса пространства, из которого выводится список сообщений.
Формат: 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
Включать ли удаленные сообщения. Удаленные сообщения включают время удаления и метаданные об их удалении, но содержимое сообщения недоступно.
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответное сообщение для перечисления сообщений.
В случае успеха тело ответа содержит данные следующей структуры: