REST Resource: conversations.messages

Ресурс: Сообщение

Сообщение в разговоре между агентом и пользователем.

JSON-представление
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
Поля
name

string

Имя сообщения, заданное Business Messages. Разрешается как "conversations/{conversationId}/messages/{messageId}", где {conversationId} — уникальный идентификатор беседы, а {messageId} — уникальный идентификатор сообщения.

messageId

string

Необходимый. Уникальный идентификатор сообщения, присвоенный агентом. Если сообщение попытается использовать тот же messageId , что и предыдущее сообщение, это может повлиять на правильную доставку сообщения.

representative

object ( Representative )

Подробная информация о представителе (человеке или чат-боте), отправившем сообщение.

suggestions[]

object ( Suggestion )

Список предлагаемых ответов, который отображается в виде списка фишек предложений после соответствующего сообщения. Максимум 13 предложений.

Чипы отображаются только в том случае, если связанное сообщение является самым последним сообщением в разговоре (включая сообщения как агента, так и пользователя). Пользователь может нажать предложенный ответ, чтобы отправить текстовый ответ агенту.

fallback

string

Необязательный. Резервный текст, который отображается, если устройство пользователя не поддерживает тип или содержимое сообщения. Максимум 3072 символа.

containsRichText

boolean

Необязательный. Если true , это означает, что сообщение содержит форматированный текст. Если сообщение содержит недопустимое форматирование, Business Messages возвращает ошибку.

content поля объединения. Содержание сообщения. content может быть только одним из следующих:
text

string

Текстовое сообщение. Максимум 3072 символа.

image

object ( Image )

Имиджевое сообщение.

richCard

object ( RichCard )

Богатое сообщение карты.

Изображение

Изображение.

JSON-представление
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Поля
content поля объединения. Содержание изображения. content может быть только одним из следующих:
contentInfo

object ( ContentInfo )

Информация об изображении, включая URL-адрес изображения и URL-адрес миниатюры изображения.

СодержаниеИнформация

Сообщение, содержащее информацию о содержимом.

JSON-представление
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Поля
fileUrl

string

Общедоступный URL-адрес файла. Платформа определяет MIME-тип файла из поля типа контента в заголовках HTTP, когда платформа извлекает файл. Поле типа контента должно присутствовать и быть точным в HTTP-ответе от URL-адреса.

Максимум 5 МБ.

Поддерживаемые типы контента: изображение/jpeg, изображение/jpg, изображение/png, изображение/webp.

thumbnailUrl

string

Необязательный. Общедоступный URL-адрес миниатюры.

Если вы не укажете URL-адрес миниатюры, платформа будет отображать пустую миниатюру-заполнитель до тех пор, пока устройство пользователя не загрузит файл.

Максимум 25 КБ.

Поддерживаемые типы контента: изображение/jpeg, изображение/jpg, изображение/png, изображение/webp.

forceRefresh

boolean

Если этот параметр установлен, платформа извлекает файл и миниатюру по указанным URL-адресам, даже если платформа имеет кэшированные копии файла (и/или миниатюры).

altText

string

Текст, описывающий подробную информацию о средствах массовой информации в целях доступности.

РичКард

Отдельная расширенная карточка или карусель расширенных карточек, отправляемых агентом пользователю.

JSON-представление
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
Поля
Полевая card Союза. Возможные типы богатых карт. card может быть только одной из следующих:
standaloneCard

object ( StandaloneCard )

Автономная карта.

carouselCard

object ( CarouselCard )

Карусель карт.

АвтономнаяКарта

Автономная карта.

JSON-представление
{
  "cardContent": {
    object (CardContent)
  }
}
Поля
cardContent

object ( CardContent )

Содержание карты.

Содержание карты

Содержание карты.

JSON-представление
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Поля
title

string

Необязательный. Название карты. Максимум 200 символов.

description

string

Необязательный. Описание карты. Максимум 2000 символов.

media

object ( Media )

Необязательный. Медиафайлы для включения в карту.

suggestions[]

object ( Suggestion )

Необязательный. Список предложений для включения в карточку. Максимум 4 предложения.

СМИ

Медиа-файл внутри расширенной карты.

