<!DOCTYPE html> <html class=""> <head> <meta charset="utf-8"> <title>messages.requestWebView</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta property="description" content="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."> <meta property="og:title" content="messages.requestWebView"> <meta property="og:image" content=""> <meta property="og:description" content="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."> <link rel="icon" type="image/svg+xml" href="/img/website_icon.svg?4"> <link rel="apple-touch-icon" sizes="180x180" href="/img/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/img/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/img/favicon-16x16.png"> <link rel="alternate icon" href="/img/favicon.ico" type="image/x-icon" /> <link href="/css/bootstrap.min.css?3" rel="stylesheet"> <link href="/css/telegram.css?240" rel="stylesheet" media="screen"> <style> </style> </head> <body class="preload"> <div class="dev_page_wrap"> <div class="dev_page_head navbar navbar-static-top navbar-tg"> <div class="navbar-inner"> <div class="container clearfix"> <ul class="nav navbar-nav navbar-right hidden-xs"><li class="navbar-twitter"><a href="https://twitter.com/telegram" target="_blank" data-track="Follow/Twitter" onclick="trackDlClick(this, event)"><i class="icon icon-twitter"></i><span> Twitter</span></a></li></ul> <ul class="nav navbar-nav"> <li><a href="//telegram.org/">Home</a></li> <li class="hidden-xs"><a href="//telegram.org/faq">FAQ</a></li> <li class="hidden-xs"><a href="//telegram.org/apps">Apps</a></li> <li class="active"><a href="/api">API</a></li> <li class=""><a href="/mtproto">Protocol</a></li> <li class=""><a href="/schema">Schema</a></li> </ul> </div> </div> </div> <div class="container clearfix"> <div class="dev_page"> <div id="dev_page_content_wrap" class=" "> <div class="dev_page_bread_crumbs"><ul class="breadcrumb clearfix"><li><a href="/api" >API</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/methods" >All Methods</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/method/messages.requestWebView" >messages.requestWebView</a></li></ul></div> <h1 id="dev_page_title">messages.requestWebView</h1> <div id="dev_page_content"><p>Open a <a href="/bots/webapps">bot mini app</a>, sending over user information after user confirmation.</p> <p>After calling this method, until the user closes the webview, <a href="/method/messages.prolongWebView">messages.prolongWebView</a> must be called every 60 seconds.</p> <p><div class="clearfix"> <ul class="dev_layer_select slightly-pull-right nav nav-pills"> <li class="dropdown"> <a class="dropdown-toggle" onclick="return dropdownClick(this, event)" href="#">Layer 170 <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="?layer=1">1 – Base layer</a></li><li><a href="?layer=2">2 – New userpic notifications</a></li><li><a href="?layer=3">3 – Send message can trigger link change</a></li><li><a href="?layer=4">4 – Check-in chats</a></li><li><a href="?layer=5">5 – Localized SMS, localized notifications</a></li><li><a href="?layer=6">6 – Foursquare integration</a></li><li><a href="?layer=7">7 – Added wallPaperSolid</a></li><li><a href="?layer=8">8 – Added end-to-end encryption</a></li><li><a href="?layer=9">9 – Improved big files upload perfomance</a></li><li><a href="?layer=10">10 – Improved chat participants updates</a></li><li><a href="?layer=11">11 – Improved secret chats</a></li><li><a href="?layer=12">12 – New dynamic support</a></li><li><a href="?layer=13">13 – Audio, video MIME; contacts import retry; new secret actions</a></li><li><a href="?layer=14">14 – Notify settings sync, blacklist sync</a></li><li><a href="?layer=15">15 – Modified getHistory offset behaviour</a></li><li><a href="?layer=16">16 – Split sendCode into 2 parts</a></li><li><a href="?layer=17">17 – Added custom typing, introduced message flags</a></li><li><a href="?layer=18">18 – Added usernames</a></li><li><a href="?layer=23">23 – Stickers for secret chats</a></li><li><a href="?layer=105">105 – Scheduled messages, Cloud themes</a></li><li><a href="?layer=108">108 – Login with QR code</a></li><li><a href="?layer=109">109 – Polls v2</a></li><li><a href="?layer=110">110 – People Nearby 2.0, Bank card entity</a></li><li><a href="?layer=111">111 – Folders, Broadcast Stats</a></li><li><a href="?layer=112">112 – Old featured stickers, generic dice, poll timer, poll solution</a></li><li><a href="?layer=113">113 – PSA</a></li><li><a href="?layer=114">114 – Video thumbs for GIFs</a></li><li><a href="?layer=115">115 – Peek Channel Invite</a></li><li><a href="?layer=116">116 – Group Stats, Profile Videos</a></li><li><a href="?layer=117">117 – WebRTC Phone Calls</a></li><li><a href="?layer=118">118 – Callback with 2FA, Countries list</a></li><li><a href="?layer=119">119 – Comments in channels, Threads, Anonymous Admins</a></li><li><a href="?layer=120">120 – Multipins, Message Stats, GeoLive v2</a></li><li><a href="?layer=121">121 – SVG-based Outlines for Stickers</a></li><li><a href="?layer=122">122 – Voice Chats</a></li><li><a href="?layer=123">123 – Voice Chat improvements</a></li><li><a href="?layer=124">124 – Expiring Invite links</a></li><li><a href="?layer=125">125 – Voice Chats in Broadcasts</a></li><li><a href="?layer=126">126 – Ban channels in channels</a></li><li><a href="?layer=127">127 – Payments in channels</a></li><li><a href="?layer=128">128 – Microthumbs for User/Chat profile photos</a></li><li><a href="?layer=129">129 – Video Chats</a></li><li><a href="?layer=130">130 – Custom placeholder for bot reply keyboards</a></li><li><a href="?layer=131">131 – Reset 2FA Password after a week</a></li><li><a href="?layer=132">132 – Chat themes</a></li><li><a href="?layer=133">133 – 64-bit IDs for User/Chat</a></li><li><a href="?layer=134">134 – Chat Requests, Shared Media Calendar</a></li><li><a href="?layer=135">135 – Send Message As a Channel</a></li><li><a href="?layer=136">136 – Reactions</a></li><li><a href="?layer=137">137 – Translations</a></li><li><a href="?layer=138">138 – GIF Sticker Packs</a></li><li><a href="?layer=139">139 – RTMP streaming</a></li><li><a href="?layer=140">140 – WebApps, Cloud Ringtones</a></li><li><a href="?layer=142">142 – TCP Reflectors</a></li><li><a href="?layer=143">143 – Premium Subscription, Cloud Invoices</a></li><li><a href="?layer=144">144 – Premium as a Gift, Custom Emoji</a></li><li><a href="?layer=145">145 – Custom Reactions, Statuses, Sign In with email</a></li><li><a href="?layer=147">147 – Keywords for stickers and emojis</a></li><li><a href="?layer=148">148 – Forums, collectible usernames</a></li><li><a href="?layer=150">150 – Pinned forum topics, general topic</a></li><li><a href="?layer=151">151 – Media spoilers, suggested profile photos</a></li><li><a href="?layer=152">152 – Real-time translations, Firebase SMS authentication</a></li><li><a href="?layer=153">153 – Modify created stickersets</a></li><li><a href="?layer=155">155 – Dates for reactions</a></li><li><a href="?layer=158">158 – Shared folders, per-chat wallpapers</a></li><li><a href="?layer=159">159 – Anonymous votes</a></li><li><a href="?layer=160">160 – Stories</a></li><li><a href="?layer=164">164 – Stories in Channels</a></li><li><a href="?layer=166">166 – Giveaways in channels</a></li><li><a href="?layer=167">167 – Similar channels</a></li><li><a href="?layer=168">168 – Channel colors</a></li><li><a href="?layer=169">169 – Multiselection of chats for bots</a></li><li><a href="?layer=170"><strong>170 – Saved Messages 2.0</strong></a></li> <li class="divider"></li> <li><a href="/api/layers">More...</a></li> </ul> </li> </ul> </div> <pre class="page_scheme"><code><a href="/constructor/webViewResultUrl" >webViewResultUrl</a>#c14557c query_id:<a href="/type/long" >long</a> url:<a href="/type/string" >string</a> = <a href="/type/WebViewResult" >WebViewResult</a>; ---functions--- <a href="/method/messages.requestWebView" class="current_page_link" >messages.requestWebView</a>#269dc2c1 flags:<a href="/type/%23" >#</a> from_bot_menu:flags.4?true silent:flags.5?true peer:<a href="/type/InputPeer" >InputPeer</a> bot:<a href="/type/InputUser" >InputUser</a> url:flags.1?<a href="/type/string" >string</a> start_param:flags.3?<a href="/type/string" >string</a> theme_params:flags.2?<a href="/type/DataJSON" >DataJSON</a> platform:<a href="/type/string" >string</a> reply_to:flags.0?<a href="/type/InputReplyTo" >InputReplyTo</a> send_as:flags.13?<a href="/type/InputPeer" >InputPeer</a> = <a href="/type/WebViewResult" >WebViewResult</a>;</code></pre></p> <h3><a class="anchor" href="#parameters" id="parameters" name="parameters"><i class="anchor-icon"></i></a>Parameters</h3> <table class="table"> <thead> <tr> <th>Name</th> <th style="text-align: center;">Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><strong>flags</strong></td> <td style="text-align: center;"><a href="/type/%23">#</a></td> <td>Flags, see <a href="/mtproto/TL-combinators#conditional-fields">TL conditional fields</a></td> </tr> <tr> <td><strong>from_bot_menu</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.4?<a href="/constructor/true">true</a></td> <td>Whether the webview was opened by clicking on the bot's <a href="/api/bots/menu">menu button »</a>.</td> </tr> <tr> <td><strong>silent</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.5?<a href="/constructor/true">true</a></td> <td>Whether the inline message that will be sent by the bot on behalf of the user once the web app interaction is <a href="/method/messages.sendWebViewResultMessage">terminated</a> should be sent silently (no notifications for the receivers).</td> </tr> <tr> <td><strong>peer</strong></td> <td style="text-align: center;"><a href="/type/InputPeer">InputPeer</a></td> <td>Dialog where the web app is being opened, and where the resulting message will be sent (see the <a href="/api/bots/webapps">docs for more info »</a>).</td> </tr> <tr> <td><strong>bot</strong></td> <td style="text-align: center;"><a href="/type/InputUser">InputUser</a></td> <td>Bot that owns the <a href="/api/bots/webapps">web app</a></td> </tr> <tr> <td><strong>url</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.1?<a href="/type/string">string</a></td> <td><a href="/api/bots/webapps">Web app URL</a></td> </tr> <tr> <td><strong>start_param</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.3?<a href="/type/string">string</a></td> <td>If the web app was opened from the attachment menu using a <a href="/api/links#bot-attachment-or-side-menu-links">attachment menu deep link</a>, <code>start_param</code> should contain the <code>data</code> from the <code>startattach</code> parameter.</td> </tr> <tr> <td><strong>theme_params</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.2?<a href="/type/DataJSON">DataJSON</a></td> <td><a href="/api/bots/webapps#theme-parameters">Theme parameters »</a></td> </tr> <tr> <td><strong>platform</strong></td> <td style="text-align: center;"><a href="/type/string">string</a></td> <td>Short name of the application; 0-64 English letters, digits, and underscores</td> </tr> <tr> <td><strong>reply_to</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.0?<a href="/type/InputReplyTo">InputReplyTo</a></td> <td>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 <a href="/method/messages.sendWebViewResultMessage">terminated</a> should be sent in reply to the specified message or story.</td> </tr> <tr> <td><strong>send_as</strong></td> <td style="text-align: center;"><a href="/mtproto/TL-combinators#conditional-fields">flags</a>.13?<a href="/type/InputPeer">InputPeer</a></td> <td>Open the web app as the specified peer, sending the resulting the message as the specified peer.</td> </tr> </tbody> </table> <h3><a class="anchor" href="#result" id="result" name="result"><i class="anchor-icon"></i></a>Result</h3> <p><a href="/type/WebViewResult">WebViewResult</a></p> <h3><a class="anchor" href="#possible-errors" id="possible-errors" name="possible-errors"><i class="anchor-icon"></i></a>Possible errors</h3> <table class="table"> <thead> <tr> <th>Code</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>400</td> <td>BOT_INVALID</td> <td>This is not a valid bot.</td> </tr> <tr> <td>400</td> <td>BOT_WEBVIEW_DISABLED</td> <td>A webview cannot be opened in the specified conditions: emitted for example if <code>from_bot_menu</code> or <code>url</code> are set and <code>peer</code> is not the chat with the bot.</td> </tr> <tr> <td>400</td> <td>INPUT_USER_DEACTIVATED</td> <td>The specified user was deleted.</td> </tr> <tr> <td>400</td> <td>PEER_ID_INVALID</td> <td>The provided peer id is invalid.</td> </tr> <tr> <td>400</td> <td>YOU_BLOCKED_USER</td> <td>You blocked this user.</td> </tr> </tbody> </table> <h3><a class="anchor" href="#related-pages" id="related-pages" name="related-pages"><i class="anchor-icon"></i></a>Related pages</h3> <h4><a class="anchor" href="#bot-menu-button" id="bot-menu-button" name="bot-menu-button"><i class="anchor-icon"></i></a><a href="/api/bots/menu">Bot menu button</a></h4> <p>Bots can choose the behavior of the menu button shown next to the text input field.</p> <h4><a class="anchor" href="#messagessendwebviewresultmessage" id="messagessendwebviewresultmessage" name="messagessendwebviewresultmessage"><i class="anchor-icon"></i></a><a href="/method/messages.sendWebViewResultMessage">messages.sendWebViewResultMessage</a></h4> <p>Terminate webview interaction started with <a href="/method/messages.requestWebView">messages.requestWebView</a>, sending the specified message to the chat on behalf of the user.</p> <h4><a class="anchor" href="#mini-apps-on-telegram" id="mini-apps-on-telegram" name="mini-apps-on-telegram"><i class="anchor-icon"></i></a><a href="/api/bots/webapps">Mini Apps on Telegram</a></h4> <p>Bots can offer users interactive HTML5 web apps to completely replace any website.</p> <h4><a class="anchor" href="#deep-links" id="deep-links" name="deep-links"><i class="anchor-icon"></i></a><a href="/api/links">Deep links</a></h4> <p>Telegram clients must handle special tg:// and t.me deep links encountered in messages, link entities and in other apps by registering OS handlers.</p> <h4><a class="anchor" href="#telegram-mini-apps" id="telegram-mini-apps" name="telegram-mini-apps"><i class="anchor-icon"></i></a><a href="/bots/webapps">Telegram Mini Apps</a></h4> <h4><a class="anchor" href="#messagesprolongwebview" id="messagesprolongwebview" name="messagesprolongwebview"><i class="anchor-icon"></i></a><a href="/method/messages.prolongWebView">messages.prolongWebView</a></h4> <p>Indicate to the server (from the user side) that the user is still using a web app.</p> <p>If the method returns a <code>QUERY_ID_INVALID</code> error, the webview must be closed.</p></div> </div> </div> </div> <div class="footer_wrap"> <div class="footer_columns_wrap footer_desktop"> <div class="footer_column footer_column_telegram"> <h5>Telegram</h5> <div class="footer_telegram_description"></div> Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed. </div> <div class="footer_column"> <h5><a href="//telegram.org/faq">About</a></h5> <ul> <li><a href="//telegram.org/faq">FAQ</a></li> <li><a href="//telegram.org/privacy">Privacy</a></li> <li><a href="//telegram.org/press">Press</a></li> </ul> </div> <div class="footer_column"> <h5><a href="//telegram.org/apps#mobile-apps">Mobile Apps</a></h5> <ul> <li><a href="//telegram.org/dl/ios">iPhone/iPad</a></li> <li><a href="//telegram.org/android">Android</a></li> <li><a href="//telegram.org/dl/web">Mobile Web</a></li> </ul> </div> <div class="footer_column"> <h5><a href="//telegram.org/apps#desktop-apps">Desktop Apps</a></h5> <ul> <li><a href="//desktop.telegram.org/">PC/Mac/Linux</a></li> <li><a href="//macos.telegram.org/">macOS</a></li> <li><a href="//telegram.org/dl/web">Web-browser</a></li> </ul> </div> <div class="footer_column footer_column_platform"> <h5><a href="/">Platform</a></h5> <ul> <li><a href="/api">API</a></li> <li><a href="//translations.telegram.org/">Translations</a></li> <li><a href="//instantview.telegram.org/">Instant View</a></li> </ul> </div> </div> <div class="footer_columns_wrap footer_mobile"> <div class="footer_column"> <h5><a href="//telegram.org/faq">About</a></h5> </div> <div class="footer_column"> <h5><a href="//telegram.org/blog">Blog</a></h5> </div> <div class="footer_column"> <h5><a href="//telegram.org/apps">Apps</a></h5> </div> <div class="footer_column"> <h5><a href="/">Platform</a></h5> </div> <div class="footer_column"> <h5><a href="//telegram.org/press">Press</a></h5> </div> </div> </div> </div> <script src="/js/main.js?47"></script> <script>backToTopInit("Go up"); removePreloadInit(); </script> </body> </html>