Method: projects.agent.sessions.contexts.list

Returns the list of all contexts in the specified session.

HTTP request

GET https://dialogflow.googleapis.com/v2/{parent=projects/*/agent/sessions/*}/contexts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

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

  • dialogflow.contexts.list

Query parameters

Parameters
pageSize

number

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 data with the following structure:

The response message for Contexts.ListContexts.

JSON representation
{
  "contexts": [
    {
      object(Context)
    }
  ],
  "nextPageToken": string
}
Fields
contexts[]

object(Context)

The list of contexts. There will be a maximum number of items returned based on the pageSize field in the request.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

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 OAuth 2.0 Overview.