telegram api method · layer 229 · #269dc2c1

messages.requestWebView

usable by users

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

definition

messages.requestWebView#269dc2c1 flags:# from_bot_menu:flags.4?true silent:flags.5?true compact:flags.7?true fullscreen:flags.8?true peer:InputPeer bot:InputUser url:flags.1?string start_param:flags.3?string theme_params:flags.2?DataJSON platform:string reply_to:flags.0?InputReplyTo send_as:flags.13?InputPeer = WebViewResult;

parameters

nametypedescription
flags#Flags, see TL conditional fields
from_bot_menuflags.4?trueWhether the webview was opened by clicking on the bot's menu button ».
silentflags.5?trueWhether 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).
compactflags.7?trueIf set, requests to open the mini app in compact mode (as opposed to normal or fullscreen mode). Must be set if the mode parameter of the attachment menu deep link is equal to compact.
fullscreenflags.8?trueIf set, requests to open the mini app in fullscreen mode (as opposed to normal or compact mode). Must be set if the mode parameter of the attachment menu deep link is equal to fullscreen.
peerInputPeerDialog where the web app is being opened, and where the resulting message will be sent (see the docs for more info »).
botInputUserBot that owns the web app
urlflags.1?stringWeb app URL
start_paramflags.3?stringIf 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_paramsflags.2?DataJSONTheme parameters »
platformstringShort name of the application; 0-64 English letters, digits, and underscores
reply_toflags.0?InputReplyToIf 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_asflags.13?InputPeerOpen the web app as the specified peer, sending the resulting the message as the specified peer.

returns

WebViewResult

errors (13)

codeerrordescription
400BOT_INVALIDThis is not a valid bot.
400BOT_WEBVIEW_DISABLEDA 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.
400BUSINESS_CONNECTION_NOT_ALLOWEDThis method was invoked over a business connection using invokeWithBusinessConnection, but either (1) we're a user, and users cannot invoke methods over a business connection; (2) we're a bot, but business mode was disabled in @botfather or (3); we're a bot, but this method cannot be invoked over a business connection.
400INPUT_USER_DEACTIVATEDThe specified user was deleted.
400MSG_ID_INVALIDInvalid message ID provided.
400PEER_ID_INVALIDThe provided peer id is invalid.
400SEND_AS_PEER_INVALIDYou can't send messages as the specified peer.
400THEME_PARAMS_INVALIDThe specified theme_params field is invalid.
400URL_INVALIDInvalid URL provided.
400YOU_BLOCKED_USERYou blocked this user.
401AUTH_KEY_UNREGISTEREDThe specified authorization key is not registered in the system (for example, a PFS temporary key has expired).
403CHAT_WRITE_FORBIDDENYou can't write in this chat.
403PRIVACY_PREMIUM_REQUIREDYou need a Telegram Premium subscription to send a message to this user.

history

present in layers 140–229 · constructor id changed 4×

idlayers
#0fa04dff140–142
#91b15831143–144
#fc87a53c145–147
#178b480b148–159
#269dc2c1160–229