7. Справочник по функциям JS
Руководство по функциям JavaScript для Metabot
Справочник всех функций
Получение данных бота Метод Описание bot.getData(string $key): mixed|null Возвращ...
Методы bot
bot.getData()
Получить значение данных бота bot.getData(string $key) Описание: Возвращает значение данных бо...
bot.findLeads()
Получить лида по атрибутам bot.findLeads($columns = [], $where = [], $orderBy = [], ?int $limit ...
bot.scheduleScript()
Планирование скрипта bot.scheduleScript(?int $scriptId, ?int $leadId, ?int $ticketId = null, $...
bot.getScriptIdByName()
Получить ID скрипта по наименованию bot.getScriptIdByName(?string $scriptName) Описание: Возвр...
bot.getScriptIdByCode()
Получить ID скрипта по коду bot.getScriptIdByCode(?string $scriptCode) Описание: Возвращает id...
bot.runScriptForLead()
Запустить скрипт для лида по ID bot.runScriptForLead(?int $scriptId, ?int $leadId, ?int $ticketI...
bot.runScriptByNameForLead()
Запустить скрипт для лида по наименованию bot.runScriptByNameForLead(?string $scriptName, ?int $...
bot.runScriptForPerson()
Запустить скрипт для персоны по ID bot.runScriptForPerson(?int $scriptId, ?int $personId, ?int $...
bot.runScriptByNameForPerson()
Запустить скрипт для персоны по наименованию bot.runScriptByNameForPerson(?string $scriptName, ?...
bot.runScriptByCodeForLead()
Запустить скрипт для лида по коду bot.runScriptByCodeForLead(?string $scriptCode, ?int $leadId, ...
bot.runScriptByCodeForPerson()
Запустить скрипт для персоны по коду bot.runScriptByCodeForPerson(?string $scriptCode, ?int $per...
bot.clearJobsByScriptId()
Очистить джобы по id скрипта bot.clearJobsByScriptId(?int $scriptId, ?int $leadId = null) Описа...
bot.clearJobsByScriptName()
Очистить джобы по наименованию скрипта bot.clearJobsByScriptName(?string $scriptName, ?int $lead...
bot.clearJobsByScriptCode()
Очистить джобы по коду скрипта bot.clearJobsByScriptCode(?string $scriptCode, ?int $leadId = nul...
bot.setAttr()
Установить значение переменной бота bot.setAttr(string $key, string $value) Описание: Обновляе...
bot.getAttr()
Получить значение переменной бота: bot.getAttr(string $key) Описание: Возвращает значение уже ...
bot.getAllAttr()
Получить все переменные бота bot.getAllAttr() Описание: Возвращает значение всех глобальных пе...
bot.issetAttr() и bot.isAttrExist()
Проверить наличие переменной бота bot.issetAttr(string $key) или bot.isAttrExist(string $key) ...
bot.scheduleTrigger()
Планирование триггера bot.scheduleTrigger(?int $triggerId, ?int $leadId, ?int $ticketId = null...
bot.runTriggerByCodeForLead()
Планирование триггера по коду bot.runTriggerByCodeForLead(?string $triggerCode, ?int $leadId, ?i...
bot.runTriggerByCodeForPerson()
Планирование триггера по коду для последнего лида персоны bot.runTriggerByCodeForPerson(?string ...
bot.clearTriggerJobsForLead()
Удалить триггеры для лида bot.clearTriggerJobsForLead(?int $leadId, ?int $ticketId = null) Опис...
bot.clearTriggerJobsForAllPersonLeads()
Удалить триггеры для всех лидов персоны bot.clearTriggerJobsForAllPersonLeads(?int $personId, ?i...
bot.getTriggerIdByName()
Получить ID триггера по наименованию bot.getTriggerIdByName(?string $triggerName) Описание: Во...
bot.getTriggerIdByCode()
Получить ID Триггера по Коду bot.getTriggerIdByCode(?string $triggerCode) Описание: Возвращает...
bot.runTriggerForLead()
Запустить триггер для лида по ID триггера bot.runTriggerForLead(?int $triggerId, ?int $leadId, ?...
bot.runTriggerByNameForLead()
Запустить триггер для лида по наименованию bot.runTriggerByNameForLead(?string $triggerName, ?in...
bot.runTriggerForPerson()
Запустить триггер для персоны по ID bot.runTriggerForPerson(?int $triggerId, ?int $personId, ?in...
bot.runTriggerByNameForPerson()
Запустить триггер для персоны по наименованию bot.runTriggerByNameForPerson(?string $triggerName...
bot.clearTriggerJobsById()
Очистить джобы по id триггера bot.clearTriggerJobsById(?int $triggerId, ?int $leadId = null) Оп...
bot.clearTriggerJobsByName()
Очистить джобы по наименованию триггера bot.clearTriggerJobsByName(?string $triggerName, ?int $l...
bot.clearTriggerJobsByScriptCode()
Очистить джобы по коду скрипта bot.clearTriggerJobsByScriptCode(?string $scriptCode, ?int $leadI...
bot.clearTriggerJobsByIdForTicket()
Очистить джобы по id триггера и ID заявки bot.clearTriggerJobsByIdForTicket(?int $triggerId, ?in...
bot.clearTriggerJobsByNameForTicket()
Очистить джобы по наименованию триггера и ID заявки bot.clearTriggerJobsByNameForTicket(?string ...
bot.scheduleBroadcast()
Планирование рассылки bot.scheduleBroadcast(?int $broadcastId, ?int $ticketId = null, $jobPara...
bot.scheduleBroadcastByCode()
Планирование рассылки по коду bot.scheduleBroadcastByCode(?string $broadcastCode, ?int $ticket...
bot.getBroadcastIdByCode()
Получить ID Рассылки по Коду bot.getBroadcastIdByCode(?string $broadcastCode) Описание: Нахо...
bot.getForwardEventType()
Проверка кто переключил на оператора bot.getForwardEventType() Описание: Эта функция необходим...
bot.isForwardedToOperator()
Проверка переключения на оператора bot.isForwardedToOperator() Описание: Проверяет переключен ...
bot.createTicket()
Создание заявки bot.createTicket($data) Описание: Создает в боте заявку с указанными полями. ...
bot.updateTicketById()
Обновление заявки bot.updateTicketById(int $ticketId, $data) Описание: Обновляет заявку по i...
bot.getMaxRejectsTicketCount()
Получить максимальное количество отказов bot.getMaxRejectsTicketCount() Описание: Возвращает м...
bot.findTickets()
Поиск заявок bot.findTickets($where = [], bool $findInAllBusinessBots = false, $orderBy = [], ...
bot.findTicketIdByCustomField()
Найти id заявки по значению поля bot.findTicketIdByCustomField(string $fieldName, $value) Описа...
bot.getTicketTypeIdByName()
Найти id вида заявки по наименованию bot.getTicketTypeIdByName(string $typeName) Описание: Нах...
bot.getTicketStatusIdByName()
Найти id статуса заявки по наименованию bot.getTicketStatusIdByName(string $statusName) Описани...
bot.setCurrentTicketById()
Установить текущую заявку bot.setCurrentTicketById(?int $ticketId) Описание: Устанавливает тек...
bot.clearTicketAssignedPersonsLog()
Очистить лог назначения тикета персонам bot.clearTicketAssignedPersonsLog() Описание: Очищае...
bot.createPerson()
Создание персоны bot.createPerson($data) Описание: Создает в боте персону с указанными полями....
bot.findPersons()
Поиск персоны bot.findPersons($where = [], $orderBy = [], ?int $limit = null, ?int $offset = nul...
bot.updatePersonById()
Обновить персону по id bot.updatePersonById(int $personId, $data) Описание: Обновляет поля пер...
bot.deletePersonById()
Удалить персону по id bot.deletePersonById(int $personId) Описание: Удаляет персону по id. А...
bot.getIntegrationIdByCode()
Получить id интеграции бота по коду bot.getIntegrationIdByCode(?string $integrationCode) Описан...
bot.getEnabledIntegrationIdByCode()
Получить id включенной интеграции бота по коду bot.getEnabledIntegrationIdByCode(?string $integr...
bot.isEnabledIntegrationById()
Проверить активность интеграции по id bot.isEnabledIntegrationById(?int $integrationId) Описани...
bot.isEnabledIntegrationByCode()
Проверить активность интеграции по коду bot.isEnabledIntegrationByCode(?string $integrationCode)...
bot.getLockNameForBot()
Сгенерировать имя блокировки по боту bot.getLockNameForBot(string $lockName, string $lockPrefix ...
bot.getLockNameForBusiness()
Сгенерировать имя блокировки по бизнесу bot.getLockNameForBusiness(string $lockName, string $loc...
bot.waitForBusinessLock()
Захватить блокировку по бизнесу bot.waitForBusinessLock(string $lockName, string $lockPrefix = '...
bot.waitForBotLock()
Захватить блокировку по боту bot.waitForBotLock(string $lockName, string $lockPrefix = '', ?int ...
bot.releaseAllCurrentLocks()
Освободить все блокировки bot.releaseAllCurrentLocks(): bool Описание: Освобождает все блокиро...
bot.releaseCurrentLockForBusiness()
Освободить блокировку скрипта по бизнесу bot.releaseCurrentLockForBusiness(string $lockName, str...
bot.releaseCurrentLockForBot()
Освободить блокировку скрипта по боту bot.releaseCurrentLockForBot(string $lockName, string $loc...
bot.releaseLockForBusiness()
Освободить блокировку по бизнесу bot.releaseLockForBusiness(string $lockName, string $lockPrefix...
bot.releaseLockForBot()
Освободить блокировку по боту bot.releaseLockForBot(string $lockName, string $lockPrefix = ''): ...
bot.hasLockForBot()
Проверка существования блокировки по боту bot.hasLockLockForBot(string $lockName, string $lockPr...
bot.hasLockForBusiness()
Проверка существования блокировки по бизнесу bot.hasLockForBusiness(string $lockName, string $lo...
bot.getForwardEventType()
Получить название события bot.getForwardEventType() Описание: Возвращает строку "forwarded_by_...
bot.canAutoForward()
Узнать доступно ли авто-назначение оператора в данном скрипте bot.canAutoForward() Описание: Ф...
bot.scheduleJob()
Планирование любой задачи bot.scheduleJob($jobParams = []) Описание: Запускает задачу в соотве...
bot.getIncomingMessage()
Получить текст входящего сообщения bot.getIncomingMessage(bool $useOutputFilter = false) Описан...
bot.getWebhookJobId()
Получить id вебхука зарегистрированного в очереди Метабот bot.getWebhookJobId() Описание: Возв...
bot.getWebhookJob()
Получить информацию о вебхуке bot.getWebhookJob() Описание: Возвращает информацию о вебхуке, т...
bot.getWebhookPayload()
Получить payload входящего вебхука bot.getWebhookPayload() Описание: Возвращает payload входящ...
bot.getLastResultPayload()
Получить payload c данными о последнем ответе мессенджера bot.getLastResultPayload() Описание: ...
bot.getChannelData()
Получить настройки канала лида bot.getChannelData(string|null $key = null) Описание: Получить ...
bot.disableBuffer()
Принудительное отключение буфера исходящих сообщений bot.disableBuffer() Описание: Принудитель...
bot.enableBuffer()
Принудительное включение буфера исходящих сообщений bot.enableBuffer() Описание: Принудительн...
bot.flushBuffer()
Принудительное освобождение буфера исходящих сообщений bot.flushBuffer() Описание: Принудитель...
bot.getAllAttachments()
Получить вложения всех видов bot.getAllAttachments(string|null $filesMimeExcludeFilter = 'image|...
bot.getFiles()
Получить все вложения, которые распознаны как файл bot.getFiles(string|null $mimeIncludeFilter =...
bot.getImages()
Получить все изображения bot.getImages(string|null $mimeIncludeFilter = 'image') Описание: Пол...
bot.getVideos()
Получить все видео bot.getVideos(string|null $mimeIncludeFilter = 'video') Описание: Получить ...
bot.sendPayload()
Отправить payload в мессенджер bot.sendPayload(string|null $endpoint, array|object $payload) Оп...
bot.sendText()
Отправить текст в мессенджер bot.sendText(string|null|mixed $messageText, array|object|null $api...
bot.sendMessage()
Отправить сообщение в мессенджер bot.sendMessage(string|null|mixed $messageText, array|object|nu...
bot.sendButtons()
Отправить кнопки с сообщением в мессенджер bot.sendButtons(string|null|mixed $messageText, array...
bot.getTelegramFileInfoById()
Получить информацию о файле в Telegram bot.getTelegramFileInfoById(string|null $fileId, bool $is...
bot.sendTelegramAttachmentAndGetFileId()
Отправить файл в Телеграм и получить file ID bot.sendTelegramAttachmentAndGetFileId(string|null ...
bot.editTelegramInlineKeyboard()
Отредактировать кнопки меню bot.editTelegramInlineKeyboard(int|string $chatId, int|string $mess...
bot.removeTelegramInlineKeyboard()
Удалить кнопки bot.removeTelegramInlineKeyboard(int|string $chatId, int|string $messageId, strin...
bot.getTelegramLastMessageId()
Получить ID последнего сообщения bot.getTelegramLastMessageId() Описание: Возвращает ID послед...
bot.setCdnConfig()
Установить конфиг для доступа к CDN bot.setCdnConfig(array|object|null $cdnConfig = null) Описа...
bot.setCdnConfig()
Передача конфига коннекта к CDN bot.setCdnConfig(array|object|null $cdnConfig = null) Описание:...
bot.getCdnConfig()
Получить текущий конфиг CDN bot.getCdnConfig() Описание: Возвращает текущий конфиг CDN. Возвр...
bot.getFileInfoByUrl()
Получить информацию о файле по URL bot.getFileInfoByUrl(string $fileUrl) Описание: Возвращает ...
bot.downloadFileFromUrl()
Скачать файла с URL bot.downloadFileFromUrl(string $fileUrl) Описание: Скачивает файл с URL и ...
bot.downloadTmpFileFromUrl()
Скачать файла с URL и загрузить во временное хранилище bot.downloadTmpFileFromUrl(string $fileUr...
bot.removeFile()
Удалить файл по URL bot.removeFile(string $fileUrl) Описание: Удаляет файл по URL из хранилищ...
bot.removeTmpFile()
Удалить файл по URL из временного хранилища bot.removeTmpFile(string $fileUrl) Описание: Удаля...
bot.uploadFileToCdnAndGetNewUrl()
Залить файл на CDN и получить новую ссылку bot.uploadFileToCdnAndGetNewUrl(string $fileUrl, arra...
bot.removeFileFromCdn()
Удалить файл из CDN bot.removeFileFromCdn(string $fileUrl, $cdnConfig = null) Описание: Удаляе...
Методы lead
lead.getData()
Получить значение данных лида lead.getData(string $key) Описание: Возвращает значение данных с...
lead.issetData() и lead.isDataExist()
Проверить наличие данных lead.issetData(string $key) или lead.isDataExist(string $key) Описан...
lead.getSerialNumber()
Порядковый номер лида lead.getSerialNumber() Описание: Возвращает порядковый номер лида в боте...
lead.getChannelCode()
Код канала лида lead.getChannelCode() Описание: Возвращает код канала лида (telegram, umnico, ...
lead.setAttr()
Установить значение переменной лида lead.setAttr(string $key, string $value) Описание: Обновля...
lead.getAttr()
Получить значение переменной лида lead.getAttr(string $key) Описание: Возвращает значение уже ...
lead.getAllAttr()
Получить все переменные лида lead.getAllAttr() Описание: Возвращает значение всех переменных л...
lead.issetAttr() и lead.isAttrExist()
Проверить наличие переменной лида lead.issetAttr(string $key) или lead.isAttrExist(string $key...
lead.deleteAttrs() и lead.deleteAttr()
Удаление переменных лида lead.deleteAttrs(string|object|array|null $attrs, ?int $ticketId = null...
lead.forceDeleteAttrs() и lead.forceDeleteAttr()
Принудительное удаление переменных лида из БД lead.forceDeleteJsonAttrs(string|object|array|null...
lead.deleteJsonAttrs() и lead.deleteJsonAttr()
Удаление json-переменных лида lead.deleteJsonAttrs(string|object|array|null $attrs, ?int $ticket...
lead.forceDeleteJsonAttrs() и lead.forceDeleteJsonAttr()
Принудительное удаление json-переменных лида из БД lead.forceDeleteJsonAttrs(string|object|array...
lead.isInStatus()
Проверка существования статуса у лида lead.isInStatus(string $statusName) Описание: Проверить,...
lead.getStatusId()
Узнать id статуса лида lead.getStatusId() Описание: Возвращает значение поля status_id лида. ...
lead.isTagExist() и lead.issetTag()
Проверить наличие тэга лида lead.isTagExist($some_tag) или lead.issetTag($some_tag) Описание:...
lead.getTag()
Получить значение тэга лида lead.getTag(string $key) Описание: Возвращает значение тэга лида п...
lead.getAllTags()
Получить массив всех тэгов лида lead.getAllTags() Описание: Возвращает массив всех тэгов лида....
lead.addTags() и lead.addTag()
Добавление тэгов лида lead.addTags(string|object|array|null $tags, ?int $ticketId = null, $scrip...
lead.deleteTags() и lead.deleteTag()
Удаление тэгов лида lead.deleteTags(string|object|array|null $tags, ?int $ticketId = null, $scri...
lead.forceDeleteTags() и lead.forceDeleteTag()
Принудительное удаление тэгов лидаиз БД lead.forceDeleteTags(string|object|array|null $tags, ?in...
lead.setForwarded()
Переключить на оператора lead.setForwarded(bool|int $state) Описание: Установка ($state == tru...
lead.getPersonId()
Получить id персоны lead.getPersonId() Описание: Возвращает id персоны лида. Возвращает: i...
lead.setPersonId()
Привязать персону к лиду lead.setPersonId(?int $personId) Описание: Привязывает к лиду персо...
lead.createPersonForCurrentLead()
Создать персону для лида lead.createPersonForCurrentLead($data) Описание: Создает персону дл...
lead.isContextExist() и lead.issetContext()
Проверить наличие контекста лида lead.isContextExist(string $key) или lead.issetContext(string...
lead.getContext()
Получить значение контекста лида lead.getContext(string $key) Описание: Возвращает значение ко...
lead.getAllContexts()
Получить массив всех контекстов лида lead.getAllContexts() Описание: Возвращает массив всех ко...
lead.setActiveNlpIntegrationByCode()
Присвоить интеграцию лиду по коду lead.setActiveNlpIntegrationByCode(?string $integrationCode) ...
lead.canAutoForward()
Узнать доступно ли авто-назначение оператора в данном скрипте lead.canAutoForward() Описание: ...
lead.getNextOperators()
Вернуть список следующих операторов lead.getNextOperators(string $departmentCode = null, bool $i...
lead.assignDialogToNextOperator()
Назначить диалог на следующего оператора lead.assignDialogToNextOperator(string|null $department...
lead.assignDialogToOperator()
Назначить диалог на указанного оператора lead.assignDialogToOperator(int|null $operatorId, bool ...
lead.getLastRequest()
Получить объект с параметрами последнего реквеста lead.getLastRequest() Описание: Находит посл...
lead.getMessengerCode()
Получить буквенное обозначение текущего мессенджера канала lead.getMessengerCode() Описание: В...
lead.getIdentification()
Получить идентификатор лида во внешней системе lead.getIdentification() Описание: Возвращает и...
lead.getIdentificationEntity()
Получить дополнительный идентификатор лида во внешней системе lead.getIdentificationEntity() Оп...
lead.getMessenger()
Получить текущий мессенджер lead.getMessenger() Описание: Метод для получения обозначения теку...
Методы ticket
ticket.update()
Обновление заявки, через объект заявки ticket.update($data) Описание: Обновляет заявку соответ...
ticket.getData()
Получить значение данных заявки ticket.getData(string $key) Описание: Получить значение данных...
ticket.getCustomData()
Считывание произвольных полей заявки ticket.getCustomData(string $key) Описание: Находит зна...
ticket.issetData() и ticket.isDataExist()
Проверить наличие данных по заявке ticket.issetData(string $key) или ticket.isDataExist(string...
ticket.reloadCustomData()
Перезагрузка кастомных данных ticket.reloadCustomData(bool $isReloadModel = false) Описание: ...
ticket.setAllCustomData()
Переопределить список кастомных полей ticket.setAllCustomData(array $customData) Описание: Н...
ticket.getAllCustomData()
Получить список кастомных полей ticket.getAllCustomData() Описание: Возвращает значения всех...
ticket.setCustomData()
Установить значение кастомного поля ticket.setCustomData(string $key, $value) Описание: Уста...
ticket.issetCustomData()
Имеет ли значение кастомное поле ticket.issetCustomData(string $key) Описание: Проверяет сущ...
ticket.isCustomDataExist()
Существует ли кастомное поле ticket.isCustomDataExist(string $key) Описание: Проверяет с...
ticket.getTicketTypeName()
Получить название типа заявки ticket.getTicketTypeName() Описание: Находит название типа заявк...
ticket.getStatusId() и ticket.getAttr('status_id')
Получить ID статуса заявки ticket.getStatusId() или ticket.getAttr('status_id') Описание: На...
ticket.getStatusName()
Получить название статуса заявки ticket.getStatusName() Описание: Находит название статуса зая...
ticket.getStatusType()
Получить тип статуса заявки ticket.getStatusType() Описание: Находит тип статуса заявки. Возв...
ticket._sanitizeString()
Приведение названия статуса к стандартному виду ticket._sanitizeString($string) Описание: Вспо...
ticket.isInStatus()
Проверить статус заявки ticket.isInStatus($statusName) Описание: Проверить, что заявка находит...
ticket.setStatusId()
Установить статус заявки по id ticket.setStatusId(int|null $statusId, int|null $personQueueIdFor...
ticket.setStatusByName()
Установить статус заявки по имени ticket.setStatusByName(string $statusName, int|null $personQue...
ticket.reloadTicket()
Загрузить заявку повторно ticket.reloadTicket() Описание: Загрузить заявку повторно из БД. Авт...
ticket.getAuthorPersonId()
Получить ID автора заявки ticket.getAuthorPersonId() Описание: Возвращает id автора заявки. В...
ticket.getAssignedPersonId()
Получить ID исполнителя заявки ticket.getAssignedPersonId() Описание: Возвращает id исполнител...
ticket.getClientPersonId()
Получить ID клиента заявки ticket.getClientPersonId() Описание: Возвращает id клиента заявки. ...
ticket.getAuthorPersonFullName()
Получить ФИО автора заявки ticket.getAuthorPersonFullName() Описание: Возвращает ФИО автора за...
ticket.getAssignedPersonFullName()
Получить ФИО исполнителя заявки ticket.getAssignedPersonFullName() Описание: Возвращает ФИО ис...
ticket.getClientPersonFullName()
Получить ФИО клиента заявки ticket.getClientPersonFullName() Описание: Возвращает ФИО клиента ...
ticket.getAuthorPersonRoleId()
Получить ID роли автора заявки ticket.getAuthorPersonRoleId() Описание: Возвращает ID роли авт...
ticket.getAssignedPersonRoleId()
Получить ID роли исполнителя заявки ticket.getAssignedPersonRoleId() Описание: Возвращает ID р...
ticket.getClientPersonRoleId()
Получить ID роли клиента заявки ticket.getClientPersonRoleId() Описание: Возвращает ID роли кл...
ticket.getAuthorPersonRoleName()
Получить имя роли автора заявки ticket.getAuthorPersonRoleName() Описание: Возвращает имя роли...
ticket.getAssignedPersonRoleName()
Получить имя роли исполнителя заявки ticket.getAssignedPersonRoleName() Описание: Возвращает и...
ticket.getClientPersonRoleName()
Получить имя роли клиента заявки ticket.getClientPersonRoleName() Описание: Возвращает имя рол...
ticket.getAuthorPersonRoleTitle()
Получить заголовок роли автора заявки ticket.getAuthorPersonRoleTitle() Описание: Возвращает з...
ticket.getAssignedPersonRoleTitle()
Получить заголовок роли исполнителя заявки ticket.getAssignedPersonRoleTitle() Описание: Возвр...
ticket.getClientPersonRoleTitle()
Получить заголовок роли клиента заявки ticket.getClientPersonRoleTitle() Описание: Возвращает ...
ticket.getAuthorPersonRoleFormattedTitle()
Получить форматированное название роли автора заявки ticket.getAuthorPersonRoleFormattedTitle() ...
ticket.getAssignedPersonRoleFormattedTitle()
Получить форматированное название роли исполнителя заявки ticket.getAssignedPersonRoleFormattedT...
ticket.getClientPersonRoleFormattedTitle()
Получить форматированное название роли клиента заявки ticket.getClientPersonRoleFormattedTitle()...
ticket.getPerson1Id()
Получение id первой дополнительной персоны ticket.getPerson1Id() Описание: Возвращает id пер...
ticket.getPerson2Id()
Получение id второй дополнительной персоны ticket.getPerson2Id() Описание: Возвращает id вто...
ticket.getPerson3Id()
Получение id третьей дополнительной персоны ticket.getPerson3Id() Описание: Возвращает id тр...
ticket.setPerson1Id()
Установка id первой дополнительной персоны ticket.setPerson1Id(int|null $personId) Описание: ...
ticket.setPerson2Id()
Установка id второй дополнительной персоны ticket.setPerson2Id(int|null $personId) Описание: ...
ticket.setPerson3Id()
Установка id третьей дополнительной персоны ticket.setPerson3Id(int|null $personId) Описание:...
ticket.assignToNextQueuePerson()
Назначить заявку следующему исполнителю ticket.assignToNextQueuePerson(int $queueMode = 1, int|n...
ticket.moveAssignedPersonToEndOfQueue()
Перенести исполнителя в конец очереди ticket.moveAssignedPersonToEndOfQueue(int $queueMode = 1, ...
ticket.assignToPersonById()
Назначить исполнителя заявки ticket.assignToPersonById(int|null $personId, int|null $personQueue...
ticket.getAssignedPersonRejectsCount()
Получить количество отказов от заявок ticket.getAssignedPersonRejectsCount(int|null $personQueue...
ticket.setAssignedPersonRejectsCount()
Установить количество отказов от заявок ticket.setAssignedPersonRejectsCount(int $rejectsCount, ...
ticket.incAssignedPersonRejectsCount()
Увеличить количество отказов от заявок ticket.incAssignedPersonRejectsCount(int|null $personQueu...
ticket.assignToNextPersonAndMoveToEnd()
Назначить заявку следующему исполнителю и перенести в конец очереди ticket.assignToNextPersonAnd...
Методы ticketStatuses
ticketStatuses.reload()
Перезагрузить все статусы из БД ticketStatuses.reload() Описание: Перезагружает все статусы из...
ticketStatuses.getCollection()
Получить Laravel Collection ticketStatuses.getCollection() Описание: Возвращает коллекцию стат...
ticketStatuses.find()
Поиск статусов ticketStatuses.find(array|object|null $where, bool $isReturnCollection = false) ...
ticketStatuses.findById()
Поиск статуса по ID ticketStatuses.findById(string|int|null $id) Описание: Находит статус соот...
ticketStatuses.findByName()
Поиск статуса по имени ticketStatuses.findByName(string $name) Описание: Находит статус соотве...
ticketStatuses.findAllByNames()
Поиск статусов по имени ticketStatuses.findAllByNames(string|array|object|null $names, string $o...
ticketStatuses.findAllByTypes()
Поиск статусов по типу статуса ticketStatuses.findAllByTypes(string|array|object|null $types, st...
Методы person
person.update()
Обновить персону person.update($data) Описание: Обновляет данные персоны в соответствии с ...
person.delete()
Удалить персону person.delete() Описание: Удаляет персону лида. Возвращает: bool - подтв...
person.getAllData()
Получить все поля персоны person.getAllData() Описание: Возвращает значения всех полей персо...
person.setData()
Установить поле персоны person.setData(string $key, $value) Описание: Заполняет указанное по...
person.getData()
Получить значение данных персоны person.getData(string $key) Описание: Возвращает значение д...
person.issetData() и person.isDataExist()
Проверить наличие данных по персоне person.issetData(string $key) или person.isDataExist(str...
person.getId()
Получить ID персоны person.getId() Описание: Возвращает id персоны привязанной к лиду. Возв...
person.getFullName()
Получить полное имя персоны person.getFullName() Описание: Возвращает полное имя персоны лид...
person.getRoleId()
Получить ID роли персоны person.getRoleId() Описание: Возвращает id роли привязанной к персо...
person.getRoleName()
Получить название роли персоны person.getRoleName() Описание: Возвращает название роли привя...
person.getRoleTitle()
Получить заголовок роли персоны person.getRoleTitle() Описание: Возвращает заголовок роли пр...
person.getRoleFormattedTitle()
Получить форматированное название роли персоны person.getRoleFormattedTitle() Описание: Возв...
person.getPhone()
Получить номер телефона персоны person.getPhone() Описание: Находит номер телефона персоны л...
person.setPhone()
Установить номер телефона персоны person.setPhone(?string $phone) Описание: Устанавливает ...
person.getEmail()
Получить почту персоны person.getEmail() Описание: Находит адрес электронной почты персоны л...
person.addToQueue()
Добавление персоны в очередь person.addToQueue(?int $personQueueId = null, ?string $personQueueT...
person.removeFromQueue()
Удаление персоны из очереди person.removeFromQueue(?int $personQueueId = null, ?string $personQu...
person.moveToEndOfQueue()
Перемещение персоны в конец очереди person.moveToEndOfQueue(int $queueMode = 1, ?int $personQueu...
person.setIsActiveInQueue()
Активация/деактивация персоны в очереди person.setIsActiveInQueue(bool $isActive = true) Опис...
Методы personQueues
personQueues.find()
Найти очередь исполнителей personQueues.find($where, bool $isReturnCollection = false) Опис...
personQueues.findById()
Найти очередь исполнителей по id personQueues.findById(string|int|null $id) Описание: Нахо...
personQueues.findAllByTitles()
Найти очереди исполнителей по заголовку personQueues.findAllByTitles(string|array|object|nul...
personQueues.findByCode()
Найти очередь исполнителей по коду personQueues.findByCode(string $code, bool $isEnabled = n...
personQueues.findAllByCodes()
Найти очереди исполнителей по коду personQueues.findAllByCodes($codes, bool $isEnabled = nul...
personQueues.reload()
Обновить очередь исполнителей personQueues.reload() Описание: Обновляет данные очередей ис...
personQueues.getCollection()
Получить коллекцию очередей исполнителей personQueues.getCollection() Описание: Возвращает...
Методы table
table.createItem()
Создание записи table.createItem(string $tableName, array|object $data) Описание: Создает запи...
table.find()
Поиск записей table.find(string $tableName, array|object $columns = [], array|object $where = []...
table.count()
Подсчет количества записей table.count(string $tableName, array|object $where = []) Описание: ...
table.sum()
Подсчет суммы по полю table.sum(string $tableName, string $column, array|object $where = []) Оп...
table.max()
Поиск максимального значения по полю table.max(string $tableName, string $column, array|object $...
Методы для строки полученной через метод table
item.update()
Обновление записи item.update(array|object $data) Описание: Изменяет значение указанной записи...
item.delete()
Удаление записи item.delete() Описание: Удаляет указанную запись item в таблице. Возвращает: ...
item.getDateFormatted()
Получить форматированную дату по названию поля item.getDateFormatted(string $fieldName, string $...
item.getDateFormattedString()
Получить форматированную дату из произвольной строки item.getDateFormattedString(string $date, s...
item.reload()
Перезагрузить данные записи из бд item.reload() Описание: Перезагружает значение записи из бд ...
Методы для строки полученной через getLastRequest
Примеры использования методов
Использование методов блокировок
Ниже представлен JS скрипт на примере которого будет рассмотрена работа с методами блокировок. b...
Использование методов планирования времени
Установить время задержки для выполнения функции можно двумя способами: Метод setTimeout(); ...
Использование методов работы с файлами
Ниже представлен JS скрипт на примере которого будет рассмотрена работа с файлами. // ----------...
Методы api
api.request()
Выполнить HTTP запрос api.request(string $method, string $uri, $requestOptions = [], $httpClient...
api.post()
Выполнить HTTP POST запрос api.post(string $uri, $body = [], $requestOptions = [], $headers = []...
api.get()
Выполнить HTTP GET запрос api.get(string $uri, $requestOptions = [], $headers = [], $httpClientC...
api.getJson()
Выполнить HTTP GET запрос api.getJson(string $uri, $jsonBody = null, $headers = [], $requestOpti...
api.postJson()
Выполнить HTTP POST запрос api.postJson(string $uri, $jsonBody = [], $headers = [], $requestOpti...
api.getHttpConfig()
Получить HTTP Config api.getHttpConfig() Описание: Возвращает HTTP Config. Возвращает: array...
api.setHttpConfig()
Установить HTTP Config api.setHttpConfig($config) Описание: Устанавливает HTTP Config. Атрибу...
api.getRequestOptions()
Получить параметры HTTP запроса api.getRequestOptions() Описание: Возвращает параметры HTTP за...
api.setRequestOptions()
Установить параметры HTTP запроса api.setRequestOptions($options) Описание: Устанавливает пара...
api.getHeaders()
Получить заголовки HTTP запроса api.getHeaders() Описание: Возвращает заголовки HTTP запроса. ...
api.setHeaders()
Установить заголовки HTTP запроса api.setHeaders($headers) Описание: Устанавливает заголовки H...
api.getProxyUrl()
Получить Proxy Url HTTP запроса api.getProxyUrl() Описание: Возвращает Proxy Url HTTP запроса....
api.setProxyUrl()
Установить Proxy Url HTTP запроса api.setProxyUrl($proxyUrl) Описание: Устанавливает Proxy Url...
api.getLastResponseCode()
Получить код последнего ответа HTTP запроса api.getLastResponseCode() Описание: Возвращает код...
api.getLastResponseContent()
Получить содержимое последнего ответа HTTP запроса api.getLastResponseContent() Описание: Возв...
api.getLastJsonResponse()
Получить последний ответ HTTP запроса в формате JSON api.getLastJsonResponse() Описание: Возвр...
api.getLastResponse()
Получить последний ответ HTTP запроса api.getLastResponse() Описание: Возвращает последний отв...
api.setTimeout()
Установить время задержки для HTTP запросов api.setTimeout(float $timeout) Описание: Устанавли...
api.getTimeout()
Получить время задержки для HTTP запросов api.getTimeout() Описание: Возвращает время задержки...
api.isExceptionThrown()
api.isExceptionThrown() Описание: Возвращает: bool — .
api.getLastResponseTime()
Получить время последнего ответа HTTP запроса api.getLastResponseTime() Описание: Возвращает в...
api.getLastErrorBody()
Получить содержимое ошибки последнего ответа HTTP запроса api.getLastErrorBody(bool $isAutoConve...
api.callEndpoint()
Вызвать внешнее API из чат-бота api.callEndpoint( string $externalApiEndpointCode, string...
api.enableExceptions()
Включить исключения для HTTP запросов api.enableExceptions() Описание: Включает исключения для...
api.disableExceptions()
Выключить исключения для HTTP запросов api.disableExceptions() Описание: Выключает исключения ...
api.enableContinueCallEndpointOnJsError()
Включить вызов эндпоинта при ошибке JS api.enableContinueCallEndpointOnJsError() Описание: Вкл...
api.disableContinueCallEndpointOnJsError()
Выключить вызов эндпоинта при ошибке JS api.disableContinueCallEndpointOnJsError() Описание: В...
api.getIsContinueCallEndpointOnJsError()
Получить режим вызова эндпоинта при ошибке JS api.getIsContinueCallEndpointOnJsError() Описание...