aiogram/aiogram
Aiogram
aiogram is an asynchronous framework for building Telegram bots in Python. It provides a complete toolkit for interacting with the Telegram Bot API, handling incoming updates, and managing bot state through a built-in finite state machine. The framework is designed around an event-driven architecture that routes messages and other updates to handler functions using a flexible dispatching system.
The framework distinguishes itself through its middleware system, which allows developers to intercept and modify both incoming updates and outgoing API calls. It supports a wide range of Telegram-specific features including inline keyboards, callback queries, command menus, and web app buttons. aiogram also provides tools for managing chat members, invite links, and bot permissions, as well as handling complex interactions like polls with media options and paid media content.
Beyond core messaging, aiogram covers content management with support for sending and receiving various media types, file uploads and downloads, and message entity parsing. It includes capabilities for chat administration, user verification, and localization of bot responses. The framework also handles Telegram-specific features such as forum topics, giveaways, gifts, and proximity alerts.
The project's documentation provides guidance on setting up a bot, configuring commands, and working with the framework's various components.
Features
- Telegram Bot Frameworks - Ships a complete asynchronous framework for building and managing Telegram bots.
- Finite State Machine Managers - Maintains per-user conversation state across multiple interactions using a built-in finite state machine.
- Command Visibility Scopes - Limits a bot's command visibility to only administrators within a chat, hiding commands from regular members.
- Member-Specific Command Scopes - Restricts bot commands to a specific chat member by defining a scope that targets a single user within a chat.
- Chat-Based - Limits which Telegram bot commands a user sees based on their chat type or user status.
- Bot Command Interfaces - Provides a built-in mechanism for registering slash commands that appear in the bot's command menu.
- Captioned Media Messages - Attaches a photo file to a message and optionally includes a text caption displayed below the image.
- Messaging Update Processors - Dispatches incoming Telegram updates to handler functions based on commands, message types, or custom filters.
- Update Filters - Ships composable filters to selectively process incoming updates based on message content or metadata.
- Telegram Message Sending - Sends text or media messages to Telegram chats via the Bot API without requiring an event dispatcher.
- Query Processing - Processes callback data sent from inline keyboard buttons to trigger specific bot actions.
- Update Pollers - Implements update polling to retrieve new messages, callbacks, and events from Telegram servers.
- Chat-Specific Command Scopes - Defines a scope that restricts a bot command to a specific chat, allowing targeted command visibility.
- Bot Permission Configurations - Controls what actions a Telegram bot can perform in a chat, such as sending messages or media, by setting granular permission flags.
- Bot Update Middleware - Runs custom middleware logic before or after processing updates and API calls to modify behavior.
- Bot Update and API Interceptors - Provides middleware that intercepts and modifies both incoming updates and outgoing API calls.
- Update Routing Systems - Dispatches incoming Telegram updates to registered handlers using a flexible routing system with blueprints.
- Inline Keyboard - Provides inline keyboard buttons that trigger callbacks or open URLs when tapped within messages.
- Reply Keyboard Buttons - Creates a tappable button for inline or reply keyboards that sends a predefined text when pressed.
- Command Menu Buttons - Creates a Telegram bot menu button that displays a list of bot commands when tapped by the user.
- Conversation State Machines - Ships a built-in finite state machine for maintaining per-user conversation state across interactions.
- Telegram Media Downloader - Retrieves a file from Telegram servers using its file ID and saves it to a local path.
- Chat Member Administration - Adds, removes, or restricts members in a Telegram group or channel.
- Administrator Rights Configurations - Configures the specific permissions granted to a chat administrator, such as the ability to delete messages or manage video chats.
- Member Status Change Handlers - Provides structured event handling for chat member status changes in Telegram bots.
- Bans - Represents a banned chat member with information about the user and the ban date.
- Keyboard Removal Interfaces - Removes the current custom keyboard from the chat interface, returning to the default text input mode.
- Paid Media Transfers - Transmits a paid photo to a Telegram chat as part of a media group, requiring the user to pay before viewing.
- Media Option Polls - Creates polls where each answer option can include a photo or video attachment.
- Poll Creators - Ships a built-in poll creation capability for interactive user engagement in Telegram bots.
- Invite Link Management - Creates, edits, and revokes invite links for Telegram group chats with access control.
- Audio Message Constructions - Constructs audio messages with optional caption, duration, performer, and thumbnail for bot responses.
- Message Editing and Deletion - Modifies or removes previously sent messages in a Telegram chat.
- Bot Response Localization - Integrates GNU Gettext and Fluent for translating bot responses into user languages.
- Telegram Message Entity Parsing - Extracts structured metadata from text segments, such as URLs, mentions, and formatting, for precise message handling.
- Private Chat Command Scopes - Restricts bot command visibility to private chats with individual users.
- Clipboard Copy - Creates a button that copies specified text to the user's clipboard when pressed.
- Chat Management APIs - Provides APIs for managing group, supergroup, and private chat entities through the bot.
- Telegram - Uploads a file to Telegram by wrapping a local path, bytes, or file-like object into the required multipart/form-data format.
- Bot Frameworks - Asynchronous framework for the Bot API.
- Media and Communication - Asynchronous Telegram Bot framework.
