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

Используйте этот метод для отправки сообщений через каналы мессенджеров (WhatsApp и Viber), SMS и пуш, в том числе, используя каскады, то есть комбинацию каналов.

Метод schedule

В результате выполнения запроса будет отправлено сообщение в канал или по каскаду в соответствии с заданными параметрами (в теле запроса). В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий JSON с идентификатором сообщения и статусом его отправки. В случае неуспешного выполнения запроса возвращается сообщение с кодом ошибки.

URL-адрес подключения

Для отправки сообщения выполняется POST-запрос на URL-адрес: https://app.edna.ru/api/cascade/schedule

Формат запроса

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

Пример запроса

Ниже приведен пример тела запроса с использованием каскада, в рамках которого отправляется сообщение клиенту через канал push, потом сообщение отправляется в WhatsApp клиента, а затем отправляется SMS сообщение.

{
    "requestId": "test-001",
    "comment": "Postman 2022-12-15T13:57:02.575Z",
    "cascadeId": 111,
    "subscriberFilter": {
        "address": "79000000000",
        "type": "PHONE"
    },
    "startTime": "2022-01-21T08:00:00Z",
    "content": {
        "smsContent": {
            "text": "Карта готова, заберите её в отделении банка"
        },
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Карта готова, заберите её в отделении банка",
            "attachment": {
                "url": "https://.jpg", 
                "name": "Схема прохода",
                "size": 5123
            },
            "location": {
                "longitude": 56.7645,
                "latitude": 48.4564,
                "address": "г. Москва, ул Правды, д 3"
            }
        },
        "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"
                }
            }
        }
    }

Параметры запроса

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

Общие параметры

Параметры whatsappContent

Параметры viberContent

Параметры smsContent

Параметры pushContent

* Деятельность сети запрещена на территории РФ

Кавычки в тексте

Необходимо быть внимательным к выделению слов в кавычки. Если вы используете знак двойные кавычки “ или одиночные кавычки ‘ в отправляемом сообщении, то их обязательно нужно отделять знаком \ (обратный слеш).

Правильно:

"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"

Оформление текста в WhatsApp

Вы можете использовать различные опции для оформления текста в WhatsApp сообщениях. Эта опция подключена по умолчанию, отключить её нельзя.

• Курсив: Используйте символ подчеркивания по обе стороны текста: _текст_
• Жирный: Используйте символ звёздочки по обе стороны текста: *текст*
• Зачеркнутый: Используйте символ тильды по обе стороны текста: ~текст~
• Моноширинный: используйте символ трёх кавычек по обе стороны текста: ```текст```

Формат ответа

В ответ на запрос возвращается JSON-объект, содержащий Id отправленного сообщения и статус его обработки.

Типы вложений

Все отправляемые вложения должны удовлетворять нижеперечисленным требованиям. Иначе сообщение не будет доставлено.

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

Важно! Название прикрепленного файла (attachmentName) не может превышать 25 символов для месенджера Viber. Для все остальных допускается не более 75 символов.

Для дополнительной информации по форматам медиа вложений для WhatsApp можно
обратиться на этот ресурс*.

* Деятельность сети запрещена на территории РФ