Telegram Mini Apps

Description of SDK methods allowing to work with Telegram Mini Apps through interaction with Parallelix unified interface

What is Telegram Mini Apps (Web Apps)

Telegram mini apps are web-based applications that run directly within the Telegram messaging app. They offer a more immersive and interactive experience than standard web links or bots, and they can be used to create a wide range of experiences, from e-commerce and games to productivity tools and more.

You can learn more here.

---

Telegram Mini Apps Platform Module (ParallelixTelegram)

Module Name: "telegram"

Any of our modules inherits from ParallelixWrapper - a virtual class describing a unified SDK structure. Below we have described the peculiarities of working with the module, as well as the differences and description of API parameters for the current module.

PlatformSpecificParameters

These are parameters that are passed inside some module methods. When working with them, you need to create subobjects as described in the documentation on working with such parameters. Inside this subobject are the parameters described in the documentation of a particular platform.

Below we have described each method available for calling, its parameters with a reference to the official documentation and the name of the official method.

---

Platform Specific configuration

No specific configuration provided for this platform

API Reference

Most Telegram methods don't have Callback functions to check the state of the action, so an empty object will be sent as data in onSuccess.

All methods called by Invoker, described as (window.Telegram.WebApp) in official documentation.

Method	Official Method / Description
GetLaunchParams	initDataUnsafe field
HandleEvents	onEvent
GetClientInfo	Returns object with: platform version fields from invoker
ToggleFullscreen	requestFullscreen
AddToHomeScreen	addToHomeScreen
OpenPaymentForm	openInvoice
PublishStory	shareToStory
OpenLink	openLink
GetStorage	View in PWA class
SetStorage	View in PWA class
CloseApplication	close
ShowQRReader	showScanQrPopup
RequestUserPhone	requestContact
GetUserInfo	Calls GetLaunchParams and return object from initDataUnsafe.user
RequestLocation	LocationManager.getLocation
GoBack	Go back to previous page (window.history.back())

---

Call directly methods from Telegram SDK

To query methods directly, using the same syntax as in the official documentation, use the following approach:

// Parallelix Direct Calls
client.Platform.Invoker.[YOUR_METHOD]

// Equivalient of
window.Telegram.WebApp.[FIELD_OR_METHOD]