telegram-crawler/data/web/blogfork.telegram.org/api/emoji-status.html
2024-09-23 18:02:35 +00:00

177 lines
15 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="">
<head>
<meta charset="utf-8">
<title>Emoji status</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="description" content="Telegram allows users to set an emoticon or a custom emoji as status, to show next to their name in chats and profiles.">
<meta property="og:title" content="Emoji status">
<meta property="og:image" content="">
<meta property="og:description" content="Telegram allows users to set an emoticon or a custom emoji as status, to show next to their name in chats and profiles.">
<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="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="/api/emoji-status" >Emoji status</a></li></ul></div>
<h1 id="dev_page_title">Emoji status</h1>
<div id="dev_page_content"><!-- scroll_nav -->
<p>Telegram allows users, channels and supergroups to set an emoticon or a <a href="/api/custom-emoji">custom emoji</a> as status, to show next to their name in chats and profiles.</p>
<h3><a class="anchor" href="#setting-an-emoji-status" id="setting-an-emoji-status" name="setting-an-emoji-status"><i class="anchor-icon"></i></a>Setting an emoji status</h3>
<pre><code><a href='/constructor/emojiStatusEmpty'>emojiStatusEmpty</a>#2de11aae = <a href='/type/EmojiStatus'>EmojiStatus</a>;
<a href='/constructor/emojiStatus'>emojiStatus</a>#929b619d document_id:<a href='/type/long'>long</a> = <a href='/type/EmojiStatus'>EmojiStatus</a>;
<a href='/constructor/emojiStatusUntil'>emojiStatusUntil</a>#fa30a8c7 document_id:<a href='/type/long'>long</a> until:<a href='/type/int'>int</a> = <a href='/type/EmojiStatus'>EmojiStatus</a>;
<a href='/constructor/user'>user</a>#83314fca flags:<a href='/type/%23'>#</a> self:flags.10?<a href='/constructor/true'>true</a> contact:flags.11?<a href='/constructor/true'>true</a> mutual_contact:flags.12?<a href='/constructor/true'>true</a> deleted:flags.13?<a href='/constructor/true'>true</a> bot:flags.14?<a href='/constructor/true'>true</a> bot_chat_history:flags.15?<a href='/constructor/true'>true</a> bot_nochats:flags.16?<a href='/constructor/true'>true</a> verified:flags.17?<a href='/constructor/true'>true</a> restricted:flags.18?<a href='/constructor/true'>true</a> min:flags.20?<a href='/constructor/true'>true</a> bot_inline_geo:flags.21?<a href='/constructor/true'>true</a> support:flags.23?<a href='/constructor/true'>true</a> scam:flags.24?<a href='/constructor/true'>true</a> apply_min_photo:flags.25?<a href='/constructor/true'>true</a> fake:flags.26?<a href='/constructor/true'>true</a> bot_attach_menu:flags.27?<a href='/constructor/true'>true</a> premium:flags.28?<a href='/constructor/true'>true</a> attach_menu_enabled:flags.29?<a href='/constructor/true'>true</a> flags2:<a href='/type/%23'>#</a> bot_can_edit:flags2.1?<a href='/constructor/true'>true</a> close_friend:flags2.2?<a href='/constructor/true'>true</a> stories_hidden:flags2.3?<a href='/constructor/true'>true</a> stories_unavailable:flags2.4?<a href='/constructor/true'>true</a> contact_require_premium:flags2.10?<a href='/constructor/true'>true</a> bot_business:flags2.11?<a href='/constructor/true'>true</a> bot_has_main_app:flags2.13?<a href='/constructor/true'>true</a> 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>&lt;<a href='/type/RestrictionReason'>RestrictionReason</a>&gt; 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>&lt;<a href='/type/Username'>Username</a>&gt; 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'>User</a>;
<a href='/constructor/updateUserEmojiStatus'>updateUserEmojiStatus</a>#28373599 user_id:<a href='/type/long'>long</a> emoji_status:<a href='/type/EmojiStatus'>EmojiStatus</a> = <a href='/type/Update'>Update</a>;
<a href='/constructor/updateRecentEmojiStatuses'>updateRecentEmojiStatuses</a>#30f443db = <a href='/type/Update'>Update</a>;
<a href='/constructor/account.emojiStatusesNotModified'>account.emojiStatusesNotModified</a>#d08ce645 = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
<a href='/constructor/account.emojiStatuses'>account.emojiStatuses</a>#90c467d1 hash:<a href='/type/long'>long</a> statuses:<a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/EmojiStatus'>EmojiStatus</a>&gt; = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
---functions---
<a href='/method/account.updateEmojiStatus'>account.updateEmojiStatus</a>#fbd3de6b emoji_status:<a href='/type/EmojiStatus'>EmojiStatus</a> = <a href='/type/Bool'>Bool</a>;
<a href='/method/account.getRecentEmojiStatuses'>account.getRecentEmojiStatuses</a>#0f578105 hash:<a href='/type/long'>long</a> = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
<a href='/method/account.clearRecentEmojiStatuses'>account.clearRecentEmojiStatuses</a>#18201aae = <a href='/type/Bool'>Bool</a>;</code></pre>
<p>Use <a href="/method/account.updateEmojiStatus">account.updateEmojiStatus</a> to change the status emoji of your profile. </p>
<ul>
<li>Pass <a href="/constructor/emojiStatus">emojiStatus</a> to set a <a href="/api/custom-emoji">custom emoji</a>.</li>
<li>Pass <a href="/constructor/emojiStatusUntil">emojiStatusUntil</a> to set a <a href="/api/custom-emoji">custom emoji</a>, for a limited period of time.</li>
<li>Pass <a href="/constructor/emojiStatusEmpty">emojiStatusEmpty</a> to set the default Premium badge.</li>
</ul>
<p>The newly set <a href="/type/EmojiStatus">EmojiStatus</a> constructor will be contained in the <code>emoji_status</code> field of the <a href="/constructor/user">user</a> constructor, and other users will receive an <a href="/constructor/updateUserEmojiStatus">updateUserEmojiStatus</a>. </p>
<p>Other logged-in clients will also receive an <a href="/constructor/updateRecentEmojiStatuses">updateRecentEmojiStatuses</a> update, indicating that the recent status emoji list has changed. </p>
<p>Recently used emoji statuses can be fetched using <a href="/method/account.getRecentEmojiStatuses">account.getRecentEmojiStatuses</a>, and the list can be cleared using <a href="/method/account.clearRecentEmojiStatuses">account.clearRecentEmojiStatuses</a>. </p>
<p>Note that the custom emoji selection UI should offer a list of categories to quickly filter results by a (list of) emojis, or by some other criteria, see <a href="/api/emoji-categories">here »</a> for more info. </p>
<h4><a class="anchor" href="#setting-an-emoji-status-in-channels-and-supergroups" id="setting-an-emoji-status-in-channels-and-supergroups" name="setting-an-emoji-status-in-channels-and-supergroups"><i class="anchor-icon"></i></a>Setting an emoji status in channels and supergroups</h4>
<pre><code><a href='/constructor/emojiList'>emojiList</a>#7a1e11d1 hash:<a href='/type/long'>long</a> document_id:<a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/long'>long</a>&gt; = <a href='/type/EmojiList'>EmojiList</a>;
---functions---
<a href='/method/account.getChannelRestrictedStatusEmojis'>account.getChannelRestrictedStatusEmojis</a>#35a9e0d5 hash:<a href='/type/long'>long</a> = <a href='/type/EmojiList'>EmojiList</a>;</code></pre>
<p><strong>Only</strong> channel/supergroup custom emoji <a href="/constructor/stickerSet">stickersets</a>, i.e. <a href="/constructor/stickerSet">stickersets</a> with the <code>channel_emoji_status</code> flag set, can be used in channel/supergroup custom emoji statuses. </p>
<p>Note, however, that some specific <a href="/api/custom-emoji">custom emojis</a> from channel/supergroup custom emoji stickersets cannot be used as channel/supergroup statuses: use <a href="/method/account.getChannelRestrictedStatusEmojis">account.getChannelRestrictedStatusEmojis</a> to fetch the full list of IDs of custom emojis that cannot be used in channel/supergroup statuses.</p>
<p>Channels/supergroups gain the ability to change their status emoji only after reaching at least the <a href="/api/boost">boost level</a> specified in the <a href="/api/config#channel-emoji-status-level-min"><code>channel_emoji_status_level_min</code> »</a>/<a href="/api/config#group-emoji-status-level-min"><code>group_emoji_status_level_min</code> »</a> config parameters. </p>
<h3><a class="anchor" href="#featured-emoji-status-stickersets" id="featured-emoji-status-stickersets" name="featured-emoji-status-stickersets"><i class="anchor-icon"></i></a>Featured emoji status stickersets</h3>
<pre><code><a href='/constructor/emojiStatus'>emojiStatus</a>#929b619d document_id:<a href='/type/long'>long</a> = <a href='/type/EmojiStatus'>EmojiStatus</a>;
<a href='/constructor/account.emojiStatusesNotModified'>account.emojiStatusesNotModified</a>#d08ce645 = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
<a href='/constructor/account.emojiStatuses'>account.emojiStatuses</a>#90c467d1 hash:<a href='/type/long'>long</a> statuses:<a href='/type/Vector%20t'>Vector</a>&lt;<a href='/type/EmojiStatus'>EmojiStatus</a>&gt; = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
<a href='/constructor/inputStickerSetEmojiDefaultStatuses'>inputStickerSetEmojiDefaultStatuses</a>#29d0f5ee = <a href='/type/InputStickerSet'>InputStickerSet</a>;
<a href='/constructor/inputStickerSetEmojiChannelDefaultStatuses'>inputStickerSetEmojiChannelDefaultStatuses</a>#49748553 = <a href='/type/InputStickerSet'>InputStickerSet</a>;
---functions---
<a href='/method/account.getDefaultEmojiStatuses'>account.getDefaultEmojiStatuses</a>#d6753386 hash:<a href='/type/long'>long</a> = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;
<a href='/method/account.getChannelDefaultEmojiStatuses'>account.getChannelDefaultEmojiStatuses</a>#7727a7d5 hash:<a href='/type/long'>long</a> = <a href='/type/account.EmojiStatuses'>account.EmojiStatuses</a>;</code></pre>
<p>A set of standard statuses for users/(channels/supergroups) can be fetched by passing <a href="/constructor/inputStickerSetEmojiDefaultStatuses">inputStickerSetEmojiDefaultStatuses</a>/<a href="/constructor/inputStickerSetEmojiChannelDefaultStatuses">inputStickerSetEmojiChannelDefaultStatuses</a> to <a href="/method/messages.getStickerSet">messages.getStickerSet</a>, as specified in the <a href="/api/stickers">stickerset documentation »</a>. </p>
<p><a href="/method/account.getDefaultEmojiStatuses">account.getDefaultEmojiStatuses</a> can also be used to get a list of featured emoji statuses, from multiple featured custom emoji stickersets.<br>
<a href="/method/account.getChannelDefaultEmojiStatuses">account.getChannelDefaultEmojiStatuses</a> is the equivalent method for channel/supergroup emoji statuses.</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 src="/js/jquery.min.js?1"></script>
<script src="/js/bootstrap.min.js?1"></script>
<script>window.initDevPageNav&&initDevPageNav();
backToTopInit("Go up");
removePreloadInit();
</script>
</body>
</html>