This page describes individual bot elements and features in detail. See also:
Users can send messages of all types to bots, including text, files, locations, stickers, voice messages and even dice if they're feeling lucky. However, Telegram bots offer many other tools for building flexible interfaces tailored to your specific needs:
/
.For even more flexibility, Web Apps support 100% custom interfaces with JavaScript.
Note: Telegram bots can support multiple languages that adapt to the users' language settings in the app.
A command is a simple /keyword
that tells the bot what to do. Telegram apps will:
/
(for this to work, you need to have provided a list of commands to @BotFather or via the appropriate API method). Selecting a command from the list immediately sends it.Commands must always start with the /
symbol and contain up to 32 characters. They can use Latin letters, numbers and underscores, though simple lowercase text is recommended for a cleaner look.
Here are a few examples:
Commands should be as specific as possible – for example /newlocation
or /newrule
is better than a /new
command that then requires an additional parameter from the user like "location“ or ”rule".
We require all developers to support several Global Commands to make sure Telegram bots offer a consistent and user-friendly experience.
Your bot is able to show different commands to different users and groups – you can control this using scopes. For example, your bot could show additional commands to group admins or translate the list based on the user’s language_code.
Keep in mind that Bot API updates will not contain any information about the scope of a command sent by the user – in fact, they may contain commands that don’t exist at all in your bot. Your backend should always verify that received commands are valid and that the user was authorized to use them regardless of scope.
Bots with privacy mode enabled will only receive commands in groups under special conditions, see here.
Bots are able to interpret free text input from users, but offering specific suggestions is often more intuitive – this is where custom keyboards can be extremely useful.
Whenever your bot sends a message, it can display a special keyboard with predefined reply options (see ReplyKeyboardMarkup). Telegram apps that receive the message will display your keyboard to the user. Using any of the buttons will immediately send the respective text. This way you can drastically simplify and streamline user interaction with your bot.
Check out the one_time_keyboard parameter to automatically hide your bot's keyboard as soon as it's been used.
You can also customize the text placeholder in the input field by setting the input_field_placeholder
parameter.
There are times when you'd prefer to do things without sending any messages to the chat – like when a user is changing settings, toggling options or navigating search results. In such cases, you can use Inline Keyboards that are shown directly below their relevant messages.
Unlike with custom reply keyboards, pressing buttons on inline keyboards doesn't send messages to the chat. Instead, inline keyboards support buttons that can work behind the scenes or open different interfaces: callback buttons, URL buttons, switch-to-inline buttons, game buttons and payment buttons.
To provide a better user experience, consider editing your keyboard when the user toggles a setting button or navigates to a new page – this is both faster and smoother than sending a whole new message and deleting the previous one.
In all bot chats, a menu button appears near the message field. By default, tapping this button opens a menu that can hold some or all of a bot's commands, including a short description for each. Users can then select a command from the menu without needing to type it out.
You can set different texts of the menu button and its command descriptions for various individual users or groups of users – for example, showing translated text based on the user’s language, as explained here.
The menu button can alternatively be used to launch a Web App.
To make basic interactions more uniform, we ask all developers to support a few basic commands. Telegram apps will have interface shortcuts for these commands.
Users will see a Start button the first time they open a chat with your bot. Help and Settings links will be available in the menu on the bot's profile page if you add them in @BotFather.
Bots can present the user with a friendly and intuitive interface that lists any number of groups, channels or other users according to a custom set of criteria. Tapping on a chat will send its identifier to the bot in a service message and seamlessly close the interface.
A group management bot is the perfect example: an admin could select a chat the bot should manage, and then select a user it should promote – this would happen without ever typing any text.
Here is a quick start guide to use this feature:
request_chat
or request_user
respectively.chat_shared
or user_shared
service message.Keep in mind that the bot may not be able to use the identifier it receives if the corresponding chat or user is not already known or accessible by some other means.
In addition to sending commands and messages to the chat with the bot, there are several ways of interacting with them without opening any specific chat or group.
Users can interact with your bot via inline queries straight from the message field in any chat. All they need to do is start a message with your bot's @username and enter a keyword.
Having received the query, your bot can return some results. As soon as the user selects one, it is sent to the relevant chat. This way, people can request and send content from your bot in any of their chats, groups or channels.
Remember that inline functionality has to be enabled via @BotFather, or your bot will not receive inline Updates.
Examples of inline bots include @gif, @bing and @wiki. Web App bots can also be used inline – try typing @durgerkingbot in any chat.
Telegram bots have a deep linking mechanism that allows additional parameters to be passed to the bot on startup. It could be a command that launches the bot – or an authentication token to connect the user's Telegram account to their account on another platform.
Each bot has a link that opens a conversation with it in Telegram – https://t.me/<bot_username>
. Parameters can be added directly to this link to let your bot work with additional information on the fly, without any user input.
A-Z, a-z, 0-9, _ and - are allowed. We recommend using base64url to encode parameters with binary and other types of content. The parameter can be up to 64 characters long.
Private Chats
In private chats, you can use the start
parameter to automatically pass any value to your bot whenever a user presses the link. For example, you could use:
https://t.me/your_bot?start=airplane
When someone opens a chat with your bot via this link, you will receive:
/start airplane
Groups
In groups, you can add the parameter startgroup
to this link. For example:
https://t.me/your_bot?startgroup=spaceship
Following a link with this parameter prompts the user to select a group to add the bot to – the resulting update will contain text in the form:
/start@your_bot spaceship
Web Apps also support deep linking, for more information check out our dedicated guide.
Certain bots can be added directly to a user’s attachment menu – giving them easy access to the bot in any chat. Currently, this option is restricted to certain approved bots, but may be expanded later.
Try adding @DurgerKingBot to your attachment menu.
There are various ways of further integrating bots with Telegram and other services.
Telegram offers a robust ecosystem of monetization features, allowing any bot to support its development with multiple revenue streams.
Telegram Stars power all digital transactions between bots and users. Users can acquire Stars through in-app purchases via Apple and Google or via @PremiumBot.
Bots can use the Stars they receive to increase message limits, send gifts to users or accept rewards in Toncoin.
Services can use their bot to sell digital goods and services – like online courses, commissioned artwork and items in games.
Bots can post paid photos and videos – and users are only allowed to view the media after paying to unlock it. This functionality is available to all bots – including bot admins in channels and bots managing Telegram Business accounts.
Developers are able to offer paid subscriptions to their bot – adding multiple tiers of content and features tailored to their audience.
Developers can participate in revenue sharing from Telegram Ads – receiving 50% of the revenue from ads that appear in the chat with their bot.
Mini Apps allow developers to create infinitely flexible interfaces that can be launched right inside Telegram – integrating seamlessly with the app and replacing any website.
If your bot is a mini app, you can add a prominent Launch app button as well as demo videos and screenshots to the bot’s profile. To do this, go to @BotFather and set up your bot's Main Mini App.
Mini apps are covered in detail in our dedicated guide – you should read it carefully to learn the wide variety of features they can offer.
If you develop a mini app, be sure to follow our design guidelines – you'll want your custom interface to seamlessly integrate into the app to provide users the best possible experience.
Mini apps integrate seamlessly with Telegram – from receiving detailed theme settings to using native dialogs for reading QR codes, controlling biometrics, sharing media directly to stories and more.
When opened from a direct link in a group, mini apps can also use the chat_instance
parameter to track of the current context, supporting shared usage by multiple chat members – to create live whiteboards, group orders, multiplayer games and much more.
Developers can upload screenshots and video demos of their mini app right from the bot's profile page – giving users an overview of the app's features and functionality. These media previews will be shown to any user who views your app – like in the Mini App Store or via Search.
Previews support multiple languages – so you can upload translated versions of your previews that will be shown to users based on their app language.
More than 500 million out of Telegram's 950 million users interact with mini apps every month. Successful mini apps have the chance to be highlighted in the Telegram Mini App Store – appearing for all users in the 'Apps' tab of Search.
Featured mini apps are chosen based on how they enrich the Telegram ecosystem. To increase the chances of being featured, you must enable the Main Mini App in @BotFather, upload high-quality media demos showcasing your app to your bot's profile and accept payments in Telegram Stars.
Check out our documentation to learn more about enabling Main Mini Apps and accepting payments in Stars.
Users can place direct shortcuts to specific mini apps on the home screen of their devices – accessing their favorite games and services in one tap.
The loading screen of mini apps can be customized in @Botfather – where developers can add their own icon and set specific colors for both light and dark themes.
To customize your loading screen, go to @Botfather >
/mybots
> Select bot > Bot Settings > Configure Mini App > Configure Splash Screen. You can tap on Open Splash Screen Preview to see the final result.
Mini apps are able to use the entire screen in portrait or landscape orientation – allowing for immersive games and media with expanded gestures and interfaces.
Users can set an emoji status inside mini apps or give an app permission to update it automatically.
Developers can also integrate APIs from other services or request geolocation access – instantly changing a user's status when they start a game or leave the office .
Media generated in mini apps can be shared in any chat – letting users effortlessly send referral codes and custom images to contacts, groups and channels. Alternatively, users can download it with a native popup.
Any media created by the mini app, like whiteboard snapshots, leaderboards and AI-generated videos can be opened with the native story editor via the shareToStory method – for users to share as a Telegram Story right from the mini app.
Mini apps also receive a number of events, allowing them to instantly react to actions by the user. You can learn more about which events are available here.
Mini apps are able to receive location permissions from users – giving developers the ability to make location-based games and interactive maps for events.
Mini Apps can request acceleration, orientation and rotation data from devices in real time – unlocking support for motion controls and VR experiences.
A user's device can send basic hardware info to mini apps, such as its processing power and memory capacity. Mini apps can then use this to optimize graphics and automatically adjust settings for the smoothest experience.
Bots can enable Business Mode, allowing Telegram Business subscribers to connect them to their account – streamlining and automating private chat management and interactions with their clients.
The account owner can specify which chats your bot can access – within those chats, the bot will receive all updates normally supported by the Bot API, except messages sent by itself and other bots. Depending on the business connection settings, your bot may also be able to send messages and do other actions on behalf of the account owner in chats that were active in the last 24h.
Here is a quick start guide to integrate your bot with Telegram Business:
business_message
, edited_business_message
and deleted_business_messages
updates. can_reply
in the latest BusinessConnection update.business_connection_id
field in sendMessage, sendChatAction and other send methods to communicate on behalf of the Business user.Users who connect your bot to their account will see a quick action bar at the top of each managed chat – tapping on “Manage Bot” will redirect them to your bot, which will receive a deep link message in the format /start bizChat<user_chat_id>
.
Please keep in mind that operating bots on Telegram is subject to the Telegram Bot Developer Terms of Service. Specifically, for Telegram Business, make sure you have read and understood Section 5.4.
If your bot or mini app sells digital goods and services, be sure to carry out the payment in Telegram Stars by specifying
XTR
as currency. In compliance with third-party store policies, Telegram does not support the sale of digital goods and services using other currencies.
Telegram bots can accept payments with a sleek, streamlined interface that collects all necessary data from the user. Telegram doesn't collect any payment data – like the user's credit card information – and sends it directly to one of the supported payment providers.
Here is a quick start guide to implement payments:
Then, to issue an invoice and process the order flow:
For more details, feel free to check out our full exhaustive guides for selling goods and services on Telegram – they include live checklists, parameters and in-depth method descriptions:
Telegram does not directly process the payments, does not store data about orders and does not collect any fees. Invoices are forwarded directly to the payment provider.
For this reason, disputes must be solved between the user, the bot developer and the payment provider. You can read more about this in the Privacy Policy.
Telegram offers a flexible, lightweight and free framework to authenticate users on any website and app. This can be used to bridge your platform with Telegram, providing a smooth experience to your users. You can also freely rely on this framework to implement a fast and signup-free login on your site, regardless of its connection to Telegram.
The Telegram login widget is a simple and secure way to authorize users on your website.
/setdomain
command in @BotFather to pair the bot with your website domain. When users open your website via an inline button, you can use the login_url parameter as an alternative to login widgets. This way, you'll be able to seamlessly authorize them on your website or app before the page even loads.
Make sure to review our guide on authenticating the received data as well as our sample code.
Bots can serve as standalone gaming platforms – with our HTML5 Gaming API you can develop multiplayer or single-player games and let your users have fun comparing ranks, scores and much more.
To get started, follow these simple steps:
/newgame
command to @BotFathergame_short_name
in a CallbackQueryurl
param of answerCallbackQueryThen, to handle highscores:
You can also embed a share button within your game, play around with custom inline buttons, URL parameters and much more. To get a better idea, make sure to check out:
Check out @GameBot and @gamee for examples of what you can do using our Gaming Platform.
Stickers and Custom Emoji are a distinctive Telegram feature used by millions of users to share artwork every day. Stickers and custom emoji take many forms – ranging from basic images to smooth vector animations and high-detail .WEBM videos.
All these formats are supported by our Bot API, which allows bots to create, edit, delete and share new artwork packs on the fly. Telegram's Import API lets users migrate packs from other platforms and sticker apps.
Creating a new pack
To create a new pack, simply:
sticker_type
to regular to create a sticker pack or to custom emoji to create a pack of custom emoji. Attach the files you wish to include in the pack as an array of InputStickerAdditional features
Regular stickers and custom emoji support keywords that users can type to quickly find the respective artwork – this can be useful when a sticker doesn't have obvious ties to a specific emoji. You can use the keywords
parameter in InputSticker to specify them.
Custom emoji additionally support adaptive colors – they will always match the current context (e.g., white on photos, accent color when used as status, etc.); to enable this feature, use the needs_repainting
parameter in createStickerSet.
Once you're done creating and sharing your artwork, don't forget to check out our remaining sticker methods to find out how to edit, delete and even reorder your pack.
Note that these methods will only work on packs created by the bot that is calling them.
Bots can tailor their interfaces to support multiple languages – updating inputs and information on the fly. A user’s language_code is included in every relevant update as an IETF language tag, allowing bots to adapt accordingly.
We recommend that you follow our guidelines to provide the best user experience.
The language_code is an optional field – it could be empty.
If you target the general public, your code should always fall back to either the last recorded language tag or English (in this order) when the field is missing for a specific user.
Bots are frequently added to groups to perform basic tasks or assist moderators – like automatically posting company announcements or even celebrating birthdays. By default, all bots added to groups run in Privacy Mode and only see relevant messages and commands:
/command@this_bot
)./start
) if the bot was the last bot to send a message to the group.All bots will also receive, regardless of privacy mode:
Privacy mode is enabled by default for all bots, except bots that were added to a group as admins (bot admins always receive all messages). It can be disabled so that the bot receives all messages like an ordinary user (the bot will need to be re-added to the group for this change to take effect). We only recommend doing this in cases where it is absolutely necessary for your bot to work. In most cases, using the force reply option for the bot's messages should be more than enough.
This mode not only increases user privacy, but also makes the bot more efficient by reducing the number of inputs it needs to process. Users can always see a bot’s current privacy setting in the list of group members.
You can quickly test your bot without interfering with its users by simply running another instance of your code on a different bot account. To do so, create a new bot via @BotFather, obtain its token and use it in the testing instance of your code.
All further testing and debugging can happen privately on the new bot, without affecting the original instance.
If you need to share file references across bots, note that the
file_id
field is tied to a single bot id, so your test instance cannot use a sharedfile_id
database to quickly send media – files must be individually reuploaded.
Telegram also offers a dedicated test environment suitable for more advanced testing. Bots and users in this environment generally have more flexible restrictions – for example:
Flood limits are not raised in the test environment, and may at times be stricter. To minimize how this impacts your bot, you should make sure that it handles errors with retry policies and does not depend on hardcoded limit values.
The test environment is completely separate from the main environment, so you will need to create a new user account and a new bot with @BotFather.
To create an account and log in, use either of the following:
After logging in, simply create a new bot following the standard procedure and send your requests to the Test Bot API in this format:
https://api.telegram.org/bot<token>/test/METHOD_NAME
When working with the test environment, you may use HTTP links without TLS in the
url
field of both LoginUrl and WebAppInfo.
Millions choose Telegram for its speed. To best benefit users, your bot also needs to be responsive. In order to help developers keep their bots in shape, @BotFather will send status alerts if it sees something is wrong.
We check the number of replies and the request/response conversion rate for popular bots (~300 requests per minute, this value may change in the future). If your bot returns an abnormally low number, you will receive a notification from @BotFather.
By default, you will only get one alert per bot per hour.
Each alert has the following buttons:
We currently notify you about the following issues:
Too few private messages are sent. Value: {value} - Your bot is sending far fewer messages than it did in previous weeks. This is useful for newsletter-style bots that send messages without prompts from users. The larger the value, the more significant the difference.
Too few replies to incoming private messages. Conversion rate: {value} - Your bot is not replying to all messages that are being sent to it (the request/response conversion rate for your bot was too low for at least two of the last three 5-minute periods).
To provide a good user experience, please respond to all messages that are sent to your bot. Respond to message updates by calling send… methods (e.g. sendMessage).
inline_query
updates by calling answerInlineQuery.callback_query
updates by calling answerCallbackQuery.You can host and work with your own instance of our open-source Bot API.
The source code is available here, along with a quick installation guide.
After installing the server, remember to use the logOut method before redirecting requests to your new local API URL.
Your local instance runs on port
8081
by default and will only accept HTTP requests, so a TLS termination proxy has to be used to handle remote HTTPS requests.
By hosting our API locally you'll gain access to some upgrades, including:
API | Max File Download | Max File Upload | WHook URL | WHook Port | WHook Max Connections |
---|---|---|---|---|---|
Official | 20MB | 50MB | HTTPS | 443,80,88,8443 | 1-100 |
Local | Unlimited | 2000MB | HTTP | Any port | 1-100000 |
You can find an exhaustive list here.
All limits may be subject to change in the future, so make sure to follow @BotNews.
Below is a detailed guide to using @BotFather, Telegram’s tool for creating and managing bots.
Use the /newbot
command to create a new bot. @BotFather will ask you for a name and username, then generate an authentication token for your new bot.
The name of your bot is displayed in contact details and elsewhere.
The username is a short name, used in search, mentions and t.me links. Usernames are 5-32 characters long and not case sensitive – but may only include Latin characters, numbers, and underscores. Your bot's username must end in 'bot’, like 'tetris_bot' or 'TetrisBot'.
The token is a string, like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
, which is required to authorize the bot and send requests to the Bot API. Keep your token secure and store it safely, it can be used by anyone to control your bot.
Unlike the bot’s name, the username cannot be changed later – so choose it carefully.
When sending a request to api.telegram.org, remember to prefix the word ‘bot’ to your token.
When new users open your bot, they will be met with a helpful description in a box titled “What can this bot do?”.
Properly setting this field in @BotFather allows everyone to immediately get an idea of what your bot can do – your description should be brief, to the point and on topic.
You can also add a photo or video to this field with
Edit Description Picture
in @BotFather.
Additionally, just like normal users, bots also come with a short bio available on their profile. If you didn't specify this field while first creating your bot, you can set it at any time with the /setabouttext
command in @BotFather. Users can interact with many bots and they won't have access to their description after starting them – having a quick reminder of the bot's purpose can be very useful.
Note that both the Description and the About text can be natively localized – each user will automatically see the correct translation for their language.
Bots can also have a profile picture – you should pick something unique and original so that users can find it in their chat list at a glance.
Starting from April 21, 2023 (Telegram 9.6), you can edit your bot directly from its profile page – including setting a custom profile video.
If your existing token is compromised or you lost it for some reason, use the /token
command to generate a new one.
You can transfer ownership of your bot to another user.
To do this, send /mybots
, select your bot, then transfer ownership.
You can only transfer a bot to users who have interacted with it at least once.
Transferring ownership will give full control of the bot to another user – they will be able to access the bot’s messages and even delete it. The transfer is permanent, so please consider it carefully.
The remaining commands are pretty self-explanatory:
To edit your bot, you have two options.
You can use the available commands:
/
in the chat with your bot. See commands for more info.Or you can use the /mybots
command, tap on your bot and use the modern inline interface to edit it.
Starting from April 21, 2023 (Telegram 9.6), you can edit your bot's public-facing info directly from its profile page – including setting a custom profile video.
Please note that it may take a few minutes for changes to take effect.
With this information, you are ready to proceed to our Full API Reference for Developers.