- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- Попробуйте!
Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON {}
. Пример см. в разделе Список сообщений .
Требует аутентификации пользователя .
HTTP-запрос
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Необходимый. Имя ресурса пространства, из которого выводится список сообщений. Формат: |
Параметры запроса
Параметры | |
---|---|
pageSize | Максимальное количество возвращенных сообщений. Служба может возвращать меньше сообщений, чем это значение. Если не указано, возвращается не более 25. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения возвращают ошибку |
pageToken | Необязательно, если возобновляется предыдущий запрос. Токен страницы, полученный в результате предыдущего вызова сообщений списка. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
filter | Фильтр запроса. Вы можете фильтровать сообщения по дате ( Чтобы фильтровать сообщения по дате их создания, укажите Чтобы фильтровать по потоку, укажите Чтобы фильтровать как по теме, так и по дате, используйте в запросе оператор Например, допустимы следующие запросы:
Недействительные запросы отклоняются сервером с ошибкой |
orderBy | Необязательно, если возобновляется предыдущий запрос. Как упорядочивается список сообщений. Укажите значение для заказа с помощью операции упорядочивания. Действительные значения операции заказа следующие:
Порядок по умолчанию — |
showDeleted | Включать ли удаленные сообщения. Удаленные сообщения включают время удаления и метаданные об их удалении, но содержимое сообщения недоступно. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответное сообщение для перечисления сообщений.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"messages": [
{
object ( |
Поля | |
---|---|
messages[] | Список сообщений. |
nextPageToken | Вы можете отправить токен как |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/chat.import
-
https://www.googleapis.com/auth/chat.messages
-
https://www.googleapis.com/auth/chat.messages.readonly
Дополнительную информацию см. в руководстве по авторизации .