Эта страница переведена с помощью Cloud Translation API.

Отправка сообщений

Агенты RCS for Business взаимодействуют с пользователями, отправляя и получая сообщения. Для отправки сообщений пользователям ваш агент отправляет запросы на отправку сообщений в API RCS Business Messaging. Один запрос может включать текст , расширенные карточки , медиафайлы и PDF-файлы , предлагаемые ответы и предлагаемые действия .

Платформа RCS for Business в определенных ситуациях выдает ошибки, чтобы помочь вам управлять доставкой сообщений:

Если вы отправляете сообщение пользователю, устройство которого не поддерживает RCS или на котором RCS не включен, платформа RCS for Business возвращает ошибку 404 NOT_FOUND. В этом случае вы можете попытаться связаться с пользователем, используя резервные методы, определенные в вашей инфраструктуре.
Если вы отправляете сообщение пользователю RCS в сети, где ваш агент еще не запущен, или в сети, где не включена поддержка RCS, платформа RCS for Business возвращает ошибку 404 NOT_FOUND.
Если вы отправляете сообщение с функциями, которые не поддерживаются устройством пользователя, платформа RCS for Business возвращает ошибку 400 INVALID_ARGUMENT и не доставляет ваше сообщение.

В рамках вашей многоканальной стратегии обмена сообщениями лучше всего отзывать сообщения , которые не были доставлены в течение разумного времени, и отправлять их по другому каналу. Чтобы автоматически отзывать сообщения по истечении заданного времени, установите срок действия сообщения .

Получатель не в сети.

Платформа RCS for Business по-прежнему принимает сообщение для доставки, даже если получатель находится в автономном режиме. Вы получаете ответ 200 OK, и платформа RCS for Business удерживает сообщение и пытается повторно доставить его в течение 30 дней. Нет необходимости запрашивать у RCS for Business повторную отправку сообщения.

RCS for Business удаляет все недоставленные сообщения через 30 дней после их отправки.

В зависимости от сценария использования вашего агента, вам может потребоваться отозвать недоставленное сообщение до истечения 30-дневного срока. Отзыв сообщения может предотвратить получение устаревших сообщений пользователями, не подключенными к сети, после их повторного подключения. Существует несколько способов отзыва сообщения:

Для инициирования отзыва отправьте запрос на аннулирование.
Установите срок действия сообщения таким образом, чтобы оно автоматически отзывалось в соответствующее время.

Установить срок действия сообщения

Сообщения вашего агента имеют ограниченный срок действия? Например, одноразовые пароли действительны лишь короткое время. Предложения с ограниченным сроком действия истекают. А напоминания о встрече становятся неактуальными после даты встречи. Чтобы сообщения оставались актуальными и своевременными, установите срок их действия. Это предотвратит получение устаревшей информации пользователями, находящимися в автономном режиме, когда они снова подключатся к сети. Срок действия также является хорошим сигналом для активации вашей резервной стратегии обмена сообщениями, чтобы пользователи получали необходимую информацию вовремя.

Чтобы установить срок действия сообщения, укажите одно из следующих полей в сообщении агента:

expireTime : точное время в формате UTC, когда сообщение истекает.
ttl (время жизни): время, по истечении которого сообщение теряет силу.

Информацию о форматировании и параметрах значений см. в разделе AgentMessage .

Максимальное значение для ttl и expireTime составляет 15 дней с момента отправки сообщения.

Хотя минимальных значений ttl и expireTime нет, рекомендуется выждать не менее 10 секунд после отправки сообщения, чтобы значительно снизить вероятность получения уведомлений как об отзыве, так и о доставке.

Время жизни (TTL) для сообщения

При установке значения TTL для сообщения RCS for Business вы указываете, как долго сообщение должно считаться действительным и доступным для доставки. Если сообщение не будет успешно доставлено на устройство пользователя в течение этого периода TTL, платформа RCS for Business автоматически попытается его отозвать.

При инициировании отзыва сообщения вы запрашиваете у платформы RCS for Business прекращение попыток доставки данного сообщения. Однако это действие влияет только на будущие попытки доставки. Если устройство пользователя уже успешно получило сообщение, оно находится в процессе обработки, и платформа RCS for Business не может отозвать сообщение с устройства пользователя.

Вот чего следует ожидать в отношении уведомлений:

Сообщение доставлено в течение срока действия TTL: Если устройство пользователя подключается к сети и получает сообщение до истечения срока действия TTL, вы получаете уведомление DELIVERED . Уведомление об отзыве не отправляется, поскольку сообщение было успешно доставлено. Это наиболее распространенный и ожидаемый сценарий.
Сообщение не доставлено до истечения срока действия TTL: Если срок действия TTL истекает до того, как сообщение достигнет устройства пользователя (например, устройство находится в автономном режиме), платформа RCS for Business пытается отозвать сообщение. Вы получите уведомление TTL_EXPIRATION_REVOKED , указывающее на то, что сообщение было успешно удалено из очереди доставки. В этом случае пользователь не получит сообщение.

Укажите тип трафика сообщений.

API RBM включает поле messageTrafficType для категоризации сообщений. Хотя сценарии использования агента по-прежнему определяют поведение агента и применяемые бизнес-правила, messageTrafficType позволяет более детально классифицировать содержимое сообщений. В конечном итоге это позволяет одному агенту обрабатывать несколько сценариев использования. На данный момент это не влияет на существующие сценарии использования агента или бизнес-правила.

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

Чтобы задать тип трафика сообщений, назначьте каждому сообщению соответствующее messageTrafficType в зависимости от его содержимого. RCS for Business поддерживает следующие типы трафика.

