# Справочник всех функций ### Получение данных бота
МетодОписание
[bot.**getData**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetdata "bot.getData()")Возвращает данные текущего бота по ключу Возможные ключи:
### Работа с лидами #### Методы bot
МетодОписание
[bot.**findLeads**($columns = \[\], $where = \[\], $orderBy = \[\], ?int $limit = null, ?int $offset = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindleads "bot.findLeads()")Находит лиды по указанным атрибутам
#### Методы lead
МетодОписание
[lead.**getData**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetdata "lead.getData()")Возвращает значение данных лида по ключу Возможные ключи: - **id** - id лида; - **identification** - внешний id лида; - **manager\_id** - id менеджера привязанного к лиду; - **bot\_id** - id бота лида; - **channel\_id** - id канала лида; - **status\_id** - id статуса лида; - **extra** - ??? - **is\_mute** - включен ли бот для лида; - все системные поля лида (по английски).
[lead.**issetData**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetdata-i-leadisdataexist "lead.issetData() и lead.isDataExist()") Проверяет наличие данных лида по ключу Возможные ключи: - **id** - id лида; - **identification** - внешний id лида; - **manager\_id** - id менеджера привязанного к лиду; - **bot\_id** - id бота лида; - **channel\_id** - id канала лида; - **status\_id** - id статуса лида; - **extra** - ??? - **is\_mute** - включен ли бот для лида; - все системные поля лида (по английски).
[lead.**isDataExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetdata-i-leadisdataexist "lead.issetData() и lead.isDataExist()")
[lead.**getSerialNumber**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetserialnumber "lead.getSerialNumber()")Возвращает порядковый номер лида в текущем боте
[lead.**getChannelCode**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetchannelcode "lead.getChannelCode()")Возвращает код канала лида
### Работа со скриптами
Метод Описание
[bot.**scheduleScript**(?int $scriptId, ?int $leadId, ?int $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulescript "bot.scheduleScript()")Планирует вызов скрипта
[bot.**getScriptIdByName**(?string $scriptName): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetscriptidbyname "bot.getScriptIdByName()")Возвращает ID скрипта по наименованию
[bot.**getScriptIdByCode**(?string $scriptCode): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetscriptidbycode "bot.getScriptIdByCode()")Возвращает ID скрипта по коду
[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()")Запускает скрипт для лида по ID скрипта
[bot**.runScriptByNameForLead**(?string $scriptName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbynameforlead "bot.runScriptByNameForLead()")Запускает скрипт для лида по наименованию скрипта
[bot.**runScriptForPerson**(?int $scriptId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptforperson "bot.runScriptForPerson()") Запускает скрипт для персоны по ID скрипта
[bot.**runScriptByNameForPerson**(?string $scriptName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbynameforperson "bot.runScriptByNameForPerson()")Запускает скрипт для персоны по наименованию скрипта
[bot.**runScriptByCodeForLead**(?string $scriptCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbycodeforlead "bot.runScriptByCodeForLead()")Запускает скрипт для лида по коду
[bot.**runScriptByCodeForPerson**(?string $scriptCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botrunscriptbycodeforperson "bot.runScriptByCodeForPerson()")Запускает скрипт для персоны по коду
[bot.**clearJobsByScriptId**(?int $scriptId, ?int $leadId = null): **bool** ](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptid "bot.clearJobsByScriptId()")Запускает джобы по id скрипта
[bot.**clearJobsByScriptName**(?string $scriptName, ?int $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptname "bot.clearJobsByScriptName()")Очищает джобы по наименованию скрипта
[bot.**clearJobsByScriptCode**(?string $scriptCode, ?int $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearjobsbyscriptcode)Очищает джобы по коду скрипта
### Работа с атрибутами #### Методы bot
МетодОписание
[bot.**setAttr(**string $key, string $value): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetattr "bot.setAttr()")Устанавливает значение переменной бота
[bot.**getAttr**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetattr "bot.getAttr()")Возвращает значение переменной бота
[bot.**getAllAttr**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetallattr "bot.getAllAttr()")Возвращает массив всех переменных бота
[bot.**issetAttr**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botissetattr-i-botisattrexist "bot.issetAttr() и bot.isAttrExist()")Проверяет наличие переменной бота
[bot.**isAttrExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botissetattr-i-botisattrexist)
bot.**setJsonAttr**(string $key, $value): **self**Устанавливает значение JSON переменной бота
bot.**getJsonAttr**(string $key): **mixed|null**Возвращает значение JSON переменной бота
bot.**issetJsonAttr**(string $key): **bool** Проверяет наличие JSON переменной бота
bot.**isJsonAttrKeyExist**(string $key): **bool**
#### Методы lead
МетодОписание
[lead.**setAttr**(string $key, string $value): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetattr "lead.setAttr()")Устанавливает значение переменной лида
[lead.**getAttr**(string $key): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetattr "lead.getAttr()")Возвращает значение переменной лида
[lead.**getAllAttr**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetallattr)Возвращает все переменные лида
[lead.**issetAttr**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetattr-i-leadisattrexist)Проверяет наличие переменной лида
[lead.**isAttrExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadissetattr-i-leadisattrexist)
[lead.**deleteAttrs**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeleteattrs-i-leaddeleteattr "lead.deleteAttrs() и lead.deleteAttr()")Удаляет переменную/переменные лида
[lead.**deleteAttr**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeleteattrs-i-leaddeleteattr)
[lead.**forceDeleteAttrs**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeleteattrs-i-leadforcedeleteattr "lead.forceDeleteAttrs() и lead.forceDeleteAttr()")Принудительно удаляет переменную/переменные лида из БД
[lead.**forceDeleteAttr**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeleteattrs-i-leadforcedeleteattr)
lead.**setJsonAttr**(string $key, $value): **self**Устанавливает значение JSON переменной лида
lead.**getJsonAttr**(string $key): **mixed|null**Возвращает значение JSON переменной лида
lead.**issetJsonAttr**(string $key): **bool**Проверяет наличие JSON переменной лида
lead.**isJsonAttrKeyExist**(string $key): **bool**
[lead.**deleteJsonAttrs**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletejsonattrs-i-leaddeletejsonattr "lead.deleteJsonAttrs() и lead.deleteJsonAttr()")Удаляет json-переменную/json-переменные лида
[lead.**deleteJsonAttr**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletejsonattrs-i-leaddeletejsonattr "lead.deleteJsonAttrs() и lead.deleteJsonAttr()")
[lead.**forceDeleteJsonAttrs**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletejsonattrs-i-leadforcedeletejsonattr "lead.forceDeleteJsonAttrs() и lead.forceDeleteJsonAttr()")Принудительно удаляет json-переменную/json-переменные лида из БД
[lead.**forceDeleteJsonAttr**(string|object|array|null $attrs, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletejsonattrs-i-leadforcedeletejsonattr)
#### Методы memory
МетодОписание
memory.**setAttr**(string $key, string $value): **self**Устанавливает значение временной переменной
memory.**getAttr**(string $key): **string|null**Возвращает значение временной переменной
memory.**issetAttr**(string $key): **bool**Проверяет наличие временной переменной
memory.**isAttrExist**(string $key): **bool**
memory.**setJsonAttr**(string $key, $value): **self**Устанавливает значение временной JSON переменной
memory.**getJsonAttr**(string $key): **mixed|null**Возвращает значение временной JSON переменной
memory.**issetJsonAttr**(string $key): **bool**Проверяет наличие временной JSON переменной
memory.**isJsonAttrKeyExist**(string $key): **bool**
### Работа с триггерами
МетодОписание
[bot.**scheduleTrigger**(?int $triggerId, ?int $leadId, ?int $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botscheduletrigger "bot.scheduleTrigger()")Планирует запуск триггера
[bot.**runTriggerByCodeForLead**(?string $triggerCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbycodeforlead "bot.runTriggerByCodeForLead()")Планирует запуск триггера по коду
[bot.**runTriggerByCodeForPerson**(?string $triggerCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbycodeforperson "bot.runTriggerByCodeForPerson()")Планирует запуск триггера по коду для последнего лида персоны
[bot.**clearTriggerJobsForLead**(?int $leadId, ?int $ticketId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsforlead "bot.clearTriggerJobsForLead()")Удаляет триггеры для лида
[bot.**clearTriggerJobsForAllPersonLeads**(?int $personId, ?int $ticketId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsforallpersonleads "bot.clearTriggerJobsForAllPersonLeads()") Удаляет триггеры для всех лидов персоны
[bot.**getTriggerIdByName**(?string $triggerName): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettriggeridbyname "bot.getTriggerIdByName()") Возвращает ID триггера по наименованию
[bot.**getTriggerIdByCode**(?string $triggerCode): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettriggeridbycode "bot.getTriggerIdByCode()") Возвращает ID Триггера по Коду
[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()") Запускает триггер для лида по ID триггера
[bot.**runTriggerByNameForLead**(?string $triggerName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbynameforlead "bot.runTriggerByNameForLead()") Запускает триггер для лида по наименованию
[bot.**runTriggerForPerson**(?int $triggerId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerforperson "bot.runTriggerForPerson()") Запускает триггер для персоны по ID
[bot.**runTriggerByNameForPerson**(?string $triggerName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botruntriggerbynameforperson "bot.runTriggerByNameForPerson()") Запускает триггер для персоны по наименованию
[bot.**clearTriggerJobsById**(?int $triggerId, ?int $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyid "bot.clearTriggerJobsById()") Очищает джобы по id триггера
[bot.**clearTriggerJobsByName**(?string $triggerName, ?int $leadId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyname "bot.clearTriggerJobsByName()") Очищает джобы по наименованию триггера
[bot.**clearTriggerJobsByScriptCode**(?string $scriptCode, ?int $leadId = null, ?int $ticketId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyscriptcode "bot.clearTriggerJobsByScriptCode()") Очищает джобы по коду скрипта
[bot.**clearTriggerJobsByIdForTicket**(?int $triggerId, ?int $ticketId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbyidforticket "bot.clearTriggerJobsByIdForTicket()") Очищает джобы по id триггера и ID заявки
[bot.**clearTriggerJobsByNameForTicket**(?string $triggerName, ?int $ticketId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcleartriggerjobsbynameforticket "bot.clearTriggerJobsByNameForTicket()") Очищает джобы по наименованию триггера и ID заявки
### Работа со статусами
МетодОписание
[lead.**isInStatus**(string $statusName): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadisinstatus "lead.isInStatus()")Проверяет существует ли статуса у лида
[lead.**getStatusId**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetstatusid "lead.getStatusId()")Возвращает id статуса лида
### Работа с рассылками
МетодОписание
[bot.**scheduleBroadcast**(?int $broadcastId, ?int $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulebroadcast "bot.scheduleBroadcast()")Планирует запуск рассылки
[bot.**scheduleBroadcastByCode**(?string $broadcastCode, ?int $ticketId = null, $jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulebroadcastbycode "bot.scheduleBroadcastByCode()")Планирует запуск рассылки по коду
[bot.**getBroadcastIdByCode**(?string $broadcastCode): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetbroadcastidbycode "bot.getBroadcastIdByCode()")Возвращает ID рассылки по коду
### Работа с тэгами
МетодОписание
[lead.**isTagExist**('some\_tag'): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadistagexist-i-leadissettag "lead.isTagExist() и lead.issetTag()")Проверяет наличие тэга лида
[lead.**issetTag**('some\_tag'): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadistagexist-i-leadissettag)
[lead.**getTag**(string $key): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgettag "lead.getTag()")Возвращает значение тэга лида
[lead.**getAllTags**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetalltags "lead.getAllTags()")Возвращает массив всех тэгов лида
[lead.**addTags**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadaddtags-i-leadaddtag "lead.addTags() и lead.addTag()")Добавляет тэги лиду
[lead.**addTag**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadaddtags-i-leadaddtag)
[lead.**deleteTags**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletetags-i-leaddeletetag "lead.deleteTags() и lead.deleteTag()")Удаляет тэги лида
[lead.**deleteTag**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isForceDelete = false, bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leaddeletetags-i-leaddeletetag)
[lead.**forceDeleteTags**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletetags-i-leadforcedeletetag "lead.forceDeleteTags() и lead.forceDeleteTag()")Принудительно удаляет тэги лида из БД
[lead.**forceDeleteTag**(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = \[\], bool $isSuppressTriggers = false): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadforcedeletetags-i-leadforcedeletetag "lead.forceDeleteTags() и lead.forceDeleteTag()")
### Работа с контекстами
МетодОписание
[lead.**isContextExist**('some\_tag'): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadiscontextexist-i-leadissetcontext "lead.isContextExist() и lead.issetContext()")Проверяет наличие контекста лида
[lead.**issetContext**('some\_tag'): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadiscontextexist-i-leadissetcontext)
[lead.**getContext**(string $key): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetcontext "lead.getContext()")Возвращает значение контекста лида
[lead.**getAllContexts**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetallcontexts "lead.getAllContexts()")Возвращает массив всех контекстов лида
### Работа с переключением на оператора #### Методы bot
МетодОписание
[bot.**getForwardEventType**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetforwardeventtype "bot.getForwardEventType()")Проверяет кто переключил на оператора
[bot.**isForwardedToOperator**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisforwardedtooperator "bot.isForwardedToOperator()")Проверяет переключения на оператора
#### Методы lead
МетодОписание
[lead.**setForwarded**(bool|int $state): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetforwarded "lead.setForwarded()")Переключает бот на оператора
### Работа с заявками #### Методы bot
МетодОписание
[bot.**createTicket**($data): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcreateticket "bot.createTicket()")Создает заявку
[bot.**updateTicketById**(int $ticketId, $data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botupdateticketbyid "bot.updateTicketById()")Обновляет заявку
[bot.**getMaxRejectsTicketCount**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetmaxrejectsticketcount "bot.getMaxRejectsTicketCount()")Возвращает максимальное количество отказов
[bot.**findTickets**($where = \[\], bool $findInAllBusinessBots = false, $orderBy = \[\], ?int $limit = null, ?int $offset = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindtickets "bot.findTickets()")Находит заявку по заданным атрибутам
[bot.**findTicketIdByCustomField**(string $fieldName, $value): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindticketidbycustomfield "bot.findTicketIdByCustomField()")Возвращает id заявки по значению поля
[bot.**getTicketTypeIdByName**(string $typeName): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettickettypeidbyname "bot.getTicketTypeIdByName()")Возвращает id заявки по наименованию вида заявки
[bot.**getTicketStatusIdByName**(string $statusName): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetticketstatusidbyname "bot.getTicketStatusIdByName()")Возвращает id заявки по наименованию статуса заявки
[bot.**setCurrentTicketById**(?int $ticketId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetcurrentticketbyid "bot.setCurrentTicketById()")Устанавливает указанную заявку как текущую
[bot.**clearTicketAssignedPersonsLog**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botclearticketassignedpersonslog "bot.clearTicketAssignedPersonsLog()")Очищает лог назначения тикета персонам
#### Методы ticket
МетодОписание
[ticket.**update**($data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketupdate "ticket.update()") Обновляет заявку, через объект заявки
[ticket.**getData**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetdata "ticket.getData()") Возвращает значение данных заявки по ключу В качестве ключа можно указать:
- **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**getCustomData**(string $key): **mixed|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetcustomdata "ticket.getCustomData()") Считывает произвольные поля заявки по ключу В качестве ключа можно указать:
- **названия всех произвольных полей заявки**; - **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**issetData**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetdata-i-ticketisdataexist "ticket.issetData() и ticket.isDataExist()") Проверяет наличие данных по заявке по ключу В качестве ключа можно указать:
- **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**isDataExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetdata-i-ticketisdataexist)
[ticket.**reloadCustomData**(bool $isReloadModel = false): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketreloadcustomdata "ticket.reloadCustomData()") Перезагружает кастомные данные
[ticket.**setAllCustomData**(array $customData): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetallcustomdata "ticket.setAllCustomData()") Переопределяет список кастомных полей
[ticket.**getAllCustomData**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetallcustomdata "ticket.getAllCustomData()") Возвращает список кастомных полей
[ticket.**setCustomData**(string $key, $value): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetcustomdata "ticket.setCustomData()") Устанавливает значение кастомного поля В качестве ключа можно указать:
- **названия всех произвольных полей заявки**; - **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**issetCustomData**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketissetcustomdata "ticket.issetCustomData()") Проверяет имеет ли значение кастомное поле В качестве ключа можно указать:
- **названия всех произвольных полей заявки**; - **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**isCustomDataExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketiscustomdataexist "ticket.isCustomDataExist()") Проверяет существует ли кастомное поле В качестве ключа можно указать:
- **названия всех произвольных полей заявки**; - **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** - время удаления заявки; - все системные поля заявки (по английски).
[ticket.**getTicketTypeName**(): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgettickettypename "ticket.getTicketTypeName()") Возвращает название типа заявки
[ticket.**getStatusId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusid-i-ticketgetattrstatus-id "ticket.getStatusId() и ticket.getAttr("status_id")") Возвращает ID статуса заявки
[ticket.**getAttr**("status\_id"): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusid-i-ticketgetattrstatus-id)
[ticket.**getStatusName**(): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatusname "ticket.getStatusName()") Возвращает название статуса заявки
[ticket.**getStatusType**(): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetstatustype "ticket.getStatusType()") Возвращает тип статуса заявки
[ticket.**\_sanitizeString**($string): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticket-sanitizestring "ticket._sanitizeString()") Приводит название статуса к стандартному виду
[ticket.**isInStatus**($statusName): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketisinstatus "ticket.isInStatus()") Проверяет статус заявки
[ticket.**setStatusId**(?int $statusId, ?int $personQueueIdForLog = null, ?string $personQueueTableForLog = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetstatusid "ticket.setStatusId()") Устанавливает статус заявки по id
[ticket.**setStatusByName**(string $statusName, ?int $personQueueIdForLog = null, ?string $personQueueTableForLog = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetstatusbyname "ticket.setStatusByName()") Устанавливает статус заявки по имени
[ticket.**reloadTicket**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketreloadticket "ticket.reloadTicket()") Загружает заявку повторно
[ticket.**getAuthorPersonId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonid "ticket.getAuthorPersonId()") Возвращает ID автора заявки
[ticket.**getAssignedPersonId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonid "ticket.getAssignedPersonId()") Возвращает ID исполнителя заявки
[ticket.**getClientPersonId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonid "ticket.getClientPersonId()") Возвращает ID клиента заявки
[ticket.**getAuthorPersonFullName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonfullname "ticket.getAuthorPersonFullName()") Возвращает ФИО автора заявки
[ticket.**getAssignedPersonFullName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonfullname "ticket.getAssignedPersonFullName()") Возвращает ФИО исполнителя заявки
[ticket.**getClientPersonFullName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonfullname "ticket.getClientPersonFullName()") Возвращает ФИО клиента заявки
[ticket.**getAuthorPersonRoleId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroleid "ticket.getAuthorPersonRoleId()") Возвращает ID роли автора заявки
[ticket.**getAssignedPersonRoleId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroleid "ticket.getAssignedPersonRoleId()") Возвращает ID роли исполнителя заявки
[ticket.**getClientPersonRoleId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroleid "ticket.getClientPersonRoleId()") Возвращает ID роли клиента заявки
[ticket.**getAuthorPersonRoleName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonrolename "ticket.getAuthorPersonRoleName()") Возвращает имя роли автора заявки
[ticket.**getAssignedPersonRoleName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonrolename "ticket.getAssignedPersonRoleName()") Возвращает имя роли исполнителя заявки
[ticket.**getClientPersonRoleName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonrolename "ticket.getClientPersonRoleName()") Возвращает имя роли клиента заявки
[ticket.**getAuthorPersonRoleTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroletitle "ticket.getAuthorPersonRoleTitle()") Возвращает заголовок роли автора заявки
[ticket.**getAssignedPersonRoleTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroletitle "ticket.getAssignedPersonRoleTitle()") Возвращает заголовок роли исполнителя заявки
[ticket.**getClientPersonRoleTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroletitle "ticket.getClientPersonRoleTitle()") Возвращает заголовок роли клиента заявки
[ticket.**getAuthorPersonRoleFormattedTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetauthorpersonroleformattedtitle "ticket.getAuthorPersonRoleFormattedTitle()") Возвращает форматированное название роли автора заявки
[ticket.**getAssignedPersonRoleFormattedTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonroleformattedtitle "ticket.getAssignedPersonRoleFormattedTitle()") Возвращает форматированное название роли исполнителя заявки
[ticket.**getClientPersonRoleFormattedTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetclientpersonroleformattedtitle "ticket.getClientPersonRoleFormattedTitle()") Возвращает форматированное название роли клиента заявки
[ticket.**getPerson1Id**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson1id "ticket.getPerson1Id()") Возвращает id первой дополнительной персоны
[ticket.**getPerson2Id**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson2id "ticket.getPerson2Id()") Возвращает id второй дополнительной персоны
[ticket.**getPerson3Id**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetperson3id "ticket.getPerson3Id()") Возвращает id третьей дополнительной персоны
[ticket.**setPerson1Id**(?int $personId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson1id "ticket.setPerson1Id()") Устанавливает id первой дополнительной персоны
[ticket.**setPerson2Id**(?int $personId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson2id "ticket.setPerson2Id()") Устанавливает id второй дополнительной персоны
[ticket.**setPerson3Id**(?int $personId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetperson3id "ticket.setPerson3Id()") Устанавливает id третьей дополнительной персоны
ticket.**getTotalFormatted**(): **string**
ticket.**getSubtotalFormatted**(): **string**
ticket.**getTotalFeeFormatted**(): **string**
ticket.**getDeliveryFeeFormatted**(): **string**
### Работа со статусами
МетодОписание
[ticketStatuses.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesreload "ticketStatuses.reload()")Перезагружает все статусы из БД
[ticketStatuses.**getCollection**(): **?Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesgetcollection "ticketStatuses.getCollection()")Возвращает Laravel Collection
[ticketStatuses.**find**(array|object|null $where, bool $isReturnCollection = false): **?ScriptTicketStatus**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfind "ticketStatuses.find()")Возвращает статусы заявок
[ticketStatuses.**findById**(string|int|null $id): **?ScriptTicketStatus**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindbyid "ticketStatuses.findById()")Возвращает статус по ID
[ticketStatuses.**findByName**(string $name): **?ScriptTicketStatus**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindbyname "ticketStatuses.findByName()")Возвращает статус по имени
[ticketStatuses.**findAllByNames**(string|array|object|null $names, string $operator = '=', bool $isReturnCollection = false): **?Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindallbynames "ticketStatuses.findAllByNames()")Возвращает статусы по имени
[ticketStatuses.**findAllByTypes**(string|array|object|null $types, string $operator = '=', bool $isReturnCollection = false): **?Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketstatusesfindallbytypes "ticketStatuses.findAllByTypes()")Возвращает статусы по типу статуса
### Работа с персонами #### Методы bot
МетодОписание
[bot.**createPerson**($data): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcreateperson "bot.createPerson()")Создает персону
[bot.**findPersons**($where = \[\], $orderBy = \[\], ?int $limit = null, ?int $offset = null, bool $isLogErrorIfManyPersonsFound = false): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botfindpersons "bot.findPersons()")Возвращает данные персон соответствующих атрибутам
[bot.**updatePersonById**(int $personId, $data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botupdatepersonbyid "bot.updatePersonById()")Обновляет персону по id
[bot.**deletePersonById**(int $personId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdeletepersonbyid "bot.deletePersonById()")Удаляет персону по id
#### Методы lead
МетодОписание
[lead.**getPersonId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetpersonid "lead.getPersonId()")Возвращает id персоны
[lead.**setPersonId**(?int $personId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetpersonid "lead.setPersonId()")Привязывает персону к лиду
[lead.**createPersonForCurrentLead**($data): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadcreatepersonforcurrentlead "lead.createPersonForCurrentLead()")Создает персону для лида
#### Методы person
МетодОписание
[person.**update**($data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personupdate "person.update()")Обновляет данные персоны
[person.**delete**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persondelete "person.delete()")Удаляет персону
[person.**getAllData**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetalldata "person.getAllData()")Возвращает все поля персоны
[person.**setData**(string $key, $value): **self**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetdata "person.setData()")Устанавливает поле персоны по ключу В качестве ключа можно указать:
- **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** - дата удаления; - все системные поля персоны (по английски).
[person.**getData**(string $key)](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetdata "person.getData()")Возвращает значение данных персоны В качестве ключа можно указать:
- **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** - дата удаления; - все системные поля персоны (по английски).
[person.**issetData**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personissetdata-i-personisdataexist "person.issetData() и person.isDataExist()")Проверяет наличие данных по персоне В качестве ключа можно указать:
- **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** - дата удаления; - все системные поля персоны (по английски).
[person.**isDataExist**(string $key): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personissetdata-i-personisdataexist)
[person.**getId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetid "person.getId()")Возвращает ID персоны
[person.**getFullName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetfullname "person.getFullName()") Возвращает полное имя персоны
[person.**getRoleId**(): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroleid "person.getRoleId()")Возвращает ID роли персоны
[person.**getRoleName**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetrolename "person.getRoleName()")Возвращает название роли персоны
[person.**getRoleTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroletitle "person.getRoleTitle()")Возвращает заголовок роли персоны
[person.**getRoleFormattedTitle**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetroleformattedtitle "person.getRoleFormattedTitle()")Возвращает форматированное название роли персоны.
[person.**getPhone**(): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetphone "person.getPhone()")Возвращает номер телефона персоны
[person.**setPhone**(?string $phone): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetphone "person.setPhone()")Устанавливает номер телефона персоны
[person.**getEmail**(): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/persongetemail "person.getEmail()")Возвращает почту персоны
### Работа с очередями исполнителей #### Методы ticket
МетодОписание
[ticket.**assignToNextQueuePerson**(int $queueMode = 1, ?int $personQueueId = null, ?string $personQueueTable = null, ?int $currentAssignAttempt = null, bool $isIncRejectsCount = true, bool $isMoveToEndIfRejectsExceed = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketassigntonextqueueperson "ticket.assignToNextQueuePerson()")Назначает заявку следующему исполнителю
[ticket.**moveAssignedPersonToEndOfQueue**(int $queueMode = 1, ?int $personQueueId = null, ?string $personQueueTable = null, bool $isResetRejectsCount = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketmoveassignedpersontoendofqueue "ticket.moveAssignedPersonToEndOfQueue()")Переносит исполнителя в конец очереди
[ticket.**assignToPersonById**(?int $personId, ?int $personQueueIdForLog = null, ?string $personQueueTableForLog = null, ?int $assignAttemptForLog = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketassigntopersonbyid "ticket.assignToPersonById()") Назначает исполнителя заявки
[ticket.**getAssignedPersonRejectsCount**(?int $personQueueId = null, ?string $personQueueTable = null): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketgetassignedpersonrejectscount "ticket.getAssignedPersonRejectsCount()") Возвращает количество отказов от заявок
[ticket.**setAssignedPersonRejectsCount**(int $rejectsCount, ?int $personQueueId = null, ?string $personQueueTable = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketsetassignedpersonrejectscount "ticket.setAssignedPersonRejectsCount()") Устанавливает количество отказов от заявок
[ticket.**incAssignedPersonRejectsCount**(?int $personQueueId = null, ?string $personQueueTable = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/ticketincassignedpersonrejectscount "ticket.incAssignedPersonRejectsCount()") Увеличивает количество отказов от заявок
#### Методы person
МетодОписание
[person.**addToQueue**(?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null, bool $isActive = true, int $rejectsCount = 0): **?int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personaddtoqueue "person.addToQueue()")Добавляет персону в очередь
[person.**removeFromQueue**(?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personremovefromqueue "person.removeFromQueue()")Удаляет персону из очереди
[person.**moveToEndOfQueue**(int $queueMode = 1, ?int $personQueueId = null, ?string $personQueueTable = null, ?int $ticketTypeId = null, bool $isResetRejectsCount = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personmovetoendofqueue "person.moveToEndOfQueue()")Перемещает персону в конец очереди
[person.**setIsActiveInQueue**(bool $isActive = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personsetisactiveinqueue "person.setIsActiveInQueue()")Активирует/деактивирует персону в очереди
#### Методы personQueues
МетодОписание
[personQueues.**find**($where, bool $isReturnCollection = false): **ScriptPersonQueue\[\]|Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfind "personQueues.find()")Возвращает очередь исполнителей
[personQueues.**findById**(string|int|null $id): **?ScriptPersonQueue**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindbyid "personQueues.findById()") Возвращает очередь исполнителей по id
[personQueues.**findAllByTitles**(string|array|object|null $titles, bool $isEnabled = null, string $findTitleOperator = 'IN', bool $isReturnCollection = false): **ScriptPersonQueue\[\]|Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindallbytitles "personQueues.findAllByTitles()") Возвращает очереди исполнителей по заголовку
[personQueues.**findByCode**(string $code, bool $isEnabled = null, string $findCodeOperator = '='): **?ScriptPersonQueue**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesfindbycode "personQueues.findByCode()") Возвращает очередь исполнителей по коду
[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()") Возвращает очереди исполнителей по коду
[personQueues.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesreload "personQueues.reload()")Обновляет очередь исполнителей
[personQueues.**getCollection**(): **?Collection**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/personqueuesgetcollection "personQueues.getCollection()")Возвращает коллекцию очередей
### Работа с интеграциями NLP #### Методы bot
МетодОписание
[bot.**getIntegrationIdByCode**(?string $integrationCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetintegrationidbycode "bot.getIntegrationIdByCode()") Возвращает id интеграции бота по коду
[bot.**getEnabledIntegrationIdByCode**(?string $integrationCode): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetenabledintegrationidbycode "bot.getEnabledIntegrationIdByCode()")Возвращает id включенной интеграции бота по коду
[bot.**isEnabledIntegrationById**(?int $integrationId): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisenabledintegrationbyid "bot.isEnabledIntegrationById()") Проверяет активность интеграции по id
[bot.**isEnabledIntegrationByCode**(?string $integrationCode): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botisenabledintegrationbycode "bot.isEnabledIntegrationByCode()") Проверяет активность интеграции по коду
#### Методы lead
МетодОписание
[lead.**setActiveNlpIntegrationByCode**(?string $integrationCode): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadsetactivenlpintegrationbycode "lead.setActiveNlpIntegrationByCode()")Присваивает интеграцию лиду по коду
### Работа с кастомными таблицами #### Методы table
МетодОписание
[table.**createItem**(string $tableName, array|object $data): **ScriptCustomTableItem**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablecreateitem "table.createItem()")Создает запись в таблице
[table.**find**(string $tableName, array|object $columns = \[\], array|object $where = \[\], array|object $orderBy = \[\], ?int $limit = null, ?int $offset = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablefind "table.find()") Ищет запись в таблице
[table.**count**(string $tableName, array|object $where = \[\]): **int** ](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablecount "table.count()") Подсчитывает количество записей
[table.**sum**(string $tableName, string $column, array|object $where = \[\]): **int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/tablesum "table.sum()")Подсчитывает сумму значений по полю
[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()")Ищет максимальное значение по полю
#### Методы item

За объект **item** принимаем запись кастомной таблицы полученную с помощью **table.createItem** или **table.find**.

МетодОписание
[item.**update**(array|object $data): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemupdate "item.update()")Обновляет записи в таблице
[item.**delete**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemdelete "item.delete()")Удаляет записи из таблицы
[item.**getDateFormatted**(string $fieldName, string $format = 'Y-m-d H:i:s', ?string $timeZone = null): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemgetdateformatted "item.getDateFormatted()")Возвращает форматированную дату по названию поля
[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()")Возвращает форматированную дату из произвольной строки
[item.**reload**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/itemreload "item.reload()") Перезагружает данные записи из БД
### Работа с блокировками
МетодОписание
[bot.**getLockNameForBot**(string $lockName, string $lockPrefix = ''): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlocknameforbot "bot.getLockNameForBot()")Генерирует имя блокировки по боту
[bot.**getLockNameForBusiness**(string $lockName, string $lockPrefix = ''): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlocknameforbusiness "bot.getLockNameForBusiness()")Генерирует имя блокировки по бизнесу
[bot.**waitForBusinessLock**(string $lockName, string $lockPrefix = '', ?int $ttlSec = null, $maxWaitSec = 300): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botwaitforbusinesslock "bot.waitForBusinessLock()")Захватывает блокировку по бизнесу
[bot.**waitForBotLock**(string $lockName, string $lockPrefix = '', ?int $ttlSec = null, $maxWaitSec = 300): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botwaitforbusinesslock "bot.waitForBusinessLock()")Захватывает блокировку по боту
[bot.**releaseAllCurrentLocks**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaseallcurrentlocks "bot.releaseAllCurrentLocks()")Освобождает все блокировки захваченные в текущем скрипте
[bot.**releaseCurrentLockForBusiness**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleasecurrentlockforbusiness "bot.releaseCurrentLockForBusiness()")Освобождает блокировку захваченную текущем скрипте по бизнесу
[bot.**releaseCurrentLockForBot**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleasecurrentlockforbot "bot.releaseCurrentLockForBot()")Освобождает блокировку захваченную в текущем скрипте по боту
[bot.**releaseLockForBusiness**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaselockforbusiness "bot.releaseLockForBusiness()")Освобождает блокировку по бизнесу
[bot.**releaseLockForBot**(string $lockName, string $lockPrefix = ''): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botreleaselockforbot "bot.releaseLockForBot()")Освобождает блокировку по боту
[bot.**hasLockForBusiness**(string $lockName, string $lockPrefix = '', $checkValue = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/bothaslockforbusiness "bot.hasLockForBusiness()")Проверяет существование блокировки по бизнесу
[bot.**hasLockForBot**(string $lockName, string $lockPrefix = '', $checkValue = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/bothaslockforbot "bot.hasLockForBot()")Проверяет существование блокировки по боту
### Работа с контакт-центром #### Методы bot
МетодОписание
[bot.**getForwardEventType**(): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetforwardeventtype-NZb "bot.getForwardEventType()")Возвращает строку "forwarded\_by\_operator" если действие выполнено оператором или null для контакт-центра
[bot.**canAutoForward**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botcanautoforward "bot.canAutoForward()")Узнает доступно ли авто-назначение оператора в данном скрипте
#### Методы lead
МетодОписание
[lead.**canAutoForward**(): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadcanautoforward "lead.canAutoForward()")Узнает доступно ли авто-назначение оператора в данном скрипте
[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()")Возвращает список следующих операторов
[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()")Назначает диалог на следующего оператора полученного с помощью **getNextOperators**
[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()")Назначает диалог на указанного в методе оператора
### Работа с API #### Методы bot
МетодОписание
[bot.**scheduleJob**($jobParams = \[\]): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botschedulejob "bot.scheduleJob()")Планирует любую задачу
#### Методы lead
МетодОписание
[lead.**getLastRequest**(): **?ScriptRequest**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetlastrequest "lead.getLastRequest()")Возвращает объект с параметрами последнего реквеста
#### Методы request

За объект **request** принимаем объект с параметрами последнего реквеста полученный с помощью **lead**.**getLastRequest**.

МетодОписание
[request.json](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request "request.")Доступ к json параметрам в виде javascript json-обьекта
[request.asJson(): **?ScriptRequest**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)
[request.array](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)Доступ к json параметрам в виде javascript json-обьекта
[request.asArray(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)
[request.string](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)Входящие параметры в виде json обьекта
[request.asString(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/request)
#### Методы last\_request

За объект **last\_request** принимаем объект с параметрами последнего реквеста полученный с помощью **lead**.**getLastRequest**.

МетодОписание
[last\_request.json](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request "last_request.")Доступ к последнему реквесту в виде javascript json-обьекта
[last\_request.asJson(): **?ScriptRequest**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)
[last\_request.array](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)Доступ к последнему реквесту в виде массива
[last\_request.asArray(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)
[last\_request.string](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)Доступ к последнему реквесту в виде json обьекта
[last\_request.asString(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/last-request)
#### Методы api
МетодОписание
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**Вызывает внешнее API из чат-бота
api.**request**(string $method, string $uri, $requestOptions = \[\], $httpClientConfig = \[\], $body = null, $jsonBody = null, $headers = \[\]): **ResponseInterface|null|mixed**Выполняет HTTP запрос, с помощью Guzzle
api.**post**(string $uri, $body = \[\], $requestOptions = \[\], $headers = \[\], $httpClientConfig = \[\]): **?string**Выполняет HTTP POST запрос, с помощью Guzzle
api.**get**(string $uri, $requestOptions = \[\], $headers = \[\], $httpClientConfig = \[\]): **?string**Выполняет HTTP GET запрос, с помощью Guzzle
api.**getJson**(string $uri, $jsonBody = \[\], $headers = \[\], $requestOptions = \[\], $httpClientConfig = \[\]): **?array**Выполняет HTTP POST запрос с jsonBody, с помощью Guzzle
api.**postJson**(string $uri, $jsonBody = \[\], $headers = \[\], $requestOptions = \[\], $httpClientConfig = \[\]): **?array**Выполняет HTTP GET запрос с jsonBody, с помощью Guzzle
api.**getHttpConfig**(): **array**Возвращает HTTP Config
api.**setHttpConfig**($config): **self**Устанавливает HTTP Config
api.**getRequestOptions**(): **array**Возвращает параметры HTTP запроса
api.**setRequestOptions**($options): **self**Устанавливает параметры HTTP запроса
api.**getHeaders**(): **array**Возвращает заголовки HTTP запроса
api.**setHeaders**($headers): **self**Устанавливает заголовки HTTP запроса
api.**getProxyUrl**(): **?string**Возвращает Proxy Url HTTP запроса
api.**setProxyUrl**($proxyUrl): **self**Устанавливает Proxy Url HTTP запроса
api.**getLastResponse**()Возвращает последний ответ HTTP запроса
api.**getLastResponseCode**(): **int**Возвращает код последнего ответа HTTP запроса
api.**getLastResponseContent**(): **?string**Возвращает содержимое последнего ответа HTTP запроса
api.**getLastJsonResponse**(): ?arrayВозвращает последний ответ HTTP запроса в формате JSON
api.**enableExceptions**(): **self**Включает исключения для HTTP запросов
api.**disableExceptions**(): **self** Выключает исключения для HTTP запросов
api.**setTimeout**(float $timeout): **self** Устанавливает время задержки для HTTP запросов
api.**getTimeout**(): **float** Возвращает время задержки для HTTP запросов
api.**isExceptionThrown**(): **bool**
api.**isConnectExceptionThrown**(): **bool**
api.**getLastResponseTime**(): **float** Возвращает время последнего ответа HTTP запроса
### Работа с файлами #### Методы bot
МетодОписание
[bot.**getIncomingMessage**(bool $useOutputFilter = false): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetincomingmessage "bot.getIncomingMessage()") Возвращает текст входящего сообщения или текст подписи к вложению
[bot.**getWebhookJobId**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookjobid "bot.getWebhookJobId()") Возвращает id вебхука зарегистрированного в очереди Метабот
[bot.**getWebhookJob**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookjob "bot.getWebhookJob()") Возвращает информацию о вебхуке
[bot.**getWebhookPayload**(): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetwebhookpayload "bot.getWebhookPayload()") Возвращает payload входящего вебхука в виде массива
[bot.**getLastResultPayload**(): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetlastresultpayload "bot.getLastResultPayload()") Возвращает payload c данными о последнем ответе мессенджера в ввиде массива
[bot.**getChannelData**(string|null $key = null): **array|null|mixed**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetchanneldata "bot.getChannelData()") Возвращает настройки канала лида
[bot.**disableBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdisablebuffer "bot.disableBuffer()") Принудительное отключение буффера исходящих сообщений
[bot.**enableBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botenablebuffer "bot.enableBuffer()") Принудительное включение буффера исходящих сообщений
[bot.**flushBuffer**()](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botflushbuffer "bot.flushBuffer()") Принудительное освобождение буффера исходящих сообщений
[bot.**getAllAttachments**(string|null $filesMimeExcludeFilter = 'image|video'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetallattachments "bot.getAllAttachments()") Возвращает вложения всех видов
[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()") Возвращает все вложения, которые распознаны как файл
[bot.**getImages**(string|null $mimeIncludeFilter = 'image'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetimages "bot.getImages()") Возвращает все изображения, а также файлы, которые распознаны как изображение
[bot.**getVideos**(string|null $mimeIncludeFilter = 'video'): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetvideos "bot.getVideos()") Возвращает все видео, а также файлы, которые распознаны как видео
[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()") Отправляет payload в мессенджер
[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()") Отправляет текст в мессенджер
[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**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendmessage "bot.sendMessage()") Отправляет сообщение в мессенджер, сообщение может содержать текст, кнопки меню и вложения
[bot.**sendButtons**(string|null|mixed $messageText, array|object $buttons, array|object|null $apiAdditionalParams = null, bool $isDisableBuffer = true): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsendbuttons "bot.sendButtons()") Отправляет кнопки с сообщением в мессенджер
[bot.**getTelegramFileInfoById**(string|null $fileId, bool $isShowOriginalInfo = false): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettelegramfileinfobyid "bot.getTelegramFileInfoById()") Возвращает информацию о файле в Telegram по его id
[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()") Отправляет файл в телеграм и возвращает его id
[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()") Редактирует кнопки меню уже отправленного в Telegram сообщения
[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()")
[bot.**getTelegramLastMessageId**(): **int|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgettelegramlastmessageid "bot.getTelegramLastMessageId()") Возвращает ID последнего сообщения, отправленного в Telegram
[bot.**setCdnConfig**(array|object|null $cdnConfig = null): **bool**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botsetcdnconfig "bot.setCdnConfig()") Устанавливает конфиг для доступа к CDN
[bot.**getCdnConfig**(): **array|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetcdnconfig "bot.getCdnConfig()") Возвращает текущий конфиг CDN
[bot.**getFileInfoByUrl**(string $fileUrl): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botgetfileinfobyurl "bot.getFileInfoByUrl()") Возвращает информацию о файле по URL
[bot.**downloadFileFromUrl**(string $fileUrl): **string|array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdownloadfilefromurl "bot.downloadFileFromUrl()") Скачивает файл с URL и загружает в хранилище файлов Метабот для вашего бизнеса
[bot.**downloadTmpFileFromUrl**(string $fileUrl): **string|array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botdownloadtmpfilefromurl "bot.downloadTmpFileFromUrl()") Скачивает файл с URL и загружает во временное хранилище файлов Метабот для вашего бизнеса
[bot.**removeFile**(string $fileUrl): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovefile "bot.removeFile()") Удаляет файл по URL из хранилища файлов Метабот для вашего бизнеса
[bot.**removeTmpFile**(string $fileUrl): **?string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovetmpfile "bot.removeTmpFile()") Удаляет файл по URL из временного хранилища файлов Метабот для вашего бизнеса
[bot.**uploadFileToCdnAndGetNewUrl**(string $fileUrl, array|object|null $cdnConfig = null): **array**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botuploadfiletocdnandgetnewurl "bot.uploadFileToCdnAndGetNewUrl()") Заливает файл на CDN и возвращает новую ссылку
[bot.**removeFileFromCdn**(string $fileUrl, $cdnConfig = null)](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/botremovefilefromcdn "bot.removeFileFromCdn()") Удаляет файл из CDN
#### Методы lead
МетодОписание
[lead.**getMessenger**(): **int**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetmessenger "lead.getMessenger()") Возвращает обозначение текущего мессенджера канала
[lead.**getMessengerCode**(): **string**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetmessengercode "lead.getMessengerCode()") Возвращает буквенное обозначение текущего мессенджера канала
[lead.**getIdentification**(): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetidentification "lead.getIdentification()") Возвращает идентификатор лида во внешней системе
[lead.**getIdentificationEntity**(): **string|null**](https://docs.metabot24.ru/books/7-spravocnik-po-funkciyam-js/page/leadgetidentificationentity "lead.getIdentificationEntity()") Возвращает дополнительный идентификатор лида во внешней системе