REST Resource: brands.agents.greetings

  • The Resource: Greeting is deprecated.

  • A greeting includes details such as name, locale, welcome messages, and optional conversation starters.

  • A locale is a required field using the IETF BCP 47 language tag format.

  • Welcome messages are required and a greeting must have at least one defined.

  • All listed methods (create, get, list, patch) for greetings are also deprecated.

Resource: Greeting

Details about a greeting.

JSON representation
{
  "name": string,
  "locale": string,
  "welcomeMessages": [
    {
      object (WelcomeMessage)
    }
  ],
  "conversationStarters": [
    {
      object (ConversationStarters)
    }
  ],
  "customId": string,
  "adLink": string
}
Fields
name

string

Output only. The name of the greeting, as set by Business Messages. Resolves to "brands/{brand_id}/agents/{agent_id}/greetings/{greeting_id}" where {greeting_id} is the unique ID of the greeting.

locale

string

Required. The locale is a well-formed IETF BCP 47 language tag. It must match a locale defined in ConversationalSettings.

welcomeMessages[]

object (WelcomeMessage)

Required. Welcome message content. A greeting must have at least one welcome message defined.

conversationStarters[]

object (ConversationStarters)

Optional. Details about the conversation starters. Maximum 5.

customId

string

Optional. A custom identifier defined by the partner.

Methods

create
(deprecated)

Deprecated: Greetings are deprecated.

get

Deprecated: Greetings are deprecated.

list
(deprecated)

Deprecated: Greetings are deprecated.

patch
(deprecated)

Deprecated: Greetings are deprecated.