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

bot.runScriptByNameForLead()

Запустить скрипт для лида по наименованию

bot.runScriptByNameForLead(?string $scriptName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

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

Атрибуты:
Имя Тип Описание
scriptName string Наименование скрипта, который будет запущен
leadId int ID лида, для которого будет запущен скрипт
ticketId int ID заявки, для которой будет запущен скрипт
addToQueue bool Добавление в очередь скриптов
jobParams json

Передача в планируемую задачу входящих json параметров. Указывать через script_request_params

Возможные параметры в jobParams:

 
  • add_tags — добавить тэги;
  • remove_tags — удалить тэги;
  • is_periodic — будет ли запускаться джоба с периодичностью;
  • repeat_interval_sec — интервал периодичности запуска;
  • script_request_params:
  • run_at — точное время запуска (по часовому поясу сервера);
  • run_after_sec — для запуска через указанное кол-во секунд;
  • condition_script_code — параметр для перекрытия условия триггера/рассылки.

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

Возвращает:

bool - подтверждение запуска скрипта.

Пример:
bot.runScriptByNameForLead('Меню', 165784, null, true);