bot.scheduleTriggerByCode()

Планирование триггера по коду

bot.scheduleTriggerByCode(string $triggerCode, int|null $leadId, int|null $ticketId = null, $jobParams = [])

Описание:

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

Атрибуты:

Имя	Тип	Описание
triggerCode	string	Код триггера, который будет запущен
leadId	int	ID лида, для которого будет запущен триггер
ticketId	int	ID заявки, для которой будет запущен триггер
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 - подтверждение планирования триггера.

Пример:

var result = bot.scheduleTriggerByCode("trigger_code", 1426, null, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});