Установка Artix:TgBot

Для установки Artix:TgBot необходимо cкачать и запустить скрипт установки:

curl https://update.artix.su/static/cs/install_scripts/stable/telegram_bot/install.sh -o /tmp/install.sh
chmod +x /tmp/install.sh
/tmp/install.sh

Для проверки состояния Artix:TgBot выполните команду:

service artixcs-telegram-bot status

Обновление

Для обновления Artix:TgBot необходимо выполнить команды:

sudo apt update
sudo apt install artixcs-telegram-bot

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

curl https://update.artix.su/static/cs/install_scripts/stable/telegram_bot/install.sh -o /tmp/install.sh
chmod +x /tmp/install.sh
/tmp/install.sh stable true

Настройка

Настройка работы Artix:TgBot осуществляется в конфигурационном файле application.properties, расположенном в директории /opt/artixcs-telegram-bot/.

server.port=3300
# spring-boot configs
spring.profiles.active=features
spring.data.mongodb.uri=mongodb://localhost/telegram_bot
# artix telegram-bot configs
su.artix.telegram.bot.token = your_token

su.artix.telegram.bot.accountingservice.prefix = http://localhost:38054/ACC/rest/v1/
su.artix.telegram.bot.accountingservice.user = TELEGRAM_BOT_DEFAULT_TERMINAL
su.artix.telegram.bot.accountingservice.password =
# получать информацию о сгорающих в ближайшее время бонусных баллах
su.artix.telegram.bot.accountingservice.get_expiring_balance = true
# кол-во дней от текущей даты для подсчета сгорающих бонусов
su.artix.telegram.bot.accountingservice.days_from_now_to_count_bonus_expiring = 7

su.artix.telegram.bot.csservice.prefix = http://localhost:38051/CSrest/rest/
su.artix.telegram.bot.csservice.user = admin
su.artix.telegram.bot.csservice.password = admin

su.artix.telegram.bot.salerendererservice.prefix = http://localhost:38067/v1/

su.artix.telegram.bot.counter.prefix = http://localhost:39021
su.artix.telegram.bot.counter.user = admin
su.artix.telegram.bot.counter.password = admin

# enable registration for new users (true, false)
su.artix.telegram.bot.registration.card.enable = true
# requirements for filling out fields when registering a new user (REQUIRED, OPTIONAL, DISABLE)
su.artix.telegram.bot.registration.card.lastname.fill = REQUIRED
su.artix.telegram.bot.registration.card.firstname.fill = REQUIRED
su.artix.telegram.bot.registration.card.middlenname.fill = REQUIRED
su.artix.telegram.bot.registration.card.birthday.fill = REQUIRED
su.artix.telegram.bot.registration.card.gender.fill = REQUIRED
# set client.subscriptionaladj = true and client.communications = TELEGRAM automatically when registration
su.artix.telegram.bot.registration.withsubscribe=false

su.artix.telegram.bot.issuance.card.prefix = http://localhost:8094
su.artix.telegram.bot.issuance.card.user = admin
su.artix.telegram.bot.issuance.card.password = admin

# Statistics (DAYS or MINUTES)
su.artix.telegram.usecase.rule.subscribeuser.cache.unit=DAYS
su.artix.telegram.usecase.rule.subscribeuser.cache.duration=1
su.artix.telegram.usecase.rule.unsubscribeuser.cache.unit=DAYS
su.artix.telegram.usecase.rule.unsubscribeuser.cache.duration=1
su.artix.telegram.usecase.rule.statistics.trimmer.executestart=0 0 0 * * ?
su.artix.telegram.usecase.rule.statistics.trimmer.duration=365

phone_number.out_mask = 7**********
client.age.restrict = 18

StartCommand.buttons.client_data.enable=true

#Форматы отображаемых кодов. Поддерживаемые форматы: QRCode,DataMatrix,Code128
barcode.formats=QRCode

card.number.mask={cardNumber}

# url сервера лицензий
licencecenter.url=ls.artix.su
# токен для авторизации на сервере лицензий
licencecenter.contragentId =

# welcome bonus
welcome.bonus.enable=false
welcome.bonus.amount=1000
welcome.bonus.days.active=7
welcome.bonus.acceptWeight=300
serviceName=artixcs-telegram-bot

localeDirPath=/opt/artixcs-telegram-bot/locale

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

Для создания Telegram-бота необходимо:

1. В приложении Telegram найти и запустить бота @BotFather.
2. Выбрать команду /newbot и задать имя для будущего бота.
3. Токен, полученный от бота @BotFather, указать в настройке su.artix.telegram.bot.token в конфигурационном файле /opt/artixcs-telegram-bot/application.properties.

4. Перезапустить Artix:TgBot командой:

   systemctl restart artixcs-telegram-bot

Настраивание переводов в файле с сообщениями от Telegram-бота

Использование SpEL-выражений

Для использования SpEL-выражения в файле с сообщениями от Telegram-бота, который хранится в директории /opt/artixcs-telegram-bot/locale, необходимо прописать выражение в фигурных скобках, поставив перед ними знак $:

${IT_IS_SPEL}

Модули для использования в SpEL-выражении:

Порядок обращения модулей определяется последовательностью их использования в SpEL-выражении. Используемые модули привязываются к клиенту, выполняющему запрос.

