Документация v2.1

На главную

Начало работы

Установка

Установка ПО

Чтобы установить систему воспользуйтесь мастером установки

Настройка системы

Вход в систему

При первом запуске создается по умолчанию создается учетная запись администратора, которая нужна для настройки системы. Также можно воспользоваться мастер-паролем

Данные для входа

Поле Данные
Логин admin
Пароль admin

После входа рекомендуется изменить пароль или создать новую учетную запись

Системные настройки

Чтобы попасть на страницу настроек нужно нажать на логотип, который находиться на странице выбора чат-бота или указать путь /settings/

В настройках вы можете указать данные согласно вашим требованиям

При первом запуске настройки выставлены по умолчанию

Функции

В правой части страницы (на маленьких экранах в верхней части) отображаются кнопки:

Название Действие Требования
Создать резервную копию Незапланированное создание резервной копии и копирование во все указанные пути Указан минимум 1 путь для создания
Сохранить статистику ботов Сохраняет ежемесячную статистику всех чат-ботов. Используется если система не работала больше двух месяцев и статистика не сохранилась автоматически после запуска Нет
Запустить всех ботов Запускает всех доступных ботов Нет
Импорт лог-файла сервера Импортирует все логи веб-сервера системы Нет
Импорт лог-файла авторизации Импортирует файл .xlsx с данными об авторизации пользователей системы Нет

 

Настройки

Группа Поле Описание Формат ввода
Основное Расширения файлов Укажите все расширений файлов, разрешенные для загрузки на сервер Введите имя расширений через пробел. Пример: .pdf .docx .pttx .xlsx
Чат-боты Автоматический запуск чат-ботов Запуск всех доступных чат-ботов при запуске системы Вкл/Выкл
Перс. сообщения чат-ботов Возможность отправки персональных сообщений пользователям чат-бота и сбор контактных данных Вкл/Выкл
Обращения чат-ботов Возможность отправки обращений пользователями чат-бота Вкл/Выкл
Безопасность IP администратора Указанный IP-адрес не будет блокироваться при неправильном вводе пароля (не рекомендуется при динамическом IP) 255.255.255.255
Блокировка при неправильном вводе пароля Кол-во попыток авторизации. После вохможного воличества попыток пользователь блокируется и заносится в стоп-лист системы с причиной "Попытка входа в систему с неверными данными" Список
Аудит Ведение аудита Если включено, то в аудит будут записываться данные о действиях всех пользователей в системе (кроме мастер-аккаунта) Вкл/Выкл
Резервные копии Создание резервной копии Промежуток времени для создания резервной копии. В резервной копии сохраняются такие данные как: база данных, файлы чат-ботов, лог-файл системы Список
Пути сохранения резервных копий Все последующие резервные копии будут перемещены в указанные каталоги Абсолютный путь
Архивирование Если включено, то при создании резервных копий данные будут помещены в архив .zip и перемещены в указанные каталоги Вкл/Выкл

Настройка бота

Получение токена

Для получения токена воспользуйтесь чат-ботом BotFather

Введите все данные, которые запрашивает у вас данный чат-бот. После всех действий бот отправит вам API токен

Создание бота

Для создания бота необходимо наличие токена. На странице выбора чат-бота для управления нажмите кнопку "Подключить" и введите API токен, а также укажите тип чат-бота

Управление ботом (тип 1)

Сводка

На начальной странице отображается текущаяя статистика и записи ежемесячной статистики обращений. В верхнем правом углу распологается кнопка запуска(остановки) чат-бота

После текущей статистики распологается группа ежемесячной статистики, которую можно экспортировать в файл

Чтобы вернуться к выбору чат-ботов нужно нажать на имя текущего, расположенное в верхнем левом углу

Статистика

На странице отображается статистика рассмотрения обращений пользователей

Пользователи

На данной странице отображаются пользователи системы, которых можно редактировать, создавать и удалять

Для создания пользователя нажмите кнопку "Создать" и заполните форму в соответствии с вашими пожеланиями

У пользователей есть права, которые определяются администратором

