How to filter incoming messages#

Installation#

Installation:

python -m pip install whatsapp-chatbot-python

Import#

from whatsapp_chatbot_python import GreenAPIBot, Notification

Examples#

How to initialize an object#

bot = GreenAPIBot(
    "1101000001", "d75b3a66374942c5b3c019c698abc2067e151558acbd412345"
)

How to filter incoming messages#

Messages can be filtered by chat, sender, message type, and text. To filter chat, sender, and message type, you can use a string (str) or a list of strings (list[str]). The message text can be filtered by text, command, and regular expressions. Below is a table with filter names and possible values.

How to add filters through the decorator#

@bot.router.message(command="command")

How to add filters with the function#

bot.router.message.add_handler(handler, command="command")

How to filter messages by chat, sender, or message type#

To filter messages by chat, sender, or message type, you must add a string (str) or a list of strings (list[str]).

from_chat = "11001234567@c.us"

from_sender = "11001234567@c.us"

type_message = ["textMessage", "extendedTextMessage"]

How to filter messages by message text or regular expressions#

You must add a string (str) to filter messages by text or regular expressions.

text_message = "Hello. I need help."

regexp = r"Hello. I need help."

How to filter messages by command#

Add a string (str) or a tuple (tuple) to filter messages by command. You need to specify either a command name or a command name and a prefix string. The default prefix is /.

command = "help"

command = ("help", "!/")

Example#

Link to example: filters.py.

@bot.router.message(command="help")
def message_handler(notification: Notification) -> None:
    notification.answer_with_file(file="help.png")


bot.run_forever()

Running the application#

python filters.py

List of examples#