JSON-представление
{
  "height": enum (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Поля
height

enum ( Height )

Высота носителя в богатой карте.

content поля объединения. Медиаконтент. content может быть только одним из следующих:
contentInfo

object ( ContentInfo )

Информация о файле, включая URL-адрес файла и URL-адрес миниатюры файла.

Высота

Высота носителя

Перечисления
HEIGHT_UNSPECIFIED Не указан.
SHORT 112 ДП.
MEDIUM 168 ДП.
TALL 264 ДП. Недоступно для каруселей с насыщенными карточками, если для ширины карточки установлено значение SMALL .

Предположение

Предложение в списке чипов.

JSON-представление
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
Поля
option поля объединения. Рекомендуемый ответ. option может быть только одним из следующих:
reply

object ( SuggestedReply )

Предложение пользователю ответить указанным текстом.

action

object ( SuggestedAction )

Предлагаемое действие, которое инициирует собственное действие на устройстве.

liveAgentRequest

object ( LiveAgentRequest )

Просьба о присоединении к разговору живого агента.

authenticationRequest

object ( AuthenticationRequest )

Запрос на запуск потока аутентификации.

Предлагаемый ответ

При нажатии отправляет текстовый ответ обратно агенту.

JSON-представление
{
  "text": string,
  "postbackData": string
}
Поля
text

string

Текст, который отображается в предлагаемом ответе и отправляется агенту, когда пользователь нажимает на него. Максимум 25 символов.

postbackData

string

Строка, которую получает агент, когда пользователь нажимает на предложенный ответ. Максимум 2048 символов.

Предлагаемое действие

При касании инициирует соответствующее собственное действие на устройстве.

JSON-представление
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
Поля
text

string

Текст, который отображается в предлагаемом действии. Максимум 25 символов.

postbackData

string

Строка, которую получает агент, когда пользователь нажимает на предложенное действие. Максимум 2048 символов.

Полевые action Союза. Собственное действие, инициируемое на устройстве, когда пользователь нажимает предложенное действие. action может быть только одним из следующих:
openUrlAction

object ( OpenUrlAction )

Открывает указанный URL.

dialAction

object ( DialAction )

Открывает приложение дозвона пользователя по умолчанию.

Опенурлэкшн

Открывает указанный URL.

JSON-представление
{
  "url": string
}
Поля
url

string

URL-адрес

DialAction

Открывает приложение дозвона пользователя по умолчанию с заполненным указанным номером телефона.

JSON-представление
{
  "phoneNumber": string
}
Поля
phoneNumber

string

Необходимый. Указанный номер телефона в формате RFC 3966 . Например, «+1-201-555-0123».

LiveAgentRequest

Этот тип не имеет полей.

При нажатии отправляет запрос живому агенту присоединиться к разговору.

Запрос аутентификации

Запрос на аутентификацию разговора.

JSON-представление
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
Поля
Поле объединения authentication_type . Тип аутентификации. authentication_type может быть только одним из следующих:
oauth

object ( Oauth )

Подробности аутентификации через OAuth.

Оаутентификация

Подробности аутентификации через OAuth.

JSON-представление
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Поля
clientId

string

Необходимый. Идентификатор приложения, запрашивающего авторизацию.

codeChallenge

string

Необходимый. Вызов кода , используемый для обмена токенами доступа.

scopes[]

string

Необходимый. Массив, определяющий области запроса.

codeChallengeMethod

string

Необязательный. Метод запроса кода , используемый для создания запроса кода. Если этот параметр опущен, сервер предполагает plain .

КарусельКарточка

Карусель карт.

JSON-представление
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Поля
cardWidth

enum ( CardWidth )

Ширина карточек в карусели.

cardContents[]

object ( CardContent )

Список содержимого каждой карточки в карусели. В карусели может быть минимум 2 и максимум 10 карточек.

Ширина карты

Ширина карточек в карусели.

Перечисления
CARD_WIDTH_UNSPECIFIED Не указан
SMALL 136 ДП. Невозможно включить высокие носители.
MEDIUM 280 ДП.

Методы

create

Отправляет сообщение от агента пользователю.

updateReceipt

Отправляет квитанцию ​​о сообщении от агента пользователю.