Тип пользователей зависит от места создания. Если учетная запись была создана во вкладке "Справочник" бота второго типа, то учетная запись будет носить соответствующий тип

Роли учетных записей

Роль Доступ Примечание
Администратор Полный доступ к системе Рекомендуется создавать не более 10 пользователей с ролью администратора
Редактор Доступ к редактированию, созданию и удалению команд
Руководитель Полный доступ к статистике всех ботов Руководитель может просматривать только страницы со статистикой (Сводка, Статистика) всех чат-ботов
Модератор Доступ к статистике работы координаторов Модератор имеет доступ к ботам такого же типа, что и его учетная запись
Координатор Доступ к работе с пользователями Координатор имеет доступ к ботам такого же типа, что и его учетная запись

Команды

На странице команд отображаются все команды бота, выбранного для управления. Команды можно добавлять двумя способами: вручную и при помощи файла

Создание команд при помощи файла .xlsx

Название Описание Формат ввода
cmg Триггер для активации команды Текст
ans Ответ, отправляемый ботом при активации триггера Текст
ans_file Файл, отправляемый ботом при активации триггера
Если был указан файл, то в меню и в ответе можно указать пробел
Указанные файл требуется поместить в каталог %путь к катологу системы%\bots\%ID чат-бота%
Имя файла без пути
menu Пункты меню, отображаемые при отправки ответа пользователю Текст

Настройки бота

В настройках бота отображаются все данные чат-бота, которые определяются автоматически. Для обновления данных введите токен и сохраните изменения, изменения тутже вступят в силу

Для получения токена необходимо обратиться к боту BotFather и ввести в форму полученный токен, после чего сохранить изменения

Аудит

Ведение аудита зависит от настроек системы. аудит нельзя очистить.Чтобы экспортировать все записи аудита выбранного бота, нажмите на кнопку "Экспорт в файл (xlsx)"

Журнал

В журнале пользователей отображается информация о текущих подключениях к системе

Функции, описанные ниже не распространяются на пользователя, чей IP указан в настройках системы в качестве IP администратора

Функции

Функция Описание Примечание
Завершить работу Завершение сессии выбранного пользователя и удаление его из списка авторизованных Если у пользователя имелись несохраненные изменения, то они удалятся при завершении его работы
Заблокировать Завершение сессии и внесение в стоп-лист системы выбранного пользователя Заблокированные пользователи не могут пользоваться системой. При попытке авторизации отображается страница с информацией о блокировке (причина)

Перс. сообщения

На данной странице отображаются пользователи чат-бота, которые дали согласие на отправку персональных сообщений

Функции

Функция Описание Примечание
Рассылка (всем) Рассылка всем пользователям, которые когда-либо пользовались чат-ботом
Рассылка (xlsx) Рассылка всем зарегистрированным пользователям, которые указаны в шаблоне рассылки и имеются в базе данных Для отправки требуется заполненный шаблон рассылки
Запланировать рассылку (всем) Создание запланированной рассылки всем пользователям, которые когда-либо пользовались чат-ботом Максимальный срок ожидания рассылки - 21 день
Запланировать рассылку (xlsx) Создание запланированной рассылки зарегистрированным пользователям, которые указаны в шаблоне рассылки и имеются в базе данных Для отправки требуется заполненный шаблон рассылки. Максимальный срок ожидания рассылки - 21 день

История рассылок

В истории рассылок отображается информация о всех отправленных рассылках

Запланированные рассылки

На странице отображаются все запланированные рассылки и информация о них, нажмите кнопку "Отменить" для отмены отправки рассылки

Стоп-лист системы

На данной странице отображаются заблокированные пользователи, их IP-адрес и причина блокировки, нажмите кнопку "Разблокировать" для снятия блокировки с пользователя. Заблокированные пользователи не могут пользоваться системой. При попытке авторизации отображается страница с причиной блокировки

Стоп-лист бота

На данной странице отображается информация о заблокированных пользователях бота(ID и причина блокировки). Заблокированные пользователи не могут пользоваться чат-ботом. При попытке взаимодействия с чат-ботом пользователь получит сообщение с информацией о блокировке. При помощи кнопки "Разблокировать" можно снять блокировку с пользователя

