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.
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.
Remember that you can also customize the text placeholder in the input field by setting the
input_field_placeholder
parameter.
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.
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.
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 futher integrating bots with Telegram and other services.
Bots can easily process complex inputs of any kind and dynamic interaction flows via Web Apps. With this unique feature, you can develop any number of flexible, streamlined interfaces in JavaScript.
Web 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 Web 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.
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:
A full and exhaustive guide, including live checklist, parameters and in-depth method descriptions is available here. We strongly recommend that you read the full guide before going live.
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 are a distinctive Telegram feature used by millions of users to share artwork every day. Stickers 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 sticker packs on the fly. Telegram's Import API lets users migrate packs from other platforms and sticker apps.
To create a new sticker pack, follow these simple steps:
png_sticker
, tgs_sticker
and webm_sticker
– depending on which sticker format you uploaded.Once you're done, 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 in-app 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.
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.
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.
Once set, the description, about text and profile pic can be replaced but never fully removed.
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.
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.