This directory contains basic examples of TDLib usage from different programming languages and examples of library building for different platforms. If you are looking for documentation of all available TDLib methods, see the td_api.tl scheme or the automatically generated HTML documentation for a list of all available TDLib methods and classes. You can also see our Getting Started tutorial for a description of basic TDLib concepts.
TDLib can be easily used from almost any language on any platform. Choose your preferred programming language to see examples and a detailed description:
TDLib can be used from Python through the JSON interface.
Convenient Python wrappers already exist for our JSON interface.
If you use modern Python >= 3.6, take a look at python-telegram. The wrapper uses the full power of asyncio, has a good documentation and has several examples. It can be installed through pip or used in a Docker container.
For older Python versions you can use demo-pytdlib. This wrapper contains generator for TDLib API classes and basic class for interaction with TDLib.
You can also check out example/python/tdjson_example.py and tdlib-python for some very basic examples of TDLib JSON interface integration with Python.
TDLib can be used from Node.js through the JSON interface.
Convenient Node.js wrappers already exist for our JSON interface. For example, take a look at tdl, which provides a convenient, fully-asynchronous interface for interaction with TDLib and contains a bunch of examples.
You can also see node-tdlib, tglib, Paper Plane and example/javascript for other examples of TDLib JSON interface integration with Node.js.
TDLib also can be compiled to WebAssembly and used in a browser from JavaScript, but this functionality isn't production-ready yet. We will publish building and usage instructions later.
TDLib can be used from the Go programming language through the JSON interface and Cgo, and can be linked either statically or dynamically.
Convenient Go wrappers already exist for our JSON interface. For example, take a look at go-tdlib or go-tdlib, which provide a convenient TDLib client, a generator for TDLib API classes and contain many examples.
You can also see go-tdjson for another example of TDLib JSON interface integration with Go and example/go for a proof of concept example of using the TDLib JSON interface from Go.
TDLib can be used from the Java programming language through native JNI binding.
We provide a generator for JNI bridge methods and Java classes for all TDLib API methods and objects. See example/java for an example of using TDLib from desktop Java along with detailed building and usage instructions. To use TDLib to create Android Java applications, use our prebuilt library for Android.
You can also see JTDLib for another example of Java wrapper for TDLib.
TDLib provides a native .NET interface through C++/CLI and C++/CX.
See example/uwp for an example of building TDLib SDK for the Universal Windows Platform and an example of its usage from C#.
See example/csharp for an example of building TDLib with C++/CLI support and an example of TDLib usage from C# on Windows.
If you want to write a cross-platform C# application using .Net Core, see tdsharp. It uses our JSON interface, provides an asynchronous interface for interaction with TDLib, automatically generated classes for TDLib API and has some examples.
Also see Unigram, which is a full-featured client rewritten from scratch in C# using TDLib SDK for Universal Windows Platform in less than 2 months.
TDLib has a simple and convenient C++11-interface for sending and receiving requests and can be statically linked to your application.
See example/cpp for examples of TDLib usage from C++. td_example.cpp contains an example of authorization, processing new incoming messages, getting a list of chats and sending a text message.
See also the source code of Depecher – a Telegram app for Sailfish OS, and Telegram Plus – a Qt-client for Ubuntu touch, both of which are based on TDLib.
TDLib can be used from the Swift programming language through the JSON interface and can be linked statically or dynamically.
See example/swift for an example of a macOS Swift application. See example/ios for an example of building TDLib for iOS, watchOS, tvOS, and macOS.
TDLib can be used from the Objective-C programming language through JSON interface and can be linked statically or dynamically.
See example/ios for an example of building TDLib for iOS, watchOS, tvOS, and macOS.
TDLib can be used from the Rust programming language through the JSON interface.
See rust-tdlib for an example of TDLib Rust bindings.
TDLib can be used from the Erlang programming language through the JSON interface.
See erl-tdlib for an example of TDLib Erlang bindings.
TDLib can be used from the PHP programming language by wrapping its functionality in a PHP extension.
See phptdlib or PIF-TDPony for examples of such extensions which provide access to TDLib from PHP.
TDLib can be used from the Lua programming language through the JSON interface.
See tdlua or tdlua for examples of TDLib Lua bindings and basic usage examples.
See also tdbot, which makes all TDLib features available from Lua scripts.
TDLib can be used from the D programming language through the JSON interface.
See d-tdlib-service for an example of TDLib D bindings.
TDLib can be used from the Ruby programming language through the JSON interface.
See tdlib-ruby for examples of Ruby bindings and a client for TDLib.
See example/ruby for an example of logging in to Telegram using TDLib and tdlib-ruby gem.
TDLib can be used from the Elixir programming language.
See Elixir TDLib for examples of such usage and an Elixir client for TDLib. This library contains automatically generated and fully-documented classes for all TDLib API methods and objects.
TDLib can be used from the 1С programming language.
See TDLib bindings for 1С:Enterprise for examples of such usage.
TDLib can be used from the C programming language through the JSON interface and can be linked statically or dynamically.
You can also try to use our C client, which was used by the private TDLib-based version of telegram-cli.
You can use TDLib from any other language using tdbot or TDLib JSON CLI, which provide a command line tool for interaction with TDLIb using the JSON interface through stdin and stdout. You can use this method to use TDLib, for example, from Brainfuck (unfortunately, we haven't seen examples of sending a Telegram message through TDLib on Brainfuck yet).
Alternatively, you can use the TDLib JSON interface directly from your programming language.
Feel free to create an issue, if you have created a valuable TDLib binding or a TDLib client in some language and want it to be added to this list of examples.