Representative

  • This document details the JSON structure for providing information about the representative (human or chatbot) sending a message.

  • The structure includes fields for display name, avatar image, and representative type (bot or human).

  • The avatar image should be a publicly accessible URL, ideally an icon or logo, with specific size and format restrictions.

  • The representativeType field is required and indicates whether the sender is a bot or a human.

Details about the representative (human or chatbot) that sent the message.

JSON representation 
{
  "displayName": string,
  "avatarImage": string,

  // Union field representative can be only one of the following:
  "representativeType": enum (RepresentativeType)
  // End of list of possible types for union field representative.
}
Fields
displayName

string

Optional. Name of the representative.
avatarImage

string

Optional. The representative's avatar image, as a publicly available URL. Displays as a circle.

Avatar images don't support personal information, such as depictions of representatives in photographs or illustrations. Use images that don't identify individuals, such as icons, logos, or fictitious illustrations. After an avatar image is used in a message, the image can't be modified or deleted.

Images must be 1024x1024 px and have a maximum files size of 50 KB.
Union field representative. A representative, identified by its type. representative can be only one of the following:
representativeType

enum (RepresentativeType)

Required. The type of representative.

RepresentativeType

Representative type

Enums
REPRESENTATIVE_TYPE_UNSPECIFIED Unspecified representative type.
BOT Bot representative.
HUMAN Human representative.