Method: messages.list

Full name: projects.locations.instances.users.conversations.messages.list

messages.list is used to retrieve existing messages for a conversation.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of messages. Format: projects/{project}/locations/{location}/instances/{instance}/users/{user}/conversations/{conversation}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of messages to return. The service may return fewer than this value. If unspecified, at most 100 messages will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous messages.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to messages.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for messages.list method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Fields
messages[]

object (Message)

The messages from the specified conversation.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.messages.list

For more information, see the IAM documentation.