Тип трафика	Содержание сообщения	Вариант использования агента
`AUTHENTICATION`	Для сообщений аутентификации.	ОТП
`TRANSACTION`	Для сообщений о существующих услугах или продуктах пользователя. Например: подтверждения, квитанции об оплате или сведения о бронировании.	Транзакционный или многоцелевой
`PROMOTION`	Для рекламных сообщений, таких как предложения, скидки, объявления или другой рекламный контент.	Рекламный или многоцелевой
`SERVICEREQUEST`	Для сообщений об услугах, которые пользователь явно запросил.	Одноразовый пароль (OTP), транзакционный, рекламный или многоцелевой.
`ACKNOWLEDGEMENT`	Для сообщений, используемых для подтверждения действий пользователя, в частности, запроса на отписку. Это подтверждает, что запрос пользователя был получен и находится в обработке.	Одноразовый пароль (OTP), транзакционный, рекламный или многоцелевой.

Если тип трафика не указан, система назначает тип по умолчанию для сценария использования агента .

Вариант использования агента	Тип трафика по умолчанию
ОТП	`AUTHENTICATION`
транзакционный	`TRANSACTION`
Рекламный	`PROMOTION`
Многоцелевое использование	`MESSAGE_TRAFFIC_TYPE_UNSPECIFIED`

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

Ограничения на размер сообщений

Максимальный размер всего строкового сообщения AgentMessage составляет 250 КБ. Текстовая часть сообщения имеет собственное ограничение в 3072 символа.

Чтобы предотвратить непредвиденный расход данных пользователями, максимальный размер файла, который можно отправить через RCS for Business, составляет 100 МиБ, а общий размер всех медиафайлов и PDF-вложений в одном сообщении RCS for Business не должен превышать 100 МиБ. (1 МиБ = 1 048 576 байт). Для получения дополнительной информации см. раздел «Медиафайлы и PDF-файлы» .

Текст

Простейшие сообщения состоят из текста. Текстовые сообщения лучше всего подходят для передачи информации без необходимости использования визуальных элементов, сложного взаимодействия или ответов.

Пример

Приведенный ниже код отправляет сообщение в виде обычного текста. Информацию о форматировании и параметрах значений см. в файле phones.agentMessages.create .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!"
  },
  "messageTrafficType": "PROMOTION"
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
};

// Send a simple message to the device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Send simple text message to user
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444"
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a simple RBM text message
message_text = messages.TextMessage('Hello, world!')

# Send text message to the device
messages.MessageCluster().append_message(message_text).send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
);

Этот код представляет собой фрагмент примера агента RBM .

Основное содержимое сообщения - преобразование SMS

Операторы связи внедрили модели выставления счетов для поддержки перехода SMS-сообщений на RCS для бизнеса. Сообщение RCS для бизнеса, содержащее до 160 символов UTF-8, называется базовым сообщением.

При формировании запроса на отправку сообщения Basic Message помните, что символы считаются за 1 байт (UTF-8). Если вы отправляете сообщение, содержащее специальные символы, такие как эмодзи или многобайтовый набор символов, каждый символ считается за 2-4 символа UTF-8 или более.

Введите текст в поле, чтобы проверить его длину:

Предварительный просмотр содержимого текстовых сообщений и ссылок.

Клиенты RCS могут реализовывать предварительный просмотр ссылок. Если текстовое сообщение RCS для бизнеса содержит URL-адрес веб-сайта с тегами openGraph , клиент может сгенерировать предварительный просмотр (изображение, заголовок и т. д.), обеспечивая более информативный интерфейс. Например, см. базовое сообщение с предварительным просмотром URL-адреса .

Обратите внимание, что клиент RCS может позволять пользователю отключать предварительный просмотр ссылок.

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

С помощью RCS for Business можно отправлять одноразовые пароли (OTP) для автоматической проверки пользователей через API SMS Retriever. Специального API для чтения OTP, поступающих через RCS for Business, нет.

Как это работает на Android

Для приложений Android, зарегистрированных в API SMS Retriever , API ожидает корректно отформатированное сообщение RCS for Business. Это сообщение должно содержать как одноразовый пароль (OTP), так и уникальный хеш, идентифицирующий ваше приложение.

Когда сообщение RCS for Business получено в правильном формате, API SMS Retriever обрабатывает его так же, как и SMS-код подтверждения (OTP). После сопоставления хеша с вашим приложением, OTP извлекается и пересылается в ваше приложение для автоматической проверки пользователя.

Пример текстового сообщения RCS для бизнес-приложений для подтверждения пользователя: Your code is <OTP><app hash>.
Пример: Your code is 123456 M8tue43FGT.

Чтобы узнать больше о SMS Retriever и связанных с ним API, см. документацию SMS Retriever . Подробную информацию об автоматической проверке пользователей в приложениях, зарегистрированных в API SMS Retriever, см. на этой блок-схеме .

Как это работает на iOS

В iOS встроенная система обработки OTP автоматически обнаруживает и предлагает OTP-коды RCS for Business для автозаполнения, аналогично SMS-кодам. Для чтения OTP-кода в iOS-приложении не требуется специальная интеграция с API.

Медиафайлы и PDF-файлы

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

Максимальный размер отправляемого файла составляет 100 МиБ, а общий размер всех медиафайлов и PDF-вложений в одном сообщении не должен превышать 100 МиБ.

Технические характеристики миниатюр

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

Максимальный размер файла миниатюры составляет 100 КБ. Для оптимального удобства использования мы рекомендуем использовать размер 50 КБ или меньше.
Соотношение сторон миниатюры должно соответствовать соотношению сторон исходного файла.

Кэширование и управление URL-адресами

