# 07. Справочник по функциям JS

# Справочник всех функций

### Получение данных бота

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE" style="border-collapse: collapse; width: 100.001%; height: 173.495px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.1686%; height: 29.537px;">Метод</td><td style="width: 49.9215%; height: 29.537px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 50.1686%; height: 35.1389px;"><span style="font-weight: 300;">bot.**getAllData**(): **array**</span>

</td><td style="width: 49.9215%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает все данные текущего бота</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.1686%; height: 35.1389px;"><span style="font-weight: 300;">bot.**setData**(string $key, $value): **self**</span></td><td style="width: 49.9215%; height: 35.1389px;"><span style="font-weight: 400;">Устанавливает значение данных текущего бота по ключу</span>

</td></tr><tr style="height: 38.5417px;"><td style="width: 50.1686%; height: 38.5417px;">[<span style="font-weight: 300;">bot.</span>**getData**<span style="font-weight: 300;">(string $key):</span> **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetdata "bot.getData()")</td><td style="width: 49.9215%; height: 38.5417px;"><span style="font-weight: 400;">Возвращает данные текущего бота по ключу</span>

</td></tr></tbody></table>

### Работа с лидами

#### Методы bot

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-0" style="border-collapse: collapse; width: 100%; height: 75.8796px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[<span style="font-weight: 300;">bot.**findLeads**(array|object $columns = \[\], array|object $where = \[\], array|object $orderBy = \[\], int|null $limit = null, int|null $offset = null): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindleads "bot.findLeads()")</td><td style="width: 50.045%; height: 46.3426px;">Находит лиды по указанным атрибутам</td></tr><tr><td style="width: 50.045%;">[<span style="font-weight: 300;">bot.**getGeoLocation**(): **array|null**</span>](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/botgetgeolocation "bot.getGeoLocation()")</td><td style="width: 50.045%;">Возвращает геолокацию лида</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-1" style="border-collapse: collapse; width: 100%; height: 751.181px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%;"><span style="font-weight: 300;">lead.**getAllData**(): **array**</span>

</td><td style="width: 50.045%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает все данные лида</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;"><span style="font-weight: 300;">lead.**setData**(string $key, $value): **self**</span></td><td style="width: 50.045%; height: 35.1389px;"><span style="font-weight: 400;">Устанавливает значение данных лида по ключу</span>

Возможные ключи:

- **id** - id лида;
- **identification** - внешний id лида;
- **manager\_id** - id менеджера привязанного к лиду;
- **bot\_id** - id бота лида;
- **channel\_id** - id канала лида;
- **status\_id** - id статуса лида;
- **extra** - дополнения;
- **is\_mute** - включен ли бот для лида;
- все системные поля лида (по английски).

</td></tr><tr style="height: 232.234px;"><td style="width: 50.045%; height: 232.234px;">[lead.**getData**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetdata "lead.getData()")</td><td style="width: 50.045%; height: 232.234px;">Возвращает значение данных лида по ключу

Возможные ключи:

- **id** - id лида;
- **identification** - внешний id лида;
- **manager\_id** - id менеджера привязанного к лиду;
- **bot\_id** - id бота лида;
- **channel\_id** - id канала лида;
- **status\_id** - id статуса лида;
- **extra** - дополнения;
- **is\_mute** - включен ли бот для лида;
- все системные поля лида (по английски).

</td></tr><tr style="height: 116.111px;"><td style="width: 50.045%; height: 116.111px;">[<span style="font-weight: 300;">lead.</span>**issetData**<span style="font-weight: 300;">(string $key): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetdata-i-leadisdataexist "lead.issetData() и lead.isDataExist()")

</td><td rowspan="2" style="height: 232.234px; width: 50.045%;">Проверяет наличие данных лида по ключу

Возможные ключи:

- **id** - id лида;
- **identification** - внешний id лида;
- **manager\_id** - id менеджера привязанного к лиду;
- **bot\_id** - id бота лида;
- **channel\_id** - id канала лида;
- **status\_id** - id статуса лида;
- **extra** - дополнения;
- **is\_mute** - включен ли бот для лида;
- все системные поля лида (по английски).

</td></tr><tr style="height: 116.123px;"><td style="width: 50.045%; height: 116.123px;">[lead.**isDataExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetdata-i-leadisdataexist "lead.issetData() и lead.isDataExist()")

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[lead.**getSerialNumber**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetserialnumber "lead.getSerialNumber()")</td><td style="width: 50.045%; height: 35.1389px;">Возвращает порядковый номер лида в текущем боте</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[lead.**getChannelCode**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetchannelcode "lead.getChannelCode()")</td><td style="width: 50.045%; height: 35.1389px;">Возвращает код канала лида</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">lead.**isInlineButtonsAvailable**(): **bool|null**</td><td style="width: 50.045%; height: 35.1389px;">Проверяет включены ли инлайн кнопки</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">lead.**isInlineButtonsAvailableGeneralChannelSetting**(): **bool|null**</td><td style="width: 50.045%; height: 46.3426px;">Возвращает настройки кнопок канала</td></tr></tbody></table>

### Работа со скриптами

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-2" style="width: 100.001%; height: 838.259px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"> Метод</td><td style="width: 50.045%; height: 29.537px;"> Описание</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**scheduleScript**(int|null $scriptId, int|null $leadId, int|null $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulescript "bot.scheduleScript()")</td><td style="width: 50.045%; height: 57.5463px;">Планирует вызов скрипта</td></tr><tr><td style="width: 50.045%;">bot.**scheduleScriptByCode**(string $scriptCode, int|null $leadId, int|null $ticketId = null, $jobParams = \[\]): **bool**</td><td style="width: 50.045%;">Планирует вызов скрипта по коду</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getScriptIdByName**(string|null $scriptName): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetscriptidbyname "bot.getScriptIdByName()")</td><td style="width: 50.045%; height: 35.1389px;">Возвращает ID скрипта по наименованию</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getScriptIdByCode**(string|null $scriptCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetscriptidbycode "bot.getScriptIdByCode()")</td><td style="width: 50.045%; height: 35.1389px;">Возвращает ID скрипта по коду</td></tr><tr style="height: 34.1389px;"><td style="width: 50.045%; height: 34.1389px;">bot.**getScriptCodeById**(string|null $scriptId): **int|null**</td><td style="width: 50.045%; height: 34.1389px;">Возвращает код скрипта по ID</td></tr><tr><td style="width: 50.045%;">[bot.**runScriptForLead**(?int $scriptId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptforlead "bot.runScriptForLead()")</td><td style="width: 50.045%;">Запускает скрипт для лида по ID скрипта</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot**.runScriptByNameForLead**(string|null $scriptName, int|null $leadId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbynameforlead "bot.runScriptByNameForLead()")</td><td style="width: 50.045%; height: 79.9537px;">Запускает скрипт для лида по наименованию скрипта</td></tr><tr style="height: 96.7593px;"><td style="width: 50.045%; height: 96.7593px;">[bot.**runScriptForPerson**(int|null $scriptId, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptforperson "bot.runScriptForPerson()")  
  
</td><td style="width: 50.045%; height: 96.7593px;">Запускает скрипт для персоны по ID скрипта</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**runScriptByNameForPerson**(string|null $scriptName, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbynameforperson "bot.runScriptByNameForPerson()")</td><td style="width: 50.045%; height: 79.9537px;">Запускает скрипт для персоны по наименованию скрипта</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**runScriptByCodeForLead**(string|null $scriptCode, int|null $leadId, int |null$ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbycodeforlead "bot.runScriptByCodeForLead()")</td><td style="width: 50.045%; height: 79.9537px;">Запускает скрипт для лида по коду</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**runScriptByCodeForPerson**(string|null $scriptCode, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbycodeforperson "bot.runScriptByCodeForPerson()")</td><td style="width: 50.045%; height: 79.9537px;">Запускает скрипт для персоны по коду</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**clearJobsByScriptId**(int|null $scriptId, int|null $leadId = null): **bool** ](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptid "bot.clearJobsByScriptId()")</td><td style="width: 50.045%; height: 57.5463px;">Очищает джобы по id скрипта</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**clearJobsByScriptName**(string|null $scriptName, int|null $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptname "bot.clearJobsByScriptName()")</td><td style="width: 50.045%; height: 57.5463px;">Очищает джобы по наименованию скрипта</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**clearJobsByScriptCode**(string|null $scriptCode, int|null $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptcode)</td><td style="width: 50.045%; height: 57.5463px;">Очищает джобы по коду скрипта</td></tr></tbody></table>

### Работа с атрибутами

#### Методы bot

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-3" style="border-collapse: collapse; width: 100.001%; height: 587.816px;"><tbody><tr style="background-color: #c2e0f4; height: 29.8px;"><td style="width: 49.5508%; height: 29.8px;">Метод</td><td style="width: 50.4158%; height: 29.8px;">Описание</td></tr><tr style="height: 37.9333px;"><td style="width: 49.5508%; height: 37.9333px;">[bot.**setAttr(**string $key, string $value): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetattr "bot.setAttr()")</td><td style="width: 50.4158%; height: 37.9333px;">Устанавливает значение переменной бота</td></tr><tr style="height: 37.9333px;"><td style="width: 49.5508%; height: 37.9333px;">[bot.**getAttr**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetattr "bot.getAttr()")</td><td style="width: 50.4158%; height: 37.9333px;">Возвращает значение переменной бота</td></tr><tr style="height: 37.9333px;"><td style="width: 49.5508%; height: 37.9333px;">[bot.**getAllAttr**<span style="font-weight: 300;">(): </span>**array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetallattr "bot.getAllAttr()")</td><td style="width: 50.4158%; height: 37.9333px;">Возвращает массив всех переменных бота</td></tr><tr style="height: 29.6px;"><td style="width: 49.5508%; height: 29.6px;">bot.**getIntAttr**(string $key, ?int<span style="font-weight: 300;">|null</span> $default = 0): **int**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.4158%; height: 29.6px;">Возвращает значение int переменной бота</td></tr><tr style="height: 46.4px;"><td style="width: 49.5508%; height: 46.4px;">bot.**getFloatAttr**(string $key, ?float<span style="font-weight: 300;">|null</span> $default = 0.0): **float**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.4158%; height: 46.4px;">Возвращает значение float переменной бота</td></tr><tr style="height: 46.4px;"><td style="width: 49.5508%; height: 46.4px;">bot.**getBoolAttr**(string $key, ?bool<span style="font-weight: 300;">|null</span> $default = false): **bool**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.4158%; height: 46.4px;">Возвращает значение bool переменной бота</td></tr><tr style="height: 36.5333px;"><td style="width: 49.5508%; height: 36.5333px;">[<span style="font-weight: 300;">bot.**issetAttr**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botissetattr-i-botisattrexist "bot.issetAttr() и bot.isAttrExist()")</td><td rowspan="2" style="height: 73.0833px; width: 50.4158%;">Проверяет наличие переменной бота  
</td></tr><tr style="height: 36.55px;"><td style="width: 49.5508%; height: 36.55px;">[<span style="font-weight: 300;">bot.**isAttrExist**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botissetattr-i-botisattrexist)</td></tr><tr style="height: 35.05px;"><td style="width: 49.5508%; height: 35.05px;"><span style="font-weight: 300;">bot.**getAllJsonAttrs**(): **array**</span></td><td style="width: 50.4158%; height: 35.05px;">Возвращает значение всех JSON переменных бота</td></tr><tr style="height: 29.6px;"><td style="width: 49.5508%; height: 29.6px;"><span style="font-weight: 300;">bot.**setJsonAttr**(string $key, $value): **self**</span></td><td style="width: 50.4158%; height: 29.6px;">Устанавливает значение JSON переменной бота</td></tr><tr style="height: 35.1333px;"><td style="width: 49.5508%; height: 35.1333px;"><span style="font-weight: 300;">bot.**getJsonAttr**(string $key): **mixed|null**</span></td><td style="width: 50.4158%; height: 35.1333px;">Возвращает значение JSON переменной бота</td></tr><tr style="height: 36.5333px;"><td style="width: 49.5508%; height: 36.5333px;">bot.**issetJsonAttr**(string $key): **bool**

</td><td rowspan="2" style="height: 73.0833px; width: 50.4158%;">Проверяет наличие JSON переменной бота  
</td></tr><tr style="height: 36.55px;"><td style="width: 49.5508%; height: 36.55px;">bot.**isJsonAttrKeyExist**(string $key): **bool**

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-4" style="border-collapse: collapse; width: 100.001%; height: 1315.62px;"><tbody><tr style="background-color: #c2e0f4; height: 29.6px;"><td style="width: 50.045%; height: 29.6px;">Метод</td><td style="width: 50.045%; height: 29.6px;">Описание</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;">[<span style="font-weight: 300;">lead.**setAttr**(string $key, string $value): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetattr "lead.setAttr()")</td><td style="width: 50.045%; height: 37.9333px;">Устанавливает значение переменной лида</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;">[<span style="font-weight: 300;">lead.**getAttr**(string $key): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetattr "lead.getAttr()")</td><td style="width: 50.045%; height: 37.9333px;">Возвращает значение переменной лида</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;">[<span style="font-weight: 300;">lead.**getAllAttr**(): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetallattr)</td><td style="width: 50.045%; height: 37.9333px;">Возвращает все переменные лида</td></tr><tr style="height: 48.05px;"><td style="width: 50.045%; height: 48.05px;"><span style="font-weight: 300;">lead</span>.**getIntAttr**(string $key, ?int<span style="font-weight: 300;">|null</span> $default = 0): **int**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 48.05px;">Возвращает значение int переменной лида</td></tr><tr style="height: 48.05px;"><td style="width: 50.045%; height: 48.05px;"><span style="font-weight: 300;">lead</span>.**getFloatAttr**(string $key, ?float<span style="font-weight: 300;">|null</span> $default = 0.0): **float**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 48.05px;">Возвращает значение float переменной лида</td></tr><tr style="height: 47.05px;"><td style="width: 50.045%; height: 47.05px;"><span style="font-weight: 300;">lead</span>.**getBoolAttr**(string $key, ?bool<span style="font-weight: 300;">|null</span> $default = false): **bool**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 47.05px;">Возвращает значение bool переменной лида</td></tr><tr style="height: 36.5333px;"><td style="width: 50.045%; height: 36.5333px;">[<span style="font-weight: 300;">lead.**issetAttr**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetattr-i-leadisattrexist)</td><td rowspan="2" style="height: 73.0833px; width: 50.045%;">Проверяет наличие переменной лида  
</td></tr><tr style="height: 36.55px;"><td style="width: 50.045%; height: 36.55px;">[<span style="font-weight: 300;">lead.**isAttrExist**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetattr-i-leadisattrexist)</td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**deleteAttrs**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeleteattrs-i-leaddeleteattr "lead.deleteAttrs() и lead.deleteAttr()")</td><td rowspan="2" style="height: 162.7px; width: 50.045%;">Удаляет переменную/переменные лида  
</td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**deleteAttr**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeleteattrs-i-leaddeleteattr)</td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**forceDeleteAttrs**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeleteattrs-i-leadforcedeleteattr "lead.forceDeleteAttrs() и lead.forceDeleteAttr()")</td><td rowspan="2" style="height: 162.7px; width: 50.045%;">Принудительно удаляет переменную/переменные лида из БД  
</td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**forceDeleteAttr**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeleteattrs-i-leadforcedeleteattr)</td></tr><tr style="height: 35.05px;"><td style="width: 50.045%; height: 35.05px;"><span style="font-weight: 300;">lead.**getAllJsonAttrs**(): **array**</span></td><td style="width: 50.045%; height: 35.05px;">Возвращает значение всех JSON переменных лида</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">lead.**setJsonAttr**(string $key, $value): **self**</span></td><td style="width: 50.045%; height: 29.6px;">Устанавливает значение JSON переменной лида</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">lead.**getJsonAttr**(string $key): **mixed|null**</span></td><td style="width: 50.045%; height: 29.6px;">Возвращает значение JSON переменной лида</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">lead.**issetJsonAttr**(string $key): **bool**</span></td><td rowspan="2" style="height: 59.2px; width: 50.045%;">Проверяет наличие JSON переменной лида  
</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">lead.**isJsonAttrKeyExist**(string $key): **bool**</span></td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**deleteJsonAttrs**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletejsonattrs-i-leaddeletejsonattr "lead.deleteJsonAttrs() и lead.deleteJsonAttr()")</td><td rowspan="2" style="height: 162.7px; width: 50.045%;">Удаляет json-переменную/json-переменные лида  
<span style="font-weight: 300;">  
</span></td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**deleteJsonAttr**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletejsonattrs-i-leaddeletejsonattr "lead.deleteJsonAttrs() и lead.deleteJsonAttr()")</td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**forceDeleteJsonAttrs**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletejsonattrs-i-leadforcedeletejsonattr "lead.forceDeleteJsonAttrs() и lead.forceDeleteJsonAttr()")</td><td rowspan="2" style="height: 162.7px; width: 50.045%;">Принудительно удаляет json-переменную/json-переменные лида из БД  
<span style="font-weight: 300;">  
</span></td></tr><tr style="height: 81.35px;"><td style="width: 50.045%; height: 81.35px;">[<span style="font-weight: 300;">lead.**forceDeleteJsonAttr**(string|object|array|null $attrs, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletejsonattrs-i-leadforcedeletejsonattr)</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;"><span style="font-weight: 300;">lead</span>.**setAllLiveTexAttrs**(<span style="font-weight: 300;">string </span>$value): **self**

</td><td style="width: 50.045%; height: 37.9333px;">Устанавливает значение всех LiveTex переменных лида</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;"><span style="font-weight: 300;">lead</span>.**setLiveTexAttr**(string $key,<span style="font-weight: 300;">string</span> $value): **self**

</td><td style="width: 50.045%; height: 37.9333px;">Устанавливает значение LiveTex переменной лида</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;"><span style="font-weight: 300;">lead</span>.**getAllLiveTexAttrs**(): **array**

</td><td style="width: 50.045%; height: 37.9333px;">Возвращает значение всех LiveTex переменных лида</td></tr><tr style="height: 37.9333px;"><td style="width: 50.045%; height: 37.9333px;"><span style="font-weight: 300;">lead</span>.**getLiveTexAttr**(string $key)<span style="font-weight: 300;">: **mixed|null**</span>

</td><td style="width: 50.045%; height: 37.9333px;">Возвращает значение LiveTex переменной лида</td></tr></tbody></table>

#### Методы memory

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-memor" style="border-collapse: collapse; width: 100.001%; height: 667.583px;"><tbody><tr style="background-color: #c2e0f4; height: 29.6px;"><td style="width: 50.045%; height: 29.6px;">Метод</td><td style="width: 50.045%; height: 29.6px;">Описание</td></tr><tr style="height: 35.1333px;"><td style="width: 50.045%; height: 35.1333px;"><span style="font-weight: 300;">memory.**setAttr**(string $key, string $value): **self**</span></td><td style="width: 50.045%; height: 35.1333px;">Устанавливает значение временной переменной</td></tr><tr style="height: 35.1333px;"><td style="width: 50.045%; height: 35.1333px;"><span style="font-weight: 300;">memory.**getAttr**(string $key): **string|null**</span></td><td style="width: 50.045%; height: 35.1333px;">Возвращает значение временной переменной</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">memory</span>.**getIntAttr**(string $key, ?int<span style="font-weight: 300;">|null</span> $default = 0): **int**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 29.6px;">Возвращает значение int временной переменной</td></tr><tr style="height: 46.4px;"><td style="width: 50.045%; height: 46.4px;"><span style="font-weight: 300;">memory</span>.**getFloatAttr**(string $key, ?float<span style="font-weight: 300;">|null</span> $default = 0.0): **float**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 46.4px;">Возвращает значение float временной переменной</td></tr><tr style="height: 46.4px;"><td style="width: 50.045%; height: 46.4px;"><span style="font-weight: 300;">memory</span>.**getBoolAttr**(string $key, ?bool<span style="font-weight: 300;">|null</span> $default = false): **bool**<span style="font-weight: 300;">**|null**</span></td><td style="width: 50.045%; height: 46.4px;">Возвращает значение bool временной переменной</td></tr><tr style="height: 35.1333px;"><td style="width: 50.045%; height: 35.1333px;"><span style="font-weight: 300;">memory.**issetAttr**(string $key): **bool**</span></td><td rowspan="2" style="height: 70.2833px; width: 50.045%;">Проверяет наличие временной переменной  
</td></tr><tr style="height: 35.15px;"><td style="width: 50.045%; height: 35.15px;"><span style="font-weight: 300;">memory.**isAttrExist**(string $key): **bool**</span></td></tr><tr style="height: 36.05px;"><td style="width: 50.045%; height: 36.05px;"><span style="font-weight: 300;">memory.**setAllJsonAttrs**(array $data): **self**</span></td><td style="width: 50.045%; height: 36.05px;">Устанавливает значение всех временных JSON переменных</td></tr><tr style="height: 35.05px;"><td style="width: 50.045%; height: 35.05px;"><span style="font-weight: 300;">memory.**getAllJsonAttrs**(): **array**</span></td><td style="width: 50.045%; height: 35.05px;">Возвращает значение всех временных JSON переменных</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">memory.**setJsonAttr**(string $key, $value): **self**</span></td><td style="width: 50.045%; height: 29.6px;">Устанавливает значение временной JSON переменной</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">memory.**getJsonAttr**(string $key): **mixed|null**</span></td><td style="width: 50.045%; height: 29.6px;">Возвращает значение временной JSON переменной</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">memory.**issetJsonAttr**(string $key): **bool**</span></td><td rowspan="2" style="height: 59.2px; width: 50.045%;">Проверяет наличие временной JSON переменной  
</td></tr><tr style="height: 29.6px;"><td style="width: 50.045%; height: 29.6px;"><span style="font-weight: 300;">memory.**isJsonAttrKeyExist**(string $key): **bool**</span></td></tr></tbody></table>

### Работа с триггерами

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-5" style="border-collapse: collapse; width: 100.001%; height: 1535.96px;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4;"><td style="width: 50.045%; height: 29.7917px;">Метод</td><td style="width: 50.045%; height: 29.7917px;">Описание</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**scheduleTrigger**(int|null $triggerId, int|null $leadId, int|null $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botscheduletrigger "bot.scheduleTrigger()")</td><td style="width: 50.045%; height: 57.5463px;">Планирует запуск триггера</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">bot.**scheduleTriggerByCode**(string $triggerCode, int|null $leadId, int|null $ticketId = null, $jobParams = \[\]): **bool**</td><td style="width: 50.045%; height: 49.3056px;">Планирует запуск триггера по коду

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**runTriggerForLead**(?int $triggerId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerforlead "bot.runTriggerForLead()")

</td><td style="width: 50.045%; height: 57.5463px;">Запускает триггер для лида по ID триггера</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**runTriggerByCodeForLead**(string|null $triggerCode, int|null $leadId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbycodeforlead "bot.runTriggerByCodeForLead()")</td><td style="width: 50.045%; height: 79.9537px;">Планирует запуск триггера по коду</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**runTriggerByCodeForPerson**(string|null $triggerCode, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbycodeforperson "bot.runTriggerByCodeForPerson()")</td><td style="width: 50.045%; height: 79.9537px;">Планирует запуск триггера по коду для последнего лида персоны</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**clearTriggerJobsForLead**(int|null $leadId, int|null $ticketId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsforlead "bot.clearTriggerJobsForLead()")</td><td style="width: 50.045%; height: 57.5463px;">Удаляет триггеры для лида</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**clearTriggerJobsForAllPersonLeads**(int|null $personId, int|null $ticketId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsforallpersonleads "bot.clearTriggerJobsForAllPersonLeads()")

</td><td style="width: 50.045%; height: 57.5463px;">Удаляет триггеры для всех лидов персоны</td></tr><tr style="height: 35.3819px;"><td style="width: 50.045%; height: 35.3819px;">[<span style="font-weight: 300;">bot.</span>**getTriggerIdByName**<span style="font-weight: 300;">(string|null $triggerName): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettriggeridbyname "bot.getTriggerIdByName()")

</td><td style="width: 50.045%; height: 35.3819px;"><span style="font-weight: 400;">Возвращает ID триггера по наименованию</span></td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**getTriggerIdByCode**(string|null $triggerCode): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettriggeridbycode "bot.getTriggerIdByCode()")

</td><td style="width: 50.045%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID Триггера по Коду</span></td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[<span style="font-weight: 300;">bot.</span>**runTriggerByNameForLead**<span style="font-weight: 300;">(string|null $triggerName, int|null $leadId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbynameforlead "bot.runTriggerByNameForLead()")

</td><td style="width: 50.045%; height: 79.9537px;"><span style="font-weight: 400;">Запускает триггер для лида по наименованию</span></td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[<span style="font-weight: 300;">bot.**runTriggerForPerson**(int|null $triggerId, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerforperson "bot.runTriggerForPerson()")

</td><td style="width: 50.045%; height: 79.9537px;"><span style="font-weight: 400;">Запускает триггер для персоны по ID</span></td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[<span style="font-weight: 300;">bot.**runTriggerByNameForPerson**(string|null $triggerName, int|null $personId, int|null $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbynameforperson "bot.runTriggerByNameForPerson()")

</td><td style="width: 50.045%; height: 79.9537px;"><span style="font-weight: 400;">Запускает триггер для персоны по наименованию</span></td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 300;">bot.</span>**clearTriggerJobsByScriptId**<span style="font-weight: 300;">(int|null $scriptId, int|null $leadId = null): **bool**</span>

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы триггера </span><span style="font-weight: 400;">по id скрипта</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 300;">bot.</span>**clearTriggerJobsByScriptName**<span style="font-weight: 300;">(string|null $scriptName, int|null $leadId = null): **bool**</span>

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы триггера </span><span style="font-weight: 400;">по наименованию скрипта</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;">[<span style="font-weight: 300;">bot.</span>**clearTriggerJobsById**<span style="font-weight: 300;">(int|null $triggerId, int|null $leadId = null): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyid "bot.clearTriggerJobsById()")

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы </span><span style="font-weight: 400;">по id триггера</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 300;">bot.</span>**clearTriggerJobsByCode**<span style="font-weight: 300;">(string|null $triggerCode, int|null $leadId = null, int $ticketId = null): **bool**</span>

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы </span><span style="font-weight: 400;">по коду триггера</span>

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">bot.**clearTriggerJobsByCodeForAllPersonLeads**(string|null $triggerCode, int|null $personId, int $ticketId = null): **bool**

</td><td style="width: 50.045%; height: 57.5463px;">Удаляет триггеры для всех лидов персоны по коду</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;">[<span style="font-weight: 300;">bot.</span>**clearTriggerJobsByName**<span style="font-weight: 300;">(string|null $triggerName, int|null $leadId = null): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyname "bot.clearTriggerJobsByName()")

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы по</span><span style="font-weight: 400;"> наименованию триггера</span>

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[<span style="font-weight: 300;">bot.**clearTriggerJobsByScriptCode**(string|null $scriptCode, int|null $leadId = null, int|null $ticketId = null): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyscriptcode "bot.clearTriggerJobsByScriptCode()")

</td><td style="width: 50.045%; height: 57.5463px;"><span style="font-weight: 400;">Очищает джобы по коду скрипта</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;">[<span style="font-weight: 300;">bot.</span>**clearTriggerJobsByIdForTicket**<span style="font-weight: 300;">(int|null $triggerId, int|null $ticketId): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyidforticket "bot.clearTriggerJobsByIdForTicket()")

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы по </span><span style="font-weight: 400;"> id триггера и ID заявки</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;">[<span style="font-weight: 300;">bot.</span>**clearTriggerJobsByNameForTicket**<span style="font-weight: 300;">(string|null $triggerName, int|null $ticketId): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbynameforticket "bot.clearTriggerJobsByNameForTicket()")

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы </span><span style="font-weight: 400;">по наименованию триггера и ID заявки</span>

</td></tr><tr style="height: 80.162px;"><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 300;">bot.</span>**clearTriggerJobsByCodeForTicket**<span style="font-weight: 300;">(string|null $triggerCode, int|null $ticketId): </span>**bool**

</td><td style="width: 50.045%; height: 80.162px;"><span style="font-weight: 400;">Очищает джобы </span><span style="font-weight: 400;">по коду триггера и ID заявки</span>

</td></tr></tbody></table>

### Работа со статусами

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-6" style="border-collapse: collapse; width: 100.001%; height: 424.722px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[<span style="font-weight: 300;">lead.</span>**isInStatus**<span style="font-weight: 300;">(string $statusName): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadisinstatus "lead.isInStatus()")</td><td style="width: 50.045%; height: 35.1389px;">Проверяет существует ли статуса у лида</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getStatusId**(): **int**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")[<span style="font-weight: 300;">**|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")</td><td style="width: 50.045%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id статуса лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**getAllStatuses**(): **array**</span></td><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 400;">Возвращает все статусы лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**getAllStatusesIndexedByName**(): **array**</span></td><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 400;">Возвращает все наименования статусов лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**setStatusId**(int $statusId, string $name): **self**</span></td><td style="width: 50.045%; height: 29.537px;">Устанавливает <span style="font-weight: 400;">id статуса лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**setStatusName**(string $name): **self**</span></td><td style="width: 50.045%; height: 29.537px;">Устанавливает <span style="font-weight: 400;">наименование статуса лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**getStatusName**(): **string**</span></td><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 400;">Возвращает наименование статуса лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**setStatus**(int $statusId, string $name): **self**</span></td><td style="width: 50.045%; height: 29.537px;">Устанавливает <span style="font-weight: 400;">статус лида</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**setStatusById**(int $statusId): **self**</span></td><td style="width: 50.045%; height: 29.537px;">Устанавливает<span style="font-weight: 400;"> статус лида по id </span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**issetStatusById**(string $id): **bool**</span></td><td style="width: 50.045%; height: 29.537px;">Проверяет существует ли статуса у лида по <span style="font-weight: 400;">id</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**issetStatusByName**(string $name): **bool**</span></td><td style="width: 50.045%; height: 29.537px;">Проверяет существует ли статуса у лида по наименованию</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**getStatusIdByName**(string $statusName): **int**</span></td><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id статуса лида по наименованию</span></td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;"><span style="font-weight: 300;">lead.**setStatusByName**(string $statusName): **self**</span></td><td style="width: 50.045%; height: 29.537px;">Устанавливает<span style="font-weight: 400;"> статус лида по наименованию</span></td></tr></tbody></table>

### Работа с рассылками

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-7" style="border-collapse: collapse; width: 100.001%; height: 718.25px;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr><td style="width: 50.045%;">[bot.**scheduleBroadcast**(int|null $broadcastId, int|null $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulebroadcast "bot.scheduleBroadcast()")</td><td style="width: 50.045%;"><span style="background-color: #ffffff;">Планирует запуск рассылки</span></td></tr><tr><td style="width: 50.045%;">[bot.**scheduleBroadcastByCode**(string|null $broadcastCode, int|null $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulebroadcastbycode "bot.scheduleBroadcastByCode()")</td><td style="width: 50.045%;"><span style="background-color: #ffffff;">Планирует запуск рассылки по коду</span></td></tr><tr style="height: 49.625px;"><td style="width: 50.045%; height: 49.625px;">[bot.**getBroadcastIdByCode**(string|null $broadcastCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetbroadcastidbycode "bot.getBroadcastIdByCode()")</td><td style="width: 50.045%; height: 49.625px;"><span style="background-color: #ffffff;">Возвращает ID рассылки по коду</span></td></tr></tbody></table>

### Работа с тэгами

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-8" style="border-collapse: collapse; width: 100.001%; height: 683.033px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.</span>**isTagExist**<span style="font-weight: 300;">('some\_tag'): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadistagexist-i-leadissettag "lead.isTagExist() и lead.issetTag()")</td><td rowspan="2" style="height: 70.2778px; width: 50.4158%;"><span style="font-weight: 400;">Проверяет наличие тэга лида</span>  
<span style="font-weight: 400;">  
</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**issetTag**('some\_tag'): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadistagexist-i-leadissettag)</td></tr><tr><td style="width: 49.5508%;"><span style="font-weight: 300;">lead.**setTag**(string $key, $value): **self**</span></td><td style="width: 50.4158%;"><span style="font-weight: 400;">Устанавливает значение тэга лида</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getTag**(string $key): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgettag "lead.getTag()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает значение тэга лида</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getAllTags**(): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetalltags "lead.getAllTags()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает массив всех тэгов лида</span></td></tr><tr style="height: 81.6667px;"><td style="width: 49.5508%; height: 81.6667px;">[<span style="font-weight: 300;">lead.**addTags**(string|object|array|null $tags, int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadaddtags-i-leadaddtag "lead.addTags() и lead.addTag()")</td><td rowspan="2" style="height: 163.333px; width: 50.4158%;">Добавляет тэги лиду  
</td></tr><tr style="height: 81.6667px;"><td style="width: 49.5508%; height: 81.6667px;">[<span style="font-weight: 300;">lead.**addTag**(string|object|array|null $tags, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadaddtags-i-leadaddtag)</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">lead.**deleteTags**(string|object|array|null $tags, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletetags-i-leaddeletetag "lead.deleteTags() и lead.deleteTag()")</td><td rowspan="2" style="height: 159.907px; width: 50.4158%;">Удаляет тэги лида  
</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">lead.**deleteTag**(string|object|array|null $tags, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletetags-i-leaddeletetag)</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">lead.**forceDeleteTags**(string|object|array|null $tags, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletetags-i-leadforcedeletetag "lead.forceDeleteTags() и lead.forceDeleteTag()")</td><td rowspan="2" style="height: 159.907px; width: 50.4158%;">Принудительно удаляет тэги лида из БД  
<span style="font-weight: 300;">  
</span></td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">lead.**forceDeleteTag**(string|object|array|null $tags, int|null $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletetags-i-leadforcedeletetag "lead.forceDeleteTags() и lead.forceDeleteTag()")</td></tr></tbody></table>

### Работа с контекстами

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-9" style="border-collapse: collapse; width: 100.001%; height: 258.958px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;"><span style="font-weight: 300;">lead.**setContext**(string $key, $value): **self**</span></td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Устанавливает значение контекста лида</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.</span>**isContextExist**<span style="font-weight: 300;">('some\_tag'): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadiscontextexist-i-leadissetcontext "lead.isContextExist() и lead.issetContext()")</td><td rowspan="2" style="height: 70.2778px; width: 50.4158%;"><span style="font-weight: 400;">Проверяет наличие контекста лида</span>  
<span style="font-weight: 400;">  
</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**issetContext**('some\_tag'): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadiscontextexist-i-leadissetcontext)</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getContext**(string $key): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetcontext "lead.getContext()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает значение контекста лида</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getAllContexts**(): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetallcontexts "lead.getAllContexts()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает массив всех контекстов лида</span></td></tr></tbody></table>

### Работа с переключением на оператора

#### Методы bot

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-10" style="border-collapse: collapse; width: 100.001%; height: 65.1875px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%;">[bot.**getForwardEventType**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetforwardeventtype "bot.getForwardEventType()")</td><td style="width: 50.4158%;">Проверяет кто переключил на оператора

</td></tr><tr><td style="width: 49.5508%;">[bot.**isForwardedToOperator**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisforwardedtooperator "bot.isForwardedToOperator()")</td><td style="width: 50.4158%;">Проверяет переключения на оператора

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-11" style="border-collapse: collapse; width: 100.001%; height: 65.1875px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 49.5508%; height: 35.3906px;">[lead.**setForwarded**(bool|int $state): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetforwarded "lead.setForwarded()")</td><td style="width: 50.4158%; height: 35.3906px;">Переключает бот на оператора

</td></tr></tbody></table>

### Работа с заявками

#### Методы bot

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-12" style="border-collapse: collapse; width: 100.001%; height: 588.704px; border-color: #34495e;"><tbody><tr style="height: 29.537px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.</span>**createTicket**<span style="font-weight: 300;">($data): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcreateticket "bot.createTicket()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Создает заявку</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**updateTicketById**(int $ticketId, $data): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botupdateticketbyid "bot.updateTicketById()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Обновляет заявку</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**getMaxRejectsTicketCount**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetmaxrejectsticketcount "bot.getMaxRejectsTicketCount()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает максимальное количество отказов</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[<span style="font-weight: 300;">bot.**findTickets**($where = \[\], bool $findInAllBusinessBots = false, $orderBy = \[\], int|null $limit = null, int|null $offset = null): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindtickets "bot.findTickets()")</td><td style="width: 50.4158%; height: 57.5463px;"><span style="font-weight: 400;">Находит заявку по заданным атрибутам</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[<span style="font-weight: 300;">bot.**findTicketIdByCustomField**(string $fieldName, $value): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindticketidbycustomfield "bot.findTicketIdByCustomField()")</td><td style="width: 50.4158%; height: 57.5463px;">Возвращает id заявки по значению поля

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**getTicketTypeIdByName**(string $typeName): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettickettypeidbyname "bot.getTicketTypeIdByName()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id заявки по наименованию вида заявки</span></td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;"><span style="font-weight: 300;">bot.**getTicketTypeNameById**(int|null $ticketTypeId): **string|null**</span></td><td style="width: 50.4158%; height: 46.3426px;"><span style="font-weight: 400;">Возвращает наименование заявки по id вида заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**getTicketStatusIdByName**(string $statusName): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetticketstatusidbyname "bot.getTicketStatusIdByName()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id заявки по наименованию статуса заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">bot.**setCurrentTicketById**(int|null $ticketId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetcurrentticketbyid "bot.setCurrentTicketById()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Устанавливает указанную заявку как текущую</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[bot.**clearTicketAssignedPersonsLog**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearticketassignedpersonslog "bot.clearTicketAssignedPersonsLog()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Очищает лог назначения тикета персонам</span></td></tr></tbody></table>

#### Методы ticket

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-13" style="border-collapse: collapse; width: 100.001%; height: 4921.56px; border-color: #34495e;"><tbody><tr style="height: 29.537px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**update**($data): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketupdate "ticket.update()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Обновляет заявку, через объект заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">ticket.**getAllData**(): **array**</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает значение всех данных заявки</span>

</td></tr><tr style="height: 433.9px;"><td style="width: 49.5508%; height: 433.9px;"><span style="font-weight: 300;">ticket.**setData**(string $key, $value): **self**</span>

</td><td style="width: 50.4158%; height: 433.9px;"><span style="font-weight: 400;">Устанавливает значение данных заявки по ключу</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 433.9px;"><td style="width: 49.5508%; height: 433.9px;">[<span style="font-weight: 300;">ticket.</span>**getData**<span style="font-weight: 300;">(string $key): </span>**mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetdata "ticket.getData()")

</td><td style="width: 50.4158%; height: 433.9px;"><span style="font-weight: 400;">Возвращает значение данных заявки по ключу</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 450.706px;"><td style="width: 49.5508%; height: 450.706px;">[<span style="font-weight: 300;">ticket.**getCustomData**(string $key): **mixed|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetcustomdata "ticket.getCustomData()")

</td><td style="width: 50.4158%; height: 450.706px;"><span style="font-weight: 400;">Считывает произвольные поля заявки по ключу</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-1"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **названия всех произвольных полей заявки**;
- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 216.933px;"><td style="width: 49.5508%; height: 216.933px;">[<span style="font-weight: 300;">ticket.</span>**issetData**<span style="font-weight: 300;">(string $key): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetdata-i-ticketisdataexist "ticket.issetData() и ticket.isDataExist()")

</td><td rowspan="2" style="height: 433.901px; width: 50.4158%;"><span style="font-weight: 400;">Проверяет наличие данных по заявке по ключу</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-2"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 216.968px;"><td style="width: 49.5508%; height: 216.968px;">[<span style="font-weight: 300;">ticket.</span>**isDataExist**<span style="font-weight: 300;">(string $key): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetdata-i-ticketisdataexist)

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**reloadCustomData**(bool $isReloadModel = false): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketreloadcustomdata "ticket.reloadCustomData()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Перезагружает кастомные данные</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;"><span style="font-weight: 300;">ticket.**loadCustomDataIfNotLoaded**(bool $isReloadModel = false): **bool**</span>

</td><td style="width: 50.4158%; height: 57.5463px;"><span style="font-weight: 400;">Загружает кастомные данные, если они не загружены</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">[ticket.**setAllCustomData**(array $customData): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetallcustomdata "ticket.setAllCustomData()")  
</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Переопределяет список кастомных полей</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getAllCustomData**(): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetallcustomdata "ticket.getAllCustomData()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает список кастомных полей</span></td></tr><tr style="height: 450.706px;"><td style="width: 49.5508%; height: 450.706px;">[<span style="font-weight: 300;">ticket.**setCustomData**(string $key, $value): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetcustomdata "ticket.setCustomData()")

</td><td style="width: 50.4158%; height: 450.706px;"><span style="font-weight: 400;">Устанавливает значение кастомного поля</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-3"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **названия всех произвольных полей заявки**;
- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 450.706px;"><td style="width: 49.5508%; height: 450.706px;">[<span style="font-weight: 300;">ticket.**issetCustomData**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetcustomdata "ticket.issetCustomData()")

</td><td style="width: 50.4158%; height: 450.706px;"><span style="font-weight: 400;">Проверяет имеет ли значение кастомное поле</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-4"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **названия всех произвольных полей заявки**;
- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 450.706px;"><td style="width: 49.5508%; height: 450.706px;">[<span style="font-weight: 300;">ticket.**isCustomDataExist**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketiscustomdataexist "ticket.isCustomDataExist()")

</td><td style="width: 50.4158%; height: 450.706px;"><span style="font-weight: 400;">Проверяет существует ли кастомное поле</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-5"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **названия всех произвольных полей заявки**;
- **id** - id заявки;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **author\_person\_id** - id автора заявки;
- **client\_person\_id** - id клиента заявки;
- **assigned\_person\_id** - id исполнителя заявки;
- **ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;
- **payment\_type\_id** - id способа оплаты. Доступные значения: 
    - 0 - PAYMENT\_TYPE\_NONE;
    - **1** - PAYMENT\_TYPE\_ROBOKASSA;
    - **2** - PAYMENT\_TYPE\_YANDEXKASSA;
    - **3** - PAYMENT\_TYPE\_CASH;
- **status\_id** - id статуса заявки;
- **title** - заголовок заявки;
- **description** - описание заявки;
- **created\_at** - время создания заявки;
- **updated\_at** - время обновления заявки;
- **deleted\_at** - время удаления заявки;
- все системные поля заявки (по английски).

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getTicketTypeName**(): **string**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgettickettypename "ticket.getTicketTypeName()")**[|null](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")**

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает название типа заявки</span></td></tr><tr style="height: 37.338px;"><td style="width: 49.5508%; height: 37.338px;">[<span style="font-weight: 300;">ticket.</span>**getStatusId**<span style="font-weight: 300;">(): </span>**int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusid-i-ticketgetattrstatus-id "ticket.getStatusId() и ticket.getAttr("status_id")")**[|null](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")**

</td><td rowspan="2" style="height: 72.4769px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает ID статуса заявки</span>

  
</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket<span style="font-weight: 400;">.**getAttr**('status\_id')<span style="font-weight: 300;">: </span>**int**</span></span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusid-i-ticketgetattrstatus-id)**[|null](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")**

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getStatusName**(): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusname "ticket.getStatusName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает название статуса заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getStatusType**<span style="font-weight: 300;">(): </span>**string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatustype "ticket.getStatusType()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает тип статуса заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**isInStatus**<span style="font-weight: 300;">($statusName): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketisinstatus "ticket.isInStatus()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Проверяет статус заявки</span>

</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">ticket.</span>**setStatusId**<span style="font-weight: 300;">(int|null $statusId, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetstatusid "ticket.setStatusId()")

</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Устанавливает статус заявки по id</span>

</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[<span style="font-weight: 300;">ticket.</span>**setStatusByName**<span style="font-weight: 300;">(string $statusName, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetstatusbyname "ticket.setStatusByName()")

</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Устанавливает статус заявки по имени</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**reloadTicket**<span style="font-weight: 300;">(): </span>**bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketreloadticket "ticket.reloadTicket()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Загружает заявку повторно</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonid "ticket.getAuthorPersonId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID автора заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonid "ticket.getAssignedPersonId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID исполнителя заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonid "ticket.getClientPersonId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID клиента заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonFullName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonfullname "ticket.getAuthorPersonFullName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ФИО автора заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonFullName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonfullname "ticket.getAssignedPersonFullName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ФИО исполнителя заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonFullName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonfullname "ticket.getClientPersonFullName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ФИО клиента заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonRoleId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroleid "ticket.getAuthorPersonRoleId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID роли автора заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonRoleId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroleid "ticket.getAssignedPersonRoleId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID роли исполнителя заявки</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonRoleId**<span style="font-weight: 300;">(): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroleid "ticket.getClientPersonRoleId()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID роли клиента заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonRoleName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonrolename "ticket.getAuthorPersonRoleName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает имя роли автора заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonRoleName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonrolename "ticket.getAssignedPersonRoleName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает имя роли исполнителя заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonRoleName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonrolename "ticket.getClientPersonRoleName()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает имя роли клиента заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonRoleTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroletitle "ticket.getAuthorPersonRoleTitle()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает заголовок роли автора заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonRoleTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroletitle "ticket.getAssignedPersonRoleTitle()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает заголовок роли исполнителя заявки</span></td></tr><tr style="height: 49.3056px;"><td style="width: 49.5508%; height: 49.3056px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonRoleTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroletitle "ticket.getClientPersonRoleTitle()")

</td><td style="width: 50.4158%; height: 49.3056px;"><span style="font-weight: 400;">Возвращает заголовок роли клиента заявки</span></td></tr><tr style="height: 49.3056px;"><td style="width: 49.5508%; height: 49.3056px;">[<span style="font-weight: 300;">ticket.</span>**getAuthorPersonRoleFormattedTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroleformattedtitle "ticket.getAuthorPersonRoleFormattedTitle()")

</td><td style="width: 50.4158%; height: 49.3056px;"><span style="font-weight: 400;">Возвращает форматированное название роли автора заявки</span></td></tr><tr style="height: 49.3056px;"><td style="width: 49.5508%; height: 49.3056px;">[<span style="font-weight: 300;">ticket.</span>**getAssignedPersonRoleFormattedTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroleformattedtitle "ticket.getAssignedPersonRoleFormattedTitle()")

</td><td style="width: 50.4158%; height: 49.3056px;"><span style="font-weight: 400;">Возвращает форматированное название роли исполнителя заявки</span></td></tr><tr style="height: 49.3056px;"><td style="width: 49.5508%; height: 49.3056px;">[<span style="font-weight: 300;">ticket.</span>**getClientPersonRoleFormattedTitle**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroleformattedtitle "ticket.getClientPersonRoleFormattedTitle()")

</td><td style="width: 50.4158%; height: 49.3056px;"><span style="font-weight: 400;">Возвращает форматированное название роли клиента заявки</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getPerson1Id**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson1id "ticket.getPerson1Id()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id первой дополнительной персоны</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getPerson2Id**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson2id "ticket.getPerson2Id()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id второй дополнительной персоны</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">ticket.**getPerson3Id**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson3id "ticket.getPerson3Id()")

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id третьей дополнительной персоны</span></td></tr><tr style="height: 37.5463px;"><td style="width: 49.5508%; height: 37.5463px;">[<span style="font-weight: 300;">ticket.**setPerson1Id**(int|null $personId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson1id "ticket.setPerson1Id()")

</td><td style="width: 50.4158%; height: 37.5463px;"><span style="font-weight: 400;">Устанавливает id первой дополнительной персоны</span></td></tr><tr style="height: 44.5255px;"><td style="width: 49.5508%; height: 44.5255px;">[<span style="font-weight: 300;">ticket.**setPerson2Id**(int|null $personId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson2id "ticket.setPerson2Id()")

</td><td style="width: 50.4158%; height: 44.5255px;"><span style="font-weight: 400;">Устанавливает id второй дополнительной персоны</span></td></tr><tr style="height: 44.5255px;"><td style="width: 49.5508%; height: 44.5255px;">[<span style="font-weight: 300;">ticket.**setPerson3Id**(int|null $personId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson3id "ticket.setPerson3Id()")

</td><td style="width: 50.4158%; height: 44.5255px;"><span style="font-weight: 400;">Устанавливает id третьей дополнительной персоны</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">ticket.**getTotalFormatted**(): **string**</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает <span style="font-weight: 300;"><span style="font-weight: 400;">форматированную итоговую <span style="font-weight: 300;"><span style="font-weight: 400;"><span style="font-weight: 300;"><span style="font-weight: 400;">стоимость заказа</span></span></span></span></span></span></span></td></tr><tr style="height: 49.3056px;"><td style="width: 49.5508%; height: 49.3056px;"><span style="font-weight: 300;">ticket.**getSubtotalFormatted**(): **string**</span>

</td><td style="width: 50.4158%; height: 49.3056px;"><span style="font-weight: 400;">Возвращает <span style="font-weight: 300;"><span style="font-weight: 400;">форматированную промежуточную <span style="font-weight: 300;"><span style="font-weight: 400;"><span style="font-weight: 300;"><span style="font-weight: 400;">стоимость заказа</span></span></span></span></span></span></span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">ticket.**getTotalFeeFormatted**(): **string**</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает <span style="font-weight: 300;"><span style="font-weight: 400;">форматированную <span style="font-weight: 300;"><span style="font-weight: 400;">стоимость заказа</span></span></span></span></span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">ticket.**getDeliveryFeeFormatted**(): **string**</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 300;"><span style="font-weight: 400;">Возвращает форматированную стоимость доставки</span></span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;"><span style="font-weight: 300;">ticket.**getTicketLines**(): **ScriptTicketLine**</span>

</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 300;"><span style="font-weight: 400;">Возвращает массив объектов ScriptTicketLine</span></span>

</td></tr></tbody></table>

#### Методы ScriptTicketLine

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-14" style="border-collapse: collapse; width: 100.001%; height: 804.12px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 49.5508%; height: 29.7917px;">ScriptTicketLine.**reload**(): **bool**</td><td style="width: 50.4158%; height: 29.7917px;">Обновить данные по строке заявки из бд</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getId**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id <span style="font-weight: 300;"><span style="font-weight: 400;">ScriptTicketLine</span></span></span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getTicketId**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id заявки</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getProductId**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id продукта заявки</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getProduct**(): **ScriptProduct|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает все данные продукта заявки</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getQuantity**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает количество продукта в заявке</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getPrice**(): **float**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает цену продукта в заявке</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getPriceFormatted**(): **string**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает форматированную цену продукта в заявки</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**getPriceDateFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает цену продукта в заявке в указанном форматировании</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**priceDateFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getFee**(): **float**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает стоимость заявки</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getFeeFormatted**(): **string**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает форматированную стоимость заявки</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptTicketLine.**getSubtotal**(): **float**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает итоговую стоимость заявки</span></td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;">ScriptTicketLine.**getSubtotalFormatted**(): **string**</td><td style="width: 50.4158%; height: 46.3426px;"><span style="font-weight: 400;">Возвращает форматированную итоговую стоимость заявки</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**getCreatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 57.5463px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату создания заказа</span>  
<span style="font-weight: 400;">  
</span></td></tr><tr><td style="width: 49.5508%;">ScriptTicketLine.**createdAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**getUpdatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату обновления заказа</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**updatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**getDeletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату удаления заказа</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptTicketLine.**deletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr></tbody></table>

#### Методы ScriptProduct

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scrip" style="border-collapse: collapse; width: 100.001%; height: 700.231px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 49.5508%; height: 29.7917px;">ScriptProduct.**reload**(): **bool**</td><td style="width: 50.4158%; height: 29.7917px;"> Обновить данные по продукту из бд</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getId**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getTitle**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает наименование продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getCode**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает код продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getPrice**(): **float|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает цену продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getMainCategoryId**(): **int|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id категории продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getIsEnabled**(): **bool|null**</td><td style="width: 50.4158%; height: 29.537px;">Проверяет активен ли продукт</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getIsAvailableInStock**(): **bool|null**</td><td style="width: 50.4158%; height: 29.537px;">Проверяет есть ли продукт в наличии</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getUrl**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает url продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getThumbUrl**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает thumb url продукта</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ScriptProduct.**getPriceFormatted**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает форматированную цену продукта</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**getCreatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату создания продукта</span>  
</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**createdAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**getUpdatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату обновления продукта</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**updatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**getDeletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату удаления продукта</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ScriptProduct.**deletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr></tbody></table>

### Работа со статусами заявок

#### Методы ticketStatus

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-ticke" style="border-collapse: collapse; width: 100.001%; height: 557.893px; border-color: #34495e;"><tbody><tr style="background-color: #c2e0f4; height: 29.7917px;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">ticketStatus.**reload**(): **bool**</td><td style="width: 50.4158%; height: 35.1389px;">Перезагружает статус в БД</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ticketStatus.**getId**(): **int**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id статуса</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ticketStatus.**getName**(): **string**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает наименование статуса</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ticketStatus.**getType**(): **string|null**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает тип статуса</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ticketStatus.**getOrderPos**(): **int**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает значение статуса</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">ticketStatus.**isSameStatusName**($statusName): **bool**</td><td style="width: 50.4158%; height: 29.537px;">Проверяет наименование статуса на сходство</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**getCreatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату создания статуса</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**createdAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**getUpdatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату обновления статуса</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**updatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**getDeletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td><td rowspan="2" style="height: 115.093px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает форматированную дату удаления статуса</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">ticketStatus.**deletedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**

</td></tr></tbody></table>

#### Методы ticketStatuses

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-ticke-0" style="border-collapse: collapse; width: 100.001%; height: 925.579px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[ticketStatuses.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesreload "ticketStatuses.reload()")</td><td style="width: 50.4158%; height: 35.1389px;">Перезагружает все статусы из БД</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[ticketStatuses.**getCollection**(): **Collection|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesgetcollection "ticketStatuses.getCollection()")</td><td style="width: 50.4158%; height: 35.1389px;">Возвращает Laravel Collection</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[ticketStatuses.**find**(array|object|null $where, bool $isReturnCollection = false): **ScriptTicketStatus|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfind "ticketStatuses.find()")</td><td style="width: 50.4158%; height: 57.5463px;">Возвращает статусы заявок</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[ticketStatuses.**findById**(string|int|null $id): **ScriptTicketStatus|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindbyid "ticketStatuses.findById()")</td><td style="width: 50.4158%; height: 57.5463px;">Возвращает статус по ID</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[ticketStatuses.**findByName**(string $name): **ScriptTicketStatus|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindbyname "ticketStatuses.findByName()")</td><td style="width: 50.4158%; height: 57.5463px;">Возвращает статус по имени</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[ticketStatuses.**findAllByNames**(string|array|object|null $names, string $operator = '=', bool $isReturnCollection = false): **Collection|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindallbynames "ticketStatuses.findAllByNames()")</td><td style="width: 50.4158%; height: 79.9537px;">Возвращает статусы по имени</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[ticketStatuses.**findAllByTypes**(string|array|object|null $types, string $operator = '=', bool $isReturnCollection = false): **Collection|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindallbytypes "ticketStatuses.findAllByTypes()")</td><td style="width: 50.4158%; height: 79.9537px;">Возвращает статусы по типу статуса</td></tr></tbody></table>

### Работа с персонами

#### Методы bot

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-15" style="border-collapse: collapse; width: 100.001%; height: 1009.33px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 49.5508%; height: 29.7969px;">[<span style="font-weight: 300;">bot.</span>**createPerson**<span style="font-weight: 300;">($data): </span>**int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcreateperson "bot.createPerson()")</td><td style="width: 50.4158%; height: 29.7969px;"><span style="font-weight: 400;">Создает персону</span></td></tr><tr style="height: 46.5938px;"><td style="width: 49.5508%; height: 46.5938px;">[bot.**findPersons**($where = \[\], $orderBy = \[\], int|null $limit = null, int|null $offset = null, bool $isLogErrorIfManyPersonsFound = false): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindpersons "bot.findPersons()")</td><td style="width: 50.4158%; height: 46.5938px;">Возвращает данные персон соответствующих атрибутам</td></tr><tr style="height: 35.3906px;"><td style="width: 49.5508%; height: 35.3906px;">[<span style="font-weight: 300;">bot.**updatePersonById**(int $personId, $data): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botupdatepersonbyid "bot.updatePersonById()")</td><td style="width: 50.4158%; height: 35.3906px;"><span style="font-weight: 400;">Обновляет персону по id</span>

</td></tr><tr style="height: 35.3906px;"><td style="width: 49.5508%; height: 35.3906px;">[<span style="font-weight: 300;">bot.**deletePersonById**(int $personId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdeletepersonbyid "bot.deletePersonById()")</td><td style="width: 50.4158%; height: 35.3906px;"><span style="font-weight: 400;">Удаляет персону по id</span>

</td></tr><tr><td style="width: 49.5508%;"><span style="font-weight: 300;">bot.**getDefaultPersonRoleId**(): **int|null**</span></td><td style="width: 50.4158%;"><span style="font-weight: 400;">Возвращает id персоны по умолчанию</span>

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-16" style="border-collapse: collapse; width: 100.001%; height: 135.451px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**getPersonId**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetpersonid "lead.getPersonId()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает id персоны</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">lead.**setPersonId**(int|null $personId): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetpersonid "lead.setPersonId()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Привязывает персону к лиду</span></td></tr><tr style="height: 35.3819px;"><td style="width: 49.5508%; height: 35.3819px;">[<span style="font-weight: 300;">lead.**createPersonForCurrentLead**($data): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadcreatepersonforcurrentlead "lead.createPersonForCurrentLead()")</td><td style="width: 50.4158%; height: 35.3819px;"><span style="font-weight: 400;">Создает персону для лида</span>

</td></tr></tbody></table>

#### Методы person

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-17" style="border-collapse: collapse; width: 100.001%; height: 1657.93px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**update**($data): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personupdate "person.update()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Обновляет данные персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**delete**(): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persondelete "person.delete()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Удаляет персону</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getAllData**(): **array**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetalldata "person.getAllData()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает все поля персоны</span>

</td></tr><tr style="height: 383.484px;"><td style="width: 49.5508%; height: 383.484px;">[<span style="font-weight: 300;">person.**setData**(string $key, $value): **self**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetdata "person.setData()")</td><td style="width: 50.4158%; height: 383.484px;"><span style="font-weight: 400;">Устанавливает поле персоны по ключу</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-6"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id персоны;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **person\_role\_id** - id роли;
- **is\_external** - значение поля **Сотрудник/Клиент**;
- **user\_id** - id пользователя;
- **firstname** - имя;
- **lastname** - фамилия;
- **middlename** - отчество;
- **email** - адрес электронной почты;
- **phone** - номер телефона;
- **organization\_name** - название организации;
- **organization\_address** - адрес организации;
- **comment** - комментарий;
- **created\_at** - дата создания;
- **updated\_at** - дата последнего редактирования;
- **deleted\_at** - дата удаления;
- все системные поля персоны (по английски).

</td></tr><tr style="height: 383.484px;"><td style="width: 49.5508%; height: 383.484px;">[<span style="font-weight: 300;">person.**getData**(string $key)</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetdata "person.getData()")</td><td style="width: 50.4158%; height: 383.484px;"><span style="font-weight: 400;">Возвращает значение данных персоны</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-7"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id персоны;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **person\_role\_id** - id роли;
- **is\_external** - значение поля **Сотрудник/Клиент**;
- **user\_id** - id пользователя;
- **firstname** - имя;
- **lastname** - фамилия;
- **middlename** - отчество;
- **email** - адрес электронной почты;
- **phone** - номер телефона;
- **organization\_name** - название организации;
- **organization\_address** - адрес организации;
- **comment** - комментарий;
- **created\_at** - дата создания;
- **updated\_at** - дата последнего редактирования;
- **deleted\_at** - дата удаления;
- все системные поля персоны (по английски).

</td></tr><tr style="height: 200.139px;"><td style="width: 49.5508%; height: 200.139px;">[<span style="font-weight: 300;">person.**issetData**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personissetdata-i-personisdataexist "person.issetData() и person.isDataExist()")</td><td rowspan="2" style="height: 400.289px; width: 50.4158%;"><span style="font-weight: 400;">Проверяет наличие данных по персоне</span>

В качестве ключа можно указать:

<div class="pointer-container" id="bkmrk-%C2%A0-8"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id персоны;
- **business\_id** - id бизнеса;
- **bot\_id** - id бота;
- **person\_role\_id** - id роли;
- **is\_external** - значение поля **Сотрудник/Клиент**;
- **user\_id** - id пользователя;
- **firstname** - имя;
- **lastname** - фамилия;
- **middlename** - отчество;
- **email** - адрес электронной почты;
- **phone** - номер телефона;
- **organization\_name** - название организации;
- **organization\_address** - адрес организации;
- **comment** - комментарий;
- **created\_at** - дата создания;
- **updated\_at** - дата последнего редактирования;
- **deleted\_at** - дата удаления;
- все системные поля персоны (по английски).

<span style="font-weight: 300;">  
</span></td></tr><tr style="height: 200.15px;"><td style="width: 49.5508%; height: 200.15px;">[<span style="font-weight: 300;">person.**isDataExist**(string $key): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personissetdata-i-personisdataexist)</td></tr><tr><td style="width: 49.5508%;"><span style="font-weight: 300;">person.**getLeads**(bool $isFindInAllBusinessBots = false): **array**</span></td><td style="width: 50.4158%;"><span style="font-weight: 400;">Возвращает лиды персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getId**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetid "person.getId()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.</span>**getFullName**<span style="font-weight: 300;">(): </span>**string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetfullname "person.getFullName()")

</td><td rowspan="2" style="height: 74.3519px; width: 50.4158%;"><span style="font-weight: 400;">Возвращает полное имя персоны</span>

  
<span style="font-weight: 400;">  
</span>

</td></tr><tr style="height: 39.213px;"><td style="width: 49.5508%; height: 39.213px;"><span style="font-weight: 300;">person.**getFIO**(): **string**</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getRoleId**(): **int|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroleid "person.getRoleId()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает ID роли персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getRoleName**(): **string**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetrolename "person.getRoleName()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает название роли персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getRoleTitle**(): **string**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroletitle "person.getRoleTitle()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает заголовок роли персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getRoleFormattedTitle**(): **string**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroleformattedtitle "person.getRoleFormattedTitle()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает форматированное название роли персоны.</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getPhone**(): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetphone "person.getPhone()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает номер телефона персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**setPhone**(string|null $phone): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetphone "person.setPhone()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Устанавливает номер телефона персоны</span>

</td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[<span style="font-weight: 300;">person.**getEmail**(): **string|null**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetemail "person.getEmail()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает почту персоны</span>

</td></tr></tbody></table>

### Работа с очередями исполнителей

#### Методы ticket

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-18" style="border-collapse: collapse; width: 100.001%; height: 509.977px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 102.361px;"><td style="width: 49.5508%; height: 102.361px;">[ticket.**assignToNextQueuePerson**(int $queueMode = 1, int|null $personQueueId = null, string|null $personQueueTable = null, int|null $currentAssignAttempt = null, bool $isIncRejectsCount = true, bool $isMoveToEndIfRejectsExceed = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketassigntonextqueueperson "ticket.assignToNextQueuePerson()")</td><td style="width: 50.4158%; height: 102.361px;"><span style="font-weight: 400;">Назначает заявку следующему исполнителю</span></td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[ticket.**moveAssignedPersonToEndOfQueue**(int $queueMode = 1, int|null $personQueueId = null, string|null $personQueueTable = null, bool $isResetRejectsCount = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketmoveassignedpersontoendofqueue "ticket.moveAssignedPersonToEndOfQueue()")</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Переносит исполнителя в конец очереди</span></td></tr><tr style="height: 102.361px;"><td style="width: 49.5508%; height: 102.361px;">[ticket.**assignToPersonById**(int|null $personId, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null, int|null $assignAttemptForLog = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketassigntopersonbyid "ticket.assignToPersonById()")

</td><td style="width: 50.4158%; height: 102.361px;"><span style="font-weight: 400;">Назначает исполнителя заявки</span>

</td></tr><tr><td style="width: 49.5508%;">[ticket.**assignToNextPersonAndMoveToEnd**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketassigntonextpersonandmovetoend "ticket.assignToNextPersonAndMoveToEnd()")

</td><td style="width: 50.4158%;"><span style="font-weight: 400;">Назначает заявку следующему исполнителю и переносит его в конец очереди</span>

</td></tr><tr style="height: 57.7778px;"><td style="width: 49.5508%; height: 57.7778px;">[ticket.**getAssignedPersonRejectsCount**(int $personQueueId = null, string|null $personQueueTable = null): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonrejectscount "ticket.getAssignedPersonRejectsCount()")

</td><td style="width: 50.4158%; height: 57.7778px;"><span style="font-weight: 400;">Возвращает количество отказов от заявок</span>

</td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[ticket.**setAssignedPersonRejectsCount**(int $rejectsCount, int|null $personQueueId = null, string|null $personQueueTable = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetassignedpersonrejectscount "ticket.setAssignedPersonRejectsCount()")

</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Устанавливает количество отказов от заявок</span>

</td></tr><tr style="height: 57.7778px;"><td style="width: 49.5508%; height: 57.7778px;">[ticket.**incAssignedPersonRejectsCount**(int|null $personQueueId = null, string|null $personQueueTable = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketincassignedpersonrejectscount "ticket.incAssignedPersonRejectsCount()")

</td><td style="width: 50.4158%; height: 57.7778px;"><span style="font-weight: 400;">Увеличивает количество отказов от заявок</span>

</td></tr></tbody></table>

#### Методы person

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-19" style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%; height: 63.1482px;">[person.**addToQueue**(int|null $personQueueId = null, string|null $personQueueTable = null, int|null $ticketTypeId = null, bool $isActive = true, int $rejectsCount = 0): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personaddtoqueue "person.addToQueue()")</td><td style="width: 50.4158%; height: 63.1482px;"><span style="font-weight: 400;">Добавляет персону в очередь</span></td></tr><tr><td style="width: 49.5508%; height: 46.3426px;">[person.**removeFromQueue**(int|null $personQueueId = null, string|null $personQueueTable = null, int|null $ticketTypeId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personremovefromqueue "person.removeFromQueue()")</td><td style="width: 50.4158%; height: 46.3426px;">Удаляет персону из очереди</td></tr><tr><td style="width: 49.5508%; height: 63.3681px;">[person.**moveToEndOfQueue**(int $queueMode = 1, int|null $personQueueId = null, string|null $personQueueTable = null, int|null $ticketTypeId = null, bool $isResetRejectsCount = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personmovetoendofqueue "person.moveToEndOfQueue()")</td><td style="width: 50.4158%; height: 63.3681px;"><span style="font-weight: 400;">Перемещает персону в конец очереди</span></td></tr><tr><td style="width: 49.5508%; height: 29.7917px;">[person.**setIsActiveInQueue**(bool $isActive = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetisactiveinqueue "person.setIsActiveInQueue()")</td><td style="width: 50.4158%; height: 29.7917px;"><span style="font-weight: 400;">Активирует/деактивирует персону в очереди</span></td></tr></tbody></table>

#### Методы personQueue

<table border="1" id="bkmrk-%D0%9D%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-%D0%9C%D0%B5%D1%82%D0%BE-20" style="border-collapse: collapse; width: 100.001%; height: 362.847px; border-color: #34495e;"><tbody><tr style="background-color: #c2e0f4; height: 29.7917px;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">personQueue.**getId**(): **int**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает id очереди персон</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">personQueue.**getCode**(): **string**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает код очереди персон</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">personQueue.**getIsEnabled**(): **bool**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Проверяет активна ли очередь персон</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">personQueue.**getName**(): **string**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Возвращает наименование очереди персон</span></td></tr><tr style="height: 29.537px;"><td style="width: 49.5508%; height: 29.537px;">personQueue.**isSameName**($name): **bool**</td><td style="width: 50.4158%; height: 29.537px;"><span style="font-weight: 400;">Проверяет наименование очереди персон на сходство</span></td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;">personQueue.**getCreatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**  
</td><td rowspan="2" style="width: 50.4158%; height: 92.6852px;"><span style="font-weight: 400;">Возвращает форматированную дату создания очереди персон</span></td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;">personQueue.**createdAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**  
</td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;">personQueue.**getUpdatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**  
</td><td rowspan="2" style="width: 50.4158%; height: 92.6852px;"><span style="font-weight: 400;">Возвращает форматированную дату обновления очереди персон</span></td></tr><tr style="height: 46.3426px;"><td style="width: 49.5508%; height: 46.3426px;">personQueue.**updatedAtFormatted**(string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**  
</td></tr></tbody></table>

#### Методы personQueues

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-perso" style="border-collapse: collapse; width: 100.001%; height: 575.718px; border-color: #34495e;"><tbody><tr style="height: 29.7917px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.7917px;">Метод</td><td style="width: 50.4158%; height: 29.7917px;">Описание</td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[personQueues.**find**($where, bool $isReturnCollection = false): **ScriptPersonQueue\[\]|Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfind "personQueues.find()")</td><td style="width: 50.4158%; height: 57.5463px;"><span style="font-weight: 400;">Возвращает очередь исполнителей</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">[personQueues.**findById**(string|int|null $id): **ScriptPersonQueue|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindbyid "personQueues.findById()")  
</td><td style="width: 50.4158%; height: 57.5463px;"><span style="font-weight: 400;">Возвращает очередь исполнителей по id</span></td></tr><tr style="height: 57.5463px;"><td style="width: 49.5508%; height: 57.5463px;">personQueues.**findByName**(string $name, bool $isEnabled = null): **ScriptPersonQueue|null**  
</td><td style="width: 50.4158%; height: 57.5463px;"><span style="font-weight: 400;">Возвращает очередь исполнителей по наименованию</span></td></tr><tr style="height: 63.1482px;"><td style="width: 49.5508%; height: 63.1482px;">personQueues.**findAllByNames**($names, bool $isEnabled = null, string $findNameOperator = 'IN', bool $isReturnCollection = false): **ScriptPersonQueue\[\]|Collection**  
</td><td style="width: 50.4158%; height: 63.1482px;"><span style="font-weight: 400;">Возвращает очереди исполнителей по наименованию</span></td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[personQueues.**findByCode**(string $code, bool $isEnabled = null, string $findCodeOperator = '='): **ScriptPersonQueue|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindbycode "personQueues.findByCode()")  
</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Возвращает очередь исполнителей по коду</span></td></tr><tr style="height: 79.9537px;"><td style="width: 49.5508%; height: 79.9537px;">[personQueues.**findAllByCodes**($codes, bool $isEnabled = null, string $findCodeOperator = 'IN', bool $isReturnCollection = false): **ScriptPersonQueue\[\]|Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindallbycodes "personQueues.findAllByCodes()")  
</td><td style="width: 50.4158%; height: 79.9537px;"><span style="font-weight: 400;">Возвращает очереди исполнителей по коду</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[personQueues.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesreload "personQueues.reload()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Обновляет очередь исполнителей</span></td></tr><tr style="height: 35.1389px;"><td style="width: 49.5508%; height: 35.1389px;">[personQueues.**getCollection**(): **Collection|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesgetcollection "personQueues.getCollection()")</td><td style="width: 50.4158%; height: 35.1389px;"><span style="font-weight: 400;">Возвращает коллекцию очередей</span></td></tr></tbody></table>

### Работа с интеграциями NLP

#### Методы bot

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.g" style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%; height: 29.7969px;">[bot.**getIntegrationIdByCode**(string|null $integrationCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetintegrationidbycode "bot.getIntegrationIdByCode()")  
</td><td style="width: 50.4158%; height: 29.7969px;">Возвращает id интеграции бота по коду</td></tr><tr><td style="width: 49.5508%; height: 46.5938px;">[bot.**getEnabledIntegrationIdByCode**(string|null $integrationCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetenabledintegrationidbycode "bot.getEnabledIntegrationIdByCode()")</td><td style="width: 50.4158%; height: 46.5938px;">Возвращает id включенной интеграции бота по коду</td></tr><tr><td style="width: 49.5508%; height: 29.7969px;">[bot.**isEnabledIntegrationById**(int|null $integrationId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisenabledintegrationbyid "bot.isEnabledIntegrationById()")  
</td><td style="width: 50.4158%; height: 29.7969px;">Проверяет активность интеграции по id</td></tr><tr><td style="width: 49.5508%; height: 29.7969px;">[bot.**isEnabledIntegrationByCode**(string|null $integrationCode): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisenabledintegrationbycode "bot.isEnabledIntegrationByCode()")  
</td><td style="width: 50.4158%; height: 29.7969px;">Проверяет активность интеграции по коду</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead." style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%;">[lead.<span class="hljs-title function_">**setActiveNlpIntegrationByCode**(string|null $integrationCode): **bool**</span>](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetactivenlpintegrationbycode "lead.setActiveNlpIntegrationByCode()")</td><td style="width: 50.4158%;">Присваивает интеграцию лиду по коду</td></tr><tr><td style="width: 49.5508%;">lead.**setActiveNlpIntegrationById**(int|null $nlpIntegrationId): **bool**</td><td style="width: 50.4158%;">Присваивает интеграцию лиду по id</td></tr><tr><td style="width: 49.5508%;">lead.**hasActiveNlpIntegration**(): **bool**</td><td style="width: 50.4158%;">Проверяет активна ли интеграция</td></tr><tr><td style="width: 49.5508%;">lead.**getActiveNlpIntegrationId**(): **int|null**</td><td style="width: 50.4158%;">Возвращает интеграцию по id</td></tr><tr><td style="width: 49.5508%;">lead.**getActiveNlpIntegrationCode**(): **string|null**</td><td style="width: 50.4158%;">Возвращает интеграцию по коду</td></tr><tr><td style="width: 49.5508%;">lead.**getActiveOrFirstNlpIntegrationId**(): **int|null**</td><td style="width: 50.4158%;">Возвращает активную или первую интеграцию по id</td></tr><tr><td style="width: 49.5508%;">lead.**getActiveOrFirstNlpIntegrationCode**(): **string|null**</td><td style="width: 50.4158%;">Возвращает активную или первую интеграцию по коду</td></tr></tbody></table>

### Работа с интеграциями

#### Методы lead

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead.-0" style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%; height: 29.7969px;">lead.**getForwardEventTypeForFB**(): **string|null**  
</td><td style="width: 50.4158%; height: 29.7969px;">Возвращает тип события для ФБ</td></tr></tbody></table>

### Работа с кастомными таблицами

#### Методы table

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-table" style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%; height: 46.5938px;">[table.**createItem**(string $tableName, array|object $data): **ScriptCustomTableItem**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablecreateitem "table.createItem()")</td><td style="width: 50.4158%; height: 46.5938px;">Создает запись в таблице</td></tr><tr><td style="width: 49.5508%; height: 60.375px;">[table.**find**(string $tableName, array|object $columns = \[\], array|object $where = \[\], array|object $orderBy = \[\], int|null $limit = null, int|null $offset = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablefind "table.find()")

</td><td style="width: 50.4158%; height: 60.375px;">Ищет запись в таблице</td></tr><tr><td style="width: 49.5508%; height: 35.3906px;">[table.**count**(string $tableName, array|object $where = \[\]): **int** ](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablecount "table.count()")

</td><td style="width: 50.4158%; height: 35.3906px;">Подсчитывает количество записей</td></tr><tr><td style="width: 49.5508%; height: 35.3906px;">[table.**sum**(string $tableName, string $column, array|object $where = \[\]): **int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablesum "table.sum()")</td><td style="width: 50.4158%; height: 35.3906px;">Подсчитывает сумму значений по полю

</td></tr><tr><td style="width: 49.5508%; height: 49.5938px;">[table.**max**(string $tableName, string $column, array|object $where = \[\]): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablemax "table.max()")</td><td style="width: 50.4158%; height: 49.5938px;">Ищет максимальное значение по полю

</td></tr></tbody></table>

#### Методы item

<p class="callout info">За объект **item** принимаем запись кастомной таблицы полученную с помощью **table.createItem** или **table.find**.</p>

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-item." style="border-collapse: collapse; width: 100.001%; height: 972.39px; border-color: #34495e;"><tbody><tr style="height: 29.7969px; background-color: #c2e0f4; border-color: #000000;"><td style="width: 49.5508%; height: 29.537px;">Метод</td><td style="width: 50.4158%; height: 29.537px;">Описание</td></tr><tr><td style="width: 49.5508%; height: 35.3906px;">[item.**update**(array|object $data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemupdate "item.update()")</td><td style="width: 50.4158%; height: 35.3906px;">Обновляет записи в таблице

</td></tr><tr><td style="width: 49.5508%; height: 35.3906px;">[item.**delete**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemdelete "item.delete()")</td><td style="width: 50.4158%; height: 35.3906px;">Удаляет записи из таблицы

</td></tr><tr><td style="width: 49.5508%; height: 57.7812px;">[item.**getDateFormatted**(string $fieldName, string $format = 'Y-m-d H:i:s', string|null $timeZone = null): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemgetdateformatted "item.getDateFormatted()")</td><td style="width: 50.4158%; height: 57.7812px;">Возвращает форматированную дату по названию поля

</td></tr><tr><td style="width: 49.5508%; height: 66.3906px;">[item.**getDateFormattedString**(string|DateTimeInterface $date, string $toFormat = 'Y-m-d H:i:s', string|null $fromFormat = 'Y-m-d H:i:s', string|null $toTimeZone = null, string|null $fromTimeZone = null): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemgetdateformattedstring "item.getDateFormattedString()")</td><td style="width: 50.4158%; height: 66.3906px;">Возвращает форматированную дату из произвольной строки

</td></tr><tr><td style="width: 49.5508%; height: 35.3906px;">[item.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemreload "item.reload()")

</td><td style="width: 50.4158%; height: 35.3906px;">Перезагружает данные записи из БД

</td></tr></tbody></table>

### Работа с блокировками

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.g-0" style="border-collapse: collapse; width: 100.001%; height: 661.609px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getLockNameForBot**(string $lockName, string $lockPrefix = ''): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlocknameforbot "bot.getLockNameForBot()")</td><td style="width: 50.045%; height: 57.5463px;">Генерирует имя блокировки по боту</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getLockNameForBusiness**(string $lockName, string $lockPrefix = ''): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlocknameforbusiness "bot.getLockNameForBusiness()")</td><td style="width: 50.045%; height: 57.5463px;">Генерирует имя блокировки по бизнесу</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**waitForBusinessLock**(string $lockName, string $lockPrefix = '', int|null $ttlSec = null, $maxWaitSec = 300): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botwaitforbusinesslock "bot.waitForBusinessLock()")</td><td style="width: 50.045%; height: 57.5463px;">Захватывает блокировку по бизнесу</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**waitForBotLock**(string $lockName, string $lockPrefix = '', int|null $ttlSec = null, $maxWaitSec = 300): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botwaitforbusinesslock "bot.waitForBusinessLock()")</td><td style="width: 50.045%; height: 57.5463px;">Захватывает блокировку по боту</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[bot.**releaseAllCurrentLocks**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaseallcurrentlocks "bot.releaseAllCurrentLocks()")</td><td style="width: 50.045%; height: 49.3056px;">Освобождает все блокировки захваченные в текущем скрипте</td></tr><tr style="height: 64.8495px;"><td style="width: 50.045%; height: 64.8495px;">[bot.**releaseCurrentLockForBusiness**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleasecurrentlockforbusiness "bot.releaseCurrentLockForBusiness()")</td><td style="width: 50.045%; height: 64.8495px;">Освобождает блокировку захваченную текущем скрипте по бизнесу</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**releaseCurrentLockForBot**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleasecurrentlockforbot "bot.releaseCurrentLockForBot()")</td><td style="width: 50.045%; height: 57.5463px;">Освобождает блокировку захваченную в текущем скрипте по боту</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**releaseLockForBusiness**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaselockforbusiness "bot.releaseLockForBusiness()")</td><td style="width: 50.045%; height: 57.5463px;">Освобождает блокировку по бизнесу</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**releaseLockForBot**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaselockforbot "bot.releaseLockForBot()")</td><td style="width: 50.045%; height: 57.5463px;">Освобождает блокировку по боту</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**hasLockForBusiness**(string $lockName, string $lockPrefix = '', $checkValue = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/bothaslockforbusiness "bot.hasLockForBusiness()")</td><td style="width: 50.045%; height: 57.5463px;">Проверяет существование блокировки по бизнесу</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**hasLockForBot**(string $lockName, string $lockPrefix = '', $checkValue = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/bothaslockforbot "bot.hasLockForBot()")</td><td style="width: 50.045%; height: 57.5463px;">Проверяет существование блокировки по боту</td></tr></tbody></table>

### Работа с контакт-центром

#### Методы bot

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.g-1" style="border-collapse: collapse; width: 100.001%; height: 522.5px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr><td style="width: 50.045%;">[bot.**canAutoForward**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcanautoforward "bot.canAutoForward()")</td><td style="width: 50.045%;">Узнает доступно ли авто-назначение оператора в данном скрипте

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead.-1" style="border-collapse: collapse; width: 100.001%; height: 522.5px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[lead.**canAutoForward**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadcanautoforward "lead.canAutoForward()")</td><td style="width: 50.045%; height: 46.3426px;">Узнает доступно ли авто-назначение оператора в данном скрипте

</td></tr><tr><td style="width: 50.045%;">[lead.**getNextOperators**(string $departmentCode = null, bool $isOnline = true, int|null $limit = 1, bool $useLocks = true): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetnextoperators "lead.getNextOperators()")</td><td style="width: 50.045%;">Возвращает список следующих операторов

</td></tr><tr><td style="width: 50.045%;">[lead.**assignDialogToNextOperator**(string|null $departmentCode = null, bool $isOnline = true, bool $isForwardIfOperatorNotFound = true, bool $useLocks = true): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadassigndialogtonextoperator "lead.assignDialogToNextOperator()")</td><td style="width: 50.045%;">Назначает диалог на следующего оператора полученного с помощью **getNextOperators**

</td></tr><tr><td style="width: 50.045%;">[lead.**assignDialogToOperator**(int|null $operatorId, bool $isForwardIfOperatorNotFound = true, bool $useLocks = true): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadassigndialogtooperator "lead.assignDialogToOperator()")</td><td style="width: 50.045%;">Назначает диалог на указанного в методе оператора

</td></tr></tbody></table>

### Работа с API

#### Методы bot

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.s" style="border-collapse: collapse; width: 100.001%; height: 75.8796px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[bot.**scheduleJob**($jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulejob "bot.scheduleJob()")</td><td style="width: 50.045%; height: 46.3426px;">Планирует любую задачу

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead.-2" style="border-collapse: collapse; width: 100.001%; height: 195.463px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[lead.**getLastRequest**(): **ScriptRequest|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetlastrequest "lead.getLastRequest()")</td><td style="width: 50.045%; height: 46.3426px;">Возвращает объект с параметрами последнего реквеста

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">lead.**getLang**(): **string|null**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает язык установленный в бизнесе

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">lead.**setLang**(string|null $langCode): **string|null**</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает язык в бизнесе

</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">lead.**isLangExist**(string $langCode, bool|null $isEnabled = true): **bool**</td><td style="width: 50.045%; height: 49.3056px;">Проверяет существует ли язык

</td></tr></tbody></table>

#### Методы request

<p class="callout info">За объект **request** принимаем объект с параметрами последнего реквеста полученный с помощью **lead**.**getLastRequest**.</p>

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-reque" style="border-collapse: collapse; width: 100.001%; height: 230.845px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[request.json](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request "request.")</td><td rowspan="2" style="height: 78.1366px; width: 50.045%;">Доступ к json параметрам в виде javascript json-обьекта

</td></tr><tr style="height: 31.794px;"><td style="width: 50.045%; height: 31.794px;">[request.asJson(): **ScriptRequest|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)</td></tr><tr style="height: 31.794px;"><td style="width: 50.045%; height: 31.794px;">[request.array](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)</td><td rowspan="2" style="width: 50.045%; height: 63.588px;">Доступ к json параметрам в виде javascript json-обьекта  
</td></tr><tr style="height: 31.794px;"><td style="width: 50.045%; height: 31.794px;">[request.asArray(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[request.string](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)</td><td rowspan="2" style="height: 29.7917px; width: 50.045%;">Входящие параметры в виде json обьекта</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[request.asString(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)</td></tr></tbody></table>

#### Методы last\_request

<p class="callout info">За объект **last\_request** принимаем объект с параметрами последнего реквеста полученный с помощью **lead**.**getLastRequest**.</p>

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-last_" style="border-collapse: collapse; width: 100.001%; height: 224.838px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">[last\_request.json](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request "last_request.")</td><td rowspan="2" style="height: 76.1343px; width: 50.045%;">Доступ к последнему реквесту в виде javascript json-обьекта

</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[last\_request.asJson(): **ScriptRequest|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[last\_request.array](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)</td><td rowspan="2" style="width: 50.045%; height: 59.5834px;">Доступ к последнему реквесту в виде массива</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[last\_request.asArray(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[last\_request.string](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)</td><td rowspan="2" style="width: 50.045%; height: 59.5834px;">Доступ к последнему реквесту в виде json обьекта</td></tr><tr style="height: 29.7917px;"><td style="width: 50.045%; height: 29.7917px;">[last\_request.asString(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)</td></tr></tbody></table>

#### Методы api

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-api.c" style="border-collapse: collapse; width: 100.001%; height: 1400.16px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 200.556px;"><td style="width: 50.045%; height: 200.556px;">api.**callEndpoint**(  
 string $externalApiEndpointCode,   
 string|null $uri = null,  
 string|null $method = null,   
 string|null $format = null,   
 array|object|string|null $body = null,   
 array|object|string|null $headers = \[\],  
 array|object|string|null $requestOptions = \[\],   
 array|object|string|null $httpClientConfig = \[\],   
 string|null $proxyUrl = null  
): **array|string|null**</td><td style="width: 50.045%; height: 200.556px;">Вызывает внешнее API из чат-бота

</td></tr><tr style="height: 102.361px;"><td style="width: 50.045%; height: 102.361px;">[api.**request**(string $method, string $uri, $requestOptions = \[\], $httpClientConfig = \[\], $body = null, $jsonBody = null, $headers = \[\], bool $isForceAddJsonHeaders = false): **ResponseInterface|null|mixed**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/apirequest "api.request()")</td><td style="width: 50.045%; height: 102.361px;">Выполняет HTTP запрос, с помощью Guzzle

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[api.**post**(string $uri, $body = \[\], $requestOptions = \[\], $headers = \[\], $httpClientConfig = \[\]): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/apipost "api.post()")</td><td style="width: 50.045%; height: 57.5463px;">Выполняет HTTP POST запрос, с помощью Guzzle

</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">api.**get**(string $uri, $requestOptions = \[\], $headers = \[\], $httpClientConfig = \[\]): **string|null**</td><td style="width: 50.045%; height: 49.3056px;">Выполняет HTTP GET запрос, с помощью Guzzle

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">api.**getJson**(string $uri, $jsonBody = \[\], $headers = \[\], $requestOptions = \[\], $httpClientConfig = \[\]): **array|null**</td><td style="width: 50.045%; height: 57.5463px;">Выполняет HTTP POST запрос с jsonBody, с помощью Guzzle

</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">api.**postJson**(string $uri, $jsonBody = \[\], $headers = \[\], $requestOptions = \[\], $httpClientConfig = \[\]): **array|null**</td><td style="width: 50.045%; height: 49.3056px;">Выполняет HTTP GET запрос с jsonBody, с помощью Guzzle

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getHttpConfig**(): **array**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает HTTP Config

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**setHttpConfig**($config): **self**</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает HTTP Config

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getRequestOptions**(): **array**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает параметры HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**setRequestOptions**($options): **self**</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает параметры HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getHeaders**(): **array**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает заголовки HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**setHeaders**($headers): **self**</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает заголовки HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getProxyUrl**(): **string|null**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает Proxy Url HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**setProxyUrl**($proxyUrl): **self**</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает Proxy Url HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getLastResponse**(): **mixed|ResponseInterface|null**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает последний ответ HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getLastResponseCode**(): **int**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает код последнего ответа HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getLastResponseContent**(): **string|null**</td><td style="width: 50.045%; height: 35.1389px;">Возвращает содержимое последнего ответа HTTP запроса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">api.**getLastJsonResponse**(): **array|null**</td><td style="width: 50.045%; height: 57.5463px;">Возвращает последний ответ HTTP запроса в формате JSON

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**enableExceptions**(): **self**</td><td style="width: 50.045%; height: 35.1389px;">Включает исключения для HTTP запросов

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**disableExceptions**(): **self**

</td><td style="width: 50.045%; height: 35.1389px;">Выключает исключения для HTTP запросов

</td></tr><tr style="height: 36.1343px;"><td style="width: 50.045%; height: 36.1343px;">api.**setTimeout**(float $timeout): **self**

</td><td style="width: 50.045%; height: 36.1343px;">Устанавливает время задержки для HTTP запросов

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getTimeout**(): **float**

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает время задержки для HTTP запросов

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**isExceptionThrown**(): **bool**

</td><td style="width: 50.045%; height: 35.1389px;">Проверяет существует ли исключение

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**isConnectExceptionThrown**(): **bool**

</td><td style="width: 50.045%; height: 35.1389px;">Проверяет существует ли исключение подключения

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getLastResponseTime**(): **float**

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает время последнего ответа HTTP запроса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">api.**getLastErrorBody**(bool $isAutoConvertToJson = true): **string|array|null**

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает содержимое ошибки последнего ответа HTTP запроса

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**enableContinueCallEndpointOnJsError**(): **self**

</td><td style="width: 50.045%; height: 35.1389px;">Включает вызов эндпоинта при ошибке JS

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**disableContinueCallEndpointOnJsError**(): **self**

</td><td style="width: 50.045%; height: 35.1389px;">Выключает вызов эндпоинта при ошибке JS

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">api.**getIsContinueCallEndpointOnJsError**(): **bool**

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает режим вызова эндпоинта при ошибке JS

</td></tr></tbody></table>

### Работа с файлами

#### Методы bot

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.g-2" style="border-collapse: collapse; width: 100.001%; height: 1802.92px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getIncomingMessage**(bool $useOutputFilter = false): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetincomingmessage "bot.getIncomingMessage()")

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает текст входящего сообщения или текст подписи к вложению</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[bot.**getWebhookJobId**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookjobid "bot.getWebhookJobId()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает id вебхука зарегистрированного в очереди Метабот</td></tr><tr><td style="width: 50.045%; height: 49.3056px;">bot.**getWebhookJobRecord**(): **BotWebhookQueueRecord|null**

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает запись вебхука зарегистрированного в очереди Метабот</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getWebhookJob**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookjob "bot.getWebhookJob()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает информацию о вебхуке</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getWebhookPayload**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookpayload "bot.getWebhookPayload()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает payload входящего вебхука в виде массива

</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[bot.**getLastResultPayload**(): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlastresultpayload "bot.getLastResultPayload()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает payload c данными о последнем ответе мессенджера в ввиде массива</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getChannelData**(string|null $key = null): **array|null|mixed**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetchanneldata "bot.getChannelData()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает настройки канала лида </td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**disableBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdisablebuffer "bot.disableBuffer()")

</td><td style="width: 50.045%; height: 57.5463px;">Принудительное отключение буффера исходящих сообщений

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**enableBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botenablebuffer "bot.enableBuffer()")

</td><td style="width: 50.045%; height: 57.5463px;">Принудительное включение буффера исходящих сообщений

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**flushBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botflushbuffer "bot.flushBuffer()")

</td><td style="width: 50.045%; height: 57.5463px;">Принудительное освобождение буффера исходящих сообщений

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getAllAttachments**(string|null $filesMimeExcludeFilter = 'image|video'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetallattachments "bot.getAllAttachments()")

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает вложения всех видов</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getFiles**(string|null $mimeIncludeFilter = null, string|null $mimeExcludeFilter = 'image|video'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetfiles "bot.getFiles()")

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает все вложения, которые распознаны как файл</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[bot.**getImages**(string|null $mimeIncludeFilter = 'image'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetimages "bot.getImages()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает все изображения, а также файлы, которые распознаны как изображение</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[bot.**getVideos**(string|null $mimeIncludeFilter = 'video'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetvideos "bot.getVideos()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает все видео, а также файлы, которые распознаны как видео</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**sendPayload**(string|null $endpoint, array|object $payload): **array|string|mixed**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendpayload "bot.sendPayload()")

</td><td style="width: 50.045%; height: 57.5463px;">Отправляет payload в мессенджер</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**sendText**(string|null|mixed $messageText, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendtext "bot.sendText()")

</td><td style="width: 50.045%; height: 79.9537px;">Отправляет текст в мессенджер

</td></tr><tr style="height: 102.361px;"><td style="width: 50.045%; height: 102.361px;">[bot.**sendMessage**(string|null|mixed $messageText, array|object|null $buttons = null, array|object|null $attachments = null, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true, bool $isUpdateMessageButtons = false): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendmessage "bot.sendMessage()")

</td><td style="width: 50.045%; height: 102.361px;">Отправляет сообщение в мессенджер, сообщение может содержать текст, кнопки меню и вложения

</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**sendButtons**(string|null|mixed $messageText, array|object $buttons, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true, bool $isUpdateMessageButtons = false): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendbuttons "bot.sendButtons()")

</td><td style="width: 50.045%; height: 79.9537px;">Отправляет кнопки с сообщением в мессенджер

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getTelegramFileInfoById**(string|null $fileId, bool $isShowOriginalInfo = false): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettelegramfileinfobyid "bot.getTelegramFileInfoById()")

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает информацию о файле в Telegram по его id

</td></tr><tr style="height: 102.361px;"><td style="width: 50.045%; height: 102.361px;">[bot.**sendTelegramAttachmentAndGetFileId**(string|null $messageText, array|object|null $attachment, array|object|null $buttons = null, array|object|null $apiAdditionalParams = null): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendtelegramattachmentandgetfileid "bot.sendTelegramAttachmentAndGetFileId()")

</td><td style="width: 50.045%; height: 102.361px;">Отправляет файл в телеграм и возвращает его id

</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**editTelegramInlineKeyboard**(int|string $chatId, int|string $messageId, string|null string $inlineMessageId, array|object|null $inlineKeyboardMarkup): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botedittelegraminlinekeyboard "bot.editTelegramInlineKeyboard()")

</td><td rowspan="2" style="height: 159.907px; width: 50.045%;">Редактирует кнопки меню уже отправленного в Telegram сообщения

</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">[bot.**removeTelegramInlineKeyboard**(int|string $chatId, int|string $messageId, string|null $inlineMessageId = null): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovetelegraminlinekeyboard "bot.removeTelegramInlineKeyboard()")

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**getTelegramLastMessageId**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettelegramlastmessageid "bot.getTelegramLastMessageId()")

</td><td style="width: 50.045%; height: 57.5463px;">Возвращает ID последнего сообщения, отправленного в Telegram

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**setCdnConfig**(array|object|null $cdnConfig = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetcdnconfig "bot.setCdnConfig()")

</td><td style="width: 50.045%; height: 35.1389px;">Устанавливает конфиг для доступа к CDN

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getCdnConfig**(): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetcdnconfig "bot.getCdnConfig()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает текущий конфиг CDN

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**getFileInfoByUrl**(string $fileUrl): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetfileinfobyurl "bot.getFileInfoByUrl()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает информацию о файле по URL

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**downloadFileFromUrl**(string $fileUrl): **string|array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdownloadfilefromurl "bot.downloadFileFromUrl()")

</td><td style="width: 50.045%; height: 57.5463px;">Скачивает файл с URL и загружает в хранилище файлов Метабот для вашего бизнеса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**downloadTmpFileFromUrl**(string $fileUrl): **string|array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdownloadtmpfilefromurl "bot.downloadTmpFileFromUrl()")

</td><td style="width: 50.045%; height: 57.5463px;">Скачивает файл с URL и загружает во временное хранилище файлов Метабот для вашего бизнеса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**removeFile**(string $fileUrl): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovefile "bot.removeFile()")

</td><td style="width: 50.045%; height: 57.5463px;">Удаляет файл по URL из хранилища файлов Метабот для вашего бизнеса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**removeTmpFile**(string $fileUrl): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovetmpfile "bot.removeTmpFile()")

</td><td style="width: 50.045%; height: 57.5463px;">Удаляет файл по URL из временного хранилища файлов Метабот для вашего бизнеса

</td></tr><tr style="height: 57.5463px;"><td style="width: 50.045%; height: 57.5463px;">[bot.**uploadFileToCdnAndGetNewUrl**(string $fileUrl, array|object|null $cdnConfig = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botuploadfiletocdnandgetnewurl "bot.uploadFileToCdnAndGetNewUrl()")

</td><td style="width: 50.045%; height: 57.5463px;">Заливает файл на CDN и возвращает новую ссылку

</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[bot.**removeFileFromCdn**(string $fileUrl, $cdnConfig = null)](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovefilefromcdn "bot.removeFileFromCdn()")

</td><td style="width: 50.045%; height: 35.1389px;">Удаляет файл из CDN

</td></tr></tbody></table>

#### Методы lead

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead.-3" style="border-collapse: collapse; width: 100.001%; height: 268.704px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr><td style="width: 50.045%;">[lead.**getMessenger**(): **int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetmessenger "lead.getMessenger()")

</td><td style="width: 50.045%;">Возвращает обозначение текущего мессенджера канала</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[lead.**getMessengerCode**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetmessengercode "lead.getMessengerCode()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает буквенное обозначение текущего мессенджера канала</td></tr><tr style="height: 35.1389px;"><td style="width: 50.045%; height: 35.1389px;">[lead.**getIdentification**(): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetidentification "lead.getIdentification()")

</td><td style="width: 50.045%; height: 35.1389px;">Возвращает идентификатор лида во внешней системе</td></tr><tr style="height: 49.3056px;"><td style="width: 50.045%; height: 49.3056px;">[lead.**getIdentificationEntity**(): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetidentificationentity "lead.getIdentificationEntity()")

</td><td style="width: 50.045%; height: 49.3056px;">Возвращает дополнительный идентификатор лида во внешней системе</td></tr></tbody></table>

### Работа с GPT

#### Методы bot

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bot.r" style="border-collapse: collapse; width: 100.001%; height: 1051.83px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**run**(array|object|null $jobParams = \[\]): **bool**</td><td style="width: 50.045%; height: 29.537px;">Запускает скрипт в рамках текущего потока бота</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**stop**(): **bool**</td><td style="width: 50.045%; height: 29.537px;">Прерывает текущий скрипт</td></tr><tr style="height: 34.838px;"><td style="width: 50.045%; height: 34.838px;">bot.**throw**(string $message = '', int $code = 0): **bool**</td><td style="width: 50.045%; height: 34.838px;">Создает искусственное падение скрипта</td></tr><tr style="height: 64.838px;"><td style="width: 50.045%; height: 64.838px;">bot.**disableRepeatMessageText**(): **bool**</td><td style="width: 50.045%; height: 64.838px;">Отключает вывод сообщения для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 64.838px;"><td style="width: 50.045%; height: 64.838px;">bot.**enableRepeatMessageText**(): **bool**</td><td style="width: 50.045%; height: 64.838px;">Включает вывод сообщения для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 81.6667px;"><td style="width: 50.045%; height: 81.6667px;">bot.**isEnabledRepeatMessageText**(): **bool**</td><td style="width: 50.045%; height: 81.6667px;">Проверяет включен или нет вывод сообщения для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 64.838px;"><td style="width: 50.045%; height: 64.838px;">bot.**hideRepeatMessageButtons**(): **bool**</td><td style="width: 50.045%; height: 64.838px;">Отключает вывод меню для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 64.838px;"><td style="width: 50.045%; height: 64.838px;">bot.**showRepeatMessageButtons**(): **bool**</td><td style="width: 50.045%; height: 64.838px;">Включает вывод меню для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 81.6667px;"><td style="width: 50.045%; height: 81.6667px;">bot.**isShowRepeatMessageButtons**(): **bool**</td><td style="width: 50.045%; height: 81.6667px;">Проверяет включен или нет вывод меню для команды конструктора "Повтор" для текущего вебхука/задания</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getConversationQuestion**(): **OverridenQuestion|null**</td><td style="width: 50.045%; height: 29.537px;">Возвращает текущее состояние беседы</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getCurrentScriptId**(): **int|null**</td><td style="width: 50.045%; height: 29.537px;">Возвращает ID текущего скрипта</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getCurrentScriptCode**(): **string|null**</td><td style="width: 50.045%; height: 29.537px;">Возвращает код текущего скрипта</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getCurrentCommandId**(): **int|null**</td><td style="width: 50.045%; height: 29.537px;">Возвращает код текущей команды</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getConversationButtons**(): **array**</td><td style="width: 50.045%; height: 29.537px;">Возвращает текущие кнопки</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getMenuItemsForScript**(?string $scriptCode): **array**</td><td style="width: 50.045%; height: 29.537px;">Возвращает все пункты меню скрипта</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">bot.**getMenuItemsForCurrentScript**(): **array**</td><td style="width: 50.045%; height: 29.537px;">Возвращает все пункты меню текущего скрипта</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">bot.**getButtonsForScript**(?string $scriptCode, ?int $scriptId = null, bool $withRunScriptId = true): **array**</td><td style="width: 50.045%; height: 46.3426px;">Возвращает все кнопки скрипта</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">bot.**getButtonsForCurrentScript**(bool $withRunScriptId = true): **array**</td><td style="width: 50.045%; height: 46.3426px;">Возвращает все кнопки текущего скрипта</td></tr><tr style="height: 79.9537px;"><td style="width: 50.045%; height: 79.9537px;">bot.**findButtonByIncomingMessage**(array|object $buttons, ?string $overrideIncomingMessage = null, bool $isLogFoundButton = true): **array|null**

</td><td style="width: 50.045%; height: 79.9537px;">Находит кнопку которую "нажимает пользователь" по входящему сообщению</td></tr><tr style="height: 63.1482px;"><td style="width: 50.045%; height: 63.1482px;">bot.**getScriptIdFromButtonsByIncomingMessage**(array|object $buttons, ?string $overrideIncomingMessage = null, bool $isLogFoundButton = true): **int|null**</td><td style="width: 50.045%; height: 63.1482px;">Возвращает id скрипта по кнопке которую "нажимает пользователь"</td></tr><tr style="height: 63.1482px;"><td style="width: 50.045%; height: 63.1482px;">bot.**getScriptCodeFromButtonsByIncomingMessage**(array|object $buttons, ?string $overrideIncomingMessage = null, bool $isLogFoundButton = true): **string|null**  
</td><td style="width: 50.045%; height: 63.1482px;">Возвращает код скрипта по кнопке которую "нажимает пользователь"</td></tr></tbody></table>

#### Методы api

<table border="1" id="bkmrk-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-api.g" style="border-collapse: collapse; width: 100.001%; height: 375.324px;"><tbody><tr style="background-color: #c2e0f4; height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">Метод</td><td style="width: 50.045%; height: 29.537px;">Описание</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">api.**getLastErrorBody**(bool $isAutoConvertToJson = true): **string|array|null**</td><td style="width: 50.045%; height: 46.3426px;">Возвращает содержимое API ответа, если внешнее API вернуло код ошибки</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**enableContinueCallEndpointOnJsError**(): **bool**</td><td style="width: 50.045%; height: 29.537px;">Игнорирует ошибку в JS Body</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**disableContinueCallEndpointOnJsError**(): **bool**</td><td style="width: 50.045%; height: 29.537px;">Отключает игнорирование ошибки в JS Body</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">api.**getIsContinueCallEndpointOnJsError**(): **bool**</td><td style="width: 50.045%; height: 46.3426px;">Проверяет вкл. или выключено игнорирование ошибки в JS Body перед запуском внешнего api</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**callApiOnlyByOkFlag**(bool $value = true): **bool**</td><td rowspan="2" style="width: 50.045%; height: 59.074px;">Выполняет обращение по api, только если JS валиден</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**onlyForOk**(bool $value = true): **bool**</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**isCallApiOnlyByOkFlag**(): **bool**</td><td rowspan="2" style="width: 50.045%; height: 59.074px;">Проверяет включен или нет флаг isCallApiOnlyByOkFlag</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**isOnlyForOk**(): **bool**</td></tr><tr style="height: 46.3426px;"><td style="width: 50.045%; height: 46.3426px;">api.**ok**(bool $value = true): **bool**</td><td style="width: 50.045%; height: 46.3426px;">Указывает что JS валиден, для того чтобы выполнился запуск внешнего api</td></tr><tr style="height: 29.537px;"><td style="width: 50.045%; height: 29.537px;">api.**isOk**(): **bool**</td><td style="width: 50.045%; height: 29.537px;">Проверяет валиден ли JS</td></tr></tbody></table>

# Методы bot



# bot.getData()

### Получить значение данных бота

```JavaScript
bot.getData(string $key)
```

##### Описание:

Возвращает значение данных бота по ключу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Ключ данных бота</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">все поля бота в БД (по английски).</span>

##### Возвращает:

**mixed** - значение данных бота в формате, в котором они находятся в сущности

или

**null** - если таких данных не существует.

##### Пример:

```JavaScript
let data = bot.getData('leadsCount');
```

# bot.findLeads()

### Получить лиды по атрибутам

```JavaScript
bot.findLeads($columns = [], $where = [], $orderBy = [], ?int $limit = null, ?int $offset = null)
```

##### Описание:

Находит лида по указанным атрибутам и другим данным.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 428.4px;"><tbody><tr style="height: 29.7875px; background-color: #ced4d9;"><td style="width: 33.3663%; height: 29.7875px;">Имя</td><td style="width: 23.3609%; height: 29.7875px;">Тип</td><td style="width: 43.3717%; height: 29.7875px;">Описание</td></tr><tr style="height: 80px;"><td style="width: 33.3663%; height: 80px;">columns</td><td style="width: 23.3609%; height: 80px;">array</td><td style="width: 43.3717%; height: 80px;">Возвращаемые поля лидов, по умолчанию все поля. Вы можете вывести дополнительные поля: **status\_name**, **channel\_name**, **channel\_code**</td></tr><tr style="height: 77.125px;"><td style="width: 33.3663%; height: 77.125px;">[where](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/where-dlya-botfindleads)</td><td style="width: 23.3609%; height: 77.125px;">array</td><td style="width: 43.3717%; height: 77.125px;">Массив для поиска лидов по атрибутам, статусам и каналам. Подробнее читайте [здесь.](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/where-dlya-botfindleads)

</td></tr><tr style="height: 46.5875px;"><td style="width: 33.3663%; height: 46.5875px;">[orderBy](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/orderby-dlya-botfindleads)</td><td style="width: 23.3609%; height: 46.5875px;">array</td><td style="width: 43.3717%; height: 46.5875px;">Массив сортировки возвращаемых значений. Подробнее читайте [здесь](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/orderby-dlya-botfindleads).</td></tr><tr style="height: 46.4px;"><td style="width: 33.3663%; height: 46.4px;">limit</td><td style="width: 23.3609%; height: 46.4px;">int</td><td style="width: 43.3717%; height: 46.4px;">Максимальное число возвращаемых лидов. Можно вернуть диапазон от 1 до 100</td></tr><tr style="height: 148.5px;"><td style="width: 33.3663%; height: 148.5px;">offset</td><td style="width: 23.3609%; height: 148.5px;">int</td><td style="width: 43.3717%; height: 148.5px;">Числовое значение, указывающее количество записей, которые необходимо пропустить от начала результата выборки перед возвратом данных. Этот параметр используется для пагинации. Например, если `limit` установлен на 100, а `offset` равен 100, то будут возвращены записи, начиная со 101-го лида.</td></tr></tbody></table>

##### Возвращает:

**array** - массив полей лидов.

В массиве следующие поля:

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id лида
- **identification** - внешний id лида
- **manager\_id** - id менеджера привязанного к лиду
- **bot\_id** - id бота лида
- **channel\_id** - id канала лида
- **status\_id** - id статуса лида
- **is\_mute** - включен ли бот для лида

##### Пример:

```JavaScript
let leads = bot.findLeads(
    [],
    [
     ['lead_attributes.attribute_type', 'variable'],
     ['lead_attributes.attribute_key', 'nlpLastIntentName'],
     ['lead_attributes.attribute_value', 'позвать_человека'],
    ],
    [['updated_at']]
);

if (leads.length) {
    let statusName = leads[0].getData('id');
}
```

или получаем поля для первого найденного лида (без условий):

```JavaScript
let leads = bot.findLeads(['status_name', 'channel_name', 'channel_code']);
if (leads.length) {
    let statusName = leads[0].getData('status_name');
    let channelName = leads[0].getData('channel_name');
    let channelCode = leads[0].getData('channel_code');
}
```

# bot.scheduleScript()

### Планирование скрипта


```JavaScript
bot.scheduleScript(?int $scriptId, ?int $leadId, ?int $ticketId = null, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
var result = bot.scheduleScript(1426, 6473, null, {
  "script_request_params": {
        "name": "Alex" 
  }
});
```

# bot.getScriptIdByName()

### Получить ID скрипта по наименованию

```JavaScript
bot.getScriptIdByName(?string $scriptName)
```

##### Описание:

Возвращает id скрипта по его наименованию.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование скрипта</td></tr></tbody></table>

##### Возвращает:

**int** - id скрипта в формате числа.

##### Пример:

```JavaScript
let ScriptId = bot.getScriptIdByName('Меню');
```

# bot.getScriptIdByCode()

### Получить ID скрипта по коду

```JavaScript
bot.getScriptIdByCode(?string $scriptCode)
```

##### Описание:

Возвращает id скрипта по его дополнительному идентификатору.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код скрипта</td></tr></tbody></table>

##### Возвращает:

**int** - id скрипта в формате числа.

##### Пример:

```JavaScript
let ScriptId = bot.getScriptIdByCode('menu');
```

# bot.runScriptForLead()

### Запустить скрипт для лида по ID

```JavaScript
bot.runScriptForLead(?int $scriptId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-1" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
let ScriptId = bot.getScriptIdByName('Меню');

bot.runScriptForLead(ScriptId, 165784, null, true);
```

# bot.runScriptByNameForLead()

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

```JavaScript
bot.runScriptByNameForLead(?string $scriptName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-2" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runScriptByNameForLead('Меню', 165784, null, true);
```

# bot.runScriptForPerson()

### Запустить скрипт для персоны по ID

```JavaScript
bot.runScriptForPerson(?int $scriptId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-3" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID персоны, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
let ScriptId = bot.getScriptIdByCode('menu');

bot.runScriptForPerson(ScriptId, 24178, null, true);
```

# bot.runScriptByNameForPerson()

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

```JavaScript
bot.runScriptByNameForPerson(?string $scriptName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-4" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID персоны, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runScriptByNameForPerson('Меню', 24178, null, false);
```

# bot.runScriptByCodeForLead()

### Запустить скрипт для лида по коду

```JavaScript
bot.runScriptByCodeForLead(?string $scriptCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-5" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runScriptByCodeForLead("SEND_TOKEN", 135, null, false, {
  "run_at": "2021-03-23 19:05:30", 
});
```

# bot.runScriptByCodeForPerson()

### Запустить скрипт для персоны по коду

```JavaScript
bot.runScriptByCodeForPerson(?string $scriptCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-6" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код скрипта, который будет запущен</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID персоны, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runScriptByCodeForPerson("SEND_TOKEN", 135, null, false, {
  "run_after_sec": 5, 
});
```

# bot.clearJobsByScriptId()

### Очистить джобы по id скрипта

```JavaScript
bot.clearJobsByScriptId(?int $scriptId, ?int $leadId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по id скрипта.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-4" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID серипта</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
bot.clearJobsByScriptId(1342, 187);
```

# bot.clearJobsByScriptName()

### Очистить джобы по наименованию скрипта

```JavaScript
bot.clearJobsByScriptName(?string $scriptName, ?int $leadId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по наименованию скрипта.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-5" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">scriptName</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование скрипта</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
bot.clearJobsByScriptName("skript", 187);
```

# bot.clearJobsByScriptCode()

### Очистить джобы по коду скрипта

```JavaScript
bot.clearJobsByScriptCode(?string $scriptCode, ?int $leadId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по коду скрипта.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-7" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">scriptCode</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Код скрипта</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
bot.clearJobsByScriptCode("SEND_TOKEN", 187);
```

# bot.setAttr()

### Установить значение переменной бота

```JavaScript
bot.setAttr(string $key, string $value)
```

##### Описание:

<span style="font-weight: 400;">Обновляет значение уже существующей глобальной переменной или создает новую переменную с указанным значением. Данные будут сохранены в БД.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">value</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Значение переменной</td></tr></tbody></table>

Не возвращает значений, так как выполняет только установку переменной.

##### Пример:

Создание глобальной переменной бота bot\_attribute:

```JavaScript
bot.setAttr('bot_attribute', 'Значение глобальной переменной')
```

# bot.getAttr()

### Получить значение переменной бота:

```JavaScript
bot.getAttr(string $key)
```

### Описание:

<span style="font-weight: 400;">Возвращает значение уже существующей глобальной переменной.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr></tbody></table>

##### Возвращает:

**mixed** - объект того же типа и значения, что у запрашиваемой переменной.

##### Пример:

Получение значения глобальной переменной бота bot\_attribute:

```JavaScript
let bot_attribute_value = bot.getAttr('bot_attribute');
```

# bot.getAllAttr()

### Получить все переменные бота

```JavaScript
bot.getAllAttr()
```

##### Описание:

<span style="font-weight: 400;">Возвращает значение всех глобальных переменных.</span>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**array** - массив значений всех переменных.

##### Пример:

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

```JavaScript
let bot_attribute = null;
let all_bot_attributes = bot.getAllAttr();
for(let i = 0; i < all_bot_attributes.length; i++) {
  bot_attribute = bot_attribute + all_bot_attributes[i];
}
```

# bot.issetAttr() и bot.isAttrExist()

### Проверить наличие переменной бота

```JavaScript
bot.issetAttr(string $key)
```

или

```JavaScript
bot.isAttrExist(string $key)
```

##### Описание:

Проверяет существует ли глобальная переменная в боте.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-1" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**bool** - подтверждение существования переменной.

##### Пример:

Проверка двумя способами существования глобальной переменной бота bot\_attribute:

```JavaScript
let bot_exists = bot.issetAttr('bot_attribute');
let bot_altexists = bot.isAttrExist('bot_attribute');
```

# bot.scheduleTrigger()

### Планирование триггера


```JavaScript
bot.scheduleTrigger(?int $triggerId, ?int $leadId, ?int $ticketId = null, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен триггер</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен триггер</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

**bool** - подтверждение планирования триггера.

##### Пример:

```JavaScript
var result = bot.scheduleTrigger(4213, 1426, null, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});
```

# bot.runTriggerByCodeForLead()

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

```
bot.runTriggerByCodeForLead(?string $triggerCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен триггер</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен триггер</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь триггеров</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

**bool** - подтверждение планирования триггера.

##### Пример:

```JavaScript
var result = bot.runTriggerByCodeForLead('test', 1426, null, true, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});
```

# bot.runTriggerByCodeForPerson()

### Планирование триггера по коду для последнего лида персоны

```
bot.runTriggerByCodeForPerson(?string $triggerCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера, который будет запущен</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID персоны, для которой будет найден последний лид</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен триггер</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь триггеров</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

**bool** - подтверждение планирования триггера.

##### Пример:

```JavaScript
var result = bot.runTriggerByCodeForPerson('test', 1426, null, true, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});
```

# bot.clearTriggerJobsForLead()

### Удалить триггеры для лида

```JavaScript
bot.clearTriggerJobsForLead(?int $leadId, ?int $ticketId = null)
```

##### Описание:

Удаляет все триггеры из очереди для лида.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 106.188px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2511%; height: 29.7969px;">Имя</td><td style="width: 33.498%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2511%; height: 46.5938px;">leadId</td><td style="width: 33.498%; height: 46.5938px;">int</td><td style="width: 33.3745%; height: 46.5938px;">ID лида, триггеры которого будут удалены</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2511%; height: 29.7969px;">ticketId</td><td style="width: 33.498%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID заявки, триггеры которого будут удалены</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение удаления триггеров.

##### Пример:

```JavaScript
bot.clearTriggerJobsForLead(236178);
```

# bot.clearTriggerJobsForAllPersonLeads()

### Удалить триггеры для всех лидов персоны

```JavaScript
bot.clearTriggerJobsForAllPersonLeads(?int $personId, ?int $ticketId = null)
```

##### Описание:

Удаляет все триггеры из очереди для всех лидов персоны.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">personId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID персоны, триггеры которой будут удалены</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">ticketId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID заявки, триггеры которого будут удалены</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение удаления триггеров.

##### Пример:

```JavaScript
bot.clearTriggerJobsForAllPersonLeads(36178);
```

# bot.getTriggerIdByName()

### Получить ID триггера по наименованию

```JavaScript
bot.getTriggerIdByName(?string $triggerName)
```

##### Описание:

Возвращает id триггера по указанному наименованию.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование триггера</td></tr></tbody></table>

##### Возвращает:

**int** - id триггера в формате числа.

##### Пример:

```
let TriggerId = bot.getTriggerIdByName('Триггер');
```

# bot.getTriggerIdByCode()

### Получить ID Триггера по Коду

```
bot.getTriggerIdByCode(?string $triggerCode)
```

##### Описание:

Возвращает id триггера по указанному коду.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-2" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код триггера</td></tr></tbody></table>

##### Возвращает:

**int** - id триггера в формате числа.

# bot.runTriggerForLead()

### Запустить триггер для лида по ID триггера

```JavaScript
bot.runTriggerForLead(?int $triggerId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-3" style="border-collapse: collapse; width: 100%; height: 182.578px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера, который будет запущен</td></tr><tr style="height: 46.5938px;"><td style="width: 33.3745%; height: 46.5938px;">leadId</td><td style="width: 33.3745%; height: 46.5938px;">int</td><td style="width: 33.3745%; height: 46.5938px;">ID лида, для которого будет запущен скрипт</td></tr><tr style="height: 46.5938px;"><td style="width: 33.3745%; height: 46.5938px;">ticketId</td><td style="width: 33.3745%; height: 46.5938px;">int</td><td style="width: 33.3745%; height: 46.5938px;">ID заявки, для которой будет запущен скрипт</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">addToQueue</td><td style="width: 33.3745%; height: 29.7969px;">bool</td><td style="width: 33.3745%; height: 29.7969px;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.runTriggerForLead(TriggerId, 236178, null, true, {
  "run_at": "2021-03-23 19:01:00", 
});
```

# bot.runTriggerByNameForLead()

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

```JavaScript
bot.runTriggerByNameForLead(?string $triggerName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-4" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">triggerName</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование триггера, который будет запущен</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида, для которого будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runTriggerByNameForLead('Триггер', 236178, null, true{
  "run_after_sec": 5, 
});
```

# bot.runTriggerForPerson()

### Запустить триггер для персоны по ID

```JavaScript
bot.runTriggerForPerson(?int $triggerId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-5" style="border-collapse: collapse; width: 100%; height: 182.578px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера, который будет запущен</td></tr><tr style="height: 46.5938px;"><td style="width: 33.3745%; height: 46.5938px;">personId</td><td style="width: 33.3745%; height: 46.5938px;">int</td><td style="width: 33.3745%; height: 46.5938px;">ID персоны, для которой будет запущен скрипт</td></tr><tr style="height: 46.5938px;"><td style="width: 33.3745%; height: 46.5938px;">ticketId</td><td style="width: 33.3745%; height: 46.5938px;">int</td><td style="width: 33.3745%; height: 46.5938px;">ID заявки, для которой будет запущен скрипт</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">addToQueue</td><td style="width: 33.3745%; height: 29.7969px;">bool</td><td style="width: 33.3745%; height: 29.7969px;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.runTriggerForPerson(TriggerId, 36178, null, true);
```

# bot.runTriggerByNameForPerson()

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

```JavaScript
bot.runTriggerByNameForPerson(?string $triggerName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-6" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">triggerName</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование триггера, который будет запущен</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID персоны, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущен скрипт</td></tr><tr><td style="width: 33.3745%;">addToQueue</td><td style="width: 33.3745%;">bool</td><td style="width: 33.3745%;">Добавление в очередь скриптов</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.runTriggerByNameForPerson('Триггер', 36178, null, true);
```

# bot.clearTriggerJobsById()

### Очистить джобы по id триггера

```JavaScript
bot.clearTriggerJobsById(?int $triggerId, ?int $leadId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по id триггера.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-7" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.clearTriggerJobsById(TriggerId);
```

# bot.clearTriggerJobsByName()

### Очистить джобы по наименованию триггера

```JavaScript
bot.clearTriggerJobsByName(?string $triggerName, ?int $leadId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по наименованию триггера.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-8" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">triggerName</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование триггера</td></tr><tr><td style="width: 33.3745%;">leadId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID лида</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
bot.clearTriggerJobsByName('Триггер');
```

# bot.clearTriggerJobsByScriptCode()

### Очистить джобы по коду скрипта

```
bot.clearTriggerJobsByScriptCode(?string $scriptCode, ?int $leadId = null, ?int $ticketId = null)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб триггеров по коду скрипта.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr" style="border-collapse: collapse; width: 100%; height: 119.188px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">scriptCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код скрипта</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">leadId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID лида</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">ticketId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID заявки</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

# bot.clearTriggerJobsByIdForTicket()

### Очистить джобы по id триггера и ID заявки

```JavaScript
bot.clearTriggerJobsByIdForTicket(?int $triggerId, ?int $ticketId)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по id триггера и ID заявки.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-9" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">triggerId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID триггера</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, джобы которой будут очищены</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.clearTriggerJobsByIdForTicket(TriggerId, 17256);
```

# bot.clearTriggerJobsByNameForTicket()

### Очистить джобы по наименованию триггера и ID заявки

```JavaScript
bot.clearTriggerJobsByNameForTicket(?string $triggerName, ?int $ticketId)
```

##### Описание:

<span style="font-weight: 400;">Выполняется поиск и очистка джоб по наименованию триггера и ID заявки.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tri-10" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">triggerName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование триггера</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, джобы которой будут очищены</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение очистки джоб.

##### Пример:

```JavaScript
bot.clearTriggerJobsByNameForTicket('Триггер', 17256);
```

# bot.scheduleBroadcast()

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


```JavaScript
bot.scheduleBroadcast(?int $broadcastId, ?int $ticketId = null, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">broadcastId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID рассылки, которая будет запущена</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущена рассылка</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

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

# bot.scheduleBroadcastByCode()

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


```JavaScript
bot.scheduleBroadcastByCode(?string $broadcastCode, ?int $ticketId = null, $jobParams = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bro" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">broadcastCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код рассылки, которая будет запущена</td></tr><tr><td style="width: 33.3745%;">ticketId</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">ID заявки, для которой будет запущена рассылка</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

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

**run\_at** - точное время запуска (по часовому поясу сервера)  
или  
**run\_after\_sec** - для запуска через указанное кол-во секунд

</td></tr></tbody></table>

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

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

##### Пример:

```JavaScript
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 ? 'да' : 'нет');
```

# bot.getBroadcastIdByCode()

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


```JavaScript
bot.getBroadcastIdByCode(?string $broadcastCode)
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-bro-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">broadcastCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код рассылки</td></tr></tbody></table>

##### Возвращает:

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

# bot.getForwardEventType()

### Проверка кто переключил на оператора

```JavaScript
bot.getForwardEventType()
```

##### Описание:

Эта функция необходимо для того чтобы отличать событие Переключения на оператора обычным способом (через маршруты/скрипты бота) или при перехвате управления оператором.

##### Возвращает:

**bool** - "forwarded\_by\_operator" если контроль за диалогом забран оператором (по его инициативе).

# bot.isForwardedToOperator()

### Проверка переключения на оператора

```JavaScript
bot.isForwardedToOperator()
```

##### Описание:

<span style="font-weight: 400;">Проверяет переключен ли лид на оператора.</span>

##### Возвращает:

**bool** - подтверждение того, что лид переключен на оператора.

# bot.createTicket()

### Создание заявки

```JavaScript
bot.createTicket($data)
```

##### Описание:

Создает в боте заявку с указанными полями.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab" style="border-collapse: collapse; width: 100%; height: 290.547px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="background-color: #ecf0f1; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;"><span style="font-weight: 400;">data</span></td><td style="width: 33.2909%; height: 29.7969px;">json</td><td style="width: 33.2948%; height: 29.7969px;">Данные о заявке в формате json. Возможные поля расписаны ниже</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;"><span style="font-weight: 400;">title</span></td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Заголовок заявки</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;"><span style="font-weight: 400;">ticket\_type\_id</span></td><td style="width: 33.2909%; height: 29.7969px;">int</td><td style="width: 33.2948%; height: 29.7969px;">Id типа заявки</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;"><span style="font-weight: 400;">status\_id</span></td><td style="width: 33.2909%; height: 29.7969px;">int</td><td style="width: 33.2948%; height: 29.7969px;">Id статуса заявки</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;"><span style="font-weight: 400;">author\_person\_id</span>

</td><td style="width: 33.2909%; height: 35.3906px;">int</td><td style="width: 33.2948%; height: 35.3906px;">Id автора заявки</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;"><span style="font-weight: 400;">client\_person\_id</span>

</td><td style="width: 33.2909%; height: 35.3906px;">int</td><td style="width: 33.2948%; height: 35.3906px;">Id клиента заявки</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;"><span style="font-weight: 400;">assigned\_person\_id</span>

</td><td style="width: 33.2909%; height: 35.3906px;">int</td><td style="width: 33.2948%; height: 35.3906px;">Id исполнителя заявки</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;"><span style="font-weight: 400;">description</span>

</td><td style="width: 33.2909%; height: 35.3906px;">string</td><td style="width: 33.2948%; height: 35.3906px;">Описание заявки</td></tr></tbody></table>

<span style="font-weight: 400;">Для избежания пересечения с полями заявки дополнительные поля по имени передаются отдельным блоком 'custom'.</span>

##### Возвращает:

**int** - id созданной заявки в формате числа.

##### Пример:

```JavaScript
let ticketData = {
  'title': 'Создано в боте',
  'ticket_type_id': 1006,
  'status_id': 1017
  'description': lead.getAttr('проблема')  
};

ticketData.custom = {
  'возраст': 99,
  'рост': 199
};

let newTicketId = bot.createTicket(ticketData);
```

Пример создания заявки с кастомным полем **space** типа выпадающий список:

```JavaScript
let $space = 0;

if (lead.getAttr('space') == 'Квартира') {
  $space = 1;
} else if (lead.getAttr('space') == 'Частный дом') {
  $space = 2;
} else if (lead.getAttr('space') == 'Общежитие') {
  $space = 3;
}

let ticketData = {
  'title': 'Создано в боте'
};

ticketData.custom = {
  'space': $space
}

let newTicketId = bot.createTicket(ticketData);
```

# bot.updateTicketById()

### Обновление заявки


```JavaScript
bot.updateTicketById(int $ticketId, $data)
```

##### Описание:

Обновляет заявку по id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-fie" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">ticketId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID заявки</td></tr><tr style="height: 29.7969px; background-color: #ecf0f1;"><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">data</span></td><td style="width: 33.3745%; height: 29.7969px;">json</td><td style="width: 33.3745%; height: 29.7969px;">Данные о заявке в формате json. Возможные поля расписаны ниже</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">title</span></td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Заголовок заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">ticket\_type\_id</span></td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">Id типа заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">status\_id</span></td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">Id статуса заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">author\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id автора заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">client\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id клиента заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">assigned\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id исполнителя заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">description</span>

</td><td style="width: 33.3745%; height: 35.3906px;">string</td><td style="width: 33.3745%; height: 35.3906px;">Описание заявки</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение обновления заявки.

##### Пример:

```JavaScript
bot.updateTicketById(4527, {
  'title': 'Создано в боте',
  'ticket_type_id': 1013,
  'status_id': 1096
})
```

# bot.getMaxRejectsTicketCount()

### Получить максимальное количество отказов

```JavaScript
bot.getMaxRejectsTicketCount()
```

##### Описание:

Возвращает максимальное количество отказов от заявки.

##### Возвращает:

**int** - количество отказов в формате числа.

##### Пример:

```JavaScript
let MaxRejects = bot.getMaxRejectsTicketCount();
```

# bot.findTickets()

### Поиск заявок


```JavaScript
bot.findTickets($where = [], bool $findInAllBusinessBots = false, $orderBy = [], ?int $limit = null, ?int $offset = null)
```

##### Описание:

Находит заявки в соответствии с указанными параметрами и возвращает их массив.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5" style="border-collapse: collapse; width: 100%; height: 148.984px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">where</td><td style="width: 33.3745%; height: 29.7969px;">array</td><td style="width: 33.3745%; height: 29.7969px;">Параметр по которому будет проверяться соответствие с найденными заявками</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">findInAllBusinessBots</td><td style="width: 33.3745%; height: 29.7969px;">bool</td><td style="width: 33.3745%; height: 29.7969px;">Параметр, показывающий нужно ли искать заявки во всех ботах бизнеса</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">orderBy</td><td style="width: 33.3745%; height: 29.7969px;">array</td><td style="width: 33.3745%; height: 29.7969px;">Параметр сортирующий найденные заявки</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">limit</td><td style="width: 33.3745%; height: 29.7969px;">?int</td><td style="width: 33.3745%; height: 29.7969px;">Максимальное количество заявок, которое будет возвращено</td></tr><tr><td style="width: 33.3745%;">offset</td><td style="width: 33.3745%;">?int</td><td style="width: 33.3745%;">Параметр показывающий с какой по счету найденной заявки начать возвращать значения</td></tr></tbody></table>

##### Возвращает:

**array** - массив с id всех найденных заявок.

##### Пример:

```JavaScript
let tickets = bot.findTickets();

for (let i = 0; i < tickets.length; i++) {
  lead.setAttr('tickets_' + i + '_tickets_title', tickets[i].getData('title'));
  lead.setAttr('tickets_' + i + '_client_contacts', tickets[i].getCustomData('client_contacts'));
  lead.setAttr('tickets_' + i + '_details', tickets[i].getCustomData('details'));
  lead.setAttr('tickets_' + i + '_статус_имя', tickets[i].getCustomData('статус.имя'));
}

lead.setAttr('found_tickets_count', tickets.length);
```

# bot.findTicketIdByCustomField()

### Найти id заявки по значению поля

```JavaScript
bot.findTicketIdByCustomField(string $fieldName, $value)
```

##### Описание:

Находит Id первой заявки, у которой поле $fieldName имеет значение $value.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-fie-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">fieldName</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование поля заявки</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">value</td><td style="width: 33.2909%; height: 29.7969px;">mixed</td><td style="width: 33.2948%; height: 29.7969px;">Значение поля заявки</td></tr></tbody></table>

##### Возвращает:

**int** - id найденной заявки в формате числа.

##### Пример:

```JavaScript
let TicketId = bot.findTicketIdByCustomField('title', 'Заявка');
```

# bot.getTicketTypeIdByName()

### Найти id вида заявки по наименованию

```JavaScript
bot.getTicketTypeIdByName(string $typeName)
```

##### Описание:

Находит id вида заявки по наименованию вида заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-typ" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">typeName</td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Наименование вида заявки</td></tr></tbody></table>

##### Возвращает:

**int** - id вида заявки в формате числа.

##### Пример:

```JavaScript
let TicketId = bot.findTicketIdByCustomField('Заявка');
```

# bot.getTicketStatusIdByName()

### <span style="color: #222222; font-size: 1.666em;">Найти id статуса заявки по наименованию</span>  


```JavaScript
bot.getTicketStatusIdByName(string $statusName)
```

##### Описание:

Находит id статуса заявки по наименованию статуса заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">statusName</td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Наименование статуса заявки</td></tr></tbody></table>

##### Возвращает:

**int** - id статуса заявки в формате числа.

##### Пример:

```JavaScript
let StatusId = bot.getTicketStatusIdByName('Статус');
```

# bot.setCurrentTicketById()

### Установить текущую заявку

```
bot.setCurrentTicketById(?int $ticketId)
```

##### Описание:

Устанавливает текущую заявку по id. Переменные с новым значением начинают работать со следующей команды после команды с вызовом bot.setCurrentTicketById.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tic" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">ticketId</td><td style="width: 33.2909%;">?int</td><td style="width: 33.2948%;">ID заявки</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```JavaScript
bot.setCurrentTicketById(1432);
```

# bot.clearTicketAssignedPersonsLog()

### Очистить лог назначения тикета персонам


```JavaScript
bot.clearTicketAssignedPersonsLog()
```

##### Описание:

Очищает лог назначения тикета персонам, чтобы можно было запустить один тикет повторно по той же очереди исполнителей.

##### Возвращает:

**bool** — подтверждение очистки лога.

# bot.createPerson()

### Создание персоны

```JavaScript
bot.createPerson($data)
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab" style="border-collapse: collapse; width: 100%; height: 620.747px;"><tbody><tr style="background-color: #ced4d9; height: 29.8785px;"><td style="width: 33.2909%; height: 29.8785px;">Имя</td><td style="width: 33.2909%; height: 29.8785px;">Тип</td><td style="width: 33.2948%; height: 29.8785px;">Описание</td></tr><tr style="background-color: #ecf0f1; height: 48.8889px;"><td style="width: 33.2909%; height: 48.8889px;">data

</td><td style="width: 33.2909%; height: 48.8889px;">json</td><td style="width: 33.2948%; height: 48.8889px;">Данные о персоне в формате json. Возможные поля расписаны ниже</td></tr><tr style="height: 48.8889px;"><td style="width: 33.2909%; height: 48.8889px;">lead\_id

</td><td style="width: 33.2909%; height: 48.8889px;">integer|null</td><td style="width: 33.2948%; height: 48.8889px;">Id лида, к которому будет привязана персона</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">person\_role\_id

</td><td style="width: 33.2909%; height: 35.4688px;">integer</td><td style="width: 33.2948%; height: 35.4688px;">Id персоны</td></tr><tr style="height: 124.983px;"><td style="width: 33.2909%; height: 124.983px;">is\_external

</td><td style="width: 33.2909%; height: 124.983px;">bool</td><td style="width: 33.2948%; height: 124.983px;"><span style="font-weight: 400;">Если не устанавливать по умолчанию будет установлено 1, означающее что персона является клиентом. </span>

<span style="font-weight: 400;">А 0 означает что персона является работником бизнеса</span>

</td></tr><tr style="height: 48.8889px;"><td style="width: 33.2909%; height: 48.8889px;">user\_id

</td><td style="width: 33.2909%; height: 48.8889px;">integer</td><td style="width: 33.2948%; height: 48.8889px;">Id пользователя, привязываемого к персоне</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">firstname

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Имя персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">lastname

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Фамилия персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">middlename

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Отчество персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">email

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Адрес электронной почты персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">phone

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Номер телефона персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">organization\_name

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Название организации</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">organization\_address

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Адрес организации</td></tr><tr style="height: 35.4688px;"><td style="width: 33.2909%; height: 35.4688px;">comment

</td><td style="width: 33.2909%; height: 35.4688px;">string|null</td><td style="width: 33.2948%; height: 35.4688px;">Комментарий к персоне</td></tr></tbody></table>

##### Возвращает:

**int** - id персоны в формате числа.

##### Пример:

```JavaScript
let newPersonId = bot.createPerson({
  'lead_id': 2356,
  'is_external': 1,
  'lastname': 'Иванов'
});
```

# bot.findPersons()

### Поиск персоны

```JavaScript
bot.findPersons($where = [], $orderBy = [], ?int $limit = null, ?int $offset = null, bool $isLogErrorIfManyPersonsFound = false)
```

##### Описание:

Находит персоны в соответствии с указанными параметрами и возвращает их массив.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-whe" style="border-collapse: collapse; width: 100%; height: 297.156px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 66.3906px;"><td style="width: 33.2909%; height: 66.3906px;">where

</td><td style="width: 33.2909%; height: 66.3906px;">array</td><td style="width: 33.2948%; height: 66.3906px;">Параметр по которому будет проверяться соответствие с найденными персонами</td></tr><tr style="height: 49.5938px;"><td style="width: 33.2909%; height: 49.5938px;">orderBy

</td><td style="width: 33.2909%; height: 49.5938px;">array</td><td style="width: 33.2948%; height: 49.5938px;">Параметр сортирующий найденные персоны</td></tr><tr style="height: 49.5938px;"><td style="width: 33.2909%; height: 49.5938px;">limit

</td><td style="width: 33.2909%; height: 49.5938px;">?int</td><td style="width: 33.2948%; height: 49.5938px;">Максимальное количество персон, которое будет возвращено</td></tr><tr style="height: 66.3906px;"><td style="width: 33.2909%; height: 66.3906px;">offset

</td><td style="width: 33.2909%; height: 66.3906px;">?int</td><td style="width: 33.2948%; height: 66.3906px;">Параметр показывающий с какой по счету найденной персоны начать возвращать значения</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">isLogErrorIfManyPersonsFound

</td><td style="width: 33.2909%; height: 35.3906px;">bool</td><td style="width: 33.2948%; height: 35.3906px;">Возвращать ли лог с ошибкой, если найдено больше персон чем указано в limit</td></tr></tbody></table>

##### Возвращает:

**array** - массив с id всех найденных персон.

##### Пример:

```JavaScript
//let persons = bot.findPersons([["firstname", "Alex"]], {}, null, null, true);
//let persons = bot.findPersons([["firstname", "Alex"], ["is_external", "=", 0]], {}, null, null, true);
//let persons = bot.findPersons([["persons.firstname", "=", "Alex"], ["persons.is_external", "=", 0], ["person_roles.name", "=", "test"]], {}, null, null, true);

let persons = bot.findPersons([["firstname", "Alex"]]);

for (let i = 0; i < persons.length; i++) {
  lead.setAttr('person_' + i + '_role_name', persons[i].getRoleName()); 
}

lead.setAttr('found_persons_count', persons.length);
```

# bot.updatePersonById()

### Обновить персону по id

```JavaScript
bot.updatePersonById(int $personId, $data)
```

##### Описание:

Обновляет поля персоны в соответствии с БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per" style="border-collapse: collapse; width: 100%; height: 572.553px;"><tbody><tr style="background-color: #ced4d9; height: 29.8785px;"><td style="width: 33.3791%; height: 29.8785px;">Имя</td><td style="width: 33.3791%; height: 29.8785px;">Тип</td><td style="width: 33.3791%; height: 29.8785px;">Описание</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">personId

</td><td style="width: 33.3791%; height: 35.4688px;">int</td><td style="width: 33.3791%; height: 35.4688px;">ID персоны</td></tr><tr style="height: 48.8889px; background-color: #ecf0f1;"><td style="width: 33.3791%; height: 48.8889px;">data

</td><td style="width: 33.3791%; height: 48.8889px;">json</td><td style="width: 33.3791%; height: 48.8889px;">Данные о персоне в формате json. Возможные поля расписаны ниже</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">person\_role\_id

</td><td style="width: 33.3791%; height: 35.4688px;">integer</td><td style="width: 33.3791%; height: 35.4688px;">Id персоны</td></tr><tr style="height: 124.983px;"><td style="width: 33.3791%; height: 124.983px;">is\_external

</td><td style="width: 33.3791%; height: 124.983px;">bool</td><td style="width: 33.3791%; height: 124.983px;"><span style="font-weight: 400;">Если не устанавливать по умолчанию будет установлено 1, означающее что персона является клиентом. </span>

<span style="font-weight: 400;">А 0 означает что персона является работником бизнеса</span>

</td></tr><tr style="height: 49.5833px;"><td style="width: 33.3791%; height: 49.5833px;">user\_id

</td><td style="width: 33.3791%; height: 49.5833px;">integer</td><td style="width: 33.3791%; height: 49.5833px;">Id пользователя, привязываемого к персоне</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">firstname

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Имя персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">lastname

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Фамилия персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">middlename

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Отчество персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">email

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Адрес электронной почты персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">phone

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Номер телефона персоны</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">organization\_name

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Название организации</td></tr><tr><td style="width: 33.3791%; height: 35.4688px;">organization\_address

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Адрес организации</td></tr><tr style="height: 35.4688px;"><td style="width: 33.3791%; height: 35.4688px;">comment

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Комментарий к персоне</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**bool** - подтверждение обновления данных.

##### Пример:

```JavaScript
bot.updatePersonById(15624, {
  'is_external': 1,
  'firstname': 'Иван',
  'lastname': 'Иванов'
});
```

# bot.deletePersonById()

### Удалить персону по id

```JavaScript
bot.deletePersonById(int $personId)
```

##### Описание:

Удаляет персону по id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-0" style="border-collapse: collapse; width: 100%; height: 100.578px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">personId

</td><td style="width: 33.2909%; height: 35.3906px;">int</td><td style="width: 33.2948%; height: 35.3906px;">ID персоны</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

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

##### Пример:

```JavaScript
bot.deletePersonById(24376);
```

# bot.getIntegrationIdByCode()

### Получить id интеграции бота по коду

```JavaScript
bot.getIntegrationIdByCode(?string $integrationCode)
```

##### Описание:

Находит id интеграции по ее коду.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">integrationCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код интеграции</td></tr></tbody></table>

##### Возвращает:

**int** - id интеграции, если она принадлежит боту

или

**null** - если интеграция не найдена.

# bot.getEnabledIntegrationIdByCode()

### Получить id включенной интеграции бота по коду

```JavaScript
bot.getEnabledIntegrationIdByCode(?string $integrationCode)
```

##### Описание:

Находит id интеграции по ее коду, если интеграция активна.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-int" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">integrationCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код интеграции</td></tr></tbody></table>

##### Возвращает:

**int** - id интеграции, если она принадлежит боту и активна

или

**null** - если интеграция не найдена или не активна.

# bot.isEnabledIntegrationById()

### Проверить активность интеграции по id

```JavaScript
bot.isEnabledIntegrationById(?int $integrationId)
```

##### Описание:

Проверяет есть ли такая интеграция по id и включена ли она.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-int-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">integrationId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID интеграции</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение активности интеграции.

# bot.isEnabledIntegrationByCode()

### Проверить активность интеграции по коду

```JavaScript
bot.isEnabledIntegrationByCode(?string $integrationCode)
```

##### Описание:

Проверяет есть ли такая интеграция по коду и включена ли она.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-int-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">integrationId</td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">ID интеграции</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение активности интеграции.

# bot.getLockNameForBot()

### Сгенерировать имя блокировки по боту

```JavaScript
bot.getLockNameForBot(string $lockName, string $lockPrefix = ''): string
```

##### Описание:

Генерирует имя блокировки по боту.

<p class="callout info">Использование на данный момент смысла не имеет, функции блокировок сами добавляют дополнительные префиксы к именами блокировок указанным в аргументах функций.</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">lockName</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Имя блокировки</td></tr><tr><td style="width: 33.2909%;">lockPrefix </td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

**string** - имя блокировки в формате строки.

##### Пример:

```JavaScript
let lockName = bot.getLockNameForBot('lock', 'first');
```

# bot.getLockNameForBusiness()

### Сгенерировать имя блокировки по бизнесу

```JavaScript
bot.getLockNameForBusiness(string $lockName, string $lockPrefix = ''): string
```

##### Описание:

Генерирует имя блокировки по бизнесу.

<p class="callout info">Использование на данный момент смысла не имеет, функции блокировок сами добавляют дополнительные префиксы к именами блокировок указанным в аргументах функций.</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">lockName</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Имя блокировки</td></tr><tr><td style="width: 33.2909%;">lockPrefix </td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

**string** - имя блокировки в формате строки.

##### Пример:

```JavaScript
let lockName = bot.getLockNameForBusiness('lock', 'first');
```

# bot.waitForBusinessLock()

### Захватить блокировку по бизнесу

```
bot.waitForBusinessLock(string $lockName, string $lockPrefix = '', ?int $ttlSec = null, $maxWaitSec = 300): bool
```

##### Описание:

Дожидается, когда блокировка будет освобождена, и затем захватывает ее.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">ttlSec </td><td style="width: 33.2909%; height: 29.537px;">?int</td><td style="width: 33.2948%; height: 29.537px;">Время жизни блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">maxWaitSec </td><td style="width: 33.2909%; height: 46.3426px;">int</td><td style="width: 33.2948%; height: 46.3426px;">Максимальное время ожидания блокировки</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение захвата блокировки.

##### Пример:

```JavaScript
let lockName = 'my_lock_1';
let lockPrefix = '';
let ttlSec = 5;
let maxWaitSec = 300;

let isLocked = false;
isLocked = bot.waitForBusinessLock(lockName, lockPrefix, ttlSec, maxWaitSec);
```

# bot.waitForBotLock()

### Захватить блокировку по боту

```
bot.waitForBotLock(string $lockName, string $lockPrefix = '', ?int $ttlSec = null, $maxWaitSec = 300): bool
```

##### Описание:

Дожидается, когда блокировка будет освобождена, и затем захватывает ее.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">ttlSec </td><td style="width: 33.2909%; height: 29.537px;">?int</td><td style="width: 33.2948%; height: 29.537px;">Время жизни блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">maxWaitSec </td><td style="width: 33.2909%; height: 46.3426px;">int</td><td style="width: 33.2948%; height: 46.3426px;">Максимальное время ожидания блокировки</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение захвата блокировки.

##### Пример:

```JavaScript
let lockName = 'my_lock_1';
let lockPrefix = '';
let ttlSec = 5;
let maxWaitSec = 300;

let isLocked = false;
isLocked = bot.waitForBotLock(lockName, lockPrefix, ttlSec, maxWaitSec);
```

# bot.releaseAllCurrentLocks()

### Освободить все блокировки

```
bot.releaseAllCurrentLocks(): bool
```

##### Описание:

Освобождает все блокировки захваченные в текущем скрипте

##### Возвращает:

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

# bot.releaseCurrentLockForBusiness()

### Освободить блокировку скрипта по бизнесу

```
bot.releaseCurrentLockForBusiness(string $lockName, string $lockPrefix = ''): bool
```

##### Описание:

Освобождает блокировку захваченную текущем скрипте по бизнесу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```JavaScript
if (bot.releaseCurrentLockForBusiness('lockName')) {
    bot.sendText('Блокировка удалена')
} else {
    bot.sendText('Ошика удаления блокировки')
}
```

# bot.releaseCurrentLockForBot()

### Освободить блокировку скрипта по боту

```
bot.releaseCurrentLockForBot(string $lockName, string $lockPrefix = ''): bool
```

##### Описание:

Освобождает блокировку захваченную текущем скрипте по боту.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```JavaScript
if (bot.releaseCurrentLockForBot('lockName')) {
    bot.sendText('Блокировка удалена')
} else {
    bot.sendText('Ошика удаления блокировки')
}
```

# bot.releaseLockForBusiness()

### Освободить блокировку по бизнесу

```
bot.releaseLockForBusiness(string $lockName, string $lockPrefix = ''): bool
```

##### Описание:

Освобождает блокировку по бизнесу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```JavaScript
if (bot.releaseLockForBusiness('lockName')) {
    bot.sendText('Блокировка удалена')
} else {
    bot.sendText('Ошика удаления блокировки')
}
```

# bot.releaseLockForBot()

### Освободить блокировку по боту

```
bot.releaseLockForBot(string $lockName, string $lockPrefix = ''): bool
```

##### Описание:

Освобождает блокировку по боту.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```JavaScript
if (bot.releaseLockForBot('lockName')) {
    bot.sendText('Блокировка удалена')
} else {
    bot.sendText('Ошика удаления блокировки')
}
```

# bot.hasLockForBot()

### Проверка существования блокировки по боту

```
bot.hasLockLockForBot(string $lockName, string $lockPrefix = '', $checkValue = null): bool
```

##### Описание:

Проверяет существование блокировки по боту.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr><tr><td style="width: 33.2909%;">checkValue</td><td style="width: 33.2909%;">int</td><td style="width: 33.2948%;">Количество проверок</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение существования блокировки.

##### Пример:

```JavaScript
let hasLock = bot.hasLockLockForBot('lockName');
```

# bot.hasLockForBusiness()

### Проверка существования блокировки по бизнесу

```
bot.hasLockForBusiness(string $lockName, string $lockPrefix = '', $checkValue = null): bool
```

##### Описание:

Проверяет существование блокировки по бизнесу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">lockName</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Имя блокировки</td></tr><tr style="height: 46.3426px;"><td style="width: 33.2909%; height: 46.3426px;">lockPrefix </td><td style="width: 33.2909%; height: 46.3426px;">string</td><td style="width: 33.2948%; height: 46.3426px;">Префикс, который будет добавлен к имени блокировки</td></tr><tr><td style="width: 33.2909%;">checkValue</td><td style="width: 33.2909%;">int</td><td style="width: 33.2948%;">Количество проверок</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение существования блокировки.

##### Пример:

```JavaScript
let hasLock = bot.hasLockForBusiness('lockName');
```

# bot.getForwardEventType()

### Получить название события

```JavaScript
bot.getForwardEventType()
```

##### Описание:

Возвращает строку "forwarded\_by\_operator" если действие выполнено оператором или null для контакт-центра. Ранее она использовалась только для интеграции с контакт-центром Facebook. Для Facebook аналогично, но в дополнение к "forwarded\_by\_operator" может возвращать и другие строки, например "message\_from\_operator" или "operator\_joined\_dialog".

##### Возвращает:

**string** - строка "forwarded\_by\_operator", если действие выполнено оператором

или

**null** - если действие не выполнено оператором.

# bot.canAutoForward()

### Узнать доступно ли авто-назначение оператора в данном скрипте

```
bot.canAutoForward()
```

##### Описание:

Функция необходима для исключения рекурсивного вызова назначения диалога на оператора, а также для исключения выполнения авто-назначения диалога на оператора, если оператор сам подключается к диалога из контакт-центра.

##### Возвращает:

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

# bot.scheduleJob()

### Планирование любой задачи

```JavaScript
bot.scheduleJob($jobParams = [])
```

#### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-scr-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%;">jobParams</td><td style="width: 33.3745%;">json</td><td style="width: 33.3745%;">Передача в планируемую задачу входящих json параметров. Можно указать script\_request\_params (для скрипта/триггера/рассылки)  
condition\_script\_code (для перекрытия условия триггера/рассылки).

</td></tr></tbody></table>

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

- **trigger\_code** — код триггера;
- **script\_code** — код скрипта;
- **lead\_id** — лид;
- **ticket\_id** — заявка;
- **condition\_script\_code** — js код ("return false;");
- **add\_tags** — добавить тэги;
- **remove\_tags** — удалить тэги;
- **is\_periodic** — будет ли запускаться джоба с периодичностью;
- **repeat\_interval\_sec** — интервал периодичности запуска;
- **script\_request\_params**:
- **run\_at** — точное время запуска (по часовому поясу сервера);
- **run\_after\_sec** — для запуска через указанное кол-во секунд;
- **condition\_script\_code** — параметр для перекрытия условия триггера/рассылки.

<p class="callout warning">Если указать run\_at и run\_after\_sec то будет использован только параметр run\_at.</p>

##### Возвращает:

**bool** — подтверждение планирования задачи.

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>##### Пример:

```JavaScript
var result = bot.scheduleJob({
  "trigger_code": "trg31",
  "lead_id": lead.getData('id'),
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});
```

# bot.getIncomingMessage()

### Получить текст входящего сообщения

```JavaScript
bot.getIncomingMessage(bool $useOutputFilter = false)
```

##### Описание:

Возвращает текст входящего сообщения или текст подписи к вложению.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 110.745px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 80.9537px;"><td style="width: 33.2909%; height: 80.9537px;">useOutputFilter </td><td style="width: 33.2909%; height: 80.9537px;">bool</td><td style="width: 33.2948%; height: 80.9537px;">Используется для включения фильтра входящего сообщения, чтобы исключить не поддерживаемые системой символы</td></tr></tbody></table>

##### Возвращает:

**string** - текст входящего сообщения в формате строки.

# bot.getWebhookJobId()

### Получить id вебхука зарегистрированного в очереди Метабот

```
bot.getWebhookJobId()
```

##### Описание:

Возвращает id вебхука зарегистрированного в очереди Метабот.

##### Возвращает:

**int** - id вебхука

или

**null** - если таких данных не существует.

# bot.getWebhookJob()

### Получить информацию о вебхуке

```
bot.getWebhookJob()
```

##### Описание:

Возвращает информацию о вебхуке, т.е. запись из очереди Метабот. Данная запись также содержит поле payload, удобство использования данной функции в отличии от обработки «сырого» payload в том, что данные возвращаемые функцией уже обработаны и представлены в едином формате для любого мессенджера.

##### Возвращает:

**array** - массив индексов.

Параметры (индексы массива) которые возвращает данная функция:

- 'id'
- 'status\_id'
- 'attempt'
- 'response\_code'
- 'response\_time'
- 'worked\_time'
- 'messenger'
- 'event\_type'
- 'original\_event\_type'
- 'channel\_code'
- 'channel\_id'
- 'channel\_id'
- 'bot\_channel\_id'
- 'bot\_id'
- 'lead\_identification'
- 'lead\_identification\_entity'
- 'lead\_id'
- 'lead\_status\_ext'
- 'lead\_status\_id'
- 'message\_id'
- 'message\_date'
- 'message'
- 'message\_type'
- 'url'
- 'url\_secret'
- 'payload'
- 'payload\_array'
- 'chat\_id'
- 'created\_at'
- 'updated\_at'

# bot.getWebhookPayload()

### Получить payload входящего вебхука

```
bot.getWebhookPayload()
```

##### Описание:

Возвращает payload входящего вебхука в виде массива.

##### Возвращает:

**array** - массив payload входящего вебхука.

# bot.getLastResultPayload()

### Получить payload c данными о последнем ответе мессенджера

```
bot.getLastResultPayload()
```

##### Описание:

Возвращает payload c данными о последнем ответе мессенджера в виде массива.

##### Возвращает:

**array** - массив payload c данными о последнем ответе мессенджера

или

**null** - если таких данных не существует.

##### Пример:

1. Мы отправили в мессенджер сообщения используя REST API.
2. Мессенджер вернул ответ, этот ответ будет доступен с помощью функции getLastResultPayload().
3. Например, таким способом можно получить file\_id, который вернул Telegram после отправки файла или id сообщения который вернул Telegram, для того чтобы в дальнейшем отредактировать это сообщение или удалить.

# bot.getChannelData()

### Получить настройки канала лида

```JavaScript
bot.getChannelData(string|null $key = null)
```

##### Описание:

Получить настройки канала лида, задаваемые при привязки нового канала.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;">Ключ настройки канала лида</td></tr></tbody></table>

##### Возвращает:

**array** - массив настроек канала

**mixed** - настройка канала в формате, в котором она находится в сущности

или

**null** - если таких данных не существует.

# bot.disableBuffer()

### Принудительное отключение буфера исходящих сообщений

```
bot.disableBuffer()
```

##### Описание:

Принудительное отключение буфера исходящих сообщений.

<p class="callout warning">Если отключаете, не забывайте **включать назад**, в конце вашего JavaScript кода.</p>

# bot.enableBuffer()

### Принудительное включение буфера исходящих сообщений 

```
bot.enableBuffer()
```

##### Описание:

Принудительное включение буфера исходящих сообщений.

<p class="callout info">Не влияет на аргумент $isDisableBuffer передаваемый в sendText / sendMessage / sendButtons.</p>

# bot.flushBuffer()

### Принудительное освобождение буфера исходящих сообщений

```
bot.flushBuffer()
```

##### Описание:

Принудительное освобождение буфера исходящих сообщений. Отправка всех накопленных сообщений клиенту.

# bot.getAllAttachments()

### Получить вложения всех видов

```
bot.getAllAttachments(string|null $filesMimeExcludeFilter = 'image|video')
```

##### Описание:

Получить вложения всех видов, в т.ч. фото, видео, аудио, файлы и т.д., т.е. все вложения которые поддерживаем Метабот и данный канал.

<p class="callout warning">На данный момент getAllAttachments **работает только с Telegram**, для других каналов функция возвращает пустой массив.  
</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">filesMimeExcludeFilter </td><td style="width: 33.2909%; height: 29.7969px;">'image|video' | null</td><td style="width: 33.2948%; height: 29.7969px;">Тип исключаемых файлов</td></tr></tbody></table>

##### Возвращает:

**array** - массив вложений.

# bot.getFiles()

### Получить все вложения, которые распознаны как файл

```JavaScript
bot.getFiles(string|null $mimeIncludeFilter = null, string|null $mimeExcludeFilter = 'image|video')
```

##### Описание:

Получить все вложения, которые распознаны как файл.

<p class="callout warning">На данный момент getFilesработает **работает только с Telegram**, для других каналов функция возвращает пустой массив.  
</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 89.1204px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">mimeIncludeFilter </td><td style="width: 33.2909%; height: 29.7917px;">string|null | null</td><td style="width: 33.2948%; height: 29.7917px;">Тип добавляемых файлов</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">mimeExcludeFilter </td><td style="width: 33.2909%; height: 29.537px;">'image|video' | null</td><td style="width: 33.2948%; height: 29.537px;">Тип исключаемых файлов</td></tr></tbody></table>

##### Возвращает:

**array** - массив вложений.

# bot.getImages()

### Получить все изображения

```JavaScript
bot.getImages(string|null $mimeIncludeFilter = 'image')
```

##### Описание:

Получить все изображения, а также файлы, которые распознаны как изображение.

<p class="callout warning">На данный момент getImagesработает **работает только с Telegram**, для других каналов функция возвращает пустой массив.  
</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">mimeIncludeFilter </td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;">Тип включаемых файлов</td></tr></tbody></table>

##### Возвращает:

**array** - массив вложений.

# bot.getVideos()

### Получить все видео

```JavaScript
bot.getVideos(string|null $mimeIncludeFilter = 'video')
```

##### Описание:

Получить все видео, а также файлы, которые распознаны как видео.

<p class="callout warning">На данный момент getVideos **работает только с Telegram**, для других каналов функция возвращает пустой массив.  
</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">mimeIncludeFilter </td><td style="width: 33.2909%; height: 29.7969px;">string | null</td><td style="width: 33.2948%; height: 29.7969px;">Тип включаемых файлов</td></tr></tbody></table>

##### Возвращает:

**array** - массив вложений.

# bot.sendPayload()

### Отправить payload в мессенджер

```JavaScript
bot.sendPayload(string|null $endpoint, array|object $payload)
```

##### Описание:

Отправить payload в мессенджер. Удобство использования данной функции в отличии от нативной передачи с помощью api.callEndpoint или api.postJson в том, что не нужно подставлять дополнительные параметры типа токена мессенджера.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">endpoint</td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;">Ключ данных бота</td></tr><tr><td style="width: 33.2909%;">payload</td><td style="width: 33.2909%;">array|object </td><td style="width: 33.2948%;">  
</td></tr></tbody></table>

##### Возвращает:

**mixed** - payload в формате, в котором они находятся в сущности

или

**array** - массив payload

или

**string** - payload в формате строки.

# bot.sendText()

### Отправить текст в мессенджер

```JavaScript
bot.sendText(string|null|mixed $messageText, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true)
```

##### Описание:

Отправляет текст пользователю в мессенджер.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">messageText</td><td style="width: 33.2909%; height: 29.7969px;">string|null|mixed</td><td style="width: 33.2948%; height: 29.7969px;">Текст сообщения</td></tr><tr><td style="width: 33.2909%;">apiAdditionalParams </td><td style="width: 33.2909%;">array|object|null </td><td style="width: 33.2948%;">Дополнительные параметры API</td></tr><tr><td style="width: 33.2909%;">isDisableBuffer </td><td style="width: 33.2909%;">bool </td><td style="width: 33.2948%;">Отключение буфера</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение успешной отправки сообщения.

# bot.sendMessage()

### Отправить сообщение в мессенджер

```
bot.sendMessage(string|null|mixed $messageText, array|object|null $buttons = null, array|object|null $attachments = null, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true, bool $isUpdateMessageButtons = false)
```

##### Описание:

Отправить сообщение в мессенджер, сообщение может содержать текст, кнопки меню и вложения. Если мессенджер поддерживает, то все это будет отправлено в едином сообщении, иначе по отдельности, в порядке: сначала вложение, затем текст и кнопки меню.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 177.731px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">messageText</td><td style="width: 33.2909%; height: 29.7917px;">string|null|mixed</td><td style="width: 33.2948%; height: 29.7917px;">Текст сообщения</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">buttons </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Кнопки</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">attachments </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Вложения</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">apiAdditionalParams </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Дополнительные параметры, которые будут отправлены по REST API в мессенджер</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isDisableBuffer </td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Принудительное отключение буффера исходящих сообщений</td></tr><tr><td style="width: 33.2909%;">isUpdateMessageButtons</td><td style="width: 33.2909%;">bool </td><td style="width: 33.2948%;">true, для обновления последнего отправленного сообщения в логе,  
чтобы не писать в лог повторы сообщений от GPT при апдейте</td></tr></tbody></table>

Дополнительно доступен предопределенный параметр «endpoint» – для замены параметра конечной точки в URL, например чтобы направить сообщение Телеграм не по классическому пути sendMessage а «по пути» editMessageMedia для редактирования сообщения, также можно подменить «endpoint», чтобы удалить сообщение, но для данных действий необходимо запоминать и передавать дополнительно как минимум параметр message\_id.

##### Возвращает:

**bool** - подтверждение успешной отправки сообщения.

# bot.sendButtons()

### Отправить кнопки с сообщением в мессенджер

```JavaScript
bot.sendButtons(string|null|mixed $messageText, array|object $buttons, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true, bool $isUpdateMessageButtons = false)
```

##### Описание:

Отправить кнопки с сообщением в мессенджер.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 181.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">messageText</td><td style="width: 33.2909%; height: 29.7917px;">string|null|mixed</td><td style="width: 33.2948%; height: 29.7917px;">Текст сообщения</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">buttons </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Кнопки</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">apiAdditionalParams </td><td style="width: 33.2909%; height: 63.1482px;">array|object|null </td><td style="width: 33.2948%; height: 63.1482px;">Дополнительные параметры, которые будут отправлены по REST API в мессенджер</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isDisableBuffer </td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Принудительное отключение буффера исходящих сообщений</td></tr><tr><td style="width: 33.2909%;">isUpdateMessageButtons</td><td style="width: 33.2909%;">bool </td><td style="width: 33.2948%;">Чтобы не логировать сообщение "Выберите вариант с помощью кнопок ниже" для кнопок GPT, которые отправляются в Telegram для обновления сообщений</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение успешной отправки сообщения.

# bot.getTelegramFileInfoById()

### Получить информацию о файле в Telegram

```JavaScript
bot.getTelegramFileInfoById(string|null $fileId, bool $isShowOriginalInfo = false)
```

##### Описание:

Возвращает информацию о файле в Telegram по file ID.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 177.731px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">fileId</td><td style="width: 33.2909%; height: 29.7917px;">string|null|mixed</td><td style="width: 33.2948%; height: 29.7917px;">ID файла</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isShowOriginalInfo </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Показать оригинальную информацию</td></tr></tbody></table>

##### Возвращает:

**array** - информация о файле в форме массива

или

**null** - если таких файлов нет.

# bot.sendTelegramAttachmentAndGetFileId()

### Отправить файл в Телеграм и получить file ID

```JavaScript
bot.sendTelegramAttachmentAndGetFileId(string|null $messageText, array|object|null $attachment, array|object|null $buttons = null, array|object|null $apiAdditionalParams = null)
```

##### Описание:

Отправляет файл в Телеграм и возвращает file ID. При запуске данной функции буфер исходящих сообщений освобождается (высылаются накопленные сообщения), отключается буфер, после выполнения функции, включается назад. Если включить буфер для выполнения данной функции, вы не сможете получить результат выполнения данной функции, тк отправка накопленного текста будет выполнена позже.

По этой же причине, чтобы было меньше проблем в работе с sendText / sendMessage / sendButtons буфер для них отключен по умолчанию. Логика работы отключения буфера для этих функций аналогична. Если же передаем параметр $isDisableBuffer = false, то ничего не происходит, т.е. текущее состояние буфера не изменяется, если необходимо, вы можете принудительно выключить буфер, передать аргумент $isDisableBuffer = false, сообщения отправятся с использованием буфера.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 177.731px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">messageText</td><td style="width: 33.2909%; height: 29.7917px;">string|null|mixed</td><td style="width: 33.2948%; height: 29.7917px;">Текст сообщения</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">buttons </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Кнопки</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">attachments </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Вложения</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">apiAdditionalParams </td><td style="width: 33.2909%; height: 29.537px;">array|object|null </td><td style="width: 33.2948%; height: 29.537px;">Дополнительные параметры, которые будут отправлены по REST API в мессенджер</td></tr></tbody></table>

##### Возвращает:

**array** - ID файлов

или

**null** - если файл не был создан.

# bot.editTelegramInlineKeyboard()

### Отредактировать кнопки меню 

```JavaScript
bot.editTelegramInlineKeyboard(int|string $chatId, int|string $messageId, string|null string $inlineMessageId, array|object|null $inlineKeyboardMarkup)
```

##### Описание:

Редактирует кнопки меню уже отправленного в Telegram сообщения. Выполняет API запрос «editMessageReplyMarkup» к Telegram Bots API.

Описание данного метода можно посмотреть в документации Telegram: https://core.telegram.org/bots/api#editmessagereplymarkup

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 211.343px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">chatId</td><td style="width: 33.3634%; height: 29.7917px;">string|null </td><td style="width: 33.3634%; height: 29.7917px;">Обязателен, если не указан inline\_message\_id. Уникальный идентификатор целевого чата или имя пользователя целевого канала</td></tr><tr style="height: 29.537px;"><td style="width: 33.3634%; height: 29.537px;">messageId</td><td style="width: 33.3634%; height: 29.537px;">array|object|null </td><td style="width: 33.3634%; height: 29.537px;">Обязателен, если не указан inline\_message\_id. Идентификатор сообщения для редактирования</td></tr><tr style="height: 29.537px;"><td style="width: 33.3634%; height: 29.537px;">inlineMessageId</td><td style="width: 33.3634%; height: 29.537px;">array|object|null </td><td style="width: 33.3634%; height: 29.537px;">Обязателен, если не указаны Chat\_id и message\_id. Идентификатор встроенного сообщения</td></tr><tr style="height: 63.1482px;"><td style="width: 33.3634%; height: 63.1482px;">inlineKeyboardMarkup</td><td style="width: 33.3634%; height: 63.1482px;">array|object|null </td><td style="width: 33.3634%; height: 63.1482px;">В формате JSON объект для кнопок.

</td></tr></tbody></table>

##### Возвращает:

**string** - информация о кнопках

или

**null** - если кнопки не были созданы.

# bot.removeTelegramInlineKeyboard()

### Удалить кнопки

```JavaScript
bot.removeTelegramInlineKeyboard(int|string $chatId, int|string $messageId, string|null $inlineMessageId = null)
```

##### Описание:

Удаляет кнопки меню уже отправленного в Telegram сообщения. Выполняет API запрос «editMessageReplyMarkup» к Telegram Bots API, но кнопки (параметр «reply\_markup») не передается в Telegram Bots API.

Описание данного метода можно посмотреть в документации Telegram: https://core.telegram.org/bots/api#editmessagereplymarkup

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 211.343px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">chatId</td><td style="width: 33.3634%; height: 29.7917px;">string|null </td><td style="width: 33.3634%; height: 29.7917px;">Обязателен, если не указан inline\_message\_id. Уникальный идентификатор целевого чата или имя пользователя целевого канала</td></tr><tr style="height: 29.537px;"><td style="width: 33.3634%; height: 29.537px;">messageId</td><td style="width: 33.3634%; height: 29.537px;">array|object|null </td><td style="width: 33.3634%; height: 29.537px;">Обязателен, если не указан inline\_message\_id. Идентификатор сообщения для редактирования</td></tr><tr style="height: 29.537px;"><td style="width: 33.3634%; height: 29.537px;">inlineMessageId</td><td style="width: 33.3634%; height: 29.537px;">array|object|null </td><td style="width: 33.3634%; height: 29.537px;">Обязателен, если не указаны Chat\_id и message\_id. Идентификатор встроенного сообщения</td></tr></tbody></table>

##### Возвращает:

**array** - информация о кнопках

или

**null** - если кнопки не были созданы.

# bot.getTelegramLastMessageId()

### Получить ID последнего сообщения

```
bot.getTelegramLastMessageId()
```

##### Описание:

Возвращает ID последнего сообщения, отправленного в Telegram. Доступно только в текущем вебхуке, сразу после отправки сообщения. Функция считывает последний payload ответа API мессенджера и извлекает ID сообщения.

##### Возвращает:

**int** - ID сообщения

или

**null** - если сообщение не найдено.

# bot.setCdnConfig()

### Установить конфиг для доступа к CDN

```JavaScript
bot.setCdnConfig(array|object|null $cdnConfig = null)
```

##### Описание:

Устанавливает конфиг для доступа к CDN.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 211.343px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">cdnConfig </td><td style="width: 33.3634%; height: 29.7917px;">array|object|null </td><td style="width: 33.3634%; height: 29.7917px;">Конфиг</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение успешной работы метода.

##### Пример:

```JavaScript
let cdnConfig = {"ftp_host": "user115.upload.clients-cdnnow.ru", "ftp_login": "mylogin", "ftp_pass": "mypassword", "public_url": "https://user115.clients-cdnnow.ru"}
```

# bot.setCdnConfig()

### Передача конфига коннекта к CDN

```JavaScript
bot.setCdnConfig(array|object|null $cdnConfig = null)
```

##### Описание:

Передача конфига коннекта к CDN в JS коде может быть не приемлема с точки зрения безопасности.

<p class="callout info">Поэтому мы можем подключить CDN к вашему бизнесу с помощью конфига системы, для этого обратитесь в поддержку.</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 211.343px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">cdnConfig </td><td style="width: 33.3634%; height: 29.7917px;">array|object|null </td><td style="width: 33.3634%; height: 29.7917px;">Конфиг</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение успешной работы метода.

# bot.getCdnConfig()

### Получить текущий конфиг CDN

```
bot.getCdnConfig()
```

##### Описание:

Возвращает текущий конфиг CDN.

##### Возвращает:

**array** - текущий конфиг

или

**null** - если данные не найдены.

# bot.getFileInfoByUrl()

### Получить информацию о файле по URL

```JavaScript
bot.getFileInfoByUrl(string $fileUrl)
```

##### Описание:

Возвращает информацию о файле по URL.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr></tbody></table>

##### Возвращает:

**array** - возвращает массив вида:

```JavaScript
[
	'exists' => (int) $httpResponseCode == 200,
	'size_kb' => (float) $fileSizeKb,
	'type' => $type,
	'mime_type' => (string|null) $mimeType,
]

```

Где

$**httpResponseCode** – HTTP код выполнения HEAD запроса (без чтения BODY);

$**fileSize** – размер файла в Кб;

$**type** – тип вложения определенный с помощью $mimeType ('image' / 'video' / 'audio' / 'file');

$**mimeType** – Mime Type определенный на основе расширения файла (извлекаемого из URL).

# bot.downloadFileFromUrl()

### Скачать файла с URL

```JavaScript
bot.downloadFileFromUrl(string $fileUrl)
```

##### Описание:

Скачивает файл с URL и загрузить в хранилище файлов Метабот для вашего бизнеса. Желательно использовать своё CDN хранилище или самим загружать файлы с помощью своего, стороннего микросервиса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr></tbody></table>

##### Возвращает:

**array** - скачанный файлы

или

**string** - скачанный файл.

# bot.downloadTmpFileFromUrl()

### Скачать файла с URL и загрузить во временное хранилище

```JavaScript
bot.downloadTmpFileFromUrl(string $fileUrl)
```

##### Описание:

Скачивает файл с URL и загрузить во временное хранилище файлов Метабот для вашего бизнеса. Желательно использовать своё CDN хранилище или самим загружать файлы с помощью своего, стороннего микросервиса.

<p class="callout warning"> Имейте ввиду, что такое хранилище периодически очищается.</p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr></tbody></table>

##### Возвращает:

**array** - скачанный файлы

или

**string** - скачанный файл.

# bot.removeFile()

### Удалить файл по URL 

```JavaScript
bot.removeFile(string $fileUrl)
```

##### Описание:

Удаляет файл по URL из хранилища файлов Метабот для вашего бизнеса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr></tbody></table>

##### Возвращает:

**string** - URL файла.

# bot.removeTmpFile()

### Удалить файл по URL из временного хранилища

```
bot.removeTmpFile(string $fileUrl)
```

##### Описание:

Удаляет файл по URL из временного хранилища файлов Метабот для вашего бизнеса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr></tbody></table>

##### Возвращает:

**string** - URL файла.

# bot.uploadFileToCdnAndGetNewUrl()

### Залить файл на CDN и получить новую ссылку

```JavaScript
bot.uploadFileToCdnAndGetNewUrl(string $fileUrl, array|object|null $cdnConfig = null)
```

##### Описание:

Заливает файл на CDN и возвращает новую ссылку, а также доп. параметры с описанием файла.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 89.1204px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr><tr style="height: 29.537px;"><td style="width: 33.3634%; height: 29.537px;">cdnConfig </td><td style="width: 33.3634%; height: 29.537px;">array|object|null </td><td style="width: 33.3634%; height: 29.537px;">Конфиг</td></tr></tbody></table>

##### Возвращает:

**array** - данные файла.

В случае успеха возвращает массив вида:

```JavaScript
[
	'result' => true,
	'type' => (string) $type,
	'url' => (string) $newUrl,
	'name' => (string) $fileName,
	'size_kb' => (float) $fileSizeKb,
	'max_size_by_type_kb' => (float) $maxFileSize,
]
```

Где

 $**type** – тип файла;

 $**newUrl** – ссылка на файла в CDN;

 $**fileName** – имя загруженного файла;

 $**fileSizeKb** – размер загруженного файла в Кб;

 $**maxFileSize** - максимальное ограничение размера файла в зависимости от типа файла.

 В случае провала возвращает массив вида:

```JavaScript
[
	'result' => false,
	'error' => true,
	'error_code' => (string) ‘вид ошибки’, // например 'error_when_upload' или ‘file_size_exceeded’
	'error_message' => (string) описание ошибки,
]

```

# bot.removeFileFromCdn()

### Удалить файл из CDN

```JavaScript
bot.removeFileFromCdn(string $fileUrl, $cdnConfig = null)
```

##### Описание:

Удаляет файл из CDN.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100.001%; height: 59.5834px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.3634%; height: 29.7917px;">Имя</td><td style="width: 33.3634%; height: 29.7917px;">Тип</td><td style="width: 33.3634%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.3634%; height: 29.7917px;">fileUrl</td><td style="width: 33.3634%; height: 29.7917px;">string</td><td style="width: 33.3634%; height: 29.7917px;">URL файла</td></tr><tr><td style="width: 33.3634%;">cdnConfig </td><td style="width: 33.3634%;">array|object|null</td><td style="width: 33.3634%;">Конфиг</td></tr></tbody></table>

##### Возвращает:

**array** - данные файла.

# Методы lead



# lead.getData()

### Получить значение данных лида

```JavaScript
lead.getData(string $key)
```

##### Описание:

Возвращает значение данных сущности лида по ключу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Ключ данных лида</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id лида;</span>
- <span style="font-weight: 400;">**identification** - внешний id лида;</span>
- <span style="font-weight: 400;">**manager\_id** - id менеджера привязанного к лиду;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота лида;</span>
- <span style="font-weight: 400;">**channel\_id** - id канала лида;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса лида;</span>
- <span style="font-weight: 400;">**extra** - ???</span>
- <span style="font-weight: 400;">**is\_mute** - включен ли бот для лида;</span>
- <span style="font-weight: 400;">все системные поля лида (по английски).</span>

##### Возвращает:

**mixed** - значение данных лида в формате, в котором они находятся в сущности

или

**null** - если таких данных не существует.

##### Пример:

```JavaScript
let extra = lead.getData('extra');
```

# lead.issetData() и lead.isDataExist()

### Проверить наличие данных

```JavaScript
lead.issetData(string $key)
```

или

```
lead.isDataExist(string $key)
```

##### Описание:

Проверяет существуют ли данные по ключу.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Ключ данных лида</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id лида;</span>
- <span style="font-weight: 400;">**identification** - внешний id лида;</span>
- <span style="font-weight: 400;">**manager\_id** - id менеджера привязанного к лиду;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота лида;</span>
- <span style="font-weight: 400;">**channel\_id** - id канала лида;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса лида;</span>
- <span style="font-weight: 400;">**extra** - ???</span>
- <span style="font-weight: 400;">**is\_mute** - включен ли бот для лида;</span>
- <span style="font-weight: 400;">все системные поля лида (по английски).</span>

##### Возвращает:

**bool** - подтверждение существования данных.

##### Пример:

```JavaScript
let data = lead.issetData('manager_id');
let altdata = lead.isDataExist('status_id');
```

# lead.getSerialNumber()

### Порядковый номер лида

```JavaScript
lead.getSerialNumber()
```

##### Описание:

Возвращает порядковый номер лида в боте начиная с первого созданного.

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

<span style="font-weight: 300;"> </span>**int** - порядковый номер лида

или

**null** - если лид не найден.

##### Пример:

```JavaScript
let num = lead.getSerialNumber();
```

# lead.getChannelCode()

### Код канала лида

```JavaScript
lead.getChannelCode()
```

##### Описание:

Возвращает код канала лида <span style="font-weight: 400;">(telegram, umnico, bitrix, и пр.)</span>

##### Возвращает:

**string** - код канала лида в формате строки.

Коды которые может возвращать данная функция:

- 'unknown'
- 'avito'
- 'apple\_business\_chat'
- 'facebook'
- 'instagram'
- 'jivoWidget'
- 'livechatWidget'
- 'odnoklassniki'
- 'skype'
- 'telegram'
- 'twitter'
- 'viber'
- 'vk'
- 'wechat'
- 'whatsapp'
- 'youla'
- 'metabotWidget'
- 'webim'

# lead.setAttr()

### Установить значение переменной лида

```JavaScript
lead.setAttr(string $key, string $value)
```

##### Описание:

<span style="font-weight: 400;">Обновляет значение уже существующей переменной лида или создает новую переменную с указанным значением. Данные будут сохранены в БД.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">value</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Значение переменной</td></tr></tbody></table>

##### Возвращает:

**self** - объект того же типа, в данном случае переменную, которая была создана.

##### Пример:

Создание переменной лида lead\_attribute:

```JavaScript
let lead = "Значение переменной лида";
let lead_attribute = lead.setAttr('lead_attribute', lead);
```

<div class="pointer-container" id="bkmrk-%C2%A0-0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>

# lead.getAttr()

### Получить значение переменной лида

```JavaScript
lead.getAttr(string $key)
```

##### Описание:

<span style="font-weight: 400;">Возвращает значение уже существующей переменной лида.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr></tbody></table>

##### Возвращает:

<span style="font-weight: 300;">**string** - значение запрашиваемой переменной в виде строки</span>

<span style="font-weight: 300;">или</span>

**null** - если переменная не была найдена.

##### Пример:

Получение значения переменной лида lead\_attribute:

```JavaScript
let lead_attribute_value = lead.getAttr('lead_attribute');
```

<div class="pointer-container" id="bkmrk-%C2%A0-1"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>

# lead.getAllAttr()

### Получить все переменные лида

```JavaScript
lead.getAllAttr()
```

##### Описание:

<span style="font-weight: 400;">Возвращает значение всех переменных лида.</span>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**array** - массив значений всех переменных.

##### Пример:

Получение значения всех переменных лида и вынесение из массива одного из значений:

```JavaScript
let all_lead_attributes = lead.getAllAttr();
let lead_attribute = all_lead_attributes[3];
```

<div class="pointer-container" id="bkmrk-%C2%A0-2"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>

# lead.issetAttr() и lead.isAttrExist()

### Проверить наличие переменной лида

```JavaScript
lead.issetAttr(string $key)
```

или

```JavaScript
lead.isAttrExist(string $key)
```

##### Описание:

Проверяет существует ли переменная лида в боте.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-1" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование переменной</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**bool** - подтверждение существования переменной.

##### Пример:

Проверка двумя способами существования переменной лида lead\_attribute:

```JavaScript
let lead_exists = lead.issetAttr('lead_attribute');
let lead_altexists = lead.isAttrExist('lead_attribute');
```

# lead.deleteAttrs() и lead.deleteAttr()

### Удаление переменных лида

```JavaScript
lead.deleteAttrs(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

или

```JavaScript
lead.deleteAttr(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет переменную из бота.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">attrs</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 96.766px;"><td style="width: 33.3745%; height: 96.766px;">isForceDelete </td><td style="width: 33.3745%; height: 96.766px;">bool </td><td style="width: 33.3745%; height: 96.766px;">Подавить запуск триггеров или нет, т.е. если передать true,   
и есть триггер подписанный на событие изменения/удаления переменной то он не будет запущен.</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то переменная будет удалена из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления переменной.

##### Пример:

```JavaScript
lead.deleteAttrs('var1, var2, var3', null, null, true);
```

# lead.forceDeleteAttrs() и lead.forceDeleteAttr()

### Принудительное удаление переменных лида из БД

```JavaScript
lead.forceDeleteJsonAttrs(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

или

```JavaScript
lead.forceDeleteJsonAttr(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет переменную из бота и БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att-0" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">attrs</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то переменная будет удалена из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления переменной.

##### Пример:

```JavaScript
lead.forceDeleteAttrs('var1, var2, var3');
```

# lead.deleteJsonAttrs() и lead.deleteJsonAttr()

### Удаление json-переменных лида

```JavaScript
lead.deleteJsonAttrs(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

или

```JavaScript
lead.deleteJsonAttr(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет json переменную из бота.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att-1" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">attrs</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 96.766px;"><td style="width: 33.3745%; height: 96.766px;">isForceDelete </td><td style="width: 33.3745%; height: 96.766px;">bool </td><td style="width: 33.3745%; height: 96.766px;">Подавить запуск триггеров или нет, т.е. если передать true,   
и есть триггер подписанный на событие изменения/удаления переменной то он не будет запущен.</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то переменная будет удалена из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления переменной.

##### Пример:

```JavaScript
lead.deleteJsonAttrs('json_var1, json_var2, json_var3', null, null, true);
```

# lead.forceDeleteJsonAttrs() и lead.forceDeleteJsonAttr()

### Принудительное удаление json-переменных лида из БД

```JavaScript
lead.forceDeleteJsonAttrs(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

или

```JavaScript
lead.forceDeleteJsonAttr(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет json переменную из бота и БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att-2" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">attrs</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления переменной</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то переменная будет удалена из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления переменной.

##### Пример:

```JavaScript
lead.forceDeleteJsonAttrs('json_var1, json_var2, json_var3');
```

# lead.isInStatus()

### Проверка существования статуса у лида

```JavaScript
lead.isInStatus(string $statusName)
```

##### Описание:

<span style="font-weight: 400;">Проверить, что лид находится в статусе с указанным в методе именем</span>.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">statusName</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование статуса</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение существования статуса.

# lead.getStatusId()

### Узнать id статуса лида

```JavaScript
lead.getStatusId()
```

##### Описание:

<span style="font-weight: 400;">Возвращает значение поля status\_id лида.</span>

##### Возвращает:

**int** — id статуса лида в форме числа

или

**null** — если у лида нет статуса.

# lead.isTagExist() и lead.issetTag()

### Проверить наличие тэга лида

```JavaScript
lead.isTagExist($some_tag)
```

или

```JavaScript
lead.issetTag($some_tag)
```

##### Описание:

Проверяет существование тега у лида.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">some\_tag</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование тэга</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение существования тега.

##### Пример:

```JavaScript
let TagExist = lead.isTagExist('тэг');
```

или

```JavaScript
let TagExist = lead.issetTag('тэг');
```

# lead.getTag()

### Получить значение тэга лида

```JavaScript
lead.getTag(string $key)
```

##### Описание:

Возвращает значение тэга лида по наименованию.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование тэга</td></tr></tbody></table>

##### Возвращает:

**string** - если тэг активен

или

**null** - если тэг неактивен.

##### Пример:

```JavaScript
let Tag = lead.getTag('тэг');
```

# lead.getAllTags()

### Получить массив всех тэгов лида

```JavaScript
lead.getAllTags()
```

##### Описание:

Возвращает массив всех тэгов лида.

##### Возвращает:

**array** - массив наименований тэгов лида.

##### Пример:

```JavaScript
let AllTags = lead.getAllTags();
let Tag2 = AllTags[1];
```

# lead.addTags() и lead.addTag()

### Добавление тэгов лида

```
lead.addTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

или

```
lead.addTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

##### Описание:

Добавляет тэг в бот.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">tags</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий тэгов(разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - наименование созданного тэга.

##### Пример:

```JavaScript
lead.addTags('new_tag', null, {"some_key": "some_value"});
```

# lead.deleteTags() и lead.deleteTag()

### Удаление тэгов лида

```
lead.deleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

или

```
lead.deleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет тэг из бота.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tag" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">tags</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий тэгов (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга</td></tr><tr style="height: 96.766px;"><td style="width: 33.3745%; height: 96.766px;">isForceDelete </td><td style="width: 33.3745%; height: 96.766px;">bool </td><td style="width: 33.3745%; height: 96.766px;">Подавить запуск триггеров или нет, т.е. если передать true,   
и есть триггер подписанный на событие изменения/удаления тэга то он не будет запущен.</td></tr><tr style="height: 96.9844px;"><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления тэга.

##### Пример:

```JavaScript
lead.deleteTags('TAG_111, tag_222 , tag_333', null, null, true);
```

# lead.forceDeleteTags() и lead.forceDeleteTag()

### Принудительное удаление тэгов лидаиз БД

```JavaScript
lead.forceDeleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

или

```JavaScript
lead.forceDeleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)
```

##### Описание:

Удаляет тэг из бота и БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-att-0" style="border-collapse: collapse; width: 100%; height: 447.313px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">attrs</td><td style="width: 33.3745%; height: 80.1875px;">string|object|array|null</td><td style="width: 33.3745%; height: 80.1875px;">Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив</td></tr><tr style="height: 63.3906px;"><td style="width: 33.3745%; height: 63.3906px;">ticketId </td><td style="width: 33.3745%; height: 63.3906px;">?int</td><td style="width: 33.3745%; height: 63.3906px;">Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга</td></tr><tr style="height: 80.1875px;"><td style="width: 33.3745%; height: 80.1875px;">scriptRequestParams </td><td style="width: 33.3745%; height: 80.1875px;">object</td><td style="width: 33.3745%; height: 80.1875px;">Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга</td></tr><tr><td style="width: 33.3745%; height: 96.9844px;">isSuppressTriggers </td><td style="width: 33.3745%; height: 96.9844px;">bool </td><td style="width: 33.3745%; height: 96.9844px;">Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается</td></tr></tbody></table>

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**self** - подтверждение удаления тэга.

##### Пример:

```JavaScript
lead.forceDeleteTags('TAG_111, tag_222 , tag_333');
```

# lead.setForwarded()

### Переключить на оператора

```JavaScript
lead.setForwarded(bool|int $state)
```

##### Описание:

<span style="font-weight: 400;">Установка ($state == true) или сброс ($state == false) у лида признака “Переведён на оператора”.</span>

##### <span style="font-weight: 400;">Атрибуты:</span>

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 31.644%; height: 29.7969px;">Имя</td><td style="width: 30.0536%; height: 29.7969px;">Тип</td><td style="width: 38.3024%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 31.644%; height: 29.7969px;"><span style="font-weight: 400;">state </span></td><td style="width: 30.0536%; height: 29.7969px;">bool|int</td><td style="width: 38.3024%; height: 29.7969px;"><span style="font-weight: 400;">При $state = true установка и при $state = false сброс признака “Переведён на оператора”</span></td></tr></tbody></table>

##### Возвращает:

**self** - подтверждение установки или сброса в формате используемом при вызове метода.

# lead.getPersonId()

### Получить id персоны


```JavaScript
lead.getPersonId()
```

##### Описание:

Возвращает id персоны лида.

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**int** - id персоны в формате числа.

##### Пример:

```JavaScript
let PersonId = lead.getPersonId();
lead.setAttr('PersonId', PersonId);
```

# lead.setPersonId()

### Привязать персону к лиду


```JavaScript
lead.setPersonId(?int $personId)
```

##### Описание:

Привязывает к лиду персону с соответствующим id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-1" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">personId

</td><td style="width: 33.2909%; height: 35.3906px;">int</td><td style="width: 33.2948%; height: 35.3906px;">Id персоны</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение успешной привязки персоны к лиду.

##### Пример:

```JavaScript
lead.setPersonId(167435);
```

# lead.createPersonForCurrentLead()

### Создать персону для лида


```JavaScript
lead.createPersonForCurrentLead($data)
```

##### Описание:

Создает персону для текущего лида в контексте которого запущен v8-скрипт.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-dat" style="border-collapse: collapse; width: 100%; height: 452.078px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3791%; height: 29.7969px;">Имя</td><td style="width: 33.3791%; height: 29.7969px;">Тип</td><td style="width: 33.3791%; height: 29.7969px;">Описание</td></tr><tr style="background-color: #ecf0f1;"><td style="width: 33.3791%;">data

</td><td style="width: 33.3791%;">json</td><td style="width: 33.3791%;">Данные о персоне в формате json. Возможные поля расписаны ниже</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">person\_role\_id

</td><td style="width: 33.3791%; height: 35.3906px;">integer</td><td style="width: 33.3791%; height: 35.3906px;">Id роли</td></tr><tr style="height: 124.953px;"><td style="width: 33.3791%; height: 124.953px;">is\_external

</td><td style="width: 33.3791%; height: 124.953px;">bool</td><td style="width: 33.3791%; height: 124.953px;"><span style="font-weight: 400;">Если не устанавливать по умолчанию будет установлено 1, означающее что персона является клиентом. </span>

<span style="font-weight: 400;">А 0 означает что персона является работником бизнеса</span>

</td></tr><tr style="height: 49.5938px;"><td style="width: 33.3791%; height: 49.5938px;">user\_id

</td><td style="width: 33.3791%; height: 49.5938px;">integer</td><td style="width: 33.3791%; height: 49.5938px;">Id пользователя, привязываемого к персоне</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">firstname

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Имя персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">lastname

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Фамилия персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">middlename

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Отчество персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">email

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Адрес электронной почты персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">phone

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Номер телефона персоны</td></tr><tr><td style="width: 33.3791%; height: 35.4688px;">organization\_name

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Название организации</td></tr><tr><td style="width: 33.3791%; height: 35.4688px;">organization\_address

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Адрес организации</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">comment

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Комментарий к персоне</td></tr></tbody></table>

##### Возвращает:

**int** - id созданной персоны в формате числа.

##### Пример:

```JavaScript
let newPersonId = lead.createPersonForCurrentLead({
  'is_external': 1,
  'firstname': 'Иван',
  'lastname': 'Иванов'
})
```

# lead.isContextExist() и lead.issetContext()

### Проверить наличие контекста лида

```
lead.isContextExist(string $key)
```

или

```
lead.issetContext(string $key)
```

##### Описание:

Проверяет существование контекста у лида.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование контекста</td></tr></tbody></table>

##### Возвращает:

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

##### Пример:

```
let ContextExist = lead.isContextExist('контекст');
```

или

```
let ContextExist = lead.issetContext('контекст');
```

# lead.getContext()

### Получить значение контекста лида

```
lead.getContext(string $key)
```

##### Описание:

Возвращает значение контекста лида по наименованию.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">key</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование контекста</td></tr></tbody></table>

##### Возвращает:

**string** - если контекст активен

или

**null** - если контекст неактивен.

##### Пример:

```
let Context = lead.getContext('контекст');
```

# lead.getAllContexts()

### Получить массив всех контекстов лида

```
lead.getAllContexts()
```

##### Описание:

Возвращает массив всех контекстов лида.

##### Возвращает:

**array** - массив наименований контекстов лида.

##### Пример:

```JavaScript
let AllContexts = lead.getAllContexts();
let Context2 = AllContexts[1];
```

# lead.setActiveNlpIntegrationByCode()

### Присвоить интеграцию лиду по коду

```JavaScript
lead.setActiveNlpIntegrationByCode(?string $integrationCode)
```

##### Описание:

Присваивает интеграцию лиду в соответствии с кодом интеграции.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-int-2" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">integrationCode</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Код интеграции</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение присвоения интеграции.

# lead.canAutoForward()

### Узнать доступно ли авто-назначение оператора в данном скрипте

```
lead.canAutoForward()
```

##### Описание:

Функция необходима для исключения рекурсивного вызова назначения диалога на оператора, а также для исключения выполнения авто-назначения диалога на оператора, если оператор сам подключается к диалога из контакт-центра.

Результат выполнения данной функции аналогичен результату выполнения функции **bot.canAutoForward()**, функция в bot первична, в лиде функция добавлена для удобства.

Если оператор сам выполняет подключение к диалогу из контакт-центра, то результат функции аналогичен проверке:

```JavaScript
return bot.getForwardEventType() !== 'forwarded_by_operator';
```

Но при этом **lead.canAutoForward(): bool** гарантирует что назначение заявки на оператора не вызвано рекурсивно.

##### Возвращает:

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

# lead.getNextOperators()

### Вернуть список следующих операторов

```JavaScript
lead.getNextOperators(string $departmentCode = null, bool $isOnline = true, int|null $limit = 1, bool $useLocks = true)
```

##### Описание:

Возвращает список следующих операторов.

Полученный список будет отсортирован, по:

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>\- Кол-ву диалогов на операторе;  
\- Дате последнего назначения/принятия диалога;  
\- ID оператора.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 89.1204px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">departmentCode </td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Код отдела</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isOnline </td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Должны ли операторы быть онлайн</td></tr><tr><td style="width: 33.2909%;">limit </td><td style="width: 33.2909%;">int|null</td><td style="width: 33.2948%;">Лимит возвращенных операторов. Чтобы получить всех операторов, указываем $limit=null</td></tr><tr><td style="width: 33.2909%;">useLocks </td><td style="width: 33.2909%;">bool </td><td style="width: 33.2948%;">Использовать ли блокировки</td></tr></tbody></table>

##### Возвращает:

**int** - список операторов

или

**null** - если нет операторов.

# lead.assignDialogToNextOperator()

### Назначить диалог на следующего оператора

```JavaScript
lead.assignDialogToNextOperator(string|null $departmentCode = null, bool $isOnline = true, bool $isForwardIfOperatorNotFound = true, bool $useLocks = true)
```

##### Описание:

Назначает диалог на следующего оператора полученного с помощью **getNextOperators**.

Варианты откуда может запускаться:  
\- оператор сам подключился к КЦ и в системном скрипте есть вызов данной функции - игнорируем ее вызов;  
\- функцию вызвали в другом скрипте и она также есть в системном скрипте - игнорируем ее вызов только из системного скрипта;  
\- функцию вызвали в системном скрипте - не игнорируем ее вызов.

Если вызываем функцию из системного скрипта перевода на оператора, то данная функция не выполняет перевод (так как он уже выполнен на момент запуска функции) и также не запускает системный скрипт (так как он уже запущен на момент запуска функции) - для этого есть внутренние механизмы отслеживания, откуда запущена функция, и по сути это исключает рекурсивный запуск функций, для этого и введена новая функция bot / lead.canAutoForward на самом деле выполнять данную проверку canAutoForward смысла нет, так как она выполняется автоматически внутри функций назначения оператора и автоматом отсечет рекурсивный вызов, но где может понадобиться использование canAutoForward - это для написания JavaScript условия - нужно ли отсылать уведомление лиду, о том что скрипт перевод на оператора: пример вызываем назначение на оператора в обычном скрипте, и в этом же скрипте уведомляем о то, что мы перевели на оператора, тогда при запуске системного скрипта Перевод на оператора вывод такого же сообщения нужно исключить.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 139.806px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">departmentCode </td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Код отдела</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isOnline </td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Должны ли операторы быть онлайн</td></tr><tr style="height: 21.1482px;"><td style="width: 33.2909%; height: 21.1482px;">isForwardIfOperatorNotFound</td><td style="width: 33.2909%; height: 21.1482px;">bool</td><td style="width: 33.2948%; height: 21.1482px;">Продолжить если оператор не найден</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">useLocks </td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Использовать ли блокировки</td></tr></tbody></table>

##### Возвращает:

**int** - оператора

или

**null** - если не удалось назначить.

# lead.assignDialogToOperator()

### Назначить диалог на указанного оператора

```JavaScript
lead.assignDialogToOperator(int|null $operatorId, bool $isForwardIfOperatorNotFound = true, bool $useLocks = true)
```

##### Описание:

Назначает диалог на указанного в методе оператора.

 Если вызываем функцию из системного скрипта перевода на оператора, то данная функция не выполняет перевод (так как он уже выполнен на момент запуска функции) и также не запускает системный скрипт (так как он уже запущен на момент запуска функции).

Если вызываем функцию из обычного скрипта, то в данной точке сразу будет вызван системный скрипт (если он есть). Системный скрипт можно не создавать и обрабатывать все в точке вызова (можно через v8 плагина) или в отдельном обычном скрипте. Если в системном скрипте и скрипте в котором вызывает данную функцию есть отправка сообщений то необходимо вызывать **bot.disableBuffer()**, чтобы не нарушать последовательность сообщений. Но лучше отправлять сообщения только в одном из скриптов.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 89.1204px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">operatorId</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">ID оператора</td></tr><tr><td style="width: 33.2909%;">limit </td><td style="width: 33.2909%;">int|null</td><td style="width: 33.2948%;">Лимит возвращенных операторов. Чтобы получить всех операторов, указываем $limit=null</td></tr><tr><td style="width: 33.2909%;">useLocks </td><td style="width: 33.2909%;">bool </td><td style="width: 33.2948%;">Использовать ли блокировки</td></tr></tbody></table>

##### Возвращает:

**int** - оператора

или

**null** - если не удалось назначить оператора.

# lead.getLastRequest()

### Получить объект с параметрами последнего реквеста

```JavaScript
lead.getLastRequest()
```

##### Описание:

Находит последний реквест и возвращает объект с его параметрами.

##### Возвращает:

**ScriptRequest** — последний реквест.

# lead.getMessengerCode()

### Получить буквенное обозначение текущего мессенджера канала

```
lead.getMessengerCode()
```

##### Описание:

Возвращает буквенное обозначение текущего мессенджера канала.

##### Возвращает:

**string** - буквенное обозначение текущего мессенджера канала.

Коды которые может возвращать данная функция:

- 'unknown'
- 'avito'
- 'apple\_business\_chat'
- 'facebook'
- 'instagram'
- 'jivoWidget'
- 'livechatWidget'
- 'odnoklassniki'
- 'skype'
- 'telegram'
- 'twitter'
- 'viber'
- 'vk'
- 'wechat'
- 'whatsapp'
- 'youla'
- 'metabotWidget'
- 'webim'

# lead.getIdentification()

### Получить идентификатор лида во внешней системе

```
lead.getIdentification()
```

##### Описание:

Возвращает идентификатор лида во внешней системе, т.е. в мессенджере, например для Telegram - это id чата клиента.

##### Возвращает:

**string** - идентификатор лида во внешней системе в формате строки

или

**null** - если идентификатор не найден.

# lead.getIdentificationEntity()

### Получить дополнительный идентификатор лида во внешней системе

```
lead.getIdentificationEntity()
```

##### Описание:

Возвращает дополнительный идентификатор лида во внешней системе, например используется для Bitrix24 – и возвращает ‘LEAD’ / ‘DEAL’.

##### Возвращает:

**string** - дополнительный идентификатор лида во внешней системе в формате строки

или

**null** - если нет составного идентификатора лида.

# lead.getMessenger()

### Получить текущий мессенджер

```
lead.getMessenger()
```

##### Описание:

Метод для получения обозначения текущего мессенджера канала.

Коды которые может возвращать данная функция:

- Unknown - 0
- Avito - 1
- Apple business chat - 17
- Facebook - 2
- Instagram - 3
- JivoWidget - 15
- LivechatWidget - 4
- Jdnoklassniki - 16
- Skype - 5
- Telegram - 6
- Twitter - 7
- Viber - 8
- VK - 9
- Wechat - 12
- Whatsapp - 10
- Юла - 11
- MetabotWidget - 13
- Webim - 14

##### Возвращает:

**int** - код канала.

# Методы ticket



# ticket.update()

#### <span style="color: #222222; font-size: 1.666em;">Обновление заявки, через объект заявки</span>

```JavaScript
ticket.update($data)
```

##### Описание:

<span style="font-weight: 400;">Обновляет заявку соответствующую указанным данным.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="background-color: #ecf0f1;"><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">data</span></td><td style="width: 33.3745%; height: 29.7969px;">json</td><td style="width: 33.3745%; height: 29.7969px;">Данные о заявке в формате json. Возможные поля расписаны ниже</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">title</span></td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Заголовок заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">ticket\_type\_id</span></td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">Id типа заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">status\_id</span></td><td style="width: 33.3745%; height: 29.7969px;">int</td><td style="width: 33.3745%; height: 29.7969px;">Id статуса заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">author\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id автора заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">client\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id клиента заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">assigned\_person\_id</span>

</td><td style="width: 33.3745%; height: 35.3906px;">int</td><td style="width: 33.3745%; height: 35.3906px;">Id исполнителя заявки</td></tr><tr><td style="width: 33.3745%; height: 35.3906px;"><span style="font-weight: 400;">description</span>

</td><td style="width: 33.3745%; height: 35.3906px;">string</td><td style="width: 33.3745%; height: 35.3906px;">Описание заявки</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение обновления заявки.

##### Пример:

```JavaScript
let ticketData = {
  'title': 'Создано в боте',
  'ticket_type_id': 1013,
  'status_id': 1096
};

ticketData.custom = {
  'client_contacts': 'my contacts',
  'details': 'some details'
};

let isUpdated = ticket.update(ticketData);

lead.setAttr('is_ticket_updated', isUpdated);
```

Пример обновления одного поля заявки:

```JavaScript
let ticket = bot.findTickets([['id', ticketId]])[0];
let ticketData = {
  'client_comment': lead.getAttr('Отзыв')
};

ticket.update(ticketData);
```

# ticket.getData()

#### <span style="color: #222222; font-size: 1.666em;">Получить значение данных заявки</span>  


```JavaScript
ticket.getData(string $key)
```

##### Описание:

<span style="font-weight: 400;">Получить значение данных заявки по ключу или названию поля БД.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">key</td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

##### Возвращает:

**mixed** - если значение найдено

или

**null** - если значение не найдено.

##### Пример:

```JavaScript
let Data = ticket.getData('title');
```

# ticket.getCustomData()

### Считывание произвольных полей заявки


```JavaScript
ticket.getCustomData(string $key)
```

##### Описание:

Находит значение указанного типа произвольного поля заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%;">key</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**названия всех произвольных полей заявки**;</span>
- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

<p class="callout warning">Можно получить код значения, используя суффикс **".raw"** к имени произвольного поля. Т.е. если в заявке установлено из опций поля с именем age второе значение:  
({  
"1": "18-25 лет",  
"2": "25-30 лет",  
"3": "30-35 лет",  
"4": "35-40 лет",  
"5": "Больше 40 лет",  
"6": "Не важно"   
})  
то **ticket.getCustomData('age')** вернёт "25-30 лет", **ticket.getCustomData('age.raw')** вернёт "2". </p>

##### Возвращает:

**mixed** - если значение найдено

или

**null** - если значение не найдено.

##### Пример:

```JavaScript
let tickets = bot.findTickets();

for (let i = 0; i < tickets.length; i++) {
  lead.setAttr('tickets_' + i + '_tickets_title', tickets[i].getData('title'));
  lead.setAttr('tickets_' + i + '_client_contacts', tickets[i].getCustomData('client_contacts'));
  lead.setAttr('tickets_' + i + '_details', tickets[i].getCustomData('details'));
  lead.setAttr('tickets_' + i + '_статус_имя', tickets[i].getCustomData('статус.имя'));
}

lead.setAttr('found_tickets_count', tickets.length);
```

# ticket.issetData() и ticket.isDataExist()

#### <span style="color: #222222; font-size: 1.666em;">Проверить наличие данных по заявке</span>  


```JavaScript
ticket.issetData(string $key)
```

или

```JavaScript
ticket.isDataExist(string $key)
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-2" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%;">key</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

##### Возвращает:

**bool** - подтверждение существования данных.

##### Пример:

```JavaScript
let Data = ticket.issetData('title');
```

или

```JavaScript
let Data = ticket.isDataExist('title');
```

# ticket.reloadCustomData()

### Перезагрузка кастомных данных


```JavaScript
ticket.reloadCustomData(bool $isReloadModel = false)
```

##### Описание:

Перезагружает кастомные поля заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-isr" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">isReloadModel</td><td style="width: 33.2909%; height: 29.7969px;">bool</td><td style="width: 33.2948%; height: 29.7969px;">Перезагружает и системные поля заявки, вызывая ticket.reloadTicket()</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение успешной перезагрузки.

# ticket.setAllCustomData()

### Переопределить список кастомных полей


```JavaScript
ticket.setAllCustomData(array $customData)
```

##### Описание:

Не переносится в БД. Будет переопределен массив кастомных полей в памяти, используется для внутренних целей задания значений полей.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-cus" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">customData</td><td style="width: 33.2909%; height: 29.7969px;">array</td><td style="width: 33.2948%; height: 29.7969px;">Массив кастомных полей</td></tr></tbody></table>

##### Возвращает:

**self** - тип указанный при вызове метода.

##### Пример:

```JavaScript
ticket.setAllCustomData([{
"место": "Место 01",
"время": "12:30"
}]);
```

# ticket.getAllCustomData()

### Получить список кастомных полей


```JavaScript
ticket.getAllCustomData()
```

##### Описание:

Возвращает значения всех кастомных полей.

##### Возвращает:

**array** - массив значений кастмных полей.

# ticket.setCustomData()

### Установить значение кастомного поля


```JavaScript
ticket.setCustomData(string $key, $value)
```

##### Описание:

Устанавливает значение кастомного поля. Не сохраняется в БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-3" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Ключ наименование поля</td></tr><tr><td style="width: 33.3745%;">value</td><td style="width: 33.3745%;">self</td><td style="width: 33.3745%;">Значение поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**названия всех произвольных полей заявки**;</span>
- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

##### Возвращает:

**self** - тип указанный при вызове метода.

##### Пример:

```JavaScript
ticket.setCustomData("место", "Место1");
```

# ticket.issetCustomData()

### <span style="font-weight: 400;">И</span>меет ли значение кастомное поле


```JavaScript
ticket.issetCustomData(string $key)
```

##### Описание:

Проверяет существует ли ключ и не имеет ли он значение null.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-4" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**названия всех произвольных полей заявки**;</span>
- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

##### Возвращает:

**bool** - подтверждение существования ключа.

##### Пример:

```JavaScript
ticket.issetCustomData("время");
```

# ticket.isCustomDataExist()

### Существует ли кастомное поле




```JavaScript
ticket.isCustomDataExist(string $key)
```

##### Описание:

Проверяет существует ли такой ключ в списке кастомных полей.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-5" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">key</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**названия всех произвольных полей заявки**;</span>
- <span style="font-weight: 400;">**id** - id заявки;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**author\_person\_id** - id автора заявки;</span>
- <span style="font-weight: 400;">**client\_person\_id** - id клиента заявки;</span>
- <span style="font-weight: 400;">**assigned\_person\_id** - id исполнителя заявки;</span>
- <span style="font-weight: 400;">**ticket\_type\_id** - id вида заявки, виды заявки создаются вручную;</span>
- <span style="font-weight: 400;">**payment\_type\_id** - id способа оплаты. Доступные значения:</span>
    - <span style="font-weight: 400;">0 - PAYMENT\_TYPE\_NONE;</span>
    - <span style="font-weight: 400;">**1** - PAYMENT\_TYPE\_ROBOKASSA;</span>
    - <span style="font-weight: 400;">**2** - PAYMENT\_TYPE\_YANDEXKASSA;</span>
    - <span style="font-weight: 400;">**3** - PAYMENT\_TYPE\_CASH;</span>
- <span style="font-weight: 400;">**status\_id** - id статуса заявки;</span>
- <span style="font-weight: 400;">**title** - заголовок заявки;</span>
- <span style="font-weight: 400;">**description** - описание заявки;</span>
- <span style="font-weight: 400;">**created\_at** - время создания заявки;</span>
- <span style="font-weight: 400;">**updated\_at** - время обновления заявки;</span>
- <span style="font-weight: 400;">**deleted\_at** - время удаления заявки;</span>
- <span style="font-weight: 400;">все системные поля заявки (по английски).</span>

##### Возвращает:

**bool** - подтверждение существования ключа.

##### Пример:

```JavaScript
ticket.isCustomDataExist("место");
```

# ticket.getTicketTypeName()

#### <span style="color: #222222; font-size: 1.666em;">Получить название типа заявки</span>

```
ticket.getTicketTypeName()
```

##### Описание:

Находит название типа заявки.

##### Возвращает:

**string** — название типа заявки

или

**null** — если у заявки нет типа.

# ticket.getStatusId() и ticket.getAttr('status_id')

#### <span style="color: #222222; font-size: 1.666em;">Получить ID статуса заявки</span>  


```JavaScript
ticket.getStatusId()
```

или

```
ticket.getAttr('status_id')
```

##### Описание:

Находит id статуса заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta-0" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">status\_id</td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Ключ id статуса заявки</td></tr></tbody></table>

##### Возвращает:

**int** — id статуса заявки

или

**null** — если у заявки нет статуса.

# ticket.getStatusName()

#### <span style="color: #222222; font-size: 1.666em;">Получить название статуса заявки</span>

```
ticket.getStatusName()
```

##### Описание:

Находит название статуса заявки.

##### Возвращает:

**string** — название статуса заявки

или

**null** — если у заявки нет статуса.

# ticket.getStatusType()

#### <span style="color: #222222; font-size: 1.666em;">Получить тип статуса заявки</span>  


```JavaScript
ticket.getStatusType()
```

##### Описание:

Находит тип статуса заявки.

##### Возвращает:

**string** — тип статуса заявки

или

**null** — если у заявки нет статуса или у статуса нет типа.

# ticket._sanitizeString()

#### <span style="color: #222222; font-size: 1.666em;">Приведение названия статуса к стандартному виду</span>  


```JavaScript
ticket._sanitizeString($string)
```

##### Описание:

<span style="font-weight: 400;">Вспомогательная функция используемая для приведения названия статуса к нижнему регистру и удаления лишних символов из названия.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">statusNme</td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование статуса заявки</td></tr></tbody></table>

##### Возвращает:

**string** - обновленное наименование статуса заявки.

<p class="callout warning"><span style="font-weight: 400;">В v8 скриптах не используется.</span></p>

# ticket.isInStatus()

### Проверить статус заявки

```JavaScript
ticket.isInStatus($statusName)
```

##### Описание:

<span style="font-weight: 400;">Проверить, что заявка находится в статусе с именем $statusName.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta-2" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;"><span style="font-weight: 400;">statusName</span></td><td style="width: 33.2909%; height: 29.7969px;">string</td><td style="width: 33.2948%; height: 29.7969px;">Наименование статуса заявки</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение, <span style="font-weight: 400;">что заявка находится в указанном статусе.</span>

# ticket.setStatusId()

#### <span style="color: #222222; font-size: 1.666em;">Установить статус заявки по id</span>  


```JavaScript
ticket.setStatusId(int|null $statusId, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null)
```

##### Описание:

Устанавливает указанный статус для заявки по id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta-3" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%;">statusId</td><td style="width: 33.3745%;">int|null</td><td style="width: 33.3745%;">id статуса заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueIdForLog</td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди записываемый в лог</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTableForLog </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей записываемое в лог</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение установки нового статуса<span style="font-weight: 400;">.</span>

# ticket.setStatusByName()

#### <span style="color: #222222; font-size: 1.666em;">Установить статус заявки по имени</span>  


```JavaScript
ticket.setStatusByName(string $statusName, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null)
```

##### Описание:

Устанавливает указанный статус для заявки по имени.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-sta-4" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">statusName</span></td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Наименование статуса заявки</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueIdForLog</td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди записываемый в лог</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTableForLog </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей записываемое в лог</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение установки нового статуса<span style="font-weight: 400;">.</span>

# ticket.reloadTicket()

#### <span style="color: #222222; font-size: 1.666em;">Загрузить заявку повторно</span>  


```JavaScript
ticket.reloadTicket()
```

##### Описание:

<span style="font-weight: 400;">Загрузить заявку повторно из БД. </span><span style="font-weight: 400;">Автоматически выполняется, например, в случае изменения статуса заявки, назначении другого исполнителя и т.п.</span>

##### Возвращает:

**bool** — подтверждение повторной загрузки заявки<span style="font-weight: 400;">.</span>

# ticket.getAuthorPersonId()

#### <span style="color: #222222; font-size: 1.666em;">Получить ID автора заявки</span>  


```JavaScript
ticket.getAuthorPersonId()
```

##### Описание:

Возвращает id автора заявки.

##### Возвращает:

**int** — id автора заявки в формате числа

или

**null** — если автор не найден.

# ticket.getAssignedPersonId()

#### <span style="color: #222222; font-size: 1.666em;">Получить ID исполнителя заявки</span>  


```JavaScript
ticket.getAssignedPersonId()
```

##### Описание:

Возвращает id исполнителя заявки.

##### Возвращает:

**int** — id исполнителя заявки в формате числа

или

**null** — если исполнитель не найден.

# ticket.getClientPersonId()

#### <span style="color: #222222; font-size: 1.666em;">Получить ID клиента заявки</span>  


```JavaScript
ticket.getClientPersonId()
```

##### Описание:

Возвращает id клиента заявки.

##### Возвращает:

**int** — id клиента заявки в формате числа

или

**null** — если клиент не найден.

# ticket.getAuthorPersonFullName()

#### <span style="color: #222222; font-size: 1.666em;">Получить ФИО автора заявки</span>  


```JavaScript
ticket.getAuthorPersonFullName()
```

##### Описание:

Возвращает ФИО автора заявки.

##### Возвращает:

**string** — ФИО автора заявки.

# ticket.getAssignedPersonFullName()

### Получить ФИО исполнителя заявки

```JavaScript
ticket.getAssignedPersonFullName()
```

##### Описание:

Возвращает ФИО исполнителя заявки.

##### Возвращает:

**string** — ФИО исполнителя заявки.

# ticket.getClientPersonFullName()

### Получить ФИО клиента заявки

```JavaScript
ticket.getClientPersonFullName()
```

##### Описание:

Возвращает ФИО клиента заявки.

##### Возвращает:

**string** — ФИО клиента заявки.

# ticket.getAuthorPersonRoleId()

### Получить ID роли автора заявки

```JavaScript
ticket.getAuthorPersonRoleId()
```

##### Описание:

Возвращает ID роли автора заявки.

##### Возвращает:

**int** — ID роли автора заявки

или

**null** — если клиент или роль не найдены.

# ticket.getAssignedPersonRoleId()

#### <span style="color: #222222; font-size: 1.666em;">Получить ID роли исполнителя заявки</span>  


```JavaScript
ticket.getAssignedPersonRoleId()
```

##### Описание:

Возвращает ID роли исполнителя заявки.

##### Возвращает:

**int** — ID роли исполнителя заявки

или

**null** — если клиент или роль не найдены.

# ticket.getClientPersonRoleId()

### Получить ID роли клиента заявки

```JavaScript
ticket.getClientPersonRoleId()
```

##### Описание:

Возвращает ID роли клиента заявки.

##### Возвращает:

**int** — ID роли клиента заявки

или

**null** — если клиент или роль не найдены.

# ticket.getAuthorPersonRoleName()

### Получить имя роли автора заявки

```JavaScript
ticket.getAuthorPersonRoleName()
```

##### Описание:

Возвращает имя роли автора заявки.

##### Возвращает:

**string** — имя роли автора заявки.

# ticket.getAssignedPersonRoleName()

#### <span style="color: #222222; font-size: 1.666em;">Получить имя роли исполнителя заявки</span>  


```JavaScript
ticket.getAssignedPersonRoleName()
```

##### Описание:

Возвращает имя роли исполнителя заявки.

##### Возвращает:

**string** — имя роли исполнителя заявки.

# ticket.getClientPersonRoleName()

### Получить имя роли клиента заявки

```JavaScript
ticket.getClientPersonRoleName()
```

##### Описание:

Возвращает имя роли клиента заявки.

##### Возвращает:

**string** — имя роли клиента заявки.

# ticket.getAuthorPersonRoleTitle()

### Получить заголовок роли автора заявки

```JavaScript
ticket.getAuthorPersonRoleTitle()
```

##### Описание:

Возвращает заголовок роли автора заявки.

##### Возвращает:

**string** — заголовок роли автора заявки.

# ticket.getAssignedPersonRoleTitle()

#### <span style="color: #222222; font-size: 1.666em;">Получить заголовок роли исполнителя заявки</span>  


```JavaScript
ticket.getAssignedPersonRoleTitle()
```

##### Описание:

Возвращает заголовок роли исполнителя заявки.

##### Возвращает:

**string** — заголовок роли исполнителя заявки.

# ticket.getClientPersonRoleTitle()

### Получить заголовок роли клиента заявки

```JavaScript
ticket.getClientPersonRoleTitle()
```

##### Описание:

Возвращает заголовок роли клиента заявки.

##### Возвращает:

**string** — заголовок роли клиента заявки.

# ticket.getAuthorPersonRoleFormattedTitle()

### Получить форматированное название роли автора заявки

```JavaScript
ticket.getAuthorPersonRoleFormattedTitle()
```

##### Описание:

Возвращает форматированное название роли автора заявки.

##### Возвращает:

**string** — форматированное название роли автора заявки.

# ticket.getAssignedPersonRoleFormattedTitle()

### Получить форматированное название роли исполнителя заявки

```JavaScript
ticket.getAssignedPersonRoleFormattedTitle()
```

##### Описание:

Возвращает форматированное название роли исполнителя заявки.

##### Возвращает:

**string** — форматированное название роли исполнителя заявки.

# ticket.getClientPersonRoleFormattedTitle()

### Получить форматированное название роли клиента заявки

```JavaScript
ticket.getClientPersonRoleFormattedTitle()
```

##### Описание:

Возвращает форматированное название роли клиента заявки.

##### Возвращает:

**string** — форматированное название роли клиента заявки.

# ticket.getPerson1Id()

### Получение id первой дополнительной персоны


```JavaScript
ticket.getPerson1Id()
```

##### Описание:

Возвращает id первой дополнительной персоны заявки.

##### Возвращает:

**int** — id персоны в формате числа

или

**null** — если персона не найдена.

# ticket.getPerson2Id()

### Получение id второй дополнительной персоны


```JavaScript
ticket.getPerson2Id()
```

##### Описание:

Возвращает id второй дополнительной персоны заявки.

##### Возвращает:

**int** — id персоны в формате числа

или

**null** — если персона не найдена.

# ticket.getPerson3Id()

### Получение id третьей дополнительной персоны


```JavaScript
ticket.getPerson3Id()
```

##### Описание:

Возвращает id третьей дополнительной персоны заявки.

##### Возвращает:

**int** — id персоны в формате числа

или

**null** — если персона не найдена.

# ticket.setPerson1Id()

### Установка id первой дополнительной персоны


```JavaScript
ticket.setPerson1Id(int|null $personId)
```

##### Описание:

Устанавливает id первой дополнительной персоны заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-0" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">personId</td><td style="width: 33.2909%;">int|null</td><td style="width: 33.2948%;">ID персоны</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение установки значения.

# ticket.setPerson2Id()

### Установка id второй дополнительной персоны


```JavaScript
ticket.setPerson2Id(int|null $personId)
```

##### Описание:

Устанавливает id второй дополнительной персоны заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-1" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">personId</td><td style="width: 33.2909%;">int|null</td><td style="width: 33.2948%;">ID персоны</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение установки значения.

# ticket.setPerson3Id()

### Установка id третьей дополнительной персоны


```JavaScript
ticket.setPerson3Id(int|null $personId)
```

##### Описание:

Устанавливает id третьей дополнительной персоны заявки.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-2" style="border-collapse: collapse; width: 100%; height: 59.3287px;"><tbody><tr style="background-color: #ced4d9; height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">personId</td><td style="width: 33.2909%; height: 29.537px;">int|null</td><td style="width: 33.2948%; height: 29.537px;">ID персоны</td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение установки значения.

# ticket.assignToNextQueuePerson()

#### <span style="color: #222222; font-size: 1.666em;">Назначить заявку следующему исполнителю</span>  


```JavaScript
ticket.assignToNextQueuePerson(int $queueMode = 1, int|null $personQueueId = null, string|null $personQueueTable = null, int|null $currentAssignAttempt = null, bool $isIncRejectsCount = true, bool $isMoveToEndIfRejectsExceed = true)
```

##### Описание:

<span style="font-weight: 400;">Назначить заявку следующему исполнителю. Исполнитель будет определен, как первый в очереди распределения по типу заявки.</span>

<span style="font-weight: 400;">Логика работы функции:</span>

1. <span style="font-weight: 400;">Ищет первую персону из очереди распределения, которой еще не назначали тикет (заявку).</span>
2. <span style="font-weight: 400;">Если персоны нет, то возвращаем false (чтобы остановить триггер распределения очереди).</span>
3. <span style="font-weight: 400;">Увеличивает счетчик отказов у найденной персоны.</span>
4. <span style="font-weight: 400;">Увеличивается счетчик отказов по найденному исполнителю.</span>
5. <span style="font-weight: 400;">Если кол-во отказов &gt;= $maxRejects, то исполнитель переносится в конец очереди </span><span style="font-weight: 400;">(исполнитель текущий, которого нашли, а не первый в очереди).</span>
6. <span style="font-weight: 400;">Назначает заявку найденной персоне.</span>

<span style="font-weight: 400;">Поиск исполнителя выполняется по следующим критериям:</span>

- <span style="font-weight: 400;">Исполнитель есть в очереди по типу заявки;</span>
- <span style="font-weight: 400;">Исполнитель активен в очереди распределения (включена соответствующая галка);</span>
- <span style="font-weight: 400;">Исполнителю еще не назначалась данная заявка.</span>

<p class="callout warning"><span style="font-weight: 400;">Условие (количество отказов по исполнителю rejects\_count &lt; $maxRejects+1) НЕ НУЖНО, т.к.:   
</span><span style="font-weight: 400;">1. Как только лимит превышен персона сразу будет перемещена в конец очереди, а счетчик сброшен.  
</span><span style="font-weight: 400;">2. Может возникнуть баг, если лимит превышен, персона никогда не попадет в выборку и ее счетчик не будет сброшен.</span></p>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-isi" style="border-collapse: collapse; width: 100%; height: 432.5px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 169.734px;"><td style="width: 33.2909%; height: 169.734px;">queueMode </td><td style="width: 33.2909%; height: 169.734px;">int</td><td style="width: 33.2948%; height: 169.734px;">Режим работы очереди.

Для работы с очередью на основе видов заявок указывать не нужно, будет использовано значение по умолчанию **1**;  
Для работы с очередью на основе видов очередей указать **2.**

</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">personQueueId </td><td style="width: 33.2909%; height: 29.7969px;">int|null</td><td style="width: 33.2948%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">personQueueTable </td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">currentAssignAttempt </td><td style="width: 33.2909%; height: 29.7969px;">int|null</td><td style="width: 33.2948%; height: 29.7969px;"><span style="font-weight: 400;">Номер попытки прогона одного и того же тикета по той же очереди</span>

</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2909%; height: 46.5938px;">isIncRejectsCount</td><td style="width: 33.2909%; height: 46.5938px;">bool</td><td style="width: 33.2948%; height: 46.5938px;"><span style="font-weight: 400;">Увеличивать или нет счетчик попыток у персоны (в очереди исполнителей)</span></td></tr><tr style="height: 96.9844px;"><td style="width: 33.2909%; height: 96.9844px;">isMoveToEndIfRejectsExceed</td><td style="width: 33.2909%; height: 96.9844px;">bool</td><td style="width: 33.2948%; height: 96.9844px;"><span style="font-weight: 400;">Переносить или нет персону в конец очереди и сбрасывать счетчик попыток, если кол-во попыток превышено (превышает число указанное в настройках бота)</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение назначения заявки следующему исполнителю<span style="font-weight: 400;">.</span>

# ticket.moveAssignedPersonToEndOfQueue()

#### <span style="color: #222222; font-size: 1.666em;">Перенести исполнителя в конец очереди</span>  


```JavaScript
ticket.moveAssignedPersonToEndOfQueue(int $queueMode = 1, int|null $personQueueId = null, string|null $personQueueTable = null, bool $isResetRejectsCount = true)
```

##### Описание:

<span style="font-weight: 400;">Используется для скрипта "Приема заявки" в боте, чтобы переместить исполнителя в конец очереди, после того как он принял заявку.</span>

<span style="font-weight: 400;">Переносит персону, которой в данный момент назначен тикет, в конец очереди, при этом исполнитель заявки не меняется.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-isr-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 169.734px;">queueMode </td><td style="width: 33.3745%; height: 169.734px;">int</td><td style="width: 33.3745%; height: 169.734px;">Режим работы очереди.

Для работы с очередью на основе видов заявок указывать не нужно, будет использовано значение по умолчанию **1**;  
Для работы с очередью на основе видов очередей указать **2.**

</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueId </td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTable </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">isResetRejectsCount</td><td style="width: 33.3745%; height: 29.7969px;">bool</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Обновить или нет счетчик попыток у персоны (в очереди исполнителей)</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение переноса исполнителя<span style="font-weight: 400;">.</span>

# ticket.assignToPersonById()

#### <span style="color: #222222; font-size: 1.666em;">Назначить исполнителя заявки</span>  


```JavaScript
ticket.assignToPersonById(int|null $personId, int|null $personQueueIdForLog = null, string|null $personQueueTableForLog = null, int|null $assignAttemptForLog = null)
```

##### Описание:

Назначает указанного исполнителя для заявки. <span style="font-weight: 400;">Для сброса персоны необходимо указать null в аргументах функции.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%;">personId</td><td style="width: 33.3745%;">int|null</td><td style="width: 33.3745%;">id персоны-исполнителя</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueIdForLog</td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди записываемый в лог</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTableForLog </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей записываемое в лог</span></td></tr><tr><td style="width: 33.3745%;">assignAttemptForLog </td><td style="width: 33.3745%;">int|null</td><td style="width: 33.3745%;"><span style="font-weight: 400;">Номер попытки прогона одного и того же тикета по той же очереди записываемый в лог</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение назначения исполнителя.

# ticket.getAssignedPersonRejectsCount()

#### <span style="color: #222222; font-size: 1.666em;">Получить количество отказов от заявок</span>  


```JavaScript
ticket.getAssignedPersonRejectsCount(int|null $personQueueId = null, string|null $personQueueTable = null): ?int
```

##### Описание:

Возвращает количество отказов от заявок <span style="font-weight: 400;">для текущего исполнителя</span>.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueId </td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTable </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr></tbody></table>

##### Возвращает:

**int** — количество отказов от заявок в формате числа.

# ticket.setAssignedPersonRejectsCount()

#### <span style="color: #222222; font-size: 1.666em;">Установить количество отказов от заявок</span>  


```JavaScript
ticket.setAssignedPersonRejectsCount(int $rejectsCount, int|null $personQueueId = null, string|null $personQueueTable = null)
```

##### Описание:

<span style="font-weight: 400;">Установить количество отказов от заявок для текущего исполнителя.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-rej" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%;">rejectsCount</td><td style="width: 33.3745%;">int</td><td style="width: 33.3745%;">Количество отказов</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueId </td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTable </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr></tbody></table>

##### Возвращает:

**bool** — подтверждение успешной установки отказов.

# ticket.incAssignedPersonRejectsCount()

#### <span style="color: #222222; font-size: 1.666em;">Увеличить количество отказов от заявок</span>  


```JavaScript
ticket.incAssignedPersonRejectsCount(int|null $personQueueId = null, string|null $personQueueTable = null)
```

##### Описание:

<span style="font-weight: 400;">Увеличить количество отказов от заявок для текущего исполнителя на 1. </span><span style="font-weight: 400;">Метод не сбрасывает кол-во попыток, если значение будет больше чем указанное в боте максимальное количество отказов.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-1" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueId </td><td style="width: 33.3745%; height: 29.7969px;">int|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">personQueueTable </td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr></tbody></table>


##### Возвращает:

**bool** — подтверждение успешного увеличения отказов.

# ticket.assignToNextPersonAndMoveToEnd()

### <span style="font-weight: 400;">Назначить заявку следующему исполнителю и перенести в конец очереди</span>

```JavaScript
ticket.assignToNextPersonAndMoveToEnd()
```

##### Описание:

Назначает заявку следующему исполнителю и переносит его в конец очереди.

##### Возвращает:

**bool** — подтверждение назначения заявки.

# Методы ticketStatuses



# ticketStatuses.reload()

### Перезагрузить все статусы из БД

```JavaScript
ticketStatuses.reload()
```

##### Описание:

Перезагружает все статусы из БД.

##### Возвращает:

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

# ticketStatuses.getCollection()

#### <span style="color: #222222; font-size: 1.666em;">Получить Laravel Collection</span>  


```JavaScript
ticketStatuses.getCollection()
```

##### Описание:

Возвращает коллекцию статусов заявок.

##### Возвращает:

**?Collection** - данные статусов в виде коллекции.

##### Пример:

```JavaScript
let collection = ticketStatuses.find([['name', 'like', 'СТАТУС']], true);
status = collection.last();
status = status['_object'] ? status['_object'] : null;
lead.setAttr('7_status_from_collection', status ? status.name : null);

collection = collection.reload();

collection = ticketStatuses.getCollection();
statuses = collection.where('name', '=', 'статус 1');
status = statuses.first();
status = (status && status['_object']) ? status['_object'] : null;
lead.setAttr('8_status_from_collection', status ? status.name : null);
```

# ticketStatuses.find()

#### <span style="color: #222222; font-size: 1.666em;">Поиск статусов</span>  


```JavaScript
ticketStatuses.find(array|object|null $where, bool $isReturnCollection = false)
```

##### Описание:

Находит статусы соответствующие указанным данным.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">where</td><td style="width: 33.3745%; height: 29.7969px;">array|object|null</td><td style="width: 33.3745%; height: 29.7969px;">Параметр по которому будет проверяться соответствие с найденными статусами</td></tr><tr><td style="width: 33.3745%;">isReturnCollection</td><td style="width: 33.3745%;">bool </td><td style="width: 33.3745%;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

##### Возвращает:

**?ScriptTicketStatus** - v8 обертка над моделью

или

**Collection** - данные статусов в виде коллекции.

##### Пример:

```JavaScript
let statuses = ticketStatuses.find([['name', 'like', 'СТАТУС']]);
lead.setAttr('6_found_ticket_statuses_count', statuses.length);

let collection = ticketStatuses.find([['name', 'like', 'СТАТУС']], true);
status = collection.last();
status = status['_object'] ? status['_object'] : null;
lead.setAttr('7_status_from_collection', status ? status.name : null);
```

### Атрибуты и методы ScriptTicketStatus

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

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 598.313px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 86.8281px;"><td style="width: 32.0171%; height: 86.8281px;">Получение элемента

</td><td style="width: 50.0595%; height: 86.8281px;">- .last()
- .first()
- .where()

</td><td style="width: 17.9234%; height: 86.8281px;">**?string**</td></tr><tr style="height: 53.2344px;"><td style="width: 32.0171%; height: 53.2344px;">Обновление

</td><td style="width: 50.0595%; height: 53.2344px;">- .reload()

</td><td style="width: 17.9234%; height: 53.2344px;">**bool**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты создания

</td><td style="width: 50.0595%; height: 137.219px;">- created\_at
- createdAt
- getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты обновления

</td><td style="width: 50.0595%; height: 137.219px;">- updated\_at
- updatedAt
- getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты удаления

</td><td style="width: 50.0595%; height: 137.219px;">- deleted\_at
- deletedAt
- getDeletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- deletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr></tbody></table>

# ticketStatuses.findById()

#### <span style="color: #222222; font-size: 1.666em;">Поиск статуса по ID</span>  


```JavaScript
ticketStatuses.findById(string|int|null $id)
```

##### Описание:

Находит статус соответствующий указанному id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-id-" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">id</td><td style="width: 33.3745%; height: 29.7969px;">string|int|null</td><td style="width: 33.3745%; height: 29.7969px;">ID статуса заявки</td></tr></tbody></table>

##### Возвращает:

**?ScriptTicketStatus** - v8 обертка над моделью

##### Пример:

```JavaScript
let status = ticketStatuses.findById(1095);
lead.setAttr('2_found_ticket_status_by_id', status ? status.id : null);
```

### Атрибуты и методы ScriptTicketStatus

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

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 598.313px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 86.8281px;"><td style="width: 32.0171%; height: 86.8281px;">Получение элемента

</td><td style="width: 50.0595%; height: 86.8281px;">- .last()
- .first()
- .where()

</td><td style="width: 17.9234%; height: 86.8281px;">**?string**</td></tr><tr style="height: 53.2344px;"><td style="width: 32.0171%; height: 53.2344px;">Обновление

</td><td style="width: 50.0595%; height: 53.2344px;">- .reload()

</td><td style="width: 17.9234%; height: 53.2344px;">**bool**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты создания

</td><td style="width: 50.0595%; height: 137.219px;">- created\_at
- createdAt
- getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты обновления

</td><td style="width: 50.0595%; height: 137.219px;">- updated\_at
- updatedAt
- getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты удаления

</td><td style="width: 50.0595%; height: 137.219px;">- deleted\_at
- deletedAt
- getDeletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- deletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr></tbody></table>

# ticketStatuses.findByName()

#### <span style="color: #222222; font-size: 1.666em;">Поиск статуса по имени</span>  


```JavaScript
ticketStatuses.findByName(string $name)
```

##### Описание:

Находит статус соответствующий указанному имени.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-nam" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">name</td><td style="width: 33.3745%; height: 29.7969px;">string</td><td style="width: 33.3745%; height: 29.7969px;">Имя статуса заявки</td></tr></tbody></table>

##### Возвращает:

**?ScriptTicketStatus** - v8 обертка над моделью.

##### Пример:

```JavaScript
let status = ticketStatuses.findByName('статус 1');
lead.setAttr('0_found_ticket_status_by_name', status ? status.id : null);
```

### Атрибуты и методы ScriptTicketStatus

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

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 598.313px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 86.8281px;"><td style="width: 32.0171%; height: 86.8281px;">Получение элемента

</td><td style="width: 50.0595%; height: 86.8281px;">- .last()
- .first()
- .where()

</td><td style="width: 17.9234%; height: 86.8281px;">**?string**</td></tr><tr style="height: 53.2344px;"><td style="width: 32.0171%; height: 53.2344px;">Обновление

</td><td style="width: 50.0595%; height: 53.2344px;">- .reload()

</td><td style="width: 17.9234%; height: 53.2344px;">**bool**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты создания

</td><td style="width: 50.0595%; height: 137.219px;">- created\_at
- createdAt
- getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты обновления

</td><td style="width: 50.0595%; height: 137.219px;">- updated\_at
- updatedAt
- getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr><tr style="height: 137.219px;"><td style="width: 32.0171%; height: 137.219px;">Получение даты удаления

</td><td style="width: 50.0595%; height: 137.219px;">- deleted\_at
- deletedAt
- getDeletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null): ?string
- deletedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 137.219px;">**?string**</td></tr></tbody></table>

# ticketStatuses.findAllByNames()

#### <span style="color: #222222; font-size: 1.666em;">Поиск статусов по имени</span>  


```JavaScript
ticketStatuses.findAllByNames(string|array|object|null $names, string $operator = '=', bool $isReturnCollection = false)
```

##### Описание:

Находит статусы соответствующие указанным именам.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-nam-0" style="border-collapse: collapse; width: 100%; height: 170.188px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 46.7969px;"><td style="width: 33.3745%; height: 46.7969px;">names</td><td style="width: 33.3745%; height: 46.7969px;">string|array|object|null</td><td style="width: 33.3745%; height: 46.7969px;">Имя статуса</td></tr><tr style="height: 46.7969px;"><td style="width: 33.3745%; height: 46.7969px;">operator</td><td style="width: 33.3745%; height: 46.7969px;">string</td><td style="width: 33.3745%; height: 46.7969px;">Оператор</td></tr><tr style="height: 46.7969px;"><td style="width: 33.3745%; height: 46.7969px;">isReturnCollection</td><td style="width: 33.3745%; height: 46.7969px;">bool</td><td style="width: 33.3745%; height: 46.7969px;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

##### Возвращает:

**Collection** - данные статусов в виде коллекции.

##### Пример:

```JavaScript
let statuses = ticketStatuses.findAllByNames('статус', 'like');
lead.setAttr('1_found_ticket_status_by_names_like', statuses.length);

statuses = ticketStatuses.findAllByNames(['статус 1', 'Статус 2'], 'IN');
lead.setAttr('3_found_ticket_statuses_by_names_count', statuses.length);
```

# ticketStatuses.findAllByTypes()

#### <span style="color: #222222; font-size: 1.666em;">Поиск статусов по типу статуса</span>  


```JavaScript
ticketStatuses.findAllByTypes(string|array|object|null $types, string $operator = '=', bool $isReturnCollection = false)
```

##### Описание:

Находит статусы соответствующие указанным типам.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-typ" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 46.7969px;">types</td><td style="width: 33.3745%; height: 46.7969px;">string|array|object|null</td><td style="width: 33.3745%; height: 46.7969px;">Тип статуса</td></tr><tr><td style="width: 33.3745%; height: 46.7969px;">operator</td><td style="width: 33.3745%; height: 46.7969px;">string</td><td style="width: 33.3745%; height: 46.7969px;">Оператор</td></tr><tr><td style="width: 33.3745%; height: 46.7969px;">isReturnCollection</td><td style="width: 33.3745%; height: 46.7969px;">bool</td><td style="width: 33.3745%; height: 46.7969px;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

На данный момент поддерживаются следующие типы статусов:

- NEW
- ASSIGNED
- PENDING\_CONFIRMATION
- CONFIRMED
- CANCELLED
- CLOSED
- PENDING\_PAYMENT
- PAYMENT\_FAILED
- PAID
- PREPARING\_ORDER
- DELIVERY\_IN\_PROGRESS
- WAITS\_FOR\_CUSTOMER\_PICK\_UP
- DELIVERED

##### Возвращает:

**Collection** - данные статусов в виде коллекции.

##### Пример:

```JavaScript
var statuses = ticketStatuses.findAllByTypes(['ASSIGNED', 'NEW'], 'IN');
lead.setAttr('4_found_ticket_statuses_by_types_in_count', statuses.length);

statuses = ticketStatuses.findAllByTypes('ASSIGNED', 'like');
lead.setAttr('5_found_ticket_statuses_by_types_like_count', statuses.length);
```

# Методы person



# person.update()

### Обновить персону



```JavaScript
person.update($data)
```

##### Описание:

Обновляет данные персоны в соответствии с БД.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-dat-0" style="border-collapse: collapse; width: 100%; height: 452.078px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3791%; height: 29.7969px;">Имя</td><td style="width: 33.3791%; height: 29.7969px;">Тип</td><td style="width: 33.3791%; height: 29.7969px;">Описание</td></tr><tr style="background-color: #ecf0f1;"><td style="width: 33.3791%;">data

</td><td style="width: 33.3791%;">json</td><td style="width: 33.3791%;">Данные о персоне в формате json. Возможные поля расписаны ниже</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">person\_role\_id

</td><td style="width: 33.3791%; height: 35.3906px;">integer</td><td style="width: 33.3791%; height: 35.3906px;">Id персоны</td></tr><tr style="height: 124.953px;"><td style="width: 33.3791%; height: 124.953px;">is\_external

</td><td style="width: 33.3791%; height: 124.953px;">bool</td><td style="width: 33.3791%; height: 124.953px;"><span style="font-weight: 400;">Если не устанавливать по умолчанию будет установлено 1, означающее что персона является клиентом. </span>

<span style="font-weight: 400;">А 0 означает что персона является работником бизнеса</span>

</td></tr><tr style="height: 49.5938px;"><td style="width: 33.3791%; height: 49.5938px;">user\_id

</td><td style="width: 33.3791%; height: 49.5938px;">integer</td><td style="width: 33.3791%; height: 49.5938px;">Id пользователя, привязываемого к персоне</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">firstname

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Имя персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">lastname

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Фамилия персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">middlename

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Отчество персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">email

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Адрес электронной почты персоны</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">phone

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Номер телефона персоны</td></tr><tr><td style="width: 33.3791%; height: 35.4688px;">organization\_name

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Название организации</td></tr><tr><td style="width: 33.3791%; height: 35.4688px;">organization\_address

</td><td style="width: 33.3791%; height: 35.4688px;">string|null</td><td style="width: 33.3791%; height: 35.4688px;">Адрес организации</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3791%; height: 35.3906px;">comment

</td><td style="width: 33.3791%; height: 35.3906px;">string|null</td><td style="width: 33.3791%; height: 35.3906px;">Комментарий к персоне</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение обновления данных.

##### Пример:

```JavaScript
person.update({
  'is_external': 1,
  'firstname': 'Иван',
  'lastname': 'Иванов'
});
```

# person.delete()

### Удалить персону



```JavaScript
person.delete()
```

##### Описание:

Удаляет персону лида.

##### Возвращает:

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

# person.getAllData()

### Получить все поля персоны


```JavaScript
person.getAllData()
```

##### Описание:

Возвращает значения всех полей персоны лида в виде массива.

<span style="font-size: 1.4em; font-weight: 400;">Возвращает:</span>

**array** - массив всех значений полей персоны.

##### Пример:

```JavaScript
let AllData = person.getAllData();
let Data2 = AllData[1];
```

# person.setData()

### Установить поле персоны


```JavaScript
person.setData(string $key, $value)
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">key

</td><td style="width: 33.2909%; height: 35.3906px;">string</td><td style="width: 33.2948%; height: 35.3906px;">Ключ наименование поля</td></tr><tr><td style="width: 33.2909%;">value

</td><td style="width: 33.2909%;">mixed</td><td style="width: 33.2948%;">Значение вводимое в поле</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id персоны;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**person\_role\_id** - id роли;</span>
- <span style="font-weight: 400;">**is\_external** - значение поля **Сотрудник/Клиент**;</span>
- <span style="font-weight: 400;">**user\_id** - id пользователя;</span>
- <span style="font-weight: 400;">**firstname** - имя;</span>
- <span style="font-weight: 400;">**lastname** - фамилия;</span>
- <span style="font-weight: 400;">**middlename** - отчество;</span>
- <span style="font-weight: 400;">**email** - адрес электронной почты;</span>
- <span style="font-weight: 400;">**phone** - номер телефона;</span>
- <span style="font-weight: 400;">**organization\_name** - название организации;</span>
- <span style="font-weight: 400;">**organization\_address** - адрес организации;</span>
- <span style="font-weight: 400;">**comment** - комментарий;</span>
- <span style="font-weight: 400;">**created\_at** - дата создания;</span>
- <span style="font-weight: 400;">**updated\_at** - дата последнего редактирования;</span>
- <span style="font-weight: 400;">**deleted\_at** - дата удаления;</span><span style="font-weight: 400;">  
    </span>
- <span style="font-weight: 400;">все системные поля персоны (по английски).</span>

##### Возвращает:

**self** - значение отредактированного поля в соответствующем формате.

##### Пример:

```JavaScript
person.setData('email', 'user@mail.ru');
```

# person.getData()

### Получить значение данных персоны


```JavaScript
person.getData(string $key)
```

##### Описание:

<span style="font-weight: 400;">Возвращает значение данных персоны по ключу или названию поля БД.</span>

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">key

</td><td style="width: 33.3745%; height: 35.3906px;">string</td><td style="width: 33.3745%; height: 35.3906px;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id персоны;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**person\_role\_id** - id роли;</span>
- <span style="font-weight: 400;">**is\_external** - значение поля **Сотрудник/Клиент**;</span>
- <span style="font-weight: 400;">**user\_id** - id пользователя;</span>
- <span style="font-weight: 400;">**firstname** - имя;</span>
- <span style="font-weight: 400;">**lastname** - фамилия;</span>
- <span style="font-weight: 400;">**middlename** - отчество;</span>
- <span style="font-weight: 400;">**email** - адрес электронной почты;</span>
- <span style="font-weight: 400;">**phone** - номер телефона;</span>
- <span style="font-weight: 400;">**organization\_name** - название организации;</span>
- <span style="font-weight: 400;">**organization\_address** - адрес организации;</span>
- <span style="font-weight: 400;">**comment** - комментарий;</span>
- <span style="font-weight: 400;">**created\_at** - дата создания;</span>
- <span style="font-weight: 400;">**updated\_at** - дата последнего редактирования;</span>
- <span style="font-weight: 400;">**deleted\_at** - дата удаления;</span><span style="font-weight: 400;">  
    </span>
- <span style="font-weight: 400;">все системные поля персоны (по английски).</span>

##### Возвращает:

**self** - значение запрашиваемого поля в соответствующем формате.

##### Пример:

```JavaScript
let createdAt = person.getData('created_at');
```

# person.issetData() и person.isDataExist()

### Проверить наличие данных по персоне


```JavaScript
person.issetData(string $key)
```

или

```
person.isDataExist(string $key)
```

##### Описание:

Проверяет существование данных персоны лида.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-1" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">key

</td><td style="width: 33.3745%; height: 35.3906px;">string</td><td style="width: 33.3745%; height: 35.3906px;">Ключ наименование поля</td></tr></tbody></table>

<span style="font-weight: 400;">В качестве ключа можно указать:</span>

- <span style="font-weight: 400;">**id** - id персоны;</span>
- <span style="font-weight: 400;">**business\_id** - id бизнеса;</span>
- <span style="font-weight: 400;">**bot\_id** - id бота;</span>
- <span style="font-weight: 400;">**person\_role\_id** - id роли;</span>
- <span style="font-weight: 400;">**is\_external** - значение поля **Сотрудник/Клиент**;</span>
- <span style="font-weight: 400;">**user\_id** - id пользователя;</span>
- <span style="font-weight: 400;">**firstname** - имя;</span>
- <span style="font-weight: 400;">**lastname** - фамилия;</span>
- <span style="font-weight: 400;">**middlename** - отчество;</span>
- <span style="font-weight: 400;">**email** - адрес электронной почты;</span>
- <span style="font-weight: 400;">**phone** - номер телефона;</span>
- <span style="font-weight: 400;">**comment** - комментарий;</span>
- <span style="font-weight: 400;">**created\_at** - дата создания;</span>
- <span style="font-weight: 400;">**updated\_at** - дата последнего редактирования;</span>
- <span style="font-weight: 400;">**deleted\_at** - дата удаления;</span><span style="font-weight: 400;">  
    </span>
- <span style="font-weight: 400;">все системные поля персоны (по английски).</span>

##### Возвращает:

**bool** - подтверждение существования данных.

##### Пример:

```JavaScript
let DataExist = person.issetData('phone');
```

или

```JavaScript
let DataExist = person.isDataExist('phone');
```

# person.getId()

### Получить ID персоны


```JavaScript
person.getId()
```

##### Описание:

Возвращает id персоны привязанной к лиду.

##### Возвращает:

**int** - id персоны в формате числа.

##### Пример:

```JavaScript
let PersonId = person.getId();
lead.setAttr('PersonId', PersonId);
```

# person.getFullName()

### Получить полное имя персоны


```JavaScript
person.getFullName()
```

##### Описание:

<span style="font-weight: 400;">Возвращает полное имя персоны лида в виде **Фамилия + Имя + Отчество**.</span>

##### Возвращает:

**string** - полное имя персоны.

##### Пример:

```JavaScript
let PersonName = person.getFullName();
lead.setAttr('PersonName', PersonName);
```

# person.getRoleId()

### Получить ID роли персоны


```JavaScript
person.getRoleId()
```

##### Описание:

Возвращает id роли привязанной к персоне лида.

##### Возвращает:

**int** - id роли персоны в формате числа.

##### Пример:

```JavaScript
let RoleId = person.getRoleId();
lead.setAttr('RoleId', RoleId);
```

# person.getRoleName()

### Получить название роли персоны


```JavaScript
person.getRoleName()
```

##### Описание:

Возвращает название роли привязанной к персоне лида.

##### Возвращает:

**string** - название роли персоны.

##### Пример:

```JavaScript
let RoleName = person.getRoleName();
lead.setAttr('RoleName', RoleName);
```

# person.getRoleTitle()

### Получить заголовок роли персоны


```JavaScript
person.getRoleTitle()
```

##### Описание:

Возвращает заголовок роли привязанной к персоне лида.

##### Возвращает:

**string** - заголовок роли персоны.

##### Пример:

```JavaScript
let RoleTitle = person.getRoleTitle();
lead.setAttr('RoleTitle', RoleTitle);
```

# person.getRoleFormattedTitle()

### Получить форматированное название роли персоны


```JavaScript
person.getRoleFormattedTitle()
```

##### Описание:

<span style="font-weight: 400;">Возвращает форматированное название роли персоны лида.</span>

<span style="font-weight: 400;">Будет возвращено: </span>

- <span style="font-weight: 400;">Заголовок роли, если он указан, иначе</span>
- <span style="font-weight: 400;">Имя роли, если оно указано, иначе </span>
- <span style="font-weight: 400;">ID роли.</span>

##### Возвращает:

**string** - <span style="font-weight: 400;">форматированное название </span>роли персоны.

##### Пример:

```JavaScript
let FormattedTitle = person.getRoleFormattedTitle();
lead.setAttr('FormattedTitle', FormattedTitle);
```

# person.getPhone()

### Получить номер телефона персоны


```JavaScript
person.getPhone()
```

##### Описание:

Находит номер телефона персоны лида.

##### Возвращает:

**string** - номер телефона персоны в формате строки.

# person.setPhone()

### Установить номер телефона персоны



```JavaScript
person.setPhone(?string $phone)
```

##### Описание:

Устанавливает значение номера телефона персоны лида.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-pho" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.891px;"><td style="width: 33.2909%; height: 36.891px;">phone

</td><td style="width: 33.2909%; height: 36.891px;">string</td><td style="width: 33.2948%; height: 36.891px;">Номер телефона</td></tr></tbody></table>


##### Возвращает:

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

##### Пример:

```JavaScript
person.setPhone('+71234567890');
```

# person.getEmail()

### Получить почту персоны


```JavaScript
person.getEmail()
```

##### Описание:

Находит адрес электронной почты персоны лида.


##### Возвращает:

**string** - адрес электронной почты персоны в формате строки.

# person.addToQueue()

### Добавление персоны в очередь

```JavaScript
person.addToQueue(?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null, bool $isActive = true, int $rejectsCount = 0)
```

##### Описание:

Добавляет персону в указанную очередь.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tic" style="border-collapse: collapse; width: 100%; height: 209.078px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 27.3177%; height: 29.7969px;">Имя</td><td style="width: 27.0705%; height: 29.7969px;">Тип</td><td style="width: 45.7355%; height: 29.7969px;">Описание</td></tr><tr style="height: 37.7188px;"><td style="width: 27.3177%; height: 37.7188px;">personQueueId</td><td style="width: 27.0705%; height: 37.7188px;">int</td><td style="width: 45.7355%; height: 37.7188px;">ID вида очереди, в которую будет добавлена персона

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">personQueueTable</td><td style="width: 27.0705%; height: 35.3906px;">string</td><td style="width: 45.7355%; height: 35.3906px;">Наименование кастомной таблицы

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">ticketTypeId</td><td style="width: 27.0705%; height: 35.3906px;">int</td><td style="width: 45.7355%; height: 35.3906px;">ID вида заявки, в очередь которой будет добавлена персона

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">isActive</td><td style="width: 27.0705%; height: 35.3906px;">bool</td><td style="width: 45.7355%; height: 35.3906px;">Активность персоны в очереди

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">rejectsCount</td><td style="width: 27.0705%; height: 35.3906px;">int</td><td style="width: 45.7355%; height: 35.3906px;">Количество отказов от заявки

</td></tr></tbody></table>

<p class="callout warning">Одновременно в методе может быть указан либо только вид заявки, либо только вид очереди (одна из этих переменных должна содержать значение null). Так же по видам заявок не должна допускаться установка значения кастомной таблицы</p>

##### Возвращает:

**int** - id добавленной персоны.

##### Пример:

```JavaScript
person.addToQueue(null, null, 2541);
```

# person.removeFromQueue()

### Удаление персоны из очереди

```JavaScript
person.removeFromQueue(?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null)
```

##### Описание:

Удаляет персону из указанной очереди.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-per-2" style="border-collapse: collapse; width: 100%; height: 209.078px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 27.3177%; height: 29.7969px;">Имя</td><td style="width: 27.0705%; height: 29.7969px;">Тип</td><td style="width: 45.7355%; height: 29.7969px;">Описание</td></tr><tr style="height: 37.7188px;"><td style="width: 27.3177%; height: 37.7188px;">personQueueId</td><td style="width: 27.0705%; height: 37.7188px;">int</td><td style="width: 45.7355%; height: 37.7188px;">ID вида очереди

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">personQueueTable</td><td style="width: 27.0705%; height: 35.3906px;">string</td><td style="width: 45.7355%; height: 35.3906px;">Наименование кастомной таблицы

</td></tr><tr style="height: 35.3906px;"><td style="width: 27.3177%; height: 35.3906px;">ticketTypeId</td><td style="width: 27.0705%; height: 35.3906px;">int</td><td style="width: 45.7355%; height: 35.3906px;">ID вида заявки

</td></tr></tbody></table>

<p class="callout warning">Одновременно в методе может быть указан либо только вид заявки, либо только вид очереди (одна из этих переменных должна содержать значение null)</p>

##### Возвращает:

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

##### Пример:

```JavaScript
person.removeFromQueue(3527, "table");
```

# person.moveToEndOfQueue()

### Перемещение персоны в конец очереди

```JavaScript
person.moveToEndOfQueue(int $queueMode = 1, ?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null, bool $isResetRejectsCount = true)
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-que" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 27.3177%; height: 29.7969px;">Имя</td><td style="width: 27.0705%; height: 29.7969px;">Тип</td><td style="width: 45.7355%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 27.3177%; height: 169.734px;">queueMode </td><td style="width: 27.0705%; height: 169.734px;">int</td><td style="width: 45.7355%; height: 169.734px;">Режим работы очереди.

Для работы с очередью на основе видов заявок указывать не нужно, будет использовано значение по умолчанию **1**;  
Для работы с очередью на основе видов очередей указать **2**

</td></tr><tr><td style="width: 27.3177%; height: 29.7969px;">personQueueId </td><td style="width: 27.0705%; height: 29.7969px;">?int</td><td style="width: 45.7355%; height: 29.7969px;"><span style="font-weight: 400;">id очереди</span></td></tr><tr><td style="width: 27.3177%; height: 29.7969px;">personQueueTable </td><td style="width: 27.0705%; height: 29.7969px;">?string</td><td style="width: 45.7355%; height: 29.7969px;"><span style="font-weight: 400;">Название таблицы-связки для очередей</span></td></tr><tr style="height: 36.891px;"><td style="width: 27.3177%; height: 36.891px;">ticketTypeIds

</td><td style="width: 27.0705%; height: 36.891px;">int|array|object|null</td><td style="width: 45.7355%; height: 36.891px;">**$ticketTypeIds = null**, то персона будет перемещена в конец очереди по всем типам заявок;  
**$ticketTypeIds = число**, то персона будет перемещена в конец очереди по указанному типу заявки;  
**$ticketTypeIds = строка** **с перечислениями** типов заявок через запятую, то персона будет перемещена в конец очереди по указанным типам заявок (например 1,2,3);  
**$ticketTypeIds = строка без перечислений** через запятую, ticketTypeIds будет приведен к типу = число и персона будет перемещена в конец очереди по указанному типу заявки;  
**$ticketTypeIds = json массив**, то персона будет перемещена в конец очереди по всем типам заявок (например \[1,2,3\])</td></tr><tr><td style="width: 27.3177%;">isResetRejectsCount

</td><td style="width: 27.0705%;">bool</td><td style="width: 45.7355%;">Обнулить количество отказов персоны</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение удачного перемещения персоны.

##### Пример:

```JavaScript
person.moveToEndOfQueue(2, 3352, null, [1013]);
persons.moveToEndOfQueue();
```

# person.setIsActiveInQueue()

### Активация/деактивация персоны в очереди


```JavaScript
person.setIsActiveInQueue(bool $isActive = true)
```

##### Описание:

Включает или выключает параметр **Активна** персоны в очереди.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-isa" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.891px;"><td style="width: 33.2909%; height: 36.891px;">isActive

</td><td style="width: 33.2909%; height: 36.891px;">bool</td><td style="width: 33.2948%; height: 36.891px;">Активировать или деактивировать персону в очереди</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение активации или деактивации.

##### Пример:

```
persons.setIsActiveInQueue(true);
```

# Методы personQueues



# personQueues.find()

### Найти очередь исполнителей



```JavaScript
personQueues.find($where, bool $isReturnCollection = false)
```

##### Описание:

Находит очередь исполнителей соответствующую указанным значениям.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-whe" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">where

</td><td style="width: 33.2909%;">array</td><td style="width: 33.2948%;">Параметр по которому будет проверяться соответствие с найденными очередями</td></tr><tr style="height: 36.891px;"><td style="width: 33.2909%; height: 36.891px;">isReturnCollection

</td><td style="width: 33.2909%; height: 36.891px;">bool</td><td style="width: 33.2948%; height: 36.891px;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

##### Возвращает:

**ScriptPersonQueue\[\]** - обертка вокруг записи из таблицы person\_queues

или

**Collection** - данные очередей в виде коллекции.

##### Пример:

### Атрибуты и методы ScriptPersonQueue

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 648.438px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение id

</td><td style="width: 50.0595%; height: 81.2188px;">- .id
- .getId()

</td><td style="width: 17.9234%; height: 81.2188px;">**int**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение кода</td><td style="width: 50.0595%; height: 81.2188px;">- .code
- .getCode()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение активности</td><td style="width: 50.0595%; height: 81.2188px;">- .is\_enabled
- .getIsEnabled()

</td><td style="width: 17.9234%; height: 81.2188px;">**bool**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение заголовка</td><td style="width: 50.0595%; height: 81.2188px;">- .title
- .getTitle()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 170.781px;"><td style="width: 32.0171%; height: 170.781px;">Получение даты создания</td><td style="width: 50.0595%; height: 170.781px;">- .created\_at
- .createdAt
- .getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 170.781px;"> **string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Получение даты обновления</td><td style="width: 50.0595%; height: 29.7969px;">- .updated\_at
- .updatedAt
- .getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 29.7969px;">**string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Обновление</td><td style="width: 50.0595%; height: 29.7969px;">- .reload()

</td><td style="width: 17.9234%; height: 29.7969px;">**bool**</td></tr><tr style="height: 46.5938px;"><td style="width: 32.0171%; height: 46.5938px;">Приводит $title к нижнему регистру и сравнивает с заголовком очереди</td><td style="width: 50.0595%; height: 46.5938px;">- .isSameTitle($title)

</td><td style="width: 17.9234%; height: 46.5938px;">**bool**</td></tr></tbody></table>

# personQueues.findById()

### Найти очередь исполнителей по id



```JavaScript
personQueues.findById(string|int|null $id)
```

##### Описание:

Находит очередь исполнителей соответствующую указанному id.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-id-" style="border-collapse: collapse; width: 100%; height: 66.6875px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.8906px;"><td style="width: 33.2909%; height: 36.8906px;">id

</td><td style="width: 33.2909%; height: 36.8906px;">string|int|null</td><td style="width: 33.2948%; height: 36.8906px;">ID очереди исполнителей</td></tr></tbody></table>

##### Возвращает:

**ScriptPersonQueue\[\]** - обертка вокруг записи из таблицы person\_queues.

##### Пример:

### Атрибуты и методы ScriptPersonQueue

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 648.438px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение id

</td><td style="width: 50.0595%; height: 81.2188px;">- .id
- .getId()

</td><td style="width: 17.9234%; height: 81.2188px;">**int**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение кода</td><td style="width: 50.0595%; height: 81.2188px;">- .code
- .getCode()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение активности</td><td style="width: 50.0595%; height: 81.2188px;">- .is\_enabled
- .getIsEnabled()

</td><td style="width: 17.9234%; height: 81.2188px;">**bool**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение заголовка</td><td style="width: 50.0595%; height: 81.2188px;">- .title
- .getTitle()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 170.781px;"><td style="width: 32.0171%; height: 170.781px;">Получение даты создания</td><td style="width: 50.0595%; height: 170.781px;">- .created\_at
- .createdAt
- .getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 170.781px;"> **string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Получение даты обновления</td><td style="width: 50.0595%; height: 29.7969px;">- .updated\_at
- .updatedAt
- .getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 29.7969px;">**string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Обновление</td><td style="width: 50.0595%; height: 29.7969px;">- .reload()

</td><td style="width: 17.9234%; height: 29.7969px;">**bool**</td></tr><tr style="height: 46.5938px;"><td style="width: 32.0171%; height: 46.5938px;">Приводит $title к нижнему регистру и сравнивает с заголовком очереди</td><td style="width: 50.0595%; height: 46.5938px;">- .isSameTitle($title)

</td><td style="width: 17.9234%; height: 46.5938px;">**bool**</td></tr></tbody></table>

# personQueues.findAllByTitles()

### Найти очереди исполнителей по заголовку



```JavaScript
personQueues.findAllByTitles(string|array|object|null $titles, bool $isEnabled = null, string $findTitleOperator = 'IN', bool $isReturnCollection = false)
```

##### Описание:

Находит очереди исполнителей соответствующим указанным заголовкам.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tit" style="border-collapse: collapse; width: 100%; height: 172.844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.875px;"><td style="width: 33.2909%; height: 36.875px;">titles

</td><td style="width: 33.2909%; height: 36.875px;">string|array|object|null</td><td style="width: 33.2948%; height: 36.875px;">Заголовки очередей</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">isEnabled

</td><td style="width: 33.2909%; height: 35.3906px;">bool </td><td style="width: 33.2948%; height: 35.3906px;">Активность очереди</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">findTitleOperator

</td><td style="width: 33.2909%; height: 35.3906px;">string </td><td style="width: 33.2948%; height: 35.3906px;">Оператор заголовка, по умолчанию 'IN'</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">isReturnCollection

</td><td style="width: 33.2909%; height: 35.3906px;">bool </td><td style="width: 33.2948%; height: 35.3906px;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

##### Возвращает:

**ScriptPersonQueue\[\]** - обертка вокруг записи из таблицы person\_queues

или

**Collection** - данные очередей в виде коллекции.

##### Пример:

### Атрибуты и методы ScriptPersonQueue

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 648.438px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение id

</td><td style="width: 50.0595%; height: 81.2188px;">- .id
- .getId()

</td><td style="width: 17.9234%; height: 81.2188px;">**int**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение кода</td><td style="width: 50.0595%; height: 81.2188px;">- .code
- .getCode()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение активности</td><td style="width: 50.0595%; height: 81.2188px;">- .is\_enabled
- .getIsEnabled()

</td><td style="width: 17.9234%; height: 81.2188px;">**bool**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение заголовка</td><td style="width: 50.0595%; height: 81.2188px;">- .title
- .getTitle()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 170.781px;"><td style="width: 32.0171%; height: 170.781px;">Получение даты создания</td><td style="width: 50.0595%; height: 170.781px;">- .created\_at
- .createdAt
- .getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 170.781px;"> **string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Получение даты обновления</td><td style="width: 50.0595%; height: 29.7969px;">- .updated\_at
- .updatedAt
- .getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 29.7969px;">**string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Обновление</td><td style="width: 50.0595%; height: 29.7969px;">- .reload()

</td><td style="width: 17.9234%; height: 29.7969px;">**bool**</td></tr><tr style="height: 46.5938px;"><td style="width: 32.0171%; height: 46.5938px;">Приводит $title к нижнему регистру и сравнивает с заголовком очереди</td><td style="width: 50.0595%; height: 46.5938px;">- .isSameTitle($title)

</td><td style="width: 17.9234%; height: 46.5938px;">**bool**</td></tr></tbody></table>

# personQueues.findByCode()

### Найти очередь исполнителей по коду



```JavaScript
personQueues.findByCode(string $code, bool $isEnabled = null, string $findCodeOperator = '=')
```

##### Описание:

Находит очередь исполнителей соответствующую указанному коду.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-cod" style="border-collapse: collapse; width: 100%; height: 137.469px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.8906px;"><td style="width: 33.3745%; height: 36.8906px;">code

</td><td style="width: 33.3745%; height: 36.8906px;">string</td><td style="width: 33.3745%; height: 36.8906px;">Код очереди</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">isEnabled

</td><td style="width: 33.3745%; height: 35.3906px;">bool </td><td style="width: 33.3745%; height: 35.3906px;">Активность очереди</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">findCodeOperator

</td><td style="width: 33.3745%; height: 35.3906px;">string </td><td style="width: 33.3745%; height: 35.3906px;">Оператор кода, по умолчанию '='</td></tr></tbody></table>

##### Возвращает:

**ScriptPersonQueue\[\]** - обертка вокруг записи из таблицы person\_queues.

##### Пример:

```JavaScript
let personQueue = personQueues.findByCode('хоккей');
let personQueueId = personQueue.id;
```

### Атрибуты и методы ScriptPersonQueue

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 648.438px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение id

</td><td style="width: 50.0595%; height: 81.2188px;">- .id
- .getId()

</td><td style="width: 17.9234%; height: 81.2188px;">**int**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение кода</td><td style="width: 50.0595%; height: 81.2188px;">- .code
- .getCode()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение активности</td><td style="width: 50.0595%; height: 81.2188px;">- .is\_enabled
- .getIsEnabled()

</td><td style="width: 17.9234%; height: 81.2188px;">**bool**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение заголовка</td><td style="width: 50.0595%; height: 81.2188px;">- .title
- .getTitle()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 170.781px;"><td style="width: 32.0171%; height: 170.781px;">Получение даты создания</td><td style="width: 50.0595%; height: 170.781px;">- .created\_at
- .createdAt
- .getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 170.781px;"> **string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Получение даты обновления</td><td style="width: 50.0595%; height: 29.7969px;">- .updated\_at
- .updatedAt
- .getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 29.7969px;">**string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Обновление</td><td style="width: 50.0595%; height: 29.7969px;">- .reload()

</td><td style="width: 17.9234%; height: 29.7969px;">**bool**</td></tr><tr style="height: 46.5938px;"><td style="width: 32.0171%; height: 46.5938px;">Приводит $title к нижнему регистру и сравнивает с заголовком очереди</td><td style="width: 50.0595%; height: 46.5938px;">- .isSameTitle($title)

</td><td style="width: 17.9234%; height: 46.5938px;">**bool**</td></tr></tbody></table>

# personQueues.findAllByCodes()

### Найти очереди исполнителей по коду



```JavaScript
personQueues.findAllByCodes($codes, bool $isEnabled = null, string $findCodeOperator = 'IN', bool $isReturnCollection = false)
```

##### Описание:

Находит очереди исполнителей соответствующим указанным кодам.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-cod-0" style="border-collapse: collapse; width: 100%; height: 385.203px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 36.891px;"><td style="width: 33.3745%; height: 36.891px;">codes

</td><td style="width: 33.3745%; height: 36.891px;">string|array|object|null</td><td style="width: 33.3745%; height: 36.891px;">Коды очередей</td></tr><tr><td style="width: 33.3745%;">isEnabled

</td><td style="width: 33.3745%; height: 35.3906px;">bool </td><td style="width: 33.3745%; height: 35.3906px;">Активность очереди</td></tr><tr><td style="width: 33.3745%;">findCodeOperator

</td><td style="width: 33.3745%; height: 35.3906px;">string </td><td style="width: 33.3745%; height: 35.3906px;">Оператор кода, по умолчанию 'IN'</td></tr><tr><td style="width: 33.3745%;">isReturnCollection

</td><td style="width: 33.3745%; height: 35.3906px;">bool </td><td style="width: 33.3745%; height: 35.3906px;">Параметр позволяющий вернуть значения в виде коллекции</td></tr></tbody></table>

##### Возвращает:

**ScriptPersonQueue\[\]** - обертка вокруг записи из таблицы person\_queues

или

**Collection** - данные очередей в виде коллекции.

##### Пример:

### Атрибуты и методы ScriptPersonQueue

<table border="1" id="bkmrk-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%92%D0%BE%D0%B7%D0%B2%D1%80" style="border-collapse: collapse; width: 100%; height: 648.438px;"><tbody><tr style="height: 46.5938px; background-color: #c2e0f4;"><td style="width: 32.0171%; height: 46.5938px;">Описание</td><td style="width: 50.0595%; height: 46.5938px;">Метод</td><td style="width: 17.9234%; height: 46.5938px;">Возвращаемое значение</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение id

</td><td style="width: 50.0595%; height: 81.2188px;">- .id
- .getId()

</td><td style="width: 17.9234%; height: 81.2188px;">**int**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение кода</td><td style="width: 50.0595%; height: 81.2188px;">- .code
- .getCode()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение активности</td><td style="width: 50.0595%; height: 81.2188px;">- .is\_enabled
- .getIsEnabled()

</td><td style="width: 17.9234%; height: 81.2188px;">**bool**</td></tr><tr style="height: 81.2188px;"><td style="width: 32.0171%; height: 81.2188px;">Получение заголовка</td><td style="width: 50.0595%; height: 81.2188px;">- .title
- .getTitle()

</td><td style="width: 17.9234%; height: 81.2188px;">**string**</td></tr><tr style="height: 170.781px;"><td style="width: 32.0171%; height: 170.781px;">Получение даты создания</td><td style="width: 50.0595%; height: 170.781px;">- .created\_at
- .createdAt
- .getCreatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .createdAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 170.781px;"> **string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Получение даты обновления</td><td style="width: 50.0595%; height: 29.7969px;">- .updated\_at
- .updatedAt
- .getUpdatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)
- .updatedAtFormatted(string $format = 'Y-m-d H:i:s', ?string $timeZone = null)

</td><td style="width: 17.9234%; height: 29.7969px;">**string**</td></tr><tr style="height: 29.7969px;"><td style="width: 32.0171%; height: 29.7969px;">Обновление</td><td style="width: 50.0595%; height: 29.7969px;">- .reload()

</td><td style="width: 17.9234%; height: 29.7969px;">**bool**</td></tr><tr style="height: 46.5938px;"><td style="width: 32.0171%; height: 46.5938px;">Приводит $title к нижнему регистру и сравнивает с заголовком очереди</td><td style="width: 50.0595%; height: 46.5938px;">- .isSameTitle($title)

</td><td style="width: 17.9234%; height: 46.5938px;">**bool**</td></tr></tbody></table>

# personQueues.reload()

### Обновить очередь исполнителей



```JavaScript
personQueues.reload()
```

##### Описание:

Обновляет данные очередей исполнителей

##### Возвращает:

**bool** - подтверждение обновления очередей.

# personQueues.getCollection()

### Получить коллекцию очередей исполнителей



```JavaScript
personQueues.getCollection()
```

##### Описание:

Возвращает коллекцию очередей исполнителей.

##### Возвращает:

**Collection** - данные очередей в виде коллекции.

# Методы table



# table.createItem()

### Создание записи

```JavaScript
table.createItem(string $tableName, array|object $data)
```

##### Описание:

Создает запись в таблице и возвращает значение этой записи, как объект.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.2909%; height: 35.3906px;">tableName

</td><td style="width: 33.2909%; height: 35.3906px;">string</td><td style="width: 33.2948%; height: 35.3906px;">Наименование таблицы, в которой будет создана запись</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">data</td><td style="width: 33.2909%; height: 29.7969px;">array | object ( json{} )</td><td style="width: 33.2948%; height: 29.7969px;">Значения | значение записи</td></tr></tbody></table>

##### Возвращает:

**ScriptCustomTableItem** - все значения полей записи в формате объекта.

##### Пример:

Добавление данных в кастомную таблицу **regions**:

```JavaScript
var region = {
  "name": "Юго-Восточный",
  "comment": "Cоздано через v8"
};
var newRegion = table.createItem('regions', region);
```

# table.find()

### Поиск записей

```JavaScript
table.find(string $tableName, array|object $columns = [], array|object $where = [], array|object $orderBy = [], ?int $limit = null, ?int $offset = null): array
```

##### Описание:

Ищет записи в таблице и возвращает их в виде массива объектов.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab-0" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.2909%;">tableName</td><td style="width: 33.2909%;">string</td><td style="width: 33.2948%;">Наименование таблицы, в которой будет найдена запись</td></tr><tr><td style="width: 33.2909%;">columns

</td><td style="width: 33.2909%;">array | object ( json{} )</td><td style="width: 33.2948%;">Столбцы которые будут возвращены в ответе</td></tr><tr><td style="width: 33.2909%;">where

</td><td style="width: 33.2909%;">array | object ( json{} )</td><td style="width: 33.2948%;">Условие, которое будет проверяться при поиске</td></tr><tr><td style="width: 33.2909%;">orderBy

</td><td style="width: 33.2909%;">array | object ( json{} )</td><td style="width: 33.2948%;">Устанавливает в какой последовательности будут возвращены выходные значения</td></tr><tr><td style="width: 33.2909%;">limit

</td><td style="width: 33.2909%;">int</td><td style="width: 33.2948%;">Устанавливает максимальное количество возвращенных значений</td></tr><tr><td style="width: 33.2909%;">offset

</td><td style="width: 33.2909%;">int</td><td style="width: 33.2948%;">Устанавливает смещение</td></tr></tbody></table>

##### Возвращает:

**array** - массив объектов (найденных записей).

##### Примеры:

Получение **всех** регионов (лимит 100):

```JavaScript
var items = table.find('regions');
var regions = [];
for(var i = 0; i < items.length; i++) { // добавление поочередно всех записей в объект regions
  var item = items[i];
  regions.push({"id": item.id, "name": item.name, "comment": item.comment}); 
}
```

Получение **трех** значений поля **region** с **id больше двух**:

```JavaScript
var columns = ['region'];
var where = [["id", ">", 2]];
var orderBy = [];
var limit = 3;
var offset = 0;

let items = table.find('regions', columns, where, orderBy, limit, offset);
```

# table.count()

### Подсчет количества записей

```JavaScript
table.count(string $tableName, array|object $where = [])
```

##### Описание:

Ищет записи соответствующие условию метода в таблице и возвращает их количество.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab-1" style="border-collapse: collapse; width: 100%; height: 106.188px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2909%; height: 46.5938px;">tableName</td><td style="width: 33.2909%; height: 46.5938px;">string</td><td style="width: 33.2948%; height: 46.5938px;">Наименование таблицы, в которой будет создана запись</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">where</td><td style="width: 33.2909%; height: 29.7969px;">array | object ( json{} )</td><td style="width: 33.2948%; height: 29.7969px;">Условие, которое будет проверяться при поиске</td></tr></tbody></table>

##### Возвращает:

**int** - количество записей в формате числа.

##### Примеры:

Получение количества **всех** записей в таблице:

```JavaScript
var regionsCount = table.count("regions");
memory.setAttr('regionsCount', regionsCount);
```

Получение количества записей с **id больше 2**:

```JavaScript
var countRegionIdsGreather2 = table.count("regions", [["id", ">", 2]]);
memory.setAttr('countRegionIdsGreather2', countRegionIdsGreather2);
```

# table.sum()

### Подсчет суммы по полю

```JavaScript
table.sum(string $tableName, string $column, array|object $where = [])
```

##### Описание:

Ищет записи соответствующие условию метода в таблице и возвращает сумму их значений.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab-2" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 46.5938px;">tableName</td><td style="width: 33.3745%; height: 46.5938px;">string</td><td style="width: 33.3745%; height: 46.5938px;">Наименование таблицы, в которой будет создана запись</td></tr><tr><td style="width: 33.3745%;">column</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование поля из которого будут браться значения</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">where</td><td style="width: 33.3745%; height: 29.7969px;">array | object ( json{} )</td><td style="width: 33.3745%; height: 29.7969px;">Условие, которое будет проверяться при поиске</td></tr></tbody></table>

##### Возвращает:

**int** - сумма всех значений поля в виде числа.

##### Примеры:

Подсчет суммы **всех** значений записей поля **id** в таблице **regions:**

```JavaScript
var sumRegionIds = table.sum("regions", 'id');
memory.setAttr('sumRegionIds', sumRegionIds);
```

Подсчет суммы значений записей поля **id** в таблице **regions** с **id больше нуля**:

```JavaScript
var sumRegionIds = table.sum("regions", 'id', [["id", ">", 0]]);
memory.setAttr('sumRegionIds', sumRegionIds);
```

# table.max()

### Поиск максимального значения по полю

```
table.max(string $tableName, string $column, array|object $where = [])
```

##### Описание:

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

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-tab-3" style="border-collapse: collapse; width: 100%; height: 94.9844px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr><td style="width: 33.3745%; height: 46.5938px;">tableName</td><td style="width: 33.3745%; height: 46.5938px;">string</td><td style="width: 33.3745%; height: 46.5938px;">Наименование таблицы, в которой будет создана запись</td></tr><tr><td style="width: 33.3745%;">column</td><td style="width: 33.3745%;">string</td><td style="width: 33.3745%;">Наименование поля из которого будут браться значения</td></tr><tr><td style="width: 33.3745%; height: 29.7969px;">where</td><td style="width: 33.3745%; height: 29.7969px;">array | object ( json{} )</td><td style="width: 33.3745%; height: 29.7969px;">Условие, которое будет проверяться при поиске</td></tr></tbody></table>

##### Возвращает:

**mixed** - максимальное среди всех значений поля в том же типе, что в таблице

или

**null** - если максимальное значение не было найдено.

##### Примеры:

Нахождение максимального значения в поле **id** в таблице **regions:**

```JavaScript
var maxRegionId = table.max("regions", 'id');
memory.setAttr('maxRegionId', maxRegionId);
```

Нахождение максимального значения в поле **id** в таблице **regions** с **id больше нуля**:

```JavaScript
var maxRegionId = table.max("regions", 'id', [["id", ">", 0]]);
memory.setAttr('maxRegionId', maxRegionId);
```

# Методы для строки полученной через метод table



# item.update()

### Обновление записи

```JavaScript
item.update(array|object $data)
```

##### Описание:

Изменяет значение указанной записи item в таблице.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-dat" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">data</td><td style="width: 33.3745%; height: 29.7969px;">array | object ( json{} )</td><td style="width: 33.3745%; height: 29.7969px;">Значения | значение записи</td></tr></tbody></table>

##### Возвращает:

**bool** - подтверждение удачного изменения записи.

##### Пример:

Обновление записи **item**:

```JavaScript
var items = table.find('regions');
var item = items[0];

item.update({"name": item.name, "num": 77});
```

# item.delete()

### Удаление записи

```
item.delete()
```

##### Описание:

Удаляет указанную запись item в таблице.

##### Возвращает:

**bool** - подтверждение удачного удаления записи.

##### Пример:

Удаление всех записей из таблицы:

```JavaScript
var items = table.find('regions');

for(var i = 0; i < items.length; i++) {
  items[i].delete();
}
```

# item.getDateFormatted()

### Получить форматированную дату по названию поля

```JavaScript
item.getDateFormatted(string $fieldName, string $toFormat = 'Y-m-d H:i:s', string|null $toTimeZone = null, string|null $fromTimeZone = null)
```

##### Описание:

Возвращает значение даты измененного формата из запрашиваемого поля.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-fie" style="border-collapse: collapse; width: 100%; height: 305.719px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2909%; height: 46.5938px;">fieldName</td><td style="width: 33.2909%; height: 46.5938px;">string</td><td style="width: 33.2948%; height: 46.5938px;">Наименование поля из которого будет браться значение</td></tr><tr style="height: 169.734px;"><td style="width: 33.2909%; height: 169.734px;">toFormat</td><td style="width: 33.2909%; height: 169.734px;">string</td><td style="width: 33.2948%; height: 169.734px;">Формат даты, например: 'Y-m-d H:i:s' (Y - год;

 m - месяц;

 d - день;

 H - часы;

 i - минуты;

 s - секунды.)

</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">toTimeZone</td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;">Часовой пояс в ответе</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">fromTimeZone</td><td style="width: 33.2909%; height: 29.7969px;">string|null</td><td style="width: 33.2948%; height: 29.7969px;">Часовой пояс в запросе</td></tr></tbody></table>

##### Возвращает:

**string** -

или

**null** - если дата не требует форматирования.

##### Пример:

Возвращает значение даты измененного формата из поля **create**:

```JavaScript
var date = item.getDateFormatted('create', 'd-m-Y H:i:s', 'Y-m-d H', 'UTC', '+3');
```

# item.getDateFormattedString()

### Получить форматированную дату из произвольной строки

```JavaScript
item.getDateFormattedString(string $date, string $toFormat = 'Y-m-d H:i:s', string|null $fromFormat = 'Y-m-d H:i:s', string|null $toTimeZone = null, string|null $fromTimeZone = null)
```

##### Описание:

Меняет формат введенной даты.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-dat-0" style="border-collapse: collapse; width: 100%; height: 352.297px;"><tbody><tr style="background-color: #ced4d9; height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">Имя</td><td style="width: 33.3745%; height: 29.7969px;">Тип</td><td style="width: 33.3745%; height: 29.7969px;">Описание</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">date</td><td style="width: 33.3745%; height: 35.3906px;">string</td><td style="width: 33.3745%; height: 35.3906px;">Дата

</td></tr><tr style="height: 192.125px;"><td style="width: 33.3745%; height: 192.125px;">toFormat</td><td style="width: 33.3745%; height: 192.125px;">string</td><td style="width: 33.3745%; height: 192.125px;">Формат даты в ответе, например:

'Y-m-d H:i:s'

(Y - год;

 m - месяц;

 d - день;

 H - часы;

 i - минуты;

 s - секунды.)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3745%; height: 35.3906px;">fromFormat</td><td style="width: 33.3745%; height: 35.3906px;">string|null</td><td style="width: 33.3745%; height: 35.3906px;">Формат даты в запросе

</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">toTimeZone</td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;">Часовой пояс в ответе</td></tr><tr style="height: 29.7969px;"><td style="width: 33.3745%; height: 29.7969px;">fromTimeZone</td><td style="width: 33.3745%; height: 29.7969px;">string|null</td><td style="width: 33.3745%; height: 29.7969px;">Часовой пояс в запросе</td></tr></tbody></table>

##### Возвращает:

**string** -

или

**null** - если дата не требует форматирования.

##### Пример:

```JavaScript
var date = item.getDateFormattedString('2022-02-01 12', 'd-m-Y H:i:s', 'Y-m-d H', 'UTC', '+3');
```

Возвращает 01-02-2022 09:00:00

# item.reload()

### Перезагрузить данные записи из бд

```
item.reload()
```

##### Описание:

Перезагружает значение записи из бд в таблицу.

##### Возвращает:

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

##### Пример:

Перезагрузка всех записей таблицы:

```JavaScript
var items = table.find('regions');

for(var i = 0; i < items.length; i++) {
  items[i].reload();
}
```

# Методы для строки полученной через getLastRequest



# request.

### Доступ к json параметрам

```
request.json
request.array
request.string
```

или

```
request.asJson()
request.asArray()
request.asString()
```

##### Описание:

Доступ к json параметрам в виде javascript json-обьекта, например для использования как request.json.name или в виде массива request.array\['name'\] или в виде json объекта соответственно. request — нужен чтобы знать точно что именно в текущем запросе прилетели параметры, а не были сохранены в атрибуты лида, например неделю назад.

<p class="callout info">.json/.array/.string — это синонимы и по факту вызывают функции</p>

<p class="callout warning">request — это параметры текущего request запроса</p>

# last_request.

### Доступ к последнему реквесту

```
last_request.json
last_request.array
last_request.string
```

или

```
last_request.asJson()
last_request.asArray()
last_request.asString()
```


##### Описание:

Доступ к последним json параметрам сохраненным в атрибутах лида в виде javascript json-обьекта, например для использования как request.json.name или в виде массива request.array\['name'\] или в виде json объекта соответственно. В лид параметры будут сохранены в json атрибут лида (sys\_last\_script\_request\_params).

# Примеры использования методов



# Использование методов блокировок

Ниже представлен JS скрипт на примере которого будет рассмотрена работа с методами блокировок.

```JavaScript
bot.sendText('Ожидаю получения блокировки')

let lockName = 'my_lock_1'
let lockPrefix = ''
let ttlSec = 5 // время жизни блокировки
let maxWaitSec = 300 // макс время ожидания блокировки

let isLocked = false
// Получаем блокировку по бизнесу (bot.waitForBusinessLock) или боту (bot.waitForBotLock)
isLocked = bot.waitForBusinessLock(lockName, lockPrefix, ttlSec, maxWaitSec) 
if (isLocked) {
  bot.sendText('Блокировка получена')
} else {
  bot.sendText('Время ожидания блокировки истекло')
}

bot.sendText('Ожидаю истечения блокировки и получаю новую')

//bot.releaseAllCurrentLocks()

ttlSec = 20
maxWaitSec = 1 // если раскомментировать то время ожидания будет превышено 
               // (если проверять превышение то закомментировано выше должно быть maxWaitSec)

// Повторно, получаем новую блокировку по бизнесу с тем же ключем
isLocked = bot.waitForBusinessLock(lockName, lockPrefix, ttlSec, maxWaitSec)
if (isLocked) {
  bot.sendText('Повторная блокировка получена')
} else {
  bot.sendText('Время ожидания повторной блокировки истекло')
}

// Блокировка получена или время ожидания истекло
bot.sendText('Блокировка получена')

// --------------

bot.sendText('Ищем и удаляем блокировку')

let hasLock = bot.hasLockForBusiness(lockName)

if (hasLock) {
  // Удаляем блокировку
  // по бизнесу - bot.releaseLockForBusiness / по боту - bot.releaseLockForBot
  // на самом деле это не releaseLock а forceReleaseLock (тк можно разрблокировать даже если ее тут не получали)
  // но зато это гарантирует удаление блокировки, поэтому префикс force в начале убран
  // для удаления же блокировки по тек скрипту можно использовать bot.releaseCurrentLock(lockName) или bot.releaseAllCurrentLocks()
  //if (bot.releaseLockForBusiness(lockName)) {
  
  // Вариант чтобы случайно не удалить блокировку, если мы ее не созадли в текущем скрипте
  // Например истекло время ожидания получения блокировки (maxWaitSec)
  // bot.releaseCurrentLockForBusiness / bot.releaseCurrentLockForBot
  if (bot.releaseCurrentLockForBusiness(lockName)) {
    bot.sendText('Блокировка удалена')
  } else {
    bot.sendText('Ошика удаления блокировки')
  }
} else {
  bot.sendText('Блокировка не найдена')
}

// Удаляем блокировку если она получена именно в данном скрипте (через waitForBusinessLock / waitForBotLock)
// Скрипт сам запоминает какие мы блокировки создавали в данном скрипте и удаляем ее только если создали тут
//bot.releaseCurrentLock(lockName)

// На всякий случай
// Удаляем все блокировки полученные именно в данном скрипте
// Скрипт сам запоминает какие мы блокировки создавали в данном скрипте и удаляем их все, которые мы тут создали
bot.releaseAllCurrentLocks()

bot.sendText('Дополнительно, почистили все блокировки созданные в данном скрипте, на случай, если что-то забыли...')
```

# Использование методов планирования времени

Установить время задержки для выполнения функции можно двумя способами:

- Метод **setTimeout()**;
- Задерживающий декоратор **delay()**.

Они позволяют вызвать функцию один раз через определённый интервал времени.

### setTimeout()

```JavaScript
setTimeout($func, int $delay, $arg1, $arg2, ...)
```

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><tbody><tr style="height: 29.7969px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7969px;">Имя</td><td style="width: 33.2909%; height: 29.7969px;">Тип</td><td style="width: 33.2948%; height: 29.7969px;">Описание</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2909%; height: 29.7969px;">func</td><td style="width: 33.2909%; height: 29.7969px;">function</td><td style="width: 33.2948%; height: 29.7969px;">Вызываемая функция</td></tr><tr><td style="width: 33.2909%;">delay</td><td style="width: 33.2909%;">int</td><td style="width: 33.2948%;">Задержка перед запуском в миллисекундах. Значение по умолчанию – 0</td></tr><tr><td style="width: 33.2909%;">arg1, arg2, ...</td><td style="width: 33.2909%;">mixed</td><td style="width: 33.2948%;">Аргументы, передаваемые в функцию</td></tr></tbody></table>

##### Пример:

```JavaScript
function sayHi(phrase, who) {
  lead.setAttr('sayHi', phrase + ', ' + who);
}

setTimeout(sayHi, 1000, "Привет", "Джон");
```

или

```JavaScript
setTimeout("lead.setAttr('sayHi', 'Привет!')", 1000);
```

Отмена таймера:

```JavaScript
let timerId = setTimeout(...);
clearTimeout(timerId);
```

### delay()

```
delay($f, int $ms)
```

##### Aтрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-f-f" style="border-collapse: collapse; width: 100%; height: 152.269px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">f</td><td style="width: 33.2909%; height: 29.7917px;">function</td><td style="width: 33.2948%; height: 29.7917px;">Вызываемая функция</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">ms</td><td style="width: 33.2909%; height: 63.1482px;">int</td><td style="width: 33.2948%; height: 63.1482px;">Задержка перед запуском в миллисекундах</td></tr></tbody></table>

##### Пример:

```JavaScript
function sayHi(text) {
  lead.setAttr('sayHi', text);
}

let f1000 = delay(sayHi, 1000);

f1000("Привет!");
```

# Использование методов работы с файлами

Ниже представлен JS скрипт на примере которого будет рассмотрена работа с файлами.

```JavaScript
// ---------------------------------------------------------------------------------------------------
// ПОДГОТОВКА КОМПОНЕНТА, ПЕРЕЧИСЛЕНИЕ ВСЕХ ПАРАМЕТРОВ
let imageUploader = {
  "params": {
    "max_file_size_mb": null,
    "min_image_width": null,
    "min_image_height": null,
    "promt_message": null,
    "promt_keyboard": null,
    "btn_cancel_caption": null,
    "btn_cancel_no_inline_label_code": null,
    "btn_ok_caption": null,
    "fallback_message": null,
    "success_message": null,
    "files_custom_table_name": null,
    "api_additional_params": null,
    "script_code_for_files_is_not_supported": null,

    // Параметры внутренней логики
    "is_first_immediate_call": false,
    "image_info": null,
    "new_image_url": null,
    "image_upload_result": null,
    "old_image_url": null,
    "telegram_file_id": null
  }
}
// ---------------------------------------------------------------------------------------------------

// ---------------------------------------------------------------------------------------------------
// ПОДГОТОВКА ЗНАЧЕНИЙ ПО УМОЛЧАНИЮ
// Максимальный размер файла в Мб
imageUploader.params.max_file_size_mb = 2

// Минимальная ширина изображения
// если 0 - то нет ограничения
// если включаем данную опцию то фото принимаем только с включенной галкой телеграмма "Сжать изображением"
imageUploader.params.min_image_width = 0

// Минимальная высота изображения
// если 0 - то нет ограничения
// если включаем данную опцию то фото принимаем только с включенной галкой телеграмма "Сжать изображением"
imageUploader.params.min_image_height = 0

// Сообщение-вопрос
imageUploader.params.promt_message = null // для вычисления используйте функцию this.calcPromtMessage()

imageUploader.params.promt_keyboard = null // для вычисления используйте функцию this.calcPromtKeyboard()

// Заголовки единственного пункта меню
// (одна кнопка но у нее меняется заголовок, в зависимости от того приняли мы хоть одно фото или нет)
imageUploader.params.btn_cancel_caption = "Отмена"
// Код кнопки, если inline режим выключен
imageUploader.params.btn_cancel_no_inline_label_code = "1"
imageUploader.params.btn_ok_caption = "Готово"

// Nекст отправляемый лиду, если входящий вебхук не содержит изображения
// Если нужно сложное вычисление - то модифицировать функцию this.calcFallbackMessage()
imageUploader.params.fallback_message = "<b>Изображение не распознано</b>" +
    "\r\n\r\n<i>Повторите попытку...</i>"

// Текст отправляемый в случае успешного сохранения фото
// для вычисления используйте функцию this.calcSuccessMessage()
imageUploader.params.success_message = null

//imageUploader.params.success_message = "<b>Изображение распознано</b>" +
//    "\r\n\r\nОжидаем следующий файл" +
//    "\r\n\Если надоело, нажмите " + '"'  + this.getBtnOkCaption() + '"' + "..."

// Название кастомной таблицы куда сохраняем ссылки на фото
imageUploader.params.files_custom_table_name = "person_files"

// Дополнительные параметры отправляемые в Телеграм (что сдесь укажем то и будет отправлено в POST запросе к Telegram)
imageUploader.params.api_additional_params = {"parse_mode": "HTML", "disable_web_page_preview": true}

imageUploader.params.script_code_for_files_is_not_supported = "files_is_not_supported"
// ---------------------------------------------------------------------------------------------------

// ---------------------------------------------------------------------------------------------------
// ПОДГОТОВКА МЕТОДОВ ДЛЯ ДОСТУПА К ПАРАМЕТРАМ (Getters & Setters)
// Обязательно описываем методы для всех параметров, чтобы их можно было перекрывать извне
imageUploader.getMaxFileSizeMb = function() {
  return this.params.max_file_size_mb
}
imageUploader.setMaxFileSizeMb = function(maxFileSizeMb) {
  this.params.max_file_size_mb = maxFileSizeMb
  return this
}

imageUploader.getMinImageWidth = function() {
  return this.params.min_image_width
}
imageUploader.setMinImageWidth = function(minImageWidth) {
  this.params.min_image_width = minImageWidth
  return this
}

imageUploader.getMinImageHeight = function() {
  return this.params.min_image_height
}
imageUploader.setMinImageHeight = function(minImageHeight) {
  this.params.min_image_height = minImageHeight
  return this
}

imageUploader.getPromtMessage = function() {
  return this.params.promt_message
}
imageUploader.setPromtMessage = function(promtMessage) {
  this.params.promt_message = promtMessage
  return this
}

imageUploader.getPromtKeyboard = function() {
  return this.params.promt_keyboard
}
imageUploader.setPromtKeyboard = function(promtKeyboard) {
  this.params.promt_keyboard = promtKeyboard
  return this
}

imageUploader.getBtnCancelCaption = function() {
  return this.params.btn_cancel_caption
}
imageUploader.setBtnCancelCaption = function(btnCancelCaption) {
  this.params.btn_cancel_caption = btnCancelCaption
  return this
}

imageUploader.getBtnCancelNoInlineLabelCode = function() {
  return this.params.btn_cancel_no_inline_label_code
}
imageUploader.setBtnCancelNoInlineLabelCode = function(btnCancelNoInlineLabelCode) {
  this.params.btn_cancel_no_inline_label_code = btnCancelNoInlineLabelCode
  return this
}

imageUploader.getBtnOkCaption = function() {
  return this.params.btn_ok_caption
}
imageUploader.setBtnOkCaption = function(btnOkCaption) {
  this.params.btn_ok_caption = btnOkCaption
  return this
}

imageUploader.getFallbackMessage = function() {
  return this.params.fallback_message
}
imageUploader.setFallbackMessage = function(fallbackMessage) {
  this.params.fallback_message = fallbackMessage
  return this
}

imageUploader.getSuccessMessage = function() {
  return this.params.success_message
}
imageUploader.setSuccessMessage = function(successMessage) {
  this.params.success_message = successMessage
  return this
}

imageUploader.getFilesCustomTableName = function() {
  return this.params.files_custom_table_name
}
imageUploader.setFilesCustomTableName = function(filesCustomTableName) {
  this.params.files_custom_table_name = filesCustomTableName
  return this
}

imageUploader.getApiAdditionalParams = function() {
  return this.params.api_additional_params
}
imageUploader.setApiAdditionalParams = function(apiAdditionalParams) {
  this.params.api_additional_params = apiAdditionalParams
  return this
}

imageUploader.getScriptCodeForFilesIsNotSupported = function() {
  return this.params.script_code_for_files_is_not_supported
}
imageUploader.setScriptCodeForFilesIsNotSupported = function(scriptCodeForFilesIsNotSupported) {
  this.params.script_code_for_files_is_not_supported = scriptCodeForFilesIsNotSupported
  return this
}

imageUploader.getIsFirstImmediateCall = function() {
  this.params.is_first_immediate_call = isFirstImmediateCall // GLOBAL VARIABLE !!!

  return this.params.is_first_immediate_call
}
imageUploader.setIsFirstImmediateCall = function(isFirstImmediateCall) {
  this.params.is_first_immediate_call = isFirstImmediateCall
  return this
}

imageUploader.getImageInfo = function() {
  return this.params.image_info
}
imageUploader.setImageInfo = function(imageInfo) {
  this.params.image_info = imageInfo
  return this
}

imageUploader.getOldImageUrl = function() {
  return this.params.old_image_url
}
imageUploader.setOldImageUrl = function(oldImageUrl) {
  this.params.old_image_url = oldImageUrl
  return this
}

imageUploader.getNewImageUrl = function() {
  return this.params.new_image_url
}
imageUploader.setNewImageUrl = function(newImageUrl) {
  this.params.new_image_url = newImageUrl
  return this
}

imageUploader.getImageUploadResult = function() {
  return this.params.image_upload_result
}
imageUploader.setImageUploadResult = function(imageUploadResul) {
  this.params.image_upload_result = imageUploadResul
  return this
}

imageUploader.getTelegramFileId = function() {
  return this.params.telegram_file_id
}
imageUploader.setTelegramFileId = function(telegramFileId) {
  this.params.telegram_file_id = telegramFileId
  return this
}


// ---------------------------------------------------------------------------------------------------

// ---------------------------------------------------------------------------------------------------
// ПОДГОТОВКА МЕТОДОВ ДЛЯ БИЗНЕС ЛОГИКИ

imageUploader.calcPromtMessage = function() {
  // Todo: this.params.promt_message -> можно использовать для задания шаблона сообщения и добавить сюда макроподстановку

  let maxFileSizeMb = this.getMaxFileSizeMb()
  let minImageWidth = this.getMinImageWidth()
  let minImageHeight = this.getMinImageHeight()

  let msg = "<b>Отправьте ваше фото</b>"+
    (maxFileSizeMb > 0 ? ("\r\n\r\n<i>Размер фото: не более " + maxFileSizeMb + " Мб</i>") : "") +
    (minImageWidth > 0 ? ("\r\n<i>Ширина: не менее " + minImageWidth + " px</i>") : "") +
    (minImageHeight > 0 ? ("\r\n<i>Высота: не менее " + minImageHeight + " px</i>") : "")

  return msg
}

imageUploader.calcSuccessMessage = function() {
  return "<b>Изображение распознано</b>" +
    "\r\n\r\nОжидаем следующий файл" +
    "\r\n\Если надоело, нажмите " + '"'  + this.getBtnOkCaption() + '"' + "..."
}

// Вычисление сообщения о невалидных данных
imageUploader.calcFallbackMessage = function() {
  return this.getFallbackMessage()
}

// Вычисление заголовка единственного пункта меню
imageUploader.calcBtnCancelCaption = function() {
  if (!this.isAnyImagesReceived()) {
    return this.getBtnCancelCaption()
  } else {
    return this.getBtnOkCaption()
  }
}

// Вычисление кнопок меню
imageUploader.calcPromtKeyboard = function() {
  return [
    [
      {
        "text": this.calcBtnCancelCaption(),
        "callback_data": "btn_cancel",
        "text_button_label": this.getBtnCancelNoInlineLabelCode()
      },
    ]
  ]
}

imageUploader.calcInvalidFileSizePromtMessage = function(yourFileSizeMb) {
  return "Файл не соответствуют требованию: "+
      "\r\nРазмер файла не более " + this.getMaxFileSizeMb() + " Мб." +
      "\r\nРазмер вашего файла: " + yourFileSizeMb +
      "\r\n\r\n" +
      this.calcPromtMessage()
}

imageUploader.calcInvalidWidthOrHeightPromtMessage = function(yourWidth, yourHeight) {
  return "Файл не соответствуют требованиям ширины или высоты, или изображение не распознано" +
    "\r\nШирина вашего фото: " + yourWidth +
    "\r\nВысота вашего фото: " + yourHeight +
    "\r\n\r\n" +
    '<b>При отправке фото через Telegram включите галку "Сжать изображение"</b>' +
    "\r\n\r\n" +
    this.calcPromtMessage()
}

// Получить атрибут "ID последнего сообщения отправленного в Telegram"
imageUploader.getLastTelegramMessageId = function() {
  return parseInt(lead.getAttr("last_telegram_message_id"))
}

// Есть ли сохраненный атрибут "ID последнего сообщения отправленного в Telegram"
imageUploader.hasLastTelegramMessageId = function() {
  let messageId = this.getLastTelegramMessageId()
  return (!isNaN(messageId) && messageId > 0)
}

// Сохраненить атрибут "ID последнего сообщения отправленного в Telegram"
imageUploader.saveLastTelegramMessageId = function() {
  lead.setAttr("last_telegram_message_id", bot.getTelegramLastMessageId())
}

// Очистить атрибут "ID последнего сообщения отправленного в Telegram"
imageUploader.clearLastTelegramMessageId = function() {
  lead.setAttr("last_telegram_message_id", null)
}

// Функция для скрытия кнопок предыдущего меню
imageUploader.removeInlineKeyboard = function() {
  if (this.hasLastTelegramMessageId()) {
    bot.removeTelegramInlineKeyboard(lead.getData("identification"), this.getLastTelegramMessageId())
  }
}

// Функция для удаления предыдущего сообщения
imageUploader.deletePrevMessage = function() {
  if (this.hasLastTelegramMessageId()) {
    this.removeInlineKeyboard()

    // Можно это делать в окне в 24 часа
    bot.sendMessage("---", null, null, {"endpoint": "deleteMessage", "message_id": this.getLastTelegramMessageId()})

    this.clearLastTelegramMessageId()
  }
}

// Функция для определения получили ли мы хоть одно валидное фото в данной команде
imageUploader.isAnyImagesReceived = function() {
  let res = parseInt(lead.getAttr("is_any_image_received"))
  res = !isNaN(res) && res > 0
  return res
}

// Функция для сохранения состояния - получили ли мы хоть одно валидное фото в данной команде
imageUploader.setIsAnyImagesReceived = function(value) {
  lead.setAttr("is_any_image_received", value)
}

// Функция для отправки вопроса с меню
imageUploader.sendPromtMessageWithMenu = function(argPromtMessage, argPromtKeyboard, argAttachments){
  // Скрываем кнопки предыдущего меню
  this.removeInlineKeyboard()

  if (typeof argPromtMessage == "undefined") {
    argPromtMessage = this.calcPromtMessage()
  }

  if (typeof argPromtKeyboard == "undefined") {
    argPromtKeyboard = this.calcPromtKeyboard()
  }
  
  if (typeof argAttachments == "undefined") {
    argAttachments = null
  }

  // Отправляем кнопки с текстом вопроса
  //bot.sendButtons(
  //  argPromtMessage,
  //  argPromtKeyboard,
  //  this.getApiAdditionalParams()
  //)

  // Отправляем сообщение с кнопками
  bot.sendMessage(
    argPromtMessage,
    argPromtKeyboard,
    argAttachments,
    this.getApiAdditionalParams()
  )

  // Запоминаем ID последнего сообщения
  this.saveLastTelegramMessageId()
}

// Сохранение файла в кастомную таблицу
imageUploader.saveFileToCustomTable = function(data) {
  let tableName = this.getFilesCustomTableName()

  if (tableName === null || tableName === "") {
    return
  }

  table.createItem(tableName, data)
}

// Создаем персону для лида, если ее еще нет
imageUploader.checkPersonForCurrentLeadAndGetCommandResult = function() {
  if (!lead.getPersonId()) {
      lead.createPersonForCurrentLead({"comment": null})
  }

  if (!lead.getPersonId()) {
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForFilesIsNotSupported()
    }
  }

  return null
}

// Если канал лида - не телеграм, то перекидываем в другой скрипт, сообщающий о том что команда запроса файла не поддерживается
imageUploader.checkChannelAndGetCommandResult = function() {
  if (lead.getChannelCode() !== "telegram") {
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForFilesIsNotSupported()
    }
  }

  return null
}

// Для ограничения максимального размера файла
imageUploader.validateFileSizeAndGetCommandResult = function(imagePayload) {
    let maxFileSizeMb = this.getMaxFileSizeMb()
    let isIncorrectFileSize = false
    if (maxFileSizeMb > 0) {
        if (!imagePayload["file_size"] || imagePayload["file_size"] > maxFileSizeMb*1024*1024) {
          isIncorrectFileSize = true
        }
    }

    if (isIncorrectFileSize) {
      // Превышен максимальный размер файла

      let yourFileSizeMb = "не определен"
      if (imagePayload["file_size"]) {
        // Конвертируем байты в Мб
        yourFileSizeMb = imagePayload["file_size"] / 1024 / 1024

        // Округляем до второго знака
        yourFileSizeMb = Math.round(yourFileSizeMb * 100) / 100

        yourFileSizeMb = yourFileSizeMb + " Мб"
      }

      // Повторяем вопрос и меню
      this.sendPromtMessageWithMenu(this.calcInvalidFileSizePromtMessage(yourFileSizeMb))

      // Выходим из Callback (ждем пока пришлют другой файл)
      return {
        "result": false,
      }
    }

    return null
}

// Для ограничения ширины и высоты изображения
//   рабатает, только если фото отправлено с включенной галкой сжатия
imageUploader.validateFileWidthAndHeightAndGetCommandResult = function(imagePayload) {
  let minImageWidth = this.getMinImageWidth()
  let minImageHeight = this.getMinImageHeight()

  let isIncorrectWidth = (minImageWidth > 0 && (!imagePayload['width'] || imagePayload['width'] < minImageWidth))
  let isIncorrectHeight = (minImageHeight > 0 && (!imagePayload['height'] || imagePayload['height'] < minImageHeight))

  if (isIncorrectWidth || isIncorrectHeight) {
    // Файл не соответствуют требованиям ширины или высоты

    let yourWidth = "Не определено"
    if (imagePayload['width']) {
      yourWidth = imagePayload['width'] * 1
    }

    let yourHeight = "Не определено"
    if (imagePayload['width']) {
      yourHeight = imagePayload['height'] * 1
    }

    // Повторяем вопрос и меню
    this.sendPromtMessageWithMenu(this.calcInvalidWidthOrHeightPromtMessage(yourWidth, yourHeight))

    // Выходим из Callback (ждем пока пришлют другой файл)
    return {
      "result": false,
    }
  }

  return null
}

// Загружаем файл на CDN и получаем новый URL, если возникла ошибка, выводим ее, обновляем меню и выходим из Callback
imageUploader.uploadFileToCdnAndGetCommandResult = function(oldImageUrl) {
  this.setNewImageUrl(null)
  this.setImageUploadResult(null)

  let uploadResult = bot.uploadFileToCdnAndGetNewUrl(oldImageUrl)
  this.setImageUploadResult(uploadResult)

  let newImageUrl = null
  if (uploadResult.result && !uploadResult.error) {
    newImageUrl = uploadResult.url
    this.setNewImageUrl(newImageUrl)
  } else {
    // Если возникла ошибка, выводим ее и далее по куду - выходим из Callback
    if (uploadResult.error_message) {
      bot.sendMessage(uploadResult.error_message)
    }

    // Повторяем вопрос и меню
    this.sendPromtMessageWithMenu()

    // Выходим из Callback (ждем пока пришлют другой файл)
    return {
      "result": false,
    }
  }

  return null
}

// Для входящего текста: если написали "отмена"/"пропустить"
// Или для кнопок: нажали на кнопку "отмена" или написали 1, для режима работы без inline кнопок (inline кнопки отключаются в настройках канала)
imageUploader.checkIncomingMessageForNoImagesAndGetResult = function() {
  if (["отмена", "пропустить", "btn_cancel", "1"].includes(bot.getIncomingMessage().toLowerCase())) {
    // Удаляем предыдущее меню, если оно есть
    this.removeInlineKeyboard()

    // Для логики с удалением предыдущего сообщения
    // для реализации учесть все цепочки, т.е. можно сделать полноценный графический компонент как слайдер, чтобы вся обработка была в одном сообщении
    //deletePrevMessage()

    // Выходим из команды и прерываем зацикливание
    return {
      "break": true,
    }
  }

  return null
}

// Сохраняем ссылку на файл в таблицу
// Уведомляем клиента о том что фото загружено
// Пересылаем загруженно фото Лиду
// Повторяем вопрос и меню
// Выходим из callback, но не прерываем команду, ожидаем следующий файл
// ВЫНЕСЕНО В ФУНКЦИЮ - ЧТОБЫ МОЖНО БЫЛО ПЕРЕКРЫВАТЬ ЕЕ ИЗВНЕ
imageUploader.runOnSuccessLogicAndGetResult = function() {
  let telegramFileId = this.getTelegramFileId()
  let newImageUrl = this.getNewImageUrl()
    
  // Сохраняем ссылку на файл в таблицу
  this.saveFileToCustomTable({
    "person_id": lead.getPersonId(),
    "lead_id": leadId,
    "telegram_file_id": telegramFileId,
    "type": "image",
    "file_name": null,
    "url": newImageUrl,
    "size": null,
    "mime_type": null,
  })

  // Уведомляем клиента о том что фото загружено
  // Пересылаем загруженно фото Лиду
  // Todo: Вынести в параметры компонента - но с учетом макроса для newImageUrl
  let msg = "<b>Ваше фото успешно загружено</b>\r\n<a href='" + newImageUrl + "'>Ссылка на загруженное фото</a>"
  // Вариант: Для отправки отдельно фото и отдельно сообщения с меню
  bot.sendMessage(msg, null, [{"type": "image", "url": newImageUrl}], this.getApiAdditionalParams())
  // Повторяем вопрос и меню
  this.sendPromtMessageWithMenu(this.calcSuccessMessage())

  // Вариант: Для отправки полученного фото и вопроса одним сообщением
  // Повторяем вопрос и меню
  //sendPromtMessageWithMenu(successMessage + "\r\n\r\n" + msg, null, [{"type": "image", "url": newImageUrl}])

  // Выходим из callback, но не прерываем команду, ожидаем следующий файл
  return {
    "result": false,
  }
}

// Повторяем вопрос и меню
// Выходим из JS, но не прерываем замыкание, ожидаем следующий файл
// ВЫНЕСЕНО В ФУНКЦИЮ - ЧТОБЫ МОЖНО БЫЛО ПЕРЕКРЫВАТЬ ЕЕ ИЗВНЕ
imageUploader.runOnNoImagesLogicAndGetResult = function() {
  // Повторяем вопрос и меню
  this.sendPromtMessageWithMenu(this.calcFallbackMessage())

  // Выходим из JS, но не прерываем замыкание, ожидаем следующий файл
  return {
    "result": false,
  }
}

// ---------------------------------------------------------------------------------------------------
// Метод для вычисления результата
// Результат будет передан в команду "Выполнить JavaScript CallBack" с замыканием состояния
imageUploader.getComponentResult = function() {
  let checkPersonResult = this.checkPersonForCurrentLeadAndGetCommandResult()
  if (checkPersonResult !== null) {
    return checkPersonResult
  }

  let checkChannelResult = this.checkChannelAndGetCommandResult()
  if (checkChannelResult !== null) {
    return checkChannelResult
  }

  // ---------------------------------------------------------------------------------------------------
  // Инициализация компонента
  if (this.getIsFirstImmediateCall()) {
    // !!! ИНИЦИАЛИЗАЦИЯ !!!

    // Запоминаем что фото еще не получено, чтобы определять, какое меню выводить
    this.setIsAnyImagesReceived(0)

    // Сбрасываем ID последнего сообщения
    this.clearLastTelegramMessageId()

    // Отправляем вопрос и меню
    this.sendPromtMessageWithMenu()

    // Выходим из JS, в параметрах ничего не возвращаем, тк это инициализация
    return {}
  }
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // Получаем фото из входящего вебхука
  let images = bot.getImages()
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // ЛОГИКА КОМПОНЕНТА
  if (images.length > 0) {
    // Если прислали фото, обрабатываем его, иначе см. блок else

    // Получаем инфу о фото
    let imageInfo = images[0]
    let imagePayload = imageInfo["payload"]
    let oldImageUrl = imageInfo["url"]
    let telegramFileId = imageInfo["file_id"]

    this.setImageInfo(imageInfo)
    this.setOldImageUrl(oldImageUrl)
    this.setTelegramFileId(telegramFileId)
    
    // Для ограничения максимального размера файла
    let validateFileSizeResult = this.validateFileSizeAndGetCommandResult(imagePayload)
    if (validateFileSizeResult !== null) {
      return validateFileSizeResult
    }

    // Для ограничения ширины и высоты изображения
    //   рабатает, только если фото отправлено с включенной галкой сжатия
    let validateFileWidthAndHeightResult = (this.validateFileWidthAndHeightAndGetCommandResult(imagePayload))
    if (validateFileWidthAndHeightResult !== null) {
      return validateFileWidthAndHeightResult
    }


    // Загружаем файл на CDN и получаем новый URL, если возникла ошибка, выводим ее, обновляем меню и выходим из Callback
    let uploadFileToCdnResult = (this.uploadFileToCdnAndGetCommandResult(oldImageUrl))
    if (uploadFileToCdnResult !== null) {
      return uploadFileToCdnResult
    }

    // Запоминаем, что корректное фото получено
    this.setIsAnyImagesReceived(1)

    // Сохраняем ссылку на файл в таблицу
    // Уведомляем клиента о том что фото загружено
    // Пересылаем загруженно фото Лиду
    // Повторяем вопрос и меню
    // Выходим из callback, но не прерываем команду, ожидаем следующий файл
    // ВЫНЕСЕНО В ФУНКЦИЮ - ЧТОБЫ МОЖНО БЫЛО ПЕРЕКРЫВАТЬ ЕЕ ИЗВНЕ
    return this.runOnSuccessLogicAndGetResult()
  } else {
    // Если прислали НЕ фото

    let checkIncomingMessageResult = this.checkIncomingMessageForNoImagesAndGetResult()
    if (checkIncomingMessageResult !== null) {
      return checkIncomingMessageResult
    }

    // Повторяем вопрос и меню
    // Выходим из JS, но не прерываем замыкание, ожидаем следующий файл
    // ВЫНЕСЕНО В ФУНКЦИЮ - ЧТОБЫ МОЖНО БЫЛО ПЕРЕКРЫВАТЬ ЕЕ ИЗВНЕ
    return this.runOnNoImagesLogicAndGetResult()
  }
}

//Todo: Учесть мультиязычность!

module.exports = {
  imageUploader
}



Листинг компонента фото-слайдера для Telegram

const {unset, unsetButton} = require("Common.Utils.Arrays")

// ---------------------------------------------------------------------------------------------------// ПОДГОТОВКА КОМПОНЕНТА, ПЕРЕЧИСЛЕНИЕ ВСЕХ ПАРАМЕТРОВlet imageSlider = {
  "params": {
    "script_code_for_files_is_not_supported": null,
    "script_code_for_person_files_is_empty": null,
    "script_code_for_main_menu": null,
    "files_custom_table_name": null,

    // Параметры внутренней логики
    "is_first_immediate_call": false,
  }
}
// ---------------------------------------------------------------------------------------------------// ---------------------------------------------------------------------------------------------------// ПОДГОТОВКА ЗНАЧЕНИЙ ПО УМОЛЧАНИЮ
imageSlider.params.script_code_for_files_is_not_supported = "files_is_not_supported"
imageSlider.params.script_code_for_person_files_is_empty = "main_menu"
imageSlider.params.script_code_for_main_menu = "main_menu"// Название кастомной таблицы откуда грузим фото
imageSlider.params.files_custom_table_name = "person_files"// ---------------------------------------------------------------------------------------------------// ---------------------------------------------------------------------------------------------------// ПОДГОТОВКА МЕТОДОВ ДЛЯ ДОСТУПА К ПАРАМЕТРАМ (Getters & Setters)// Обязательно описываем методы для всех параметров, чтобы их можно было перекрывать извне
imageSlider.getScriptCodeForFilesIsNotSupported = function() {
  return this.params.script_code_for_files_is_not_supported
}
imageSlider.setScriptCodeForFilesIsNotSupported = function(scriptCodeForFilesIsNotSupported) {
  this.params.script_code_for_files_is_not_supported = scriptCodeForFilesIsNotSupported
  return this
}

imageSlider.getScriptCodeForPersonFilesIsEmpty = function() {
  return this.params.script_code_for_person_files_is_empty
}
imageSlider.setScriptCodeForPersonFilesIsEmpty = function(scriptCodeForPersonFilesIsEmpty) {
  this.params.script_code_for_person_files_is_empty = scriptCodeForPersonFilesIsEmpty
  return this
}

imageSlider.getScriptCodeForMainMenu = function() {
  return this.params.script_code_for_main_menu
}
imageSlider.setScriptCodeForMainMenu = function(scriptCodeForMainMenu) {
  this.params.script_code_for_main_menu = scriptCodeForMainMenu
  return this
}

imageSlider.getFilesCustomTableName = function() {
  return this.params.files_custom_table_name
}
imageSlider.setFilesCustomTableName = function(filesCustomTableName) {
  this.params.files_custom_table_name = filesCustomTableName
  return this
}

imageSlider.getIsFirstImmediateCall = function() {
  this.params.is_first_immediate_call = isFirstImmediateCall // GLOBAL VARIABLE !!!

  return this.params.is_first_immediate_call
}
imageSlider.setIsFirstImmediateCall = function(isFirstImmediateCall) {
  this.params.is_first_immediate_call = isFirstImmediateCall
  return this
}
// ---------------------------------------------------------------------------------------------------// ---------------------------------------------------------------------------------------------------// Методы компонента// Текущая позиция слайдера
imageSlider.getSliderPos = function() {
  return lead.getAttr("slider_pos")*1
}

// Установить текущую позицию слайдера
imageSlider.setSliderPos = function(sliderPos) {
  lead.setAttr("slider_pos", sliderPos)
}

// Получить атрибут "ID последнего сообщения отправленного в Telegram"
imageSlider.getLastTelegramMessageId = function() {
  return parseInt(lead.getAttr("last_telegram_message_id"))
}

// Есть ли сохраненный атрибут "ID последнего сообщения отправленного в Telegram"
imageSlider.hasLastTelegramMessageId = function() {
  let messageId = this.getLastTelegramMessageId()
  return (!isNaN(messageId) && messageId > 0)
}

// Сохранить атрибут "ID последнего сообщения отправленного в Telegram"
imageSlider.saveLastTelegramMessageId = function() {
  lead.setAttr("last_telegram_message_id", bot.getTelegramLastMessageId())
}

// Очистить атрибут "ID последнего сообщения отправленного в Telegram"
imageSlider.clearLastTelegramMessageId = function() {
  lead.setAttr("last_telegram_message_id", null)
}

// Функция для скрытия кнопок предыдущего меню
imageSlider.removeInlineKeyboard = function() {
  if (this.hasLastTelegramMessageId()) {
    bot.removeTelegramInlineKeyboard(lead.getData("identification"), this.getLastTelegramMessageId())
  }
}

// Функция для удаления предыдущего сообщения (слайдера)
imageSlider.deletePrevMessage = function() {
  if (this.hasLastTelegramMessageId()) {
    this.removeInlineKeyboard() 

    // Можно это делать в окне в 24 часа
    bot.sendMessage("---", null, null, {"endpoint": "deleteMessage", "message_id": this.getLastTelegramMessageId()})

    this.clearLastTelegramMessageId()
  }
}

// Останавливаем анимацию ожидания на кнопке
imageSlider.answerCallbackQuery = function() {
    let callbackQueryId = null
    let webhookPayload = bot.getWebhookPayload()
    if (webhookPayload && webhookPayload['callback_query'] && webhookPayload['callback_query']['id']) {
      callbackQueryId = webhookPayload['callback_query']['id']
      if (typeof callbackQueryId == "string" && callbackQueryId.length > 0) {
          bot.sendPayload('answerCallbackQuery', {
            "callback_query_id": callbackQueryId, 
          })
      }
    }
}

// Создаем персону для лида, если ее еще нет
imageSlider.checkPersonForCurrentLeadAndGetCommandResult = function() {
  if (!lead.getPersonId()) {
      lead.createPersonForCurrentLead({"comment": null})
  }

  if (!lead.getPersonId()) {
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForFilesIsNotSupported()
    }
  }

  return null
}

// Если канал лида - не телеграм, то перекидываем в другой скрипт, сообщающий о том что команда запроса файла не поддерживается
imageSlider.checkChannelAndGetCommandResult = function() {
  if (lead.getChannelCode() !== "telegram") {
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForFilesIsNotSupported()
    }
  }

  return null
}
// ---------------------------------------------------------------------------------------------------// ---------------------------------------------------------------------------------------------------// Метод для вычисления результата// Результат будет передан в команду "Выполнить JavaScript CallBack" с замыканием состояния
imageSlider.getComponentResult = function() {
  // Создаем персону для лида, если ее еще нет
  let checkPersonResult = this.checkPersonForCurrentLeadAndGetCommandResult()
  if (checkPersonResult !== null) {
    return checkPersonResult
  }

  // Если канал лида - не телеграм, то перекидываем в другой скрипт, сообщающий о том что команда запроса файла не поддерживается
  let checkChannelResult = this.checkChannelAndGetCommandResult()
  if (checkChannelResult !== null) {
    return checkChannelResult
  }

  // ---------------------------------------------------------------------------------------------------
  // Инициализация компонента
  if (this.getIsFirstImmediateCall()) {
    // !!! ИНИЦИАЛИЗАЦИЯ !!!

    // Запоминаем что фото еще не получено, чтобы определять, какое меню выводить
    this.setSliderPos(0)

    // Сбрасываем ID последнего сообщения
    this.clearLastTelegramMessageId()
  }
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // ЛОГИКА КОМПОНЕНТА
  // ---------------------------------------------------------------------------------------------------
  
  // ---------------------------------------------------------------------------------------------------
  // Определяем, есть ли фото, если нет, то перекидываем в Главное меню
  let wc = [["person_id", lead.getPersonId()], ["type", "image"]] 

  let imagesCount = table.count(
    this.getFilesCustomTableName(), // tableName
    wc
  )

  if (!imagesCount) {
    bot.sendText("У вас нет загруженных фото! Сначала загрузите их!")

    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForPersonFilesIsEmpty()
    }
  }
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // Подготовка переменных
  let isAnyOtherMessageReceived = false
  let prevSliderPos = this.getSliderPos()

  let hasPrevPhoto = prevSliderPos > 0
  let hasNextPhoto = prevSliderPos < (imagesCount-1)

  // Для отладки:
  //bot.sendText(hasPrevPhoto + ":" + hasNextPhoto)
  //bot.sendText(imagesCount + ":" + prevSliderPos)
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // Обработка нажатых кнопок или входящего текста
  if (["btn_static_main_menu", "0"].includes(bot.getIncomingMessage().toLowerCase())) {
    // Удаляем предыдущее меню, если оно есть
    //this.removeInlineKeyboard()

    // Удаляем слайден, если он есть
    this.deletePrevMessage()

    // Выходим из команды
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForMainMenu(),
    }
  } else if (["btn_static_prev_photo", "1"].includes(bot.getIncomingMessage().toLowerCase())) {
    // Останавливаем анимацию ожидания на кнопке
    this.answerCallbackQuery()

    let _sliderPos = this.getSliderPos()
    if (hasPrevPhoto) {
      _sliderPos--
      hasPrevPhoto = _sliderPos > 0
      hasNextPhoto = _sliderPos < (imagesCount-1)     
    } else {
     // Фото закончились
    }
    this.setSliderPos(_sliderPos)
  }  else if (["btn_static_next_photo", "2"].includes(bot.getIncomingMessage().toLowerCase())) {
    // Останавливаем анимацию ожидания на кнопке
    this.answerCallbackQuery()

    let _sliderPos = this.getSliderPos()
    if (hasNextPhoto) {
      _sliderPos++
      hasPrevPhoto = _sliderPos > 0
      hasNextPhoto = _sliderPos < (imagesCount-1)      
    } else {
      // Фото закончились
    }
    this.setSliderPos(_sliderPos)
  } else {
    // Если получаем любое текстовое сообщение то лучше посылать фото не в том же сообщении, а в новом, 
    //   чтобы слайдер не уходил вверх в переписке
    //if (bot.getIncomingMessage() !== "") {
      isAnyOtherMessageReceived = true
    //} 
  }

  if (isAnyOtherMessageReceived) {
    this.deletePrevMessage()
  }
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // Выполнение запросов к кастомной таблице
  let sliderPos = this.getSliderPos()

  // Для отладки
  //bot.sendText(prevSliderPos + ":" + sliderPos)

  // Для отладки
  //bot.sendText(imagesCount + ":" + sliderPos)

  let limit = 1
  let offset = sliderPos
  let images
  let image

  //let loadImage = function () {
    imagesCount = table.count(
      this.getFilesCustomTableName(), // tableName
      wc
    )  

    images = table.find(
      this.getFilesCustomTableName(), // tableName
      null, // columns
      wc,
      null, // orderBy
      limit,
      offset
    )

    image = images[0]
  //}

  //loadImage()

  if (!images.length) {
    return {
      "break": true,
      "run_script_by_code": this.getScriptCodeForPersonFilesIsEmpty()
    }
  }
  // ---------------------------------------------------------------------------------------------------

  // ---------------------------------------------------------------------------------------------------
  // Отображение слайдера
  // ps: "_static_" - вхождение такого текста означает что платформа Метабот 
  //                  не будет автоматически удалять inlineKeyboard после приема вебхука с нажатием на кнопку
  let inlineKeyboard = [
    [
      {"text": "<<", "callback_data": "btn_static_prev_photo", "text_button_label": "1"},
      {"text": ">>", "callback_data": "btn_static_next_photo", "text_button_label": "2"},
    ], 
    [
      {"text": "Главное меню", "callback_data": "btn_static_main_menu", "text_button_label": "0"},
    ]
  ]

  // Удаление кнопок меню, если действие недоступно
  if (!hasPrevPhoto) {
    unsetButton(inlineKeyboard, "btn_static_prev_photo")
  }
  if (!hasNextPhoto) {
    unsetButton(inlineKeyboard, "btn_static_next_photo")
  }

  // Для отладки
  //bot.sendText(this.hasLastTelegramMessageId() + ":" + this.getLastTelegramMessageId())

  if (this.hasLastTelegramMessageId()) {
    if (prevSliderPos !== sliderPos) {
      newMedia = {"type": "photo", "media": image.url, "caption": "Фото #" + image.id}
      bot.sendMessage("---", inlineKeyboard, null, {"endpoint": "editMessageMedia", "message_id": this.getLastTelegramMessageId(), "media": newMedia})
      //this.saveLastTelegramMessageId()  // Тут этого делать не нужно! Тк тут мы обновляем существующее сообщение !
    }
  } else {
    bot.sendMessage("Фото #" + image.id, inlineKeyboard, [{"type": "image", "url": image.url}])
    this.saveLastTelegramMessageId()
  }

  return {
    "result": false,
  }
  // ---------------------------------------------------------------------------------------------------
}

//Todo: Учесть мультиязычность!module.exports = {
  imageSlider
}

```

# Методы api



# api.request()

### Выполнить HTTP запрос

```JavaScript
api.request(string $method, string $uri, $requestOptions = [], $httpClientConfig = [], $body = null, $jsonBody = null, $headers = [], bool $isForceAddJsonHeaders = false)
```

##### Описание:

Выполняет HTTP запрос, с помощью Guzzle.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 266.342px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.7917px;"><td style="width: 33.2909%; height: 29.7917px;">method</td><td style="width: 33.2909%; height: 29.7917px;">string</td><td style="width: 33.2948%; height: 29.7917px;">Метод запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Опции запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">httpClientConfig</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">body</td><td style="width: 33.2909%; height: 29.537px;">array|object|string|null</td><td style="width: 33.2948%; height: 29.537px;">Тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">jsonBody</td><td style="width: 33.2909%; height: 29.537px;">array|object|null</td><td style="width: 33.2948%; height: 29.537px;">JSON тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isForceAddJsonHeaders</td><td style="width: 33.2909%; height: 29.537px;">bool </td><td style="width: 33.2948%; height: 29.537px;">Добавление заголовков Json</td></tr></tbody></table>

##### Возвращает:

**mixed** — ответ запроса

или

**ResponseInterface** — объект Response

или

**null** — если таких данных не существует.

# api.post()

### Выполнить HTTP POST запрос

```JavaScript
api.post(string $uri, $body = [], $requestOptions = [], $headers = [], $httpClientConfig = [])
```

##### Описание:

Выполняет HTTP POST запрос, с помощью Guzzle.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Опции запроса</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">httpClientConfig</td><td style="width: 33.2909%; height: 63.1482px;">array|object</td><td style="width: 33.2948%; height: 63.1482px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">body</td><td style="width: 33.2909%; height: 29.537px;">array|object|null</td><td style="width: 33.2948%; height: 29.537px;">Тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr></tbody></table>

##### Возвращает:

**string** — ответ запроса в формате строки

или

**null** — если таких данных не существует.

# api.get()

### Выполнить HTTP GET запрос

```JavaScript
api.get(string $uri, $requestOptions = [], $headers = [], $httpClientConfig = [])
```

##### Описание:

Выполняет HTTP GET запрос, с помощью Guzzle.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Опции запроса</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">httpClientConfig</td><td style="width: 33.2909%; height: 63.1482px;">array|object</td><td style="width: 33.2948%; height: 63.1482px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr></tbody></table>

##### Возвращает:

**string** — ответ запроса в формате строки

или

**null** — если таких данных не существует.

# api.getJson()

### Выполнить HTTP GET запрос

```JavaScript
api.getJson(string $uri, $jsonBody = null, $headers = [], $requestOptions = [], $httpClientConfig = [])
```

##### Описание:

Выполняет HTTP GET запрос с jsonBody, с помощью Guzzle.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Опции запроса</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">httpClientConfig</td><td style="width: 33.2909%; height: 63.1482px;">array|object</td><td style="width: 33.2948%; height: 63.1482px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">jsonBody</td><td style="width: 33.2909%; height: 29.537px;">array|object|null</td><td style="width: 33.2948%; height: 29.537px;">Json тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr></tbody></table>

##### Возвращает:

**array** — ответ запроса в формате массива

или

**null** — если таких данных не существует.

# api.postJson()

### Выполнить HTTP POST запрос

```JavaScript
api.postJson(string $uri, $jsonBody = [], $headers = [], $requestOptions = [], $httpClientConfig = [])
```

##### Описание:

Выполняет HTTP POST запрос с jsonBody, с помощью Guzzle.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Опции запроса</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">httpClientConfig</td><td style="width: 33.2909%; height: 63.1482px;">array|object</td><td style="width: 33.2948%; height: 63.1482px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">jsonBody</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Json тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr></tbody></table>

##### Возвращает:

**array** — ответ запроса в формате массива

или

**null** — если таких данных не существует.

# api.getHttpConfig()

### Получить HTTP Config

```JavaScript
api.getHttpConfig()
```

##### Описание:

Возвращает HTTP Config.

##### Возвращает:

**array** — HTTP Config в формате массива.

# api.setHttpConfig()

### Установить HTTP Config

```JavaScript
api.setHttpConfig($config)
```

##### Описание:

Устанавливает HTTP Config.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">config</td><td style="width: 33.2909%; height: 29.537px;">array|object|string</td><td style="width: 33.2948%; height: 29.537px;">HTTP Config</td></tr></tbody></table>

##### Возвращает:

**array** — HTTP Config в формате массива.

# api.getRequestOptions()

### Получить параметры HTTP запроса

```JavaScript
api.getRequestOptions()
```

##### Описание:

Возвращает параметры HTTP запроса.

##### Возвращает:

**array** — параметры HTTP запроса в формате массива.

# api.setRequestOptions()

### Установить параметры HTTP запроса

```JavaScript
api.setRequestOptions($options)
```

##### Описание:

Устанавливает параметры HTTP запроса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">options</td><td style="width: 33.2909%; height: 29.537px;">array|object|string</td><td style="width: 33.2948%; height: 29.537px;">Параметры HTTP запроса</td></tr></tbody></table>

##### Возвращает:

**array** — параметры HTTP запроса в формате массива.

# api.getHeaders()

### Получить заголовки HTTP запроса

```JavaScript
api.getHeaders()
```

##### Описание:

Возвращает заголовки HTTP запроса.

##### Возвращает:

**array** — заголовки HTTP запроса в формате массива.

# api.setHeaders()

### Установить заголовки HTTP запроса

```JavaScript
api.setHeaders($headers)
```

##### Описание:

Устанавливает заголовки HTTP запроса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object</td><td style="width: 33.2948%; height: 29.537px;">Заголовки HTTP запроса</td></tr></tbody></table>

##### Возвращает:

**array** — заголовки HTTP запроса в формате массива.

# api.getProxyUrl()

### Получить Proxy Url HTTP запроса

```JavaScript
api.getProxyUrl()
```

##### Описание:

Возвращает Proxy Url HTTP запроса.

##### Возвращает:

**string** — Proxy Url HTTP запроса в формате строки

или

**null** — если данные не найдены.

# api.setProxyUrl()

### Установить Proxy Url HTTP запроса

```JavaScript
api.setProxyUrl($proxyUrl)
```

##### Описание:

Устанавливает Proxy Url HTTP запроса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">proxyUrl</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Proxy Url HTTP запроса</td></tr></tbody></table>

##### Возвращает:

**string** — Proxy Url HTTP запроса в формате строки

или

**null** — если данные не найдены.

# api.getLastResponseCode()

### Получить код последнего ответа HTTP запроса

```JavaScript
api.getLastResponseCode()
```

##### Описание:

Возвращает код последнего ответа HTTP запроса.

##### Возвращает:

**int** — код ответа HTTP запроса.

# api.getLastResponseContent()

### Получить содержимое последнего ответа HTTP запроса

```JavaScript
api.getLastResponseContent()
```

##### Описание:

Возвращает содержимое последнего ответа HTTP запроса.

##### Возвращает:

**string** — содержимое ответа HTTP запроса

или

**null** — если данные не найдены.

# api.getLastJsonResponse()

### Получить последний ответ HTTP запроса в формате JSON

```JavaScript
api.getLastJsonResponse()
```

##### Описание:

Возвращает последний ответ HTTP запроса в формате JSON.

##### Возвращает:

**array** — ответ HTTP запроса в формате JSON

или

**null** — если данные не найдены.

# api.getLastResponse()

### Получить последний ответ HTTP запроса

```JavaScript
api.getLastResponse()
```

##### Описание:

Возвращает последний ответ HTTP запроса.

##### Возвращает:

**mixed** — ответ HTTP запроса

или

**ResponseInterface** — ответ HTTP запроса

или

**null** — если данные не найдены.

# api.setTimeout()

### Установить время задержки для HTTP запросов

```JavaScript
api.setTimeout(float $timeout)
```

##### Описание:

Устанавливает время задержки для HTTP запросов.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">timeout</td><td style="width: 33.2909%; height: 29.537px;">float</td><td style="width: 33.2948%; height: 29.537px;">Время задержки</td></tr></tbody></table>

##### Возвращает:

**float** — время задержки.

# api.getTimeout()

### Получить время задержки для HTTP запросов

```JavaScript
api.getTimeout()
```

##### Описание:

Возвращает время задержки для HTTP запросов.

##### Возвращает:

**float** — время задержки.

# api.isExceptionThrown()

###   


```JavaScript
api.isExceptionThrown()
```

##### Описание:

##### Возвращает:

**bool** — .

# api.getLastResponseTime()

### Получить время последнего ответа HTTP запроса

```JavaScript
api.getLastResponseTime()
```

##### Описание:

Возвращает время последнего ответа HTTP запроса.

##### Возвращает:

**float** — время ответа.

# api.getLastErrorBody()

### Получить содержимое ошибки последнего ответа HTTP запроса

```JavaScript
api.getLastErrorBody(bool $isAutoConvertToJson = true)
```

##### Описание:

Возвращает содержимое ошибки последнего ответа HTTP запроса.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 211.088px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">isAutoConvertToJson</td><td style="width: 33.2909%; height: 29.537px;">bool</td><td style="width: 33.2948%; height: 29.537px;">Конвертация в Json</td></tr></tbody></table>

##### Возвращает:

**string** — содержимое ошибки в формате строки

или

**array** — содержимое ошибки в формате массива

или

**null** — если данные не найдены.

# api.callEndpoint()

### Вызвать внешнее API из чат-бота

```JavaScript
api.callEndpoint(
  string $externalApiEndpointCode, 
  string|null $uri = null,
  string|null $method = null, 
  string|null $format = null, 
  array|object|string|null $body = null, 
  array|object|string|null $headers = [],
  array|object|string|null $requestOptions = [], 
  array|object|string|null $httpClientConfig = [], 
  string|null $proxyUrl = null
)
```

##### Описание:

Вызывает внешнее API из чат-бота.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key-0" style="border-collapse: collapse; width: 100%; height: 329.236px;"><tbody><tr style="height: 29.7917px; background-color: #ced4d9;"><td style="width: 33.2909%; height: 29.7917px;">Имя</td><td style="width: 33.2909%; height: 29.7917px;">Тип</td><td style="width: 33.2948%; height: 29.7917px;">Описание</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">externalApiEndpointCode</td><td style="width: 33.2909%; height: 29.537px;">string</td><td style="width: 33.2948%; height: 29.537px;">Внешний код эндпоинта</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">uri</td><td style="width: 33.2909%; height: 29.537px;">string|null</td><td style="width: 33.2948%; height: 29.537px;">Url запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">method</td><td style="width: 33.2909%; height: 29.537px;">string|null</td><td style="width: 33.2948%; height: 29.537px;">Метод запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">format</td><td style="width: 33.2909%; height: 29.537px;">string|null</td><td style="width: 33.2948%; height: 29.537px;">Формат запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">body</td><td style="width: 33.2909%; height: 29.537px;">array|object|string|null</td><td style="width: 33.2948%; height: 29.537px;">Тело запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">headers</td><td style="width: 33.2909%; height: 29.537px;">array|object|string|null</td><td style="width: 33.2948%; height: 29.537px;">Заголовки запроса</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">requestOptions</td><td style="width: 33.2909%; height: 29.537px;">array|object|string|null</td><td style="width: 33.2948%; height: 29.537px;">Параметры запроса</td></tr><tr style="height: 63.1482px;"><td style="width: 33.2909%; height: 63.1482px;">httpClientConfig</td><td style="width: 33.2909%; height: 63.1482px;">array|object|string|null</td><td style="width: 33.2948%; height: 63.1482px;">Набор параметров для включения или выключения различных возможностей Http Client</td></tr><tr style="height: 29.537px;"><td style="width: 33.2909%; height: 29.537px;">proxyUrl</td><td style="width: 33.2909%; height: 29.537px;">string|null</td><td style="width: 33.2948%; height: 29.537px;">Proxy Url HTTP запроса</td></tr></tbody></table>

##### Возвращает:

**string** — ответ запроса в формате строки

или

**array** — ответ запроса в формате массива

или

**null** — если данные не найдены.

# api.enableExceptions()

### Включить исключения для HTTP запросов

```JavaScript
api.enableExceptions()
```

##### Описание:

Включает исключения для HTTP запросов.

##### Возвращает:

**self** — включение исключений.

# api.disableExceptions()

### Выключить исключения для HTTP запросов

```JavaScript
api.disableExceptions()
```

##### Описание:

Выключает исключения для HTTP запросов.

##### Возвращает:

**self** — выключение исключений.

# api.enableContinueCallEndpointOnJsError()

### Включить вызов эндпоинта при ошибке JS

```JavaScript
api.enableContinueCallEndpointOnJsError()
```

##### Описание:

Включает вызов эндпоинта при ошибке JS.

##### Возвращает:

**self** — включение вызова.

# api.disableContinueCallEndpointOnJsError()

### Выключить вызов эндпоинта при ошибке JS

```JavaScript
api.disableContinueCallEndpointOnJsError()
```

##### Описание:

Выключает вызов эндпоинта при ошибке JS.

##### Возвращает:

**self** — выключение вызова.

# api.getIsContinueCallEndpointOnJsError()

### Получить режим вызова эндпоинта при ошибке JS

```JavaScript
api.getIsContinueCallEndpointOnJsError()
```

##### Описание:

Возвращает режим вызова эндпоинта при ошибке JS.

##### Возвращает:

**bool** — режим вызова.

# Подробное описание сложных методов

Некоторые методы обладают сложной структурой и требуют более детального объяснения. В этом разделе вы найдете отдельные страницы, посвященные подробному описанию параметров и особенностей работы таких методов.

# where для bot.findLeads()

### Базовая структура:

Каждое условие внутри массива `where` имеет следующую структуру:

1. **Простое условие**: `['поле', 'значение']`
    
    Проверяет, равно ли поле заданному значению.
2. **Условие с оператором**: `['поле', 'оператор', 'значение']`
    
    Проверяет поле с использованием указанного оператора.

```JavaScript
let where = [
  ['поле', 'значение'],
  ['поле', 'оператор', 'значение']
]

bot.findLeads([], where, [])
```

### Доступные категории полей:

1. Поля лидов
2. Каналы (channels)
3. Статусы лидов (leadstatuses)
4. Атрибуты лидов (lead\_attributes)

#### **1. Поля лидов**

Это основные поля, доступные для каждого лида.

<table id="bkmrk-%D0%9F%D0%BE%D0%BB%D0%B5-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-id-id-"><thead><tr><th>Поле</th><th>Описание</th></tr></thead><tbody><tr><td>id</td><td>ID лида</td></tr><tr><td>name</td><td>Имя лида</td></tr><tr><td>identification</td><td>ID в мессенджере (например, Telegram ID)</td></tr><tr><td>person\_id</td><td>ID персоны</td></tr><tr><td>manager\_id</td><td>ID менеджера</td></tr><tr><td>bot\_id</td><td>ID бота</td></tr><tr><td>channel\_id</td><td>ID канала</td></tr><tr><td>lang\_code</td><td>Код языка</td></tr><tr><td>status\_id</td><td>ID статуса</td></tr><tr><td>is\_mute</td><td>Включен ли бот для лида (0 или 1)</td></tr><tr><td>is\_forwarded</td><td>Передан ли оператору (0 или 1)</td></tr><tr><td>last\_activity</td><td>Дата последней активности</td></tr><tr><td>last\_response</td><td>Timestamp последнего ответа</td></tr><tr><td>messenger</td><td>ID мессенджера</td></tr><tr><td>bot\_debug\_level</td><td>Уровень отладки бота (0 - обычный, 11 - админ)</td></tr><tr><td>created\_at</td><td>Дата создания</td></tr><tr><td>updated\_at</td><td>Дата обновления</td></tr><tr><td>dialog\_id</td><td>ID диалога</td></tr><tr><td>unread\_count</td><td>Количество непрочитанных сообщений</td></tr><tr><td>forwarded\_at</td><td>Дата передачи оператору</td></tr></tbody></table>

Пример использования:

```jsx
where = [
  ['id', 145492],
  ['name', 'like', '%Иван%'],
  ['created_at', '>=', '2023-01-01']
]


```

#### **2. Каналы (channels)**

Для поиска по каналам используются поля `channels.code` и `channels.id`.

<table id="bkmrk-%D0%9A%D0%BE%D0%B4-id-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-unkn"><thead><tr><th>Код</th><th>ID</th><th>Описание</th></tr></thead><tbody><tr><td>unknown</td><td>0</td><td>Неизвестный канал</td></tr><tr><td>avito</td><td>1</td><td>Avito</td></tr><tr><td>facebook</td><td>2</td><td>Facebook</td></tr><tr><td>instagram</td><td>3</td><td>Instagram</td></tr><tr><td>livechatWidget</td><td>4</td><td>LiveChat Widget</td></tr><tr><td>skype</td><td>5</td><td>Skype</td></tr><tr><td>telegram</td><td>6</td><td>Telegram</td></tr><tr><td>twitter</td><td>7</td><td>Twitter</td></tr><tr><td>viber</td><td>8</td><td>Viber</td></tr><tr><td>vk</td><td>9</td><td>VKontakte</td></tr><tr><td>whatsapp</td><td>10</td><td>WhatsApp</td></tr><tr><td>youla</td><td>11</td><td>Youla</td></tr><tr><td>wechat</td><td>12</td><td>WeChat</td></tr><tr><td>metabotWidget</td><td>13</td><td>MetaBot Widget</td></tr><tr><td>webim</td><td>14</td><td>Webim</td></tr><tr><td>jivoWidget</td><td>15</td><td>Jivo Widget</td></tr><tr><td>odnoklassniki</td><td>16</td><td>Odnoklassniki</td></tr><tr><td>apple\_business\_chat</td><td>17</td><td>Apple Business Chat</td></tr></tbody></table>

Канал текущего лида можно получить с помощью метода `lead.getMessengerCode()`.

Пример использования:

```JavaScript
// Ищет только telegram
let where = [
  ['channels.code', 'telegram']
]

// Ищет telegram и whatsapp
let where = [
  ['channels.id', 'IN', [6, 10]]
]
```

#### **3. Статусы лидов (leadstatuses)**

Для поиска по статусам используются поля `leadstatuses.name` и `leadstatuses.id`.

Пример использования:

```JavaScript
let where = [
  ['leadstatuses.name', 'Новый'],
  ['leadstatuses.id', 1]
]
```

Статусы можно получить на странице [https://app.metabot24.com/status](https://app.metabot24.com/status)

#### Рекомендации:

```MarkDown
Используйте вместо leadstatuses.id - status_id
А вместо channels.id - channel_id

Если вы выполняете большие операции это сократит время вычисления
```

#### **4. Атрибуты лидов (lead\_attributes)**

Для поиска по атрибутам используются следующие поля:

<table id="bkmrk-%D0%9F%D0%BE%D0%BB%D0%B5-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead_a"><thead><tr><th>Поле</th><th>Описание</th></tr></thead><tbody><tr><td>lead\_attributes.attribute\_type</td><td>Тип атрибута (tag, variable, system, json, context)</td></tr><tr><td>lead\_attributes.attribute\_key</td><td>Ключ атрибута</td></tr><tr><td>lead\_attributes.attribute\_value</td><td>Значение атрибута. Если type = tag, то можно не использовать</td></tr></tbody></table>

Пример использования:

```JavaScript
let where = [
  ['lead_attributes.attribute_type', 'variable'],
  ['lead_attributes.attribute_key', 'is_pay'],
  ['lead_attributes.attribute_value', '1']
]

```

### Операторы

В условиях можно использовать различные операторы:

- Сравнения: `=`, `<`, `>`, `<=`, `>=`, `<>`, `!=`
- Строковые: `like`, `not like`
- Множества: `IN`, `NOT IN`

<table id="bkmrk-%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%A2%D0%B8"><thead><tr><th>Оператор</th><th>Описание</th><th>Тип переменной</th><th>Пример</th></tr></thead><tbody><tr><td>=</td><td>Равно</td><td>string, int</td><td>\['id', '=', 100\]</td></tr><tr><td>&lt;</td><td>Меньше</td><td>int, float</td><td>\['price', '&lt;', 1000\]</td></tr><tr><td>&gt;</td><td>Больше</td><td>int, float</td><td>\['age', '&gt;', 18\]</td></tr><tr><td>&lt;=</td><td>Меньше или равно</td><td>int, float</td><td>\['quantity', '&lt;=', 50\]</td></tr><tr><td>&gt;=</td><td>Больше или равно</td><td>int, float</td><td>\['rating', '&gt;=', 4.5\]</td></tr><tr><td>&lt;&gt; или !=</td><td>Не равно</td><td>string, int</td><td>\['status', '&lt;&gt;', 'closed'\]</td></tr><tr><td>like</td><td>Соответствует шаблону</td><td>string</td><td>\['name', 'like', '%John%'\]</td></tr><tr><td>not like</td><td>Не соответствует шаблону</td><td>string</td><td>\['email', 'not like', '%@spam.com'\]</td></tr><tr><td>ilike</td><td>Соответствует шаблону (без учета регистра)</td><td>string</td><td>\['title', 'ilike', '%book%'\]</td></tr><tr><td>IN</td><td>Содержится в списке</td><td>array</td><td>\['id', 'IN', \[1, 2, 3\]\]</td></tr><tr><td>NOT IN</td><td>Не содержится в списке</td><td>array</td><td>\['status', 'NOT IN', \['closed', 'deleted'\]\]</td></tr><tr><td>is</td><td>Равно (для null)</td><td>null</td><td>\['manager\_id', 'is', null\]</td></tr><tr><td>is not</td><td>Не равно (для null)</td><td>null</td><td>\['end\_date', 'is not', null\]</td></tr><tr><td>regexp</td><td>Соответствует регулярному выражению</td><td>string</td><td>\['phone', 'regexp', '^\\\\+7'\]</td></tr><tr><td>not regexp</td><td>Не соответствует регулярному выражению</td><td>string</td><td>\['username', 'not regexp', '\[0-9\]'\]</td></tr></tbody></table>

> Примечание: Некоторые операторы могут быть недоступны или работать иначе.

Пример использования операторов:

```JavaScript
let where = [
  ['id', '>', 1000],
  ['name', 'like', '%Иван%'],
  ['channels.code', 'IN', ['telegram', 'whatsapp']]
]
```

### Полный пример использования

```JavaScript
let where = [
  ['name', 'like', '%Иван%'],
  ['channels.code', 'telegram'],
  ['leadstatuses.name', 'Новый'],
  ['lead_attributes.attribute_type', 'tag'],
  ['lead_attributes.attribute_key', 'важный_клиент']
]

let leads = bot.findLeads([], where, [])
debug(leads)
```

# orderBy для bot.findLeads()

### Базовая структура:

Параметр `orderBy` используется для сортировки результатов поиска лидов по заданным полям. Он представляет собой массив условий, где каждое условие задаёт поле для сортировки и порядок сортировки (по возрастанию или по убыванию).

Каждое условие внутри массива `orderBy` имеет следующую структуру:

```JavaScript
let orderBy = [
  ['поле', 'порядок']
]

bot.findLeads([], [], orderBy)
```

1. **Поле**: Название поля, по которому будет производиться сортировка (например, `created_at`, `updated_at`, `id`).
2. **Порядок**: Определяет, как будет сортироваться поле. Возможны два значения: 
    - `ASC` — по возрастанию.
    - `DESC` — по убыванию.

**Доступные категории полей:**

1. [Поля лидов](https://docs.metabot24.ru/link/744#bkmrk-1.-%D0%9F%D0%BE%D0%BB%D1%8F-%D0%BB%D0%B8%D0%B4%D0%BE%D0%B2)
2. [Статусы лидов (leadstatuses)](https://docs.metabot24.ru/link/744#bkmrk-3.-%D0%A1%D1%82%D0%B0%D1%82%D1%83%D1%81%D1%8B-%D0%BB%D0%B8%D0%B4%D0%BE%D0%B2-%28le)

### Примеры использования

#### **1. Сортировка по одному полю**

```JavaScript
let orderBy = [
  ['created_at', 'ASC']
]

let leads = bot.findLeads([], [], orderBy)
```

Этот пример сортирует лидов по дате создания в порядке возрастания (от самого раннего к самому позднему).

#### **2. Сортировка по нескольким полям**

```JavaScript
let orderBy = [
  ['updated_at', 'DESC'],
  ['id', 'ASC']
]

let leads = bot.findLeads([], [], orderBy)
```

Этот пример сначала сортирует лидов по дате обновления в порядке убывания (от самого последнего к самому раннему), а затем — по `id` в порядке возрастания.

### Пример с `where` и `orderBy`

```JavaScript
let where = [
  ['name', 'like', '%Иван%'],
  ['channels.code', 'telegram']
]

let orderBy = [
  ['created_at', 'DESC']
]

let leads = bot.findLeads([], where, orderBy)
```

# bot.getGeoLocation()

### Геолокация лида

```JavaScript
bot.getGeoLocation()
```

##### Описание:

Для Telegram вернет массив {latitude: n, longitute: m}, если в вебхуке пришла локация, иначе null. Для мессенджера отличного от Telegram вернет null.

##### Возвращает:  


<span style="font-weight: 300;">**array** </span>- массив {latitude: n, longitute: m}

или

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>**null** - если локация не найдена.