-
+
- Integration
- Web Apps
- Payments
- Web Login @@ -88,7 +88,7 @@
- Keyboards that replace the user's keyboard with predefined answer options.
- Buttons that are shown next to messages from the bot.
For even more flexibility, Web Apps support 100% custom interfaces with Javascript.
+For even more flexibility, Web Apps support 100% custom interfaces with JavaScript.
@@ -121,14 +121,14 @@ width=44% />We require all developers to support several Global Commands to make sure Telegram bots offer a consistent and user-friendly experience.
Command Scopes
-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.
+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.
+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.
Keyboards
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.
+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.
@@ -144,7 +144,7 @@ width=44% />-
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.
+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.
Menu Button
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.
@@ -162,7 +162,7 @@ width=44% />Global Commands
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.
-
-
- /start - begins the interaction with the user, like sending an introductory message. This command can also be used to pass additional parameters to the bot (see Deep Linking). +
- /start - begins the interaction with the user, like sending an introductory message. This command can also be used to pass additional parameters to the bot (see Deep Linking).
- /help - returns a help message, like a short text about what your bot can do and a list of commands.
- /settings - (if applicable) shows the bot's settings for this user and suggests commands to edit them.
Inline Requests
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.
+Remember that inline functionality has to be enabled via @BotFather, or your bot will not receive inline Updates.
@@ -241,14 +241,14 @@ width=44% />Here is a quick start guide to implement payments:
- Pick a provider and obtain the proper token as well as a test token from the "Stripe TEST MODE" provider. -
- Implement payments via the appropriate API methods. +
- Implement payments via the appropriate API methods.
- Test your implementation by using your test token along with a test credit card.
Then, to issue an invoice and process the order flow:
-
-
- Send an invoice to the user for the goods or services you are offering. -
- Validate the order and accept the checkout via answerPreCheckoutQuery. -
- Confirm the payment by checking for a successful payment service message. +
- Send an invoice to the user for the goods or services you are offering. +
- Validate the order and accept the checkout via answerPreCheckoutQuery. +
- Confirm the payment by checking for a successful payment service message.
- Ship the goods or provide the services.
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.
@@ -278,24 +278,24 @@ width=44% />Make sure to review our guide on authenticating the received data as well as our sample code.
HTML5 Games
-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.
+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:
- Send the
/newgamecommand to @BotFather - Provide a description text, an image or an optional gif to showcase its gameplay -
- Send the game to users via the sendGame method or via an inline query -
- When someone wants to play, you'll receive the appropriate
game_short_namein a CallbackQuery
- - To launch the game, provide the HTML5 Game URL as the
urlparam of answerCallbackQuery
+ - Send the game to users via the sendGame method or via an inline query +
- When someone wants to play, you'll receive the appropriate
game_short_namein a CallbackQuery
+ - To launch the game, provide the HTML5 Game URL as the
urlparam of answerCallbackQuery
Then, to handle highscores:
-
-
- Use setGameScore to post high scores in the chat with the game -
- Use getGameHighScores to get in-game high score tables +
- Use setGameScore to post high scores in the chat with the game +
- Use getGameHighScores to get in-game high score tables
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:
@@ -305,24 +305,24 @@ width=44% />
Check out @GameBot and @gamee for examples of what you can do using our Gaming Platform.
Stickers
-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.
+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:
-
-
- Upload a new sticker file via uploadStickerFile. Repeat for all the stickers in the set. You will use the returned files in the next step, so keep them around. -
- Create a new sticker pack via createStickerSet. Attach the files you collected in step 1 and remember to only specify one of the three avaiable fields –
png_sticker,tgs_stickerandwebm_sticker– depending on which sticker format you uploaded.
- - Complete the pack by adding each remaining sticker in sequence via addStickerToSet. +
- Upload a new sticker file via uploadStickerFile. Repeat for all the stickers in the set. You will use the returned files in the next step, so keep them around. +
- Create a new sticker pack via createStickerSet. Attach the files you collected in step 1 and remember to only specify one of the three avaiable fields –
png_sticker,tgs_stickerandwebm_sticker– depending on which sticker format you uploaded.
+ - Complete the pack by adding each remaining sticker in sequence via addStickerToSet.
-
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.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.Language Support
-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.
+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.
-
-
- Your interfaces, texts and inline results should adapt seamlessly to the language_code, without user intervention. +
- Your interfaces, texts and inline results should adapt seamlessly to the language_code, without user intervention.
- Connected WebApps will receive the user's language_code – your HTML page should account for it. -
- HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery. +
- HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery.
- Command lists can also be specified for individual languages – more on this here.
@@ -341,7 +341,7 @@ width=44% />- Commands explicitly meant for them (e.g.,
/command@this_bot). - General commands (e.g.
/start) if the bot was the last bot to send a message to the group.
- - Inline messages sent via the bot. +
- Inline messages sent via the bot.
- Replies to any messages implicitly or explicitly meant for this bot.
All bots will also receive, regardless of privacy mode:
@@ -378,18 +378,18 @@ width=44% />-
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).
+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).
-
-
- Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to
inline_queryupdates by calling answerInlineQuery.
+ - Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to
inline_queryupdates by calling answerInlineQuery.
- Too few answers to callback queries. Conversion rate: {value} -
- Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to
callback_queryupdates by calling answerCallbackQuery.
+ - Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to
callback_queryupdates by calling answerCallbackQuery.
Local Bot API
-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.
+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.
@@ -407,7 +407,7 @@ width=44% />Your local instance runs on port
8081by default and will only accept HTTP requests, so a TLS termination proxy has to be used to handle remote HTTPS requests.- Official +Official 20MB 50MB HTTPS @@ -415,7 +415,7 @@ width=44% />1-100 - Local +Local Unlimited 2000MB HTTP @@ -499,9 +499,9 @@ width=44% />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.
+With this information, you are ready to proceed to our Full API Reference for Developers.
-
-
- If you have any questions, check out our Bot FAQ. +
- If you have any questions, check out our Bot FAQ.
- If you're experiencing issues with our API, please contact @BotSupport on Telegram.
Page not found + + + + + + + + + + + + + + + + ++ ++ + + + + + diff --git a/data/web/core.telegram.org/bots/features.html b/data/web/core.telegram.org/bots/features.html index fd19844ffc..f2d432443f 100644 --- a/data/web/core.telegram.org/bots/features.html +++ b/data/web/core.telegram.org/bots/features.html @@ -63,7 +63,7 @@++ ++++ ++ +Page not found
+ +The page has not been saved+ +- Attachment Menu
-- Integration
-
+
- Integration
- Web Apps
- Payments
- Web Login @@ -88,7 +88,7 @@
- Keyboards that replace the user's keyboard with predefined answer options.
- Buttons that are shown next to messages from the bot.
For even more flexibility, Web Apps support 100% custom interfaces with Javascript.
+For even more flexibility, Web Apps support 100% custom interfaces with JavaScript.
@@ -121,14 +121,14 @@ width=44% />We require all developers to support several Global Commands to make sure Telegram bots offer a consistent and user-friendly experience.
Command Scopes
-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.
+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.
+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.
Keyboards
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.
+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.
@@ -144,7 +144,7 @@ width=44% />-
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.
+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.
Menu Button
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.
@@ -162,7 +162,7 @@ width=44% />Global Commands
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.
-
-
- /start - begins the interaction with the user, like sending an introductory message. This command can also be used to pass additional parameters to the bot (see Deep Linking). +
- /start - begins the interaction with the user, like sending an introductory message. This command can also be used to pass additional parameters to the bot (see Deep Linking).
- /help - returns a help message, like a short text about what your bot can do and a list of commands.
- /settings - (if applicable) shows the bot's settings for this user and suggests commands to edit them.
Inline Requests
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.
+Remember that inline functionality has to be enabled via @BotFather, or your bot will not receive inline Updates.
@@ -241,14 +241,14 @@ width=44% />Here is a quick start guide to implement payments:
- Pick a provider and obtain the proper token as well as a test token from the "Stripe TEST MODE" provider. -
- Implement payments via the appropriate API methods. +
- Implement payments via the appropriate API methods.
- Test your implementation by using your test token along with a test credit card.
Then, to issue an invoice and process the order flow:
-
-
- Send an invoice to the user for the goods or services you are offering. -
- Validate the order and accept the checkout via answerPreCheckoutQuery. -
- Confirm the payment by checking for a successful payment service message. +
- Send an invoice to the user for the goods or services you are offering. +
- Validate the order and accept the checkout via answerPreCheckoutQuery. +
- Confirm the payment by checking for a successful payment service message.
- Ship the goods or provide the services.
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.
@@ -278,24 +278,24 @@ width=44% />Make sure to review our guide on authenticating the received data as well as our sample code.
HTML5 Games
-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.
+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:
- Send the
/newgamecommand to @BotFather - Provide a description text, an image or an optional gif to showcase its gameplay -
- Send the game to users via the sendGame method or via an inline query -
- When someone wants to play, you'll receive the appropriate
game_short_namein a CallbackQuery
- - To launch the game, provide the HTML5 Game URL as the
urlparam of answerCallbackQuery
+ - Send the game to users via the sendGame method or via an inline query +
- When someone wants to play, you'll receive the appropriate
game_short_namein a CallbackQuery
+ - To launch the game, provide the HTML5 Game URL as the
urlparam of answerCallbackQuery
Then, to handle highscores:
-
-
- Use setGameScore to post high scores in the chat with the game -
- Use getGameHighScores to get in-game high score tables +
- Use setGameScore to post high scores in the chat with the game +
- Use getGameHighScores to get in-game high score tables
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
-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.
+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:
-
-
- Upload a new sticker file via uploadStickerFile. Repeat for all the stickers in the set. You will use the returned files in the next step, so keep them around. -
- Create a new sticker pack via createStickerSet. Attach the files you collected in step 1 and remember to only specify one of the three avaiable fields –
png_sticker,tgs_stickerandwebm_sticker– depending on which sticker format you uploaded.
- - Complete the pack by adding each remaining sticker in sequence via addStickerToSet. +
- Upload a new sticker file via uploadStickerFile. Repeat for all the stickers in the set. You will use the returned files in the next step, so keep them around. +
- Create a new sticker pack via createStickerSet. Attach the files you collected in step 1 and remember to only specify one of the three avaiable fields –
png_sticker,tgs_stickerandwebm_sticker– depending on which sticker format you uploaded.
+ - Complete the pack by adding each remaining sticker in sequence via addStickerToSet.
-
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.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.Language Support
-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.
+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.
-
-
- Your interfaces, texts and inline results should adapt seamlessly to the language_code, without user intervention. +
- Your interfaces, texts and inline results should adapt seamlessly to the language_code, without user intervention.
- Connected WebApps will receive the user's language_code – your HTML page should account for it. -
- HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery. +
- HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery.
- Command lists can also be specified for individual languages – more on this here.
@@ -341,7 +341,7 @@ width=44% />- Commands explicitly meant for them (e.g.,
/command@this_bot). - General commands (e.g.
/start) if the bot was the last bot to send a message to the group.
- - Inline messages sent via the bot. +
- Inline messages sent via the bot.
- Replies to any messages implicitly or explicitly meant for this bot.
All bots will also receive, regardless of privacy mode:
@@ -378,18 +378,18 @@ width=44% />-
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).
+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).
-
-
- Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to
inline_queryupdates by calling answerInlineQuery.
+ - Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to
inline_queryupdates by calling answerInlineQuery.
- Too few answers to callback queries. Conversion rate: {value} -
- Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to
callback_queryupdates by calling answerCallbackQuery.
+ - Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to
callback_queryupdates by calling answerCallbackQuery.
Local Bot API
-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.
+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.
@@ -407,7 +407,7 @@ width=44% />Your local instance runs on port
8081by default and will only accept HTTP requests, so a TLS termination proxy has to be used to handle remote HTTPS requests.- Official +Official 20MB 50MB HTTPS @@ -415,7 +415,7 @@ width=44% />1-100 - Local +Local Unlimited 2000MB HTTP @@ -499,9 +499,9 @@ width=44% />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.
+With this information, you are ready to proceed to our Full API Reference for Developers.
-
-
- If you have any questions, check out our Bot FAQ. +
- If you have any questions, check out our Bot FAQ.
- If you're experiencing issues with our API, please contact @BotSupport on Telegram.
Page not found + + + + + + + + + + + + + + + + ++ ++ + + + + +++ ++++ ++ +Page not found
+ +The page has not been saved+ +