• Bots
• Telegram Mini Apps

WithMini Apps developers can useJavaScript to createinfinitely flexible interfaces that can be launched right inside Telegram — and can completely replaceany website.

Like bots,Mini Apps supportseamless authorization, payments via third-partypayment providers (withGoogle Pay andApple Pay out of the box), delivering tailored push notifications to users, andmuch more.

To see aMini App in action, try our sample@DurgerKingBot.

Recent changes

November 17, 2024

Bot API 8.0

This is thelargest update in the history of Telegram mini apps – adding more than10 new features and monetization options for developers. To read more about all these changes, check out thisdedicated blog post.

Full-screen Mode

• Mini Apps are now able tobecome full-screen in both portrait andlandscape mode – allowing them to hostmore games, playwidescreen media and supportimmersive user experiences.
• Added the methodsrequestFullscreen andexitFullscreen to toggle full-screen mode.
• Added the fieldssafeAreaInset andcontentSafeAreaInset, allowing Mini Apps to ensure that their content properly respects the device's safe area margins.
• Further added the fieldsisActive andisFullscreen to the classWebApp.
• Added theeventsactivated,deactivated,safeAreaChanged,contentSafeAreaChanged,fullscreenChanged andfullscreenFailed.

Homescreen Shortcuts

• Mini Apps can now be accessed viadirect shortcuts added to thehome screen of mobile devices.
• Added the methodaddToHomeScreen to create a shortcut for users to add to their home screens.
• Added the methodcheckHomeScreenStatus to determine the status and support of the home screen shortcut for the Mini App on the current device.
• Added theeventshomeScreenAdded andhomeScreenChecked.

Emoji Status

• Mini Apps can now prompt users to set theiremoji status – or request access to later sync it automatically with in-game badges, third-party APIs and more.
• Added the methodsetEmojiStatus to let users manually confirm a custom emoji as their new status via a native dialog.
• Added the methodrequestEmojiStatusAccess for obtaining permission to later update a user's emoji status via the Bot API methodsetUserEmojiStatus.
• Added theeventsemojiStatusSet,emojiStatusFailed andemojiStatusAccessRequested.

Media Sharing and File Downloads

• Users can nowshare media directly from Mini Apps – sendingreferral codes, custom memes, artwork and more toany chat or posting themas a story.
• Added the methodshareMessage to share media from Mini Apps to Telegram chats. Also seePreparedInlineMessage.
• Added the methoddownloadFile, introducing support for anative popup that prompts users to download files from the Mini App.
• Added theeventsshareMessageSent,shareMessageFailed andfileDownloadRequested.

Geolocation Access

• Mini Apps can now requestgeolocation access to users, allowing them to build virtually any location-based service, fromgames with dynamic points of interest tointeractive maps for events.
• Added the fieldLocationManager to the classWebApp.
• Added theeventslocationManagerUpdated andlocationRequested.

Device Motion Tracking

• Mini Apps can now track detaileddevice motion data, allowing them to implement better productivity tools, immersiveVR experiences and more.
• Added the fieldsisOrientationLocked,Accelerometer,DeviceOrientation andGyroscope to the classWebApp.
• Added the methodslockOrientation andunlockOrientation to control the screen orientation.
• Added theeventsaccelerometerStarted,accelerometerStopped,accelerometerChanged,accelerometerFailed,deviceOrientationStarted,deviceOrientationStopped,deviceOrientationChanged,deviceOrientationFailed,gyroscopeStarted,gyroscopeStopped,gyroscopeChanged,gyroscopeFailed.

Subscription Plans and Gifts for Telegram Stars

• Mini Apps now supportpaid subscriptions powered byTelegram Stars –monetizing their efforts with multiple tiers of content and features.
• Mini Apps can use their balance ofTelegram Stars tosend gifts to their users.
• You can read more on implementing Paid Subscriptions and Gifts in ourBot API documentation.

Loading Screen Customization

• Mini Apps can customize their loading screen, addingtheir own icon andspecific colors for light and dark themes.
• You can access these customization settings in@BotFather via/mybots > Select Bot > Bot Settings > Configure Mini App > Enable Mini App

