telegram_bot_helper's Introduction

telegram-bot-helper

Some utils to ease the connection with Telegram bot API

They include a TelegramAPIHelper class that will help you to manage retrieving and sending messages through the Telegram API. A Emoji class that should (when added more) give you a easy way to send emoticons. And a MessageProcessor/Job classes that will help you to handle some common bot answering.

JOB DESCRIPTION

The kind of jobs that this library would handle should be described in a JSON file this way:

[
{
    "job_id": "info",
    "message_type": "command",
    "keywords": ["start", "info"],
    "countdown": 3,
    "minutes_timeout": 20,
    "job_action": "phrase",
    "data": "We are working on it. In the meanwhile you will have to look at the code."
}
]

job_id: is an optional field to name the job
message_type: Indicates the type of messages that would trigger the action. There are three currently suported message types
user_message: After a user has written a message
command: After anyone has invoked our bot command /command
repeated_message: After a user(s) has(ve) written a message some number of times
keywords: The command or text we are looking for
minutes_timeout: For repeated_message the number of minutes within the keywords have to been written
countdown: For repeated_message the number of times the keywords have to appear
frequency: Return the job result only this % of times
job_action: The action triggered. There are currently five kind of job_actions suported:
phrase: Returns the data string
random_phrase: Returns a random string from the data strings list
blog_link: Returns a non used (in 24 hours) blog link from the RSS present at data field
audio: Returns a voice message already uploaded to Telegram servers which id is stored at data field
custom_poll: Returns a string (first item of the string list) with a custom keyboard of answers that are the rest of the string list
data: The data used to return a value

telegram_bot_helper's People

Contributors

Watchers

telegram_bot_helper's Issues

Bot can reply a already uploaded voice message

Improve message matching

It currently matches a "needle" if it is at the beginning of the message, or at the end, or inside it between blank spaces, or the message is the needle.

We should use re to obtain a better matching procedure.

Add unittests

As the project is gaining more complexity it starts being mandatory to have some kind of quick/automated testing.

I've collected some messages retrieved from Tg API, but we can collect easily as many as we may need.

Add possiblity to define a random link for the new blog_link option

So for example you can use the link http://c.xkcd.com/random/comic/ to get a new link and it sends it. Or even better it detects directly if it's a rss or a randomizer directly :)