Method: projects.agent.environments.users.sessions.contexts.list

Returns the list of all contexts in the specified session.

HTTP request

GET https://{endpoint}/v2/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contexts

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.contexts.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken

string

Optional. The nextPageToken value returned from a previous list request.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListContextsResponse.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.