Важно: В целях обеспечения конфиденциальности и безопасности пользователей платформа RCS for Business загружает и обрабатывает медиафайлы и PDF-файлы по предоставленным URL-адресам перед их доставкой пользователю. Это предотвращает отслеживание действий агентов по уникальным URL-адресам. Поэтому не следует отправлять большое количество уникальных URL-адресов. Платформа RCS for Business не поддерживает это, независимо от того, указывают ли URL-адреса на одни и те же или разные файлы. Используйте один и тот же URL-адрес для идентичных файлов.

Платформа RCS for Business кэширует файлы в течение 60 дней, а API возвращает идентификатор файла, который ваш агент может включать в сообщения для пользователей. По истечении 60 дней RCS for Business удаляет файлы из кэша.

При указании файлов по URL-адресу рекомендуется установить параметр contentMessage.forceRefresh в false . Установка contentMessage.forceRefresh в true заставляет RCS for Business получать новый контент с указанного URL-адреса, даже если контент URL-адреса кэширован, что увеличивает время доставки сообщений для пользователей.

Пример URL-адреса файла

Приведенный ниже код отправляет изображение. Информацию о форматировании и параметрах значений см. в AgentContentMessage .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "contentInfo": {
      "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif",
      "forceRefresh": false
    }
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let params = {
   fileUrl: 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif',
   msisdn: '+12223334444',
};

// Send an image/video to a device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.AgentContentMessage;
import com.google.api.services.rcsbusinessmessaging.v1.model.AgentMessage;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   String fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

   // create media only message
   AgentContentMessage agentContentMessage = new AgentContentMessage();
   agentContentMessage.setContentInfo(new ContentInfo().setFileUrl(fileUrl));

   // attach content to message
   AgentMessage agentMessage = new AgentMessage();
   agentMessage.setContentMessage(agentContentMessage);

   rbmApiHelper.sendAgentMessage(agentMessage, "+12223334444");
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create media file attachment
file_message = messages.FileMessage('http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif')

messages.MessageCluster().append_message(file_message).send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

string fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

// Create content info with the file url
ContentInfo contentInfo = new ContentInfo
{
    FileUrl = fileUrl
};

// Attach content info to a message
AgentContentMessage agentContentMessage = new AgentContentMessage
{
    ContentInfo = contentInfo,
};

// Attach content to message
AgentMessage agentMessage = new AgentMessage
{
    ContentMessage = agentContentMessage
};

rbmApiHelper.SendAgentMessage(agentMessage, "+12223334444");

Этот код представляет собой фрагмент примера агента RBM .

В качестве альтернативы, вы можете загрузить медиафайлы перед отправкой в сообщении с помощью команды files.create .

Пример загрузки файла

Приведенный ниже код загружает видеофайл и файл с миниатюрой, а затем отправляет оба файла в сообщении. Информацию о форматировании и параметрах значений см. в files.create и AgentContentMessage .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \
-H "Content-Type: video/mp4" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
--upload-file "FULL_PATH_TO_VIDEO_MEDIA_FILE"

# Capture server-specified video file name from response body JSON


curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \
-H "Content-Type: image/jpeg" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
--upload-file "FULL_PATH_TO_THUMBNAIL_MEDIA_FILE"

# Capture server-specified image file name from response body JSON


curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "uploadedRbmFile": {
      "fileName": "SERVER-SPECIFIED_VIDEO_FILE_NAME",
      "thumbnailName": "SERVER-SPECIFIED_THUMBNAIL_FILE_NAME"
    }
  }
}'

Поддерживаемые типы носителей

RCS for Business поддерживает следующие типы мультимедиа. Для миниатюр поддерживаются только image/jpeg, image/jpg, image/gif и image/png.

Тип носителя	Тип документа	Расширение	Работает с многофункциональными карточками.
приложение/огг	OGG аудио	.ogx	Нет
application/pdf	PDF	.pdf	Да (только для Google Сообщений в Индии)
аудио/аАК	аудио AAC	.aac	Нет
аудио/мп3	MP3 аудио	.mp3	Нет
аудио/мпег	MPEG аудио	.mpeg	Нет
аудио/мг	MPG аудио	.mp3	Нет
аудио/мп4	аудио MP4	.mp4	Нет
audio/mp4-latm	MP4-latm аудио	.mp4	Нет
аудио/3gpp	3GPP аудио	.3gp	Нет
изображение/jpeg	JPEG	.jpeg, .jpg	Да
изображение/гиф	GIF	.gif	Да
изображение/png	ПНГ	.png	Да
видео/h263	Видео H263	.h263	Да
видео/м4в	Видео M4V	.m4v	Да
видео/mp4	видео MP4	.mp4	Да
видео/mpeg4	видео MPEG-4	.mp4, .m4p	Да
видео/мпег	видео MPEG	.mpeg	Да
видео/вебм	Видео WebM	.webm	Да

Предложения

Ваш агент отправляет предложения (предложенные ответы и действия) в виде списков с подсказками (максимум 11 предложений) или в виде расширенных карточек (максимум четыре предложения).

Каждое предложение содержит максимум 25 символов.

Предложенные ответы

Функция «Предложенные ответы» помогает пользователям ориентироваться в диалоге, предоставляя варианты ответов, на которые ваш агент знает, как реагировать.

Когда пользователь нажимает на предложенный ответ, ваш агент получает событие, содержащее текст ответа и данные обратной связи . Максимальная длина полезной нагрузки составляет 2048 символов.

Пример

