Method: projects.locations.apps.conversations.list

Lists conversations in the given app.

HTTP request

GET https://ces.googleapis.com/v1/{parent=projects/*/locations/*/apps/*}/conversations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the app to list conversations from.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. The nextPageToken value returned from a previous list AgentService.ListConversations call.
filter

string

Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
source

enum (Conversation.Source)

Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.

Request body

The request body must be empty.

Response body

Response message for AgentService.ListConversations.

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

JSON representation 
{
  "conversations": [
    {
      object (Conversation)
    }
  ],
  "nextPageToken": string
}
Fields
conversations[]

object (Conversation)

The list of conversations.
nextPageToken

string

A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates 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:

  • ces.conversations.list

For more information, see the IAM documentation.