Обращения

На данной странице отображаются обращения пользователей. Их можно назначать специалистам, удалять, отвечать на них и блокировать отправителя

Управление ботом (тип 2)

Статистика

На этой странице отображается свод статистики для бота второго типа, а именно: кол-во заказанных и расмотренных звонков, информация о количестве зареигистрированных пользователей и статусе активации их учетной записи. Ниже находиться сводная таблица статистики по координаторам.

Справочник

В справочнике находиться информация о координаторах и модераторах чат-бота второго типа, здесь можно создать, редактировать и удалить учетную запись пользователя чат-бота второго типа(модератор или координатор)

Зарегистрированные пользователи

На этой странице отображается зарегистрированные пользователи и их данные, а именно: номер телефона, ID, № ПКУ, закрепленный координатор, пароль и статус активации учетной записи

Добавление пользователей при помощи импорта из файла (xlsx)

Название Описание Примечание
phn_number Номер телефона добавляемого пользователя При сохранении все номера телефонов будут приведены в формат 8
nmb_pku Номер учетной записи ПКУ
cur ID учетной записи куратора. Получить список ID можно на странице справочника

 

Рассылки

Функция Описание Примечание
Рассылка Рассылка зарегистрированным в боте второго типа пользователям, которые активировали свою учетную запись
Рассылка с обратной связью В рассылке с обратной связью можно создать варианты ответа на вопрос, заданный в тексте сообщения Для отправки требуется заполненный шаблон рассылки

Мои обслуживаемые

Страница содержит информацию о запросах на обратную связь (звонок). При нажатии на строку в таблице вы перейдете на страницу, где сможете изменить статус запроса.Статус звонка можно изменить только один раз

Встречи

На этой странице отображается информация о встречах. При нажатии на строку в таблице вы перейдете на страницу, где сможете изменить статус встречи. Статус встречи можно изменить только один раз

Дополнение

Мастер-пароль

Мастер-пароль - учётная запись, встроенная в систему, используется если утерян пароль от пользователей с правами администратора или для подтверждения действий

Данная учётная запись не отоборажается в аудите и журнале пользователей и её невозможно удалить

Ошибки

Во время работы могут возникнуть как ошибки чат-бота так и ошибки системы. Здесь описаны возможные ошибки и способы их решения. Если это не помогло, то обратитесь в тех. поддержку

Возможные ошибки системы

Ошибка Причина Действия
CertificateNotFound Сертификат не был найден в папке cert Проверьте наличие сертификата в папке cert
CertificateIsNotValid Срок действия сертификата истек, сертификат был выдан не центром сертификации scbots.tech или данные сертификата не совпадают с данными системы Запросите перевыпуск сертификата
NetworkCardError Количество действующих сетевых карт превышает допустимое и система не можт запуститься сразу на всех Оставьте только одну сетевую карту на которой будет работать система, а остальные отключите

 

Возможные ошибки чат-бота

Ошибка Причина Действия
RemoteDisconnected Ошибка подключения к серверу api.telegram.org Данная запись является не ошибкой, а уведомелнием о том, что было произведено переподключение к серверу api.telegram.org
Connection aborted
HTTPSConnectionPool: Read timed out
Bad Request: can't parse entities: Can't find end of the entity starting at byte offset Данная ошибка была вызвана командой чат-бота, а именно ответом Найдите команду с разметкой сообщения и проверьте правильность написание специальных символов разметки: каждый символ должен находиться в паре с другим таким же символом
A request to the Telegram API was unsuccessful. Error code: 400. Description: Bad Request: message text is empty Попытка отправки пустого ответа Найдите команду у которой не указан файл и ответ, отредактируйте команду так, чтобы выполнялись условия создания

Тех. характеристики

Требования для работы системы

Название Значение
Открытые порты 5000 (TCP)
443 (TCP)
80 (TCP)
Поддерживаемые ОС Windows (версия ядра 10.0 и выше)
ОЗУ 2 ГБ
Место на диске 1 ГБ