Перейти к основному контенту

Рассылки


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


Раздел Рассылки служит для создания рассылок по заданному условию для списка  подписчиков.

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

На экранной форме нажать кнопку Новая рассылка.

image.png

При создании  новой рассылки необходимо заполнить следующие параметры:

  • Наименование Рассылки - текстовое название рассылки, например: Рассылка новому подписчику.
  • Запускаемый скрипт конструктора - из выпадающего списка выбрать ранее созданный скрипт, который будет запускаться при старте рассылки.
  • JavaScript условие для запуска рассылки - JS условие при выполнении которого произойдет запуск рассылки, например: у пользователя добавился тэг - подписался_на_обучение.

Нажать кнопку Создать.

image.pngНастройка свойств рассылки

Сценарий скрипта рассылки должен быть описан заранее в отдельном скрипте, например как на рисунке ниже.

image.pngСкрипт рассылки

В данном разделе размещается список рассылок с доступными операциями по ним.

image.pngОперации по рассылкам

  • Запустить рассылку - запуск рассылки будет произведен всем подписчикам по выполненному JS условию. Так как процесс не обратимый, то запуск выполняется при утвердительном ответе на предупреждающее сообщение.
  • Редактировать - открывается форма редактирования настроек рассылки.
  • Удалить - удалить рассылку из списка.
  • Подписчики - список лидов-подписчиков, которым будет произведена рассылка.
  • Сообщения - отчет о количествах сообщений по произведенной рассылке с возможностью отбора количества за период времени. 
    • Выбрать нужного подписчика или оставить параметр Все.
    • Установить календарный период С... - По..., воспользовавшись календарем.
    • Нажать кнопку Применить фильтр.


image.pngОтчет по отправленным сообщениям

После выполненной рассылки в списке Лидов отображается общее количество лидов, на которых была отправлена рассылка.

image.png

При переходе по ссылке Лиды открывается список лидов, которым была отправлена рассылка.

image.png

JS методы для работы с рассылками

С рассылками так же можно работать изс помощью JS следующимиметодов. методамиВсе объектаметоды и их описание вы можете посмотреть в bot:

Название метода Метод Планирование рассылки bot.scheduleBroadcast(?int $broadcastId, ?int $ticketId = null, $jobParams = []): bool Планирование рассылкиСправочнике по кодуфункциям bot.scheduleBroadcastByCodeJS(?string $broadcastCode, ?int $ticketId = null, $jobParams = []): bool Получить ID Рассылки по Коду bot.getBroadcastIdByCode(?string $broadcastCode): ?int

Каждый из методов подробнее расписан ниже.

Планирование рассылки

bot.scheduleBroadcast(?int $broadcastId, ?int $ticketId = null, $jobParams = [])
Описание:

Запускает рассылку в соответствии с указанными параметрами.

Атрибуты:
Имя Тип Описание broadcastId int ID рассылки, которая будет запущена ticketId int ID заявки, для которой будет запущена рассылка jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение планирования рассылки.

Пример:
var result = bot.scheduleBroadcast(1426, null, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});

Планирование рассылки по коду

bot.scheduleBroadcastByCode(?string $broadcastCode, ?int $ticketId = null, $jobParams = [])
Описание:

Запускает рассылку в соответствии с указанными параметрами по коду.

Атрибуты:
Имя Тип Описание broadcastCode string Код рассылки, которая будет запущена ticketId int ID заявки, для которой будет запущена рассылка jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение планирования рассылки.

Пример:
var result = bot.scheduleBroadcastByCode('test_broadcast', null, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "condition_script_code": "if (leadId == 135) { lead.setAttr('рассылка 127', 'выполнено. параметр name: ' + request.json.name); bot.runScriptForLead(7724, 135); }",
  "script_request_params": {
        "name": "Alex" 
  }
});

memory.setAttr('yes_or_not', result ? 'да' : 'нет');

Получить ID Рассылки по Коду

bot.getBroadcastIdByCode(?string $broadcastCode)
Описание:

Находит id рассылки по ее коду.

Атрибуты:
Имя Тип Описание broadcastCode string Код рассылки
Возвращает:

int - id рассылки.