REST Resource: projects.conversations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Conversation

Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

JSON representation
{
  "name": string,
  "lifecycleState": enum (LifecycleState),
  "conversationProfile": string,
  "phoneNumber": {
    object (ConversationPhoneNumber)
  },
  "startTime": string,
  "endTime": string,
  "conversationStage": enum (ConversationStage)
}
Fields
name

string

Output only. The unique identifier of this conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

lifecycleState

enum (LifecycleState)

Output only. The current state of the Conversation.

conversationProfile

string

Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

phoneNumber

object (ConversationPhoneNumber)

Output only. It will not be empty if the conversation is to be connected over telephony.

startTime

string (Timestamp format)

Output only. The time the conversation was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. The time the conversation was finished.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

conversationStage

enum (ConversationStage)

The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation.

If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE.

If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversationStage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.

LifecycleState

Enumeration of the completion status of the conversation.

Enums
LIFECYCLE_STATE_UNSPECIFIED Unknown.
IN_PROGRESS Conversation is currently open for media analysis.
COMPLETED Conversation has been completed.

ConversationPhoneNumber

Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.

JSON representation
{
  "phoneNumber": string
}
Fields
phoneNumber

string

Output only. The phone number to connect to this conversation.

ConversationStage

Enumeration of the different conversation stages a conversation can be in. Reference: https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages

Enums
CONVERSATION_STAGE_UNSPECIFIED Unknown. Should never be used after a conversation is successfully created.
VIRTUAL_AGENT_STAGE The conversation should return virtual agent responses into the conversation.
HUMAN_ASSIST_STAGE The conversation should not provide responses, just listen and provide suggestions.

Methods

complete

Completes the specified conversation.

create

Creates a new conversation.

get

Retrieves the specific conversation.

list

Returns the list of all conversations in the specified project.