Small library for kik, Telegram, Discord and Facebook Messenger bots
Supported are Kik, Telegram, Discord and Facebook messenger and a chat function on a HTML site (primarily for testing).
The bots are running on a flask server. The Telegram bot and the Discord bot also support the message loop version without a server.
Currently it can only handle incoming text messages (and locations for Telegram and Facebook) and sending text messages and images.
Other functions:
bothelper.Bot.sendText(msg, text, buttons=None)
Send a text message. Supports emojis by ascii name and respects the messaging limits of the platforms.
bothelper.Bot.sendLink(msg, url)
Send a link.
bothelper.Bot.sendPhoto(msg, url)
Send a photo via its url.
bothelper.Bot.sendQuestion(msg, text, buttons=None)
Send a text message that expects an inmediate reply (optionally with predifined reply buttons)
bothelper.Bot.sendQuestionWithReplies(self, msg, text, responses=None, onOtherResponse=None)
Send a text message with predifined reply buttons (a.k.a "quick reply", "InlineKeyboardButton").
bothelper.Bot.user(msg)
Store and retrieve data specific to one user, similiar to sessions in PHP.
https://github.com/cvzi/vicibot
https://github.com/cvzi/chatanonymously
from bothelper import telegrambot
from bothelper import kikbot
from bothelper import facebookbot
from bothelper import htmlbot
from bothelper import discordbot
import bothelper
serv = bothelper.ServerHelper()
class MyMinmalBot(bothelper.Bot):
startMessageText = """Welcome!"""
# Builtin event: called if no other function matches
def onOtherResponse(self, msg):
self.sendText(msg, "Ok. not sure what to do with it. I don't know this command")
@serv.textLike("/start")
def commandStart(self, msg):
# Show the welcome message
self.sendText(msg, self.startMessageText)
@serv.textStartsWith("Hi")
@serv.textStartsWith("Hey")
@serv.textStartsWith("Hello")
def hi(self, msg):
self.sendText(msg, "Hi :winking_face:")
self.sendQuestion(msg, "Do you prefer :cat: or :dog:?", responses=[("Cats", self.showCat), ("Dogs", self.showDog)])
def showCat(self, msg):
self.sendText(msg, ":musical_note: Soft kitty, warm kitty, little ball of fur, ...")
def showDog(self, msg):
self.sendText(msg, "Who let the dogs out?")
@serv.textLike("/help")
@serv.textLike("help")
@serv.textLike("/about")
@serv.textLike("about")
def showHelp(self, msg):
self.sendText(msg, "This is a minimal BotHelper Example. More at: https://github.com/cvzi/bothelper")
if __name__ == '__main__':
TITLE = "Minimal Example Bot"
#HOSTNAME = "https://minimalbot.example.com"
myBot = MyMinmalBot(serv, TITLE)
myBot.addFlaskBot(bottype=htmlbot.HtmlBot, route="/")
#myBot.addFlaskBot(bottype=facebookbot.FacebookBot, route="/facebook", app_secret="123", verify_token="ABC", access_token="XYZ", start_message=myBot.startMessageText)
#myBot.addFlaskBot(bottype=kikbot.KikBot, route="/kik", name="myminimalkikbotname", apikey="ABC", webhook_host=HOSTNAME)
#myBot.addFlaskBot(bottype=telegrambot.TelegramBot, route="/telegram", token="XYZ", webhook_host=HOSTNAME)
#myBot.addBot(bottype=discordbot.DiscordBot, token="MmRI4CLSaNfpT8ap6itJIoIg.TqkHmw.DGBHtV_ggYjDZ9728rZXUa-Bc5L", prefix="mybot!")
myBot.run(port=80) # https://127.0.0.1:80/
- A web server that can host a flask server (e.g. Heroku with gunicorn) (Kik, Telegram and Facebook require a public server for the webhook)
- Flask
- emoji
- telepot (only if you want to use the Telegram bot)
- kik (only if you want to use the Kik bot)
- discord.py (only if you want to use the Discord bot)
- requests (only if you want to use the Facebook Messenger bot)
