Отправка сообщений по каскаду в канал Push
Для отправки сообщений в канал Push по каскаду используется метод api/cascade/schedule.
В этой статье описана отправка сообщений по каскаду с использование метода api/cascade/schedule и объекта pushContent.
Подробную информацию о методе api/cascade/schedule смотрите в статье:
Вызов метода
Чтобы отправить сообщение в канал Push через каскад по методу api/cascade/schedule, отправьте POST-запрос на URL-адрес https://app.edna.by/api/cascade/schedule.
Примеры запросов
Сообщение с текстом и кнопками
{
"requestId": "test-001",
"cascadeId": 111,
"subscriberFilter": {
"address": "37500000000",
"type": "PHONE"
},
"startTime": "2022-01-21T08:00:00Z",
"content": {
"pushContent": {
"small": {
"text": "Заберите карту в отделении банка",
"title": "Карта готова",
"imageUrl": "https://.png"
},
"big": {
"title": "Карта готова",
"text": "Заберите карту в отделении банка",
"imageUrl": "https://.png"
},
"buttons": [
{
"text": "Поддержка",
"url": "DeeplinkSupport"
},
{
"text": "Напомнить позже",
"url": "DeeplinkLater"
}
],
"action": "DeeplinkMainPush",
"effects": {
"vibrate": "[500,100,500,150,50,50]",
"lights": "#770808",
"sound": "AthlonRoar",
"androidNotificationChannel": "Статус заказа"
},
"iosSettings": {
"interruptionLevel": "ACTIVE",
"category": "ednaPushCategory"
}
}
}
}
Параметры pushContent
Подробную информацию об общих параметрах метода api/cascade/schedule смотрите в статье:
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
small | object | Обязательный | Параметры отображения свернутого push-уведомления. |
small.title | string | Необязательный | Заголовок свернутого push-уведомления. |
small.text | string | Обязательный | Текст свернутого push-уведомления. Оформление текста |
small.imageUrl | string | Необязательный | Иконка (логотип) для отображения в свернутом push-уведомлении. Рекомендуемое соотношение сторон — 1×1. Размер — не более 1024×1024. |
big | object | Необязательный | Параметры отображения расширенного push-уведомления. |
big.title | string | Необязательный | Заголовок развернутого push-уведомления. |
big.text | string | Необязательный | Текст развернутого push-уведомления. Оформление текста |
big.imageUrl | string | Необязательный | Большое изображение для развернутого push-уведомления. Рекомендуются изображения с соотношениями сторон 2×1, где основная визуальная масса остается при обрезке до 1,79×1 и 2,5×1 (ограничения Android). |
action | string | Необязательный | Ссылка, которая будет передана приложению при переходе пользователя по push-уведомлению. |
buttons | object | Необязательный | Параметры отображения кнопок. Вместе с уведомлением можно отобразить до двух кнопок. |
buttons.text | string | Необязательный | Название кнопки. Пользователи увидят это название на кнопке в уведомлении. |
buttons.url | string | Необязательный | Ссылка кнопки. Будет передана приложению при нажатии пользователя на кнопку. |
effects | object | Необязательный | Звук, вибрация, имя notification channel и цвет мигания светодиода на устройстве пользователя при получении push-уведомления. |
effects.sound | string | Необязательный | Имя файла со звуком без расширения. Файл с таким именем должен находиться в каталоге res/raw приложения Android и в корневом каталоге Xcode приложения iOS. |
effects.lights | string | Необязат ельный | Цвет LED при получении push-уведомления (только Android). На некоторых смартфонах Android есть сигнальный светодиод. С помощью этого параметра можно задать цвет мигания этого светодиода при получении push-уведомления. |
effects.vibrate | string | Необязательный | Последовательность промежутков бездействия и вибрации мотора при получении push-уведомления в миллисекундах (только Android). Первое значение — бездействие. Например, при паттерне [300,500,300,500] на устройстве будет 300 мс бездействия, 500 мс вибрации, 300 мс бездействия, 500 мс вибрации. |
effects.androidNotificationChannel | string | Необязательный | Название канала уведомлений для Android. Пользователи увидят это название в настройках смартфона. Изменить параметры канала (звук, вибрацию и цвет светодиода) возможно только для новых получателей push-уведомлений. |
iosSettings | object | Необязательный | Уровень прерывания и категория ContentExtension (только для iOS). |
iosSettings.interruptionLevel | string | Необязательный | Уровень прерывания определяет вид уведомления на iOS 15 и выше. |
iosSettings.category | string | Необязательный | Категория для вызова ContentExtension. Параметр обрабатывается на стороне iOS и определяет, как отрисовывается расширенное push-уведомление. |
attributes | object | Необязательный | Дополнительные параметры push-сообщения. Внутри JSON таблица «ключ-значение». |
Оформление текста
Правила экранирования кавычек в тексте
Знаки кавычек “ или ‘ должны быть отделены знаком \ в отправляемом сообщении.
Пример правильного оформления:
"text": "Мария! Ждем вас на Мастер-класс \"Готовим вместе c Tefal\" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"
"text": "Мария! Ждем вас на Мастер-класс «Готовим вместе c Tefal» 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"
Пример неправильного оформления:
"text": "Мария! Ждем вас на Мастер-класс "Готовим вместе с Tefal" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"
Формат ответа
{
"requestId": "string"
}