messages.requestWebView

Open a bot mini app, sending over user information after user confirmation.

After calling this method, until the user closes the webview, messages.prolongWebView must be called every 60 seconds.

 Method schema is available as of layer 143. Switch »

Parameters

Name Type Description
flags # Flags, see TL conditional fields
from_bot_menu flags.4?true Whether the webview was opened by clicking on the bot's menu button ».
silent flags.5?true Whether the inline message that will be sent by the bot on behalf of the user once the web app interaction is terminated should be sent silently (no notifications for the receivers).
compact flags.7?true If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the mode parameter of the attachment menu deep link is equal to compact.
peer InputPeer Dialog where the web app is being opened, and where the resulting message will be sent (see the docs for more info »).
bot InputUser Bot that owns the web app
url flags.1?string Web app URL
start_param flags.3?string If the web app was opened from the attachment menu using a attachment menu deep link, start_param should contain the data from the startattach parameter.
theme_params flags.2?DataJSON Theme parameters »
platform string Short name of the application; 0-64 English letters, digits, and underscores
reply_to flags.0?InputReplyTo If set, indicates that the inline message that will be sent by the bot on behalf of the user once the web app interaction is terminated should be sent in reply to the specified message or story.
send_as flags.13?InputPeer Open the web app as the specified peer, sending the resulting the message as the specified peer.

Result

WebViewResult

Possible errors

Code Type Description
400 BOT_INVALID This is not a valid bot.
400 BOT_WEBVIEW_DISABLED A webview cannot be opened in the specified conditions: emitted for example if from_bot_menu or url are set and peer is not the chat with the bot.
400 INPUT_USER_DEACTIVATED The specified user was deleted.
400 MSG_ID_INVALID Invalid message ID provided.
400 PEER_ID_INVALID The provided peer id is invalid.
403 PRIVACY_PREMIUM_REQUIRED You need a Telegram Premium subscription to send a message to this user.
400 SEND_AS_PEER_INVALID You can't send messages as the specified peer.
400 YOU_BLOCKED_USER You blocked this user.

Related pages

Bot menu button

Bots can choose the behavior of the menu button shown next to the text input field.

messages.sendWebViewResultMessage

Terminate webview interaction started with messages.requestWebView, sending the specified message to the chat on behalf of the user.

Deep links

Telegram clients must handle special tg:// and t.me deep links encountered in messages, link entities and in other apps by registering OS handlers.

Mini Apps on Telegram

Bots can offer users interactive HTML5 web apps to completely replace any website.

Telegram Mini Apps

messages.prolongWebView

Indicate to the server (from the user side) that the user is still using a web app.

If the method returns a QUERY_ID_INVALID error, the webview must be closed.

Telegram Premium

Telegram Premium is an optional subscription service that unlocks additional exclusive client-side and API-side features, while helping support the development of the app.

Go up