Hardware-specific Optimizations

• Mini Apps running on Android can now receivebasic information about a device's processing hardware, allowing them tooptimize user experience based on the device's capabilities.
• This information includes the OS, App and SDK's respective versions as well as the device's model and performance class.

General

• The fieldphoto_url in the classWebAppUser is now available to all Mini Apps, allowing them to access a user's profile photo if their privacy settings allow for it.
• Third parties (e.g., Mini App builders, external SDKs etc.) that receive or process data on behalf of Mini Apps are now able tovalidate it without knowing the App'sbot token.
• Debuggingoptions have been expanded to include full support foriOS devices. You can use these tools to find app-specific issues in your Mini App.

September 6, 2024

Bot API 7.10

• Added the fieldSecondaryButton to the classWebApp.
• Added the eventsecondaryButtonClicked.
• Renamed the classMainButton to the classBottomButton.
• Added the fieldbottomBarColor and the methodsetBottomBarColor to the classWebApp.
• Added the fieldbottom_bar_bg_color to the classThemeParams.

July 31, 2024

Bot API 7.8

• Added the option for bots to set aMain Mini App, which can be previewed and launched directly from a button in the bot's profile or a link.
• Added the methodshareToStory to the classWebApp.

July 7, 2024

Bot API 7.7

• Added the fieldisVerticalSwipesEnabled and the methodsenableVerticalSwipes,disableVerticalSwipes to the classWebApp.
• Added the eventscanQrPopupClosed.

July 1, 2024

Bot API 7.6

• Added the fieldsection_separator_color to the classThemeParams.
• Changed the default opening mode forDirect Link Mini Apps.

March 31, 2024

Bot API 7.2

• Added the fieldBiometricManager to the classWebApp.

December 29, 2023

Bot API 7.0

• Added the fieldSettingsButton to the classWebApp.
• Added the fieldsheader_bg_color,accent_text_color,section_bg_color,section_header_text_color,subtitle_text_color,destructive_text_color to the classThemeParams.
• Mini Apps no longer close when the methodWebApp.openTelegramLink is called.

September 22, 2023

Bot API 6.9

• Added the fieldCloudStorage to the classWebApp.
• Added the methodsrequestWriteAccess andrequestContact to the classWebApp.
• Added the fieldsadded_to_attachment_menu andallows_write_to_pm to the classWebAppUser.
• Added the eventswriteAccessRequested andcontactRequested.
• Added the ability to set any header color using thesetHeaderColor method.

April 21, 2023

Bot API 6.7

• Added support for launching Mini Apps from inline query results and from a direct link.
• Added the methodswitchInlineQuery to the classWebApp.

December 30, 2022

Bot API 6.4

• Added the fieldplatform, the optional parameteroptions to the methodopenLink and the methodsshowScanQrPopup,closeScanQrPopup,readTextFromClipboard to the classWebApp.
• Added the eventsqrTextReceived,clipboardTextReceived.

August 12, 2022

Bot API 6.2

• Added the fieldisClosingConfirmationEnabled and the methodsenableClosingConfirmation,disableClosingConfirmation,showPopup,showAlert,showConfirm to the classWebApp.
• Added the fieldis_premium to the classWebAppUser.
• Added the eventpopupClosed.

June 20, 2022

Bot API 6.1

• Added the ability to use bots added to the attachment menu in group, supergroup and channel chats.
• Added support fort.me links that can be used to select the chat in which the attachment menu with the bot will be opened.
• Added the fieldsversion,headerColor,backgroundColor,BackButton,HapticFeedback and the methodsisVersionAtLeast,setHeaderColor,setBackgroundColor,openLink,openTelegramLink,openInvoice to the classWebApp.
• Added the fieldsecondary_bg_color to the classThemeParams.
• Added the methodoffClick to the classMainButton.
• Added the fieldschat,can_send_after to the classWebAppInitData.
• Added theeventsbackButtonClicked,settingsButtonClicked,invoiceClosed.

Designing Mini Apps

Color Schemes

