Console
    Contact Us Start free

    REST Resource: projects.locations.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 
 
) 
 } 
 , 
 "ingestedContextReferences" 
 : 
 { 
 string 
 : 
 { 
 object (  ContextReference 
 
) 
 } 
 , 
 ... 
 } 
 }
    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 use 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 use 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.
    ingestedContextReferences

    map (key: string, value: object ( ContextReference ))

    Output only. The context reference updates provided by external systems.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    Methods

    complete

    		Completes the specified conversation.

    create

    		Creates a new conversation.

    get

    		Retrieves the specific conversation.

    ingestContextReferences

    		Data ingestion API.

    list

    		Returns the list of all conversations in the specified project.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: