core.telegram.org Open in urlscan Pro
149.154.167.99  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Twitter

 * Home
 * FAQ
 * Apps
 * API
 * Protocol
 * Schema


TELEGRAM APIS

We offer three kinds of APIs for developers. The Bot API allows you to easily
create programs that use Telegram messages for an interface. The Telegram API
and TDLib allow you to build your own customized Telegram clients. You are
welcome to use both APIs free of charge. Lastly, the Gateway API allows any
business, app or website to send verification codes through Telegram instead of
traditional SMS.

You can also add Telegram Widgets to your website.

Designers are welcome to create Animated Stickers or Custom Themes for Telegram.

--------------------------------------------------------------------------------


BOT API



This API allows you to connect bots to our system. Telegram Bots are special
accounts that do not require an additional phone number to set up. These
accounts serve as an interface for code running somewhere on your server.

To use this, you don't need to know anything about how our MTProto encryption
protocol works — our intermediary server will handle all encryption and
communication with the Telegram API for you. You communicate with this server
via a simple HTTPS-interface that offers a simplified version of the Telegram
API.

> Learn more about the Bot API here »

Bot developers can also make use of our Payments API to accept payments from
Telegram users around the world.

--------------------------------------------------------------------------------


TDLIB – BUILD YOUR OWN TELEGRAM

Even if you're looking for maximum customization, you don't have to create your
app from scratch. Try our Telegram Database Library (or simply TDLib), a tool
for third-party developers that makes it easy to build fast, secure and
feature-rich Telegram apps.

TDLib takes care of all network implementation details, encryption and local
data storage, so that you can dedicate more time to design, responsive
interfaces and beautiful animations.

TDLib supports all Telegram features and makes developing Telegram apps a breeze
on any platform. It can be used on Android, iOS, Windows, macOS, Linux and
virtually any other system. The library is open source and compatible with
virtually any programming language.

> Learn more about TDLib here »

--------------------------------------------------------------------------------


GATEWAY API

The Telegram Gateway API allows any business, app or website to send
authorization codes through Telegram instead of traditional SMS – offering a
powerful and convenient way to lower costs while increasing the security and
delivery speed of your codes to Telegram’s 950+ million monthly active users.
Users will instantly receive messages with codes in a special chat inside
Telegram.

> Telegram's Gateway API is completely free to test. Learn more here »

--------------------------------------------------------------------------------


TELEGRAM API

This API allows you to build your own customized Telegram clients. It is 100%
open for all developers who wish to create Telegram applications on our
platform. Feel free to study the open source code of existing Telegram
applications for examples of how things work here. Don't forget to register your
application in our system.

 * Getting Started
 * Security
 * Optimization
 * API methods


GETTING STARTED

CREATING AN APPLICATION

How to get your application identifier and create a new Telegram app.

USER AUTHORIZATION

How to register a user's phone to start using the API.

TWO-FACTOR AUTHENTICATION

How to login to a user's account if they have enabled 2FA, how to change
password.

QR CODE LOGIN

QR code login flow

ERROR HANDLING

How to handle API return errors correctly.

HANDLING DIFFERENT DATA CENTERS

How to connect to the closest DC access point for faster interaction with the
API, and things to watch out for when developing a client.

HANDLING UPDATES

How to subscribe to updates and handle them properly.

HANDLING PUSH-NOTIFICATIONS

How to subscribe and handle them properly.

CHANNELS, SUPERGROUPS, GIGAGROUPS AND BASIC GROUPS

How to handle channels, supergroups, gigagroups, basic groups, and what's the
difference between them.

FORUMS

Telegram allows creating forums with multiple distinct topics.

CHANNEL STATISTICS

Telegram offers detailed channel statistics for channels and supergroups.

CALLING METHODS

Additional options for calling methods.

UPLOADING AND DOWNLOADING FILES

How to transfer large data batches correctly.

PAGINATION

How to fetch results from large lists of objects.

CLIENT CONFIGURATION

The MTProto API has multiple client configuration parameters that can be fetched
with the appropriate methods.


SECURITY

SECRET CHATS, END-TO-END ENCRYPTION

End-to-end-encrypted messaging.

SECURITY GUIDELINES

Important checks required in your client application.

PERFECT FORWARD SECRECY

Binding temporary authorization key to permanent ones.

END-TO-END ENCRYPTION IN VOICE AND VIDEO CALLS

End-to-end-encrypted calls.


OPTIMIZATION

CLIENT OPTIMIZATION

Ways to boost API interactions.


API METHODS

AVAILABLE METHOD LIST

A list of available high-level methods.

API TL-SCHEMA, AS JSON

Text and JSON-presentation of types and methods used in API.

AVAILABLE LAYER LIST

A list of available schema versions.


OTHER ARTICLES

WORKING WITH BOTS, USING THE MTPROTO API

How to work with bots using the MTProto API.

COMMANDS

Bots offer a set of commands that can be used by users in private, or in a chat.

BUTTONS

Users can interact with your bot via buttons or even inline buttons, straight
from inline messages in any chat.

MENU BUTTON

Bots can choose the behavior of the menu button shown next to the text input
field.

INLINE QUERIES

Users can interact with your bot via inline queries, straight from the text
input field in any chat.

GAMES

Bots can offer users HTML5 games to play solo or to compete against each other
in groups and one-on-one chats; how to work with games in the MTProto API.

MINI APPS

Bots can offer users interactive HTML5 mini apps to completely replace any
website.

ATTACHMENT MENU

Bots can install attachment menu entries, offering conveniently accessible,
versatile mini apps.

STORIES

Telegram users and channels can easily post and view stories through the API.

SIMILAR CHANNELS

The API offers a method to obtain a list of similarly themed public channels,
selected based on similarities in their subscriber bases.

ACCENT COLORS

Telegram users and channels can change the accent color and background pattern
of their profile page and their messages!

PRIVACY SETTINGS

Telegram allows users to specify granular privacy settings, choosing which users
can or can't interact with them in certain ways.

SEARCH & FILTERS

Telegram allows applying detailed message filters while looking for messages in
chats.
This allows the server to filter messages based on a text query, and even on
their type, and this feature is often used by graphical clients to implement
features like the chat gallery, chat profile pictures and more.

POLLS

Telegram allows sending polls and quizzes, that can be voted on by thousands, if
not millions of users in chats and channels.

REACTIONS

Telegram allows users to react on any message using specific emojis, triggering
cute lottie animations.

ANIMATED MESSAGE EFFECTS

Telegram allows adding spectacular animated effects to messages you send.

EMOJI CATEGORIES

Sticker, custom emoji and GIF selection UIs should offer a list of categories to
quickly filter results by a (list of) emojis, or by some other criteria.

EMOJI STATUS

Telegram allows users to set an emoticon or a custom emoji as status, to show
next to their name in chats and profiles.

INVITE LINKS AND JOIN REQUESTS

Channels, basic groups and supergroups may have a public username or a private
invite link: private invite links may be further enhanced with per-user join
requests.

ADMIN, BANNED AND DEFAULT RIGHTS FOR CHANNELS, SUPERGROUPS AND GROUPS

How to handle admin permissions, granular bans and global permissions in
channels, groups and supergroups.

DISCUSSION GROUPS

Groups can be associated to a channel as a discussion group, to allow users to
discuss about posts.

CHANNEL COMMENTS AND MESSAGE THREADS

Telegram allows commenting on a channel post or on a generic group message,
thanks to message threads.

ADMIN LOG

Both supergroups and channels offer a so-called admin log, a log of recent
relevant supergroup and channel actions, like the modification of group/channel
settings or information on behalf of an admin, user kicks and bans, and more.

PINNED MESSAGES

Telegram allows pinning multiple messages on top of a specific chat.

MENTIONS

Telegram allows mentioning other users in case of urgent duckling matters, and
quickly navigating to those mentions in order to read them as swiftly as
possible.

SCHEDULED MESSAGES

Telegram allows scheduling messages.

LIVE GEOLOCATIONS

Telegram allows sending the live geolocation of a user in a chat, optionally
setting a proximity alert.


PEER DATABASE

How to work with peer information in the API.

MIN CONSTRUCTORS

Sometimes, user and channel constructors met in group chat updates may not
contain full info about the user: how to handle such constructors.

ACCOUNT DELETION

How to delete a Telegram account.

IMPORTED MESSAGES

Telegram allows importing messages and media from foreign chat apps.

TELEGRAM PASSPORT

How to work with Telegram Passport directly using the MTProto API.

TELEGRAM PAYMENTS

How to work with Telegram Payments directly using the MTProto API.

STYLED TEXT WITH MESSAGE ENTITIES

How to create styled text with message entities

WORKING WITH GIFS

Telegram clients support displaying GIFs.

WORKING WITH STICKERS

Telegram clients support displaying animated, static and video stickers.

WORKING WITH CUSTOM EMOJIS

Telegram allows including custom animated, static and video emojis directly
inside of messages.

WORKING WITH ANIMATED EMOJIS

Graphical telegram clients should transform emojis into their respective
animated version.

WORKING WITH ANIMATED DICE

Telegram supports sending animated dice emojis.

MESSAGE DRAFTS

How to handle message drafts

FOLDERS

Working with folders

TOP PEER RATING

If enabled, the rating of top peers indicates the relevance of a frequently used
peer in a certain category (frequently messaged users, frequently used bots,
inline bots, frequently visited channels and so on).

HANDLING FILE REFERENCES

How to handle file references.

SEAMLESS TELEGRAM LOGIN

Handle Seamless Telegram Login URL authorization requests.

WALLPAPERS

How to work with chat backgrounds.

NOTIFICATION SOUNDS

How to work with chat notification sounds.

MESSAGE TRANSCRIPTION

How to transcribe voice messages.

MESSAGE TRANSLATION

Telegram allows translating chat messages, and Telegram Premium users may even
enable real-time chat translation.

NATIVE ANTISPAM SYSTEM

Admins of supergroups with a certain number of members can choose to unleash the
full proactive power of Telegram's own antispam algorithms – turning on the new
Aggressive mode for the automated spam filters.

COLLECTIBLES

Telegram users can make it easy for others to contact them or find their public
groups and channels via usernames: clients can also assign multiple Fragment »
collectible usernames to accounts, supergroups and channels they own; Fragment »
also allows purchasing phone number collectibles that can be used to register
Telegram accounts.

TELEGRAM PREMIUM

Telegram Premium is an optional subscription service that unlocks additional
exclusive client-side and API-side features, while helping support the
development of the app. It is a part of Telegram’s sustainable monetization –
driven by our users, rather than advertisers or shareholders. This way, Telegram
can remain independent and prioritize its users first.

TELEGRAM BUSINESS

Users can turn their Telegram account into a business account, gaining access to
business features such as opening hours, location, quick replies, automated
messages, custom start page, chatbot support, and more.

For the moment, all Telegram Business features are available for free to
Telegram Premium subscribers.

TELEGRAM STARS

Telegram Stars are virtual items that allow users to purchase digital goods and
services from bots and mini apps inside the Telegram ecosystem, send gifts to
content creators on the Telegram platform, and more.

PAID MEDIA

Content creators can accept Stars by publishing paid photos or videos on their
channels. Subscribers will be allowed to view such posts only after paying the
author to unlock them.

CHANNEL AND SUPERGROUP BOOSTS

Telegram Premium users can grant their favorite channels additional features
like the ability to post stories by giving them boosts.

GIVEAWAYS & GIFTS

Telegram channel administrators may launch giveaways to randomly distribute
Telegram Premium subscriptions and other gifts among their followers, in
exchange for boosts.

ACTION BAR

Sometimes, when interacting with Telegram users via private or secret chats, an
action bar must be shown on top of the chat, offering convenient action buttons
or notices regarding the user.

SAVED MESSAGES

The Saved Messages chat allows users to bookmark messages and media: it's a
personal cloud storage for any messages or media you may want to send or forward
there.

PROFILE

Telegram offers many customization options for your profile!

THEMES

Telegram apps support generating, sharing and synchronizing app themes.


SPONSORED MESSAGES

If your app allows accessing content from Telegram channels, you must include
support for official sponsored messages in Telegram channels.


CHANNEL AD REVENUE

Telegram has one of the most generous reward systems in the history of social
media. Telegram channel owners can now receive 50% of the revenue from ads
displayed in their channels.

This page describes the methods used to withdraw channel ad revenue, as well as
view detailed revenue stats.


FACT-CHECKS

Telegram clients support displaying fact-checks added to messages by independent
fact-checkers.


CONTACTS

Working with contacts in the API.


BLOCKLIST

Working with the blocklist.


NEARBY USERS&CHATS

How to work with geolocation-based features like geochats and the nearby users
feature.

WEB EVENTS

When interacting with HTML5 games and the websites of payment gateways, Telegram
apps should expose the following JS APIs.

DEEP LINKS

Telegram clients must handle special tg:// and t.me deep links encountered in
messages, link entities and in other apps by registering OS handlers.

TAKEOUT

Telegram's API allows users to export all of their information through the
takeout API.

TELEGRAM


Telegram is a cloud-based mobile and desktop messaging app with a focus on
security and speed.

ABOUT

 * FAQ
 * Privacy
 * Press

MOBILE APPS

 * iPhone/iPad
 * Android
 * Mobile Web

DESKTOP APPS

 * PC/Mac/Linux
 * macOS
 * Web-browser

PLATFORM

 * API
 * Translations
 * Instant View

ABOUT

BLOG

PRESS

MODERATION

Go up