This checklist tracks support for the Telegram Web Apps JavaScript API. Mark items as they are implemented.
- ready (bcce132)
- expand (bcce132)
- close (bcce132)
- sendData (bcce132)
- openLink (840ace1)
- openTelegramLink (840ace1)
- openInvoice (840ace1)
- switchInlineQuery (a098e00)
- showAlert (bcce132)
- showConfirm (bcce132)
- showPopup (840ace1)
- showScanQrPopup (840ace1)
- closeScanQrPopup (840ace1)
- shareURL (a098e00)
- shareMessage (4b10c98)
- shareToStory (4b10c98)
- joinVoiceChat (a098e00)
- requestWriteAccess (a098e00)
- requestContact (d595540)
- requestPhoneNumber (d595540)
- openContact (d595540)
- enableVerticalSwipes (8e60df3)
- disableVerticalSwipes (8e60df3)
- hideKeyboard (94ff585)
- downloadFile (3092094)
- readTextFromClipboard (fd1c84e)
- setEmojiStatus (12cfbd0)
- requestEmojiStatusAccess (12cfbd0)
- setHeaderColor (58a73cb)
- setBackgroundColor (58a73cb)
- setBottomBarColor (58a73cb)
- isVersionAtLeast (92abbf7)
- addToHomeScreen (e709edb)
- checkHomeScreenStatus (e709edb)
- enableClosingConfirmation (8fe4dec)
- disableClosingConfirmation (8fe4dec)
- isClosingConfirmationEnabled (99a3cf2)
- requestFullscreen (4364008)
- exitFullscreen (4364008)
- lockOrientation (4364008)
- unlockOrientation (4364008)
- show (7d524fd)
- hide (7d524fd)
- setText (7d524fd)
- setColor (7d524fd)
- setTextColor (7d524fd)
- onClick (7d524fd)
- offClick (7d524fd)
- enable (92abbf7)
- disable (92abbf7)
- showProgress (92abbf7)
- hideProgress (92abbf7)
- setParams (92abbf7)
- isVisible (92abbf7)
- isActive (92abbf7)
- isProgressVisible (92abbf7)
- hasShineEffect (92abbf7)
- show (bcce132)
- hide (f0a108d)
- setText (bcce132)
- onClick (0a42d7b)
- offClick (0a42d7b)
- enable (92abbf7)
- disable (92abbf7)
- showProgress (92abbf7)
- hideProgress (92abbf7)
- setParams (92abbf7)
- isVisible (92abbf7)
- isActive (92abbf7)
- isProgressVisible (92abbf7)
- isActive (92abbf7)
- isFullscreen (92abbf7)
- isOrientationLocked (92abbf7)
- isVerticalSwipesEnabled (92abbf7)
- safeAreaInset (92abbf7)
- contentSafeAreaInset (92abbf7)
- init (10ca55c)
- getLocation (10ca55c)
- openSettings (10ca55c)
- onLocationManagerUpdated (10ca55c)
- onLocationRequested (10ca55c)
- init (8c34fbd)
- requestAccess (8c34fbd)
- authenticate (8c34fbd)
- updateBiometricToken (8c34fbd)
- openSettings (8c34fbd)
- isInited (7a2555c)
- isBiometricAvailable (7a2555c)
- isAccessRequested (7a2555c)
- isAccessGranted (7a2555c)
- isBiometricTokenSaved (7a2555c)
- deviceId (7a2555c)
- getItem (ae2a302)
- setItem (ae2a302)
- removeItem (ae2a302)
- getItems (ae2a302)
- setItems (ae2a302)
- removeItems (ae2a302)
- getKeys (ae2a302)
- clear (ae2a302)
| Event | Payload |
|---|---|
mainButtonClicked |
none |
backButtonClicked |
none |
settingsButtonClicked |
none |
writeAccessRequested |
bool granted flag |
contactRequested |
bool shared flag |
phoneRequested |
bool shared flag |
invoiceClosed |
status String |
popupClosed |
object { button_id: Option<String> } |
qrTextReceived |
scanned text String |
clipboardTextReceived |
clipboard text String |
The SDK currently covers the complete Telegram WebApp API 9.2 surface. If you spot a gap, please open an issue so it can be addressed quickly.