Mini Apps always receive data about the user's currentcolor theme in real time, so you can adjust the appearance of your interfaces to match it. For example, when users switch betweenDay and Night modes or use variouscustom themes.

Jump to technical information

Design Guidelines

Telegram apps are known for being snappy, smooth and following a consistent cross-platform design. Your Mini App should ideally reflect these principles.

• All elements should be responsive and designed with a mobile-first approach.
• Interactive elements should mimic the style, behavior, and intent of UI components that already exist.
• All included animations should be smooth, ideally 60fps.
• All inputs and images should contain labels for accessibility purposes.
• The app should deliver a seamless experience by monitoring thedynamic theme-based colors provided by the API and using them accordingly.
• Ensure that the app’s interface respects thesafe area andcontent safe area to avoid overlapping with control elements, especially when using fullscreen mode.
• For Android devices, consider the additional information in the User-Agent (seeUser-Agent details) and adjust for the device’s performance class, minimizing animations and visual effects on low-performance devices to ensure smooth performance.

Implementing Mini Apps

Telegram currently supports seven different ways of launching Mini Apps: the main Mini App from aprofile button, from akeyboard button, from aninline button, from thebot menu button, viainline mode, from adirect link – and even from theattachment menu.

Keyboard Button Mini Apps

TL;DR: Mini Apps launched from aweb_app typekeyboard button can send data back to the bot in aservice message usingTelegram.WebApp.sendData. This makes it possible for the bot to produce a response without communicating with any external servers.

Users can interact with bots usingcustom keyboards,buttons under bot messages, as well as by sending freeformtext messages or any of theattachment types supported by Telegram: photos and videos, files, locations, contacts and polls. For even more flexibility, bots can utilize the full power ofHTML5 to create user-friendly input interfaces.

You can send aweb_app typeKeyboardButton that opens a Mini App from the specified URL.

To transmit data from the user back to the bot, the Mini App can call theTelegram.WebApp.sendData method. Data will be transmitted to the bot as a String in a service message. The bot can continue communicating with the user after receiving it.

Good for:

• Сustom data input interfaces (a personalized calendar for selecting dates; selecting data from a list with advanced search options; a randomizer that lets the user “spin a wheel” and chooses one of the available options, etc.)
• Reusable components that do not depend on a particular bot.

Inline Button Mini Apps

TL;DR: For more interactive Mini Apps like@DurgerKingBot, use aweb_app typeInline KeyboardButton, which gets basic user information and can be used to send a message on behalf of the user to the chat with the bot.

If receiving text data alone is insufficient or you need a more advanced and personalized interface, you can open a Mini App using aweb_app typeInline KeyboardButton.

From the button, a Mini App will open with the URL specified in the button. In addition to the user'stheme settings, it will receive basic user information (ID,name,username,language_code) and a unique identifier for the session,query_id, which allows messages on behalf of the user to be sent back to the bot.

The bot can call the Bot API methodanswerWebAppQuery to send an inline message from the user back to the bot and close the Mini App. After receiving the message, the bot can continue communicating with the user.

Good for:

• Fully-fledged web services and integrations of any kind.
• The use cases are effectivelyunlimited.

Launching Mini Apps from the Menu Button

TL;DR: Mini Apps can be launched from a customized menu button. This simply offers a quicker way to access the app and is otherwiseidentical tolaunching a mini app from an inline button.

By default, chats with bots always show a convenientmenu button that provides quick access to all listedcommands. WithBot API 6.0, this button can be used tolaunch a Mini App instead.

To configure the menu button, you must specify the text it should show and the Mini App URL. There are two ways to set these parameters:

• To customize the button forall users, use@BotFather (the/setmenubutton command orBot Settings > Menu Button).
• To customize the button for bothall users andspecific users, use thesetChatMenuButton method in the Bot API. For example, change the button text according to the user's language, or show links to different Mini Apps based on a user's settings in your bot.

Apart from this, Mini Apps opened via the menu button work in the exact same way as whenusing inline buttons.

@DurgerKingBot allows launching its Mini App both from an inline button and from the menu button.

Launching the main Mini App

TL;DR: If your bot is a mini app, you can add a prominentLaunch app button as well as high-quality demo videos and screenshots to the bot’s profile. To do this, go to@BotFather and set up your bot'sMain Mini App.

