- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {}
. For an example, see List messages. Requires user authentication.
HTTP request
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the space to list messages from. Format: |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an |
pageToken |
Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter |
A query filter. You can filter messages by date ( To filter messages by the date they were created, specify the To filter by thread, specify the To filter by both thread and date, use the For example, the following queries are valid:
Invalid queries are rejected by the server with an |
orderBy |
Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:
The default ordering is |
showDeleted |
Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable. |
Request body
The request body must be empty.
Response body
Response message for listing messages.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"messages": [
{
object ( |
Fields | |
---|---|
messages[] |
List of messages. |
nextPageToken |
You can send a token as |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
For more information, see the Authorization guide.