CINXE.COM

<!DOCTYPE html> <html class=""> <head> <meta charset="utf-8"> <title>User</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta property="description" content="Object defines a user."> <meta property="og:title" content="User"> <meta property="og:image" content=""> <meta property="og:description" content="Object defines a user."> <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?241" 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=""><a href="/api">API</a></li> <li class=""><a href="/mtproto">Protocol</a></li> <li class="active"><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="/schema" >TL-schema</a></li><i class="icon icon-breadcrumb-divider"></i><li><a href="/type/User" >User</a></li></ul></div> <h1 id="dev_page_title">User</h1> <div id="dev_page_content"><p>Object defines a user.</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 185 <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">170 – Saved Messages 2.0</a></li><li><a href="?layer=171">171 – Saved Messages 2.0</a></li><li><a href="?layer=174">174 – Group boosts</a></li><li><a href="?layer=176">176 – Business</a></li><li><a href="?layer=177">177 – Business Bots, Birthdays</a></li><li><a href="?layer=178">178 – Saved Personal channel, Reactions notifications</a></li><li><a href="?layer=179">179 – Channel revenue stats, phrases in SMS</a></li><li><a href="?layer=180">180 – Message Effects, Hashtags</a></li><li><a href="?layer=181">181 – Stars</a></li><li><a href="?layer=182">182 – Stars Revenue</a></li><li><a href="?layer=183">183 – Paid posts</a></li><li><a href="?layer=184">184 – Stars Refunds</a></li><li><a href="?layer=185"><strong>185 – MiniApp Store, Star Gifts</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/userEmpty" >userEmpty</a>#d3bc4b7a id:<a href="/type/long" >long</a> = <a href="/type/User" class="current_page_link" >User</a>; <a href="/constructor/user" >user</a>#83314fca flags:<a href="/type/%23" >#</a> self:flags.10?true contact:flags.11?true mutual_contact:flags.12?true deleted:flags.13?true bot:flags.14?true bot_chat_history:flags.15?true bot_nochats:flags.16?true verified:flags.17?true restricted:flags.18?true min:flags.20?true bot_inline_geo:flags.21?true support:flags.23?true scam:flags.24?true apply_min_photo:flags.25?true fake:flags.26?true bot_attach_menu:flags.27?true premium:flags.28?true attach_menu_enabled:flags.29?true flags2:<a href="/type/%23" >#</a> bot_can_edit:flags2.1?true close_friend:flags2.2?true stories_hidden:flags2.3?true stories_unavailable:flags2.4?true contact_require_premium:flags2.10?true bot_business:flags2.11?true bot_has_main_app:flags2.13?true id:<a href="/type/long" >long</a> access_hash:flags.0?<a href="/type/long" >long</a> first_name:flags.1?<a href="/type/string" >string</a> last_name:flags.2?<a href="/type/string" >string</a> username:flags.3?<a href="/type/string" >string</a> phone:flags.4?<a href="/type/string" >string</a> photo:flags.5?<a href="/type/UserProfilePhoto" >UserProfilePhoto</a> status:flags.6?<a href="/type/UserStatus" >UserStatus</a> bot_info_version:flags.14?<a href="/type/int" >int</a> restriction_reason:flags.18?<a href="/type/Vector%20t" >Vector</a><<a href="/type/RestrictionReason" >RestrictionReason</a>> bot_inline_placeholder:flags.19?<a href="/type/string" >string</a> lang_code:flags.22?<a href="/type/string" >string</a> emoji_status:flags.30?<a href="/type/EmojiStatus" >EmojiStatus</a> usernames:flags2.0?<a href="/type/Vector%20t" >Vector</a><<a href="/type/Username" >Username</a>> stories_max_id:flags2.5?<a href="/type/int" >int</a> color:flags2.8?<a href="/type/PeerColor" >PeerColor</a> profile_color:flags2.9?<a href="/type/PeerColor" >PeerColor</a> bot_active_users:flags2.12?<a href="/type/int" >int</a> = <a href="/type/User" class="current_page_link" >User</a>; ---functions--- <a href="/method/account.updateProfile" >account.updateProfile</a>#78515775 flags:<a href="/type/%23" >#</a> first_name:flags.0?<a href="/type/string" >string</a> last_name:flags.1?<a href="/type/string" >string</a> about:flags.2?<a href="/type/string" >string</a> = <a href="/type/User" class="current_page_link" >User</a>; <a href="/method/account.updateUsername" >account.updateUsername</a>#3e0bdd7c username:<a href="/type/string" >string</a> = <a href="/type/User" class="current_page_link" >User</a>; <a href="/method/account.changePhone" >account.changePhone</a>#70c32edb phone_number:<a href="/type/string" >string</a> phone_code_hash:<a href="/type/string" >string</a> phone_code:<a href="/type/string" >string</a> = <a href="/type/User" class="current_page_link" >User</a>; <a href="/method/contacts.importContactToken" >contacts.importContactToken</a>#13005788 token:<a href="/type/string" >string</a> = <a href="/type/User" class="current_page_link" >User</a>;</code></pre></p> <h3><a class="anchor" href="#constructors" id="constructors" name="constructors"><i class="anchor-icon"></i></a>Constructors</h3> <table class="table"> <thead> <tr> <th>Constructor</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><a href="/constructor/userEmpty">userEmpty</a></td> <td>Empty constructor, non-existent user.</td> </tr> <tr> <td><a href="/constructor/user">user</a></td> <td>Indicates info about a certain user.<br><br>Unless specified otherwise, when updating the <a href="/api/peers">local peer database</a>, all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor).<br><br>See <a href="https://github.com/tdlib/td/blob/cb164927417f22811c74cd8678ed4a5ab7cb80ba/td/telegram/UserManager.cpp#L2267">here 禄</a> for an implementation of the logic to use when updating the <a href="/api/peers">local user peer database</a>.</td> </tr> </tbody> </table> <h3><a class="anchor" href="#methods" id="methods" name="methods"><i class="anchor-icon"></i></a>Methods</h3> <table class="table"> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><a href="/method/account.updateProfile">account.updateProfile</a></td> <td>Updates user profile.</td> </tr> <tr> <td><a href="/method/account.updateUsername">account.updateUsername</a></td> <td>Changes username for the current user.</td> </tr> <tr> <td><a href="/method/account.changePhone">account.changePhone</a></td> <td>Change the phone number of the current account</td> </tr> <tr> <td><a href="/method/contacts.importContactToken">contacts.importContactToken</a></td> <td>Obtain user info from a <a href="/api/links#temporary-profile-links">temporary profile link</a>.</td> </tr> </tbody> </table></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>