ConversationalSetting

  • Each locale has its own conversational settings represented by an IETF BCP 47 language tag.

  • Conversational settings include a required welcome message and privacy policy, and optional offline message and conversation starters.

  • Welcome messages and offline messages are text-based greetings with a maximum length of 1000 characters.

  • Conversation starters are suggested replies or actions that can initiate native actions on the device.

Conversational setting for an agent or location.

Each locale has its own conversational settings. Locale is represented by a well-formed IETF BCP 47 language tag.

JSON representation 
{
  "welcomeMessage": {
    object (WelcomeMessage)
  },
  "offlineMessage": {
    object (OfflineMessage)
  },
  "privacyPolicy": {
    object (PrivacyPolicy)
  },
  "conversationStarters": [
    {
      object (ConversationStarters)
    }
  ]
}
Fields
welcomeMessage

object (WelcomeMessage)

Required. Details about the welcome message for an agent.
offlineMessage

object (OfflineMessage)

Optional. Details about the offline message for an agent.
privacyPolicy

object (PrivacyPolicy)

Required. Details about the agent's privacy policy.
conversationStarters[]

object (ConversationStarters)

Optional. Details about the agent's conversation starters. Maximum 5.

WelcomeMessage

The greeting shown to users when they enter a conversation with the agent for the first time.

JSON representation 
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Fields
Union field content. The content of the welcome message. content can be only one of the following:
text

string

Text message. Maximum length 1000 characters.

OfflineMessage

The greeting shown to users when they enter a conversation with the agent outside the chat hours.

JSON representation 
{
  "text": string
}
Fields
text

string

The text of the offline message. Maximum length 1000 characters.

PrivacyPolicy

Privacy policy details for an agent.

JSON representation 
{
  "url": string
}
Fields
url

string

Required. The URL for the privacy policy.

ConversationStarters

Suggested replies shown to users when they enter a conversation with the agent for the first time.

JSON representation 
{
  "suggestion": {
    object (Suggestion)
  }
}
Fields
suggestion

object (Suggestion)

Optional. Suggestion at the beginning of a conversation.

Suggestion

A suggested reply.

JSON representation 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
Fields
Union field option. A suggested reply. option can be only one of the following:
reply

object (SuggestedReply)

Users can tap a suggested reply to send the text back to the agent as a reply.
action

object (SuggestedAction)

A suggested action that initiates a native action on the device.

SuggestedReply

When tapped, sends the text reply back to the agent.

JSON representation 
{
  "text": string,
  "postbackData": string
}
Fields
text

string

Required. Text that is shown in the suggested reply and sent back to the agent when the user taps it. Maximum 35 characters.
postbackData

string

Optional. The string the agent receives when the user taps the suggested reply.

SuggestedAction

When tapped, initiates the corresponding native action on the device.

JSON representation 
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  }
  // End of list of possible types for union field action.
}
Fields
text

string

Text that is shown in the suggested action. Maximum 35 characters.
postbackData

string

The string that the agent receives when a user taps the suggested action.
Union field action. The native action initiated on the device when the user taps the suggested action. action can be only one of the following:
openUrlAction

object (OpenUrlAction)

Opens the specified URL.

OpenUrlAction

Opens the specified URL.

JSON representation 
{
  "url": string
}
Fields
url

string

URL