CINXE.COM

<!DOCTYPE html> <html class=""> <head> <meta charset="utf-8"> <title>Chat</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta property="description" content="Object defines a group."> <meta property="og:title" content="Chat"> <meta property="og:image" content=""> <meta property="og:description" content="Object defines a group."> <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/Chat" >Chat</a></li></ul></div> <h1 id="dev_page_title">Chat</h1> <div id="dev_page_content"><p>Object defines a group.</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/chatEmpty" >chatEmpty</a>#29562865 id:<a href="/type/long" >long</a> = <a href="/type/Chat" class="current_page_link" >Chat</a>; <a href="/constructor/chat" >chat</a>#41cbf256 flags:<a href="/type/%23" >#</a> creator:flags.0?true left:flags.2?true deactivated:flags.5?true call_active:flags.23?true call_not_empty:flags.24?true noforwards:flags.25?true id:<a href="/type/long" >long</a> title:<a href="/type/string" >string</a> photo:<a href="/type/ChatPhoto" >ChatPhoto</a> participants_count:<a href="/type/int" >int</a> date:<a href="/type/int" >int</a> version:<a href="/type/int" >int</a> migrated_to:flags.6?<a href="/type/InputChannel" >InputChannel</a> admin_rights:flags.14?<a href="/type/ChatAdminRights" >ChatAdminRights</a> default_banned_rights:flags.18?<a href="/type/ChatBannedRights" >ChatBannedRights</a> = <a href="/type/Chat" class="current_page_link" >Chat</a>; <a href="/constructor/chatForbidden" >chatForbidden</a>#6592a1a7 id:<a href="/type/long" >long</a> title:<a href="/type/string" >string</a> = <a href="/type/Chat" class="current_page_link" >Chat</a>; <a href="/constructor/channel" >channel</a>#aadfc8f flags:<a href="/type/%23" >#</a> creator:flags.0?true left:flags.2?true broadcast:flags.5?true verified:flags.7?true megagroup:flags.8?true restricted:flags.9?true signatures:flags.11?true min:flags.12?true scam:flags.19?true has_link:flags.20?true has_geo:flags.21?true slowmode_enabled:flags.22?true call_active:flags.23?true call_not_empty:flags.24?true fake:flags.25?true gigagroup:flags.26?true noforwards:flags.27?true join_to_send:flags.28?true join_request:flags.29?true forum:flags.30?true flags2:<a href="/type/%23" >#</a> stories_hidden:flags2.1?true stories_hidden_min:flags2.2?true stories_unavailable:flags2.3?true id:<a href="/type/long" >long</a> access_hash:flags.13?<a href="/type/long" >long</a> title:<a href="/type/string" >string</a> username:flags.6?<a href="/type/string" >string</a> photo:<a href="/type/ChatPhoto" >ChatPhoto</a> date:<a href="/type/int" >int</a> restriction_reason:flags.9?<a href="/type/Vector%20t" >Vector</a><<a href="/type/RestrictionReason" >RestrictionReason</a>> admin_rights:flags.14?<a href="/type/ChatAdminRights" >ChatAdminRights</a> banned_rights:flags.15?<a href="/type/ChatBannedRights" >ChatBannedRights</a> default_banned_rights:flags.18?<a href="/type/ChatBannedRights" >ChatBannedRights</a> participants_count:flags.17?<a href="/type/int" >int</a> usernames:flags2.0?<a href="/type/Vector%20t" >Vector</a><<a href="/type/Username" >Username</a>> stories_max_id:flags2.4?<a href="/type/int" >int</a> color:flags2.7?<a href="/type/PeerColor" >PeerColor</a> profile_color:flags2.8?<a href="/type/PeerColor" >PeerColor</a> emoji_status:flags2.9?<a href="/type/EmojiStatus" >EmojiStatus</a> level:flags2.10?<a href="/type/int" >int</a> = <a href="/type/Chat" class="current_page_link" >Chat</a>; <a href="/constructor/channelForbidden" >channelForbidden</a>#17d493d5 flags:<a href="/type/%23" >#</a> broadcast:flags.5?true megagroup:flags.8?true id:<a href="/type/long" >long</a> access_hash:<a href="/type/long" >long</a> title:<a href="/type/string" >string</a> until_date:flags.16?<a href="/type/int" >int</a> = <a href="/type/Chat" class="current_page_link" >Chat</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/chatEmpty">chatEmpty</a></td> <td>Empty constructor, group doesn't exist</td> </tr> <tr> <td><a href="/constructor/chat">chat</a></td> <td>Info about a group.<br><br>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/a24af0992245f838f2b4b418a0a2d5fa9caa27b5/td/telegram/ChatManager.cpp#L5152">here 禄</a> for an implementation of the logic to use when updating the <a href="/api/peers">local user peer database</a>.</td> </tr> <tr> <td><a href="/constructor/chatForbidden">chatForbidden</a></td> <td>A group to which the user has no access. E.g., because the user was kicked from the group.</td> </tr> <tr> <td><a href="/constructor/channel">channel</a></td> <td>Channel/supergroup info<br><br>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>The only exception to the above rule is when the <code>min</code> flag is set, in which case <strong>only</strong> the following fields must be applied over any locally stored version:<br><br>- <code>title</code><br>- <code>megagroup</code><br>- <code>color</code><br>- <code>photo</code><br>- <code>username</code><br>- <code>usernames</code><br>- <code>has_geo</code><br>- <code>noforwards</code><br>- <code>emoji_status</code><br>- <code>has_link</code><br>- <code>slow_mode_enabled</code><br>- <code>scam</code><br>- <code>fake</code><br>- <code>gigagroup</code><br>- <code>forum</code><br>- <code>level</code><br>- <code>restricted</code><br>- <code>restriction_reason</code><br>- <code>join_to_send</code><br>- <code>join_request</code><br>- <code>is_verified</code><br>- <code>default_banned_rights</code><br><br>See <a href="https://github.com/tdlib/td/blob/a24af0992245f838f2b4b418a0a2d5fa9caa27b5/td/telegram/ChatManager.cpp#L8329">here 禄</a> for an implementation of the logic to use when updating the <a href="/api/peers">local user peer database</a>.</td> </tr> <tr> <td><a href="/constructor/channelForbidden">channelForbidden</a></td> <td>Indicates a channel/supergroup we can't access because we were banned, or for some other reason.</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>