Цю сторінку перекладено за допомогою 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`	Для повідомлень про послуги, які користувач явно запросив.	Одноразовий пароль, транзакційний, рекламний або багаторазовий
`ACKNOWLEDGEMENT`	Для повідомлень, що використовуються для підтвердження дії користувача, зокрема запиту на відписку. Це підтверджує, що запит користувача отримано та обробляється.	Одноразовий пароль, транзакційний, рекламний або багаторазовий

Якщо тип трафіку не встановлено, система призначає тип за замовчуванням для випадку використання агента .

Варіант використання агента	Тип трафіку за замовчуванням
Одноразовий пароль	`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 .

Ява

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 .

Пітон

# 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 for Business. Повідомлення RCS for Business, що містить до 160 символів UTF-8, називається базовим повідомленням.

Під час створення запиту на надсилання базового повідомлення пам’ятайте, що символи враховуються як 1 байт (UTF-8). Якщо ви надсилаєте повідомлення, що містить спеціальні символи, такі як емодзі або багатобайтовий набір символів, кожен символ враховується як 2–4 символи UTF-8 або більше.

Введіть текст у поле, щоб перевірити його довжину:

Попередній перегляд вмісту текстових повідомлень та посилань

Клієнти RCS можуть реалізовувати попередній перегляд посилань. Якщо текстове повідомлення RCS for Business містить 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 отримано у правильному форматі, SMS Retriever API обробляє його так само, як і SMS OTP. Після того, як хеш зіставляється з вашою програмою, OTP витягується та пересилається до вашої програми для автоматичної перевірки користувача.

Зразок текстового повідомлення RCS for Business для перевірки користувача: Your code is <OTP><app hash>.
Приклад: Your code is 123456 M8tue43FGT.

Щоб дізнатися більше про SMS Retriever та пов’язані API, див. документацію SMS Retriever . Докладніше про автоматичну перевірку користувачів у програмах, зареєстрованих за допомогою SMS Retriever API, див. у цій блок-схемі .

Як це працює для iOS

Для iOS вбудована в систему обробка одноразових паролів автоматично виявляє та пропонує одноразові паролі RCS for Business для автоматичного заповнення, як і для одноразових паролів SMS. Для зчитування одноразових паролів застосунком 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 .

Ява

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 .

Пітон

# 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 підтримує такі типи медіафайлів. Для мініатюр підтримуються лише зображення/jpeg, зображення/jpg, зображення/gif та зображення/png.

Тип медіа	Тип документа	Розширення	Працює з розширеними картками
додаток/ogg	Аудіо OGG	.ogx	Ні
заявка/pdf	PDF-файл	.pdf	Так (лише для Google Messages в Індії)
аудіо/aac	Аудіо AAC	.aac	Ні
аудіо/mp3	Аудіо у форматі MP3	.mp3	Ні
аудіо/mpeg	MPEG-аудіо	.mpeg	Ні
аудіо/миль на галон	Аудіо на галон	.mp3	Ні
аудіо/mp4	Аудіо MP4	.mp4	Ні
аудіо/mp4-latm	Аудіо MP4-LATM	.mp4	Ні
аудіо/3gpp	Аудіо 3GPP	.3gp	Ні
зображення/jpeg	JPEG	.jpeg, .jpg	Так
зображення/gif	GIF	.gif	Так
зображення/png	PNG	.png	Так
відео/h263	Відео H263	.h263	Так
відео/m4v	Відео M4V	.m4v	Так
відео/mp4	Відео MP4	.mp4	Так
відео/mpeg4	Відео MPEG-4	.mp4, .m4p	Так
відео/mpeg	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 .

Ява

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 .

Пітон

# 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 .

Ява

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 .

Пітон

# 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 .

Ява

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 .

Пітон

# 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 .

Ява

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 .

Пітон

# 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 Повідомленнях: Якщо для веб-сторінки налаштовано програму за замовчуванням, вона відкривається замість браузера або веб-перегляду, а кнопка пропозиції відображає значок програми. Щоб значок програми відображався в 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 .

Ява

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 .

Пітон

# 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-адресу за допомогою WebView

Дія «Відкрити URL-адресу за допомогою веб-перегляду» завантажує вказану веб-сторінку всередині програми обміну повідомленнями за допомогою механізму рендерингу вашого браузера за замовчуванням. Це дозволяє користувачеві взаємодіяти з веб-сторінкою, не виходячи з розмови RCS for Business. Якщо пристрій користувача не підтримує веб-перегляди, веб-сторінка відкривається в його браузері. Щоб увімкнути веб-перегляди, див. OpenURLApplication .

Веб-перегляди мають три режими відображення. Щодо форматування та параметрів значень див. WebviewViewMode .

Повний: Веб-сторінка займає весь екран
Половина: Веб-сторінка займає половину екрана
Високий: Веб-сторінка займає три чверті екрана

Приклад

Наведений нижче код надсилає дію «Відкрити 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",
           "application": "WEBVIEW",
           "webviewViewMode": "FULL",
           "description": "Accessibility description"
         }
       }
     }
   ]
 }
}'

Ява

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 .

Ява

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 .

Пітон

# 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 КБ.

Повні технічні деталі див. у документації до розширених карток .

Висота картки

Розширені картки розгортаються вертикально, щоб помістити свій вміст. Їхня мінімальна висота становить 112 DP, а максимальна – 344 DP. Якщо вміст картки недостатньо великий, щоб заповнити мінімальну висоту картки, картка розгортається та заповнює додаткову висоту пробілами.

Медіафайли в розширених картках повинні відповідати одній із трьох висот:

Короткий: 112 DP
Середній: 168 DP
Зріст: 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 .

Ява

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 .

Пітон

# 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 .

Ява

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 .

Пітон

# 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 .

Далі

Revoke messages

Надсилати повідомлення Тримайте все під контролем за допомогою колекцій Зберігайте контент і організовуйте його за категоріями відповідно до своїх потреб.

Одержувач не в мережі

Встановити термін дії повідомлення

Час життя (TTL) для повідомлення

Рекомендації щодо обробки крайніх випадків

Встановіть тип трафіку повідомлень

Обмеження розміру повідомлення

Текст

Приклад

cURL

Node.js

Ява

Пітон

C#

Базовий вміст повідомлення - конвертація SMS

Попередній перегляд вмісту текстових повідомлень та посилань

Одноразові паролі для перевірки користувачів

Як це працює для Android

Як це працює для iOS

Медіафайли та PDF-файли

Специфікації мініатюр

Кешування та керування URL-адресами

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

cURL

Node.js

Ява

Пітон

C#

Приклад завантаження файлу

cURL

Підтримувані типи медіа

Пропозиції

Пропоновані відповіді

Приклад

cURL

Node.js

Ява

Пітон

C#

Пропоновані дії

Наберіть номер

Приклад

cURL

Node.js

Ява

Пітон

C#

Переглянути місцезнаходження

Приклад

cURL

Node.js

Ява

Пітон

C#

Поділитися місцезнаходженням

Приклад

cURL

Node.js

Ява

Пітон

C#

Відкрити URL-адресу

Приклад

cURL

Node.js

Ява

Пітон

C#

Відкрийте URL-адресу за допомогою WebView

Приклад

cURL

Ява

Створити подію в календарі

Приклад

cURL

Node.js

Ява

Пітон

C#

Список пропозицій

Надсилати повідомлення