tdlib/telegram-bot-api
Telegram Bot Api
This project is a self-hosted Telegram Bot API server that implements a REST gateway to manage bots independently of official cloud infrastructure. It functions as messaging platform middleware, utilizing a translation layer to convert high-level REST API calls into low-level functions via a TDLib-based core.
The server allows for local hosting, which enables the removal of cloud file size limits for uploads and downloads and the use of arbitrary local IP addresses and ports for webhook delivery. It provides a local file system storage mechanism for handling large files and supports session-based state persistence to facilitate the migration of bot instances between server environments.
The system covers a broad range of bot capabilities, including the delivery of rich media, interactive polls, and HTML5 games, as well as the hosting of mini applications. It includes tools for business account automation, forum topic organization, and monetization features such as payment processing and subscription management. Administrative utilities are also provided for chat member management, user verification, and bulk broadcast coordination.
The server source code can be compiled into a binary for various operating systems to enable local deployment.
Features
- Bot API Server Self-Hosting - Implements a self-hosted HTTP server to manage bot operations independently of cloud infrastructure.
- Local File Storage - Uses local file system storage to handle large file transfers beyond cloud-imposed limits.
- REST Gateways - Implements a translation layer that converts high-level REST API calls into low-level TDLib functions.
- Bot File Management - Coordinates the retrieval of file information and prepares media files for download from the server.
- Messaging Middleware - Functions as a bridge translating external HTTP requests into platform-specific actions for bots.
- Telegram Webhook Receivers - Configures specific URLs to receive real-time HTTPS POST updates whenever an event occurs.
- Messaging Protocol Cores - Utilizes a low-level client library to handle messaging network protocols, encryption, and state.
- Transfer Limit Overrides - Removes official cloud restrictions on upload and download sizes when running the API server locally.
- Long-Polling Event Pushing - Uses a request-response mechanism that holds connections open until new events trigger a response.
- Rich Media Transmission - Transmits photos, videos, audio, documents, animations, and voice notes to target chats via the API.
- Update Polling - Implements a long-polling mechanism to retrieve incoming updates from the server in a continuous loop.
- Telegram Bot Frameworks - Implements the core API gateway necessary for building interactive agents on the Telegram platform.
- Text Message Transmission - Implements the transmission of formatted text messages and interactive keyboards through the bot API.
- Standardized Event Webhook Delivery - Implements a push-based system for delivering real-time event updates via HTTPS POST requests.
- Protocol Translation Layers - Provides a translation layer that converts high-level REST API calls into low-level TDLib functions.
- Rich Messenger Interfaces - Supports the creation of mini apps, HTML5 games, and complex polls to provide rich user interfaces.
- Chatbot Monetization - Processes payments, manages subscriptions, and handles digital gifts within the chat interface.
- Payment Processing Systems - Processes invoices, creates payment links, and manages refunds using virtual currency or third-party providers.
- Direct Local Path Access - Allows direct access to files via local paths to eliminate the need for separate HTTP download requests.
- Session State Persistence - Persists bot states and user sessions in local directories to facilitate server migration.
- Session Migration - Enables the transfer of bot instances across local server environments by moving session subdirectories.
- Bulk Senders - Sends high-volume messages to subscribers using a paid system to bypass standard rate limits.
- Business Account Configuration - Provides capabilities to handle profile details, settings, and messaging on behalf of connected business accounts.
- Business Account Integration - Enables the integration of bots with professional business accounts to automate messages and profile settings.
- Custom Webhook Delivery - Provides the ability to route webhooks using local IP addresses to bypass cloud network restrictions.
- Webhook Connectivity Tuning - Enables the use of arbitrary local IP addresses and ports while increasing maximum concurrent webhook connections.
- Inline Query Processors - Processes inline search queries to provide interactive result lists for users to send.
- Mini Application Hosting - Supports embedding web-based mini applications with access to local storage and geolocation.
- Mini App Runtimes - Provides a runtime environment for hosting custom JavaScript mini-applications embedded within the messenger.
