2024-04-28
▼ ▲ dialogflow.projects.locations.agents.conversations.list
Path : v3beta1/{+parent}/conversations
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/conversations
HTTP Method : GET
Parameters :
parent
Description : Required. The agent to list all conversations for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The filter string. Supports filter by create_time, metrics.has_end_interaction, metrics.has_live_agent_handoff, intents.display_name, pages.display_name and flows.display_name. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported. Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2. By intent display name: intents.display_name : "billing" 3. By end interaction signal: metrics.has_end_interaction = true
Location : query
Type : string
pageSize
Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns the list of all conversations.
▼ ▲ dialogflow.projects.locations.agents.conversations.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/conversations/{conversationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the conversation. Format: `projects//locations//agents//conversations/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified conversation.
▼ ▲ dialogflow.projects.locations.agents.conversations.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/conversations/{conversationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the conversation. Format: `projects//locations//agents//conversations/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the specified conversation.