Ресурс: AgentMessage
Сообщение, отправленное агентом пользователю.
| JSON-представление |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| Поля | |
|---|---|
name |
Это поле заполняется платформой RCS for Business. Не включайте его при создании сообщения агента. Поле разрешает "phones/{E.164}/agentMessages/{messageId}", где {E.164} – номер телефона пользователя в формате E.164, а {messageId} – назначенный агентом идентификатор сообщения агента. |
sendTime |
Это поле заполняется платформой RCS for Business. Не включайте его при создании сообщения агента. В поле указывается время отправки сообщения пользователю. Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
contentMessage |
Содержимое сообщения агента. |
messageTrafficType |
Тип трафика сообщений. |
richMessageClassification |
Только для вывода. Классифицирует сообщение в соответствии с моделью оплаты в США. Подробную информацию о каждом типе классификации можно найти в руководстве Модель оплаты в США. Это поле заполняется только для номеров телефонов в США. |
totalPayloadSizeBytes |
Только для вывода. Общий размер полезной нагрузки сообщения в байтах. В полезной нагрузке учитываются все прикрепленные к сообщению RCS for Business файлы, например видео, изображения, PDF и т. д., за исключением текста сообщения и подсказок. В настоящее время это поле заполняется только для номеров телефонов в США. |
carrier |
Только для вывода. Информация об операторе, которому принадлежит номер телефона пользователя, согласно данным RCS-серверов Google. В настоящее время это поле заполняется только для номеров телефонов в США. |
| Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
expireTime |
Необязательное поле. Временная метка по UTC, указывающая, когда ресурс считается устаревшим. Должно пройти не менее шести секунд после отправки сообщения. Если указать временную метку, которая наступит менее чем через шесть секунд после отправки, платформа автоматически изменит ее на шесть секунд. Если указать временную метку, которая совпадает со временем отправки сообщения или предшествует ему, возвращается ошибка Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
ttl |
Необязательное поле. Только для ввода. Время, в течение которого сообщение будет доступно, прежде чем оно будет автоматически отозвано. Минимальное значение – 6 секунд. Если указать положительное значение меньше шести секунд, платформа автоматически изменит его на шесть секунд и отразит это в поле Продолжительность в секундах, может содержать до девяти дробных цифр и заканчиваться на букву |
| Конец взаимоисключающих полей. | |
AgentContentMessage
Содержимое сообщения, отправленного агентом пользователю.
| JSON-представление |
|---|
{ "suggestions": [ { object ( |
| Поля | |
|---|---|
suggestions[] |
Список готовых ответов и рекомендуемых действий, которые отображаются в виде вариантов запроса/вариантов действия после сообщения агента. Максимальное количество подсказок – 11. Чипы показываются, только если связанное с ними сообщение агента является последним в чате (включая сообщения агента и пользователя). Пользователь может нажать на предложенный ответ, чтобы отправить его агенту, или на предложенное действие, чтобы запустить его на устройстве. Существует два типа шаблонов подсказок: постоянные и временные. Подробная информация приведена в разделе Подсказки. |
| Содержимое сообщения агента. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
text |
Текст в кодировке UTF-8. Максимальное количество символов – 3072. |
fileName |
Уникальное название файла. Когда агент загружает файл, платформа RCS for Business возвращает название файла. Устарело. Вместо этого используйте uploadedRbmFile. |
uploadedRbmFile |
Содержит идентификаторы файла и значка, которые были загружены на сервер RCS for Business и передаются им. |
richCard |
Отдельная полезная подсказка. |
contentInfo |
Информация о файле, включая URL файла и URL значка файла. Платформа RCS for Business показывает контент из кеша, но агент может принудительно заставить платформу RCS for Business получить новую версию контента и обновить кеш. |
| Конец взаимоисключающих полей. | |
UploadedRbmFile
Сообщение с информацией о файле и значке
| JSON-представление |
|---|
{ "fileName": string, "thumbnailName": string } |
| Поля | |
|---|---|
fileName |
Название файла, возвращенное платформой RCS for Business при загрузке файла. |
thumbnailName |
Название значка, возвращенное платформой RCS for Business при загрузке значка. |
RichCard
Отдельная полезная подсказка или карусель подсказок, отправленная агентом пользователю.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "carouselCard": { object ( |
| Поля | |
|---|---|
| Отдельная карточка или карусель карточек. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
carouselCard |
Карусель карточек. |
standaloneCard |
Отдельная карточка. |
| Конец взаимоисключающих полей. | |
CarouselCard
Карусель карточек.
| JSON-представление |
|---|
{ "cardWidth": enum ( |
| Поля | |
|---|---|
cardWidth |
Ширина карточек в карусели. |
cardContents[] |
Список контента для каждой карточки в карусели. В карусели может быть от 2 до 10 карточек. |
CarouselCard.CardWidth
Ширина карточек в карусели.
| Перечисления | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
Не указано. |
SMALL |
120 DP. |
MEDIUM |
232 DP. |
CardContent
Контент карточки
| JSON-представление |
|---|
{ "title": string, "description": string, "media": { object ( |
| Поля | |
|---|---|
title |
Название карточки (необязательно). Максимальное количество символов – 200. |
description |
Описание карточки (необязательно). Максимум 2000 символов. |
media |
Медиаконтент (изображение, GIF-файл, видео, PDF-файл), который нужно включить в карточку (необязательно). |
suggestions[] |
Список подсказок, которые будут включены в карточку (необязательно). Максимум четыре подсказки. |
Медиа
Медиафайл в полезной подсказке.
| JSON-представление |
|---|
{ "height": enum ( |
| Поля | |
|---|---|
height |
Высота медиаконтента в карточке с вертикальным макетом. Для отдельной карточки с горизонтальным макетом используйте |
contentDescription |
Необязательное поле. Описывает медиаконтент для специальных возможностей, предоставляя альтернативный текст. Поддерживается до 200 символов обычного текста. |
| Медиаконтент. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
fileName |
Уникальное название файла, возвращенное платформой RCS for Business при загрузке файла. Устарело. Вместо этого используйте uploadedRbmFile. |
uploadedRbmFile |
Содержит идентификаторы файла и значка, которые были загружены на сервер RCS for Business и передаются им. |
contentInfo |
Информация о файле, включая URL файла и URL значка файла. Платформа RCS for Business показывает контент из кеша, но агент может принудительно заставить платформу RCS for Business получить новую версию контента и обновить кеш. |
| Конец взаимоисключающих полей. | |
ContentInfo
Сообщение с информацией о контенте.
| JSON-представление |
|---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
| Поля | |
|---|---|
fileUrl |
Общедоступный URL файла. Платформа RCS for Business определяет MIME-тип файла по полю content-type в HTTP-заголовках при получении файла. В HTTP-ответе от URL должно быть указано поле content-type с точным значением. Рекомендуемый максимальный размер файла – 100 МБ. Примечание. Переадресация в URL файлов не поддерживается. Если требуется перенаправление, используйте CreateFileRequest. |
thumbnailUrl |
Общедоступный URL значка (необязательно, только для изображений, аудио- и видеофайлов). Максимальный размер – 100 КБ. Если вы не укажете URL значка, на платформе RCS for Business будет показываться пустой плейсхолдер, пока устройство пользователя не скачает файл. В зависимости от настроек пользователя файл может не скачиваться автоматически. В этом случае пользователю нужно нажать кнопку скачивания. Примечание. Переадресация в URL файлов не поддерживается. Если требуется перенаправление, используйте CreateFileRequest. |
forceRefresh |
Если этот параметр задан, платформа RCS for Business получает файл и значок по указанным URL, даже если у нее есть кешированные копии файла и/или значка. |
Media.Height
Высота содержания
| Перечисления | |
|---|---|
HEIGHT_UNSPECIFIED |
Не указано. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. |
Рекомендация
Рекомендуемый ответ или действие, включенные в полезную подсказку или список вариантов запроса.
| JSON-представление |
|---|
{ "suggestionDisplay": enum ( |
| Поля | |
|---|---|
suggestionDisplay |
Необязательное поле. Управляет поведением подсказки при показе. Применимо только к обычным текстовым сообщениям, отправленным клиентам Google Сообщений (версии 20260225.00 или более поздней). Это поле должно быть задано только для отдельных подсказок, связанных с обычными текстовыми сообщениями. Сервер отклонит сообщение, если это поле будет применено к подсказкам в полезных подсказках или отдельным подсказкам с передачей файлов. Эта настройка сериализуется только для Google Сообщений и игнорируется другими клиентами (например, iOS или Samsung). |
| предложенный ответ или действие; Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
reply |
Пользователи могут нажать на готовый ответ, чтобы отправить текстовый ответ агенту. |
action |
Пользователи могут нажать на предложенное действие, чтобы запустить соответствующее встроенное действие на устройстве. |
| Конец взаимоисключающих полей. | |
SuggestedReply
При нажатии отправляет текстовый ответ агенту.
| JSON-представление |
|---|
{ "text": string, "postbackData": string } |
| Поля | |
|---|---|
text |
Текст, который показывается в готовом ответе и отправляется агенту, когда пользователь нажимает на него. Максимум: 25 символов. |
postbackData |
Закодированная в base64 полезная нагрузка, которую агент получает в событии пользователя, когда пользователь нажимает на готовый ответ. |
SuggestedAction
При нажатии на нее на устройстве запускается соответствующее действие.
| JSON-представление |
|---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "dialAction": { object ( |
| Поля | |
|---|---|
text |
Текст, который показывается в рекомендуемом действии. Максимум: 25 символов. |
postbackData |
Полезная нагрузка (в кодировке base64), которая будет отправлена агенту в пользовательском событии, когда пользователь нажмет на рекомендуемое действие. Используйте не более 2048 символов. |
fallbackUrl |
Резервный URL, который будет использоваться, если клиент не поддерживает рекомендуемое действие (необязательно). Резервные URL открываются в новых окнах браузера. Должен быть действительным URI, как определено в RFC 3986. Используйте не более 2048 символов. |
| Встроенное действие, которое запускается на устройстве, когда пользователь нажимает на рекомендуемое действие. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
dialAction |
Открывает приложение для набора номера, установленное по умолчанию, с указанным агентом номером телефона. |
viewLocationAction |
Открывает приложение карт, установленное по умолчанию, и выбирает местоположение, указанное агентом, или ищет места рядом с пользователем по запросу, указанному агентом. |
createCalendarEventAction |
Открывает приложение календаря, установленное по умолчанию, и запускает процесс создания мероприятия с данными, указанными агентом. |
openUrlAction |
Открывает указанный URL в браузере по умолчанию. Если у пользователя установлено приложение, зарегистрированное как обработчик по умолчанию для URL, то вместо этого будет открыто оно, а его значок будет использоваться в интерфейсе рекомендуемых действий. |
shareLocationAction |
Открывает окно выбора местоположения в приложении RCS, чтобы пользователь мог выбрать местоположение и отправить его агенту. |
| Конец взаимоисключающих полей. | |
DialAction
Открывает приложение для набора номера, установленное по умолчанию, с указанным агентом номером телефона.
| JSON-представление |
|---|
{ "phoneNumber": string } |
| Поля | |
|---|---|
phoneNumber |
Номер телефона в формате E.164, например +12223334444. |
ViewLocationAction
Открывает приложение карт, установленное по умолчанию, и выбирает местоположение, указанное агентом, или ищет места рядом с пользователем по запросу, указанному агентом.
| JSON-представление |
|---|
{
"latLong": {
object ( |
| Поля | |
|---|---|
latLong |
Широта и долгота указанного местоположения (необязательно). |
label |
(Необязательно.) Ярлык маркера, установленного в точке latLong. |
query |
Вместо координат (и, при желании, ярлыка) агент может указать строку запроса. Если приложение поддерживает функцию поиска (например, Google Карты), то при нажатии на подсказку будет выполнен поиск по текущему местоположению пользователя. Если запрос достаточно конкретный, агенты могут использовать его, чтобы выбрать любое местоположение в мире. Например, если в строке запроса указать "Growing Tree Bank", будут показаны все отделения Growing Tree Bank поблизости от пользователя. Если в строке запроса указать "1600 Amphitheater Parkway, Mountain View, CA 94043", будет выбран именно этот адрес, независимо от местоположения пользователя. |
LatLng
Объект, содержащий географические координаты в виде значений широты и долготы. Это выражается в виде пары значений с плавающей запятой (double), представляющих градусы широты и градусы долготы. Если не указано иное, координаты задаются в системе WGS84. Также они должны попадать в нормализованные диапазоны значений.
| JSON-представление |
|---|
{ "latitude": number, "longitude": number } |
| Поля | |
|---|---|
latitude |
Градусная мера широты. Должна попадать в диапазон [-90.0, +90.0]. |
longitude |
Градусная мера долготы. Должна попадать в диапазон [-180,0, +180,0]. |
CreateCalendarEventAction
Открывает приложение календаря, установленное по умолчанию, и запускает процесс создания мероприятия с данными, указанными агентом.
| JSON-представление |
|---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
| Поля | |
|---|---|
startTime |
Время начала мероприятия. Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
endTime |
Время окончания мероприятия. Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
title |
Название мероприятия. Используйте не более 100 символов. |
description |
Описание мероприятия. Не более 500 знаков. |
OpenUrlAction
Открывает указанный URL в браузере по умолчанию. Если у пользователя установлено приложение, зарегистрированное как обработчик по умолчанию для URL, то вместо этого будет открыто оно, а его значок будет использоваться в интерфейсе рекомендуемых действий.
| JSON-представление |
|---|
{ "url": string, "application": enum ( |
| Поля | |
|---|---|
url |
URL, который нужно открыть. С 1 ноября 2025 г. схема URL должна быть https:// или http://. Запросы к API, в которых используются другие схемы (например, tel:, mailto:, sms:), после этой даты будут отклоняться с ошибкой 400 Bad Request. URL должен быть действительным URI, как определено в RFC 3986. Используйте не более 2048 символов. |
application |
URL открывает приложение, браузер или компонент WebView. Чтобы узнать, поддерживает ли устройство пользователя режим WebView, выполните проверку возможностей. Подробную информацию можно найти в документации: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
Режим просмотра для компонента WebView. |
description |
Описание специальных возможностей для компонента WebView. |
OpenUrlApplication
Тип приложения, открывающего URL
| Перечисления | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
Если значение не указано, URL будет открываться в браузере. |
BROWSER |
Откройте URL в браузере. |
WEBVIEW |
Открыть URL во встроенном окне веб-просмотра |
WebviewViewMode
Тип режима просмотра WebView.
| Перечисления | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
Не указано. Чтобы использовать компонент WebView, необходимо указать режим просмотра. |
FULL |
Требуется полноэкранный оверлей с чатом чат-бота, помеченным в строке состояния. |
HALF |
Требуется оверлей на половину экрана. |
TALL |
Требуется оверлей, занимающий три четверти экрана. |
Suggestion.SuggestionDisplay
Поведение при показе отдельных текстовых подсказок.
| Перечисления | |
|---|---|
SUGGESTION_DISPLAY_UNSPECIFIED |
Клиенты используют стандартные настройки показа:
|
PERSISTENT |
Подсказка остается видимой в окне сообщения, даже когда в чат добавляются новые сообщения. |
StandaloneCard
Отдельная карточка
| JSON-представление |
|---|
{ "cardOrientation": enum ( |
| Поля | |
|---|---|
cardOrientation |
Ориентация карточки. |
thumbnailImageAlignment |
Выравнивание предварительного просмотра изображений для отдельных карточек с горизонтальным макетом. |
cardContent |
Контент карточки. |
StandaloneCard.CardOrientation
Ориентация карточки.
| Перечисления | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
Не указано. |
HORIZONTAL |
Горизонтальный макет. Если в объекте |
VERTICAL |
Вертикальный макет. |
StandaloneCard.ThumbnailImageAlignment
Выравнивание предварительного просмотра изображений для отдельных карточек с горизонтальным макетом.
| Перечисления | |
|---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
Не указано. |
LEFT |
Предварительный просмотр файла выровнен по левому краю. |
RIGHT |
Предварительный просмотр файла выровнен по правому краю. |
MessageTrafficType
Поддерживаемые типы трафика сообщений. Перечисление будет расширено для поддержки дополнительных типов трафика. Обратите внимание, что хотя вариант использования агента может служить руководством по выбору типа трафика, в API нет ограничений на их связь.
| Перечисления | |
|---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Режим работы по умолчанию: тип трафика сообщений определяется сценарием использования агента. При необходимости измените тип трафика в зависимости от содержания сообщения. Для агентов, выполняющих несколько задач, значение по умолчанию не предусмотрено. Тип трафика нужно задать вручную (например, TRANSACTION, PROMOTION). |
AUTHENTICATION |
Для сообщений аутентификации (рекомендуется для агентов, отправляющих одноразовые коды). |
TRANSACTION |
Для транзакционных сообщений (рекомендуется для транзакционных агентов и агентов с несколькими сценариями использования). |
PROMOTION |
Для рекламных сообщений (рекомендуется для рекламных или многофункциональных агентов). |
SERVICEREQUEST |
Для сообщений об услугах, на получение которых пользователь дал согласие (рекомендуется для одноразовых кодов, транзакций, рекламы или агентов с несколькими сценариями использования). |
ACKNOWLEDGEMENT |
Для сообщений, подтверждающих запрос пользователя на отмену подписки (рекомендуется для сценариев использования "Одноразовый код", "Транзакции", "Реклама" или "Многоцелевой агент"). |
RichMessageClassification
Только для США: сведения о классификации сообщений, используемой для выставления счетов.
| JSON-представление |
|---|
{
"classificationType": enum ( |
| Поля | |
|---|---|
classificationType |
|
segmentCount |
Количество 160-байтовых сегментов для текста сообщения, всегда округляется в большую сторону. Рассчитывается на основе общей длины байта UTF-8 только текстового контента. Данные из готовых ответов или действий исключаются. Например, для текстового сообщения длиной 300 байт segmentCount будет равно 2. Это поле заполняется только для типа RICH_MESSAGE. |
RichMessageClassificationType
Только для США: указывает классификацию сообщения для оплаты.
Важно! Цены на платные типы сообщений, описанные на этой странице, устанавливают операторы связи США. Операторы связи в США также определяют окончательную плату, взимаемую с разработчика за отправку сообщений RCS for Business. Чтобы получить дополнительную информацию о ценах или оплате, обратитесь к представителям оператора.
| Перечисления | |
|---|---|
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED |
Не указано |
RICH_MESSAGE |
Сообщение классифицируется как RICH при следующих условиях: 1. В нем нет полезных подсказок. 2. В нем нет прикрепленных файлов. 3. Все предлагаемые действия должны быть действиями набора номера или открытия URL, которые не используют компонент WebView. |
RICH_MEDIA_MESSAGE |
Любое сообщение, которое не соответствует критериям RICH_MESSAGE. К ним относятся сообщения, содержащие полезную подсказку, медиафайл или любое рекомендуемое действие, кроме набора номера или открытия URL в браузере. |
SUGGESTED_ACTION_CLICK |
Представляет нажатие пользователем на предлагаемое действие (не на готовый ответ). Эта классификация применяется только к действиям пользователей и появляется исключительно в полезной нагрузке UserMessage веб-хука. Оно не распространяется на сообщения A2P. |
Методы |
|
|---|---|
|
Отправляет сообщение от агента пользователю. |
|
Отзывает сообщение агента, которое было отправлено, но ещё не доставлено. |