title_menu = Добро пожаловать\n\
             Накопленно ${#BonusModule.balance()} бонусных баллов\n\
             Ожидается к начислению ${#BonusModule.inactiveBalance()} бонусных баллов\n\
             Оплачивайте бонусами до 30% от стоимости покупки\n\
             Ваш уровень: ${(#CounterModule.sumCounter('counterID').compareTo(new java.math.BigDecimal('10000.00')) < 0 || #ClientModule.emailConfirmed() != true) ? 'Начальный' : (#CounterModule.sumCounter('counterID').compareTo(new java.math.BigDecimal('30000.00')) < 0 ? 'Средний' : 'Высокий')}\n\
             Начисление с каждой покупки: ${(#CounterModule.sumCounter('counterID').compareTo(new java.math.BigDecimal('10000.00')) < 0 || #ClientModule.emailConfirmed() != true) ? '5%' : (#CounterModule.sumCounter('counterID').compareTo(new java.math.BigDecimal('30000.00')) < 0 ? '7%' : '10%')}\
             ${#ClientModule.emailConfirmed() != true ? '' : 10000.00-#CounterModule.sumCounter('counterID') > 0 ? '\nДо следующего уровня осталось: ' + (10000.00-#CounterModule.sumCounter('counterID') + ' рублей') :  30000.00-#CounterModule.sumCounter('counterID') > 0 ? '\nДо следующего уровня осталось: ' + (30000.00-#CounterModule.sumCounter('counterID') + ' рублей') : '\nВы на максимальном уровне'}\
             ${#ClientModule.isProfileComplete() ? '' : '\nНе забудьте заполнить профиль, чтобы открыть переход на следующий уровень'}

title_menu = Добро пожаловать\n\
             Накоплено ${#BonusModule.balance()} бонусных баллов\n\
             ${#BonusModule.expiringBalance().amountBurn() == 0 ? '' :\
             'Успейте потратить бонусы: '.concat(#BonusModule.expiringBalance().amountBurn().movePointLeft(2)).concat(' до ').concat(new java.text.SimpleDateFormat("dd MMMM", T(java.util.Locale).of("ru")).format(#BonusModule.expiringBalance().dateEnd()))}\n\

Кнопки "Отписаться от рассылки"/"Подписаться на рассылку"

Для включения кнопок "Отписаться от рассылки"/"Подписаться на рассылку" необходимо:

1. Добавить в конфигурационный файл /opt/artixcs-telegram-bot/application.properties настройку:


   client.unsubscribe.allowed = true

2. В конфигурационном файле /opt/artixcs-telegram-bot/locale/MessagesBundle_Русский.properties можно изменить настройки переводов:

   unsubscribe_promotion_button = Отписаться от рассылки
   subscribe_promotion_button = Подписаться на рассылку
   unsubscribe_promotion_message = Вы решили не получать наши лучшие [и секретные] предложения. Уверены, что не будете скучать️?
   subscribe_promotion_message = Отлично!  Вы решили всегда быть в курсе наших лучших [и секретных] предложений
   unsubscribe_promotion_submit_button = Не хочу получать выгодные предложения
   subscribe_promotion_submit_button = Вперед к выгодным покупкам 
   subscribed_post_message = Теперь Вы не пропустите наши выгодные предложения! Они уже в пути!
   unsubscribed_post_message = Когда Вы не получаете наши акции, в мире становится больше грусти... Но Вы всегда можете передумать и подписаться в настройках профиля

3. Перезапустить Artix:TgBot командой:

   systemctl restart artixcs-telegram-bot

Название валюты

Для изменения названия валюты необходимо в конфигурационном файле /opt/artixcs-telegram-bot/locale/MessagesBundle_Русский.properties изменить настройки переводов:

currency_short_name = руб.

Информация о чеке

Для изменения отображения информации о чеке при просмотре истории покупок используется настройка purchase_item в конфигурационном файле /opt/artixcs-telegram-bot/locale/MessagesBundle_Русский.properties. 

В настройке необходимо указывать SpEL-выражение. Поддержаны следующие поля:

• #purchase.documentId – возвращает идентификатор чека,
• #purchase.shopId – возвращает идентификатор магазина,

• #purchase.date – возвращает дату покупки,

• #purchase.cashSum – возвращает сумму покупки,

• #purchase.bonusSum – возвращает количество начисленных бонусов за покупку,
• #purchase.paymentBonusSum – возвращает количество списанных бонусов за покупку.

purchase_item = #purchase.date + ' - ' + #purchase.cashSum + 'руб. бонус (+' + #purchase.bonusSum + '/-' + #purchase.paymentBonusSum + ' Б)'

purchase_item = 'Чек от ' + #purchase.date + ' на сумму ' + #purchase.cashSum + 'руб.'

Уточнения по работе с Telegram-ботом

• При ошибках валидации лицензии сервис Artix:TgBot продолжает работу, но все операции в чате с Telegram-ботом будут недоступны.
• Сессия создается сразу же, как только пользователь отправил сообщение в чат, и прерывается после 5-ти минут бездействия или при перезапуске бота.
• Измененные данные из раздела "Профиль" поступают на кассовый сервер каждые 10 секунд. Если в течение 10-ти секунд пользователь отправит несколько запросов на изменение, то все они будут отправлены на кассовый сервер как один запрос.
• В один момент времени пользователем может быть выполнена только одна задача. Например, если пользователь запросил список покупок и, не дожидаясь ответа, запросил список акций, то второй запрос выполнен не будет.