The Telegram Bot API provides an HTTP API for creating Telegram Bots. https://tdlight-team.github.io
Go to file
2020-11-11 20:09:21 +01:00
.github/workflows Revert "remove cross compilation" 2020-11-10 16:26:06 +01:00
td@ce88917ac7 update td 2020-11-10 23:33:56 +01:00
telegram-bot-api td splits automatically 2020-11-11 20:09:21 +01:00
.clang-format Telegram Bot APi server initial commit. 2020-11-03 19:34:10 +03:00
.dockerignore GitHub Actions multi-arch build and push workflow (#2) 2020-11-09 16:17:37 +01:00
.gitattributes Telegram Bot APi server initial commit. 2020-11-03 19:34:10 +03:00
.gitignore Add optimize_memory command 2020-11-05 13:12:05 +01:00
.gitmodules Update .gitmodules 2020-11-08 13:46:14 +01:00
build.html Don't export CXXFLAGS in build instructions generator. 2020-11-08 21:08:13 +03:00
CMakeLists.txt Update TDLib. 2020-11-08 14:01:44 +03:00
docker-entrypoint.sh Update entrypoint 2020-11-11 20:09:20 +01:00
Dockerfile fix healtcheck 2020-11-11 20:09:21 +01:00
LICENSE_1_0.txt Telegram Bot APi server initial commit. 2020-11-03 19:34:10 +03:00
README.md allow insecure connections (Cherry pick) 2020-11-11 20:09:17 +01:00

TDLight Telegram Bot API

TDLight Telegram Bot API is a fork of the official Telegram Bot API, focused on memory footprint and performance.

TDLight Telegram Bot API is 100% compatible with the official version.

The Telegram Bot API provides an HTTP API for creating Telegram Bots.

If you've got any questions about bots or would like to report an issue with your bot, kindly contact @BotSupport in Telegram.

Please note that only TDLight-specific issues are suitable for this repository.

Table of Contents

TDLight features

Added features

TDLib replaced with TDLight

TDLight provides constant memory usage, unlike tdlib that must be restarted to reduce the heap size.

Command optimize_memory

Calling optimize_memory will remove old data from the in-memory cache and give the freed memory back to the os

Command getmessageinfo

Get information about a message

Parameters
  • chat_id Message chat id
  • message_id Message id
Returns message

Executable flag relative

If enabled, allow only relative paths for files in local mode.

Executable flag insecure

Allow http connection in non-local mode

Modified features

Command getchat

The command getchat will also try to resolve the username online, if it can't be found locally

Object message

The message object now has two new fields:

  • views: how many views has the message (usually the views are shown only for channel messages)
  • forwards: how many times the message has been forwarded

Installation

The simplest way to build and install Telegram Bot API server is to use our Telegram Bot API server build instructions generator. If you do that, you'll only need to choose the target operating system to receive the complete build instructions.

In general, you need to install all Telegram Bot API server dependencies and compile the source code using CMake:

git clone --recursive https://github.com/tdlib/telegram-bot-api.git
cd telegram-bot-api
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --target install

Dependencies

To build and run Telegram Bot API server you will need:

  • OpenSSL
  • zlib
  • C++14 compatible compiler (e.g., Clang 3.4+, GCC 4.9+, MSVC 19.0+ (Visual Studio 2015+), Intel C++ Compiler 17+) (build only)
  • gperf (build only)
  • CMake (3.0.2+, build only)

Usage

Use telegram-bot-api --help to receive the list of all available options of the Telegram Bot API server.

The only mandatory options are --api-id and --api-hash. You must obtain your own api_id and api_hash as described in https://core.telegram.org/api/obtaining_api_id and specify them using the --api-id and --api-hash options or the TELEGRAM_API_ID and TELEGRAM_API_HASH environment variables.

To enable Bot API features not available at https://api.telegram.org, specify the option --local. In the local mode the Bot API server allows to:

  • Download files without a size limit.
  • Upload files up to 2000 MB.
  • Upload files using their local path and the file URI scheme.
  • Use an HTTP URL for the webhook.
  • Use any local IP address for the webhook.
  • Use any port for the webhook.
  • Set max_webhook_connections up to 100000.
  • Receive the absolute local path as a value of the file_path field without the need to download the file after a getFile request.

The Telegram Bot API server accepts only HTTP requests, so a TLS termination proxy needs to be used to handle remote HTTPS requests.

By default the Telegram Bot API server is launched on the port 8081, which can be changed using the option --http-port.

Documentation

See Bots: An introduction for developers for a brief description of Telegram Bots and their features.

See the Telegram Bot API documentation for a description of the Bot API interface and a complete list of available classes, methods and updates.

See the Telegram Bot API server build instructions generator for detailed instructions on how to build the Telegram Bot API server.

Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk.

Moving a bot to a local server

To guarantee that your bot will receive all updates, you must deregister it with the https://api.telegram.org server by calling the method logOut. After the bot is logged out, you can replace the address to which the bot sends requests with the address of your local server and use it in the usual way. If the server is launched in --local mode, make sure that the bot can correctly handle absolute file paths in response to getFile requests.

Moving a bot from one local server to another

If the bot is logged in on more than one server simultaneously, there is no guarantee that it will receive all updates. To move a bot from one local server to another you can use the method logOut to log out on the old server before switching to the new one.

If you want to avoid losing updates between logging out on the old server and launching on the new server, you can remove the bot's webhook using the method deleteWebhook, then use the method close to close the bot instance. After the instance is closed, locate the bot's subdirectory in the working directory of the old server by the bot's user ID, move the subdirectory to the working directory of the new server and continue sending requests to the new server as usual.

License

Telegram Bot API server source code is licensed under the terms of the Boost Software License. See LICENSE_1_0.txt for more information.