If your bot is a mini app, you can unlock a number of features that streamline and simplify the way in which users view and interact with it. To do this, go to@BotFather and set up your bot'sMain Mini App.

After setting a main mini app, you'll be able to upload detailedmedia preview demos to publicly highlight your app's key features on its profile. ALaunch app button will also appear, allowing users to open your app directly from its profile. Bots that enabled a main mini app will be displayed in theApps tab of the search for users who have launched them.

Media previews supportmultiple languages – so you can uploadtranslated versions of your previews that will be shown to users based on theirapp language.

A bot'smain Mini App can also be opened in the current chat by direct link in the formathttps://t.me/botusername?startapp. If a non-emptystartapp parameter is included in the link, it will be passed to the Mini App in thestart_param field and in the GET parametertgWebAppStartParam.

Examples

https://t.me/botusername?startapp
https://t.me/botusername?startapp=command
https://t.me/botusername?startapp=command&mode=compact

In this mode, Mini Apps can use thechat_type andchat_instance parameters to keep track of the current chat context. This introduces support forconcurrent andshared usage by multiple chat members – to create live whiteboards, group orders, multiplayer games and similar apps.

By default, the main Mini App opens to full-screen height, and users cannot reduce them to half-height. However, you can change this behavior via@BotFather or by including the parametermode=compact in the link to the Mini App, in which case it will open to half-screen height by default.

Good for:

• Fully-fledged web services and integrations that any user can open in one tap.
• Cooperative, multiplayer or teamwork-oriented services within a chat context.
• The use cases are effectivelyunlimited.

Successful bots whichenable a main Mini App andaccept payments inTelegram Stars may be featured in the TelegramMini App Store. To increase the chances of being featured, we recommend uploading high-quality media showcasing your app on your bot's profile and following ourdesign guidelines.

Inline Mode Mini Apps

TL;DR: Mini Apps launched viaweb_app typeInlineQueryResultsButton can be used anywhere in inline mode. Users can create content in a web interface and then seamlessly send it to the current chat via inline mode.

You can use thebutton parameter in theanswerInlineQuery method to display a special 'Switch to Mini App' button either above or in place of the inline results. This button willopen a Mini App from the specified URL. Once done, you can call theTelegram.WebApp.switchInlineQuery method to send the user back to inline mode.

Inline Mini Apps haveno access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected toinline mode and actively pick a result.

Good for:

• Fully-fledged web services and integrations in inline mode.

Direct Link Mini Apps

TL;DR: Mini App Bots can be launched from a direct link in any chat. They support astartapp parameter and are aware of the current chat context.

You can use direct links toopen a Mini App directly in the current chat. If a non-emptystartapp parameter is included in the link, it will be passed to the Mini App in thestart_param field and in the GET parametertgWebAppStartParam.

In this mode, Mini Apps can use thechat_type andchat_instance parameters to keep track of the current chat context. This introduces support forconcurrent andshared usage by multiple chat members – to create live whiteboards, group orders, multiplayer games and similar apps.

Mini Apps opened from a direct link haveno access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected toinline mode and actively pick a result.

Starting fromBot API 7.6, by default, Mini Apps of this type open to full-screen height, and users cannot reduce them to half-height. However, you can change this behavior by including the parametermode=compact in the link to the Mini App, in which case it will open to half-screen height by default.

Examples

https://t.me/botusername/appname
https://t.me/botusername/appname?startapp=command
https://t.me/botusername/appname?startapp=command&mode=compact

Good for:

• Fully-fledged web services and integrations that any user can open in one tap.
• Cooperative, multiplayer or teamwork-oriented services within a chat context.
• The use cases are effectivelyunlimited.

Launching Mini Apps from the Attachment Menu

TL;DR: Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched from any chat. To try this mode, open thisattachment menu link for@DurgerKingBot, then use the menu inany type of chat.

Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched fromany type of chat. You can configure in which types of chats your mini app can be started from the attachment menu (private, groups, supergroups or channels).

