mr8bit / herald

Herald - one for all

Herald - one bot, many messengers

Choose language: 🇺🇸 🇷🇺

The project is under development and is not a stable version.

Currently the project only supports:

• Viber
• Telegram
• Vk
• Facebook

In the plans:

• WhatsApp

How to use?

The first step is to configure the project in the file herald/local_settings.py must be set WEBHOOK_SITE - This is a regular encrypted URL https (for the first run and development can use ngrok)

WEBHOOK_SITE = '<WEBHOOK_SITE_HERE>' 

Viber setup

Set Viber tokens and other variables

VIBER_BOT = {
    "VIBER_BOT_NAME": os.getenv('VIBER_BOT_NAME', '<NAME_BOT_HERE>'),
    "VIBER_AUTH_TOKEN": os.getenv('VIBER_AUTH_TOKEN', '<TOKEN_VIBER_BOT_HERE>'),
    "VIBER_AVATAR": os.getenv('VIBER_AVATAR', '<ULR_IMAGE_BOT_HERE>'),
    'WEBHOOK_SITE': WEBHOOK_SITE,
    'WEBHOOK_PREFIX': '/viber',  # (Optional[str]) # If this value is specified,
}

Telegram settings

To set up a Telegram bot, just set a token and all

DJANGO_TELEGRAMBOT = {
    'MODE': 'WEBHOOK',
    'WEBHOOK_SITE': WEBHOOK_SITE,
    'WEBHOOK_PREFIX': '/bot',
    'BOTS': [
        {
            'TOKEN': '<TOKEN_TELEGRAM_BOT>',
        },
    ],
}

Facebook settings

Setting up a Facebook bot is a hassle.

Facebook support based on this library: https://github.com/qwe345asd/pymessenger

pip install git+https://github.com/qwe345asd/pymessenger

FACEBOOK_BOT = {
    'MODE': 'WEBHOOK',
    'WEBHOOK_SITE': WEBHOOK_SITE,
    'WEBHOOK_PREFIX': '/facebook',
    'ACCESS_TOKEN': '<FACEBOOK_ACCESS_TOKEN>',
    'VERIFY_TOKEN': '<FACEBOOK_VERIFY_TOKEN>'
}

About code

User login is in the file herald_bot/states/main.py in class BootStrapState.

class BootStrapState(State):
    def on_enter(self, trigger):
        """It works when a user enters a new state / screen / class"""
        pass
        
    def on_trigger(self, trigger):
        """Handles keystrokes / text sent"""
        trigger.send_message("Hi, this is a Herald, I'm alone and everywhere")
        return BootStrapState() # Transition to another state / screen / class
        
    def on_exit(self, trigger):
        """It works when the user enters the new state / screen / class"""
        pass

How to send messages? And what is in the triger?

trigger.text # Text from user 
trigger.messenger # the messenger from which the message came 0 - Telegram 1 - Viber 
trigger.user_id # id user/chat, chat_id in Telegram, user_id in Viber 
trigger.state # user state, class instance  
trigger.get_user() # Returns a user from bd Django model
trigger.create_user() # Create user
trigger.send_photo(image_path) # Send photos image_path - photo path
trigger.send_message(message) # Posting a message message - Message text
trigger.send_keyboard(message, buttons) # Send a message with the keyboard message - Message text buttons - text array

Based on libraries:

• django-telegrambot
• python-telegram-bot
• viber-bot-python
• vk_api