Следующий код отправляет текст с двумя предлагаемыми вариантами ответа. Информацию о форматировании и параметрах значений см. в SuggestedReply .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "reply": {
          "text": "Suggestion #1",
          "postbackData": "suggestion_1"
        }
      },
      {
        "reply": {
          "text": "Suggestion #2",
          "postbackData": "suggestion_2"
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

let suggestions = [
   {
      reply: {
         'text': 'Suggestion #1',
         'postbackData': 'suggestion_1',
      },
   },
   {
      reply: {
         'text': 'Suggestion #2',
         'postbackData': 'suggestion_2',
      },
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with suggestion chips to the device
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();
   suggestions.add(
      new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply());

   suggestions.add(
      new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply());

   // Send simple text message to user
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggested replies for the message to send to the user
cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'))
cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2'))

# Send a simple message with suggestion chips to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

List<Suggestion> suggestions = new List<Suggestion>
{
   // Create suggestion chips
   new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(),
   new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply()
};

// Send simple text message with suggestions to user
rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
   suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Предложенные действия

Функция «Предлагаемые действия» направляет пользователей в ходе разговора, используя встроенные функции их устройств. Ваш агент может предложить пользователям набрать номер, открыть местоположение на карте, поделиться местоположением, открыть URL-адрес или создать событие в календаре.

Для каждого предлагаемого действия вы можете дополнительно указать резервный URL-адрес (максимум 2048 символов). Этот URL-адрес откроется в новом окне браузера, если устройство пользователя не поддерживает предлагаемое действие.

Когда пользователь нажимает на предложенное действие, ваш агент получает событие, содержащее данные обратной связи для этого действия .

Информацию о форматировании и параметрах значений см. в разделе SuggestedAction .

Наберите номер

Функция «Набрать номер» направляет пользователя на номер телефона, указанный вашим оператором. Номера телефонов могут содержать только цифры ( 0-9 ), знак плюс ( + ), звездочку ( * ) и знак цифры ( # ). Поддерживается международный формат E.164 (например, +14155555555 ), но он не является обязательным. То есть, допустимыми вариантами являются как +14155555555 , так и 1011 .

Пример

Приведенный ниже код отправляет действие набора номера. Информацию о форматировании и параметрах значений см. в разделе DialAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Call",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/contact/",
          "dialAction": {
            "phoneNumber": "+15556667777"
          }
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a dial suggested action
let suggestions = [
   {
      action: {
         text: 'Call',
         postbackData: 'postback_data_1234',
         dialAction: {
            phoneNumber: '+15556667777'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a dial suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.DialAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a dial suggested action
   DialAction dialAction = new DialAction();
   dialAction.setPhoneNumber("+15556667777");

   // creating a suggested action based on a dial action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Call");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setDialAction(dialAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a dial suggested action
suggestions = [
      messages.DialAction('Call', 'reply:postback_data_1234', '+15556667777')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a dial an agent suggested action
DialAction dialAction = new DialAction
{
    PhoneNumber = "+15556667777"
};

// Creating a suggested action based on a dial action
SuggestedAction suggestedAction = new SuggestedAction
{
    Text = "Call",
    PostbackData = "postback_data_1234",
    DialAction = dialAction
};

// Attach action to a suggestion
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Посмотреть местоположение

Действие «Просмотреть местоположение» отображает местоположение в приложении карт пользователя по умолчанию. Вы можете указать местоположение либо по широте и долготе, либо с помощью запроса, основанного на текущем местоположении пользователя. Вы также можете установить пользовательскую метку для метки, отображаемой в приложении карт.

Пример

Приведенный ниже код отправляет действие определения местоположения представления. Информацию о форматировании и параметрах значений см. в ViewLocationAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "View map",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/maps/@37.4220188,-122.0844786,15z",
          "viewLocationAction": {
            "latLong": {
              "latitude": "37.4220188",
              "longitude": "-122.0844786"
            },
            "label": "Googleplex"
          }
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a view location suggested action
let suggestions = [
   {
      action: {
         text: 'View map',
         postbackData: 'postback_data_1234',
         viewLocationAction: {
            latLong: {
               latitude: 37.4220188,
               longitude: -122.0844786
            },
            label: 'Googleplex'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a view location suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.ViewLocationAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a view location suggested action
   ViewLocationAction viewLocationAction = new ViewLocationAction();
   viewLocationAction.setQuery("Googleplex, Mountain View, CA");

   // creating a suggested action based on a view location action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("View map");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setViewLocationAction(viewLocationAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a view location suggested action
suggestions = [
      messages.ViewLocationAction('View map',
            'reply:postback_data_1234',
            query='Googleplex, Mountain View, CA')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// create an view location action
ViewLocationAction viewLocationAction = new ViewLocationAction
{
    Query = "Googleplex Mountain View, CA"
};

// Attach the view location action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    ViewLocationAction = viewLocationAction,
    Text = "View map",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Функция «Поделиться местоположением» позволяет пользователю поделиться своим местоположением с вашим агентом. Пользователь может поделиться либо своим текущим местоположением, либо местоположением, выбранным вручную из приложения «Карты».

Пример

Приведенный ниже код отправляет действие «Поделиться местоположением». Информацию о форматировании и параметрах значений см. в разделе ShareLocationAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Share your location",
          "postbackData": "postback_data_1234",
          "shareLocationAction": {}
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a share location suggested action
let suggestions = [
   {
      action: {
         text: 'Share your location',
         postbackData: 'postback_data_1234',
         shareLocationAction: {
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a share location suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.ShareLocationAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a share location suggested action
   ShareLocationAction shareLocationAction = new ShareLocationAction();

   // creating a suggested action based on a share location action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Share location");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setShareLocationAction(shareLocationAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a share location suggested action
suggestions = [
      messages.ShareLocationAction('Share location',
            'reply:postback_data_1234')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a share location action
ShareLocationAction shareLocationAction = new ShareLocationAction();

// Attach the share location action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    ShareLocationAction = shareLocationAction,
    Text = "Share location",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Откройте URL-адрес

Действие «Открыть URL» позволяет перенаправить пользователей на веб-страницу, указанную вашим агентом. По умолчанию веб-страница открывается в браузере пользователя. Вы также можете настроить открытие веб-страницы в веб-представлении. Подробнее см. в разделе «Открыть URL с помощью веб-представления» .

Только в Google Сообщениях

Отображение базового URL-адреса : Для повышения прозрачности в A2P-сообщениях Google Messages отображает базовый URL-адрес в предлагаемых действиях «Открыть URL». Это изменение затрагивает предлагаемые действия в стандартных карточках и каруселях с расширенными карточками .

Карточка с расширенными возможностями отображения, предлагающая вариант «Посмотреть веб-сайт», под которым отображается URL-адрес. — Видимый базовый URL

Отображение значка приложения для веб-ссылок : если у пользователя настроено приложение по умолчанию для веб-страницы, то вместо браузера или веб-просмотра откроется это приложение, а кнопка подсказки отобразит значок приложения. Чтобы значок приложения отображался в Google Сообщениях, необходимо указать полный прямой URL-адрес. Если используется сокращенный URL-адрес, вместо него отобразится значок «Открыть URL» по умолчанию.

Значок приложения в кнопке подсказки

Пример

Приведенный ниже код отправляет действие открытия URL-адреса. Информацию о форматировании и параметрах значений см. OpenUrlAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Open Google",
          "postbackData": "postback_data_1234",
          "openUrlAction": {
            "url": "https://www.google.com"
          }
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define an open URL suggested action
let suggestions = [
   {
      action: {
         text: 'Open Google',
         postbackData: 'postback_data_1234',
         openUrlAction: {
            url: 'https://www.google.com'
         }
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with an open URL suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating an open url suggested action
   OpenUrlAction openUrlAction = new OpenUrlAction();
   openUrlAction.setUrl("https://www.google.com");

   // creating a suggested action based on an open url action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Open Google");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setOpenUrlAction(openUrlAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create an open url suggested action
suggestions = [
      messages.OpenUrlAction('Open Google',
            'reply:postback_data_1234',
            'https://www.google.com')
]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create an open url action
OpenUrlAction openUrlAction = new OpenUrlAction
{
    Url = "https://www.google.com"
};

// Attach the open url action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    OpenUrlAction = openUrlAction,
    Text = "Open Google",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Откройте URL-адрес с помощью веб-просмотра.

Действие «Открыть URL с помощью webview» загружает указанную веб-страницу в приложение для обмена сообщениями, используя механизм отрисовки вашего браузера по умолчанию. Это позволяет пользователю взаимодействовать с веб-страницей, не покидая диалог RCS for Business. Если устройство пользователя не поддерживает webview, веб-страница открывается в браузере пользователя. Чтобы включить webview, см. OpenURLApplication .

Веб-представления имеют три режима отображения. Информацию о форматировании и параметрах значений см. в разделе WebviewViewMode .

Полный экран: Веб-страница занимает весь экран.
Половина: Веб-страница занимает половину экрана.
В высоком режиме: веб-страница занимает три четверти экрана.

Пример

Приведенный ниже код отправляет действие «Открыть URL с помощью webview». Информацию о форматировании и параметрах значений см. в разделе OpenURLAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
 "contentMessage": {
   "text": "Hello, world!",
   "suggestions": [
     {
       "action": {
         "text": "Open Google",
         "postbackData": "postback_data_1234",
         "openUrlAction": {
           "url": "https://www.google.com",
           "application": "WEBVIEW",
           "webviewViewMode": "FULL",
           "description": "Accessibility description"
         }
       }
     }
   ]
 }
}'

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…
  
try {
  
   String URL = "https://www.google.com";
  
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();
  
   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // Create suggestion to view webpage in full mode
   Suggestion viewInFullMode =  getUrlActionInWebview(URL, "FULL")
   suggestions.add(viewInFullMode);
  
   // create suggestion to view webpage in half mode
   Suggestion viewInHalfMode =  getUrlActionInWebview(URL, "HALF")
   suggestions.add(viewInHalfMode);
     
   // create suggestion to view webpage in tall mode
   Suggestion viewInTallMode =  getUrlActionInWebview(URL, "TALL")
   suggestions.add(viewInTallMode);
     
   // Send simple text message with the suggested action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

  /**
    * Creates a suggested action to open URL in webview.
    *
    * @return a suggestion object for an open URL in webview action .
    */
    private Suggestion getUrlActionInWebview(String url,
                                             String viewMode) {
      // create an open url action
      OpenUrlAction openUrlAction = new OpenUrlAction();
      openUrlAction.setUrl(url);
      openUrlAction.setApplication("WEBVIEW");
      openUrlAction.setWebviewViewMode(viewMode);
      openUrlAction.setDescription("Accessibility description");
     
      // attach the open url action to a suggested action
      SuggestedAction suggestedAction = new SuggestedAction();
      suggestedAction.setOpenUrlAction(openUrlAction);
      suggestedAction.setText('display_text');
      suggestedAction.setPostbackData('postback_data_123');
     
      // attach the action to a suggestion object
      Suggestion suggestion = new Suggestion();
      suggestion.setAction(suggestedAction);
     
      return suggestion;
    }

Создать событие в календаре

Действие «Создать событие календаря» открывает приложение календаря пользователя и начинает создание нового события с указанной информацией.

Заголовок события в календаре обязателен. Его длина не должна превышать 100 символов. Описание события в календаре необязательно и имеет максимальную длину 500 символов.

Пример

Приведенный ниже код отправляет действие создания события календаря. Информацию о форматировании и параметрах значений см. в разделе CreateCalendarEventAction .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "text": "Hello, world!",
    "suggestions": [
      {
        "action": {
          "text": "Save to calendar",
          "postbackData": "postback_data_1234",
          "fallbackUrl": "https://www.google.com/calendar",
          "createCalendarEventAction": {
            "startTime": "2020-06-30T19:00:00Z",
            "endTime": "2020-06-30T20:00:00Z",
            "title": "My calendar event",
            "description": "Description of the calendar event"
          }
        }
      }
    ]
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Define a create calendar event suggested action
let suggestions = [
   {
      action: {
         text: 'Save to calendar',
         postbackData: 'postback_data_1234',
         createCalendarEventAction: {
            startTime: '2020-06-30T19:00:00Z',
            endTime: '2020-06-30T20:00:00Z',
            title: 'My calendar event',
            description: 'Description of the calendar event',
         },
      }
   },
];

let params = {
   messageText: 'Hello, world!',
   msisdn: '+12223334444',
   suggestions: suggestions,
};

// Send a simple message with a create calendar event suggested action
rbmApiHelper.sendMessage(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.CreateCalendarEventAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.RbmApiHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();

   // creating a create calendar event suggested action
   CreateCalendarEventAction createCalendarEventAction = new CreateCalendarEventAction();
   calendarEventAction.setTitle("My calendar event");
   calendarEventAction.setDescription("Description of the calendar event");
   calendarEventAction.setStartTime("2020-06-30T19:00:00Z");
   calendarEventAction.setEndTime("2020-06-30T20:00:00Z");

   // creating a suggested action based on a create calendar event action
   SuggestedAction suggestedAction = new SuggestedAction();
   suggestedAction.setText("Save to calendar");
   suggestedAction.setPostbackData("postback_data_1234");
   suggestedAction.setCreateCalendarEventAction(createCalendarEventAction);

   // attaching action to a suggestion
   Suggestion suggestion = new Suggestion();
   suggestion.setAction(suggestedAction);

   suggestions.add(suggestion);

   // Send simple text message with the suggestion action
   rbmApiHelper.sendTextMessage(
      "Hello, world!",
      "+12223334444",
      suggestions
   );
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Create a calendar event suggested action
suggestions = [
      messages.CreateCalendarEventAction('Save to Calendar',
                             'reply:postback_data_1234',
                             '2020-06-30T19:00:00Z',
                             '2020-06-30T20:00:00Z',
                             'My calendar event',
                             'Description of the calendar event')

]

# Create text message to send to user
text_msg = messages.TextMessage('Hello, world!')
cluster = messages.MessageCluster().append_message(text_msg)

# Append suggestions for the message to send to the user
for suggestion in suggestions:
    cluster.append_suggestion_chip(suggestion)

# Send a simple message with suggested action to the device
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Create a calendar event action
CreateCalendarEventAction calendarEventAction = new CreateCalendarEventAction
{
    Title = "My calendar event",
    Description = "Description of the calendar event",
    StartTime = "2020-06-30T19:00:00Z",
    EndTime = "2020-06-30T20:00:00Z"
};

// Attach the calendar event action to a suggested action
SuggestedAction suggestedAction = new SuggestedAction
{
    CreateCalendarEventAction = calendarEventAction,
    Text = "Save to calendar",
    PostbackData = "postback_data_1234"
};

// Attach the action to a suggestion object
Suggestion suggestion = new Suggestion
{
    Action = suggestedAction
};

List<Suggestion> suggestions = new List<Suggestion>
{
    suggestion
};

rbmApiHelper.SendTextMessage(
    "Hello, world!",
    "+12223334444",
    suggestions
);

Этот код представляет собой фрагмент примера агента RBM .

Список чипов для предложений

Ваш агент отправляет списки подсказок с сообщениями, которые помогают пользователям совершать дальнейшие действия. Список подсказок отображается только тогда, когда соответствующее сообщение находится внизу диалога. Любые последующие сообщения в диалоге (от пользователя или вашего агента) перезаписывают список подсказок.

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

В списках чипов содержится максимум 11 чипов с предложениями, а каждая метка чипа может содержать максимум 25 символов.

Информацию о форматировании и параметрах значений см. AgentContentMessage .

Богатые карты

Карточки с расширенными возможностями объединяют медиафайлы, текст и интерактивные подсказки в единое сообщение. Они идеально подходят для представления связанной информации (например, товара с его изображением, названием и ценой) и направления пользователей к следующему шагу, например, к предложению «Посмотреть подробности».

Расширенная карточка может содержать следующее:

Медиафайлы (изображения, GIF-файлы или видео)
Заголовочный текст
Текст описания
Предложенные ответы и действия (максимум 4)

Каждое из этих полей является необязательным, но как минимум одно из полей 1–3 должно быть включено в расширенную карточку.

Несколько открыток можно отправить вместе в виде горизонтально прокручиваемой карусели .

Обратите внимание, что общий объем полезной нагрузки для карты с большим объемом данных составляет 250 КБ.

Подробную техническую информацию см. в документации по Rich Cards .

высота карты

Карточки Rich расширяются по вертикали, чтобы соответствовать своему содержимому. Их минимальная высота составляет 112 DP, а максимальная — 344 DP. Если содержимого карточки недостаточно для заполнения минимальной высоты, карточка расширяется и заполняет оставшуюся высоту пустым пространством.

В расширенных карточках медиаконтент должен соответствовать одной из трех высот:

Короткометражный фильм: 112 ДП
Средний размер: 168 ДП
Высота: 264 DP

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

Пример

Приведенный ниже код отправляет расширенную карточку с изображением и предлагаемыми вариантами ответов. Информацию о форматировании и параметрах значений см. RichCard .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "richCard": {
      "standaloneCard": {
        "thumbnailImageAlignment": "RIGHT",
        "cardOrientation": "VERTICAL",
        "cardContent": {
          "title": "Hello, world!",
          "description": "RBM is awesome!",
          "media": {
            "height": "TALL",
            "contentInfo":{
              "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif",
              "forceRefresh": false
            }
          },
          "suggestions": [
            {
              "reply": {
                "text": "Suggestion #1",
                "postbackData": "suggestion_1"
              }
            },
            {
              "reply": {
                "text": "Suggestion #2",
                "postbackData": "suggestion_2"
              }
            }
          ]
        }
      }
    }
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Suggested replies to be used in the card
let suggestions = [
   {
      reply: {
         'text': 'Suggestion #1',
         'postbackData': 'suggestion_1',
      },
   },
   {
      reply: {
         'text': 'Suggestion #2',
         'postbackData': 'suggestion_2',
      },
   },
];

// Image to be displayed by the card
let imageUrl = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif';

// Definition of the card parameters
let params = {
   messageText: 'Hello, world!',
   messageDescription: 'RBM is awesome!',
   msisdn: '+12223334444',
   suggestions: suggestions,
   imageUrl: imageUrl,
   height: 'TALL',
};

// Send rich card to device
rbmApiHelper.sendRichCard(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.StandaloneCard;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.cards.CardOrientation;
import com.google.rbm.cards.MediaHeight;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;
…

try {
   // Create an instance of the RBM API helper
   RbmApiHelper rbmApiHelper = new RbmApiHelper();

   // Create suggestions for chip list
   List<Suggestion> suggestions = new ArrayList<Suggestion>();
   suggestions.add(
      new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply());

   suggestions.add(
      new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply());

   String imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

   // Create a standalone rich card to send to the user
   StandaloneCard standaloneCard = rbmApiHelper.createStandaloneCard(
       "Hello, world!",
       "RBM is awesome!",
       imageUrl,
       MediaHeight.MEDIUM,
       CardOrientation.VERTICAL,
       suggestions
   );

   rbmApiHelper.sendStandaloneCard(standaloneCard, "+12223334444");
} catch(Exception e) {
   e.printStackTrace();
}

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Suggested replies to be used in the card
suggestions = [
      messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'),
      messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2')
]

# Image to be displayed by the card
image_url = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif';

# Define rich card structure
rich_card = messages.StandaloneCard('VERTICAL',
                                    'Hello, world!',
                                    'RBM is awesome!',
                                    suggestions,
                                    image_url,
                                    None,
                                    None,
                                    'MEDIUM')

# Append rich card and send to the user
cluster = messages.MessageCluster().append_message(rich_card)
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
using RCSBusinessMessaging.Cards;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

List<Suggestion> suggestions = new List<Suggestion>
{
   // Create suggestion chips
   new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(),
   new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply()
};

string imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif";

// Create rich card with suggestions
StandaloneCard standaloneCard = rbmApiHelper.CreateStandaloneCard(
   "Hello, world!",
   "RBM is awesome",
   imageUrl,
   MediaHeight.TALL,
   CardOrientation.VERTICAL,
   suggestions
);

// Send rich card to user
rbmApiHelper.SendStandaloneCard(standaloneCard, "+12223334444");

Этот код представляет собой фрагмент примера агента RBM .

Карусели карт Рича

В режиме карусели можно объединять несколько информативных карточек , позволяя пользователям сравнивать элементы и реагировать на каждый из них по отдельности.

Карусели могут содержать от двух до десяти расширенных карточек. Расширенные карточки в каруселях должны соответствовать общим требованиям к содержимому и высоте расширенных карточек, описанным в документации по расширенным карточкам . Для получения дополнительной информации о структуре и характеристиках карусели см. документацию по каруселям .

Пример

Приведенный ниже код отправляет карусель с расширенными карточками. Информацию о форматировании и параметрах значений см. RichCard .

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d '{
  "contentMessage": {
    "richCard": {
      "carouselCard": {
        "cardWidth": "MEDIUM",
        "cardContents": [
          {
            "title": "Card #1",
            "description": "The description for card #1",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #1",
                  "postbackData": "card_1"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg",
                "forceRefresh": false
              }
            }
          },
          {
            "title": "Card #2",
            "description": "The description for card #2",
            "suggestions": [
              {
                "reply": {
                  "text": "Card #2",
                  "postbackData": "card_2"
                }
              }
            ],
            "media": {
              "height": "MEDIUM",
              "contentInfo": {
                "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg",
                "forceRefresh": false
              }
            }
          }
        ]
      }
    }
  }
}'

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Images for the carousel cards
let card1Image = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg';
let card2Image = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg';

// Define the card contents for a carousel with two cards, each with one suggested reply
let cardContents = [
   {
      title: 'Card #1',
      description: 'The description for card #1',
      suggestions: [
         {
            reply: {
               text: 'Card #1',
               postbackData: 'card_1',
            }
         }
      ],
      media: {
         height: 'MEDIUM',
         contentInfo: {
            fileUrl: card1Image,
            forceRefresh: false,
         },
      },
   },
   {
      title: 'Card #2',
      description: 'The description for card #2',
      suggestions: [
         {
            reply: {
               text: 'Card #2',
               postbackData: 'card_2',
            }
         }
      ],
      media: {
         height: 'MEDIUM',
         contentInfo: {
            fileUrl: card2Image,
            forceRefresh: false,
         },
      },
   },
];

// Definition of carousel card
let params = {
   msisdn: '+12223334444',
   cardContents: cardContents,
};

// Send the device the carousel card defined above
rbmApiHelper.sendCarouselCard(params, function(response) {
   console.log(response);
});

Этот код представляет собой фрагмент примера агента RBM .

Java

import com.google.api.services.rcsbusinessmessaging.v1.model.CardContent;
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion;
import com.google.rbm.cards.CardOrientation;
import com.google.rbm.cards.CardWidth;
import com.google.rbm.cards.MediaHeight;
import com.google.rbm.RbmApiHelper;
import com.google.rbm.SuggestionHelper;
…

try {
            // Create an instance of the RBM API helper
            RbmApiHelper rbmApiHelper = new RbmApiHelper();

            List cardContents = new ArrayList();

            // Images for the carousel cards
            String card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg";

            // Create suggestions for first carousel card
            List card1Suggestions = new ArrayList();
            card1Suggestions.add(
                new SuggestionHelper("Card #1", "card_1"));

            cardContents.add(
                new StandaloneCardHelper(
                    "Card #1",
                    "The description for card #1",
                    card1Image,
                    card1Suggestions)
                    .getCardContent(MediaHeight.SHORT)
            );

            // Images for the carousel cards
            String card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg";

            // Create suggestions for second carousel card
            List card2Suggestions = new ArrayList();
            card2Suggestions.add(
                new SuggestionHelper("Card #2", "card_2"));

            cardContents.add(
                new StandaloneCardHelper(
                    "Card #2",
                    "The description for card #2",
                    card2Image,
                    card2Suggestions)
                    .getCardContent(MediaHeight.SHORT)
            );

            // Send the carousel to the user
            rbmApiHelper.sendCarouselCards(cardContents, CardWidth.MEDIUM, "+12223334444");
        } catch(Exception e) {
            e.printStackTrace();
        }

Этот код представляет собой фрагмент примера агента RBM .

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service
from rcs_business_messaging import messages

# Images for the carousel cards
card_image_1 = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg';
card_image_2 = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg';

# Suggested replies to be used in the cards
suggestions1 = [
      messages.SuggestedReply('Card #1', 'reply:card_1')
]

suggestions2 = [
      messages.SuggestedReply('Card #2', 'reply:card_2')
]

# Define the card contents for a carousel with two cards,
# each with one suggested reply
card_contents = []
card_contents.append(messages.CardContent('Card #1',
                                          'The description for card #1',
                                          card_image_1,
                                          'MEDIUM',
                                          suggestions1))

card_contents.append(messages.CardContent('Card #2',
                                          'The description for card #2',
                                          card_image_2,
                                          'MEDIUM',
                                          suggestions2))

# Send the device the carousel card defined above
carousel_card = messages.CarouselCard('MEDIUM', card_contents)
cluster = messages.MessageCluster().append_message(carousel_card)
cluster.send_to_msisdn('+12223334444')

Этот код представляет собой фрагмент примера агента RBM .

C#

using Google.Apis.RCSBusinessMessaging.v1.Data;
using RCSBusinessMessaging;
using RCSBusinessMessaging.Cards;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                             projectId);

// Image references to be used in the carousel cards
string card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg";
string card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg";

// Suggestion chip lists to be used in carousel cards
List<Suggestion> suggestions1 = new List<Suggestion>
{
   new SuggestionHelper("Card #1", "card_1").SuggestedReply()
};

List<Suggestion> suggestions2 = new List<Suggestion>
{
   new SuggestionHelper("Card #2", "card_2").SuggestedReply()
};

// Create the card content for the carousel
List<CardContent> cardContents = new List<CardContent>
{
   // Add items as card content
   new StandaloneCardHelper(
                    "Card #1",
                    "The description for card #1",
                    card1Image,
                    suggestions1).GetCardContent(),
   new StandaloneCardHelper(
                    "Card #2",
                    "The description for card #2",
                    card2Image,
                    suggestions2).GetCardContent()
};

// Send the carousel to the user
rbmApiHelper.SendCarouselCards(cardContents, CardWidth.MEDIUM, msisdn);

Этот код представляет собой фрагмент примера агента RBM .

Отзыв сообщений

Отправка сообщений Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Получатель не в сети.

Установить срок действия сообщения

Время жизни (TTL) для сообщения

Рекомендации по обработке нестандартных ситуаций

Укажите тип трафика сообщений.

Ограничения на размер сообщений

Текст

Пример

cURL

Node.js

Java

Python

C#

Основное содержимое сообщения - преобразование SMS

Предварительный просмотр содержимого текстовых сообщений и ссылок.

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

Как это работает на Android

Как это работает на iOS

Медиафайлы и PDF-файлы

Технические характеристики миниатюр

Кэширование и управление URL-адресами

Пример URL-адреса файла

cURL

Node.js

Java

Python

C#

Пример загрузки файла

cURL

Поддерживаемые типы носителей

Предложения

Предложенные ответы

Пример

cURL

Node.js

Java

Python

C#

Предложенные действия

Наберите номер

Пример

cURL

Node.js

Java

Python

C#

Посмотреть местоположение

Пример

cURL

Node.js

Java

Python

C#

Поделиться местоположением

Пример

cURL

Node.js

Java

Python

C#

Откройте URL-адрес

Пример

cURL

Node.js

Java

Python

C#

Откройте URL-адрес с помощью веб-просмотра.

Пример

cURL

Java

Создать событие в календаре

Пример

cURL

Node.js

Java

Python

C#

Список чипов для предложений

Отправка сообщений