Attachment menu integration is currently only available for major advertisers on theTelegram Ad Platform. However,all bots can use it in thetest server environment.

To enable this feature for your bot, open@BotFatherfrom an account on the test server and send the/setattach command – or go toBot Settings > Configure Attachment Menu. Then specify the URL that will be opened to launch the bot's Mini App via its icon in the attachment menu.

You can add a 'Settings' item to the context menu of your Mini App using@BotFather. When users select this option from the menu, your bot will receive asettingsButtonClicked event.

In addition to the user'stheme settings, the bot will receive basic user information (ID,name,username,language_code,photo), as well as public info about the chat partner (ID,name,username,photo) or the chat info (ID,type,title,username,photo) and a unique identifier for the web view sessionquery_id, which allows messages of any type to be sent to the chat on behalf of the user that opened the bot.

The bot can call the Bot API methodanswerWebAppQuery, which sends an inline message from the user via the bot to the chat where it was launched and closes the Mini App.

You can read more about adding bots to the attachment menuhere.

Initializing Mini Apps

To connect your Mini App to the Telegram client, place the scripttelegram-web-app.js in the<head> tag before any other scripts, using this code:

<script src="https://telegram.org/js/telegram-web-app.js?56"></script>

Once the script is connected, awindow.Telegram.WebApp object will become available with the following fields:

ThemeParams

Mini Apps canadjust the appearance of the interface to match the Telegram user's app in real time. This object contains the user's current theme settings:

StoryShareParams

This object describes additional sharing settings for the native story editor.

StoryWidgetLink

This object describes a widget link to be included in the story.

ScanQrPopupParams

This object describes the native popup for scanning QR codes.

PopupParams

This object describes the native popup.

PopupButton

This object describes the native popup button.

EmojiStatusParams

This object describes additional settings for setting an emoji status.

DownloadFileParams

This object describes the parameters for the file download request.

Note: To ensure consistent file download behavior across platforms, it is recommended to include the HTTP headerContent-Disposition: attachment; filename="<file_name>" in the server response. This header helps prompt the download action and suggests a file name for the downloaded file, especially on web platforms where forced downloads cannot always be guaranteed.

SafeAreaInset

This object represents the system-defined safe area insets, providing padding values to ensure content remains within visible boundaries, avoiding overlap with system UI elements like notches or navigation bars.

ContentSafeAreaInset

This object represents the content-defined safe area insets, providing padding values to ensure content remains within visible boundaries, avoiding overlap with Telegram UI elements.

BackButton

This object controls theback button, which can be displayed in the header of the Mini App in the Telegram interface.

All these methods return the BackButton object so they can be chained.

BottomButton

This object controls the button that is displayed at the bottom of the Mini App in the Telegram interface.

All these methods return the BottomButton object so they can be chained.

SettingsButton

This object controls theSettings item in the context menu of the Mini App in the Telegram interface.

All these methods return theSettingsButton object so they can be chained.

HapticFeedback

This object controls haptic feedback.

All these methods return the HapticFeedback object so they can be chained.

CloudStorage

This object controls the cloud storage. Each bot can store up to 1024 items per user in the cloud storage.

All these methods return theCloudStorage object, so they can be chained.

BiometricManager

This object controls biometrics on the device. Before the first use of this object, it needs to be initialized using theinit method.

All these methods return theBiometricManager object so they can be chained.

BiometricRequestAccessParams

This object describes the native popup for requesting permission to use biometrics.

BiometricAuthenticateParams

This object describes the native popup for authenticating the user using biometrics.

Accelerometer

This object provides access to accelerometer data on the device.

All these methods return theAccelerometer object so they can be chained.

AccelerometerStartParams

This object defines the parameters for starting accelerometer tracking.

DeviceOrientation

This object provides access to orientation data on the device.

All these methods return theDeviceOrientation object so they can be chained.

DeviceOrientationStartParams

This object defines the parameters for starting device orientation tracking.

Gyroscope

This object provides access to gyroscope data on the device.

All these methods return theGyroscope object so they can be chained.

GyroscopeStartParams

This object defines the parameters for starting gyroscope tracking.

LocationManager

