REST Resource: projects.conversations

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),
  "telephonyConnectionInfo": {
    object (TelephonyConnectionInfo)
  }
}
Fields
name

string

Output only. Identifier. 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.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The time the conversation was finished.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
conversationStage

enum (ConversationStage)

Optional. 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.
telephonyConnectionInfo

object (TelephonyConnectionInfo)

Output only. The telephony connection information.

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 
{
  "countryCode": integer,
  "phoneNumber": string
}
Fields
countryCode

integer

Output only. Desired country code for the phone number.
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.

TelephonyConnectionInfo

The information about phone calls connected via phone gateway to the conversation.

JSON representation 
{
  "dialedNumber": string,
  "sdp": string,
  "sipHeaders": [
    {
      object (SipHeader)
    }
  ],
  "extraMimeContents": [
    {
      object (MimeContent)
    }
  ]
}
Fields
dialedNumber

string

Output only. The number dialed to connect this call in E.164 format.
sdp

string

Optional. SDP of the call. It's initially the SDP answer to the endpoint, but maybe later updated for the purpose of making the link active, etc.
sipHeaders[]

object (SipHeader)

Output only. The SIP headers from the initial SIP INVITE.
extraMimeContents[]

object (MimeContent)

Output only. The mime content from the initial SIP INVITE.

SipHeader

The SIP headers from the initial SIP INVITE.

JSON representation 
{
  "name": string,
  "value": string
}
Fields
name

string

Optional. The name of the header.
value

string

Optional. The value of the header.

MimeContent

The mime content from the initial SIP INVITE.

JSON representation 
{
  "mimeType": string,
  "content": string
}
Fields
mimeType

string

Optional. The mime type of the content.
content

string (bytes format)

Optional. The content payload.

A base64-encoded string.

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.