Endfix.Telegram.BotAPI
0.1.0
See the version list below for details.
dotnet add package Endfix.Telegram.BotAPI --version 0.1.0
NuGet\Install-Package Endfix.Telegram.BotAPI -Version 0.1.0
<PackageReference Include="Endfix.Telegram.BotAPI" Version="0.1.0" />
<PackageVersion Include="Endfix.Telegram.BotAPI" Version="0.1.0" />
<PackageReference Include="Endfix.Telegram.BotAPI" />
paket add Endfix.Telegram.BotAPI --version 0.1.0
#r "nuget: Endfix.Telegram.BotAPI, 0.1.0"
#:package Endfix.Telegram.BotAPI@0.1.0
#addin nuget:?package=Endfix.Telegram.BotAPI&version=0.1.0
#tool nuget:?package=Endfix.Telegram.BotAPI&version=0.1.0
Telegram Bot API (С#)
Typed .NET client for the Telegram Bot API. The library targets .NET Standard 2.0 and uses System.Text.Json for request and response contracts.
Installation
dotnet add package Endfix.Telegram.BotAPI
Features
- strongly typed Bot API methods, parameters and response models;
- polymorphic JSON serialization for Telegram union types;
- JSON and multipart/form-data requests;
- local file uploads, Telegram file IDs and
attach://references; - long polling and webhook examples;
- unit tests for serialization and transport contracts.
Initialization
Each bot is given a unique authentication token when it is created. Store the token in User Secrets or an environment variable; do not put it in appsettings.json or source control. You can learn about obtaining tokens and generating new ones in this document.
var api = new BotApiClient(
"<token>",
new HttpClient(new SocketsHttpHandler { PooledConnectionLifetime = TimeSpan.FromSeconds(5), MaxConnectionsPerServer = 10 }) { Timeout = TimeSpan.FromMinutes(5) }
);
Examples
- Long polling: Sequential (FIFO) or parallel update processing.
- Webhook: Built-in exponential backoff and retry policy.
The example projects include placeholder configuration files. Replace the placeholders locally or use User Secrets before running them.
Download file
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size.
var message = await api.SendDocumentAsync(chatId: 1234567890, document: new InputDocumentFile("path to file"));
var file = await api.GetFileAsync(fileId: message.Document!.FileId);
var fileBytes = await api.GetFileBytesAsync(filePath: file.FilePath!);
File.WriteAllBytes("path to downloaded file", fileBytes);
Tests
Run the local test suite with:
dotnet test Telegram.BotAPI.sln
Telegram integration tests are disabled unless their environment variables are configured. They can send real messages and are intended for a dedicated test bot and chat.
Status
The project follows the Telegram Bot API release it targets. The public API may change when Telegram adds or revises API methods and types.
License
This project is licensed under the MIT License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- System.Text.Json (>= 10.0.11)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.