This object controls location access on the device. Before the first use of this object, it needs to be initialized using theinit method.

All these methods return theLocationManager object so they can be chained.

LocationData

This object contains data about the current location.

WebAppInitData

This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from akeyboard button or frominline mode.

WebAppUser

This object contains the data of the Mini App user.

WebAppChat

This object represents a chat.

Validating data received via the Mini App

To validate data received via the Mini App, one should send the data from theTelegram.WebApp.initData field to the bot's backend. The data is a query string, which is composed of a series of field-value pairs.

You can verify the integrity of the data received by comparing the receivedhash parameter with the hexadecimal representation of theHMAC-SHA-256 signature of thedata-check-string with the secret key, which is theHMAC-SHA-256 signature of thebot's token with the constant stringWebAppData used as a key.

Data-check-string is a chain of all received fields, sorted alphabetically, in the formatkey=<value> with aline feed character ('\n', 0x0A) used as separator – e.g.,'auth_date=<auth_date>\nquery_id=<query_id>\nuser=<user>'.

The full check might look like:

data_check_string = ...secret_key = HMAC_SHA256(<bot_token>, "WebAppData")if (hex(HMAC_SHA256(data_check_string, secret_key)) == hash) {  // data is from Telegram}

To prevent the use of outdated data, you can additionally check theauth_date field, which contains a Unix timestamp of when it was received by the Mini App.

Once validated, the data may be used on your server. Complex data types are represented as JSON-serialized objects.

Validating data for Third-Party Use

^NEW If you need to share the data with a third party, they can validate the data without requiring access to yourbot's token. Simply provide them with the data from theTelegram.WebApp.initData field and yourbot_id.

The integrity of the data can be verified by validating the receivedsignature parameter, which is the base64url-encoded representation of theEd25519 signature of thedata-check-string. The verification is performed using the public key provided by Telegram.

Data-check-string is constructed as follows:
1. Prepend thebot_id, followed by: and the constant stringWebAppData.
2. Add aline feed character ('\n', 0x0A).
3. Append all received fields (excepthash andsignature), sorted alphabetically, in the formatkey=<value>.
4. Separate each key-value pair with a line feed character ('\n', 0x0A).

Example:
'12345678:WebAppData\nauth_date=<auth_date>\nquery_id=<query_id>\nuser=<user>'

The verification process might look like this:

data_check_string = ...public_key = "<Telegram_public_key>"if (Ed25519_verify(public_key, data_check_string, signature)) {  // data is valid and originated from Telegram}

Telegram provides the followingEd25519 public keys for signature verification:

Test environment:40055058a4ee38156a06562e52eece92a771bcd8346a8c4615cb7376eddf72ec (hex)
Production:e7bf03a2fa4602af4580703d88dda5bb59f32ed8b02a56c187fe7d34caed242d (hex)

To prevent the use of outdated data, the third party should additionally validate theauth_date field. This field contains a Unix timestamp indicating when the data was received by the Mini App.

Once validated, the data may be used. Complex data types are represented as JSON-serialized objects.

Events Available for Mini Apps

The Mini App can receive events from the Telegram app, onto which a handler can be attached using theTelegram.WebApp.onEvent(eventType, eventHandler) method. InsideeventHandler thethis object refers toTelegram.WebApp, the set of parameters sent to the handler depends on the event type. Below is a list of possible events:

Adding Bots to the Attachment Menu

Attachment menu integration is currently only available for major advertisers on theTelegram Ad Platform. However,all bots can use it in thetest server environment. Talk to Botfather on the test server toset up the integration.

A special link is used to add bots to the attachment menu:

https://t.me/botusername?startattach
or
https://t.me/botusername?startattach=command

For example, open thisattachment menu link for@DurgerKingBot, then use the menu in anyprivate chat.

Opening the link prompts the user to add the bot to their attachment menu. If the bot has already been added, the attachment menu will open in the current chat and redirect to the bot there (if the link is opened from a 1-on-1 chat). If a non-emptystartattach parameter was included in the link, it will be passed to the Mini App in thestart_param field and in the GET parametertgWebAppStartParam.

The following link formats are also supported:

https://t.me/username?attach=botusername
https://t.me/username?attach=botusername&startattach=command
https://t.me/+1234567890?attach=botusername
https://t.me/+1234567890?attach=botusername&startattach=command

These links open the Mini App in the attachment menu in the chat with a specific user. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. If a non-emptystartattach parameter was included in the link, it will be passed to the Mini App in thestart_param field and in the GET parametertgWebAppStartParam.

Bot API 6.1+ supports a new link format:

https://t.me/botusername?startattach&choose=users+bots
https://t.me/botusername?startattach=command&choose=groups+channels

Opening such a link prompts the user to choose a specific chat and opens the attachment menu in that chat. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. You can specify which types of chats the user will be able to choose from. It can be one or more of the following types:users,bots,groups,channels separated by a+ sign. If a non-emptystartattach parameter was included in the link, it will be passed to the Mini App in thestart_param field and in the GET parametertgWebAppStartParam.

Additional Data in User-Agent

When the Mini App is running on Android, additional information is appended to the User-Agent string to provide more context about the app environment. This information includes the app version, device model, Android version, SDK version, and device performance class, formatted as follows:

Telegram-Android/{app_version} ({manufacturer} {model}; Android {android_version}; SDK {sdk_version}; {performance_class})

where:

• {app_version} is the version of the Telegram app (e.g.,11.3.3),
• {manufacturer} {model} represents the device’s manufacturer and model (e.g.,Google sdk_gphone64_arm64),
• {android_version} is the Android OS version running on the device (e.g.,14),
• {sdk_version} indicates the Android SDK version (e.g.,34),
• {performance_class} specifies the device performance class asLOW,AVERAGE, orHIGH, indicating the device's performance capacity.

Example
Mozilla/5.0 (Linux; Android 14; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.5672.136 Mobile Safari/537.36 Telegram-Android/11.3.3 (Google sdk_gphone64_arm64; Android 14; SDK 34; LOW)

We recommend using this information to optimize your Mini App based on the device's capabilities. For instance, you can adjust animations and visual effects in games on low-performance devices to ensure a smooth experience for all users, regardless of device specifications.

Testing Mini Apps

Using bots in the test environment

To log in to the test environment, use either of the following:

• iOS: tap 10 times on the Settings icon > Accounts > Login to another account > Test.
• Telegram Desktop: open ☰ Settings > Shift + Alt + Right click ‘Add Account’ and select ‘Test Server’.
• macOS: click the Settings icon 10 times to open the Debug Menu, ⌘ + click ‘Add Account’ and log in via phone number.

The test environment is completely separate from the main environment, so you will need to create anew user account and anew bot with @BotFather.

After receiving your bot token, you can send requests to the Bot API in this format:

https://api.telegram.org/bot<token>/test/METHOD_NAME

Note: When working with the test environment, you may use HTTP links without TLS to test your Mini App.

Debug Mode for Mini Apps

Use these tools to find app-specific issues in your Mini App:

iOS

• In Telegram tap 10 times on the Settings icon and toggle onAllow Web View Inspection.
• Connect your phone to your computer using a USB cable.
• Open Safari on your Mac, then go toDevelop > [Your Device Name] in the menu bar.
• Launch your Mini App on the iOS device – it will appear in theDevelop menu under your device.

Android

• Enable USB-Debugging on your device.
• In Telegram Settings, scroll all the way down, press and hold on theversion number two times.
• ChooseEnable WebView Debug in the Debug Settings.
• Connect your phone to your computer and openchrome://inspect/#devices in Chrome – you will see your Mini App there when you launch it on your phone.

Telegram Desktop on Windows and Linux

• Download and launch theBeta Version of Telegram Desktop onWindows orLinux (not supported on Telegram Desktop for macOS yet).
• Go toSettings > Advanced > Experimental settings > Enable webview inspection.
• Right click in the WebView and chooseInspect.

Telegram macOS

• Download and launch theBeta Version of Telegram macOS.
• Quickly click 5 times on the Settings icon to open the debug menu and enable “Debug Mini Apps”.
• Right click in the Mini App and chooseInspect Element.