)",
+ "params": {
+ "caption": "Caption",
+ "text": "Quote contents"
+ }
+ },
+ "PageBlockChannel": {
+ "desc": "Reference to a telegram channel",
+ "params": {
+ "channel": "The channel/supergroup/chat"
+ }
+ },
+ "PageBlockCollage": {
+ "desc": "Collage of media",
+ "params": {
+ "caption": "Caption",
+ "items": "Media elements"
+ }
+ },
+ "PageBlockCover": {
+ "desc": "A page cover",
+ "params": {
+ "cover": "Cover"
+ }
+ },
+ "PageBlockDetails": {
+ "desc": "A collapsible details block",
+ "params": {
+ "blocks": "Block contents",
+ "flags": "Flags, see TL conditional fields",
+ "open": "Whether the block is open by default",
+ "title": "Always visible heading for the block"
+ }
+ },
+ "PageBlockDivider": {
+ "desc": "An empty block separating a page",
+ "params": {}
+ },
+ "PageBlockEmbed": {
+ "desc": "An embedded webpage",
+ "params": {
+ "allow_scrolling": "Whether scrolling should be allowed",
+ "caption": "Caption",
+ "flags": "Flags, see TL conditional fields",
+ "full_width": "Whether the block should be full width",
+ "h": "Block height, if known",
+ "html": "HTML-markup of the embedded page",
+ "poster_photo_id": "Poster photo, if available",
+ "url": "Web page URL, if available",
+ "w": "Block width, if known"
+ }
+ },
+ "PageBlockEmbedPost": {
+ "desc": "An embedded post",
+ "params": {
+ "author": "Author name",
+ "author_photo_id": "ID of the author's photo",
+ "blocks": "Post contents",
+ "caption": "Caption",
+ "date": "Creation date",
+ "url": "Web page URL",
+ "webpage_id": "ID of generated webpage preview"
+ }
+ },
+ "PageBlockFooter": {
+ "desc": "Page footer",
+ "params": {
+ "text": "Contents"
+ }
+ },
+ "PageBlockHeader": {
+ "desc": "Page header",
+ "params": {
+ "text": "Contents"
+ }
+ },
+ "PageBlockKicker": {
+ "desc": "Kicker",
+ "params": {
+ "text": "Contents"
+ }
+ },
+ "PageBlockList": {
+ "desc": "Unordered list of IV blocks",
+ "params": {
+ "items": "List of blocks in an IV page"
+ }
+ },
+ "PageBlockMap": {
+ "desc": "A map",
+ "params": {
+ "caption": "Caption",
+ "geo": "Location of the map center",
+ "h": "Map height in pixels before applying scale; 16-1024",
+ "w": "Map width in pixels before applying scale; 16-102",
+ "zoom": "Map zoom level; 13-20"
+ }
+ },
+ "PageBlockOrderedList": {
+ "desc": "Ordered list of IV blocks",
+ "params": {
+ "items": "List items"
+ }
+ },
+ "PageBlockParagraph": {
+ "desc": "A paragraph",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "PageBlockPhoto": {
+ "desc": "A photo",
+ "params": {
+ "caption": "Caption",
+ "flags": "Flags, see TL conditional fields",
+ "photo_id": "Photo ID",
+ "url": "HTTP URL of page the photo leads to when clicked",
+ "webpage_id": "ID of preview of the page the photo leads to when clicked"
+ }
+ },
+ "PageBlockPreformatted": {
+ "desc": "Preformatted ( text)",
+ "params": {
+ "language": "Programming language of preformatted text",
+ "text": "Text"
+ }
+ },
+ "PageBlockPullquote": {
+ "desc": "Pullquote",
+ "params": {
+ "caption": "Caption",
+ "text": "Text"
+ }
+ },
+ "PageBlockRelatedArticles": {
+ "desc": "Related articles",
+ "params": {
+ "articles": "Related articles",
+ "title": "Title"
+ }
+ },
+ "PageBlockSlideshow": {
+ "desc": "Slideshow",
+ "params": {
+ "caption": "Caption",
+ "items": "Slideshow items"
+ }
+ },
+ "PageBlockSubheader": {
+ "desc": "Subheader",
+ "params": {
+ "text": "Subheader"
+ }
+ },
+ "PageBlockSubtitle": {
+ "desc": "Subtitle",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "PageBlockTable": {
+ "desc": "Table",
+ "params": {
+ "bordered": "Does the table have a visible border?",
+ "flags": "Flags, see TL conditional fields",
+ "rows": "Table rows",
+ "striped": "Is the table striped?",
+ "title": "Title"
+ }
+ },
+ "PageBlockTitle": {
+ "desc": "Title",
+ "params": {
+ "text": "Title"
+ }
+ },
+ "PageBlockUnsupported": {
+ "desc": "Unsupported IV element",
+ "params": {}
+ },
+ "PageBlockVideo": {
+ "desc": "Video",
+ "params": {
+ "autoplay": "Whether the video is set to autoplay",
+ "caption": "Caption",
+ "flags": "Flags, see TL conditional fields",
+ "loop": "Whether the video is set to loop",
+ "video_id": "Video ID"
+ }
+ },
+ "PageCaption": {
+ "desc": "Page caption",
+ "params": {
+ "credit": "Credits",
+ "text": "Caption"
+ }
+ },
+ "PageListItemBlocks": {
+ "desc": "List item",
+ "params": {
+ "blocks": "Blocks"
+ }
+ },
+ "PageListItemText": {
+ "desc": "List item",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "PageListOrderedItemBlocks": {
+ "desc": "Ordered list of IV blocks",
+ "params": {
+ "blocks": "Item contents",
+ "num": "Number of element within ordered list"
+ }
+ },
+ "PageListOrderedItemText": {
+ "desc": "Ordered list of text items",
+ "params": {
+ "num": "Number of element within ordered list",
+ "text": "Text"
+ }
+ },
+ "PageRelatedArticle": {
+ "desc": "Related article",
+ "params": {
+ "author": "Author name",
+ "description": "Description",
+ "flags": "Flags, see TL conditional fields",
+ "photo_id": "ID of preview photo",
+ "published_date": "Date of publication",
+ "title": "Title",
+ "url": "URL of article",
+ "webpage_id": "Webpage ID of generated IV preview"
+ }
+ },
+ "PageTableCell": {
+ "desc": "Table cell",
+ "params": {
+ "align_center": "Horizontally centered block",
+ "align_right": "Right-aligned block",
+ "colspan": "For how many columns should this cell extend",
+ "flags": "Flags, see TL conditional fields",
+ "header": "Is this element part of the column header",
+ "rowspan": "For how many rows should this cell extend",
+ "text": "Content",
+ "valign_bottom": "Block vertically-aligned to the bottom",
+ "valign_middle": "Vertically centered block"
+ }
+ },
+ "PageTableRow": {
+ "desc": "Table row",
+ "params": {
+ "cells": "Table cells"
+ }
+ },
+ "PaidReactionPrivacyAnonymous": {
+ "desc": "Send paid reactions anonymously.",
+ "params": {}
+ },
+ "PaidReactionPrivacyDefault": {
+ "desc": "Uses the default reaction privacy, set using messages.togglePaidReactionPrivacy.",
+ "params": {}
+ },
+ "PaidReactionPrivacyPeer": {
+ "desc": "Send paid reactions as the specified peer, fetched using channels.getSendAs.",
+ "params": {
+ "peer": "The peer to send reactions as."
+ }
+ },
+ "PasswordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow": {
+ "desc": "This key derivation algorithm defines that SRP 2FA login must be used",
+ "params": {
+ "g": "Base (see SRP 2FA login)",
+ "p": "2048-bit modulus (see SRP 2FA login)",
+ "salt1": "One of two salts used by the derivation function (see SRP 2FA login)",
+ "salt2": "One of two salts used by the derivation function (see SRP 2FA login)"
+ }
+ },
+ "PasswordKdfAlgoUnknown": {
+ "desc": "Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm)",
+ "params": {}
+ },
+ "PaymentCharge": {
+ "desc": "Payment identifier",
+ "params": {
+ "id": "Telegram payment identifier",
+ "provider_charge_id": "Provider payment identifier"
+ }
+ },
+ "PaymentFormMethod": {
+ "desc": "Represents an additional payment method",
+ "params": {
+ "title": "Payment method description",
+ "url": "URL to open in a webview to process the payment"
+ }
+ },
+ "PaymentRequestedInfo": {
+ "desc": "Order info provided by the user",
+ "params": {
+ "email": "User's email address",
+ "flags": "Flags, see TL conditional fields",
+ "name": "User's full name",
+ "phone": "User's phone number",
+ "shipping_address": "User's shipping address"
+ }
+ },
+ "PaymentSavedCredentialsCard": {
+ "desc": "Saved credit card",
+ "params": {
+ "id": "Card ID",
+ "title": "Title"
+ }
+ },
+ "PeerBlocked": {
+ "desc": "Information about a blocked peer",
+ "params": {
+ "date": "When was the peer blocked",
+ "peer_id": "Peer ID"
+ }
+ },
+ "PeerChannel": {
+ "desc": "Channel/supergroup",
+ "params": {
+ "channel_id": "Channel ID"
+ }
+ },
+ "PeerChat": {
+ "desc": "Group.",
+ "params": {
+ "chat_id": "Group identifier"
+ }
+ },
+ "PeerColor": {
+ "desc": "Represents a color palette \u00bb.",
+ "params": {
+ "background_emoji_id": "Optional custom emoji ID used to generate the pattern.",
+ "color": "Color palette ID, see here \u00bb for more info; if not set, the default palette should be used.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "PeerColorCollectible": {
+ "desc": "",
+ "params": {}
+ },
+ "PeerLocated": {
+ "desc": "Peer geolocated nearby",
+ "params": {
+ "distance": "Distance from the peer in meters",
+ "expires": "Validity period of current data",
+ "peer": "Peer"
+ }
+ },
+ "PeerNotifySettings": {
+ "desc": "Notification settings.",
+ "params": {
+ "android_sound": "Notification sound for the official android application",
+ "flags": "Flags, see TL conditional fields",
+ "ios_sound": "Notification sound for the official iOS application",
+ "mute_until": "Mute all notifications until this date",
+ "other_sound": "Notification sound for other applications",
+ "show_previews": "(Ternary value) If set, indicates whether or not to display previews of messages in notifications; otherwise the default behavior should be used.",
+ "silent": "(Ternary value) If set, indicates whether to mute or unmute the peer; otherwise the default behavior should be used.",
+ "stories_android_sound": "Sound for story notifications on the official Android application",
+ "stories_hide_sender": "Whether the sender name should be displayed in story notifications.",
+ "stories_ios_sound": "Sound for story notifications on the official iOS application",
+ "stories_muted": "Whether story notifications should be disabled.",
+ "stories_other_sound": "Sound for story notifications on other applications"
+ }
+ },
+ "PeerSelfLocated": {
+ "desc": "Current peer",
+ "params": {
+ "expires": "Expiry of geolocation info for current peer"
+ }
+ },
+ "PeerSettings": {
+ "desc": "List of actions that are possible when interacting with this user, to be shown as suggested actions in the chat action bar \u00bb, see here \u00bb for more info.",
+ "params": {
+ "add_contact": "Whether we can add the user as contact",
+ "autoarchived": "Whether this peer was automatically archived according to privacy settings and can be unarchived",
+ "block_contact": "Whether we can block the user",
+ "business_bot_can_reply": "This flag is set if both business_bot_id and business_bot_manage_url are set and connected business bots \u00bb can reply to messages in this chat, as specified by the settings during initial configuration.",
+ "business_bot_id": "Contains the ID of the business bot \u00bb managing this chat, used to display info about the bot in the action bar.",
+ "business_bot_manage_url": "Contains a deep link \u00bb, used to open a management menu in the business bot. This flag is set if and only if business_bot_id is set.",
+ "business_bot_paused": "This flag is set if both business_bot_id and business_bot_manage_url are set and all connected business bots \u00bb were paused in this chat using account.toggleConnectedBotPaused \u00bb.",
+ "charge_paid_message_stars": "All users that must pay us \u00bb to send us private messages will have this flag set only for us, containing the amount of required stars, see here \u00bb for more info on paid messages.",
+ "flags": "Flags, see TL conditional fields",
+ "geo_distance": "Distance in meters between us and this peer",
+ "invite_members": "If set, this is a recently created group chat to which new members can be invited",
+ "name_change_date": "When was the user's name last changed.",
+ "need_contacts_exception": "Whether a special exception for contacts is needed",
+ "phone_country": "The country code of the user's phone number.",
+ "photo_change_date": "When was the user's photo last changed.",
+ "registration_month": "Used to display the user's registration year and month, the string is in MM.YYYY format, where MM is the registration month (1-12), and YYYY is the registration year.",
+ "report_geo": "Whether we can report a geogroup as irrelevant for this location",
+ "report_spam": "Whether we can still report the user for spam",
+ "request_chat_broadcast": "This flag is set if request_chat_title and request_chat_date fields are set and the join request \u00bb is related to a channel (otherwise if only the request fields are set, the join request \u00bb is related to a chat).",
+ "request_chat_date": "If set, this is a private chat with an administrator of a chat or channel to which the user sent a join request, and this field contains the timestamp when the join request \u00bb was sent.",
+ "request_chat_title": "If set, this is a private chat with an administrator of a chat or channel to which the user sent a join request, and this field contains the chat/channel's title.",
+ "share_contact": "Whether we can share the user's contact"
+ }
+ },
+ "PeerStories": {
+ "desc": "Stories associated to a peer",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "max_read_id": "If set, contains the ID of the maximum read story",
+ "peer": "The peer",
+ "stories": "Stories"
+ }
+ },
+ "PeerUser": {
+ "desc": "Chat partner",
+ "params": {
+ "user_id": "User identifier"
+ }
+ },
+ "PendingSuggestion": {
+ "desc": "Represents a custom pending suggestion \u00bb.",
+ "params": {
+ "description": "Body of the suggestion.",
+ "suggestion": "The suggestion ID, can be passed to help.dismissSuggestion.",
+ "title": "Title of the suggestion.",
+ "url": "URL to open when the user clicks on the suggestion."
+ }
+ },
+ "PhoneCall": {
+ "desc": "Phone call",
+ "params": {
+ "access_hash": "Access hash",
+ "admin_id": "User ID of the creator of the call",
+ "conference_supported": "If set, the other party supports upgrading of the call to a conference call.",
+ "connections": "List of endpoints the user can connect to exchange call data",
+ "custom_parameters": "Custom JSON-encoded call parameters to be passed to tgcalls.",
+ "date": "Date of creation of the call",
+ "flags": "Flags, see TL conditional fields",
+ "g_a_or_b": "Parameter for key exchange",
+ "id": "Call ID",
+ "key_fingerprint": "Key fingerprint",
+ "p2p_allowed": "Whether P2P connection to the other peer is allowed",
+ "participant_id": "User ID of the other participant in the call",
+ "protocol": "Call protocol info to be passed to libtgvoip",
+ "start_date": "When was the call actually started",
+ "video": "Whether this is a video call"
+ }
+ },
+ "PhoneCallAccepted": {
+ "desc": "An accepted phone call",
+ "params": {
+ "access_hash": "Access hash of phone call",
+ "admin_id": "ID of the call creator",
+ "date": "When was the call accepted",
+ "flags": "Flags, see TL conditional fields",
+ "g_b": "B parameter for secure E2E phone call key exchange",
+ "id": "ID of accepted phone call",
+ "participant_id": "ID of the other user in the call",
+ "protocol": "Protocol to use for phone call",
+ "video": "Whether this is a video call"
+ }
+ },
+ "PhoneCallDiscardReasonBusy": {
+ "desc": "The phone call was discarded because the user is busy in another call",
+ "params": {}
+ },
+ "PhoneCallDiscardReasonDisconnect": {
+ "desc": "The phone call was disconnected",
+ "params": {}
+ },
+ "PhoneCallDiscardReasonHangup": {
+ "desc": "The phone call was ended normally",
+ "params": {}
+ },
+ "PhoneCallDiscardReasonMigrateConferenceCall": {
+ "desc": "This phone call was migrated to a conference call.",
+ "params": {
+ "slug": "Conference link \u00bb slug."
+ }
+ },
+ "PhoneCallDiscardReasonMissed": {
+ "desc": "The phone call was missed",
+ "params": {}
+ },
+ "PhoneCallDiscarded": {
+ "desc": "Indicates a discarded phone call",
+ "params": {
+ "duration": "Duration of the phone call in seconds",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Call ID",
+ "need_debug": "Whether the server required the client to send the libtgvoip call debug data",
+ "need_rating": "Whether the server required the user to rate the call",
+ "reason": "Why was the phone call discarded",
+ "video": "Whether the call was a video call"
+ }
+ },
+ "PhoneCallEmpty": {
+ "desc": "Empty constructor",
+ "params": {
+ "id": "Call ID"
+ }
+ },
+ "PhoneCallProtocol": {
+ "desc": "Protocol info for libtgvoip",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "library_versions": "When using phone.requestCall and phone.acceptCall, specify all library versions supported by the client. The server will merge and choose the best library version supported by both peers, returning only the best value in the result of the callee's phone.acceptCall and in the phoneCallAccepted update received by the caller.",
+ "max_layer": "Maximum layer for remote libtgvoip",
+ "min_layer": "Minimum layer for remote libtgvoip",
+ "udp_p2p": "Whether to allow P2P connection to the other participant",
+ "udp_reflector": "Whether to allow connection to the other participants through the reflector servers"
+ }
+ },
+ "PhoneCallRequested": {
+ "desc": "Requested phone call",
+ "params": {
+ "access_hash": "Access hash",
+ "admin_id": "ID of the creator of the phone call",
+ "date": "When was the phone call created",
+ "flags": "Flags, see TL conditional fields",
+ "g_a_hash": "Parameter for key exchange",
+ "id": "Phone call ID",
+ "participant_id": "ID of the other participant of the phone call",
+ "protocol": "Call protocol info to be passed to libtgvoip",
+ "video": "Whether this is a video call"
+ }
+ },
+ "PhoneCallWaiting": {
+ "desc": "Incoming phone call",
+ "params": {
+ "access_hash": "Access hash",
+ "admin_id": "Admin ID",
+ "date": "Date",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Call ID",
+ "participant_id": "Participant ID",
+ "protocol": "Phone call protocol info",
+ "receive_date": "When was the phone call received",
+ "video": "Is this a video call"
+ }
+ },
+ "PhoneConnection": {
+ "desc": "Identifies an endpoint that can be used to connect to the other user in a phone call",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Endpoint ID",
+ "ip": "IP address of endpoint",
+ "ipv6": "IPv6 address of endpoint",
+ "peer_tag": "Our peer tag",
+ "port": "Port ID",
+ "tcp": "Whether TCP should be used"
+ }
+ },
+ "PhoneConnectionWebrtc": {
+ "desc": "WebRTC connection parameters",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Endpoint ID",
+ "ip": "IP address",
+ "ipv6": "IPv6 address",
+ "password": "Password",
+ "port": "Port",
+ "stun": "Whether this is a STUN endpoint",
+ "turn": "Whether this is a TURN endpoint",
+ "username": "Username"
+ }
+ },
+ "Photo": {
+ "desc": "Photo",
+ "params": {
+ "access_hash": "Access hash",
+ "date": "Date of upload",
+ "dc_id": "DC ID to use for download",
+ "file_reference": "file reference",
+ "flags": "Flags, see TL conditional fields",
+ "has_stickers": "Whether the photo has mask stickers attached to it",
+ "id": "ID",
+ "sizes": "Available sizes for download",
+ "video_sizes": "For animated profiles, the MPEG4 videos"
+ }
+ },
+ "PhotoCachedSize": {
+ "desc": "Description of an image and its content.",
+ "params": {
+ "bytes": "Binary data, file content",
+ "h": "Image height",
+ "type": "Thumbnail type",
+ "w": "Image width"
+ }
+ },
+ "PhotoEmpty": {
+ "desc": "Empty constructor, non-existent photo",
+ "params": {
+ "id": "Photo identifier"
+ }
+ },
+ "PhotoPathSize": {
+ "desc": "Messages with animated stickers can have a compressed svg (< 300 bytes) to show the outline of the sticker before fetching the actual lottie animation.",
+ "params": {
+ "bytes": "Compressed SVG path payload, see here for decompression instructions",
+ "type": "Always j"
+ }
+ },
+ "PhotoSize": {
+ "desc": "Image description.",
+ "params": {
+ "h": "Image height",
+ "size": "File size",
+ "type": "Thumbnail type \u00bb",
+ "w": "Image width"
+ }
+ },
+ "PhotoSizeEmpty": {
+ "desc": "Empty constructor. Image with this thumbnail is unavailable.",
+ "params": {
+ "type": "Thumbnail type \u00bb"
+ }
+ },
+ "PhotoSizeProgressive": {
+ "desc": "Progressively encoded photosize",
+ "params": {
+ "h": "Photo height",
+ "sizes": "Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image.",
+ "type": "Photosize type \u00bb",
+ "w": "Photo width"
+ }
+ },
+ "PhotoStrippedSize": {
+ "desc": "A low-resolution compressed JPG payload",
+ "params": {
+ "bytes": "Thumbnail data, see here for more info on decompression \u00bb",
+ "type": "Thumbnail type"
+ }
+ },
+ "Poll": {
+ "desc": "Poll",
+ "params": {
+ "answers": "The possible answers (2-poll_answers_max), vote using messages.sendVote.",
+ "close_date": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future; can't be used together with close_period.",
+ "close_period": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.",
+ "closed": "Whether the poll is closed and doesn't accept any more answers",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of the poll",
+ "multiple_choice": "Whether multiple options can be chosen as answer",
+ "public_voters": "Whether cast votes are publicly visible to all users (non-anonymous poll)",
+ "question": "The question of the poll (only Premium users can use custom emoji entities here).",
+ "quiz": "Whether this is a quiz (with wrong and correct answers, results shown in the return type)"
+ }
+ },
+ "PollAnswer": {
+ "desc": "A possible answer of a poll",
+ "params": {
+ "option": "The param that has to be passed to messages.sendVote.",
+ "text": "Textual representation of the answer (only Premium users can use custom emoji entities here)."
+ }
+ },
+ "PollAnswerVoters": {
+ "desc": "A poll answer, and how users voted on it",
+ "params": {
+ "chosen": "Whether we have chosen this answer",
+ "correct": "For quizzes, whether the option we have chosen is correct",
+ "flags": "Flags, see TL conditional fields",
+ "option": "The param that has to be passed to messages.sendVote.",
+ "voters": "How many users voted for this option"
+ }
+ },
+ "PollResults": {
+ "desc": "Results of poll",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "min": "Similar to min objects, used for poll constructors that are the same for all users so they don't have the option chosen by the current user (you can use messages.getPollResults to get the full poll results).",
+ "recent_voters": "IDs of the last users that recently voted in the poll",
+ "results": "Poll results",
+ "solution": "Explanation of quiz solution",
+ "solution_entities": "Message entities for styled text in quiz solution",
+ "total_voters": "Total number of people that voted in the poll"
+ }
+ },
+ "PopularContact": {
+ "desc": "Popular contact",
+ "params": {
+ "client_id": "Contact identifier",
+ "importers": "How many people imported this contact"
+ }
+ },
+ "PostAddress": {
+ "desc": "Shipping address",
+ "params": {
+ "city": "City",
+ "country_iso2": "ISO 3166-1 alpha-2 country code",
+ "post_code": "Address post code",
+ "state": "State, if applicable (empty otherwise)",
+ "street_line1": "First line for the address",
+ "street_line2": "Second line for the address"
+ }
+ },
+ "PostInteractionCountersMessage": {
+ "desc": "Interaction counters for a message.",
+ "params": {
+ "forwards": "Number of forwards to public channels",
+ "msg_id": "Message ID",
+ "reactions": "Number of reactions",
+ "views": "Number of views"
+ }
+ },
+ "PostInteractionCountersStory": {
+ "desc": "Interaction counters for a story.",
+ "params": {
+ "forwards": "Number of forwards and reposts to public chats and channels",
+ "reactions": "Number of reactions",
+ "story_id": "Story ID",
+ "views": "Number of views"
+ }
+ },
+ "PremiumGiftCodeOption": {
+ "desc": "Contains info about a giveaway/gift option.",
+ "params": {
+ "amount": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "currency": "Three-letter ISO 4217 currency code",
+ "flags": "Flags, see TL conditional fields",
+ "months": "Duration in months of each gifted Telegram Premium subscription.",
+ "store_product": "Identifier of the store product associated with the option, official apps only.",
+ "store_quantity": "Number of times the store product must be paid",
+ "users": "Number of users which will be able to activate the gift codes."
+ }
+ },
+ "PremiumGiftOption": {
+ "desc": "Telegram Premium gift option",
+ "params": {}
+ },
+ "PremiumSubscriptionOption": {
+ "desc": "Describes a Telegram Premium subscription option",
+ "params": {
+ "amount": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "bot_url": "Deep link used to initiate payment",
+ "can_purchase_upgrade": "Whether this subscription option can be used to upgrade the existing Telegram Premium subscription. When upgrading Telegram Premium subscriptions bought through stores, make sure that the store transaction ID is equal to transaction, to avoid upgrading someone else's account, if the client is currently logged into multiple accounts.",
+ "currency": "Three-letter ISO 4217 currency code",
+ "current": "Whether this subscription option is currently in use.",
+ "flags": "Flags, see TL conditional fields",
+ "months": "Duration of subscription in months",
+ "store_product": "Store product ID, only for official apps",
+ "transaction": "Identifier of the last in-store transaction for the currently used subscription on the current account."
+ }
+ },
+ "PrepaidGiveaway": {
+ "desc": "Contains info about a prepaid giveaway \u00bb.",
+ "params": {
+ "date": "Payment date.",
+ "id": "Prepaid giveaway ID.",
+ "months": "Duration in months of each gifted Telegram Premium subscription.",
+ "quantity": "Number of given away Telegram Premium subscriptions."
+ }
+ },
+ "PrepaidStarsGiveaway": {
+ "desc": "Contains info about a prepaid Telegram Star giveaway \u00bb.",
+ "params": {
+ "boosts": "Number of boosts the channel will gain by launching the giveaway.",
+ "date": "When was the giveaway paid for",
+ "id": "Prepaid giveaway ID.",
+ "quantity": "Number of giveaway winners",
+ "stars": "Number of given away Telegram Stars \u00bb"
+ }
+ },
+ "PrivacyKeyAbout": {
+ "desc": "Whether people can see your bio",
+ "params": {}
+ },
+ "PrivacyKeyAddedByPhone": {
+ "desc": "Whether this user can be added to our contact list by their phone number",
+ "params": {}
+ },
+ "PrivacyKeyBirthday": {
+ "desc": "Whether the user can see our birthday.",
+ "params": {}
+ },
+ "PrivacyKeyChatInvite": {
+ "desc": "Whether the user can be invited to chats",
+ "params": {}
+ },
+ "PrivacyKeyForwards": {
+ "desc": "Whether messages forwarded from the user will be anonymously forwarded",
+ "params": {}
+ },
+ "PrivacyKeyNoPaidMessages": {
+ "desc": "Who can send you messages without paying, if paid messages \u00bb are enabled.",
+ "params": {}
+ },
+ "PrivacyKeyPhoneCall": {
+ "desc": "Whether the user accepts phone calls",
+ "params": {}
+ },
+ "PrivacyKeyPhoneNumber": {
+ "desc": "Whether the user allows us to see his phone number",
+ "params": {}
+ },
+ "PrivacyKeyPhoneP2P": {
+ "desc": "Whether P2P connections in phone calls with this user are allowed",
+ "params": {}
+ },
+ "PrivacyKeyProfilePhoto": {
+ "desc": "Whether the profile picture of the user is visible",
+ "params": {}
+ },
+ "PrivacyKeyStarGiftsAutoSave": {
+ "desc": "Whether received gifts will be automatically displayed on our profile",
+ "params": {}
+ },
+ "PrivacyKeyStatusTimestamp": {
+ "desc": "Whether we can see the last online timestamp of this user.",
+ "params": {}
+ },
+ "PrivacyKeyVoiceMessages": {
+ "desc": "Whether the user accepts voice messages",
+ "params": {}
+ },
+ "PrivacyValueAllowAll": {
+ "desc": "Allow all users",
+ "params": {}
+ },
+ "PrivacyValueAllowBots": {
+ "desc": "Allow bots and mini apps",
+ "params": {}
+ },
+ "PrivacyValueAllowChatParticipants": {
+ "desc": "Allow all participants of certain chats",
+ "params": {
+ "chats": "Allowed chat IDs (either a chat or a supergroup ID, verbatim the way it is received in the constructor (i.e. unlike with bot API IDs, here group and supergroup IDs should be treated in the same way))."
+ }
+ },
+ "PrivacyValueAllowCloseFriends": {
+ "desc": "Allow only close friends \u00bb",
+ "params": {}
+ },
+ "PrivacyValueAllowContacts": {
+ "desc": "Allow all contacts",
+ "params": {}
+ },
+ "PrivacyValueAllowPremium": {
+ "desc": "Allow only users with a Premium subscription \u00bb, currently only usable for inputPrivacyKeyChatInvite.",
+ "params": {}
+ },
+ "PrivacyValueAllowUsers": {
+ "desc": "Allow only certain users",
+ "params": {
+ "users": "Allowed users"
+ }
+ },
+ "PrivacyValueDisallowAll": {
+ "desc": "Disallow all users",
+ "params": {}
+ },
+ "PrivacyValueDisallowBots": {
+ "desc": "Disallow bots and mini apps",
+ "params": {}
+ },
+ "PrivacyValueDisallowChatParticipants": {
+ "desc": "Disallow only participants of certain chats",
+ "params": {
+ "chats": "Disallowed chats IDs (either a chat or a supergroup ID, verbatim the way it is received in the constructor (i.e. unlike with bot API IDs, here group and supergroup IDs should be treated in the same way))."
+ }
+ },
+ "PrivacyValueDisallowContacts": {
+ "desc": "Disallow only contacts",
+ "params": {}
+ },
+ "PrivacyValueDisallowUsers": {
+ "desc": "Disallow only certain users",
+ "params": {
+ "users": "Disallowed users"
+ }
+ },
+ "ProfileTabFiles": {
+ "desc": "Represents the shared files tab of a profile.",
+ "params": {}
+ },
+ "ProfileTabGifs": {
+ "desc": "Represents the gifs tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabGifts": {
+ "desc": "Represents the gifts tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabLinks": {
+ "desc": "Represents the shared links tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabMedia": {
+ "desc": "Represents the media tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabMusic": {
+ "desc": "Represents the music tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabPosts": {
+ "desc": "Represents the stories tab of a profile page.",
+ "params": {}
+ },
+ "ProfileTabVoice": {
+ "desc": "Represents the voice messages tab of a profile page.",
+ "params": {}
+ },
+ "PublicForwardMessage": {
+ "desc": "Contains info about a forward of a story as a message.",
+ "params": {
+ "message": "Info about the message with the reposted story."
+ }
+ },
+ "PublicForwardStory": {
+ "desc": "Contains info about a forward of a story as a repost by a public channel.",
+ "params": {
+ "peer": "The channel that reposted the story.",
+ "story": "The reposted story (may be different from the original story)."
+ }
+ },
+ "QuickReply": {
+ "desc": "A quick reply shortcut.",
+ "params": {
+ "count": "Total number of messages in the shortcut.",
+ "shortcut": "Shortcut name.",
+ "shortcut_id": "Unique shortcut ID.",
+ "top_message": "ID of the last message in the shortcut."
+ }
+ },
+ "ReactionCount": {
+ "desc": "Reactions",
+ "params": {
+ "chosen_order": "If set, indicates that the current user also sent this reaction. The integer value indicates when was the reaction added: the bigger the value, the newer the reaction.",
+ "count": "Number of users that reacted with this emoji.",
+ "flags": "Flags, see TL conditional fields",
+ "reaction": "The reaction."
+ }
+ },
+ "ReactionCustomEmoji": {
+ "desc": "Custom emoji message reaction",
+ "params": {
+ "document_id": "Custom emoji document ID"
+ }
+ },
+ "ReactionEmoji": {
+ "desc": "Normal emoji message reaction",
+ "params": {
+ "emoticon": "Emoji"
+ }
+ },
+ "ReactionEmpty": {
+ "desc": "No reaction",
+ "params": {}
+ },
+ "ReactionNotificationsFromAll": {
+ "desc": "Receive notifications about reactions made by any user.",
+ "params": {}
+ },
+ "ReactionNotificationsFromContacts": {
+ "desc": "Receive notifications about reactions made only by our contacts.",
+ "params": {}
+ },
+ "ReactionPaid": {
+ "desc": "Represents a paid Telegram Star reaction \u00bb.",
+ "params": {}
+ },
+ "ReactionsNotifySettings": {
+ "desc": "Reaction notification settings, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "messages_notify_from": "Message reaction notification settings, if not set completely disables notifications/updates about message reactions.",
+ "show_previews": "If false, push notifications \u00bb about message/story reactions will only be of type REACT_HIDDEN/REACT_STORY_HIDDEN, without any information about the reacted-to story or the reaction itself.",
+ "sound": "Notification sound for reactions \u00bb",
+ "stories_notify_from": "Story reaction notification settings, if not set completely disables notifications/updates about reactions to stories."
+ }
+ },
+ "ReadParticipantDate": {
+ "desc": "Contains info about when a certain participant has read a message",
+ "params": {
+ "date": "When the user read the message",
+ "user_id": "User ID"
+ }
+ },
+ "ReceivedNotifyMessage": {
+ "desc": "Message ID, for which PUSH-notifications were cancelled.",
+ "params": {
+ "flags": "Reserved for future use",
+ "id": "Message ID, for which PUSH-notifications were canceled"
+ }
+ },
+ "RecentMeUrlChat": {
+ "desc": "Recent t.me link to a chat",
+ "params": {
+ "chat_id": "Chat ID",
+ "url": "t.me URL"
+ }
+ },
+ "RecentMeUrlChatInvite": {
+ "desc": "Recent t.me invite link to a chat",
+ "params": {
+ "chat_invite": "Chat invitation",
+ "url": "t.me URL"
+ }
+ },
+ "RecentMeUrlStickerSet": {
+ "desc": "Recent t.me stickerset installation URL",
+ "params": {
+ "set": "Stickerset",
+ "url": "t.me URL"
+ }
+ },
+ "RecentMeUrlUnknown": {
+ "desc": "Unknown t.me url",
+ "params": {
+ "url": "URL"
+ }
+ },
+ "RecentMeUrlUser": {
+ "desc": "Recent t.me link to a user",
+ "params": {
+ "url": "URL",
+ "user_id": "User ID"
+ }
+ },
+ "ReplyInlineMarkup": {
+ "desc": "Bot or inline keyboard",
+ "params": {
+ "rows": "Bot or inline keyboard rows"
+ }
+ },
+ "ReplyKeyboardForceReply": {
+ "desc": "Force the user to send a reply",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "placeholder": "The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.",
+ "selective": "Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.",
+ "single_use": "Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat \u2013 the user can press a special button in the input field to see the custom keyboard again."
+ }
+ },
+ "ReplyKeyboardHide": {
+ "desc": "Hide sent bot keyboard",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "selective": "Use this flag if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet"
+ }
+ },
+ "ReplyKeyboardMarkup": {
+ "desc": "Bot keyboard",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "persistent": "Requests clients to always show the keyboard when the regular keyboard is hidden.",
+ "placeholder": "The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.",
+ "resize": "Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). If not set, the custom keyboard is always of the same height as the app's standard keyboard.",
+ "rows": "Button row",
+ "selective": "Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.",
+ "single_use": "Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat \u2013 the user can press a special button in the input field to see the custom keyboard again."
+ }
+ },
+ "ReportResultAddComment": {
+ "desc": "The user should enter an additional comment for the moderators, and then messages.report must be re-invoked, passing the comment to messages.report.message.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "option": "The messages.report method must be re-invoked, passing this option to option",
+ "optional": "Whether this step can be skipped by the user, passing an empty message to messages.report, or if a non-empty message is mandatory."
+ }
+ },
+ "ReportResultChooseOption": {
+ "desc": "The user must choose one of the following options, and then messages.report must be re-invoked, passing the option's option identifier to messages.report.option.",
+ "params": {
+ "options": "Available options, rendered as menu entries.",
+ "title": "Title of the option popup"
+ }
+ },
+ "ReportResultReported": {
+ "desc": "The report was sent successfully, no further actions are required.",
+ "params": {}
+ },
+ "RequestPeerTypeBroadcast": {
+ "desc": "Choose a channel",
+ "params": {
+ "bot_admin_rights": "If specified, allows only choosing channels where the bot is an admin with at least the specified admin rights.",
+ "creator": "Whether to allow only choosing channels that were created by the current user.",
+ "flags": "Flags, see TL conditional fields",
+ "has_username": "If specified, allows only choosing channels with or without a username, according to the value of Bool.",
+ "user_admin_rights": "If specified, allows only choosing channels where the current user is an admin with at least the specified admin rights."
+ }
+ },
+ "RequestPeerTypeChat": {
+ "desc": "Choose a chat or supergroup",
+ "params": {
+ "bot_admin_rights": "If specified, allows only choosing chats or supergroups where the bot is an admin with at least the specified admin rights.",
+ "bot_participant": "Whether to allow only choosing chats or supergroups where the bot is a participant.",
+ "creator": "Whether to allow only choosing chats or supergroups that were created by the current user.",
+ "flags": "Flags, see TL conditional fields",
+ "forum": "If specified, allows only choosing chats or supergroups that are or aren't forums, according to the value of Bool.",
+ "has_username": "If specified, allows only choosing channels with or without a username, according to the value of Bool.",
+ "user_admin_rights": "If specified, allows only choosing chats or supergroups where the current user is an admin with at least the specified admin rights."
+ }
+ },
+ "RequestPeerTypeUser": {
+ "desc": "Choose a user.",
+ "params": {
+ "bot": "Whether to allow choosing only bots.",
+ "flags": "Flags, see TL conditional fields",
+ "premium": "Whether to allow choosing only Premium users."
+ }
+ },
+ "RequestedPeerChannel": {
+ "desc": "Info about a channel/supergroup, shared by a user with the currently logged in bot using messages.sendBotRequestedPeer.",
+ "params": {
+ "channel_id": "Channel/supergroup ID.",
+ "flags": "Flags, see TL conditional fields",
+ "photo": "Channel/supergroup photo.",
+ "title": "Channel/supergroup title.",
+ "username": "Channel/supergroup username."
+ }
+ },
+ "RequestedPeerChat": {
+ "desc": "Info about a chat, shared by a user with the currently logged in bot using messages.sendBotRequestedPeer.",
+ "params": {
+ "chat_id": "Chat ID.",
+ "flags": "Flags, see TL conditional fields",
+ "photo": "Chat photo.",
+ "title": "Chat title."
+ }
+ },
+ "RequestedPeerUser": {
+ "desc": "Info about a user, shared by a user with the currently logged in bot using messages.sendBotRequestedPeer.",
+ "params": {
+ "first_name": "First name.",
+ "flags": "Flags, see TL conditional fields",
+ "last_name": "Last name.",
+ "photo": "Profile photo.",
+ "user_id": "User ID.",
+ "username": "Username."
+ }
+ },
+ "RequirementToContactEmpty": {
+ "desc": "This user can be freely contacted.",
+ "params": {}
+ },
+ "RequirementToContactPaidMessages": {
+ "desc": "This user requires us to pay the specified amount of Telegram Stars to send them a message, see here \u00bb for the full flow.",
+ "params": {
+ "stars_amount": "The required amount of Telegram Stars."
+ }
+ },
+ "RequirementToContactPremium": {
+ "desc": "This user requires us to buy a Premium subscription in order to contact them.",
+ "params": {}
+ },
+ "RestrictionReason": {
+ "desc": "Restriction reason.",
+ "params": {
+ "platform": "Platform identifier (ios, android, wp, all, etc.), can be concatenated with a dash as separator (android-ios, ios-wp, etc)",
+ "reason": "Restriction reason (porno, terms, etc.). Ignore this restriction reason if it is contained in the ignore_restriction_reasons \u00bb client configuration parameter.",
+ "text": "Error message to be shown to the user"
+ }
+ },
+ "SavedDialog": {
+ "desc": "Represents a saved dialog \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The dialog",
+ "pinned": "Is the dialog pinned",
+ "top_message": "The latest message ID"
+ }
+ },
+ "SavedPhoneContact": {
+ "desc": "Saved contact",
+ "params": {
+ "date": "Date added",
+ "first_name": "First name",
+ "last_name": "Last name",
+ "phone": "Phone number"
+ }
+ },
+ "SavedReactionTag": {
+ "desc": "Info about a saved message reaction tag \u00bb.",
+ "params": {
+ "count": "Number of messages tagged with this tag.",
+ "flags": "Flags, see TL conditional fields",
+ "reaction": "Reaction associated to the tag.",
+ "title": "Custom tag name assigned by the user (max 12 UTF-8 chars)."
+ }
+ },
+ "SavedStarGift": {
+ "desc": "Represents a gift owned by a peer.",
+ "params": {
+ "can_export_at": "If set, indicates that the current gift can't be exported to the TON blockchain \u00bb yet: the owner will be able to export it at the specified unixtime.",
+ "can_resell_at": "If set, indicates that the current gift can't be resold \u00bb yet: the owner will be able to put it up for sale at the specified unixtime.",
+ "can_transfer_at": "If set, indicates that the current gift can't be transferred \u00bb yet: the owner will be able to transfer it at the specified unixtime.",
+ "can_upgrade": "Only set for non-collectible gifts, if they can be upgraded to a collectible gift \u00bb.",
+ "collection_id": "IDs of the collections \u00bb that this gift is a part of.",
+ "convert_stars": "For non-collectible gifts, the receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.",
+ "date": "Reception date of the gift.",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "Sender of the gift (unset for anonymous gifts).",
+ "gift": "The collectible gift.",
+ "message": "Message attached to the gift.",
+ "msg_id": "For gifts received by users, ID to use in inputSavedStarGiftUser constructors.",
+ "name_hidden": "If set, the gift sender in from_id and the message are set only for the receiver of the gift.",
+ "pinned_to_top": "Whether this gift is pinned on top of the user's profile page.",
+ "prepaid_upgrade_hash": "Hash to prepay for a gift upgrade separately \u00bb.",
+ "refunded": "This gift was upgraded to a collectible gift \u00bb and then re-downgraded to a regular gift because a request to refund the payment related to the upgrade was made, and the money was returned.",
+ "saved_id": "For gifts received by channels, ID to use in inputSavedStarGiftChat constructors.",
+ "transfer_stars": "If set, indicates that the gift can be transferred \u00bb to another user by paying the specified amount of stars.",
+ "unsaved": "If set, the gift is not pinned on the user's profile.",
+ "upgrade_separate": "If set, someone already separately pre-paid for the upgrade of this gift.",
+ "upgrade_stars": "Only for pre-paid non-collectible gifts, the number of Telegram Stars the sender has already paid to convert the gift into a collectible gift \u00bb (this is different from the meaning of the flag in messageActionStarGift, where it signals the upgrade price for not yet upgraded gifts)."
+ }
+ },
+ "SearchPostsFlood": {
+ "desc": "Indicates if the specified global post search \u00bb requires payment.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "query_is_free": "The specified query is free (and it will not use up free search slots).",
+ "remains": "Remaining number of free search slots.",
+ "stars_amount": "The number of Telegram Stars to pay for each non-free search.",
+ "total_daily": "Total number of daily free search slots.",
+ "wait_till": "If there are no more search slots, specifies the unixtime when more search slots will be available."
+ }
+ },
+ "SearchResultPosition": {
+ "desc": "Information about a message in a specific position",
+ "params": {
+ "date": "When was the message sent",
+ "msg_id": "Message ID",
+ "offset": "0-based message position in the full list of suitable messages"
+ }
+ },
+ "SearchResultsCalendarPeriod": {
+ "desc": "Information about found messages sent on a specific day, used to split the messages in messages.searchResultsCalendar constructors by days.",
+ "params": {
+ "count": "All messages that were sent on this day.",
+ "date": "The day this object is referring to.",
+ "max_msg_id": "Last message ID that was sent on this day.",
+ "min_msg_id": "First message ID that was sent on this day."
+ }
+ },
+ "SecureCredentialsEncrypted": {
+ "desc": "Encrypted credentials required to decrypt telegram passport data.",
+ "params": {
+ "data": "Encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication, as described in decrypting data \u00bb",
+ "hash": "Data hash for data authentication as described in decrypting data \u00bb",
+ "secret": "Secret, encrypted with the bot's public RSA key, required for data decryption as described in decrypting data \u00bb"
+ }
+ },
+ "SecureData": {
+ "desc": "Secure passport data, for more info see the passport docs \u00bb",
+ "params": {
+ "data": "Data",
+ "data_hash": "Data hash",
+ "secret": "Secret"
+ }
+ },
+ "SecureFile": {
+ "desc": "Secure passport file, for more info see the passport docs \u00bb",
+ "params": {
+ "access_hash": "Access hash",
+ "date": "Date of upload",
+ "dc_id": "DC ID",
+ "file_hash": "File hash",
+ "id": "ID",
+ "secret": "Secret",
+ "size": "File size"
+ }
+ },
+ "SecureFileEmpty": {
+ "desc": "Empty constructor",
+ "params": {}
+ },
+ "SecurePasswordKdfAlgoPBKDF2HMACSHA512iter100000": {
+ "desc": "PBKDF2 with SHA512 and 100000 iterations KDF algo",
+ "params": {
+ "salt": "Salt"
+ }
+ },
+ "SecurePasswordKdfAlgoSHA512": {
+ "desc": "SHA512 KDF algo",
+ "params": {
+ "salt": "Salt"
+ }
+ },
+ "SecurePasswordKdfAlgoUnknown": {
+ "desc": "Unknown KDF algo (most likely the client has to be updated)",
+ "params": {}
+ },
+ "SecurePlainEmail": {
+ "desc": "Email address to use in telegram passport: it must be verified, first \u00bb.",
+ "params": {
+ "email": "Email address"
+ }
+ },
+ "SecurePlainPhone": {
+ "desc": "Phone number to use in telegram passport: it must be verified, first \u00bb.",
+ "params": {
+ "phone": "Phone number"
+ }
+ },
+ "SecureRequiredType": {
+ "desc": "Required type",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "native_names": "Native names",
+ "selfie_required": "Is a selfie required",
+ "translation_required": "Is a translation required",
+ "type": "Secure value type"
+ }
+ },
+ "SecureRequiredTypeOneOf": {
+ "desc": "One of",
+ "params": {
+ "types": "Secure required value types"
+ }
+ },
+ "SecureSecretSettings": {
+ "desc": "Secure settings",
+ "params": {
+ "secure_algo": "Secure KDF algo",
+ "secure_secret": "Secure secret",
+ "secure_secret_id": "Secret ID"
+ }
+ },
+ "SecureValue": {
+ "desc": "Secure value",
+ "params": {
+ "data": "Encrypted Telegram Passport element data",
+ "files": "Array of encrypted passport files with photos the of the documents",
+ "flags": "Flags, see TL conditional fields",
+ "front_side": "Encrypted passport file with the front side of the document",
+ "hash": "Data hash",
+ "plain_data": "Plaintext verified passport data",
+ "reverse_side": "Encrypted passport file with the reverse side of the document",
+ "selfie": "Encrypted passport file with a selfie of the user holding the document",
+ "translation": "Array of encrypted passport files with translated versions of the provided documents",
+ "type": "Secure passport value type"
+ }
+ },
+ "SecureValueError": {
+ "desc": "Secure value error",
+ "params": {
+ "hash": "Hash",
+ "text": "Error message",
+ "type": "Type of element which has the issue"
+ }
+ },
+ "SecureValueErrorData": {
+ "desc": "Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.",
+ "params": {
+ "data_hash": "Data hash",
+ "field": "Name of the data field which has the error",
+ "text": "Error message",
+ "type": "The section of the user's Telegram Passport which has the error, one of secureValueTypePersonalDetails, secureValueTypePassport, secureValueTypeDriverLicense, secureValueTypeIdentityCard, secureValueTypeInternalPassport, secureValueTypeAddress"
+ }
+ },
+ "SecureValueErrorFile": {
+ "desc": "Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypeUtilityBill, secureValueTypeBankStatement, secureValueTypeRentalAgreement, secureValueTypePassportRegistration, secureValueTypeTemporaryRegistration"
+ }
+ },
+ "SecureValueErrorFiles": {
+ "desc": "Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypeUtilityBill, secureValueTypeBankStatement, secureValueTypeRentalAgreement, secureValueTypePassportRegistration, secureValueTypeTemporaryRegistration"
+ }
+ },
+ "SecureValueErrorFrontSide": {
+ "desc": "Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypePassport, secureValueTypeDriverLicense, secureValueTypeIdentityCard, secureValueTypeInternalPassport"
+ }
+ },
+ "SecureValueErrorReverseSide": {
+ "desc": "Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypeDriverLicense, secureValueTypeIdentityCard"
+ }
+ },
+ "SecureValueErrorSelfie": {
+ "desc": "Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypePassport, secureValueTypeDriverLicense, secureValueTypeIdentityCard, secureValueTypeInternalPassport"
+ }
+ },
+ "SecureValueErrorTranslationFile": {
+ "desc": "Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.",
+ "params": {
+ "file_hash": "File hash",
+ "text": "Error message",
+ "type": "One of secureValueTypePersonalDetails, secureValueTypePassport, secureValueTypeDriverLicense, secureValueTypeIdentityCard, secureValueTypeInternalPassport, secureValueTypeUtilityBill, secureValueTypeBankStatement, secureValueTypeRentalAgreement, secureValueTypePassportRegistration, secureValueTypeTemporaryRegistration"
+ }
+ },
+ "SecureValueErrorTranslationFiles": {
+ "desc": "Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes.",
+ "params": {
+ "file_hash": "Hash",
+ "text": "Error message",
+ "type": "One of secureValueTypePersonalDetails, secureValueTypePassport, secureValueTypeDriverLicense, secureValueTypeIdentityCard, secureValueTypeInternalPassport, secureValueTypeUtilityBill, secureValueTypeBankStatement, secureValueTypeRentalAgreement, secureValueTypePassportRegistration, secureValueTypeTemporaryRegistration"
+ }
+ },
+ "SecureValueHash": {
+ "desc": "Secure value hash",
+ "params": {
+ "hash": "Hash",
+ "type": "Secure value type"
+ }
+ },
+ "SecureValueTypeAddress": {
+ "desc": "Address",
+ "params": {}
+ },
+ "SecureValueTypeBankStatement": {
+ "desc": "Bank statement",
+ "params": {}
+ },
+ "SecureValueTypeDriverLicense": {
+ "desc": "Driver's license",
+ "params": {}
+ },
+ "SecureValueTypeEmail": {
+ "desc": "Email",
+ "params": {}
+ },
+ "SecureValueTypeIdentityCard": {
+ "desc": "Identity card",
+ "params": {}
+ },
+ "SecureValueTypeInternalPassport": {
+ "desc": "Internal passport",
+ "params": {}
+ },
+ "SecureValueTypePassport": {
+ "desc": "Passport",
+ "params": {}
+ },
+ "SecureValueTypePassportRegistration": {
+ "desc": "Internal registration passport",
+ "params": {}
+ },
+ "SecureValueTypePersonalDetails": {
+ "desc": "Personal details",
+ "params": {}
+ },
+ "SecureValueTypePhone": {
+ "desc": "Phone",
+ "params": {}
+ },
+ "SecureValueTypeRentalAgreement": {
+ "desc": "Rental agreement",
+ "params": {}
+ },
+ "SecureValueTypeTemporaryRegistration": {
+ "desc": "Temporary registration",
+ "params": {}
+ },
+ "SecureValueTypeUtilityBill": {
+ "desc": "Utility bill",
+ "params": {}
+ },
+ "SendAsPeer": {
+ "desc": "Indicates a peer that can be used to send messages",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Peer",
+ "premium_required": "Whether a Telegram Premium account is required to send messages as this peer"
+ }
+ },
+ "SendMessageCancelAction": {
+ "desc": "Invalidate all previous action updates. E.g. when user deletes entered text or aborts a video upload.",
+ "params": {}
+ },
+ "SendMessageChooseContactAction": {
+ "desc": "User is selecting a contact to share.",
+ "params": {}
+ },
+ "SendMessageChooseStickerAction": {
+ "desc": "User is choosing a sticker",
+ "params": {}
+ },
+ "SendMessageEmojiInteraction": {
+ "desc": "User has clicked on an animated emoji triggering a reaction, click here for more info \u00bb.",
+ "params": {
+ "emoticon": "Emoji",
+ "interaction": "A JSON object with interaction info, click here for more info \u00bb",
+ "msg_id": "Message ID of the animated emoji that was clicked"
+ }
+ },
+ "SendMessageEmojiInteractionSeen": {
+ "desc": "User is watching an animated emoji reaction triggered by another user, click here for more info \u00bb.",
+ "params": {
+ "emoticon": "Emoji"
+ }
+ },
+ "SendMessageGamePlayAction": {
+ "desc": "User is playing a game",
+ "params": {}
+ },
+ "SendMessageGeoLocationAction": {
+ "desc": "User is selecting a location to share.",
+ "params": {}
+ },
+ "SendMessageHistoryImportAction": {
+ "desc": "Chat history is being imported",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "SendMessageRecordAudioAction": {
+ "desc": "User is recording a voice message.",
+ "params": {}
+ },
+ "SendMessageRecordRoundAction": {
+ "desc": "User is recording a round video to share",
+ "params": {}
+ },
+ "SendMessageRecordVideoAction": {
+ "desc": "User is recording a video.",
+ "params": {}
+ },
+ "SendMessageTextDraftAction": {
+ "desc": "",
+ "params": {}
+ },
+ "SendMessageTypingAction": {
+ "desc": "User is typing.",
+ "params": {}
+ },
+ "SendMessageUploadAudioAction": {
+ "desc": "User is uploading a voice message.",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "SendMessageUploadDocumentAction": {
+ "desc": "User is uploading a file.",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "SendMessageUploadPhotoAction": {
+ "desc": "User is uploading a photo.",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "SendMessageUploadRoundAction": {
+ "desc": "User is uploading a round video",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "SendMessageUploadVideoAction": {
+ "desc": "User is uploading a video.",
+ "params": {
+ "progress": "Progress percentage"
+ }
+ },
+ "ShippingOption": {
+ "desc": "Shipping option",
+ "params": {
+ "id": "Option ID",
+ "prices": "List of price portions",
+ "title": "Title"
+ }
+ },
+ "SmsJob": {
+ "desc": "Info about an SMS job.",
+ "params": {
+ "job_id": "Job ID",
+ "phone_number": "Destination phone number",
+ "text": "Text"
+ }
+ },
+ "SpeakingInGroupCallAction": {
+ "desc": "User is currently speaking in the group call",
+ "params": {}
+ },
+ "SponsoredMessage": {
+ "desc": "A sponsored message.",
+ "params": {
+ "additional_info": "If set, contains additional information about the sponsored message to be shown along with the message.",
+ "button_text": "Label of the sponsored message button.",
+ "can_report": "Whether this message can be reported as specified here \u00bb.",
+ "color": "If set, the sponsored message should use the message accent color \u00bb specified in color.",
+ "entities": "Message entities for styled text in message.",
+ "flags": "Flags, see TL conditional fields",
+ "max_display_duration": "For sponsored messages to show on channel videos \u00bb, autohide the ad after after the specified amount of seconds.",
+ "media": "If set, contains some media.",
+ "message": "Sponsored message",
+ "min_display_duration": "For sponsored messages to show on channel videos \u00bb, allow the user to hide the ad only after the specified amount of seconds.",
+ "photo": "If set, contains a custom profile photo bubble that should be displayed for the sponsored message, like for messages sent in groups.",
+ "random_id": "Message ID",
+ "recommended": "Whether the message needs to be labeled as \"recommended\" instead of \"sponsored\"",
+ "sponsor_info": "If set, contains additional information about the sponsor to be shown along with the message.",
+ "title": "Contains the title of the sponsored message.",
+ "url": "Contains the URL to open when the user clicks on the sponsored message."
+ }
+ },
+ "SponsoredMessageReportOption": {
+ "desc": "A report option for a sponsored message \u00bb.",
+ "params": {
+ "option": "Option identifier to pass to channels.reportSponsoredMessage.",
+ "text": "Localized description of the option."
+ }
+ },
+ "SponsoredPeer": {
+ "desc": "A sponsored peer.",
+ "params": {
+ "additional_info": "If set, contains additional information about the sponsored message to be shown along with the peer.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The sponsored peer.",
+ "random_id": "ID of the sponsored peer, to be passed to messages.viewSponsoredMessage, messages.clickSponsoredMessage or messages.reportSponsoredMessage (the same methods used for sponsored messages »).",
+ "sponsor_info": "If set, contains additional information about the sponsor to be shown along with the peer."
+ }
+ },
+ "StarGift": {
+ "desc": "Represents a star gift, see here \u00bb for more info.",
+ "params": {
+ "availability_remains": "For limited-supply gifts: the remaining number of gifts that may be bought.",
+ "availability_resale": "The total number of (upgraded to collectibles) gifts of this type currently on resale",
+ "availability_total": "For limited-supply gifts: the total number of gifts that was available in the initial supply.",
+ "birthday": "Whether this is a birthday-themed gift",
+ "convert_stars": "The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars.",
+ "first_sale_date": "For sold out gifts only: when was the gift first bought.",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Identifier of the gift",
+ "last_sale_date": "For sold out gifts only: when was the gift last bought.",
+ "limited": "Whether this is a limited-supply gift.",
+ "limited_per_user": "If set, the maximum number of gifts of this type that can be owned by a single user is limited and specified in per_user_total, and the remaining slots for the current user in per_user_remains.",
+ "locked_until_date": "If set, the specified gift possibly cannot be sent until the specified date, see here \u00bb for the full flow.",
+ "per_user_remains": "Remaining number of gifts of this type that can be owned by the current user.",
+ "per_user_total": "Maximum number of gifts of this type that can be owned by any user.",
+ "released_by": "This gift was released by the specified peer.",
+ "require_premium": "This gift can only be bought by users with a Premium subscription.",
+ "resell_min_stars": "The minimum price in Stars for gifts of this type currently on resale.",
+ "sold_out": "Whether this gift sold out and cannot be bought anymore.",
+ "stars": "Price of the gift in Telegram Stars.",
+ "sticker": "Sticker that represents the gift.",
+ "title": "Title of the gift",
+ "upgrade_stars": "The number of Telegram Stars the user can pay to convert the gift into a collectible gift \u00bb."
+ }
+ },
+ "StarGiftAttributeBackdrop": {
+ "desc": "The backdrop of a collectible gift \u00bb.",
+ "params": {
+ "backdrop_id": "Unique ID of the backdrop",
+ "center_color": "Color of the center of the backdrop in RGB24 format.",
+ "edge_color": "Color of the edges of the backdrop in RGB24 format.",
+ "name": "Name of the backdrop",
+ "pattern_color": "Color of the starGiftAttributePattern applied on the backdrop in RGB24 format.",
+ "rarity_permille": "The number of upgraded gifts that receive this backdrop for each 1000 gifts upgraded.",
+ "text_color": "Color of the text on the backdrop in RGB24 format."
+ }
+ },
+ "StarGiftAttributeCounter": {
+ "desc": "Indicates the total number of gifts that have the specified attribute.",
+ "params": {
+ "attribute": "The attribute (just the ID, without the attribute itself).",
+ "count": "Total number of gifts with this attribute."
+ }
+ },
+ "StarGiftAttributeIdBackdrop": {
+ "desc": "The ID of a backdrop of a collectible gift \u00bb.",
+ "params": {
+ "backdrop_id": "Unique ID of the backdrop."
+ }
+ },
+ "StarGiftAttributeIdModel": {
+ "desc": "The ID of a model of a collectible gift \u00bb.",
+ "params": {
+ "document_id": "The sticker representing the upgraded gift"
+ }
+ },
+ "StarGiftAttributeIdPattern": {
+ "desc": "The ID of a pattern of a collectible gift \u00bb.",
+ "params": {
+ "document_id": "The sticker representing the symbol"
+ }
+ },
+ "StarGiftAttributeModel": {
+ "desc": "The model of a collectible gift \u00bb.",
+ "params": {
+ "document": "The sticker representing the upgraded gift",
+ "name": "Name of the model",
+ "rarity_permille": "The number of upgraded gifts that receive this backdrop for each 1000 gifts upgraded."
+ }
+ },
+ "StarGiftAttributeOriginalDetails": {
+ "desc": "Info about the sender, receiver and message attached to the original gift \u00bb, before it was upgraded to a collectible gift \u00bb.",
+ "params": {
+ "date": "When was the gift sent.",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Original message attached to the gift, if present.",
+ "recipient_id": "Original receiver of the gift.",
+ "sender_id": "Original sender of the gift, absent if the gift was private."
+ }
+ },
+ "StarGiftAttributePattern": {
+ "desc": "A sticker applied on the backdrop of a collectible gift \u00bb using a repeating pattern.",
+ "params": {
+ "document": "The symbol",
+ "name": "Name of the symbol",
+ "rarity_permille": "The number of upgraded gifts that receive this backdrop for each 1000 gifts upgraded."
+ }
+ },
+ "StarGiftCollection": {
+ "desc": "Represents a star gift collection \u00bb.",
+ "params": {
+ "collection_id": "The ID of the collection.",
+ "flags": "Flags, see TL conditional fields",
+ "gifts_count": "Number of gifts in the collection.",
+ "hash": "Field to use instead of collection_id when generating the hash to pass to payments.getStarGiftCollections.",
+ "icon": "Optional icon for the collection, taken from the first gift in the collection.",
+ "title": "Title of the collection."
+ }
+ },
+ "StarGiftUnique": {
+ "desc": "Represents a collectible star gift, see here \u00bb for more info.",
+ "params": {
+ "attributes": "Collectible attributes",
+ "availability_issued": "Total number of gifts of the same type that were upgraded to a collectible gift.",
+ "availability_total": "Total number of gifts of the same type that can be upgraded or were already upgraded to a collectible gift.",
+ "flags": "Flags, see TL conditional fields",
+ "gift_address": "For NFTs on the TON blockchain, contains the address of the NFT (append it to the ton_blockchain_explorer_url client configuration value \u00bb to obtain a link with information about the address).",
+ "gift_id": "Unique ID of the gift.",
+ "id": "Identifier of the collectible gift.",
+ "num": "Unique identifier of this collectible gift among all (already upgraded) collectible gifts of the same type.",
+ "owner_address": "For NFTs on the TON blockchain, contains the address of the owner (append it to the ton_blockchain_explorer_url client configuration value \u00bb to obtain a link with information about the address).",
+ "owner_id": "The owner of the gift.",
+ "owner_name": "The name of the owner if neither owner_id nor owner_address are set.",
+ "released_by": "This gift was released by the specified peer.",
+ "require_premium": "This gift can only be bought by users with a Premium subscription.",
+ "resale_ton_only": "Whether the gift can be bought only using Toncoins.",
+ "resell_amount": "Resale price of the gift.",
+ "slug": "Slug that can be used to create a collectible gift deep link \u00bb, or elsewhere in the API where a collectible slug is accepted.",
+ "theme_available": "A chat theme associated to this gift is available, see here \u00bb for more info on how to use it.",
+ "theme_peer": "The current chat where the associated chat theme is installed, if any (gift-based themes can only be installed in one chat at a time).",
+ "title": "Collectible title.",
+ "value_amount": "Price of the gift.",
+ "value_currency": "Currency for the gift's price."
+ }
+ },
+ "StarGiftUpgradePreview": {
+ "desc": "",
+ "params": {}
+ },
+ "StarGiftUpgradePrice": {
+ "desc": "",
+ "params": {}
+ },
+ "StarRefProgram": {
+ "desc": "Indo about an affiliate program offered by a bot",
+ "params": {
+ "bot_id": "ID of the bot that offers the program",
+ "commission_permille": "An affiliate gets a commission of starRefProgram.commission_permille\u2030 Telegram Stars for every mini app transaction made by users they refer",
+ "daily_revenue_per_user": "The amount of daily revenue per user in Telegram Stars of the bot that created the affiliate program. To obtain the approximated revenue per referred user, multiply this value by commission_permille and divide by 1000.",
+ "duration_months": "An affiliate gets a commission for every mini app transaction made by users they refer, for duration_months months after a referral link is imported, starting the bot for the first time",
+ "end_date": "Point in time (Unix timestamp) when the affiliate program will be closed (optional, if not set the affiliate program isn't scheduled to be closed)",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "StarsAmount": {
+ "desc": "Describes a real (i.e. possibly decimal) amount of Telegram Stars.",
+ "params": {
+ "amount": "The integer amount of Telegram Stars.",
+ "nanos": "The decimal amount of Telegram Stars, expressed as nanostars (i.e. 1 nanostar is equal to 1/1'000'000'000th (one billionth) of a Telegram Star). This field may also be negative (the allowed range is -999999999 to 999999999)."
+ }
+ },
+ "StarsGiftOption": {
+ "desc": "Telegram Stars gift option.",
+ "params": {
+ "amount": "Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "currency": "Three-letter ISO 4217 currency code",
+ "extended": "If set, the option must only be shown in the full list of topup options.",
+ "flags": "Flags, see TL conditional fields",
+ "stars": "Amount of Telegram stars.",
+ "store_product": "Identifier of the store product associated with the option, official apps only."
+ }
+ },
+ "StarsGiveawayOption": {
+ "desc": "Contains info about a Telegram Star giveaway option.",
+ "params": {
+ "amount": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "currency": "Three-letter ISO 4217 currency code",
+ "default": "If set, this option must be pre-selected by default in the option list.",
+ "extended": "If set, this option must only be shown in the full list of giveaway options (i.e. they must be added to the list only when the user clicks on the expand button).",
+ "flags": "Flags, see TL conditional fields",
+ "stars": "The number of Telegram Stars that will be distributed among winners",
+ "store_product": "Identifier of the store product associated with the option, official apps only.",
+ "winners": "Allowed options for the number of giveaway winners.",
+ "yearly_boosts": "Number of times the chat will be boosted for one year if the inputStorePaymentStarsGiveaway.boost_peer flag is populated"
+ }
+ },
+ "StarsGiveawayWinnersOption": {
+ "desc": "Allowed options for the number of giveaway winners.",
+ "params": {
+ "default": "If set, this option must be pre-selected by default in the option list.",
+ "flags": "Flags, see TL conditional fields",
+ "per_user_stars": "The number of Telegram Stars each winner will receive.",
+ "users": "The number of users that will be randomly chosen as winners."
+ }
+ },
+ "StarsRating": {
+ "desc": "Represents the profile's star rating, see here \u00bb for more info.",
+ "params": {
+ "current_level_stars": "The numerical value of the rating required for the current level.",
+ "flags": "Flags, see TL conditional fields",
+ "level": "The current level, may be negative.",
+ "next_level_stars": "The numerical value of the rating required for the next level.",
+ "stars": "Numerical value of the current rating."
+ }
+ },
+ "StarsRevenueStatus": {
+ "desc": "Describes Telegram Star revenue balances \u00bb.",
+ "params": {
+ "available_balance": "Amount of withdrawable Telegram Stars.",
+ "current_balance": "Amount of not-yet-withdrawn Telegram Stars.",
+ "flags": "Flags, see TL conditional fields",
+ "next_withdrawal_at": "Unixtime indicating when will withdrawal be available to the user. If not set, withdrawal can be started now.",
+ "overall_revenue": "Total amount of earned Telegram Stars.",
+ "withdrawal_enabled": "If set, the user may withdraw up to available_balance stars."
+ }
+ },
+ "StarsSubscription": {
+ "desc": "Represents a Telegram Star subscription \u00bb.",
+ "params": {
+ "bot_canceled": "Set if this bot subscription was cancelled by the bot",
+ "can_refulfill": "Whether we left the associated private channel, but we can still rejoin it using payments.fulfillStarsSubscription because the current subscription period hasn't expired yet.",
+ "canceled": "Whether this subscription was cancelled.",
+ "chat_invite_hash": "Invitation link, used to renew the subscription after cancellation or expiration.",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Subscription ID.",
+ "invoice_slug": "For bot subscriptions, the identifier of the subscription invoice",
+ "missing_balance": "Whether this subscription has expired because there are not enough stars on the user's balance to extend it.",
+ "peer": "Identifier of the associated private chat.",
+ "photo": "For bot subscriptions, the photo from the subscription invoice",
+ "pricing": "Pricing of the subscription in Telegram Stars.",
+ "title": "For bot subscriptions, the title of the subscription invoice",
+ "until_date": "Expiration date of the current subscription period."
+ }
+ },
+ "StarsSubscriptionPricing": {
+ "desc": "Pricing of a Telegram Star subscription \u00bb.",
+ "params": {
+ "amount": "Price of the subscription in Telegram Stars.",
+ "period": "The user should pay amount stars every period seconds to gain and maintain access to the channel. Currently the only allowed subscription period is 30*24*60*60, i.e. the user will be debited amount stars every month."
+ }
+ },
+ "StarsTonAmount": {
+ "desc": "Describes an amount of toncoin in nanotons (i.e. 1/1_000_000_000 of a toncoin).",
+ "params": {
+ "amount": "The amount in nanotons."
+ }
+ },
+ "StarsTopupOption": {
+ "desc": "Telegram Stars topup option.",
+ "params": {
+ "amount": "Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "currency": "Three-letter ISO 4217 currency code",
+ "extended": "If set, the option must only be shown in the full list of topup options.",
+ "flags": "Flags, see TL conditional fields",
+ "stars": "Amount of Telegram stars.",
+ "store_product": "Identifier of the store product associated with the option, official apps only."
+ }
+ },
+ "StarsTransaction": {
+ "desc": "Represents a Telegram Stars or TON transaction \u00bb.",
+ "params": {
+ "ads_proceeds_from_date": "Indicates that this is payment for ad revenue from the specified unixtime (always set together with ads_proceeds_to_date).",
+ "ads_proceeds_to_date": "Indicates that this is payment for ad revenue to the specified unixtime.",
+ "amount": "Amount of Telegram Stars or TON.",
+ "bot_payload": "Bot specified invoice payload (i.e. the payload passed to inputMediaInvoice when creating the invoice).",
+ "business_transfer": "This transaction transfers stars from the balance of a user account connected to a business bot, to the balance of the business bot, see here \u00bb for more info.",
+ "date": "Date of the transaction (unixtime).",
+ "description": "For transactions with bots, description of the bought product.",
+ "extended_media": "The purchased paid media \u00bb.",
+ "failed": "This transaction has failed.",
+ "flags": "Flags, see TL conditional fields",
+ "floodskip_number": "This transaction is payment for paid bot broadcasts. Paid broadcasts are only allowed if the allow_paid_floodskip parameter of messages.sendMessage and other message sending methods is set while trying to broadcast more than 30 messages per second to bot users. The integer value returned by this flag indicates the number of billed API calls.",
+ "gift": "This transaction was a gift from the user in peer.peer.",
+ "giveaway_post_id": "ID of the message containing the messageMediaGiveaway, for incoming star giveaway prizes.",
+ "id": "Transaction ID.",
+ "msg_id": "For paid media transactions \u00bb, message ID of the paid media posted to peer.peer (can point to a deleted message; either way, extended_media will always contain the bought media).",
+ "paid_messages": "This transaction is related to the reception or transmission of a paid message \u00bb.",
+ "peer": "Source of the incoming transaction, or its recipient for outgoing transactions.",
+ "pending": "The transaction is currently pending.",
+ "photo": "For transactions with bots, photo of the bought product.",
+ "posts_search": "Represents payment for a paid global post search \u00bb.",
+ "premium_gift_months": "This transaction indicates the payment for a gifted Telegram Premium subscription \u00bb.",
+ "reaction": "This transaction is a paid reaction \u00bb.",
+ "refund": "Whether this transaction is a refund.",
+ "stargift": "This transaction indicates a purchase or a sale (conversion back to Stars) of a gift \u00bb.",
+ "stargift_prepaid_upgrade": "Represents payment for a separate prepaid upgrade of a gift.",
+ "stargift_resale": "This transaction is related to the resale of a collectible gift \u00bb.",
+ "stargift_upgrade": "This transaction pays for the upgrade of a gift to a collectible gift \u00bb.",
+ "starref_amount": "For transactions made by referred users, the amount of Telegram Stars received by the affiliate, can be negative for refunds.",
+ "starref_commission_permille": "This transaction is the receival (or refund) of an affiliate commission (i.e. this is the transaction received by the peer that created the referral link, flag 17 is for transactions made by users that imported the referral link).",
+ "starref_peer": "For transactions made by referred users, the peer that received the affiliate commission.",
+ "subscription_period": "The number of seconds between consecutive Telegram Star debiting for Telegram Star subscriptions \u00bb.",
+ "title": "For transactions with bots, title of the bought product.",
+ "transaction_date": "If neither pending nor failed are set, the transaction was completed successfully, and this field will contain the point in time (Unix timestamp) when the withdrawal was completed successfully.",
+ "transaction_url": "If neither pending nor failed are set, the transaction was completed successfully, and this field will contain a URL where the withdrawal transaction can be viewed."
+ }
+ },
+ "StarsTransactionPeer": {
+ "desc": "Describes a Telegram Star transaction with another peer.",
+ "params": {
+ "peer": "The peer."
+ }
+ },
+ "StarsTransactionPeerAPI": {
+ "desc": "Describes a Telegram Star transaction used to pay for paid API usage, such as paid bot broadcasts.",
+ "params": {}
+ },
+ "StarsTransactionPeerAds": {
+ "desc": "Describes a Telegram Star transaction used to pay for Telegram ads as specified here \u00bb.",
+ "params": {}
+ },
+ "StarsTransactionPeerAppStore": {
+ "desc": "Describes a Telegram Star transaction with the App Store, used when purchasing Telegram Stars through the App Store.",
+ "params": {}
+ },
+ "StarsTransactionPeerFragment": {
+ "desc": "Describes a Telegram Star transaction with Fragment, used when purchasing Telegram Stars through Fragment.",
+ "params": {}
+ },
+ "StarsTransactionPeerPlayMarket": {
+ "desc": "Describes a Telegram Star transaction with the Play Store, used when purchasing Telegram Stars through the Play Store.",
+ "params": {}
+ },
+ "StarsTransactionPeerPremiumBot": {
+ "desc": "Describes a Telegram Star transaction made using @PremiumBot (i.e. using the inputInvoiceStars flow described here \u00bb).",
+ "params": {}
+ },
+ "StarsTransactionPeerUnsupported": {
+ "desc": "Describes a Telegram Star transaction that cannot be described using the current layer.",
+ "params": {}
+ },
+ "StatsAbsValueAndPrev": {
+ "desc": "Statistics value couple; initial and final value for period of time currently in consideration",
+ "params": {
+ "current": "Current value",
+ "previous": "Previous value"
+ }
+ },
+ "StatsDateRangeDays": {
+ "desc": "Channel statistics date range",
+ "params": {
+ "max_date": "Final date",
+ "min_date": "Initial date"
+ }
+ },
+ "StatsGraph": {
+ "desc": "Channel statistics graph",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "json": "Statistics data",
+ "zoom_token": "Zoom token"
+ }
+ },
+ "StatsGraphAsync": {
+ "desc": "This channel statistics graph must be generated asynchronously using stats.loadAsyncGraph to reduce server load",
+ "params": {
+ "token": "Token to use for fetching the async graph"
+ }
+ },
+ "StatsGraphError": {
+ "desc": "An error occurred while generating the statistics graph",
+ "params": {
+ "error": "The error"
+ }
+ },
+ "StatsGroupTopAdmin": {
+ "desc": "Information about an active admin in a supergroup",
+ "params": {
+ "banned": "Number of banned users for statistics period in consideration",
+ "deleted": "Number of deleted messages for statistics period in consideration",
+ "kicked": "Number of kicked users for statistics period in consideration",
+ "user_id": "User ID"
+ }
+ },
+ "StatsGroupTopInviter": {
+ "desc": "Information about an active supergroup inviter",
+ "params": {
+ "invitations": "Number of invitations for statistics period in consideration",
+ "user_id": "User ID"
+ }
+ },
+ "StatsGroupTopPoster": {
+ "desc": "Information about an active user in a supergroup",
+ "params": {
+ "avg_chars": "Average number of characters per message",
+ "messages": "Number of messages for statistics period in consideration",
+ "user_id": "User ID"
+ }
+ },
+ "StatsPercentValue": {
+ "desc": "Channel statistics percentage.\nCompute the percentage simply by doing part * total / 100",
+ "params": {
+ "part": "Partial value",
+ "total": "Total value"
+ }
+ },
+ "StatsURL": {
+ "desc": "URL with chat statistics",
+ "params": {
+ "url": "Chat statistics"
+ }
+ },
+ "StickerKeyword": {
+ "desc": "Keywords for a certain sticker",
+ "params": {
+ "document_id": "Sticker ID",
+ "keyword": "Keywords"
+ }
+ },
+ "StickerPack": {
+ "desc": "A stickerpack is a group of stickers associated to the same emoji.\nIt is not a sticker pack the way it is usually intended, you may be looking for a StickerSet.",
+ "params": {
+ "documents": "Stickers",
+ "emoticon": "Emoji"
+ }
+ },
+ "StickerSet": {
+ "desc": "Represents a stickerset (stickerpack)",
+ "params": {
+ "access_hash": "Access hash of stickerset",
+ "archived": "Whether this stickerset was archived (due to too many saved stickers in the current account)",
+ "channel_emoji_status": "If set, this custom emoji stickerset can be used in channel/supergroup emoji statuses.",
+ "count": "Number of stickers in pack",
+ "creator": "Whether we created this stickerset",
+ "emojis": "This is a custom emoji stickerset",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash",
+ "id": "ID of the stickerset",
+ "installed_date": "When was this stickerset installed",
+ "masks": "Is this a mask stickerset",
+ "official": "Is this stickerset official",
+ "short_name": "Short name of stickerset, used when sharing stickerset using stickerset deep links.",
+ "text_color": "Whether the color of this TGS custom emoji stickerset should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context.",
+ "thumb_dc_id": "DC ID of thumbnail",
+ "thumb_document_id": "Document ID of custom emoji thumbnail, fetch the document using messages.getCustomEmojiDocuments",
+ "thumb_version": "Thumbnail version",
+ "thumbs": "Stickerset thumbnail",
+ "title": "Title of stickerset"
+ }
+ },
+ "StickerSetCovered": {
+ "desc": "Stickerset with a single sticker as preview",
+ "params": {
+ "cover": "Preview",
+ "set": "Stickerset"
+ }
+ },
+ "StickerSetFullCovered": {
+ "desc": "Stickerset preview with all stickers of the stickerset included.\nCurrently used only for custom emoji stickersets, to avoid a further call to messages.getStickerSet.",
+ "params": {
+ "documents": "Stickers",
+ "keywords": "Keywords for some or every sticker in the stickerset.",
+ "packs": "Emoji information about every sticker in the stickerset",
+ "set": "Stickerset"
+ }
+ },
+ "StickerSetMultiCovered": {
+ "desc": "Stickerset, with multiple stickers as preview",
+ "params": {
+ "covers": "Preview stickers",
+ "set": "Stickerset"
+ }
+ },
+ "StickerSetNoCovered": {
+ "desc": "Just the stickerset information, with no previews.",
+ "params": {
+ "set": "Stickerset information."
+ }
+ },
+ "StoriesStealthMode": {
+ "desc": "Information about the current stealth mode session.",
+ "params": {
+ "active_until_date": "The date up to which stealth mode will be active.",
+ "cooldown_until_date": "The date starting from which the user will be allowed to re-enable stealth mode again.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "StoryAlbum": {
+ "desc": "Represents a story album \u00bb.",
+ "params": {
+ "album_id": "ID of the album.",
+ "flags": "Flags, see TL conditional fields",
+ "icon_photo": "Photo from the first story of the album, if it's a photo.",
+ "icon_video": "Video from the first story of the album, if it's a video.",
+ "title": "Name of the album."
+ }
+ },
+ "StoryFwdHeader": {
+ "desc": "Contains info about the original poster of a reposted story.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "from": "Peer that originally posted the story; will be empty for stories forwarded from a user with forwards privacy enabled, in which case from_name will be set, instead.",
+ "from_name": "Will be set for stories forwarded from a user with forwards privacy enabled, in which case from will also be empty.",
+ "modified": "Whether the story media was modified before reposting it (for example by overlaying a round video with a reaction).",
+ "story_id": ", contains the story ID"
+ }
+ },
+ "StoryItem": {
+ "desc": "Represents a story.",
+ "params": {
+ "albums": "Albums this story is part of.",
+ "caption": "Story caption.",
+ "close_friends": "Whether this story can only be viewed by our close friends, see here \u00bb for more info",
+ "contacts": "Whether this story can only be viewed by our contacts",
+ "date": "When was the story posted.",
+ "edited": "Indicates whether the story was edited.",
+ "entities": "Message entities for styled text",
+ "expire_date": "When does the story expire.",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "Sender of the story.",
+ "fwd_from": "For reposted stories \u00bb, contains info about the original story.",
+ "id": "ID of the story.",
+ "media": "Story media.",
+ "media_areas": "List of media areas, see here \u00bb for more info on media areas.",
+ "min": "Full information about this story was omitted for space and performance reasons; use stories.getStoriesByID to fetch full info about this story when and if needed.",
+ "noforwards": "Whether this story is protected and thus cannot be forwarded; clients should also prevent users from saving attached media (i.e. videos should only be streamed, photos should be kept in RAM, et cetera).",
+ "out": "indicates whether we sent this story.",
+ "pinned": "Whether this story is pinned on the user's profile",
+ "privacy": "Privacy rules indicating who can and can't view this story",
+ "public": "Whether this story is public and can be viewed by everyone",
+ "selected_contacts": "Whether this story can only be viewed by a select list of our contacts",
+ "sent_reaction": "The reaction we sent.",
+ "views": "View date and reaction information"
+ }
+ },
+ "StoryItemDeleted": {
+ "desc": "Represents a previously active story, that was deleted",
+ "params": {
+ "id": "Story ID"
+ }
+ },
+ "StoryItemSkipped": {
+ "desc": "Represents an active story, whose full information was omitted for space and performance reasons; use stories.getStoriesByID to fetch full info about the skipped story when and if needed.",
+ "params": {
+ "close_friends": "Whether this story can only be viewed by our close friends, see here \u00bb for more info",
+ "date": "When was the story posted.",
+ "expire_date": "When does the story expire.",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Story ID"
+ }
+ },
+ "StoryReaction": {
+ "desc": "How a certain peer reacted to a story",
+ "params": {
+ "date": "Reaction date",
+ "peer_id": "The peer",
+ "reaction": "The reaction"
+ }
+ },
+ "StoryReactionPublicForward": {
+ "desc": "A certain peer has forwarded the story as a message to a public chat or channel.",
+ "params": {
+ "message": "The message with the forwarded story."
+ }
+ },
+ "StoryReactionPublicRepost": {
+ "desc": "A certain peer has reposted the story.",
+ "params": {
+ "peer_id": "The peer that reposted the story.",
+ "story": "The reposted story."
+ }
+ },
+ "StoryView": {
+ "desc": "Story view date and reaction information",
+ "params": {
+ "blocked": "Whether we have completely blocked this user, including from viewing more of our stories.",
+ "blocked_my_stories_from": "Whether we have blocked this user from viewing more of our stories.",
+ "date": "When did the user view the story",
+ "flags": "Flags, see TL conditional fields",
+ "reaction": "If present, contains the reaction that the user left on the story",
+ "user_id": "The user that viewed the story"
+ }
+ },
+ "StoryViewPublicForward": {
+ "desc": "A certain peer has forwarded the story as a message to a public chat or channel.",
+ "params": {
+ "blocked": "Whether we have completely blocked this user, including from viewing more of our stories.",
+ "blocked_my_stories_from": "Whether we have blocked this user from viewing more of our stories.",
+ "flags": "Flags, see TL conditional fields",
+ "message": "The message with the forwarded story."
+ }
+ },
+ "StoryViewPublicRepost": {
+ "desc": "A certain peer has reposted the story.",
+ "params": {
+ "blocked": "Whether we have completely blocked this user, including from viewing more of our stories.",
+ "blocked_my_stories_from": "Whether we have blocked this user from viewing more of our stories.",
+ "flags": "Flags, see TL conditional fields",
+ "peer_id": "The peer that reposted the story.",
+ "story": "The reposted story."
+ }
+ },
+ "StoryViews": {
+ "desc": "Aggregated view and reaction information of a story.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "forwards_count": "Forward counter of the story",
+ "has_viewers": "If set, indicates that the viewers list is currently viewable, and was not yet deleted because the story has expired while the user didn't have a Premium account.",
+ "reactions": "All reactions sent to this story",
+ "reactions_count": "Number of reactions added to the story",
+ "recent_viewers": "User IDs of some recent viewers of the story",
+ "views_count": "View counter of the story"
+ }
+ },
+ "SuggestedPost": {
+ "desc": "Contains info about a suggested post \u00bb.",
+ "params": {
+ "accepted": "Whether the suggested post was accepted.",
+ "flags": "Flags, see TL conditional fields",
+ "price": "Price of the suggested post.",
+ "rejected": "Whether the suggested post was rejected.",
+ "schedule_date": "Scheduling date."
+ }
+ },
+ "TextAnchor": {
+ "desc": "Text linking to another section of the page",
+ "params": {
+ "name": "Section name",
+ "text": "Text"
+ }
+ },
+ "TextBold": {
+ "desc": "Bold text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextConcat": {
+ "desc": "Concatenation of rich texts",
+ "params": {
+ "texts": "Concatenated rich texts"
+ }
+ },
+ "TextEmail": {
+ "desc": "Rich text email link",
+ "params": {
+ "email": "Email address",
+ "text": "Link text"
+ }
+ },
+ "TextEmpty": {
+ "desc": "Empty rich text element",
+ "params": {}
+ },
+ "TextFixed": {
+ "desc": "fixed-width rich text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextImage": {
+ "desc": "Inline image",
+ "params": {
+ "document_id": "Document ID",
+ "h": "Height",
+ "w": "Width"
+ }
+ },
+ "TextItalic": {
+ "desc": "Italic text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextMarked": {
+ "desc": "Highlighted text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextPhone": {
+ "desc": "Rich text linked to a phone number",
+ "params": {
+ "phone": "Phone number",
+ "text": "Text"
+ }
+ },
+ "TextPlain": {
+ "desc": "Plain text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextStrike": {
+ "desc": "Strikethrough text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextSubscript": {
+ "desc": "Subscript text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextSuperscript": {
+ "desc": "Superscript text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextUnderline": {
+ "desc": "Underlined text",
+ "params": {
+ "text": "Text"
+ }
+ },
+ "TextUrl": {
+ "desc": "Link",
+ "params": {
+ "text": "Text of link",
+ "url": "Webpage HTTP URL",
+ "webpage_id": "If a preview was already generated for the page, the page ID"
+ }
+ },
+ "TextWithEntities": {
+ "desc": "Styled text with message entities",
+ "params": {
+ "entities": "Message entities for styled text",
+ "text": "Text"
+ }
+ },
+ "Theme": {
+ "desc": "Theme",
+ "params": {
+ "access_hash": "Theme access hash",
+ "creator": "Whether the current user is the creator of this theme",
+ "default": "Whether this is the default theme",
+ "document": "Theme",
+ "emoticon": "Theme emoji",
+ "flags": "Flags, see TL conditional fields",
+ "for_chat": "Whether this theme is meant to be used as a chat theme",
+ "id": "Theme ID",
+ "installs_count": "Installation count",
+ "settings": "Theme settings",
+ "slug": "Unique theme ID",
+ "title": "Theme name"
+ }
+ },
+ "ThemeSettings": {
+ "desc": "Theme settings",
+ "params": {
+ "accent_color": "Accent color, ARGB format",
+ "base_theme": "Base theme",
+ "flags": "Flags, see TL conditional fields",
+ "message_colors": "The fill to be used as a background for outgoing messages, in RGB24 format. If just one or two equal colors are provided, describes a solid fill of a background. If two different colors are provided, describes the top and bottom colors of a 0-degree gradient.If three or four colors are provided, describes a freeform gradient fill of a background.",
+ "message_colors_animated": "If set, the freeform gradient fill needs to be animated on every sent message.",
+ "outbox_accent_color": "Accent color of outgoing messages in ARGB format",
+ "wallpaper": "Wallpaper"
+ }
+ },
+ "Timezone": {
+ "desc": "Timezone information.",
+ "params": {
+ "id": "Unique timezone ID.",
+ "name": "Human-readable and localized timezone name.",
+ "utc_offset": "UTC offset in seconds, which may be displayed in hh:mm format by the client together with the human-readable name (i.e. $name UTC -01:00)."
+ }
+ },
+ "TodoCompletion": {
+ "desc": "A completed todo list \u00bb item.",
+ "params": {
+ "completed_by": "ID of the user that completed the item.",
+ "date": "When was the item completed.",
+ "id": "The ID of the completed item."
+ }
+ },
+ "TodoItem": {
+ "desc": "An item of a todo list \u00bb.",
+ "params": {
+ "id": "ID of the item, a positive (non-zero) integer unique within the current list.",
+ "title": "Text of the item, maximum length equal to todo_item_length_max \u00bb."
+ }
+ },
+ "TodoList": {
+ "desc": "Represents a todo list \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "list": "Items of the list.",
+ "others_can_append": "If set, users different from the creator of the list can append items to the list.",
+ "others_can_complete": "If set, users different from the creator of the list can complete items in the list.",
+ "title": "Title of the todo list, maximum length equal to todo_title_length_max \u00bb."
+ }
+ },
+ "TopPeer": {
+ "desc": "Top peer",
+ "params": {
+ "peer": "Peer",
+ "rating": "Rating as computed in top peer rating \u00bb"
+ }
+ },
+ "TopPeerCategoryBotsApp": {
+ "desc": "Most frequently used Main Mini Bot Apps.",
+ "params": {}
+ },
+ "TopPeerCategoryBotsInline": {
+ "desc": "Most used inline bots",
+ "params": {}
+ },
+ "TopPeerCategoryBotsPM": {
+ "desc": "Most used bots",
+ "params": {}
+ },
+ "TopPeerCategoryChannels": {
+ "desc": "Most frequently visited channels",
+ "params": {}
+ },
+ "TopPeerCategoryCorrespondents": {
+ "desc": "Users we've chatted most frequently with",
+ "params": {}
+ },
+ "TopPeerCategoryForwardChats": {
+ "desc": "Chats to which the users often forwards messages to",
+ "params": {}
+ },
+ "TopPeerCategoryForwardUsers": {
+ "desc": "Users to which the users often forwards messages to",
+ "params": {}
+ },
+ "TopPeerCategoryGroups": {
+ "desc": "Often-opened groups and supergroups",
+ "params": {}
+ },
+ "TopPeerCategoryPeers": {
+ "desc": "Top peer category",
+ "params": {
+ "category": "Top peer category of peers",
+ "count": "Count of peers",
+ "peers": "Peers"
+ }
+ },
+ "TopPeerCategoryPhoneCalls": {
+ "desc": "Most frequently called users",
+ "params": {}
+ },
+ "UpdateAttachMenuBots": {
+ "desc": "The list of installed attachment menu entries \u00bb has changed, use messages.getAttachMenuBots to fetch the updated list.",
+ "params": {}
+ },
+ "UpdateAutoSaveSettings": {
+ "desc": "Media autosave settings have changed and must be refetched using account.getAutoSaveSettings.",
+ "params": {}
+ },
+ "UpdateBotBusinessConnect": {
+ "desc": "Connecting or disconnecting a business bot or changing the connection settings will emit an updateBotBusinessConnect update to the bot, with the new settings and a connection_id that will be used by the bot to handle updates from and send messages as the user.",
+ "params": {
+ "connection": "Business connection settings",
+ "qts": "New qts value, see updates \u00bb for more info."
+ }
+ },
+ "UpdateBotCallbackQuery": {
+ "desc": "A callback button was pressed, and the button data was sent to the bot that created the button",
+ "params": {
+ "chat_instance": "Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.",
+ "data": "Callback data",
+ "flags": "Flags, see TL conditional fields",
+ "game_short_name": "Short name of a Game to be returned, serves as the unique identifier for the game",
+ "msg_id": "Message ID",
+ "peer": "Chat where the inline keyboard was sent",
+ "query_id": "Query ID",
+ "user_id": "ID of the user that pressed the button"
+ }
+ },
+ "UpdateBotChatBoost": {
+ "desc": "A channel/supergroup boost has changed (bots only)",
+ "params": {
+ "boost": "New boost information",
+ "peer": "Channel",
+ "qts": "QTS event sequence identifier"
+ }
+ },
+ "UpdateBotChatInviteRequester": {
+ "desc": "Someone has requested to join a chat or channel (bots only, users will receive an updatePendingJoinRequests, instead)",
+ "params": {
+ "about": "Bio of the user",
+ "date": "When was the join request \u00bb made",
+ "invite": "Chat invite link that was used by the user to send the join request \u00bb",
+ "peer": "The chat or channel in question",
+ "qts": "QTS event sequence identifier",
+ "user_id": "The user ID that is asking to join the chat or channel"
+ }
+ },
+ "UpdateBotCommands": {
+ "desc": "The command set of a certain bot in a certain chat has changed.",
+ "params": {
+ "bot_id": "ID of the bot that changed its command set",
+ "commands": "New bot commands",
+ "peer": "The affected chat"
+ }
+ },
+ "UpdateBotDeleteBusinessMessage": {
+ "desc": "A message was deleted in a connected business chat \u00bb.",
+ "params": {
+ "connection_id": "Business connection ID.",
+ "messages": "IDs of the messages that were deleted.",
+ "peer": "Peer where the messages were deleted.",
+ "qts": "New qts value, see updates \u00bb for more info."
+ }
+ },
+ "UpdateBotEditBusinessMessage": {
+ "desc": "A message was edited in a connected business chat \u00bb.",
+ "params": {
+ "connection_id": "Business connection ID",
+ "flags": "Flags, see TL conditional fields",
+ "message": "New message.",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "reply_to_message": "The message that message is replying to."
+ }
+ },
+ "UpdateBotInlineQuery": {
+ "desc": "An incoming inline query",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "geo": "Attached geolocation",
+ "offset": "Offset to navigate through results",
+ "peer_type": "Type of the chat from which the inline query was sent.",
+ "query": "Text of query",
+ "query_id": "Query ID",
+ "user_id": "User that sent the query"
+ }
+ },
+ "UpdateBotInlineSend": {
+ "desc": "The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "geo": "Optional. Sender location, only for bots that require user location",
+ "id": "The unique identifier for the result that was chosen",
+ "msg_id": "Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.",
+ "query": "The query that was used to obtain the result",
+ "user_id": "The user that chose the result"
+ }
+ },
+ "UpdateBotMenuButton": {
+ "desc": "The menu button behavior for the specified bot has changed",
+ "params": {
+ "bot_id": "Bot ID",
+ "button": "New menu button"
+ }
+ },
+ "UpdateBotMessageReaction": {
+ "desc": "Bots only: a user has changed their reactions on a message with public reactions.",
+ "params": {
+ "actor": "The user that (un)reacted to the message.",
+ "date": "Date of the change.",
+ "msg_id": "ID of the reacted-to message.",
+ "new_reactions": "New reactions",
+ "old_reactions": "Old reactions",
+ "peer": "Peer of the reacted-to message.",
+ "qts": "QTS event sequence identifier"
+ }
+ },
+ "UpdateBotMessageReactions": {
+ "desc": "Bots only: the number of reactions on a message with anonymous reactions has changed.",
+ "params": {
+ "date": "Date of the change.",
+ "msg_id": "ID of the reacted-to message.",
+ "peer": "Peer of the reacted-to message.",
+ "qts": "QTS event sequence identifier",
+ "reactions": "New reaction counters."
+ }
+ },
+ "UpdateBotNewBusinessMessage": {
+ "desc": "A message was received via a connected business chat \u00bb.",
+ "params": {
+ "connection_id": "Connection ID.",
+ "flags": "Flags, see TL conditional fields",
+ "message": "New message.",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "reply_to_message": "The message that message is replying to."
+ }
+ },
+ "UpdateBotPrecheckoutQuery": {
+ "desc": "This object contains information about an incoming pre-checkout query.",
+ "params": {
+ "currency": "Three-letter ISO 4217 currency code, or XTR for Telegram Stars.",
+ "flags": "Flags, see TL conditional fields",
+ "info": "Order info provided by the user",
+ "payload": "Bot specified invoice payload",
+ "query_id": "Unique query identifier",
+ "shipping_option_id": "Identifier of the shipping option chosen by the user",
+ "total_amount": "Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "user_id": "User who sent the query"
+ }
+ },
+ "UpdateBotPurchasedPaidMedia": {
+ "desc": "Bots only: a user has purchased a paid media.",
+ "params": {
+ "payload": "Payload passed by the bot in inputMediaPaidMedia.payload",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "user_id": "The user that bought the media"
+ }
+ },
+ "UpdateBotShippingQuery": {
+ "desc": "This object contains information about an incoming shipping query.",
+ "params": {
+ "payload": "Bot specified invoice payload",
+ "query_id": "Unique query identifier",
+ "shipping_address": "User specified shipping address",
+ "user_id": "User who sent the query"
+ }
+ },
+ "UpdateBotStopped": {
+ "desc": "A bot was stopped or re-started.",
+ "params": {
+ "date": "When did this action occur",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "stopped": "Whether the bot was stopped or started",
+ "user_id": "The user ID"
+ }
+ },
+ "UpdateBotSubscriptionExpire": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdateBotWebhookJSON": {
+ "desc": "A new incoming event; for bots only",
+ "params": {
+ "data": "The event"
+ }
+ },
+ "UpdateBotWebhookJSONQuery": {
+ "desc": "A new incoming query; for bots only",
+ "params": {
+ "data": "Query data",
+ "query_id": "Query identifier",
+ "timeout": "Query timeout"
+ }
+ },
+ "UpdateBusinessBotCallbackQuery": {
+ "desc": "A callback button sent via a business connection was pressed, and the button data was sent to the bot that created the button.",
+ "params": {
+ "chat_instance": "Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.",
+ "connection_id": "Business connection ID",
+ "data": "Callback data",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Message that contains the keyboard (also contains info about the chat where the message was sent).",
+ "query_id": "Query ID",
+ "reply_to_message": "The message that message is replying to.",
+ "user_id": "ID of the user that pressed the button"
+ }
+ },
+ "UpdateChannel": {
+ "desc": "Channel/supergroup (channel and/or channelFull) information was updated.",
+ "params": {
+ "channel_id": "Channel ID"
+ }
+ },
+ "UpdateChannelAvailableMessages": {
+ "desc": "The history of a channel/supergroup was hidden.",
+ "params": {
+ "available_min_id": "Identifier of a maximum unavailable message in a channel due to hidden history.",
+ "channel_id": "Channel/supergroup ID"
+ }
+ },
+ "UpdateChannelMessageForwards": {
+ "desc": "The forward counter of a message in a channel has changed",
+ "params": {
+ "channel_id": "Channel ID",
+ "forwards": "New forward counter",
+ "id": "ID of the message"
+ }
+ },
+ "UpdateChannelMessageViews": {
+ "desc": "The view counter of a message in a channel has changed",
+ "params": {
+ "channel_id": "Channel ID",
+ "id": "ID of the message",
+ "views": "New view counter"
+ }
+ },
+ "UpdateChannelParticipant": {
+ "desc": "A participant has left, joined, was banned or admined in a channel or supergroup.",
+ "params": {
+ "actor_id": "User that triggered the change (inviter, admin that kicked the user, or the even the user_id itself)",
+ "channel_id": "Channel ID",
+ "date": "Date of the event",
+ "flags": "Flags, see TL conditional fields",
+ "invite": "Chat invite used to join the channel/supergroup",
+ "new_participant": "New participant status",
+ "prev_participant": "Previous participant status",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "user_id": "User that was affected by the change",
+ "via_chatlist": "Whether the participant joined using a chat folder deep link \u00bb."
+ }
+ },
+ "UpdateChannelPinnedTopic": {
+ "desc": "A forum topic \u00bb was pinned or unpinned.",
+ "params": {
+ "channel_id": "The forum ID",
+ "flags": "Flags, see TL conditional fields",
+ "pinned": "Whether the topic was pinned or unpinned",
+ "topic_id": "The topic ID"
+ }
+ },
+ "UpdateChannelPinnedTopics": {
+ "desc": "The pinned topics of a forum have changed.",
+ "params": {
+ "channel_id": "Forum ID.",
+ "flags": "Flags, see TL conditional fields",
+ "order": "Ordered list containing the IDs of all pinned topics."
+ }
+ },
+ "UpdateChannelReadMessagesContents": {
+ "desc": "The specified channel/supergroup messages were read (emitted specifically for messages like voice messages or video, only once the media is watched and marked as read using channels.readMessageContents)",
+ "params": {
+ "channel_id": "Channel/supergroup ID",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "IDs of messages that were read",
+ "saved_peer_id": "If set, the messages were read within the specified monoforum topic \u00bb.",
+ "top_msg_id": "Forum topic ID."
+ }
+ },
+ "UpdateChannelTooLong": {
+ "desc": "There are new updates in the specified channel, the client must fetch them.\nIf the difference is too long or if the channel isn't currently in the states, start fetching from the specified pts.",
+ "params": {
+ "channel_id": "The channel",
+ "flags": "Flags, see TL conditional fields",
+ "pts": "The PTS."
+ }
+ },
+ "UpdateChannelUserTyping": {
+ "desc": "A user is typing in a supergroup, channel or message thread",
+ "params": {
+ "action": "Whether the user is typing, sending a media or doing something else",
+ "channel_id": "Channel ID",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "The peer that is typing",
+ "top_msg_id": "Thread ID"
+ }
+ },
+ "UpdateChannelViewForumAsMessages": {
+ "desc": "Users may also choose to display messages from all topics as if they were sent to a normal group, using a \"View as messages\" setting in the local client.\nThis setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages method; invoking this method will update the value of the view_forum_as_messages flag of channelFull or dialog and emit an updateChannelViewForumAsMessages.",
+ "params": {
+ "channel_id": "The forum ID",
+ "enabled": "The new value of the toggle."
+ }
+ },
+ "UpdateChannelWebPage": {
+ "desc": "A webpage preview of a link in a channel/supergroup message was generated",
+ "params": {
+ "channel_id": "Channel/supergroup ID",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated",
+ "webpage": "Generated webpage preview"
+ }
+ },
+ "UpdateChat": {
+ "desc": "Chat (chat and/or chatFull) information was updated.",
+ "params": {
+ "chat_id": "Chat ID"
+ }
+ },
+ "UpdateChatDefaultBannedRights": {
+ "desc": "Default banned rights in a normal chat were updated",
+ "params": {
+ "default_banned_rights": "New default banned rights",
+ "peer": "The chat",
+ "version": "Version"
+ }
+ },
+ "UpdateChatParticipant": {
+ "desc": "A user has joined or left a specific chat",
+ "params": {
+ "actor_id": "User that triggered the change (inviter, admin that kicked the user, or the even the user_id itself)",
+ "chat_id": "Chat ID",
+ "date": "When did this event occur",
+ "flags": "Flags, see TL conditional fields",
+ "invite": "The invite that was used to join the group",
+ "new_participant": "New participant info (empty if this participant just left)",
+ "prev_participant": "Previous participant info (empty if this participant just joined)",
+ "qts": "New qts value, see updates \u00bb for more info.",
+ "user_id": "User that was affected by the change"
+ }
+ },
+ "UpdateChatParticipantAdd": {
+ "desc": "New group member.",
+ "params": {
+ "chat_id": "Group ID",
+ "date": "When was the participant added",
+ "inviter_id": "ID of the user, who added member to the group",
+ "user_id": "ID of the new member",
+ "version": "Chat version number"
+ }
+ },
+ "UpdateChatParticipantAdmin": {
+ "desc": "Admin permissions of a user in a basic group were changed",
+ "params": {
+ "chat_id": "Chat ID",
+ "is_admin": "Whether the user was rendered admin",
+ "user_id": "ID of the (de)admined user",
+ "version": "Used in basic groups to reorder updates and make sure that all of them was received."
+ }
+ },
+ "UpdateChatParticipantDelete": {
+ "desc": "A member has left the group.",
+ "params": {
+ "chat_id": "Group ID",
+ "user_id": "ID of the user",
+ "version": "Used in basic groups to reorder updates and make sure that all of them was received."
+ }
+ },
+ "UpdateChatParticipants": {
+ "desc": "Composition of chat participants changed.",
+ "params": {
+ "participants": "Updated chat participants"
+ }
+ },
+ "UpdateChatUserTyping": {
+ "desc": "The user is preparing a message in a group; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing",
+ "params": {
+ "action": "Type of action",
+ "chat_id": "Group id",
+ "from_id": "Peer that started typing (can be the chat itself, in case of anonymous admins)."
+ }
+ },
+ "UpdateConfig": {
+ "desc": "The server-side configuration has changed; the client should re-fetch the config using help.getConfig and help.getAppConfig.",
+ "params": {}
+ },
+ "UpdateContactsReset": {
+ "desc": "All contacts were deleted",
+ "params": {}
+ },
+ "UpdateDcOptions": {
+ "desc": "Changes in the data center configuration options.",
+ "params": {
+ "dc_options": "New connection options"
+ }
+ },
+ "UpdateDeleteChannelMessages": {
+ "desc": "Some messages in a supergroup/channel were deleted",
+ "params": {
+ "channel_id": "Channel ID",
+ "messages": "IDs of messages that were deleted",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateDeleteMessages": {
+ "desc": "Messages were deleted.",
+ "params": {
+ "messages": "List of identifiers of deleted messages",
+ "pts": "New quality of actions in a message box",
+ "pts_count": "Number of generated events"
+ }
+ },
+ "UpdateDeleteQuickReply": {
+ "desc": "A quick reply shortcut \u00bb was deleted. This will not emit updateDeleteQuickReplyMessages updates, even if all the messages in the shortcut are also deleted by this update.",
+ "params": {
+ "shortcut_id": "ID of the quick reply shortcut that was deleted."
+ }
+ },
+ "UpdateDeleteQuickReplyMessages": {
+ "desc": "One or more messages in a quick reply shortcut \u00bb were deleted.",
+ "params": {
+ "messages": "IDs of the deleted messages.",
+ "shortcut_id": "Quick reply shortcut ID."
+ }
+ },
+ "UpdateDeleteScheduledMessages": {
+ "desc": "Some scheduled messages were deleted (or sent) from the schedule queue of a chat",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "messages": "Deleted scheduled messages",
+ "peer": "Peer",
+ "sent_messages": "If set, this update indicates that some scheduled messages were sent (not simply deleted from the schedule queue). In this case, the messages field will contain the scheduled message IDs for the sent messages (initially returned in updateNewScheduledMessage), and sent_messages will contain the real message IDs for the sent messages."
+ }
+ },
+ "UpdateDialogFilter": {
+ "desc": "A new folder was added",
+ "params": {
+ "filter": "Folder info",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Folder ID"
+ }
+ },
+ "UpdateDialogFilterOrder": {
+ "desc": "New folder order",
+ "params": {
+ "order": "Ordered folder IDs"
+ }
+ },
+ "UpdateDialogFilters": {
+ "desc": "Clients should update folder info",
+ "params": {}
+ },
+ "UpdateDialogPinned": {
+ "desc": "A dialog was pinned/unpinned",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "peer": "The dialog",
+ "pinned": "Whether the dialog was pinned"
+ }
+ },
+ "UpdateDialogUnreadMark": {
+ "desc": "The manual unread mark of a chat was changed",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The dialog",
+ "saved_peer_id": "If set, the mark is related to the specified monoforum topic ID \u00bb.",
+ "unread": "Was the chat marked or unmarked as read"
+ }
+ },
+ "UpdateDraftMessage": {
+ "desc": "Notifies a change of a message draft.",
+ "params": {
+ "draft": "The draft",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer to which the draft is associated",
+ "saved_peer_id": "If set, the draft is related to the specified monoforum topic ID \u00bb.",
+ "top_msg_id": "ID of the forum topic to which the draft is associated"
+ }
+ },
+ "UpdateEditChannelMessage": {
+ "desc": "A message was edited in a channel/supergroup",
+ "params": {
+ "message": "The new message",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateEditMessage": {
+ "desc": "A message was edited",
+ "params": {
+ "message": "The new edited message",
+ "pts": "PTS",
+ "pts_count": "PTS count"
+ }
+ },
+ "UpdateEncryptedChatTyping": {
+ "desc": "Interlocutor is typing a message in an encrypted chat. Update period is 6 second. If upon this time there is no repeated update, it shall be considered that the interlocutor stopped typing.",
+ "params": {
+ "chat_id": "Chat ID"
+ }
+ },
+ "UpdateEncryptedMessagesRead": {
+ "desc": "Communication history in an encrypted chat was marked as read.",
+ "params": {
+ "chat_id": "Chat ID",
+ "date": "Time when messages were read",
+ "max_date": "Maximum value of data for read messages"
+ }
+ },
+ "UpdateEncryption": {
+ "desc": "Change of state in an encrypted chat.",
+ "params": {
+ "chat": "Encrypted chat",
+ "date": "Date of change"
+ }
+ },
+ "UpdateFavedStickers": {
+ "desc": "The list of favorited stickers was changed, the client should call messages.getFavedStickers to refetch the new list",
+ "params": {}
+ },
+ "UpdateFolderPeers": {
+ "desc": "The peer list of a peer folder was updated",
+ "params": {
+ "folder_peers": "New peer list",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateGeoLiveViewed": {
+ "desc": "Live geoposition message was viewed",
+ "params": {
+ "msg_id": "Message ID of geoposition message",
+ "peer": "The user that viewed the live geoposition"
+ }
+ },
+ "UpdateGroupCall": {
+ "desc": "A new groupcall was started",
+ "params": {
+ "call": "Info about the group call or livestream",
+ "chat_id": "The channel/supergroup where this group call or livestream takes place",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "UpdateGroupCallChainBlocks": {
+ "desc": "Contains updates to the blockchain of a conference call, see here \u00bb for more info.",
+ "params": {
+ "blocks": "Blocks.",
+ "call": "The conference call.",
+ "next_offset": "Offset of the next block.",
+ "sub_chain_id": "Subchain ID."
+ }
+ },
+ "UpdateGroupCallConnection": {
+ "desc": "New WebRTC parameters",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "params": "WebRTC parameters",
+ "presentation": "Are these parameters related to the screen capture session currently in progress?"
+ }
+ },
+ "UpdateGroupCallEncryptedMessage": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdateGroupCallMessage": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdateGroupCallParticipants": {
+ "desc": "The participant list of a certain group call has changed",
+ "params": {
+ "call": "Group call",
+ "participants": "New participant list",
+ "version": "Version"
+ }
+ },
+ "UpdateInlineBotCallbackQuery": {
+ "desc": "This notification is received by bots when a button is pressed",
+ "params": {
+ "chat_instance": "Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.",
+ "data": "Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.",
+ "flags": "Flags, see TL conditional fields",
+ "game_short_name": "Short name of a Game to be returned, serves as the unique identifier for the game",
+ "msg_id": "ID of the inline message with the button",
+ "query_id": "Query ID",
+ "user_id": "ID of the user that pressed the button"
+ }
+ },
+ "UpdateLangPack": {
+ "desc": "Language pack updated",
+ "params": {
+ "difference": "Changed strings"
+ }
+ },
+ "UpdateLangPackTooLong": {
+ "desc": "A language pack has changed, the client should manually fetch the changed strings using langpack.getDifference",
+ "params": {
+ "lang_code": "Language code"
+ }
+ },
+ "UpdateLoginToken": {
+ "desc": "A login token (for login via QR code) was accepted.",
+ "params": {}
+ },
+ "UpdateMessageExtendedMedia": {
+ "desc": "You bought a paid media \u00bb: this update contains the revealed media.",
+ "params": {
+ "extended_media": "Revealed media, contains only messageExtendedMedia constructors.",
+ "msg_id": "ID of the message containing the paid media",
+ "peer": "Peer where the paid media was posted"
+ }
+ },
+ "UpdateMessageID": {
+ "desc": "Sent message with random_id client identifier was assigned an identifier.",
+ "params": {
+ "id": "id identifier of a respective Message",
+ "random_id": "Previously transferred client random_id identifier"
+ }
+ },
+ "UpdateMessagePoll": {
+ "desc": "The results of a poll have changed",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "poll": "If the server knows the client hasn't cached this poll yet, the poll itself",
+ "poll_id": "Poll ID",
+ "results": "New poll results"
+ }
+ },
+ "UpdateMessagePollVote": {
+ "desc": "A specific peer has voted in a poll",
+ "params": {
+ "options": "Chosen option(s)",
+ "peer": "The peer that voted in the poll",
+ "poll_id": "Poll ID",
+ "qts": "New qts value, see updates \u00bb for more info."
+ }
+ },
+ "UpdateMessageReactions": {
+ "desc": "New message reactions \u00bb are available",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Message ID",
+ "peer": "Peer",
+ "reactions": "Reactions",
+ "saved_peer_id": "If set, the reactions are in the specified monoforum topic \u00bb.",
+ "top_msg_id": "Forum topic ID"
+ }
+ },
+ "UpdateMonoForumNoPaidException": {
+ "desc": "An admin has (un)exempted this monoforum topic \u00bb from payment to send messages using account.toggleNoPaidMessagesException.",
+ "params": {
+ "channel_id": "The monoforum ID.",
+ "exception": "If set, an admin has exempted this peer, otherwise the peer was unexempted.",
+ "flags": "Flags, see TL conditional fields",
+ "saved_peer_id": "The peer/topic ID."
+ }
+ },
+ "UpdateMoveStickerSetToTop": {
+ "desc": "A stickerset was just moved to top, see here for more info \u00bb",
+ "params": {
+ "emojis": "This update is referring to a custom emoji stickerset",
+ "flags": "Flags, see TL conditional fields",
+ "masks": "This update is referring to a mask stickerset",
+ "stickerset": "Stickerset ID"
+ }
+ },
+ "UpdateNewAuthorization": {
+ "desc": "A new session logged into the current user's account through an unknown device.",
+ "params": {
+ "date": "Authorization date",
+ "device": "Name of device, for example Android",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here",
+ "location": "Location, for example USA, NY (IP=1.2.3.4)",
+ "unconfirmed": "Whether the session is unconfirmed, see here \u00bb for more info."
+ }
+ },
+ "UpdateNewChannelMessage": {
+ "desc": "A new message was sent in a channel/supergroup",
+ "params": {
+ "message": "New message",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateNewEncryptedMessage": {
+ "desc": "New encrypted message.",
+ "params": {
+ "message": "Message",
+ "qts": "New qts value, see updates \u00bb for more info."
+ }
+ },
+ "UpdateNewMessage": {
+ "desc": "New message in a private chat or in a basic group.",
+ "params": {
+ "message": "Message",
+ "pts": "New quantity of actions in a message box",
+ "pts_count": "Number of generated events"
+ }
+ },
+ "UpdateNewQuickReply": {
+ "desc": "A new quick reply shortcut \u00bb was created.",
+ "params": {
+ "quick_reply": "Quick reply shortcut."
+ }
+ },
+ "UpdateNewScheduledMessage": {
+ "desc": "A message was added to the schedule queue of a chat",
+ "params": {
+ "message": "Message"
+ }
+ },
+ "UpdateNewStickerSet": {
+ "desc": "A new stickerset was installed",
+ "params": {
+ "stickerset": "The installed stickerset"
+ }
+ },
+ "UpdateNewStoryReaction": {
+ "desc": "Represents a new reaction to a story.",
+ "params": {
+ "peer": "The peer where the story was posted.",
+ "reaction": "The reaction.",
+ "story_id": "Story ID."
+ }
+ },
+ "UpdateNotifySettings": {
+ "desc": "Changes in notification settings.",
+ "params": {
+ "notify_settings": "New notification settings",
+ "peer": "Notification source"
+ }
+ },
+ "UpdatePaidReactionPrivacy": {
+ "desc": "Contains the current default paid reaction privacy, see here \u00bb for more info.",
+ "params": {
+ "private": "Paid reaction privacy settings."
+ }
+ },
+ "UpdatePeerBlocked": {
+ "desc": "We blocked a peer, see here \u00bb for more info on blocklists.",
+ "params": {
+ "blocked": "Whether the peer was blocked or unblocked",
+ "blocked_my_stories_from": "Whether the peer was added/removed to/from the story blocklist; if not set, this update affects the main blocklist, see here \u00bb for more info.",
+ "flags": "Flags, see TL conditional fields",
+ "peer_id": "The (un)blocked peer"
+ }
+ },
+ "UpdatePeerHistoryTTL": {
+ "desc": "The Time-To-Live for messages sent by the current user in a specific chat has changed",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The chat",
+ "ttl_period": "The new Time-To-Live"
+ }
+ },
+ "UpdatePeerLocated": {
+ "desc": "List of peers near you was updated",
+ "params": {
+ "peers": "Geolocated peer list update"
+ }
+ },
+ "UpdatePeerSettings": {
+ "desc": "Settings of a certain peer have changed",
+ "params": {
+ "peer": "The peer",
+ "settings": "Associated peer settings"
+ }
+ },
+ "UpdatePeerWallpaper": {
+ "desc": "The wallpaper \u00bb of a given peer has changed.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer where the wallpaper has changed.",
+ "wallpaper": "The new wallpaper, if none the wallpaper was removed and the default wallpaper should be used.",
+ "wallpaper_overridden": "Whether the other user has chosen a custom wallpaper for us using messages.setChatWallPaper and the for_both flag, see here \u00bb for more info."
+ }
+ },
+ "UpdatePendingJoinRequests": {
+ "desc": "Someone has requested to join a chat or channel",
+ "params": {
+ "peer": "Chat or channel",
+ "recent_requesters": "IDs of users that have recently requested to join",
+ "requests_pending": "Number of pending join requests \u00bb for the chat or channel"
+ }
+ },
+ "UpdatePhoneCall": {
+ "desc": "An incoming phone call",
+ "params": {
+ "phone_call": "Phone call"
+ }
+ },
+ "UpdatePhoneCallSignalingData": {
+ "desc": "Incoming phone call signaling payload",
+ "params": {
+ "data": "Signaling payload",
+ "phone_call_id": "Phone call ID"
+ }
+ },
+ "UpdatePinnedChannelMessages": {
+ "desc": "Messages were pinned/unpinned in a channel/supergroup",
+ "params": {
+ "channel_id": "Channel ID",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "Messages",
+ "pinned": "Whether the messages were pinned or unpinned",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdatePinnedDialogs": {
+ "desc": "Pinned dialogs were updated",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "order": "New order of pinned dialogs"
+ }
+ },
+ "UpdatePinnedForumTopic": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdatePinnedForumTopics": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdatePinnedMessages": {
+ "desc": "Some messages were pinned in a chat",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "messages": "Message IDs",
+ "peer": "Peer",
+ "pinned": "Whether the messages were pinned or unpinned",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdatePinnedSavedDialogs": {
+ "desc": "Pinned saved dialogs \u00bb were updated",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "order": "New order of pinned saved dialogs"
+ }
+ },
+ "UpdatePrivacy": {
+ "desc": "Privacy rules were changed",
+ "params": {
+ "key": "Peers to which the privacy rules apply",
+ "rules": "New privacy rules"
+ }
+ },
+ "UpdatePtsChanged": {
+ "desc": "Common message box sequence PTS has changed, state has to be refetched using updates.getState",
+ "params": {}
+ },
+ "UpdateQuickReplies": {
+ "desc": "Info about or the order of quick reply shortcuts \u00bb was changed.",
+ "params": {
+ "quick_replies": "New quick reply shortcut order and information."
+ }
+ },
+ "UpdateQuickReplyMessage": {
+ "desc": "A new message was added to a quick reply shortcut \u00bb.",
+ "params": {
+ "message": "The message that was added (the message.quick_reply_shortcut_id field will contain the shortcut ID)."
+ }
+ },
+ "UpdateReadChannelDiscussionInbox": {
+ "desc": "Incoming comments in a discussion thread were marked as read",
+ "params": {
+ "broadcast_id": "If set, contains the ID of the channel that contains the post that started the comment thread in the discussion group (channel_id)",
+ "broadcast_post": "If set, contains the ID of the channel post that started the comment thread",
+ "channel_id": "Discussion group ID",
+ "flags": "Flags, see TL conditional fields",
+ "read_max_id": "Message ID of latest read incoming message for this thread",
+ "top_msg_id": "ID of the group message that started the thread (message in linked discussion group)"
+ }
+ },
+ "UpdateReadChannelDiscussionOutbox": {
+ "desc": "Outgoing comments in a discussion thread were marked as read",
+ "params": {
+ "channel_id": "Supergroup ID",
+ "read_max_id": "Message ID of latest read outgoing message for this thread",
+ "top_msg_id": "ID of the group message that started the thread"
+ }
+ },
+ "UpdateReadChannelInbox": {
+ "desc": "Incoming messages in a channel/supergroup were read",
+ "params": {
+ "channel_id": "Channel/supergroup ID",
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "max_id": "Position up to which all incoming messages are read.",
+ "pts": "Event count after generation",
+ "still_unread_count": "Count of messages weren't read yet"
+ }
+ },
+ "UpdateReadChannelOutbox": {
+ "desc": "Outgoing messages in a channel/supergroup were read",
+ "params": {
+ "channel_id": "Channel/supergroup ID",
+ "max_id": "Position up to which all outgoing messages are read."
+ }
+ },
+ "UpdateReadFeaturedEmojiStickers": {
+ "desc": "Some featured custom emoji stickers were marked as read",
+ "params": {}
+ },
+ "UpdateReadFeaturedStickers": {
+ "desc": "Some featured stickers were marked as read",
+ "params": {}
+ },
+ "UpdateReadHistoryInbox": {
+ "desc": "Incoming messages were read",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "max_id": "Maximum ID of messages read",
+ "peer": "Peer",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated",
+ "still_unread_count": "Number of messages that are still unread"
+ }
+ },
+ "UpdateReadHistoryOutbox": {
+ "desc": "Outgoing messages were read",
+ "params": {
+ "max_id": "Maximum ID of read outgoing messages",
+ "peer": "Peer",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateReadMessagesContents": {
+ "desc": "Contents of messages in the common message box were read (emitted specifically for messages like voice messages or video, only once the media is watched and marked as read using messages.readMessageContents).",
+ "params": {
+ "date": "When was the last message in messages marked as read.",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "IDs of read messages",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "UpdateReadMonoForumInbox": {
+ "desc": "Incoming messages in a monoforum topic were read",
+ "params": {
+ "channel_id": "ID of the monoforum.",
+ "read_max_id": "Position up to which all incoming messages are read.",
+ "saved_peer_id": "Topic ID."
+ }
+ },
+ "UpdateReadMonoForumOutbox": {
+ "desc": "Outgoing messages in a monoforum were read.",
+ "params": {
+ "channel_id": "ID of the monoforum.",
+ "read_max_id": "Position up to which all outgoing messages are read.",
+ "saved_peer_id": "Topic ID."
+ }
+ },
+ "UpdateReadStories": {
+ "desc": "Stories of a specific peer were marked as read.",
+ "params": {
+ "max_id": "ID of the last story that was marked as read",
+ "peer": "The peer"
+ }
+ },
+ "UpdateRecentEmojiStatuses": {
+ "desc": "The list of recent emoji statuses has changed",
+ "params": {}
+ },
+ "UpdateRecentReactions": {
+ "desc": "The list of recent message reactions has changed",
+ "params": {}
+ },
+ "UpdateRecentStickers": {
+ "desc": "The recent sticker list was updated",
+ "params": {}
+ },
+ "UpdateSavedDialogPinned": {
+ "desc": "A saved message dialog was pinned/unpinned",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The dialog",
+ "pinned": "Whether the dialog was pinned"
+ }
+ },
+ "UpdateSavedGifs": {
+ "desc": "The saved gif list has changed, the client should refetch it using messages.getSavedGifs",
+ "params": {}
+ },
+ "UpdateSavedReactionTags": {
+ "desc": "The list of reaction tag \u00bb names assigned by the user has changed and should be refetched using messages.getSavedReactionTags \u00bb.",
+ "params": {}
+ },
+ "UpdateSavedRingtones": {
+ "desc": "The list of saved notification sounds has changed, use account.getSavedRingtones to fetch the new list.",
+ "params": {}
+ },
+ "UpdateSentPhoneCode": {
+ "desc": "A paid login SMS code was successfully sent.",
+ "params": {
+ "sent_code": "Info about the sent code."
+ }
+ },
+ "UpdateSentStoryReaction": {
+ "desc": "Indicates we reacted to a story \u00bb.",
+ "params": {
+ "peer": "The peer that sent the story",
+ "reaction": "The reaction that was sent",
+ "story_id": "ID of the story we reacted to"
+ }
+ },
+ "UpdateServiceNotification": {
+ "desc": "A service message for the user.",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "inbox_date": "When was the notification receivedThe message must also be stored locally as part of the message history with the user id 777000 (Telegram Notifications).",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "media": "Media content (optional)",
+ "message": "Message text",
+ "popup": "If set, the message must be displayed in a popup.",
+ "type": "String, identical in format and contents to the type field in API errors. Describes type of service message. It is acceptable to ignore repeated messages of the same type within a short period of time (15 minutes)."
+ }
+ },
+ "UpdateShort": {
+ "desc": "Shortened constructor containing info on one update not requiring auxiliary data",
+ "params": {
+ "date": "Date of event",
+ "update": "Update"
+ }
+ },
+ "UpdateShortChatMessage": {
+ "desc": "Shortened constructor containing info on one new incoming text message from a chat",
+ "params": {
+ "chat_id": "ID of the chat where the message was sent",
+ "date": "date",
+ "entities": "Entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "ID of the sender of the message",
+ "fwd_from": "Info about a forwarded message",
+ "id": "ID of the message",
+ "media_unread": "Whether the message contains some unread mentions",
+ "mentioned": "Whether we were mentioned in this message",
+ "message": "Message",
+ "out": "Whether the message is outgoing",
+ "pts": "PTS",
+ "pts_count": "PTS count",
+ "reply_to": "Reply (thread) information",
+ "silent": "If true, the message is a silent message, no notifications should be triggered",
+ "ttl_period": "Time To Live of the message, once updateShortChatMessage.date+updateShortChatMessage.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well.",
+ "via_bot_id": "Info about the inline bot used to generate this message"
+ }
+ },
+ "UpdateShortMessage": {
+ "desc": "Info about a message sent to (received from) another user",
+ "params": {
+ "date": "date",
+ "entities": "Entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "fwd_from": "Info about a forwarded message",
+ "id": "The message ID",
+ "media_unread": "Whether there are some unread mentions in this message",
+ "mentioned": "Whether we were mentioned in the message",
+ "message": "The message",
+ "out": "Whether the message is outgoing",
+ "pts": "PTS",
+ "pts_count": "PTS count",
+ "reply_to": "Reply and thread information",
+ "silent": "If true, the message is a silent message, no notifications should be triggered",
+ "ttl_period": "Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well.",
+ "user_id": "The ID of the sender (if outgoing will be the ID of the destination) of the message",
+ "via_bot_id": "Info about the inline bot used to generate this message"
+ }
+ },
+ "UpdateShortSentMessage": {
+ "desc": "Shortened constructor containing info on one outgoing message to a contact (the destination chat has to be extracted from the method call that returned this object).",
+ "params": {
+ "date": "date",
+ "entities": "Entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of the sent message",
+ "media": "Attached media",
+ "out": "Whether the message is outgoing",
+ "pts": "PTS",
+ "pts_count": "PTS count",
+ "ttl_period": "Time To Live of the message, once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well."
+ }
+ },
+ "UpdateSmsJob": {
+ "desc": "A new SMS job was received",
+ "params": {
+ "job_id": "SMS job ID"
+ }
+ },
+ "UpdateStarsBalance": {
+ "desc": "The current account's Telegram Stars balance \u00bb has changed.",
+ "params": {
+ "balance": "New balance."
+ }
+ },
+ "UpdateStarsRevenueStatus": {
+ "desc": "The Telegram Star balance of a channel/bot we own has changed \u00bb.",
+ "params": {
+ "peer": "Channel/bot",
+ "status": "New Telegram Star balance."
+ }
+ },
+ "UpdateStickerSets": {
+ "desc": "Installed stickersets have changed, the client should refetch them as described in the docs.",
+ "params": {
+ "emojis": "Whether the list of installed custom emoji stickersets has changed",
+ "flags": "Flags, see TL conditional fields",
+ "masks": "Whether mask stickersets have changed"
+ }
+ },
+ "UpdateStickerSetsOrder": {
+ "desc": "The order of stickersets was changed",
+ "params": {
+ "emojis": "Whether the updated stickers are custom emoji stickers",
+ "flags": "Flags, see TL conditional fields",
+ "masks": "Whether the updated stickers are mask stickers",
+ "order": "New sticker order by sticker ID"
+ }
+ },
+ "UpdateStoriesStealthMode": {
+ "desc": "Indicates that stories stealth mode was activated.",
+ "params": {
+ "stealth_mode": "Information about the current stealth mode session."
+ }
+ },
+ "UpdateStory": {
+ "desc": "A new story was posted.",
+ "params": {
+ "peer": "ID of the poster.",
+ "story": "The story that was posted."
+ }
+ },
+ "UpdateStoryID": {
+ "desc": "A story was successfully uploaded.",
+ "params": {
+ "id": "The id that was attributed to the story.",
+ "random_id": "The random_id that was passed to stories.sendStory."
+ }
+ },
+ "UpdateTheme": {
+ "desc": "A cloud theme was updated",
+ "params": {
+ "theme": "Theme"
+ }
+ },
+ "UpdateTranscribeAudio": {
+ "desc": "",
+ "params": {}
+ },
+ "UpdateTranscribedAudio": {
+ "desc": "A pending voice message transcription \u00bb initiated with messages.transcribeAudio was updated.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Transcribed message ID",
+ "peer": "Peer of the transcribed message",
+ "pending": "Whether this transcription is still pending and further updateTranscribedAudio about it will be sent in the future.",
+ "text": "Transcribed text",
+ "transcription_id": "Transcription ID"
+ }
+ },
+ "UpdateUser": {
+ "desc": "User (user and/or userFull) information was updated.",
+ "params": {
+ "user_id": "User ID"
+ }
+ },
+ "UpdateUserEmojiStatus": {
+ "desc": "The emoji status of a certain user has changed",
+ "params": {
+ "emoji_status": "New emoji status",
+ "user_id": "User ID"
+ }
+ },
+ "UpdateUserName": {
+ "desc": "Changes the user's first name, last name and username.",
+ "params": {
+ "first_name": "New first name. Corresponds to the new value of real_first_name field of the userFull constructor.",
+ "last_name": "New last name. Corresponds to the new value of real_last_name field of the userFull constructor.",
+ "user_id": "User identifier",
+ "usernames": "Usernames."
+ }
+ },
+ "UpdateUserPhone": {
+ "desc": "A user's phone number was changed",
+ "params": {
+ "phone": "New phone number",
+ "user_id": "User ID"
+ }
+ },
+ "UpdateUserStatus": {
+ "desc": "Contact status update.",
+ "params": {
+ "status": "New status",
+ "user_id": "User identifier"
+ }
+ },
+ "UpdateUserTyping": {
+ "desc": "The user is preparing a message; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing",
+ "params": {
+ "action": "Action type",
+ "user_id": "User id"
+ }
+ },
+ "UpdateWebPage": {
+ "desc": "An instant view webpage preview was generated",
+ "params": {
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated",
+ "webpage": "Webpage preview"
+ }
+ },
+ "UpdateWebViewResultSent": {
+ "desc": "Indicates to a bot that a webview was closed and an inline message was sent on behalf of the user using messages.sendWebViewResultMessage",
+ "params": {
+ "query_id": "Web app interaction ID"
+ }
+ },
+ "Updates": {
+ "desc": "Full constructor of updates",
+ "params": {
+ "chats": "List of chats mentioned in updates",
+ "date": "Current date",
+ "seq": "Total number of sent updates",
+ "updates": "List of updates",
+ "users": "List of users mentioned in updates"
+ }
+ },
+ "UpdatesCombined": {
+ "desc": "Constructor for a group of updates.",
+ "params": {
+ "chats": "List of chats mentioned in updates",
+ "date": "Current date",
+ "seq": "Value seq for the latest update in a group",
+ "seq_start": "Value seq for the earliest update in a group",
+ "updates": "List of updates",
+ "users": "List of users mentioned in updates"
+ }
+ },
+ "UpdatesTooLong": {
+ "desc": "Too many updates, it is necessary to execute updates.getDifference.",
+ "params": {}
+ },
+ "UrlAuthResultAccepted": {
+ "desc": "Details about an accepted authorization request, for more info click here \u00bb",
+ "params": {
+ "url": "The URL name of the website on which the user has logged in."
+ }
+ },
+ "UrlAuthResultDefault": {
+ "desc": "Details about an accepted authorization request, for more info click here \u00bb",
+ "params": {}
+ },
+ "UrlAuthResultRequest": {
+ "desc": "Details about the authorization request, for more info click here \u00bb",
+ "params": {
+ "bot": "Username of a bot, which will be used for user authorization. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.",
+ "domain": "The domain name of the website on which the user will log in.",
+ "flags": "Flags, see TL conditional fields",
+ "request_write_access": "Whether the bot would like to send messages to the user"
+ }
+ },
+ "User": {
+ "desc": "Indicates info about a certain user.",
+ "params": {
+ "access_hash": "Access hash of the user, see here \u00bb for more info. If this flag is set, when updating the local peer database, generate a virtual flag called min_access_hash, which is: - Set to true if min is set AND -- The phone flag is not set OR -- The phone flag is set and the associated phone number string is non-empty - Set to false otherwise. Then, apply both access_hash and min_access_hash to the local database if: - min_access_hash is false OR - min_access_hash is true AND -- There is no locally cached object for this user OR -- There is no access_hash in the local cache OR -- The cached object's min_access_hash is also true If the final merged object stored to the database has the min_access_hash field set to true, the related access_hash is only suitable to use in inputPeerPhotoFileLocation \u00bb, to directly download the profile pictures of users, everywhere else a inputPeer*FromMessage constructor will have to be generated as specified here \u00bb. Bots can also use min access hashes in some conditions, by passing 0 instead of the min access hash.",
+ "apply_min_photo": "If set and min is set, the value of photo can be used to update the local database, see the documentation of that flag for more info.",
+ "attach_menu_enabled": "Whether we installed the attachment menu web app offered by this bot. When updating the local peer database, do not apply changes to this field if the min flag is set.",
+ "bot": "Is this user a bot? Changes to this flag should invalidate the local userFull cache for this user ID, see here \u00bb for more info.",
+ "bot_active_users": "Monthly Active Users (MAU) of this bot (may be absent for small bots).",
+ "bot_attach_menu": "Whether this bot offers an attachment menu web app",
+ "bot_business": "Whether this bot can be connected to a user as specified here \u00bb.",
+ "bot_can_edit": "Whether we can edit the profile picture, name, about text and description of this bot because we own it. When updating the local peer database, do not apply changes to this field if the min flag is set. Changes to this flag (if min is not set) should invalidate the local userFull cache for this user ID.",
+ "bot_chat_history": "Can the bot see all messages in groups?",
+ "bot_has_main_app": "If set, this bot has configured a Main Mini App \u00bb.",
+ "bot_info_version": "Version of the bot_info field in userFull, incremented every time it changes. Changes to this flag should invalidate the local userFull cache for this user ID, see here \u00bb for more info.",
+ "bot_inline_geo": "Whether the bot can request our geolocation in inline mode",
+ "bot_inline_placeholder": "Inline placeholder for this inline bot",
+ "bot_nochats": "Can the bot be added to groups?",
+ "bot_verification_icon": "Describes a bot verification icon \u00bb.",
+ "close_friend": "Whether we marked this user as a close friend, see here \u00bb for more info. When updating the local peer database, do not apply changes to this field if the min flag is set.",
+ "color": "The user's accent color.",
+ "contact": "Whether this user is a contact When updating the local peer database, do not apply changes to this field if the min flag is set.",
+ "contact_require_premium": "See here for more info on this flag \u00bb.",
+ "deleted": "Whether the account of this user was deleted. Changes to this flag should invalidate the local userFull cache for this user ID, see here \u00bb for more info.",
+ "emoji_status": "Emoji status",
+ "fake": "If set, this user was reported by many users as a fake or scam user: be careful when interacting with them.",
+ "first_name": "First name. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set.",
+ "flags": "Flags, see TL conditional fields",
+ "flags2": "Flags, see TL conditional fields",
+ "id": "ID of the user, see here \u00bb for more info and the available ID range.",
+ "lang_code": "Language code of the user",
+ "last_name": "Last name. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set.",
+ "min": "See min",
+ "mutual_contact": "Whether this user is a mutual contact. When updating the local peer database, do not apply changes to this field if the min flag is set.",
+ "phone": "Phone number. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set.",
+ "photo": "Profile picture of user. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The apply_min_photo flag is set OR -- The min flag of the locally cached user entry is set.",
+ "premium": "Whether this user is a Telegram Premium user Changes to this flag should invalidate the local userFull cache for this user ID, see here \u00bb for more info. Changes to this flag if the self flag is set should also trigger the following calls, to refresh the respective caches: - The help.getConfig cache - The messages.getTopReactions cache if the bot flag is not set",
+ "profile_color": "The user's profile color.",
+ "restricted": "Access to this user must be restricted for the reason specified in restriction_reason",
+ "restriction_reason": "Contains the reason why access to this user must be restricted.",
+ "scam": "This may be a scam user",
+ "self": "Whether this user indicates the currently logged in user",
+ "send_paid_messages_stars": "If set, the user has enabled paid messages \u00bb, we might need to pay the specified amount of Stars to send them messages, depending on the configured exceptions: check userFull.send_paid_messages_stars or users.getRequirementsToContact to see if the currently logged in user actually has to pay or not, see here \u00bb for the full flow.",
+ "status": "Online status of user. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set OR -- The locally cached user entry is equal to userStatusEmpty.",
+ "stories_hidden": "Whether we have hidden \u00bb all active stories of this user. When updating the local peer database, do not apply changes to this field if the min flag is set.",
+ "stories_max_id": "ID of the maximum read story. When updating the local peer database, do not apply changes to this field if the min flag of the incoming constructor is set.",
+ "stories_unavailable": "No stories from this user are visible.",
+ "support": "Whether this is an official support user",
+ "username": "Main active username. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set. Changes to this flag should invalidate the local userFull cache for this user ID if the above conditions are respected and the bot_can_edit flag is also set.",
+ "usernames": "Additional usernames. When updating the local peer database, apply changes to this field only if: - The min flag is not set OR - The min flag is set AND -- The min flag of the locally cached user entry is set. Changes to this flag (if the above conditions are respected) should invalidate the local userFull cache for this user ID.",
+ "verified": "Whether this user is verified"
+ }
+ },
+ "UserEmpty": {
+ "desc": "Empty constructor, non-existent user.",
+ "params": {
+ "id": "User identifier or 0"
+ }
+ },
+ "UserFull": {
+ "desc": "Extended user info",
+ "params": {
+ "about": "Bio of the user",
+ "birthday": "Contains info about the user's birthday \u00bb.",
+ "blocked": "Whether you have blocked this user",
+ "blocked_my_stories_from": "Whether we've blocked this user, preventing them from seeing our stories \u00bb.",
+ "bot_broadcast_admin_rights": "A suggested set of administrator rights for the bot, to be shown when adding the bot as admin to a channel, see here for more info on how to handle them \u00bb.",
+ "bot_can_manage_emoji_status": "If set, this is a bot that can change our emoji status \u00bb",
+ "bot_group_admin_rights": "A suggested set of administrator rights for the bot, to be shown when adding the bot as admin to a group, see here for more info on how to handle them \u00bb.",
+ "bot_info": "For bots, info about the bot (bot commands, etc)",
+ "bot_verification": "Describes a bot verification icon \u00bb.",
+ "business_away_message": "Telegram Business away message \u00bb.",
+ "business_greeting_message": "Telegram Business greeting message \u00bb.",
+ "business_intro": "Specifies a custom Telegram Business profile introduction \u00bb.",
+ "business_location": "Telegram Business location \u00bb.",
+ "business_work_hours": "Telegram Business working hours \u00bb.",
+ "can_pin_message": "Whether you can pin messages in the chat with this user, you can do this only for a chat with yourself",
+ "can_view_revenue": "If set, this user can view ad revenue statistics \u00bb for this bot.",
+ "common_chats_count": "Chats in common with this user",
+ "contact_require_premium": "If set, we cannot write to this user: subscribe to Telegram Premium to get permission to write to this user. To set this flag for ourselves invoke account.setGlobalPrivacySettings, setting the settings.new_noncontact_peers_require_premium flag, see here \u00bb for more info.",
+ "disallowed_gifts": "Disallows the reception of specific gift types.",
+ "display_gifts_button": "If this flag is set for both us and another user (changed through globalPrivacySettings), a gift button should always be displayed in the text field in private chats with the other user: once clicked, the gift UI should be displayed, offering the user options to gift Telegram Premium \u00bb subscriptions or Telegram Gifts \u00bb.",
+ "fallback_photo": "Fallback profile photo, displayed if no photo is present in profile_photo or personal_photo, due to privacy settings.",
+ "flags": "Flags, see TL conditional fields",
+ "flags2": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "has_scheduled": "Whether scheduled messages are available",
+ "id": "User ID",
+ "main_tab": "The main tab for the user's profile, see here \u00bb for more info.",
+ "notify_settings": "Notification settings",
+ "personal_channel_id": "ID of the associated personal channel \u00bb, that should be shown in the profile page.",
+ "personal_channel_message": "ID of the latest message of the associated personal channel \u00bb, that should be previewed in the profile page.",
+ "personal_photo": "Personal profile photo, to be shown instead of profile_photo.",
+ "phone_calls_available": "Whether this user can make VoIP calls",
+ "phone_calls_private": "Whether this user's privacy settings allow you to call them",
+ "pinned_msg_id": "Message ID of the last pinned message",
+ "private_forward_name": "Anonymized text to be shown instead of the user's name on forwarded messages",
+ "profile_photo": "Profile photo",
+ "read_dates_private": "If set, we cannot fetch the exact read date of messages we send to this user using messages.getOutboxReadDate. The exact read date of messages might still be unavailable for other reasons, see here \u00bb for more info. To set this flag for ourselves invoke account.setGlobalPrivacySettings, setting the settings.hide_read_marks flag.",
+ "saved_music": "The first song on the music tab of the profile, see here \u00bb for more info on the music profile tab.",
+ "send_paid_messages_stars": "If set and bigger than 0, this user has enabled paid messages \u00bb and we must pay the specified amount of Stars to send messages to them, see here \u00bb for the full flow. If set and equal to 0, the user requires payment in general but we were exempted from paying for any of the reasons specified in the docs \u00bb.",
+ "settings": "Peer settings",
+ "sponsored_enabled": "Whether ads were re-enabled for the current account (only accessible to the currently logged-in user), see here \u00bb for more info.",
+ "stargifts_count": "Number of gifts the user has chosen to display on their profile",
+ "starref_program": "This bot has an active referral program \u00bb",
+ "stars_my_pending_rating": "Our pending star rating, only visible for ourselves.",
+ "stars_my_pending_rating_date": "When the pending star rating will be applied, only visible for ourselves.",
+ "stars_rating": "The user's star rating.",
+ "stories": "Active stories \u00bb",
+ "stories_pinned_available": "Whether this user has some pinned stories.",
+ "theme": "The chat theme associated with this user \u00bb.",
+ "translations_disabled": "Whether the real-time chat translation popup should be hidden.",
+ "ttl_period": "Time To Live of all messages in this chat; once a message is this many seconds old, it must be deleted.",
+ "video_calls_available": "Whether the user can receive video calls",
+ "voice_messages_forbidden": "Whether this user doesn't allow sending voice messages in a private chat with them",
+ "wallpaper": "Wallpaper to use in the private chat with the user.",
+ "wallpaper_overridden": "Whether the other user has chosen a custom wallpaper for us using messages.setChatWallPaper and the for_both flag, see here \u00bb for more info."
+ }
+ },
+ "UserProfilePhoto": {
+ "desc": "User profile photo.",
+ "params": {
+ "dc_id": "DC ID where the photo is stored",
+ "flags": "Flags, see TL conditional fields",
+ "has_video": "Whether an animated profile picture is available for this user",
+ "personal": "Whether this profile photo is only visible to us (i.e. it was set using photos.uploadContactProfilePhoto).",
+ "photo_id": "Identifier of the respective photo",
+ "stripped_thumb": "Stripped thumbnail"
+ }
+ },
+ "UserProfilePhotoEmpty": {
+ "desc": "Profile photo has not been set, or was hidden.",
+ "params": {}
+ },
+ "UserStatusEmpty": {
+ "desc": "User status has not been set yet.",
+ "params": {}
+ },
+ "UserStatusHidden": {
+ "desc": "",
+ "params": {}
+ },
+ "UserStatusLastMonth": {
+ "desc": "Online status: last seen last month",
+ "params": {
+ "by_me": "If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here \u00bb for more info.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "UserStatusLastWeek": {
+ "desc": "Online status: last seen last week",
+ "params": {
+ "by_me": "If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here \u00bb for more info.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "UserStatusOffline": {
+ "desc": "The user's offline status.",
+ "params": {
+ "was_online": "Time the user was last seen online"
+ }
+ },
+ "UserStatusOnline": {
+ "desc": "Online status of the user.",
+ "params": {
+ "expires": "Time to expiration of the current online status"
+ }
+ },
+ "UserStatusRecently": {
+ "desc": "Online status: last seen recently",
+ "params": {
+ "by_me": "If set, the exact user status of this user is actually available to us, but to view it we must first purchase a Premium subscription, or allow this user to see our exact last online status. See here \u00bb for more info.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "Username": {
+ "desc": "Contains information about a username.",
+ "params": {
+ "active": "Whether the username is active.",
+ "editable": "Whether the username is editable, meaning it wasn't bought on fragment.",
+ "flags": "Flags, see TL conditional fields",
+ "username": "The username."
+ }
+ },
+ "VideoSize": {
+ "desc": "An animated profile picture in MPEG4 format",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "h": "Video height",
+ "size": "File size",
+ "type": "u for animated profile pictures, and v for trimmed and downscaled video previews",
+ "video_start_ts": "Timestamp that should be shown as static preview to the user (seconds)",
+ "w": "Video width"
+ }
+ },
+ "VideoSizeEmojiMarkup": {
+ "desc": "An animated profile picture based on a custom emoji sticker.",
+ "params": {
+ "background_colors": "1, 2, 3 or 4 RBG-24 colors used to generate a solid (1), gradient (2) or freeform gradient (3, 4) background, similar to how fill wallpapers are generated. The rotation angle for gradient backgrounds is 0.",
+ "emoji_id": "Custom emoji ID: the custom emoji sticker is shown at the center of the profile picture and occupies at most 67% of it."
+ }
+ },
+ "VideoSizeStickerMarkup": {
+ "desc": "An animated profile picture based on a sticker.",
+ "params": {
+ "background_colors": "1, 2, 3 or 4 RBG-24 colors used to generate a solid (1), gradient (2) or freeform gradient (3, 4) background, similar to how fill wallpapers are generated. The rotation angle for gradient backgrounds is 0.",
+ "sticker_id": "Sticker ID",
+ "stickerset": "Stickerset"
+ }
+ },
+ "WallPaper": {
+ "desc": "Represents a wallpaper based on an image.",
+ "params": {
+ "access_hash": "Access hash",
+ "creator": "Whether we created this wallpaper",
+ "dark": "Whether this wallpaper should be used in dark mode.",
+ "default": "Whether this is the default wallpaper",
+ "document": "The actual wallpaper",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Identifier",
+ "pattern": "Whether this is a pattern wallpaper \u00bb",
+ "settings": "Info on how to generate the wallpaper, according to these instructions \u00bb.",
+ "slug": "Unique wallpaper ID, used when generating wallpaper links or importing wallpaper links."
+ }
+ },
+ "WallPaperNoFile": {
+ "desc": "Represents a wallpaper only based on colors/gradients.",
+ "params": {
+ "dark": "Whether this wallpaper should be used in dark mode.",
+ "default": "Whether this is the default wallpaper",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Wallpaper ID",
+ "settings": "Info on how to generate the wallpaper."
+ }
+ },
+ "WallPaperSettings": {
+ "desc": "Wallpaper rendering information.",
+ "params": {
+ "background_color": "Used for solid \u00bb, gradient \u00bb and freeform gradient \u00bb fills.",
+ "blur": "For image wallpapers \u00bb: if set, the JPEG must be downscaled to fit in 450x450 square and then box-blurred with radius 12.",
+ "emoticon": "If set, this wallpaper can be used as a channel wallpaper and is represented by the specified UTF-8 emoji.",
+ "flags": "Flags, see TL conditional fields",
+ "fourth_background_color": "Used for freeform gradient \u00bb fills.",
+ "intensity": "Used for pattern wallpapers \u00bb.",
+ "motion": "If set, the background needs to be slightly moved when the device is rotated.",
+ "rotation": "Clockwise rotation angle of the gradient, in degrees; 0-359. Should be always divisible by 45.",
+ "second_background_color": "Used for gradient \u00bb and freeform gradient \u00bb fills.",
+ "third_background_color": "Used for freeform gradient \u00bb fills."
+ }
+ },
+ "WebAuthorization": {
+ "desc": "Represents a bot logged in using the Telegram login widget",
+ "params": {
+ "bot_id": "Bot ID",
+ "browser": "Browser user-agent",
+ "date_active": "When was the web session last active",
+ "date_created": "When was the web session created",
+ "domain": "The domain name of the website on which the user has logged in.",
+ "hash": "Authorization hash",
+ "ip": "IP address",
+ "platform": "Platform",
+ "region": "Region, determined from IP address"
+ }
+ },
+ "WebDocument": {
+ "desc": "Remote document",
+ "params": {
+ "access_hash": "Access hash",
+ "attributes": "Attributes for media types",
+ "mime_type": "MIME type",
+ "size": "File size",
+ "url": "Document URL"
+ }
+ },
+ "WebDocumentNoProxy": {
+ "desc": "Remote document that can be downloaded without proxying through telegram",
+ "params": {
+ "attributes": "Attributes for media types",
+ "mime_type": "MIME type",
+ "size": "File size",
+ "url": "Document URL"
+ }
+ },
+ "WebPage": {
+ "desc": "Webpage preview",
+ "params": {
+ "attributes": "Webpage attributes",
+ "author": "Author of the content",
+ "cached_page": "Page contents in instant view format",
+ "description": "Content description",
+ "display_url": "Webpage URL to be displayed to the user",
+ "document": "Preview of the content as a media file",
+ "duration": "Duration of the content, in seconds",
+ "embed_height": "Height of the embedded preview",
+ "embed_type": "MIME type of the embedded preview, (e.g., text/html or video/mp4)",
+ "embed_url": "URL to show in the embedded preview",
+ "embed_width": "Width of the embedded preview",
+ "flags": "Flags, see TL conditional fields",
+ "has_large_media": "Whether the size of the media in the preview can be changed.",
+ "hash": "Hash used for caching, for more info click here",
+ "id": "Preview ID",
+ "photo": "Image representing the content",
+ "site_name": "Short name of the site (e.g., Google Docs, App Store)",
+ "title": "Title of the content",
+ "type": "Type of the web page. One of the following: - app- article- document- gif- photo- profile- telegram_album- telegram_background- telegram_bot- telegram_botapp- telegram_call- telegram_channel- telegram_channel_boost- telegram_channel_direct- telegram_channel_request- telegram_chat- telegram_chat_request- telegram_chatlist- telegram_collection- telegram_community- telegram_giftcode- telegram_group_boost- telegram_livestream- telegram_megagroup- telegram_megagroup_request- telegram_message- telegram_nft- telegram_stickerset- telegram_story- telegram_story_album- telegram_theme- telegram_user- telegram_videochat- telegram_voicechat- video",
+ "url": "URL of previewed webpage",
+ "video_cover_photo": "Represents a custom video cover."
+ }
+ },
+ "WebPageAttributeStarGiftCollection": {
+ "desc": "Contains info about a gift collection \u00bb for a webPage preview of a gift collection \u00bb (the webPage will have a type of telegram_collection).",
+ "params": {
+ "icons": "Gifts in the collection."
+ }
+ },
+ "WebPageAttributeStickerSet": {
+ "desc": "Contains info about a stickerset \u00bb, for a webPage preview of a stickerset deep link \u00bb (the webPage will have a type of telegram_stickerset).",
+ "params": {
+ "emojis": "Whether this i s a custom emoji stickerset.",
+ "flags": "Flags, see TL conditional fields",
+ "stickers": "A subset of the stickerset in the stickerset.",
+ "text_color": "Whether the color of this TGS custom emoji stickerset should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context."
+ }
+ },
+ "WebPageAttributeStory": {
+ "desc": "Webpage preview of a Telegram story",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Story ID",
+ "peer": "Peer that posted the story",
+ "story": "May contain the story, if not the story should be fetched when and if needed using stories.getStoriesByID with the above id and peer."
+ }
+ },
+ "WebPageAttributeTheme": {
+ "desc": "Page theme",
+ "params": {
+ "documents": "Theme files",
+ "flags": "Flags, see TL conditional fields",
+ "settings": "Theme settings"
+ }
+ },
+ "WebPageAttributeUniqueStarGift": {
+ "desc": "Contains info about collectible gift \u00bb for a webPage preview of a collectible gift \u00bb (the webPage will have a type of telegram_nft).",
+ "params": {
+ "gift": "The starGiftUnique constructor."
+ }
+ },
+ "WebPageEmpty": {
+ "desc": "No preview is available for the webpage",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Preview ID",
+ "url": "URL of the webpage."
+ }
+ },
+ "WebPageNotModified": {
+ "desc": "The preview of the webpage hasn't changed",
+ "params": {
+ "cached_page_views": "Page view count",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "WebPagePending": {
+ "desc": "A preview of the webpage is currently being generated",
+ "params": {
+ "date": "When was the processing started",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of preview",
+ "url": "URL of the webpage"
+ }
+ },
+ "WebPageUrlPending": {
+ "desc": "",
+ "params": {}
+ },
+ "WebViewMessageSent": {
+ "desc": "Info about a sent inline webview message",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Message ID"
+ }
+ },
+ "WebViewResultUrl": {
+ "desc": "Contains the webview URL with appropriate theme and user info parameters added",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "fullscreen": "If set, the app must be opened in fullscreen",
+ "fullsize": "If set, the app must be opened in fullsize mode instead of compact mode.",
+ "query_id": "Webview session ID (only returned by inline button mini apps, menu button mini apps, attachment menu mini apps).",
+ "url": "Webview URL to open"
+ }
+ },
+ "account.AuthorizationForm": {
+ "desc": "Telegram Passport authorization form",
+ "params": {
+ "errors": "Telegram Passport errors",
+ "flags": "Flags, see TL conditional fields",
+ "privacy_policy_url": "URL of the service's privacy policy",
+ "required_types": "Required Telegram Passport documents",
+ "users": "Info about the bot to which the form will be submitted",
+ "values": "Already submitted Telegram Passport documents"
+ }
+ },
+ "account.Authorizations": {
+ "desc": "Logged-in sessions",
+ "params": {
+ "authorization_ttl_days": "Time-to-live of session",
+ "authorizations": "Logged-in sessions"
+ }
+ },
+ "account.AutoDownloadSettings": {
+ "desc": "Media autodownload settings",
+ "params": {
+ "high": "High data usage preset",
+ "low": "Low data usage preset",
+ "medium": "Medium data usage preset"
+ }
+ },
+ "account.AutoSaveSettings": {
+ "desc": "Contains media autosave settings",
+ "params": {
+ "broadcasts_settings": "Default media autosave settings for channels",
+ "chats": "Chats mentioned in the peer-specific granular autosave settings",
+ "chats_settings": "Default media autosave settings for groups and supergroups",
+ "exceptions": "Peer-specific granular autosave settings",
+ "users": "Users mentioned in the peer-specific granular autosave settings",
+ "users_settings": "Default media autosave settings for private chats"
+ }
+ },
+ "account.BusinessChatLinks": {
+ "desc": "Contains info about business chat deep links \u00bb created by the current account.",
+ "params": {
+ "chats": "Mentioned chats",
+ "links": "Links",
+ "users": "Mentioned users"
+ }
+ },
+ "account.ChatThemes": {
+ "desc": "Available chat themes",
+ "params": {
+ "chats": "Chats mentioned in the themes field.",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash to pass to the method that returned this constructor, to avoid refetching the result if it hasn't changed.",
+ "next_offset": "Next offset for pagination.",
+ "themes": "Themes.",
+ "users": "Users mentioned in the themes field."
+ }
+ },
+ "account.ChatThemesNotModified": {
+ "desc": "The available chat themes were not modified",
+ "params": {}
+ },
+ "account.ConnectedBots": {
+ "desc": "Info about currently connected business bots.",
+ "params": {
+ "connected_bots": "Info about the connected bots",
+ "users": "Bot information"
+ }
+ },
+ "account.ContentSettings": {
+ "desc": "Sensitive content settings",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "sensitive_can_change": "Whether the current client can change the sensitive content settings to view NSFW content",
+ "sensitive_enabled": "Whether viewing of sensitive (NSFW) content is enabled"
+ }
+ },
+ "account.EmailVerified": {
+ "desc": "The email was verified correctly.",
+ "params": {
+ "email": "The verified email address."
+ }
+ },
+ "account.EmailVerifiedLogin": {
+ "desc": "The email was verified correctly, and a login code was just sent to it.",
+ "params": {
+ "email": "The verified email address.",
+ "sent_code": "Info about the sent login code"
+ }
+ },
+ "account.EmojiStatuses": {
+ "desc": "A list of emoji statuses",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "statuses": "Emoji statuses"
+ }
+ },
+ "account.EmojiStatusesNotModified": {
+ "desc": "The server-side list of emoji statuses hasn't changed",
+ "params": {}
+ },
+ "account.PaidMessagesRevenue": {
+ "desc": "Total number of non-refunded Telegram Stars a user has spent on sending us messages either directly or through a channel, see here \u00bb for more info on paid messages.",
+ "params": {
+ "stars_amount": "Amount in Stars."
+ }
+ },
+ "account.Password": {
+ "desc": "Configuration for two-factor authorization",
+ "params": {
+ "current_algo": "The KDF algorithm for SRP two-factor authentication of the current password",
+ "email_unconfirmed_pattern": "A password recovery email with the specified pattern is still awaiting verification",
+ "flags": "Flags, see TL conditional fields",
+ "has_password": "Whether the user has a password",
+ "has_recovery": "Whether the user has a recovery method configured",
+ "has_secure_values": "Whether telegram passport is enabled",
+ "hint": "Text hint for the password",
+ "login_email_pattern": "A verified login email with the specified pattern is configured",
+ "new_algo": "The KDF algorithm for SRP two-factor authentication to use when creating new passwords",
+ "new_secure_algo": "The KDF algorithm for telegram passport",
+ "pending_reset_date": "The 2FA password will be automatically removed at this date, unless the user cancels the operation",
+ "secure_random": "Secure random string",
+ "srp_B": "Srp B param for SRP authorization",
+ "srp_id": "Srp ID param for SRP authorization"
+ }
+ },
+ "account.PasswordInputSettings": {
+ "desc": "Settings for setting up a new password",
+ "params": {
+ "email": "Password recovery email",
+ "flags": "Flags, see TL conditional fields",
+ "hint": "Text hint for the password",
+ "new_algo": "The SRP algorithm to use",
+ "new_password_hash": "The computed password hash",
+ "new_secure_settings": "Telegram passport settings"
+ }
+ },
+ "account.PasswordSettings": {
+ "desc": "Private info associated to the password info (recovery email, telegram passport info & so on)",
+ "params": {
+ "email": "2FA Recovery email",
+ "flags": "Flags, see TL conditional fields",
+ "secure_settings": "Telegram passport settings"
+ }
+ },
+ "account.PrivacyRules": {
+ "desc": "Privacy rules",
+ "params": {
+ "chats": "Chats to which the rules apply",
+ "rules": "Privacy rules",
+ "users": "Users to which the rules apply"
+ }
+ },
+ "account.ResetPasswordFailedWait": {
+ "desc": "You recently requested a password reset that was canceled, please wait until the specified date before requesting another reset.",
+ "params": {
+ "retry_date": "Wait until this date before requesting another reset."
+ }
+ },
+ "account.ResetPasswordOk": {
+ "desc": "The 2FA password was reset successfully.",
+ "params": {}
+ },
+ "account.ResetPasswordRequestedWait": {
+ "desc": "You successfully requested a password reset, please wait until the specified date before finalizing the reset.",
+ "params": {
+ "until_date": "Wait until this date before finalizing the reset."
+ }
+ },
+ "account.ResolvedBusinessChatLinks": {
+ "desc": "Contains info about a single resolved business chat deep link \u00bb.",
+ "params": {
+ "chats": "Mentioned chats",
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Message to pre-fill in the message input field.",
+ "peer": "Destination peer",
+ "users": "Mentioned users"
+ }
+ },
+ "account.SavedMusicIds": {
+ "desc": "List of IDs of songs (document.ids) currently pinned on our profile, see here \u00bb for more info.",
+ "params": {
+ "ids": "Full list of document.ids"
+ }
+ },
+ "account.SavedMusicIdsNotModified": {
+ "desc": "The list of IDs of songs (document.ids) currently pinned on our profile hasn't changed.",
+ "params": {}
+ },
+ "account.SavedRingtone": {
+ "desc": "The notification sound was already in MP3 format and was saved without any modification",
+ "params": {}
+ },
+ "account.SavedRingtoneConverted": {
+ "desc": "The notification sound was not in MP3 format and was successfully converted and saved, use the returned Document to refer to the notification sound from now on",
+ "params": {
+ "document": "The converted notification sound"
+ }
+ },
+ "account.SavedRingtones": {
+ "desc": "A list of saved notification sounds",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "ringtones": "Saved notification sounds"
+ }
+ },
+ "account.SavedRingtonesNotModified": {
+ "desc": "The notification sound list hasn't changed.",
+ "params": {}
+ },
+ "account.SentEmailCode": {
+ "desc": "The sent email code",
+ "params": {
+ "email_pattern": "The email (to which the code was sent) must match this pattern",
+ "length": "The length of the verification code"
+ }
+ },
+ "account.Takeout": {
+ "desc": "Takeout info",
+ "params": {
+ "id": "Takeout ID"
+ }
+ },
+ "account.Themes": {
+ "desc": "Installed themes",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "themes": "Themes"
+ }
+ },
+ "account.ThemesNotModified": {
+ "desc": "No new themes were installed",
+ "params": {}
+ },
+ "account.TmpPassword": {
+ "desc": "Temporary payment password",
+ "params": {
+ "tmp_password": "Temporary password",
+ "valid_until": "Validity period"
+ }
+ },
+ "account.WallPapers": {
+ "desc": "Installed wallpapers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "wallpapers": "Wallpapers"
+ }
+ },
+ "account.WallPapersNotModified": {
+ "desc": "No new wallpapers were found",
+ "params": {}
+ },
+ "account.WebAuthorizations": {
+ "desc": "Web authorizations",
+ "params": {
+ "authorizations": "Web authorization list",
+ "users": "Users"
+ }
+ },
+ "auth.Authorization": {
+ "desc": "Contains user authorization info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "future_auth_token": "A future auth token",
+ "otherwise_relogin_days": "If and only if setup_password_required is set and the user declines to set a 2-step verification password, they will be able to log into their account via SMS again only after this many days pass.",
+ "setup_password_required": "Suggests the user to set up a 2-step verification password to be able to log in again",
+ "tmp_sessions": "Temporary passport sessions",
+ "user": "Info on authorized user"
+ }
+ },
+ "auth.AuthorizationSignUpRequired": {
+ "desc": "An account with this phone number doesn't exist on telegram: the user has to enter basic information and sign up",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "terms_of_service": "Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram"
+ }
+ },
+ "auth.CodeTypeCall": {
+ "desc": "The next time, the authentication code is to be delivered via an outgoing phone call.",
+ "params": {}
+ },
+ "auth.CodeTypeFlashCall": {
+ "desc": "The next time, the authentication code will be delivered via an immediately canceled incoming call.",
+ "params": {}
+ },
+ "auth.CodeTypeFragmentSms": {
+ "desc": "The next time, the authentication code will be delivered via fragment.com",
+ "params": {}
+ },
+ "auth.CodeTypeMissedCall": {
+ "desc": "The next time, the authentication code will be delivered via an immediately canceled incoming call, handled manually by the user.",
+ "params": {}
+ },
+ "auth.CodeTypeSms": {
+ "desc": "The next time, the authentication code will be delivered via an immediately canceled incoming call.",
+ "params": {}
+ },
+ "auth.ExportedAuthorization": {
+ "desc": "Data for copying of authorization between data centers.",
+ "params": {
+ "bytes": "authorizes key",
+ "id": "current user identifier"
+ }
+ },
+ "auth.LoggedOut": {
+ "desc": "Future auth token \u00bb to be used on subsequent authorizations",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "future_auth_token": "Future auth token \u00bb to be used on subsequent authorizations"
+ }
+ },
+ "auth.LoginToken": {
+ "desc": "Login token (for QR code login)",
+ "params": {
+ "expires": "Expiration date of QR code",
+ "token": "Token to render in QR code"
+ }
+ },
+ "auth.LoginTokenMigrateTo": {
+ "desc": "Repeat the query to the specified DC",
+ "params": {
+ "dc_id": "DC ID",
+ "token": "Token to use for login"
+ }
+ },
+ "auth.LoginTokenSuccess": {
+ "desc": "Login via token (QR code) succeeded!",
+ "params": {
+ "authorization": "Authorization info"
+ }
+ },
+ "auth.PasswordRecovery": {
+ "desc": "Recovery info of a 2FA password, only for accounts with a recovery email configured.",
+ "params": {
+ "email_pattern": "The email to which the recovery code was sent must match this pattern."
+ }
+ },
+ "auth.SentCode": {
+ "desc": "Contains info about a sent verification code.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "next_type": "Phone code type that will be sent next, if the phone code is not received within timeout seconds: to send it use auth.resendCode",
+ "phone_code_hash": "Phone code hash, to be stored and later re-used with auth.signIn",
+ "timeout": "Timeout for reception of the phone code",
+ "type": "Phone code type"
+ }
+ },
+ "auth.SentCodePaymentRequired": {
+ "desc": "Official apps may receive this constructor, indicating that due to the high cost of SMS verification codes for the user's country/provider, the user must purchase a Telegram Premium subscription in order to proceed with the login/signup.",
+ "params": {
+ "phone_code_hash": "Phone code hash, to be stored and later re-used with auth.signIn",
+ "store_product": "Store identifier of the Telegram Premium subscription.",
+ "support_email_address": "An email address that can be contacted for more information about this request.",
+ "support_email_subject": "The mandatory subject for the email."
+ }
+ },
+ "auth.SentCodeSuccess": {
+ "desc": "The user successfully authorized using future auth tokens",
+ "params": {
+ "authorization": "Authorization info"
+ }
+ },
+ "auth.SentCodeTypeApp": {
+ "desc": "The code was sent through the telegram app",
+ "params": {
+ "length": "Length of the code in bytes"
+ }
+ },
+ "auth.SentCodeTypeCall": {
+ "desc": "The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input.",
+ "params": {
+ "length": "Length of the verification code"
+ }
+ },
+ "auth.SentCodeTypeEmailCode": {
+ "desc": "The code was sent via the previously configured login email \u00bb",
+ "params": {
+ "apple_signin_allowed": "Whether authorization through Apple ID is allowed",
+ "email_pattern": "Pattern of the email",
+ "flags": "Flags, see TL conditional fields",
+ "google_signin_allowed": "Whether authorization through Google ID is allowed",
+ "length": "Length of the sent verification code",
+ "reset_available_period": "Clients should wait for the specified amount of seconds before allowing the user to invoke auth.resetLoginEmail (will be 0 for Premium users).",
+ "reset_pending_date": "An email reset was already requested, and will occur at the specified date."
+ }
+ },
+ "auth.SentCodeTypeFirebaseSms": {
+ "desc": "An authentication code should be delivered via SMS after Firebase attestation, as described in the auth documentation \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "length": "Length of the code that will be delivered.",
+ "nonce": "On Android, the nonce to be used as described in the auth documentation \u00bb",
+ "play_integrity_nonce": "Play Integrity API nonce",
+ "play_integrity_project_id": "Google Play Integrity project ID",
+ "push_timeout": "On iOS: if a push notification with the ios_push_secret isn't received within push_timeout seconds, the next_type authentication method must be used, with auth.resendCode.",
+ "receipt": "On iOS, must be compared with the receipt extracted from the received push notification."
+ }
+ },
+ "auth.SentCodeTypeFlashCall": {
+ "desc": "The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern.",
+ "params": {
+ "pattern": "pattern to match"
+ }
+ },
+ "auth.SentCodeTypeFragmentSms": {
+ "desc": "The code was delivered via fragment.com.",
+ "params": {
+ "length": "Length of the delivered code.",
+ "url": "Open the specified URL to log into fragment.com with the wallet that owns the specified phone number and view the code."
+ }
+ },
+ "auth.SentCodeTypeMissedCall": {
+ "desc": "The code will be sent via a flash phone call, that will be closed immediately. The last digits of the phone number that calls are the code that must be entered manually by the user.",
+ "params": {
+ "length": "Length of the verification code",
+ "prefix": "Prefix of the phone number from which the call will be made"
+ }
+ },
+ "auth.SentCodeTypeSetUpEmailRequired": {
+ "desc": "The user should add and verify an email address in order to login as described here \u00bb.",
+ "params": {
+ "apple_signin_allowed": "Whether authorization through Apple ID is allowed",
+ "flags": "Flags, see TL conditional fields",
+ "google_signin_allowed": "Whether authorization through Google ID is allowed"
+ }
+ },
+ "auth.SentCodeTypeSms": {
+ "desc": "The code was sent via SMS",
+ "params": {
+ "length": "Length of the code in bytes"
+ }
+ },
+ "auth.SentCodeTypeSmsPhrase": {
+ "desc": "The code was sent via SMS as a secret phrase starting with the word specified in beginning",
+ "params": {
+ "beginning": "If set, the secret phrase (and the SMS) starts with this word.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "auth.SentCodeTypeSmsWord": {
+ "desc": "The code was sent via SMS as a secret word, starting with the letter specified in beginning",
+ "params": {
+ "beginning": "If set, the secret word in the sent SMS (which may contain multiple words) starts with this letter.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "bots.BotInfo": {
+ "desc": "Localized information about a bot.",
+ "params": {
+ "about": "Bot about text",
+ "description": "Bot description",
+ "name": "Bot name"
+ }
+ },
+ "bots.PopularAppBots": {
+ "desc": "Popular Main Mini Apps, to be used in the apps tab of global search \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Offset for pagination.",
+ "users": "The bots associated to each Main Mini App, see here \u00bb for more info."
+ }
+ },
+ "bots.PreviewInfo": {
+ "desc": "Contains info about Main Mini App previews, see here \u00bb for more info.",
+ "params": {
+ "lang_codes": "All available language codes for which preview medias were uploaded (regardless of the language code passed to bots.getPreviewInfo).",
+ "media": "All preview medias for the language code passed to bots.getPreviewInfo."
+ }
+ },
+ "channels.AdminLogResults": {
+ "desc": "Admin log events",
+ "params": {
+ "chats": "Chats mentioned in events",
+ "events": "Admin log events",
+ "users": "Users mentioned in events"
+ }
+ },
+ "channels.ChannelParticipant": {
+ "desc": "Represents a channel participant",
+ "params": {
+ "chats": "Mentioned chats",
+ "participant": "The channel participant",
+ "users": "Users"
+ }
+ },
+ "channels.ChannelParticipants": {
+ "desc": "Represents multiple channel participants",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of participants that correspond to the given query",
+ "participants": "Participants",
+ "users": "Users mentioned in participant info"
+ }
+ },
+ "channels.ChannelParticipantsNotModified": {
+ "desc": "No new participant info could be found",
+ "params": {}
+ },
+ "channels.SendAsPeers": {
+ "desc": "A list of peers that can be used to send messages in a specific group",
+ "params": {
+ "chats": "Mentioned chats",
+ "peers": "Peers that can be used to send messages to the group",
+ "users": "Mentioned users"
+ }
+ },
+ "channels.SponsoredMessageReportResultAdsHidden": {
+ "desc": "Sponsored messages were hidden for the user in all chats.",
+ "params": {}
+ },
+ "channels.SponsoredMessageReportResultChooseOption": {
+ "desc": "The user must choose a report option from the localized options available in options, and after selection, channels.reportSponsoredMessage must be invoked again, passing the option's option field to the option param of the method.",
+ "params": {
+ "options": "Localized list of options.",
+ "title": "Title of the option selection popup."
+ }
+ },
+ "channels.SponsoredMessageReportResultReported": {
+ "desc": "The sponsored message was reported successfully.",
+ "params": {}
+ },
+ "chatlists.ChatlistInvite": {
+ "desc": "Info about a chat folder deep link \u00bb.",
+ "params": {
+ "chats": "Related chat information",
+ "emoticon": "Emoji to use as icon for the folder.",
+ "flags": "Flags, see TL conditional fields",
+ "peers": "Supergroups and channels to join",
+ "title": "Name of the link",
+ "title_noanimate": "If set, any animated emojis present in title should not be animated and should be instead frozen on the first frame.",
+ "users": "Related user information"
+ }
+ },
+ "chatlists.ChatlistInviteAlready": {
+ "desc": "Updated info about a chat folder deep link \u00bb we already imported.",
+ "params": {
+ "already_peers": "Peers that were already imported",
+ "chats": "Related chat information",
+ "filter_id": "ID of the imported folder",
+ "missing_peers": "New peers to be imported",
+ "users": "Related user information"
+ }
+ },
+ "chatlists.ChatlistUpdates": {
+ "desc": "Updated information about a chat folder deep link \u00bb.",
+ "params": {
+ "chats": "Related chat information",
+ "missing_peers": "New peers to join",
+ "users": "Related user information"
+ }
+ },
+ "chatlists.ExportedChatlistInvite": {
+ "desc": "Info about an exported chat folder deep link \u00bb.",
+ "params": {
+ "filter": "Folder ID",
+ "invite": "The exported chat folder deep link \u00bb."
+ }
+ },
+ "chatlists.ExportedInvites": {
+ "desc": "Info about multiple chat folder deep links \u00bb.",
+ "params": {
+ "chats": "Related chat information",
+ "invites": "The chat folder deep links \u00bb.",
+ "users": "Related user information"
+ }
+ },
+ "contacts.Blocked": {
+ "desc": "Full list of blocked users.",
+ "params": {
+ "blocked": "List of blocked users",
+ "chats": "Blocked chats",
+ "users": "List of users"
+ }
+ },
+ "contacts.BlockedSlice": {
+ "desc": "Incomplete list of blocked users.",
+ "params": {
+ "blocked": "List of blocked users",
+ "chats": "Blocked chats",
+ "count": "Total number of elements in the list",
+ "users": "List of users"
+ }
+ },
+ "contacts.ContactBirthdays": {
+ "desc": "Birthday information of our contacts.",
+ "params": {
+ "contacts": "Birthday info",
+ "users": "User information"
+ }
+ },
+ "contacts.Contacts": {
+ "desc": "The current user's contact list and info on users.",
+ "params": {
+ "contacts": "Contact list",
+ "saved_count": "Number of contacts that were saved successfully",
+ "users": "User list"
+ }
+ },
+ "contacts.ContactsNotModified": {
+ "desc": "Contact list on the server is the same as the list on the client.",
+ "params": {}
+ },
+ "contacts.Found": {
+ "desc": "Users found by name substring and auxiliary data.",
+ "params": {
+ "chats": "Found chats",
+ "my_results": "Personalized results",
+ "results": "List of found user identifiers",
+ "users": "List of users"
+ }
+ },
+ "contacts.ImportedContacts": {
+ "desc": "Info on successfully imported contacts.",
+ "params": {
+ "imported": "List of successfully imported contacts",
+ "popular_invites": "Popular contacts",
+ "retry_contacts": "List of contact ids that could not be imported due to system limitation and will need to be imported at a later date.",
+ "users": "List of users"
+ }
+ },
+ "contacts.ResolvedPeer": {
+ "desc": "Resolved peer",
+ "params": {
+ "chats": "Chats",
+ "peer": "The peer",
+ "users": "Users"
+ }
+ },
+ "contacts.SponsoredPeers": {
+ "desc": "Sponsored peers.",
+ "params": {
+ "chats": "Info about sponsored chats and channels",
+ "peers": "Sponsored peers.",
+ "users": "Info about sponsored users"
+ }
+ },
+ "contacts.SponsoredPeersEmpty": {
+ "desc": "There are no sponsored peers for this query.",
+ "params": {}
+ },
+ "contacts.TopPeers": {
+ "desc": "Top peers",
+ "params": {
+ "categories": "Top peers by top peer category",
+ "chats": "Chats",
+ "users": "Users"
+ }
+ },
+ "contacts.TopPeersDisabled": {
+ "desc": "Top peers disabled",
+ "params": {}
+ },
+ "contacts.TopPeersNotModified": {
+ "desc": "Top peer info hasn't changed",
+ "params": {}
+ },
+ "fragment.CollectibleInfo": {
+ "desc": "Info about a fragment collectible.",
+ "params": {
+ "amount": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "crypto_amount": "Price, in the smallest units of the cryptocurrency.",
+ "crypto_currency": "Cryptocurrency name.",
+ "currency": "Three-letter ISO 4217 currency code for amount",
+ "purchase_date": "Purchase date (unixtime)",
+ "url": "Fragment URL with more info about the collectible"
+ }
+ },
+ "help.AppConfig": {
+ "desc": "Contains various client configuration parameters",
+ "params": {
+ "config": "Client configuration parameters",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "help.AppConfigNotModified": {
+ "desc": "The client configuration parameters haven't changed",
+ "params": {}
+ },
+ "help.AppUpdate": {
+ "desc": "An update is available for the application.",
+ "params": {
+ "can_not_skip": "Unskippable, the new info must be shown to the user (with a popup or something else)",
+ "document": "Application binary",
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Update ID",
+ "sticker": "Associated sticker",
+ "text": "Text description of the update",
+ "url": "Application download URL",
+ "version": "New version name"
+ }
+ },
+ "help.CountriesList": {
+ "desc": "Name, ISO code, localized name and phone codes/patterns of all available countries",
+ "params": {
+ "countries": "Name, ISO code, localized name and phone codes/patterns of all available countries",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "help.CountriesListNotModified": {
+ "desc": "The country list has not changed",
+ "params": {}
+ },
+ "help.Country": {
+ "desc": "Name, ISO code, localized name and phone codes/patterns of a specific country",
+ "params": {
+ "country_codes": "Phone codes/patterns",
+ "default_name": "Name of the country in the country's language",
+ "flags": "Flags, see TL conditional fields",
+ "hidden": "Whether this country should not be shown in the list",
+ "iso2": "ISO code of country",
+ "name": "Name of the country in the user's language, if different from the original name"
+ }
+ },
+ "help.CountryCode": {
+ "desc": "Country code and phone number pattern of a specific country",
+ "params": {
+ "country_code": "ISO country code",
+ "flags": "Flags, see TL conditional fields",
+ "patterns": "Phone patterns: for example, XXX XXX XXX",
+ "prefixes": "Possible phone prefixes"
+ }
+ },
+ "help.DeepLinkInfo": {
+ "desc": "Deep link info, see the here for more details",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Message to show to the user",
+ "update_app": "An update of the app is required to parse this link"
+ }
+ },
+ "help.DeepLinkInfoEmpty": {
+ "desc": "Deep link info empty",
+ "params": {}
+ },
+ "help.InviteText": {
+ "desc": "Text of a text message with an invitation to install Telegram.",
+ "params": {
+ "message": "Text of the message"
+ }
+ },
+ "help.NoAppUpdate": {
+ "desc": "No updates are available for the application.",
+ "params": {}
+ },
+ "help.PassportConfig": {
+ "desc": "Telegram passport configuration",
+ "params": {
+ "countries_langs": "Localization",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "help.PassportConfigNotModified": {
+ "desc": "Password configuration not modified",
+ "params": {}
+ },
+ "help.PeerColorOption": {
+ "desc": "Contains info about a color palette \u00bb.",
+ "params": {
+ "channel_min_level": "Channels can use this palette only after reaching at least the boost level specified in this field.",
+ "color_id": "Palette ID.",
+ "colors": "Light mode palette. Will be empty for IDs 0 to 6 inclusive, in which case a palette containing a single color from the following colors should be used: red, orange, violet, green, cyan, blue, pink for indexes 0 to 6 (i.e. the same colors used for randomized fallback message accent colors).",
+ "dark_colors": "Dark mode palette. Optional, defaults to the palette in colors (or the autogenerated palette for IDs 0 to 6) if absent.",
+ "flags": "Flags, see TL conditional fields",
+ "group_min_level": "Supergroups can use this palette only after reaching at least the boost level specified in this field.",
+ "hidden": "Whether this palette should not be displayed as an option to the user when choosing a palette to apply to profile pages or message accents."
+ }
+ },
+ "help.PeerColorProfileSet": {
+ "desc": "Represents a color palette that can be used in profile pages \u00bb.",
+ "params": {
+ "bg_colors": "A list of 1-2 colors in RGB format describing the colors used to generate the actual background used in the profile page.",
+ "palette_colors": "A list of 1-2 colors in RGB format, shown in the color palette settings to describe the current palette.",
+ "story_colors": "A list of 2 colors in RGB format describing the colors of the gradient used for the unread active story indicator around the profile photo."
+ }
+ },
+ "help.PeerColorSet": {
+ "desc": "Represents a color palette that can be used in message accents \u00bb.",
+ "params": {
+ "colors": "A list of 1-3 colors in RGB format, describing the accent color."
+ }
+ },
+ "help.PeerColors": {
+ "desc": "Contains info about multiple color palettes \u00bb.",
+ "params": {
+ "colors": "Usable color palettes.",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "help.PeerColorsNotModified": {
+ "desc": "The list of color palettes has not changed.",
+ "params": {}
+ },
+ "help.PremiumPromo": {
+ "desc": "Telegram Premium promotion information",
+ "params": {
+ "period_options": "Telegram Premium subscription options",
+ "status_entities": "Message entities for styled text",
+ "status_text": "Description of the current state of the user's Telegram Premium subscription",
+ "users": "Related user information",
+ "video_sections": "A list of premium feature identifiers \u00bb, associated to each video",
+ "videos": "A list of videos"
+ }
+ },
+ "help.PromoData": {
+ "desc": "A set of useful suggestions and a PSA/MTProxy sponsored peer, see here \u00bb for more info.",
+ "params": {
+ "chats": "Chat info",
+ "custom_pending_suggestion": "Contains a list of custom pending suggestions \u00bb.",
+ "dismissed_suggestions": "Contains a list of inverted suggestions \u00bb.",
+ "expires": "Unixtime when to re-invoke help.getPromoData.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "MTProxy/PSA peer",
+ "pending_suggestions": "Contains a list of pending suggestions \u00bb.",
+ "proxy": "Set when connecting using an MTProxy that has configured an associated peer (that will be passed in peer, i.e. the channel that sponsored the MTProxy) that should be pinned on top of the chat list.",
+ "psa_message": "For Public Service Announcement peers, contains the PSA itself.",
+ "psa_type": "For Public Service Announcement peers, indicates the type of the PSA.",
+ "users": "User info"
+ }
+ },
+ "help.PromoDataEmpty": {
+ "desc": "No PSA/MTProxy info is available",
+ "params": {
+ "expires": "Re-fetch PSA/MTProxy info after the specified number of seconds"
+ }
+ },
+ "help.RecentMeUrls": {
+ "desc": "Recent t.me URLs",
+ "params": {
+ "chats": "Chats",
+ "urls": "URLs",
+ "users": "Users"
+ }
+ },
+ "help.Support": {
+ "desc": "Info on support user.",
+ "params": {
+ "phone_number": "Phone number",
+ "user": "User"
+ }
+ },
+ "help.SupportName": {
+ "desc": "Localized name for telegram support",
+ "params": {
+ "name": "Localized name"
+ }
+ },
+ "help.TermsOfService": {
+ "desc": "Info about the latest telegram Terms Of Service",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of the new terms",
+ "min_age_confirm": "Minimum age required to sign up to telegram, the user must confirm that they is older than the minimum age.",
+ "popup": "Whether a prompt must be showed to the user, in order to accept the new terms.",
+ "text": "Text of the new terms"
+ }
+ },
+ "help.TermsOfServiceUpdate": {
+ "desc": "Info about an update of telegram's terms of service. If the terms of service are declined, then the account.deleteAccount method should be called with the reason \"Decline ToS update\"",
+ "params": {
+ "expires": "New TOS updates will have to be queried using help.getTermsOfServiceUpdate in expires seconds",
+ "terms_of_service": "New terms of service"
+ }
+ },
+ "help.TermsOfServiceUpdateEmpty": {
+ "desc": "No changes were made to telegram's terms of service",
+ "params": {
+ "expires": "New TOS updates will have to be queried using help.getTermsOfServiceUpdate in expires seconds"
+ }
+ },
+ "help.TimezonesList": {
+ "desc": "Timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours \u00bb.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "timezones": "Timezones"
+ }
+ },
+ "help.TimezonesListNotModified": {
+ "desc": "The timezone list has not changed.",
+ "params": {}
+ },
+ "help.UserInfo": {
+ "desc": "Internal use",
+ "params": {
+ "author": "Author",
+ "date": "Date",
+ "entities": "Message entities for styled text",
+ "message": "Info"
+ }
+ },
+ "help.UserInfoEmpty": {
+ "desc": "Internal use",
+ "params": {}
+ },
+ "messages.AffectedFoundMessages": {
+ "desc": "Messages found and affected by changes",
+ "params": {
+ "messages": "Affected message IDs",
+ "offset": "If bigger than zero, the request must be repeated to remove more messages",
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "messages.AffectedHistory": {
+ "desc": "Affected part of communication history with the user or in a chat.",
+ "params": {
+ "offset": "If a parameter contains positive value, it is necessary to repeat the method call using the given value; during the proceeding of all the history the value itself shall gradually decrease",
+ "pts": "Number of events occurred in a text box",
+ "pts_count": "Number of affected events"
+ }
+ },
+ "messages.AffectedMessages": {
+ "desc": "Events affected by operation",
+ "params": {
+ "pts": "Event count after generation",
+ "pts_count": "Number of events that were generated"
+ }
+ },
+ "messages.AllStickers": {
+ "desc": "Info about all installed stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "sets": "All stickersets"
+ }
+ },
+ "messages.AllStickersNotModified": {
+ "desc": "Info about all installed stickers hasn't changed",
+ "params": {}
+ },
+ "messages.ArchivedStickers": {
+ "desc": "Archived stickersets",
+ "params": {
+ "count": "Number of archived stickers",
+ "sets": "Archived stickersets"
+ }
+ },
+ "messages.AvailableEffects": {
+ "desc": "The full list of usable animated message effects \u00bb.",
+ "params": {
+ "documents": "Documents specified in the effects constructors.",
+ "effects": "Message effects",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "messages.AvailableEffectsNotModified": {
+ "desc": "The full list of usable animated message effects \u00bb hasn't changed.",
+ "params": {}
+ },
+ "messages.AvailableReactions": {
+ "desc": "Animations and metadata associated with message reactions \u00bb",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "reactions": "Animations and metadata associated with message reactions \u00bb"
+ }
+ },
+ "messages.AvailableReactionsNotModified": {
+ "desc": "No new reactions are available",
+ "params": {}
+ },
+ "messages.BotApp": {
+ "desc": "Contains information about a direct link Mini App",
+ "params": {
+ "app": "Bot app information",
+ "flags": "Flags, see TL conditional fields",
+ "has_settings": "Deprecated flag, can be ignored.",
+ "inactive": "Whether the web app was never used by the user, and confirmation must be asked from the user before opening it.",
+ "request_write_access": "The bot is asking permission to send messages to the user: if the user agrees, set the write_allowed flag when invoking messages.requestAppWebView."
+ }
+ },
+ "messages.BotCallbackAnswer": {
+ "desc": "Callback answer sent by the bot in response to a button press",
+ "params": {
+ "alert": "Whether an alert should be shown to the user instead of a toast notification",
+ "cache_time": "For how long should this answer be cached",
+ "flags": "Flags, see TL conditional fields",
+ "has_url": "Whether an URL is present",
+ "message": "Alert to show",
+ "native_ui": "Whether to show games in WebView or in native UI.",
+ "url": "URL to open"
+ }
+ },
+ "messages.BotPreparedInlineMessage": {
+ "desc": "Represents a prepared inline message saved by a bot, to be sent to the user via a web app \u00bb",
+ "params": {
+ "expire_date": "Expiration date of the message",
+ "id": "The ID of the saved message, to be passed to the id field of the web_app_send_prepared_message event \u00bb"
+ }
+ },
+ "messages.BotResults": {
+ "desc": "Result of a query to an inline bot",
+ "params": {
+ "cache_time": "Caching validity of the results",
+ "flags": "Flags, see TL conditional fields",
+ "gallery": "Whether the result is a picture gallery",
+ "next_offset": "The next offset to use when navigating through results",
+ "query_id": "Query ID",
+ "results": "The results",
+ "switch_pm": "Shown as a button on top of the remaining inline result list; if clicked, redirects the user to a private chat with the bot with the specified start parameter.",
+ "switch_webview": "Shown as a button on top of the remaining inline result list; if clicked, opens the specified inline mode mini app.",
+ "users": "Users mentioned in the results"
+ }
+ },
+ "messages.ChannelMessages": {
+ "desc": "Channel messages",
+ "params": {
+ "chats": "Chats",
+ "count": "Total number of results were found server-side (may not be all included here)",
+ "flags": "Flags, see TL conditional fields",
+ "inexact": "If set, returned results may be inexact",
+ "messages": "Found messages",
+ "offset_id_offset": "Indicates the absolute position of messages[0] within the total result set with count count. This is useful, for example, if the result was fetched using offset_id, and we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}.",
+ "pts": "Event count after generation",
+ "topics": "Forum topic information",
+ "users": "Users"
+ }
+ },
+ "messages.ChatAdminsWithInvites": {
+ "desc": "Info about chat invites generated by admins.",
+ "params": {
+ "admins": "Info about chat invites generated by admins.",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.ChatFull": {
+ "desc": "Full info about a channel, supergroup, gigagroup or basic group.",
+ "params": {
+ "chats": "Mentioned chats",
+ "full_chat": "Full info",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.ChatInviteImporters": {
+ "desc": "Info about the users that joined the chat using a specific chat invite",
+ "params": {
+ "count": "Number of users that joined",
+ "importers": "The users that joined",
+ "users": "The users that joined"
+ }
+ },
+ "messages.Chats": {
+ "desc": "List of chats with auxiliary data.",
+ "params": {
+ "chats": "List of chats"
+ }
+ },
+ "messages.ChatsSlice": {
+ "desc": "Partial list of chats, more would have to be fetched with pagination",
+ "params": {
+ "chats": "Chats",
+ "count": "Total number of results that were found server-side (not all are included in chats)"
+ }
+ },
+ "messages.CheckedHistoryImportPeer": {
+ "desc": "Contains a confirmation text to be shown to the user, upon importing chat history, click here for more info \u00bb.",
+ "params": {
+ "confirm_text": "A confirmation text to be shown to the user, upon importing chat history \u00bb."
+ }
+ },
+ "messages.DhConfig": {
+ "desc": "New set of configuring parameters.",
+ "params": {
+ "g": "New value prime, see Wikipedia",
+ "p": "New value primitive root, see Wikipedia",
+ "random": "Random sequence of bytes of assigned length",
+ "version": "Version of set of parameters"
+ }
+ },
+ "messages.DhConfigNotModified": {
+ "desc": "Configuring parameters did not change.",
+ "params": {
+ "random": "Random sequence of bytes of assigned length"
+ }
+ },
+ "messages.DialogFilters": {
+ "desc": "Folder and folder tags information",
+ "params": {
+ "filters": "Folders.",
+ "flags": "Flags, see TL conditional fields",
+ "tags_enabled": "Whether folder tags are enabled."
+ }
+ },
+ "messages.Dialogs": {
+ "desc": "Full list of chats with messages and auxiliary data.",
+ "params": {
+ "chats": "List of groups mentioned in the chats",
+ "dialogs": "List of chats",
+ "messages": "List of last messages from each chat",
+ "users": "List of users mentioned in messages and groups"
+ }
+ },
+ "messages.DialogsNotModified": {
+ "desc": "Dialogs haven't changed",
+ "params": {
+ "count": "Number of dialogs found server-side by the query"
+ }
+ },
+ "messages.DialogsSlice": {
+ "desc": "Incomplete list of dialogs with messages and auxiliary data.",
+ "params": {
+ "chats": "List of chats mentioned in dialogs",
+ "count": "Total number of dialogs",
+ "dialogs": "List of dialogs",
+ "messages": "List of last messages from dialogs",
+ "users": "List of users mentioned in messages and chats"
+ }
+ },
+ "messages.DiscussionMessage": {
+ "desc": "Information about a message thread",
+ "params": {
+ "chats": "Chats mentioned in constructor",
+ "flags": "Flags, see TL conditional fields",
+ "max_id": "Message ID of latest reply in this thread",
+ "messages": "The messages from which the thread starts. The messages are returned in reverse chronological order (i.e., in order of decreasing message ID).",
+ "read_inbox_max_id": "Message ID of latest read incoming message in this thread",
+ "read_outbox_max_id": "Message ID of latest read outgoing message in this thread",
+ "unread_count": "Number of unread messages",
+ "users": "Users mentioned in constructor"
+ }
+ },
+ "messages.EmojiGroups": {
+ "desc": "Represents a list of emoji categories.",
+ "params": {
+ "groups": "A list of emoji categories.",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "messages.EmojiGroupsNotModified": {
+ "desc": "The list of emoji categories hasn't changed.",
+ "params": {}
+ },
+ "messages.ExportedChatInvite": {
+ "desc": "Info about a chat invite",
+ "params": {
+ "invite": "Info about the chat invite",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.ExportedChatInviteReplaced": {
+ "desc": "The specified chat invite was replaced with another one",
+ "params": {
+ "invite": "The replaced chat invite",
+ "new_invite": "The invite that replaces the previous invite",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.ExportedChatInvites": {
+ "desc": "Info about chat invites exported by a certain admin.",
+ "params": {
+ "count": "Number of invites exported by the admin",
+ "invites": "Exported invites",
+ "users": "Info about the admin"
+ }
+ },
+ "messages.FavedStickers": {
+ "desc": "Favorited stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "packs": "Emojis associated to stickers",
+ "stickers": "Favorited stickers"
+ }
+ },
+ "messages.FavedStickersNotModified": {
+ "desc": "No new favorited stickers were found",
+ "params": {}
+ },
+ "messages.FeaturedStickers": {
+ "desc": "Featured stickersets",
+ "params": {
+ "count": "Total number of featured stickers",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here",
+ "premium": "Whether this is a premium stickerset",
+ "sets": "Featured stickersets",
+ "unread": "IDs of new featured stickersets"
+ }
+ },
+ "messages.FeaturedStickersNotModified": {
+ "desc": "Featured stickers haven't changed",
+ "params": {
+ "count": "Total number of featured stickers"
+ }
+ },
+ "messages.ForumTopics": {
+ "desc": "Contains information about multiple forum topics",
+ "params": {
+ "chats": "Related chats",
+ "count": "Total number of topics matching query; may be more than the topics contained in topics, in which case pagination is required.",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "Related messages (contains the messages mentioned by forumTopic.top_message).",
+ "order_by_create_date": "Whether the returned topics are ordered by creation date; if set, pagination by offset_date should use forumTopic.date; otherwise topics are ordered by the last message date, so paginate by the date of the message referenced by forumTopic.top_message.",
+ "pts": "Event count after generation",
+ "topics": "Forum topics",
+ "users": "Related users"
+ }
+ },
+ "messages.FoundStickerSets": {
+ "desc": "Found stickersets",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "sets": "Found stickersets"
+ }
+ },
+ "messages.FoundStickerSetsNotModified": {
+ "desc": "No further results were found",
+ "params": {}
+ },
+ "messages.FoundStickers": {
+ "desc": "Found stickers",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here",
+ "next_offset": "Offset for pagination",
+ "stickers": "Found stickers"
+ }
+ },
+ "messages.FoundStickersNotModified": {
+ "desc": "No new stickers were found for the specified query",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Offset for pagination"
+ }
+ },
+ "messages.HighScores": {
+ "desc": "Highscores in a game",
+ "params": {
+ "scores": "Highscores",
+ "users": "Users, associated to the highscores"
+ }
+ },
+ "messages.HistoryImport": {
+ "desc": "ID of a specific chat import session, click here for more info \u00bb.",
+ "params": {
+ "id": "History import ID"
+ }
+ },
+ "messages.HistoryImportParsed": {
+ "desc": "Contains information about a chat export file generated by a foreign chat app, click here for more info.\nIf neither the pm or group flags are set, the specified chat export was generated from a chat of unknown type.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "group": "The chat export file was generated from a group chat.",
+ "pm": "The chat export file was generated from a private chat.",
+ "title": "Title of the chat."
+ }
+ },
+ "messages.InactiveChats": {
+ "desc": "Inactive chat list",
+ "params": {
+ "chats": "Chat list",
+ "dates": "When was the chat last active",
+ "users": "Users mentioned in the chat list"
+ }
+ },
+ "messages.InvitedUsers": {
+ "desc": "Contains info about successfully or unsuccessfully invited \u00bb users.",
+ "params": {
+ "missing_invitees": "A list of users that could not be invited, along with the reason why they couldn't be invited.",
+ "updates": "List of updates about successfully invited users (and eventually info about the created group)"
+ }
+ },
+ "messages.MessageEditData": {
+ "desc": "Message edit data for media",
+ "params": {
+ "caption": "Media caption, if the specified media's caption can be edited",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "messages.MessageEmpty": {
+ "desc": "Empty constructor. Can be used, for example, in case when an action did not require to create a service message.",
+ "params": {}
+ },
+ "messages.MessageReactionsList": {
+ "desc": "List of peers that reacted to a specific message",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of reactions matching query",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "If set, indicates the next offset to use to load more results by invoking messages.getMessageReactionsList.",
+ "reactions": "List of peers that reacted to a specific message",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.MessageViews": {
+ "desc": "View, forward counter + info about replies",
+ "params": {
+ "chats": "Chats mentioned in constructor",
+ "users": "Users mentioned in constructor",
+ "views": "View, forward counter + info about replies"
+ }
+ },
+ "messages.Messages": {
+ "desc": "Full list of messages with auxiliary data.",
+ "params": {
+ "chats": "List of chats mentioned in dialogs",
+ "messages": "List of messages",
+ "users": "List of users mentioned in messages and chats"
+ }
+ },
+ "messages.MessagesNotModified": {
+ "desc": "No new messages matching the query were found",
+ "params": {
+ "count": "Number of results found server-side by the given query"
+ }
+ },
+ "messages.MessagesSlice": {
+ "desc": "Incomplete list of messages and auxiliary data.",
+ "params": {
+ "chats": "List of chats mentioned in messages",
+ "count": "Total number of messages in the list",
+ "flags": "Flags, see TL conditional fields",
+ "inexact": "If set, indicates that the results may be inexact",
+ "messages": "List of messages",
+ "next_rate": "Rate to use in the offset_rate parameter in the next call to messages.searchGlobal",
+ "offset_id_offset": "Indicates the absolute position of messages[0] within the total result set with count count. This is useful, for example, if the result was fetched using offset_id, and we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}).",
+ "search_flood": "For global post searches \u00bb, the remaining amount of free searches, here query_is_free is related to the current call only, not to the next paginated call, and all subsequent pagination calls will always be free.",
+ "users": "List of users mentioned in messages and chats"
+ }
+ },
+ "messages.MyStickers": {
+ "desc": "The list of stickersets owned by the current account \u00bb.",
+ "params": {
+ "count": "Total number of owned stickersets.",
+ "sets": "Stickersets"
+ }
+ },
+ "messages.PeerDialogs": {
+ "desc": "Dialog info of multiple peers",
+ "params": {
+ "chats": "Chats",
+ "dialogs": "Dialog info",
+ "messages": "Messages mentioned in dialog info",
+ "state": "Current update state of dialog",
+ "users": "Users"
+ }
+ },
+ "messages.PeerSettings": {
+ "desc": "Peer settings",
+ "params": {
+ "chats": "Mentioned chats",
+ "settings": "Peer settings",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.PreparedInlineMessage": {
+ "desc": "Represents a prepared inline message received via a bot's mini app, that can be sent to some chats \u00bb",
+ "params": {
+ "cache_time": "Caching validity of the results",
+ "peer_types": "Types of chats where this message can be sent",
+ "query_id": "The query_id to pass to messages.sendInlineBotResult",
+ "result": "The contents of the message, to be shown in a preview",
+ "users": "Users mentioned in the results"
+ }
+ },
+ "messages.QuickReplies": {
+ "desc": "Info about quick reply shortcuts \u00bb.",
+ "params": {
+ "chats": "Mentioned chats",
+ "messages": "Messages mentioned in quick_replies.",
+ "quick_replies": "Quick reply shortcuts.",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.QuickRepliesNotModified": {
+ "desc": "Info about quick reply shortcuts \u00bb hasn't changed.",
+ "params": {}
+ },
+ "messages.Reactions": {
+ "desc": "List of message reactions",
+ "params": {
+ "hash": "Hash used for caching, can also be locally regenerated using the algorithm specified here \u00bb.",
+ "reactions": "Reactions"
+ }
+ },
+ "messages.ReactionsNotModified": {
+ "desc": "The server-side list of message reactions hasn't changed",
+ "params": {}
+ },
+ "messages.RecentStickers": {
+ "desc": "Recently used stickers",
+ "params": {
+ "dates": "When was each sticker last used",
+ "hash": "Hash used for caching, for more info click here",
+ "packs": "Emojis associated to stickers",
+ "stickers": "Recent stickers"
+ }
+ },
+ "messages.RecentStickersNotModified": {
+ "desc": "No new recent sticker was found",
+ "params": {}
+ },
+ "messages.SavedDialogs": {
+ "desc": "Represents some saved message dialogs \u00bb.",
+ "params": {
+ "chats": "Mentioned chats",
+ "dialogs": "Saved message dialogs \u00bb.",
+ "messages": "List of last messages from each saved dialog",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.SavedDialogsNotModified": {
+ "desc": "The saved dialogs haven't changed",
+ "params": {
+ "count": "Number of saved dialogs found server-side by the query"
+ }
+ },
+ "messages.SavedDialogsSlice": {
+ "desc": "Incomplete list of saved message dialogs \u00bb with messages and auxiliary data.",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of saved message dialogs",
+ "dialogs": "List of saved message dialogs",
+ "messages": "List of last messages from dialogs",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.SavedGifs": {
+ "desc": "Saved gifs",
+ "params": {
+ "gifs": "List of saved gifs",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "messages.SavedGifsNotModified": {
+ "desc": "No new saved gifs were found",
+ "params": {}
+ },
+ "messages.SavedReactionTags": {
+ "desc": "List of reaction tag \u00bb names assigned by the user.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here. Can also be manually regenerated, if needed, using the custom algorithm specified here \u00bb.",
+ "tags": "Saved reaction tags."
+ }
+ },
+ "messages.SavedReactionTagsNotModified": {
+ "desc": "The list of reaction tag \u00bb names assigned by the user hasn't changed.",
+ "params": {}
+ },
+ "messages.SearchCounter": {
+ "desc": "Indicates how many results would be found by a messages.search call with the same parameters",
+ "params": {
+ "count": "Number of results that were found server-side",
+ "filter": "Provided message filter",
+ "flags": "Flags, see TL conditional fields",
+ "inexact": "If set, the results may be inexact"
+ }
+ },
+ "messages.SearchResultsCalendar": {
+ "desc": "Information about found messages sent on a specific day",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of results matching query",
+ "flags": "Flags, see TL conditional fields",
+ "inexact": "If set, indicates that the results may be inexact",
+ "messages": "Messages",
+ "min_date": "Starting timestamp of attached messages",
+ "min_msg_id": "Ending timestamp of attached messages",
+ "offset_id_offset": "Indicates the absolute position of messages[0] within the total result set with count count. This is useful, for example, if we need to display a progress/total counter (like photo 134 of 200, for all media in a chat, we could simply use photo ${offset_id_offset} of ${count}.",
+ "periods": "Used to split the messages by days: multiple SearchResultsCalendarPeriod constructors are returned, each containing information about the first, last and total number of messages matching the filter that were sent on a specific day. This information can be easily used to split the returned messages by day.",
+ "users": "Mentioned users"
+ }
+ },
+ "messages.SearchResultsPositions": {
+ "desc": "Information about sparse positions of messages",
+ "params": {
+ "count": "Total number of found messages",
+ "positions": "List of message positions"
+ }
+ },
+ "messages.SentEncryptedFile": {
+ "desc": "Message with a file enclosure sent to a protected chat",
+ "params": {
+ "date": "Sending date",
+ "file": "Attached file"
+ }
+ },
+ "messages.SentEncryptedMessage": {
+ "desc": "Message without file attachments sent to an encrypted file.",
+ "params": {
+ "date": "Date of sending"
+ }
+ },
+ "messages.SponsoredMessages": {
+ "desc": "A set of sponsored messages associated to a channel",
+ "params": {
+ "between_delay": "For sponsored messages to show on channel videos \u00bb, the number of seconds to wait after the previous ad is hidden, before showing the next ad.",
+ "chats": "Chats mentioned in the sponsored messages",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "Sponsored messages",
+ "posts_between": "If set, specifies the minimum number of messages between shown sponsored messages; otherwise, only one sponsored message must be shown after all ordinary messages.",
+ "start_delay": "For sponsored messages to show on channel videos \u00bb, the number of seconds to wait before showing the first ad.",
+ "users": "Users mentioned in the sponsored messages"
+ }
+ },
+ "messages.SponsoredMessagesEmpty": {
+ "desc": "No sponsored messages are available.",
+ "params": {}
+ },
+ "messages.StickerSet": {
+ "desc": "Stickerset and stickers inside it",
+ "params": {
+ "documents": "Stickers in stickerset",
+ "keywords": "Keywords for some or every sticker in the stickerset.",
+ "packs": "Emoji info for stickers",
+ "set": "The stickerset"
+ }
+ },
+ "messages.StickerSetInstallResultArchive": {
+ "desc": "The stickerset was installed, but since there are too many stickersets some were archived",
+ "params": {
+ "sets": "Archived stickersets"
+ }
+ },
+ "messages.StickerSetInstallResultSuccess": {
+ "desc": "The stickerset was installed successfully",
+ "params": {}
+ },
+ "messages.StickerSetNotModified": {
+ "desc": "The stickerset hasn't changed",
+ "params": {}
+ },
+ "messages.Stickers": {
+ "desc": "Found stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "stickers": "Stickers"
+ }
+ },
+ "messages.StickersNotModified": {
+ "desc": "No new stickers were found for the given query",
+ "params": {}
+ },
+ "messages.TranscribedAudio": {
+ "desc": "Transcribed text from a voice message \u00bb",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "pending": "Whether the transcription is partial because audio transcription is still in progress, if set the user may receive further updateTranscribedAudio updates with the updated transcription.",
+ "text": "Transcripted text",
+ "transcription_id": "Transcription ID",
+ "trial_remains_num": "For non-Premium users, this flag will be set, indicating the remaining transcriptions in the free trial period.",
+ "trial_remains_until_date": "For non-Premium users, this flag will be set, indicating the date when the trial_remains_num counter will be reset to the maximum value of transcribe_audio_trial_weekly_number."
+ }
+ },
+ "messages.TranslateResult": {
+ "desc": "Translated text with entities",
+ "params": {
+ "result": "Text+entities, for each input message."
+ }
+ },
+ "messages.VotesList": {
+ "desc": "How users voted in a poll",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of votes for all options (or only for the chosen option, if provided to messages.getPollVotes)",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Offset to use with the next messages.getPollVotes request, empty string if no more results are available.",
+ "users": "Info about users that voted in the poll",
+ "votes": "Vote info for each user"
+ }
+ },
+ "messages.WebPage": {
+ "desc": "Represents an Instant View webpage.",
+ "params": {
+ "chats": "Chats mentioned in the webpage.",
+ "users": "Users mentioned in the webpage.",
+ "webpage": "The instant view webpage."
+ }
+ },
+ "messages.WebPagePreview": {
+ "desc": "Represents a webpage preview.",
+ "params": {
+ "chats": "Chats mentioned in the gift field.",
+ "media": "The messageMediaWebPage or a messageMediaEmpty if there is no preview.",
+ "users": "Users mentioned within the media object."
+ }
+ },
+ "messages.WebViewResult": {
+ "desc": "",
+ "params": {}
+ },
+ "payments.BankCardData": {
+ "desc": "Credit card info, provided by the card's bank(s)",
+ "params": {
+ "open_urls": "Info URL(s) provided by the card's bank(s)",
+ "title": "Credit card title"
+ }
+ },
+ "payments.CheckCanSendGiftResultFail": {
+ "desc": "The specified gift cannot be sent yet for the specified reason.",
+ "params": {
+ "reason": "The reason why it can't be sent yet."
+ }
+ },
+ "payments.CheckCanSendGiftResultOk": {
+ "desc": "The specified gift can be sent.",
+ "params": {}
+ },
+ "payments.CheckedGiftCode": {
+ "desc": "Contains info about a Telegram Premium giftcode link.",
+ "params": {
+ "chats": "Mentioned chats",
+ "date": "Creation date of the gift code.",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "The peer that created the gift code.",
+ "giveaway_msg_id": "Message ID of the giveaway in the channel specified in from_id.",
+ "months": "Duration in months of the gifted Telegram Premium subscription.",
+ "to_id": "The destination user of the gift.",
+ "used_date": "When was the giftcode imported, if it was imported.",
+ "users": "Mentioned users",
+ "via_giveaway": "Whether this giftcode was created by a giveaway."
+ }
+ },
+ "payments.ConnectedStarRefBots": {
+ "desc": "Active affiliations",
+ "params": {
+ "connected_bots": "The affiliations",
+ "count": "Total number of active affiliations",
+ "users": "Peers mentioned in connected_bots"
+ }
+ },
+ "payments.ExportedInvoice": {
+ "desc": "Exported invoice deep link",
+ "params": {
+ "url": "Exported invoice deep link"
+ }
+ },
+ "payments.GiveawayInfo": {
+ "desc": "Contains info about an ongoing giveaway.",
+ "params": {
+ "admin_disallowed_chat_id": "If set, the current user can't participate in the giveaway, because they are an administrator in one of the channels (ID specified in this flag) that created the giveaway.",
+ "disallowed_country": "If set, the current user can't participate in this giveaway, because their phone number is from the specified disallowed country (specified as a two-letter ISO 3166-1 alpha-2 country code).",
+ "flags": "Flags, see TL conditional fields",
+ "joined_too_early_date": "The current user can't participate in the giveaway, because they were already a member of the channel when the giveaway started, and the only_new_subscribers was set when starting the giveaway.",
+ "participating": "The current user is participating in the giveaway.",
+ "preparing_results": "If set, the giveaway has ended and the results are being prepared.",
+ "start_date": "When was the giveaway started"
+ }
+ },
+ "payments.GiveawayInfoResults": {
+ "desc": "A giveaway has ended.",
+ "params": {
+ "activated_count": "Number of winners, which activated their gift codes.",
+ "finish_date": "End date of the giveaway. May be bigger than the end date specified in parameters of the giveaway.",
+ "flags": "Flags, see TL conditional fields",
+ "gift_code_slug": "If we're one of the winners of this giveaway, contains the Premium gift code, see here \u00bb for more info on the full giveaway flow.",
+ "refunded": "Whether the giveaway was canceled and was fully refunded.",
+ "stars_prize": "If we're one of the winners of this Telegram Star giveaway, the number Telegram Stars we won.",
+ "start_date": "Start date of the giveaway",
+ "winner": "Whether we're one of the winners of this giveaway.",
+ "winners_count": "Number of winners in the giveaway"
+ }
+ },
+ "payments.PaymentForm": {
+ "desc": "Payment form",
+ "params": {
+ "additional_methods": "Additional payment methods",
+ "bot_id": "Bot ID",
+ "can_save_credentials": "Whether the user can choose to save credentials.",
+ "description": "Description",
+ "flags": "Flags, see TL conditional fields",
+ "form_id": "Form ID",
+ "invoice": "Invoice",
+ "native_params": "Contains information about the payment provider, if available, to support it natively without the need for opening the URL.A JSON object that can contain the following fields:- apple_pay_merchant_id: Apple Pay merchant ID- google_pay_public_key: Google Pay public key- need_country: True, if the user country must be provided,- need_zip: True, if the user ZIP/postal code must be provided,- need_cardholder_name: True, if the cardholder name must be provided",
+ "native_provider": "Payment provider name.One of the following:- stripe",
+ "password_missing": "Indicates that the user can save payment credentials, but only after setting up a 2FA password (currently the account doesn't have a 2FA password)",
+ "photo": "Product photo",
+ "provider_id": "Payment provider ID.",
+ "saved_credentials": "Contains information about saved card credentials",
+ "saved_info": "Saved server-side order information",
+ "title": "Form title",
+ "url": "Payment form URL",
+ "users": "Users"
+ }
+ },
+ "payments.PaymentFormStarGift": {
+ "desc": "Represents a payment form for a gift, see here \u00bb for more info.",
+ "params": {
+ "form_id": "Form ID.",
+ "invoice": "Invoice"
+ }
+ },
+ "payments.PaymentFormStars": {
+ "desc": "Represents a payment form, for payments to be using Telegram Stars, see here \u00bb for more info.",
+ "params": {
+ "bot_id": "Bot ID.",
+ "description": "Description",
+ "flags": "Flags, see TL conditional fields",
+ "form_id": "Form ID.",
+ "invoice": "Invoice",
+ "photo": "Product photo",
+ "title": "Form title",
+ "users": "Info about users mentioned in the other fields."
+ }
+ },
+ "payments.PaymentReceipt": {
+ "desc": "Receipt",
+ "params": {
+ "bot_id": "Bot ID",
+ "credentials_title": "Payment credential name",
+ "currency": "Three-letter ISO 4217 currency code",
+ "date": "Date of generation",
+ "description": "Description",
+ "flags": "Flags, see TL conditional fields",
+ "info": "Info",
+ "invoice": "Invoice",
+ "photo": "Photo",
+ "provider_id": "Provider ID",
+ "shipping": "Selected shipping option",
+ "tip_amount": "Tipped amount",
+ "title": "Title",
+ "total_amount": "Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "users": "Users"
+ }
+ },
+ "payments.PaymentReceiptStars": {
+ "desc": "Receipt for payment made using Telegram Stars.",
+ "params": {
+ "bot_id": "Bot ID",
+ "currency": "Currency, always XTR.",
+ "date": "Date of generation",
+ "description": "Description",
+ "flags": "Flags, see TL conditional fields",
+ "invoice": "Invoice",
+ "photo": "Product photo",
+ "title": "Title",
+ "total_amount": "Amount of Telegram Stars.",
+ "transaction_id": "Transaction ID",
+ "users": "Info about users mentioned in the other fields."
+ }
+ },
+ "payments.PaymentResult": {
+ "desc": "Payment result",
+ "params": {
+ "updates": "Info about the payment"
+ }
+ },
+ "payments.PaymentVerificationNeeded": {
+ "desc": "Payment was not successful, additional verification is needed",
+ "params": {
+ "url": "URL for additional payment credentials verification"
+ }
+ },
+ "payments.ResaleStarGifts": {
+ "desc": "List of gifts currently on resale \u00bb.",
+ "params": {
+ "attributes": "Possible gift attributes, only set if payments.getResaleStarGifts.attributes_hash is set (on the first call, it must be equal to 0).",
+ "attributes_hash": "Hash of the attributes field, pass this to payments.getResaleStarGifts.attributes_hash to avoid returning any attributes (flag not set) if they haven't changed.",
+ "chats": "Chats mentioned in the attributes.",
+ "count": "Total number of results.",
+ "counters": "Indicates the total number of gifts that have a specific attribute, only set if payments.getResaleStarGifts.offset is empty (since this field is not related to the current result page but to all of them, it's only returned on the first page).",
+ "flags": "Flags, see TL conditional fields",
+ "gifts": "Collectible gifts on resale (may be less than count, in which case next_offset will be set).",
+ "next_offset": "Offset for pagination, pass this to payments.getResaleStarGifts.offset to fetch the next results.",
+ "users": "Users mentioned in the attributes."
+ }
+ },
+ "payments.SavedInfo": {
+ "desc": "Saved server-side order information",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "has_saved_credentials": "Whether the user has some saved payment credentials",
+ "saved_info": "Saved server-side order information"
+ }
+ },
+ "payments.SavedStarGifts": {
+ "desc": "Represents a list of gifts.",
+ "params": {
+ "chat_notifications_enabled": "Ternary value: can be not set, set&true, set&false. Can only be set for channels we own: the value indicates whether we enabled gift notifications for this channel.",
+ "chats": "Channels mentioned in gifts",
+ "count": "Total number of results (can be less than the returned gifts, in which case next_offset will be set).",
+ "flags": "Flags, see TL conditional fields",
+ "gifts": "Gifts",
+ "next_offset": "Offset to pass to payments.getSavedStarGifts to fetch the next page of results.",
+ "users": "Users mentioned in gifts"
+ }
+ },
+ "payments.StarGiftCollections": {
+ "desc": "Represents a list of star gift collections \u00bb.",
+ "params": {
+ "collections": "Star gift collections."
+ }
+ },
+ "payments.StarGiftCollectionsNotModified": {
+ "desc": "The list of star gift collections \u00bb hasn't changed.",
+ "params": {}
+ },
+ "payments.StarGiftUpgradePreview": {
+ "desc": "A preview of the possible attributes (chosen randomly) a gift \u00bb can receive after upgrading it to a collectible gift \u00bb, see here \u00bb for more info.",
+ "params": {
+ "sample_attributes": "Possible gift attributes"
+ }
+ },
+ "payments.StarGiftWithdrawalUrl": {
+ "desc": "A URL that can be used to import the exported NFT on Fragment.",
+ "params": {
+ "url": "The URL to open."
+ }
+ },
+ "payments.StarGifts": {
+ "desc": "Available gifts \u00bb.",
+ "params": {
+ "chats": "Chats mentioned in the gifts field.",
+ "gifts": "List of available gifts.",
+ "hash": "Hash used for caching, for more info click here",
+ "users": "Users mentioned in the gifts field."
+ }
+ },
+ "payments.StarGiftsNotModified": {
+ "desc": "The list of available gifts \u00bb hasn't changed.",
+ "params": {}
+ },
+ "payments.StarsRevenueAdsAccountUrl": {
+ "desc": "Contains a URL leading to a page where the user will be able to place ads for the channel/bot, paying using Telegram Stars.",
+ "params": {
+ "url": "URL to open."
+ }
+ },
+ "payments.StarsRevenueStats": {
+ "desc": "Star revenue statistics, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "revenue_graph": "Star revenue graph (number of earned stars)",
+ "status": "Current balance, current withdrawable balance and overall earned Telegram Stars",
+ "top_hours_graph": "For ad revenue statistics, ad impressions graph",
+ "usd_rate": "Current conversion rate of Telegram Stars to USD"
+ }
+ },
+ "payments.StarsRevenueWithdrawalUrl": {
+ "desc": "Contains the URL to use to withdraw Telegram Star revenue.",
+ "params": {
+ "url": "Contains the URL to use to withdraw Telegram Star revenue."
+ }
+ },
+ "payments.StarsStatus": {
+ "desc": "Info about the current Telegram Star subscriptions, balance and transaction history \u00bb.",
+ "params": {
+ "balance": "Current Telegram Star balance.",
+ "chats": "Chats mentioned in history.",
+ "flags": "Flags, see TL conditional fields",
+ "history": "List of Telegram Star transactions (partial if next_offset is set).",
+ "next_offset": "Offset to use to fetch more transactions from the transaction history using payments.getStarsTransactions.",
+ "subscriptions": "Info about current Telegram Star subscriptions, only returned when invoking payments.getStarsTransactions and payments.getStarsSubscriptions.",
+ "subscriptions_missing_balance": "The number of Telegram Stars the user should buy to be able to extend expired subscriptions soon (i.e. the current balance is not enough to extend all expired subscriptions).",
+ "subscriptions_next_offset": "Offset for pagination of subscriptions: only usable and returned when invoking payments.getStarsSubscriptions.",
+ "users": "Users mentioned in history."
+ }
+ },
+ "payments.SuggestedStarRefBots": {
+ "desc": "A list of suggested mini apps with available affiliate programs",
+ "params": {
+ "count": "Total number of results (for pagination)",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Next offset for pagination",
+ "suggested_bots": "Suggested affiliate programs (full or partial list to be fetched using pagination)",
+ "users": "Peers mentioned in suggested_bots"
+ }
+ },
+ "payments.UniqueStarGift": {
+ "desc": "Represents a collectible gift \u00bb.",
+ "params": {
+ "chats": "Chats mentioned in the gift field.",
+ "gift": "The starGiftUnique constructor.",
+ "users": "Users mentioned in the gift field."
+ }
+ },
+ "payments.UniqueStarGiftValueInfo": {
+ "desc": "Information about the value of a collectible gift \u00bb.",
+ "params": {
+ "average_price": "The current average sale price of collectible gifts of the same type, in the smallest unit of the currency specified in currency.",
+ "currency": "Three-letter ISO 4217 currency code (a localized fiat currency used to represent prices and price estimations in this constructor).",
+ "flags": "Flags, see TL conditional fields",
+ "floor_price": "The current minimum price of collectible gifts of the same type, in the smallest unit of the currency specified in currency.",
+ "fragment_listed_count": "Number of gifts of the same type currently being resold on fragment.",
+ "fragment_listed_url": "Fragment link to the listing of gifts of the same type currently being resold on fragment.",
+ "initial_sale_date": "Initial purchase date of the gift.",
+ "initial_sale_price": "Initial purchase price in the smallest unit of the currency specified in currency (automatically converted from initial_sale_stars).",
+ "initial_sale_stars": "Initial purchase price in Stars.",
+ "last_sale_date": "Last resale date of the gift.",
+ "last_sale_on_fragment": "If set, the last sale was completed on Fragment.",
+ "last_sale_price": "Last resale price, in the smallest unit of the currency specified in currency.",
+ "listed_count": "Number of gifts of the same type currently being resold on Telegram.",
+ "value": "Estimated value of the gift, in the smallest unit of the currency specified in currency.",
+ "value_is_average": "If set, the value is calculated from the average value of sold gifts of the same type. Otherwise, it is based on the sale price of the gift."
+ }
+ },
+ "payments.ValidatedRequestedInfo": {
+ "desc": "Validated user-provided info",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID",
+ "shipping_options": "Shipping options"
+ }
+ },
+ "phone.ExportedGroupCallInvite": {
+ "desc": "An invite to a group call or livestream",
+ "params": {
+ "link": "Invite link"
+ }
+ },
+ "phone.GroupCall": {
+ "desc": "Contains info about a group call, and partial info about its participants.",
+ "params": {
+ "call": "Info about the group call",
+ "chats": "Chats mentioned in the participants vector",
+ "participants": "A partial list of participants.",
+ "participants_next_offset": "Next offset to use when fetching the remaining participants using phone.getGroupParticipants",
+ "users": "Users mentioned in the participants vector"
+ }
+ },
+ "phone.GroupCallStreamChannels": {
+ "desc": "Info about RTMP streams in a group call or livestream",
+ "params": {
+ "channels": "RTMP streams"
+ }
+ },
+ "phone.GroupCallStreamRtmpUrl": {
+ "desc": "RTMP URL and stream key to be used in streaming software",
+ "params": {
+ "key": "Stream key",
+ "url": "RTMP URL"
+ }
+ },
+ "phone.GroupParticipants": {
+ "desc": "Info about the participants of a group call or livestream",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Number of participants",
+ "next_offset": "If not empty, the specified list of participants is partial, and more participants can be fetched specifying this parameter as offset in phone.getGroupParticipants.",
+ "participants": "List of participants",
+ "users": "Mentioned users",
+ "version": "Version info"
+ }
+ },
+ "phone.JoinAsPeers": {
+ "desc": "A list of peers that can be used to join a group call, presenting yourself as a specific user/channel.",
+ "params": {
+ "chats": "Chats mentioned in the peers vector",
+ "peers": "Peers",
+ "users": "Users mentioned in the peers vector"
+ }
+ },
+ "phone.PhoneCall": {
+ "desc": "A VoIP phone call",
+ "params": {
+ "phone_call": "The VoIP phone call",
+ "users": "VoIP phone call participants"
+ }
+ },
+ "photos.Photo": {
+ "desc": "Photo with auxiliary data.",
+ "params": {
+ "photo": "Photo",
+ "users": "Users"
+ }
+ },
+ "photos.Photos": {
+ "desc": "Full list of photos with auxiliary data.",
+ "params": {
+ "photos": "List of photos",
+ "users": "List of mentioned users"
+ }
+ },
+ "photos.PhotosSlice": {
+ "desc": "Incomplete list of photos with auxiliary data.",
+ "params": {
+ "count": "Total number of photos",
+ "photos": "List of photos",
+ "users": "List of mentioned users"
+ }
+ },
+ "premium.BoostsList": {
+ "desc": "List of boosts that were applied to a peer by multiple users.",
+ "params": {
+ "boosts": "Boosts",
+ "count": "Total number of results",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Offset that can be used for pagination.",
+ "users": "Mentioned users"
+ }
+ },
+ "premium.BoostsStatus": {
+ "desc": "Contains info about the current boost status of a peer.",
+ "params": {
+ "boost_url": "Boost deep link \u00bb that can be used to boost the chat.",
+ "boosts": "Total number of boosts acquired so far.",
+ "current_level_boosts": "The number of boosts acquired so far in the current level.",
+ "flags": "Flags, see TL conditional fields",
+ "gift_boosts": "The number of boosts acquired from created Telegram Premium gift codes and giveaways; only returned to channel/supergroup admins.",
+ "level": "The current boost level of the channel/supergroup.",
+ "my_boost": "Whether we're currently boosting this channel/supergroup, my_boost_slots will also be set.",
+ "my_boost_slots": "Indicates which of our boost slots we've assigned to this peer (populated if my_boost is set).",
+ "next_level_boosts": "Total number of boosts needed to reach the next level; if absent, the next level isn't available.",
+ "premium_audience": "Only returned to channel/supergroup admins: contains the approximated number of Premium users subscribed to the channel/supergroup, related to the total number of subscribers.",
+ "prepaid_giveaways": "A list of prepaid giveaways available for the chat; only returned to channel/supergroup admins."
+ }
+ },
+ "premium.MyBoosts": {
+ "desc": "A list of peers we are currently boosting, and how many boost slots we have left.",
+ "params": {
+ "chats": "Referenced chats",
+ "my_boosts": "Info about boosted peers and remaining boost slots.",
+ "users": "Referenced users"
+ }
+ },
+ "smsjobs.EligibleToJoin": {
+ "desc": "SMS jobs eligibility",
+ "params": {
+ "monthly_sent_sms": "Monthly sent SMSes",
+ "terms_url": "Terms of service URL"
+ }
+ },
+ "smsjobs.Status": {
+ "desc": "Status",
+ "params": {
+ "allow_international": "Allow international numbers",
+ "flags": "Flags, see TL conditional fields",
+ "last_gift_slug": "Last gift deep link",
+ "recent_remains": "Remaining",
+ "recent_sent": "Recently sent",
+ "recent_since": "Since",
+ "terms_url": "Terms of service URL",
+ "total_sent": "Total sent",
+ "total_since": "Total since"
+ }
+ },
+ "stats.BroadcastStats": {
+ "desc": "Channel statistics.",
+ "params": {
+ "enabled_notifications": "Percentage of subscribers with enabled notifications",
+ "followers": "Follower count change for period in consideration",
+ "followers_graph": "Followers growth graph (relative subscriber count)",
+ "growth_graph": "Channel growth graph (absolute subscriber count)",
+ "interactions_graph": "Interactions graph (absolute)",
+ "iv_interactions_graph": "IV interactions graph (absolute)",
+ "languages_graph": "Subscriber language graph (pie chart)",
+ "mute_graph": "Muted users graph (relative)",
+ "new_followers_by_source_graph": "New followers by source graph (absolute)",
+ "period": "Period in consideration",
+ "reactions_by_emotion_graph": "A graph containing the number of reactions on posts categorized by emotion",
+ "reactions_per_post": "total_reactions/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)",
+ "reactions_per_story": "total_reactions/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)",
+ "recent_posts_interactions": "Detailed statistics about number of views and shares of recently sent messages and stories",
+ "shares_per_post": "total_sharecount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)",
+ "shares_per_story": "total_shares/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)",
+ "story_interactions_graph": "A graph containing the number of story views and shares",
+ "story_reactions_by_emotion_graph": "A graph containing the number of reactions on stories categorized by emotion",
+ "top_hours_graph": "Views per hour graph (absolute)",
+ "views_by_source_graph": "Views by source graph (absolute)",
+ "views_per_post": "total_viewcount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date).",
+ "views_per_story": "total_views/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)"
+ }
+ },
+ "stats.MegagroupStats": {
+ "desc": "Supergroup statistics",
+ "params": {
+ "actions_graph": "Group activity graph (deleted, modified messages, blocked users)",
+ "growth_graph": "Supergroup growth graph (absolute subscriber count)",
+ "languages_graph": "Subscriber language graph (pie chart)",
+ "members": "Member count change for period in consideration",
+ "members_graph": "Members growth (relative subscriber count)",
+ "messages": "Message number change for period in consideration",
+ "messages_graph": "Message activity graph (stacked bar graph, message type)",
+ "new_members_by_source_graph": "New members by source graph",
+ "period": "Period in consideration",
+ "posters": "Number of users that posted messages, for range in consideration",
+ "top_admins": "Info about most active group admins",
+ "top_hours_graph": "Activity per hour graph (absolute)",
+ "top_inviters": "Info about most active group inviters",
+ "top_posters": "Info about most active group members",
+ "users": "Info about users mentioned in statistics",
+ "viewers": "Number of users that viewed messages, for range in consideration",
+ "weekdays_graph": "Activity per day of week graph (absolute)"
+ }
+ },
+ "stats.MessageStats": {
+ "desc": "Message statistics",
+ "params": {
+ "reactions_by_emotion_graph": "A graph containing the number of reactions on stories categorized by emotion",
+ "views_graph": "Message view graph"
+ }
+ },
+ "stats.PublicForwards": {
+ "desc": "Contains info about the forwards of a story as a message to public chats and reposts by public channels.",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of results",
+ "flags": "Flags, see TL conditional fields",
+ "forwards": "Info about the forwards of a story.",
+ "next_offset": "Offset used for pagination.",
+ "users": "Mentioned users"
+ }
+ },
+ "stats.StoryStats": {
+ "desc": "Contains statistics about a story.",
+ "params": {
+ "reactions_by_emotion_graph": "A bar graph containing the number of story reactions categorized by \"emotion\" (i.e. Positive, Negative, Other, etc...)",
+ "views_graph": "A graph containing the number of story views and shares"
+ }
+ },
+ "stickers.SuggestedShortName": {
+ "desc": "A suggested short name for a stickerpack",
+ "params": {
+ "short_name": "Suggested short name"
+ }
+ },
+ "storage.FileGif": {
+ "desc": "GIF image. MIME type: image/gif.",
+ "params": {}
+ },
+ "storage.FileJpeg": {
+ "desc": "JPEG image. MIME type: image/jpeg.",
+ "params": {}
+ },
+ "storage.FileMov": {
+ "desc": "Quicktime video. MIME type: video/quicktime.",
+ "params": {}
+ },
+ "storage.FileMp3": {
+ "desc": "Mp3 audio. MIME type: audio/mpeg.",
+ "params": {}
+ },
+ "storage.FileMp4": {
+ "desc": "MPEG-4 video. MIME type: video/mp4.",
+ "params": {}
+ },
+ "storage.FilePartial": {
+ "desc": "Part of a bigger file.",
+ "params": {}
+ },
+ "storage.FilePdf": {
+ "desc": "PDF document image. MIME type: application/pdf.",
+ "params": {}
+ },
+ "storage.FilePng": {
+ "desc": "PNG image. MIME type: image/png.",
+ "params": {}
+ },
+ "storage.FileUnknown": {
+ "desc": "Unknown type.",
+ "params": {}
+ },
+ "storage.FileWebp": {
+ "desc": "WEBP image. MIME type: image/webp.",
+ "params": {}
+ },
+ "stories.Albums": {
+ "desc": "Story albums \u00bb.",
+ "params": {
+ "albums": "The albums.",
+ "hash": "Hash to pass to stories.getAlbums to avoid returning any results if they haven't changed."
+ }
+ },
+ "stories.AlbumsNotModified": {
+ "desc": "The story album list \u00bb hasn't changed.",
+ "params": {}
+ },
+ "stories.AllStories": {
+ "desc": "Full list of active (or active and hidden) stories.",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of active (or active and hidden) stories",
+ "flags": "Flags, see TL conditional fields",
+ "has_more": "Whether more results can be fetched as described here \u00bb.",
+ "peer_stories": "Stories",
+ "state": "State to use for pagination",
+ "stealth_mode": "Current stealth mode information",
+ "users": "Mentioned users"
+ }
+ },
+ "stories.AllStoriesNotModified": {
+ "desc": "The list of active (or active and hidden) stories has not changed.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "state": "State to use to ask for updates",
+ "stealth_mode": "Current stealth mode information"
+ }
+ },
+ "stories.CanSendStoryCount": {
+ "desc": "Contains the number of available active story slots (equal to the value of the story_expiring_limit_* client configuration parameter minus the number of currently active stories).",
+ "params": {
+ "count_remains": "Remaining active story slots."
+ }
+ },
+ "stories.FoundStories": {
+ "desc": "Stories found using global story search \u00bb.",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of results found for the query.",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "Offset used to fetch the next page, if not set this is the final page.",
+ "stories": "Matching stories.",
+ "users": "Mentioned users"
+ }
+ },
+ "stories.PeerStories": {
+ "desc": "Active story list of a specific peer.",
+ "params": {
+ "chats": "Mentioned chats",
+ "stories": "Stories",
+ "users": "Mentioned users"
+ }
+ },
+ "stories.Stories": {
+ "desc": "List of stories",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of stories that can be fetched",
+ "flags": "Flags, see TL conditional fields",
+ "pinned_to_top": "IDs of pinned stories.",
+ "stories": "Stories",
+ "users": "Mentioned users"
+ }
+ },
+ "stories.StoryReactionsList": {
+ "desc": "List of peers that reacted to or intercated with a specific story",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of reactions matching query",
+ "flags": "Flags, see TL conditional fields",
+ "next_offset": "If set, indicates the next offset to use to load more results by invoking stories.getStoryReactionsList.",
+ "reactions": "List of peers that reacted to or interacted with a specific story",
+ "users": "Mentioned users"
+ }
+ },
+ "stories.StoryViews": {
+ "desc": "Reaction and view counters for a list of stories",
+ "params": {
+ "users": "Mentioned users",
+ "views": "View date and reaction information of multiple stories"
+ }
+ },
+ "stories.StoryViewsList": {
+ "desc": "Reaction and view counters for a story",
+ "params": {
+ "chats": "Mentioned chats",
+ "count": "Total number of results that can be fetched",
+ "flags": "Flags, see TL conditional fields",
+ "forwards_count": "Total number of story forwards/reposts",
+ "next_offset": "Offset for pagination",
+ "reactions_count": "Number of reactions that were added to the story",
+ "users": "Mentioned users",
+ "views": "Story view date and reaction information",
+ "views_count": "Total number of story views"
+ }
+ },
+ "updates.ChannelDifference": {
+ "desc": "The new updates",
+ "params": {
+ "chats": "Chats",
+ "final": "Whether there are more updates to be fetched using getDifference, starting from the provided pts",
+ "flags": "Flags, see TL conditional fields",
+ "new_messages": "New messages",
+ "other_updates": "Other updates",
+ "pts": "The PTS from which to start getting updates the next time",
+ "timeout": "Clients are supposed to refetch the channel difference after timeout seconds have elapsed, if the user is currently viewing the chat, see here \u00bb for more info.",
+ "users": "Users"
+ }
+ },
+ "updates.ChannelDifferenceEmpty": {
+ "desc": "There are no new updates",
+ "params": {
+ "final": "Whether there are more updates that must be fetched (always false)",
+ "flags": "Flags, see TL conditional fields",
+ "pts": "The latest PTS",
+ "timeout": "Clients are supposed to refetch the channel difference after timeout seconds have elapsed, if the user is currently viewing the chat, see here \u00bb for more info."
+ }
+ },
+ "updates.ChannelDifferenceTooLong": {
+ "desc": "The provided pts + limit < remote pts. Simply, there are too many updates to be fetched (more than limit), the client has to resolve the update gap in one of the following ways (assuming the existence of a persistent database to locally store messages):",
+ "params": {
+ "chats": "Chats from messages",
+ "dialog": "Dialog containing the latest PTS that can be used to reset the channel state",
+ "final": "Whether there are more updates that must be fetched (always false)",
+ "flags": "Flags, see TL conditional fields",
+ "messages": "The latest messages",
+ "timeout": "Clients are supposed to refetch the channel difference after timeout seconds have elapsed",
+ "users": "Users from messages"
+ }
+ },
+ "updates.Difference": {
+ "desc": "Full list of occurred events.",
+ "params": {
+ "chats": "List of chats mentioned in events",
+ "new_encrypted_messages": "List of new encrypted secret chat messages",
+ "new_messages": "List of new messages",
+ "other_updates": "List of updates",
+ "state": "Current state",
+ "users": "List of users mentioned in events"
+ }
+ },
+ "updates.DifferenceEmpty": {
+ "desc": "No events.",
+ "params": {
+ "date": "Current date",
+ "seq": "Number of sent updates"
+ }
+ },
+ "updates.DifferenceSlice": {
+ "desc": "Incomplete list of occurred events.",
+ "params": {
+ "chats": "List of chats mentioned in events",
+ "intermediate_state": "Intermediary state",
+ "new_encrypted_messages": "New messages from the encrypted event sequence",
+ "new_messages": "List of new messages",
+ "other_updates": "List of updates",
+ "users": "List of users mentioned in events"
+ }
+ },
+ "updates.DifferenceTooLong": {
+ "desc": "The difference is too long, and the specified state must be used to refetch updates.",
+ "params": {
+ "pts": "The new state to use."
+ }
+ },
+ "updates.State": {
+ "desc": "Updates state.",
+ "params": {
+ "date": "Date of condition",
+ "pts": "Number of events occurred in a text box",
+ "qts": "Position in a sequence of updates in secret chats. For further details refer to article secret chats",
+ "seq": "Number of sent updates",
+ "unread_count": "Number of unread messages"
+ }
+ },
+ "upload.CdnFile": {
+ "desc": "Represent a chunk of a CDN file.",
+ "params": {
+ "bytes": "The data"
+ }
+ },
+ "upload.CdnFileReuploadNeeded": {
+ "desc": "The file was cleared from the temporary RAM cache of the CDN and has to be re-uploaded.",
+ "params": {
+ "request_token": "Request token (see CDN)"
+ }
+ },
+ "upload.File": {
+ "desc": "File content.",
+ "params": {
+ "bytes": "Binary data, file content",
+ "mtime": "Modification time",
+ "type": "File type"
+ }
+ },
+ "upload.FileCdnRedirect": {
+ "desc": "The file must be downloaded from a CDN DC.",
+ "params": {
+ "dc_id": "CDN DC ID",
+ "encryption_iv": "Encryption IV (see CDN files)",
+ "encryption_key": "Encryption key (see CDN files)",
+ "file_hashes": "File hashes (see CDN files)",
+ "file_token": "File token (see CDN files)"
+ }
+ },
+ "upload.WebFile": {
+ "desc": "Represents a chunk of an HTTP webfile downloaded through telegram's secure MTProto servers",
+ "params": {
+ "bytes": "Data",
+ "file_type": "File type",
+ "mime_type": "Mime type",
+ "mtime": "Modified time",
+ "size": "File size"
+ }
+ },
+ "users.SavedMusic": {
+ "desc": "List of songs currently pinned on a user's profile, see here \u00bb for more info.",
+ "params": {
+ "count": "Total number of songs (can be bigger than documents depending on the passed limit, and the default maximum limit in which case pagination is required).",
+ "documents": "Songs."
+ }
+ },
+ "users.SavedMusicNotModified": {
+ "desc": "This subset of the songs currently pinned on a user's profile hasn't changed, see here \u00bb for more info.",
+ "params": {
+ "count": "Total number of songs on the user's profile."
+ }
+ },
+ "users.UserFull": {
+ "desc": "Full user information",
+ "params": {
+ "chats": "Mentioned chats",
+ "full_user": "Full user information",
+ "users": "Mentioned users"
+ }
+ },
+ "users.Users": {
+ "desc": "Describes a list of users (or bots).",
+ "params": {
+ "users": "Users"
+ }
+ },
+ "users.UsersSlice": {
+ "desc": "Describes a partial list of users.",
+ "params": {
+ "count": "Total number of users (bigger than the users specified in users)",
+ "users": "Subset of users."
+ }
+ }
+ },
+ "method": {
+ "InitConnection": {
+ "desc": "Initialize connection",
+ "params": {
+ "api_id": "Application identifier (see. App configuration)",
+ "app_version": "Application version",
+ "device_model": "Device model",
+ "flags": "Flags, see TL conditional fields",
+ "lang_code": "Either an ISO 639-1 language code or a language pack name obtained from a language pack link.",
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc).",
+ "params": "Additional initConnection parameters. For now, only the tz_offset field is supported, for specifying the timezone offset in seconds.",
+ "proxy": "Info about an MTProto proxy",
+ "query": "The query itself",
+ "system_lang_code": "Code for the language used on the device's OS, ISO 639-1 standard",
+ "system_version": "Operation system version"
+ }
+ },
+ "InvokeAfterMsg": {
+ "desc": "Invokes a query after successful completion of one of the previous queries.",
+ "params": {
+ "msg_id": "Message identifier on which a current query depends",
+ "query": "The query itself"
+ }
+ },
+ "InvokeAfterMsgs": {
+ "desc": "Invokes a query after a successful completion of previous queries",
+ "params": {
+ "msg_ids": "List of messages on which a current query depends",
+ "query": "The query itself"
+ }
+ },
+ "InvokeWithApnsSecret": {
+ "desc": "Official clients only, invoke with Apple push verification.",
+ "params": {
+ "nonce": "Nonce.",
+ "query": "Query.",
+ "secret": "Secret."
+ }
+ },
+ "InvokeWithBusinessConnection": {
+ "desc": "Invoke a method using a Telegram Business Bot connection, see here \u00bb for more info, including a list of the methods that can be wrapped in this constructor.",
+ "params": {
+ "connection_id": "Business connection ID.",
+ "query": "The actual query."
+ }
+ },
+ "InvokeWithGooglePlayIntegrity": {
+ "desc": "Official clients only, invoke with Google Play Integrity token.",
+ "params": {
+ "nonce": "Nonce.",
+ "query": "Query.",
+ "token": "Token."
+ }
+ },
+ "InvokeWithLayer": {
+ "desc": "Invoke the specified query using the specified API layer",
+ "params": {
+ "layer": "The layer to use",
+ "query": "The query"
+ }
+ },
+ "InvokeWithMessagesRange": {
+ "desc": "Invoke with the given message range",
+ "params": {
+ "query": "Query",
+ "range": "Message range"
+ }
+ },
+ "InvokeWithReCaptcha": {
+ "desc": "Official clients only: re-execute a method call that required reCAPTCHA verification via a RECAPTCHA_CHECK_%s__%s, where the first placeholder is the action, and the second one is the reCAPTCHA key ID.",
+ "params": {
+ "query": "The original method call.",
+ "token": "reCAPTCHA token received after verification."
+ }
+ },
+ "InvokeWithTakeout": {
+ "desc": "Invoke a method within a takeout session, see here \u00bb for more info.",
+ "params": {
+ "query": "Query",
+ "takeout_id": "Takeout session ID \u00bb"
+ }
+ },
+ "InvokeWithoutUpdates": {
+ "desc": "Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries).",
+ "params": {
+ "query": "The query"
+ }
+ },
+ "account.AcceptAuthorization": {
+ "desc": "Sends a Telegram Passport authorization form, effectively sharing data with the service",
+ "params": {
+ "bot_id": "Bot ID",
+ "credentials": "Encrypted values",
+ "public_key": "Service's public key",
+ "scope": "Telegram Passport element types requested by the service",
+ "value_hashes": "Types of values sent and their hashes"
+ }
+ },
+ "account.CancelPasswordEmail": {
+ "desc": "Cancel the code that was sent to verify an email to use as 2FA recovery method.",
+ "params": {}
+ },
+ "account.ChangeAuthorizationSettings": {
+ "desc": "Change settings related to a session.",
+ "params": {
+ "call_requests_disabled": "Whether to enable or disable receiving calls: if the flag is not set, the previous setting is not changed",
+ "confirmed": "If set, confirms a newly logged in session \u00bb.",
+ "encrypted_requests_disabled": "Whether to enable or disable receiving encrypted chats: if the flag is not set, the previous setting is not changed",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Session ID from the authorization constructor, fetchable using account.getAuthorizations"
+ }
+ },
+ "account.ChangePhone": {
+ "desc": "Change the phone number of the current account",
+ "params": {
+ "phone_code": "Phone code received when calling account.sendChangePhoneCode",
+ "phone_code_hash": "Phone code hash received when calling account.sendChangePhoneCode",
+ "phone_number": "New phone number"
+ }
+ },
+ "account.CheckUsername": {
+ "desc": "Validates a username and checks availability.",
+ "params": {
+ "username": "usernameAccepted characters: A-z (case-insensitive), 0-9 and underscores.Length: 5-32 characters."
+ }
+ },
+ "account.ClearRecentEmojiStatuses": {
+ "desc": "Clears list of recently used emoji statuses",
+ "params": {}
+ },
+ "account.ConfirmPasswordEmail": {
+ "desc": "Verify an email to use as 2FA recovery method.",
+ "params": {
+ "code": "The phone code that was received after setting a recovery email"
+ }
+ },
+ "account.ConfirmPhone": {
+ "desc": "Confirm a phone number to cancel account deletion, for more info click here \u00bb",
+ "params": {
+ "phone_code": "SMS code, for more info click here \u00bb",
+ "phone_code_hash": "Phone code hash, for more info click here \u00bb"
+ }
+ },
+ "account.CreateBusinessChatLink": {
+ "desc": "Create a business chat deep link \u00bb.",
+ "params": {
+ "link": "Info about the link to create."
+ }
+ },
+ "account.CreateTheme": {
+ "desc": "Create a theme",
+ "params": {
+ "document": "Theme file",
+ "flags": "Flags, see TL conditional fields",
+ "settings": "Theme settings, multiple values can be provided for the different base themes (day/night mode, etc).",
+ "slug": "Unique theme ID used to generate theme deep links, can be empty to autogenerate a random ID.",
+ "title": "Theme name"
+ }
+ },
+ "account.DeclinePasswordReset": {
+ "desc": "Abort a pending 2FA password reset, see here for more info \u00bb",
+ "params": {}
+ },
+ "account.DeleteAccount": {
+ "desc": "Delete the user's account from the telegram servers.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "password": "2FA password: this field can be omitted even for accounts with 2FA enabled: in this case account account deletion will be delayed by 7 days as specified in the docs \u00bb",
+ "reason": "Why is the account being deleted, can be empty"
+ }
+ },
+ "account.DeleteAutoSaveExceptions": {
+ "desc": "Clear all peer-specific autosave settings.",
+ "params": {}
+ },
+ "account.DeleteBusinessChatLink": {
+ "desc": "Delete a business chat deep link \u00bb.",
+ "params": {
+ "slug": "Slug of the link, obtained as specified here \u00bb."
+ }
+ },
+ "account.DeleteSecureValue": {
+ "desc": "Delete stored Telegram Passport documents, for more info see the passport docs \u00bb",
+ "params": {
+ "types": "Document types to delete"
+ }
+ },
+ "account.DisablePeerConnectedBot": {
+ "desc": "Permanently disconnect a specific chat from all business bots \u00bb (equivalent to specifying it in recipients.exclude_users during initial configuration with account.updateConnectedBot \u00bb); to reconnect of a chat disconnected using this method the user must reconnect the entire bot by invoking account.updateConnectedBot \u00bb.",
+ "params": {
+ "peer": "The chat to disconnect"
+ }
+ },
+ "account.EditBusinessChatLink": {
+ "desc": "Edit a created business chat deep link \u00bb.",
+ "params": {
+ "link": "New link information.",
+ "slug": "Slug of the link, obtained as specified here \u00bb."
+ }
+ },
+ "account.FinishTakeoutSession": {
+ "desc": "Terminate a takeout session, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "success": "Data exported successfully"
+ }
+ },
+ "account.GetAccountTTL": {
+ "desc": "Get days to live of account",
+ "params": {}
+ },
+ "account.GetAllSecureValues": {
+ "desc": "Get all saved Telegram Passport documents, for more info see the passport docs \u00bb",
+ "params": {}
+ },
+ "account.GetAuthorizationForm": {
+ "desc": "Returns a Telegram Passport authorization form for sharing data with a service",
+ "params": {
+ "bot_id": "User identifier of the service's bot",
+ "public_key": "Service's public key",
+ "scope": "Telegram Passport element types requested by the service"
+ }
+ },
+ "account.GetAuthorizations": {
+ "desc": "Get logged-in sessions",
+ "params": {}
+ },
+ "account.GetAutoDownloadSettings": {
+ "desc": "Get media autodownload settings",
+ "params": {}
+ },
+ "account.GetAutoSaveSettings": {
+ "desc": "Get autosave settings",
+ "params": {}
+ },
+ "account.GetBotBusinessConnection": {
+ "desc": "Bots may invoke this method to re-fetch the updateBotBusinessConnect constructor associated with a specific business connection_id, see here \u00bb for more info on connected business bots.\nThis is needed for example for freshly logged in bots that are receiving some updateBotNewBusinessMessage, etc. updates because some users have already connected to the bot before it could login.\nIn this case, the bot is receiving messages from the business connection, but it hasn't cached the associated updateBotBusinessConnect with info about the connection (can it reply to messages? etc.) yet, and cannot receive the old ones because they were sent when the bot wasn't logged into the session yet.\nThis method can be used to fetch info about a not-yet-cached business connection, and should not be invoked if the info is already cached or to fetch changes, as eventual changes will automatically be sent as new updateBotBusinessConnect updates to the bot using the usual update delivery methods \u00bb.",
+ "params": {
+ "connection_id": "Business connection ID \u00bb."
+ }
+ },
+ "account.GetBusinessChatLinks": {
+ "desc": "List all created business chat deep links \u00bb.",
+ "params": {}
+ },
+ "account.GetChannelDefaultEmojiStatuses": {
+ "desc": "Get a list of default suggested channel emoji statuses.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetChannelRestrictedStatusEmojis": {
+ "desc": "Returns fetch the full list of custom emoji IDs \u00bb that cannot be used in channel emoji statuses \u00bb.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetChatThemes": {
+ "desc": "Get all available chat themes \u00bb.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetCollectibleEmojiStatuses": {
+ "desc": "Obtain a list of emoji statuses \u00bb for owned collectible gifts.",
+ "params": {
+ "hash": "Hash for pagination"
+ }
+ },
+ "account.GetConnectedBots": {
+ "desc": "List all currently connected business bots \u00bb",
+ "params": {}
+ },
+ "account.GetContactSignUpNotification": {
+ "desc": "Whether the user will receive notifications when contacts sign up",
+ "params": {}
+ },
+ "account.GetContentSettings": {
+ "desc": "Get sensitive content settings",
+ "params": {}
+ },
+ "account.GetDefaultBackgroundEmojis": {
+ "desc": "Get a set of suggested custom emoji stickers that can be used in an accent color pattern.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetDefaultEmojiStatuses": {
+ "desc": "Get a list of default suggested emoji statuses",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetDefaultGroupPhotoEmojis": {
+ "desc": "Get a set of suggested custom emoji stickers that can be used as group picture",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetDefaultProfilePhotoEmojis": {
+ "desc": "Get a set of suggested custom emoji stickers that can be used as profile picture",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetGlobalPrivacySettings": {
+ "desc": "Get global privacy settings",
+ "params": {}
+ },
+ "account.GetMultiWallPapers": {
+ "desc": "Get info about multiple wallpapers",
+ "params": {
+ "wallpapers": "Wallpapers to fetch info about"
+ }
+ },
+ "account.GetNotifyExceptions": {
+ "desc": "Returns list of chats with non-default notification settings",
+ "params": {
+ "compare_sound": "If set, chats with non-default sound will be returned",
+ "compare_stories": "If set, chats with non-default notification settings for stories will be returned",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "If specified, only chats of the specified category will be returned"
+ }
+ },
+ "account.GetNotifySettings": {
+ "desc": "Gets current notification settings for a given user/group, from all users/all groups.",
+ "params": {
+ "peer": "Notification source"
+ }
+ },
+ "account.GetPaidMessagesRevenue": {
+ "desc": "Get the number of stars we have received from the specified user thanks to paid messages \u00bb; the received amount will be equal to the sent amount multiplied by stars_paid_message_commission_permille divided by 1000.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "parent_peer": "If set, can contain the ID of a monoforum (channel direct messages) to obtain the number of stars the user has spent to send us direct messages via the channel.",
+ "user_id": "The user that paid to send us messages."
+ }
+ },
+ "account.GetPassword": {
+ "desc": "Obtain configuration for two-factor authorization with password",
+ "params": {}
+ },
+ "account.GetPasswordSettings": {
+ "desc": "Get private info associated to the password info (recovery email, telegram passport info & so on)",
+ "params": {
+ "password": "The password (see SRP)"
+ }
+ },
+ "account.GetPrivacy": {
+ "desc": "Get privacy settings of current account",
+ "params": {
+ "key": "Peer category whose privacy settings should be fetched"
+ }
+ },
+ "account.GetReactionsNotifySettings": {
+ "desc": "Get the current reaction notification settings \u00bb.",
+ "params": {}
+ },
+ "account.GetRecentEmojiStatuses": {
+ "desc": "Get recently used emoji statuses",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetSavedMusicIds": {
+ "desc": "Fetch the full list of only the IDs of songs currently added to the profile, see here \u00bb for more info.",
+ "params": {
+ "hash": "Hash generated \u00bb from the previously returned list of IDs."
+ }
+ },
+ "account.GetSavedRingtones": {
+ "desc": "Fetch saved notification sounds",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetSecureValue": {
+ "desc": "Get saved Telegram Passport document, for more info see the passport docs \u00bb",
+ "params": {
+ "types": "Requested value types"
+ }
+ },
+ "account.GetTheme": {
+ "desc": "Get theme information",
+ "params": {
+ "format": "Theme format, a string that identifies the theming engines supported by the client",
+ "theme": "Theme"
+ }
+ },
+ "account.GetThemes": {
+ "desc": "Get installed themes",
+ "params": {
+ "format": "Theme format, a string that identifies the theming engines supported by the client",
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetTmpPassword": {
+ "desc": "Get temporary payment password",
+ "params": {
+ "password": "SRP password parameters",
+ "period": "Time during which the temporary password will be valid, in seconds; should be between 60 and 86400"
+ }
+ },
+ "account.GetUniqueGiftChatThemes": {
+ "desc": "Obtain all chat themes \u00bb associated to owned collectible gifts \u00bb.",
+ "params": {
+ "hash": "Hash from a previously returned account.chatThemes constructor, to avoid returning any result if the theme list hasn't changed.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination."
+ }
+ },
+ "account.GetWallPaper": {
+ "desc": "Get info about a certain wallpaper",
+ "params": {
+ "wallpaper": "The wallpaper to get info about"
+ }
+ },
+ "account.GetWallPapers": {
+ "desc": "Returns a list of available wallpapers.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "account.GetWebAuthorizations": {
+ "desc": "Get web login widget authorizations",
+ "params": {}
+ },
+ "account.InitTakeoutSession": {
+ "desc": "Initialize a takeout session, see here \u00bb for more info.",
+ "params": {
+ "contacts": "Whether to export contacts",
+ "file_max_size": "Maximum size of files to export",
+ "files": "Whether to export files",
+ "flags": "Flags, see TL conditional fields",
+ "message_channels": "Whether to export messages in channels",
+ "message_chats": "Whether to export messages in basic groups",
+ "message_megagroups": "Whether to export messages in supergroups",
+ "message_users": "Whether to export messages in private chats"
+ }
+ },
+ "account.InstallTheme": {
+ "desc": "Install a theme",
+ "params": {
+ "base_theme": "Indicates a basic theme provided by all clients",
+ "dark": "Whether to install the dark version",
+ "flags": "Flags, see TL conditional fields",
+ "format": "Theme format, a string that identifies the theming engines supported by the client",
+ "theme": "Theme to install"
+ }
+ },
+ "account.InstallWallPaper": {
+ "desc": "Install wallpaper",
+ "params": {
+ "settings": "Wallpaper settings",
+ "wallpaper": "Wallpaper to install"
+ }
+ },
+ "account.InvalidateSignInCodes": {
+ "desc": "Invalidate the specified login codes, see here \u00bb for more info.",
+ "params": {
+ "codes": "The login codes to invalidate."
+ }
+ },
+ "account.RegisterDevice": {
+ "desc": "Register device to receive PUSH notifications",
+ "params": {
+ "app_sandbox": "If (boolTrue) is transmitted, a sandbox-certificate will be used during transmission.",
+ "flags": "Flags, see TL conditional fields",
+ "no_muted": "Avoid receiving (silent and invisible background) notifications. Useful to save battery.",
+ "other_uids": "List of user identifiers of other users currently using the client",
+ "secret": "For FCM and APNS VoIP, optional encryption key used to encrypt push notifications",
+ "token": "Device token, see PUSH updates for the possible values.",
+ "token_type": "Device token type, see PUSH updates for the possible values."
+ }
+ },
+ "account.ReorderUsernames": {
+ "desc": "Reorder usernames associated with the currently logged-in user.",
+ "params": {
+ "order": "The new order for active usernames. All active usernames must be specified."
+ }
+ },
+ "account.ReportPeer": {
+ "desc": "Report a peer for violation of telegram's Terms of Service",
+ "params": {
+ "message": "Comment for report moderation",
+ "peer": "The peer to report",
+ "reason": "The reason why this peer is being reported"
+ }
+ },
+ "account.ReportProfilePhoto": {
+ "desc": "Report a profile photo of a dialog",
+ "params": {
+ "message": "Comment for report moderation",
+ "peer": "The dialog",
+ "photo_id": "Dialog photo ID",
+ "reason": "Report reason"
+ }
+ },
+ "account.ResendPasswordEmail": {
+ "desc": "Resend the code to verify an email to use as 2FA recovery method.",
+ "params": {}
+ },
+ "account.ResetAuthorization": {
+ "desc": "Log out an active authorized session by its hash",
+ "params": {
+ "hash": "Session hash"
+ }
+ },
+ "account.ResetNotifySettings": {
+ "desc": "Resets all notification settings from users and groups.",
+ "params": {}
+ },
+ "account.ResetPassword": {
+ "desc": "Initiate a 2FA password reset: can only be used if the user is already logged-in, see here for more info \u00bb",
+ "params": {}
+ },
+ "account.ResetWallPapers": {
+ "desc": "Delete all installed wallpapers, reverting to the default wallpaper set.",
+ "params": {}
+ },
+ "account.ResetWebAuthorization": {
+ "desc": "Log out an active web telegram login session",
+ "params": {
+ "hash": "Session hash"
+ }
+ },
+ "account.ResetWebAuthorizations": {
+ "desc": "Reset all active web telegram login sessions",
+ "params": {}
+ },
+ "account.ResolveBusinessChatLink": {
+ "desc": "Resolve a business chat deep link \u00bb.",
+ "params": {
+ "slug": "Slug of the link, obtained as specified here \u00bb."
+ }
+ },
+ "account.SaveAutoDownloadSettings": {
+ "desc": "Change media autodownload settings",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "high": "Whether to save media in the high data usage preset",
+ "low": "Whether to save media in the low data usage preset",
+ "settings": "Media autodownload settings"
+ }
+ },
+ "account.SaveAutoSaveSettings": {
+ "desc": "Modify autosave settings",
+ "params": {
+ "broadcasts": "Whether the new settings should affect all channels",
+ "chats": "Whether the new settings should affect all groups",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Whether the new settings should affect a specific peer",
+ "settings": "The new autosave settings",
+ "users": "Whether the new settings should affect all private chats"
+ }
+ },
+ "account.SaveMusic": {
+ "desc": "Adds or removes a song from the current user's profile see here \u00bb for more info on the music tab of the profile page.",
+ "params": {
+ "after_id": "If set, the song will be added after the passed song (must be already pinned on the profile).",
+ "flags": "Flags, see TL conditional fields",
+ "id": "The song to add or remove; can be an already added song when reordering songs with after_id. Adding an already added song will never re-add it, only move it to the top of the song list (or after the song passed in after_id).",
+ "unsave": "If set, removes the song."
+ }
+ },
+ "account.SaveRingtone": {
+ "desc": "Save or remove saved notification sound.",
+ "params": {
+ "id": "Notification sound uploaded using account.uploadRingtone",
+ "unsave": "Whether to add or delete the notification sound"
+ }
+ },
+ "account.SaveSecureValue": {
+ "desc": "Securely save Telegram Passport document, for more info see the passport docs \u00bb",
+ "params": {
+ "secure_secret_id": "Passport secret hash, for more info see the passport docs \u00bb",
+ "value": "Secure value, for more info see the passport docs \u00bb"
+ }
+ },
+ "account.SaveTheme": {
+ "desc": "Save a theme",
+ "params": {
+ "theme": "Theme to save",
+ "unsave": "Unsave"
+ }
+ },
+ "account.SaveWallPaper": {
+ "desc": "Install/uninstall wallpaper",
+ "params": {
+ "settings": "Wallpaper settings",
+ "unsave": "Uninstall wallpaper?",
+ "wallpaper": "Wallpaper to install or uninstall"
+ }
+ },
+ "account.SendChangePhoneCode": {
+ "desc": "Verify a new phone number to associate to the current account",
+ "params": {
+ "phone_number": "New phone number",
+ "settings": "Phone code settings"
+ }
+ },
+ "account.SendConfirmPhoneCode": {
+ "desc": "Send confirmation code to cancel account deletion, for more info click here \u00bb",
+ "params": {
+ "hash": "The hash from the service notification, for more info click here \u00bb",
+ "settings": "Phone code settings"
+ }
+ },
+ "account.SendVerifyEmailCode": {
+ "desc": "Send an email verification code.",
+ "params": {
+ "email": "The email where to send the code.",
+ "purpose": "Verification purpose."
+ }
+ },
+ "account.SendVerifyPhoneCode": {
+ "desc": "Send the verification phone code for telegram passport.",
+ "params": {
+ "phone_number": "The phone number to verify",
+ "settings": "Phone code settings"
+ }
+ },
+ "account.SetAccountTTL": {
+ "desc": "Set account self-destruction period",
+ "params": {
+ "ttl": "Time to live in days"
+ }
+ },
+ "account.SetAuthorizationTTL": {
+ "desc": "Set time-to-live of current session",
+ "params": {
+ "authorization_ttl_days": "Time-to-live of current session in days"
+ }
+ },
+ "account.SetContactSignUpNotification": {
+ "desc": "Toggle contact sign up notifications",
+ "params": {
+ "silent": "Whether to disable contact sign up notifications"
+ }
+ },
+ "account.SetContentSettings": {
+ "desc": "Set sensitive content settings (for viewing or hiding NSFW content)",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "sensitive_enabled": "Enable NSFW content"
+ }
+ },
+ "account.SetGlobalPrivacySettings": {
+ "desc": "Set global privacy settings",
+ "params": {
+ "settings": "Global privacy settings"
+ }
+ },
+ "account.SetMainProfileTab": {
+ "desc": "Changes the main profile tab of the current user, see here \u00bb for more info.",
+ "params": {
+ "tab": "The tab to set as main tab."
+ }
+ },
+ "account.SetPrivacy": {
+ "desc": "Change privacy settings of current account",
+ "params": {
+ "key": "New privacy rule",
+ "rules": "Peers to which the privacy rule will apply."
+ }
+ },
+ "account.SetReactionsNotifySettings": {
+ "desc": "Change the reaction notification settings \u00bb.",
+ "params": {
+ "settings": "New reaction notification settings."
+ }
+ },
+ "account.ToggleConnectedBotPaused": {
+ "desc": "Pause or unpause a specific chat, temporarily disconnecting it from all business bots \u00bb.",
+ "params": {
+ "paused": "Whether to pause or unpause the chat",
+ "peer": "The chat to pause"
+ }
+ },
+ "account.ToggleNoPaidMessagesException": {
+ "desc": "Allow a user to send us messages without paying if paid messages \u00bb are enabled.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "parent_peer": "If set, applies the setting within the monoforum aka direct messages \u00bb (pass the ID of the monoforum, not the ID of the associated channel).",
+ "refund_charged": "If set and require_payment is not set, refunds the amounts the user has already paid us to send us messages (directly or via a monoforum).",
+ "require_payment": "If set, requires the user to pay in order to send us messages. Can only be set by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages privacy setting to remove a previously added exemption. If not set, allows the user to send us messages without paying (can be unset by both monoforums and users).",
+ "user_id": "The user to exempt or unexempt."
+ }
+ },
+ "account.ToggleSponsoredMessages": {
+ "desc": "Disable or re-enable Telegram ads for the current Premium account.",
+ "params": {
+ "enabled": "Enable or disable ads."
+ }
+ },
+ "account.ToggleUsername": {
+ "desc": "Activate or deactivate a purchased fragment.com username associated to the currently logged-in user.",
+ "params": {
+ "active": "Whether to activate or deactivate it",
+ "username": "Username"
+ }
+ },
+ "account.UnregisterDevice": {
+ "desc": "Deletes a device by its token, stops sending PUSH-notifications to it.",
+ "params": {
+ "other_uids": "List of user identifiers of other users currently using the client",
+ "token": "Device token, see PUSH updates for the possible values.",
+ "token_type": "Device token type, see PUSH updates for the possible values."
+ }
+ },
+ "account.UpdateBirthday": {
+ "desc": "Update our birthday, see here \u00bb for more info.",
+ "params": {
+ "birthday": "Birthday.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "account.UpdateBusinessAwayMessage": {
+ "desc": "Set a list of Telegram Business away messages.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "message": "Away message configuration and contents."
+ }
+ },
+ "account.UpdateBusinessGreetingMessage": {
+ "desc": "Set a list of Telegram Business greeting messages.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "message": "Greeting message configuration and contents."
+ }
+ },
+ "account.UpdateBusinessIntro": {
+ "desc": "Set or remove the Telegram Business introduction \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "intro": "Telegram Business introduction, to remove it call the method without setting this flag."
+ }
+ },
+ "account.UpdateBusinessLocation": {
+ "desc": "Businesses \u00bb may advertise their location using this method, see here \u00bb for more info.",
+ "params": {
+ "address": "Mandatory when setting/updating the location, contains a textual description of the address (max 96 UTF-8 chars).",
+ "flags": "Flags, see TL conditional fields",
+ "geo_point": "Optional, contains a set of geographical coordinates."
+ }
+ },
+ "account.UpdateBusinessWorkHours": {
+ "desc": "Specify a set of Telegram Business opening hours.\nThis info will be contained in userFull.business_work_hours.",
+ "params": {
+ "business_work_hours": "Opening hours (optional, if not set removes all opening hours).",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "account.UpdateColor": {
+ "desc": "Update the accent color and background custom emoji \u00bb of the current account.",
+ "params": {
+ "background_emoji_id": "Custom emoji ID used in the accent color pattern.",
+ "color": "ID of the accent color palette \u00bb to use (not RGB24, see here \u00bb for more info).",
+ "flags": "Flags, see TL conditional fields",
+ "for_profile": "Whether to change the accent color emoji pattern of the profile page; otherwise, the accent color and emoji pattern of messages will be changed."
+ }
+ },
+ "account.UpdateConnectedBot": {
+ "desc": "Connect a business bot \u00bb to the current account, or to change the current connection settings.",
+ "params": {
+ "bot": "The bot to connect or disconnect",
+ "deleted": "Whether to fully disconnect the bot from the current account.",
+ "flags": "Flags, see TL conditional fields",
+ "recipients": "Configuration for the business connection",
+ "rights": "Business bot rights."
+ }
+ },
+ "account.UpdateDeviceLocked": {
+ "desc": "When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications.",
+ "params": {
+ "period": "Inactivity period after which to start hiding message texts in PUSH notifications."
+ }
+ },
+ "account.UpdateEmojiStatus": {
+ "desc": "Set an emoji status",
+ "params": {
+ "emoji_status": "Emoji status to set"
+ }
+ },
+ "account.UpdateNotifySettings": {
+ "desc": "Edits notification settings from a given user/group, from all users/all groups.",
+ "params": {
+ "peer": "Notification source",
+ "settings": "Notification settings"
+ }
+ },
+ "account.UpdatePasswordSettings": {
+ "desc": "Set a new 2FA password",
+ "params": {
+ "new_settings": "The new password (see SRP)",
+ "password": "The old password (see SRP)"
+ }
+ },
+ "account.UpdatePersonalChannel": {
+ "desc": "Associate (or remove) a personal channel \u00bb, that will be listed on our personal profile page \u00bb.",
+ "params": {
+ "channel": "The channel, pass inputChannelEmpty to remove it."
+ }
+ },
+ "account.UpdateProfile": {
+ "desc": "Updates user profile.",
+ "params": {
+ "about": "New bio",
+ "first_name": "New user first name",
+ "flags": "Flags, see TL conditional fields",
+ "last_name": "New user last name"
+ }
+ },
+ "account.UpdateStatus": {
+ "desc": "Updates online user status.",
+ "params": {
+ "offline": "If (boolTrue) is transmitted, user status will change to (userStatusOffline)."
+ }
+ },
+ "account.UpdateTheme": {
+ "desc": "Update theme",
+ "params": {
+ "document": "Theme file",
+ "flags": "Flags, see TL conditional fields",
+ "format": "Theme format, a string that identifies the theming engines supported by the client",
+ "settings": "Theme settings",
+ "slug": "Unique theme ID",
+ "theme": "Theme to update",
+ "title": "Theme name"
+ }
+ },
+ "account.UpdateUsername": {
+ "desc": "Changes username for the current user.",
+ "params": {
+ "username": "username or empty string if username is to be removedAccepted characters: a-z (case-insensitive), 0-9 and underscores.Length: 5-32 characters."
+ }
+ },
+ "account.UploadRingtone": {
+ "desc": "Upload notification sound, use account.saveRingtone to convert it and add it to the list of saved notification sounds.",
+ "params": {
+ "file": "Notification sound",
+ "file_name": "File name",
+ "mime_type": "MIME type of file"
+ }
+ },
+ "account.UploadTheme": {
+ "desc": "Upload theme",
+ "params": {
+ "file": "Previously uploaded theme file with platform-specific colors for UI components, can be left unset when creating themes that only modify the wallpaper or accent colors.",
+ "file_name": "File name",
+ "flags": "Flags, see TL conditional fields",
+ "mime_type": "MIME type, must be application/x-tgtheme-{format}, where format depends on the client",
+ "thumb": "Thumbnail"
+ }
+ },
+ "account.UploadWallPaper": {
+ "desc": "Create and upload a new wallpaper",
+ "params": {
+ "file": "The JPG/PNG wallpaper",
+ "flags": "Flags, see TL conditional fields",
+ "for_chat": "Set this flag when uploading wallpapers to be passed to messages.setChatWallPaper.",
+ "mime_type": "MIME type of uploaded wallpaper",
+ "settings": "Wallpaper settings"
+ }
+ },
+ "account.VerifyEmail": {
+ "desc": "Verify an email address.",
+ "params": {
+ "purpose": "Verification purpose",
+ "verification": "Email verification code or token"
+ }
+ },
+ "account.VerifyPhone": {
+ "desc": "Verify a phone number for telegram passport.",
+ "params": {
+ "phone_code": "Code received after the call to account.sendVerifyPhoneCode",
+ "phone_code_hash": "Phone code hash received from the call to account.sendVerifyPhoneCode",
+ "phone_number": "Phone number"
+ }
+ },
+ "auth.AcceptLoginToken": {
+ "desc": "Accept QR code login token, logging in the app that generated it.",
+ "params": {
+ "token": "Login token embedded in QR code, for more info, see login via QR code."
+ }
+ },
+ "auth.BindTempAuthKey": {
+ "desc": "Binds a temporary authorization key temp_auth_key_id to the permanent authorization key perm_auth_key_id. Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one.",
+ "params": {
+ "encrypted_message": "See Generating encrypted_message",
+ "expires_at": "Unix timestamp to invalidate temporary key, see Binding message contents",
+ "nonce": "Random long from Binding message contents",
+ "perm_auth_key_id": "Permanent auth_key_id to bind to"
+ }
+ },
+ "auth.CancelCode": {
+ "desc": "Cancel the login verification code",
+ "params": {
+ "phone_code_hash": "Phone code hash from auth.sendCode",
+ "phone_number": "Phone number"
+ }
+ },
+ "auth.CheckPassword": {
+ "desc": "Try logging to an account protected by a 2FA password.",
+ "params": {
+ "password": "The account's password (see SRP)"
+ }
+ },
+ "auth.CheckRecoveryPassword": {
+ "desc": "Check if the 2FA recovery code sent using auth.requestPasswordRecovery is valid, before passing it to auth.recoverPassword.",
+ "params": {
+ "code": "Code received via email"
+ }
+ },
+ "auth.DropTempAuthKeys": {
+ "desc": "Delete all temporary authorization keys except for the ones specified",
+ "params": {
+ "except_auth_keys": "The auth keys that shouldn't be dropped."
+ }
+ },
+ "auth.ExportAuthorization": {
+ "desc": "Returns data for copying authorization to another data-center.",
+ "params": {
+ "dc_id": "Number of a target data-center"
+ }
+ },
+ "auth.ExportLoginToken": {
+ "desc": "Generate a login token, for login via QR code.\nThe generated login token should be encoded using base64url, then shown as a tg://login?token=base64encodedtoken deep link \u00bb in the QR code.",
+ "params": {
+ "api_hash": "Application identifier hash (see. App configuration)",
+ "api_id": "Application identifier (see. App configuration)",
+ "except_ids": "List of already logged-in user IDs, to prevent logging in twice with the same user"
+ }
+ },
+ "auth.ImportAuthorization": {
+ "desc": "Logs in a user using a key transmitted from his native data-center.",
+ "params": {
+ "bytes": "Authorization key",
+ "id": "User ID"
+ }
+ },
+ "auth.ImportBotAuthorization": {
+ "desc": "Login as a bot",
+ "params": {
+ "api_hash": "Application identifier hash (see. App configuration)",
+ "api_id": "Application identifier (see. App configuration)",
+ "bot_auth_token": "Bot token (see bots)",
+ "flags": "Reserved for future use"
+ }
+ },
+ "auth.ImportLoginToken": {
+ "desc": "Login using a redirected login token, generated in case of DC mismatch during QR code login.",
+ "params": {
+ "token": "Login token"
+ }
+ },
+ "auth.ImportWebTokenAuthorization": {
+ "desc": "Login by importing an authorization token",
+ "params": {
+ "api_hash": "API hash",
+ "api_id": "API ID",
+ "web_auth_token": "The authorization token"
+ }
+ },
+ "auth.LogOut": {
+ "desc": "Logs out the user.",
+ "params": {}
+ },
+ "auth.RecoverPassword": {
+ "desc": "Reset the 2FA password using the recovery code sent using auth.requestPasswordRecovery.",
+ "params": {
+ "code": "Code received via email",
+ "flags": "Flags, see TL conditional fields",
+ "new_settings": "New password"
+ }
+ },
+ "auth.ReportMissingCode": {
+ "desc": "Official apps only, reports that the SMS authentication code wasn't delivered.",
+ "params": {
+ "mnc": "MNC of the current network operator.",
+ "phone_code_hash": "The phone code hash obtained from auth.sendCode",
+ "phone_number": "Phone number where we were supposed to receive the code"
+ }
+ },
+ "auth.RequestFirebaseSms": {
+ "desc": "Request an SMS code via Firebase.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "ios_push_secret": "Secret token received via an apple push notification",
+ "phone_code_hash": "Phone code hash returned by auth.sendCode",
+ "phone_number": "Phone number",
+ "play_integrity_token": "On Android, an object obtained as described in the auth documentation \u00bb",
+ "safety_net_token": "On Android, a JWS object obtained as described in the auth documentation \u00bb"
+ }
+ },
+ "auth.RequestPasswordRecovery": {
+ "desc": "Request recovery code of a 2FA password, only for accounts with a recovery email configured.",
+ "params": {}
+ },
+ "auth.ResendCode": {
+ "desc": "Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "phone_code_hash": "The phone code hash obtained from auth.sendCode",
+ "phone_number": "The phone number",
+ "reason": "Official clients only, used if the device integrity verification failed, and no secret could be obtained to invoke auth.requestFirebaseSms: in this case, the device integrity verification failure reason must be passed here."
+ }
+ },
+ "auth.ResetAuthorizations": {
+ "desc": "Terminates all user's authorized sessions except for the current one.",
+ "params": {}
+ },
+ "auth.ResetLoginEmail": {
+ "desc": "Reset the login email \u00bb.",
+ "params": {
+ "phone_code_hash": "Phone code hash, obtained as described in the documentation \u00bb",
+ "phone_number": "Phone number of the account"
+ }
+ },
+ "auth.SendCode": {
+ "desc": "Send the verification code for login",
+ "params": {
+ "api_hash": "Application secret hash (see App configuration)",
+ "api_id": "Application identifier (see App configuration)",
+ "phone_number": "Phone number in international format",
+ "settings": "Settings for the code type to send"
+ }
+ },
+ "auth.SignIn": {
+ "desc": "Signs in a user with a validated phone number.",
+ "params": {
+ "email_verification": "Email verification code or token",
+ "flags": "Flags, see TL conditional fields",
+ "phone_code": "Valid numerical code from the SMS-message",
+ "phone_code_hash": "SMS-message ID, obtained from auth.sendCode",
+ "phone_number": "Phone number in the international format"
+ }
+ },
+ "auth.SignUp": {
+ "desc": "Registers a validated phone number in the system.",
+ "params": {
+ "first_name": "New user first name",
+ "flags": "Flags, see TL conditional fields",
+ "last_name": "New user last name",
+ "no_joined_notifications": "If set, users on Telegram that have already added phone_number to their contacts will not receive signup notifications about this user.",
+ "phone_code_hash": "SMS-message ID",
+ "phone_number": "Phone number in the international format"
+ }
+ },
+ "bots.AddPreviewMedia": {
+ "desc": "Add a main mini app preview, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App.",
+ "lang_code": "ISO 639-1 language code, indicating the localization of the preview to add.",
+ "media": "The photo/video preview, uploaded using messages.uploadMedia."
+ }
+ },
+ "bots.AllowSendMessage": {
+ "desc": "Allow the specified bot to send us messages",
+ "params": {
+ "bot": "The bot"
+ }
+ },
+ "bots.AnswerWebhookJSONQuery": {
+ "desc": "Answers a custom query; for bots only",
+ "params": {
+ "data": "JSON-serialized answer to the query",
+ "query_id": "Identifier of a custom query"
+ }
+ },
+ "bots.CanSendMessage": {
+ "desc": "Check whether the specified bot can send us messages",
+ "params": {
+ "bot": "The bot"
+ }
+ },
+ "bots.CheckDownloadFileParams": {
+ "desc": "Check if a mini app can request the download of a specific file: called when handling web_app_request_file_download events \u00bb",
+ "params": {
+ "bot": "The bot that owns the mini app that requested the download",
+ "file_name": "The filename from the web_app_request_file_download event \u00bb",
+ "url": "The url from the web_app_request_file_download event \u00bb"
+ }
+ },
+ "bots.DeletePreviewMedia": {
+ "desc": "Delete a main mini app preview, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App.",
+ "lang_code": "ISO 639-1 language code, indicating the localization of the preview to delete.",
+ "media": "The photo/video preview to delete, previously fetched as specified here \u00bb."
+ }
+ },
+ "bots.EditPreviewMedia": {
+ "desc": "Edit a main mini app preview, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App.",
+ "lang_code": "ISO 639-1 language code, indicating the localization of the preview to edit.",
+ "media": "The photo/video preview to replace, previously fetched as specified here \u00bb.",
+ "new_media": "The new photo/video preview, uploaded using messages.uploadMedia."
+ }
+ },
+ "bots.GetAdminedBots": {
+ "desc": "Get a list of bots owned by the current user",
+ "params": {}
+ },
+ "bots.GetBotCommands": {
+ "desc": "Obtain a list of bot commands for the specified bot scope and language code",
+ "params": {
+ "lang_code": "Language code",
+ "scope": "Command scope"
+ }
+ },
+ "bots.GetBotInfo": {
+ "desc": "Get localized name, about text and description of a bot (or of the current account, if called by a bot).",
+ "params": {
+ "bot": "If called by a user, must contain the peer of a bot we own.",
+ "flags": "Flags, see TL conditional fields",
+ "lang_code": "Language code, if left empty this method will return the fallback about text and description."
+ }
+ },
+ "bots.GetBotMenuButton": {
+ "desc": "Gets the menu button action for a given user or for all users, previously set using bots.setBotMenuButton; users can see this information in the botInfo constructor.",
+ "params": {
+ "user_id": "User ID or empty for the default menu button."
+ }
+ },
+ "bots.GetBotRecommendations": {
+ "desc": "Obtain a list of similarly themed bots, selected based on similarities in their subscriber bases, see here \u00bb for more info.",
+ "params": {
+ "bot": "The method will return bots related to the passed bot."
+ }
+ },
+ "bots.GetPopularAppBots": {
+ "desc": "Fetch popular Main Mini Apps, to be used in the apps tab of global search \u00bb.",
+ "params": {
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, initially an empty string, then re-use the next_offset returned by the previous query."
+ }
+ },
+ "bots.GetPreviewInfo": {
+ "desc": "Bot owners only, fetch main mini app preview information, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App.",
+ "lang_code": "Fetch previews for the specified ISO 639-1 language code."
+ }
+ },
+ "bots.GetPreviewMedias": {
+ "desc": "Fetch main mini app previews, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App."
+ }
+ },
+ "bots.InvokeWebViewCustomMethod": {
+ "desc": "Send a custom request from a mini bot app, triggered by a web_app_invoke_custom_method event \u00bb.",
+ "params": {
+ "bot": "Identifier of the bot associated to the mini bot app",
+ "custom_method": "Identifier of the custom method to invoke",
+ "params": "Method parameters"
+ }
+ },
+ "bots.ReorderPreviewMedias": {
+ "desc": "Reorder a main mini app previews, see here \u00bb for more info.",
+ "params": {
+ "bot": "The bot that owns the Main Mini App.",
+ "lang_code": "ISO 639-1 language code, indicating the localization of the previews to reorder.",
+ "order": "New order of the previews."
+ }
+ },
+ "bots.ReorderUsernames": {
+ "desc": "Reorder usernames associated to a bot we own.",
+ "params": {
+ "bot": "The bot",
+ "order": "The new order for active usernames. All active usernames must be specified."
+ }
+ },
+ "bots.ResetBotCommands": {
+ "desc": "Clear bot commands for the specified bot scope and language code",
+ "params": {
+ "lang_code": "Language code",
+ "scope": "Command scope"
+ }
+ },
+ "bots.SendCustomRequest": {
+ "desc": "Sends a custom request; for bots only",
+ "params": {
+ "custom_method": "The method name",
+ "params": "JSON-serialized method parameters"
+ }
+ },
+ "bots.SetBotBroadcastDefaultAdminRights": {
+ "desc": "Set the default suggested admin rights for bots being added as admins to channels, see here for more info on how to handle them \u00bb.",
+ "params": {
+ "admin_rights": "Admin rights"
+ }
+ },
+ "bots.SetBotCommands": {
+ "desc": "Set bot command list",
+ "params": {
+ "commands": "Bot commands",
+ "lang_code": "Language code",
+ "scope": "Command scope"
+ }
+ },
+ "bots.SetBotGroupDefaultAdminRights": {
+ "desc": "Set the default suggested admin rights for bots being added as admins to groups, see here for more info on how to handle them \u00bb.",
+ "params": {
+ "admin_rights": "Admin rights"
+ }
+ },
+ "bots.SetBotInfo": {
+ "desc": "Set localized name, about text and description of a bot (or of the current account, if called by a bot).",
+ "params": {
+ "about": "New about text",
+ "bot": "If called by a user, must contain the peer of a bot we own.",
+ "description": "New description",
+ "flags": "Flags, see TL conditional fields",
+ "lang_code": "Language code, if left empty update the fallback about text and description",
+ "name": "New bot name"
+ }
+ },
+ "bots.SetBotMenuButton": {
+ "desc": "Sets the menu button action \u00bb for a given user or for all users",
+ "params": {
+ "button": "Bot menu button action",
+ "user_id": "User ID"
+ }
+ },
+ "bots.SetCustomVerification": {
+ "desc": "Verify a user or chat on behalf of an organization \u00bb.",
+ "params": {
+ "bot": "Must not be set if invoked by a bot, must be set to the ID of an owned bot if invoked by a user.",
+ "custom_description": "Custom description for the verification, the UTF-8 length limit for this field is contained in bot_verification_description_length_limit \u00bb. If not set, Was verified by organization \"organization_name\" will be used as description.",
+ "enabled": "If set, adds the verification; otherwise removes verification.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer to verify"
+ }
+ },
+ "bots.ToggleUserEmojiStatusPermission": {
+ "desc": "Allow or prevent a bot from changing our emoji status \u00bb",
+ "params": {
+ "bot": "The bot",
+ "enabled": "Whether to allow or prevent the bot from changing our emoji status"
+ }
+ },
+ "bots.ToggleUsername": {
+ "desc": "Activate or deactivate a purchased fragment.com username associated to a bot we own.",
+ "params": {
+ "active": "Whether to activate or deactivate it",
+ "bot": "The bot",
+ "username": "Username"
+ }
+ },
+ "bots.UpdateStarRefProgram": {
+ "desc": "Create, edit or delete the affiliate program of a bot we own",
+ "params": {
+ "bot": "The bot",
+ "commission_permille": "The permille commission rate: it indicates the share of Telegram Stars received by affiliates for every transaction made by users they referred inside of the bot. The minimum and maximum values for this parameter are contained in the starref_min_commission_permille and starref_max_commission_permille client configuration parameters. Can be 0 to terminate the affiliate program. Both the duration and the commission may only be raised after creation of the program: to lower them, the program must first be terminated and a new one created.",
+ "duration_months": "Indicates the duration of the affiliate program; if not set, there is no expiration date.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "bots.UpdateUserEmojiStatus": {
+ "desc": "Change the emoji status of a user (invoked by bots, see here \u00bb for more info on the full flow)",
+ "params": {
+ "emoji_status": "The emoji status",
+ "user_id": "The user whose emoji status should be changed"
+ }
+ },
+ "channels.CheckSearchPostsFlood": {
+ "desc": "Check if the specified global post search \u00bb requires payment.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "query": "The query."
+ }
+ },
+ "channels.CheckUsername": {
+ "desc": "Check if a username is free and can be assigned to a channel/supergroup",
+ "params": {
+ "channel": "The channel/supergroup that will assigned the specified username",
+ "username": "The username to check"
+ }
+ },
+ "channels.ConvertToGigagroup": {
+ "desc": "Convert a supergroup to a gigagroup, when requested by channel suggestions.",
+ "params": {
+ "channel": "The supergroup to convert"
+ }
+ },
+ "channels.CreateChannel": {
+ "desc": "Create a supergroup/channel.",
+ "params": {
+ "about": "Channel description",
+ "address": "Geogroup address, see here \u00bb for more info on geogroups.",
+ "broadcast": "Whether to create a channel",
+ "flags": "Flags, see TL conditional fields",
+ "for_import": "Whether the supergroup is being created to import messages from a foreign chat service using messages.initHistoryImport",
+ "forum": "Whether to create a forum",
+ "geo_point": "Geogroup location, see here \u00bb for more info on geogroups.",
+ "megagroup": "Whether to create a supergroup",
+ "title": "Channel title",
+ "ttl_period": "Time-to-live of all messages that will be sent in the supergroup: once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. You can use messages.setDefaultHistoryTTL to edit this value later."
+ }
+ },
+ "channels.CreateForumTopic": {
+ "desc": "Create a forum topic; requires manage_topics rights.",
+ "params": {
+ "channel": "The forum",
+ "flags": "Flags, see TL conditional fields",
+ "icon_color": "If no custom emoji icon is specified, specifies the color of the fallback topic icon (RGB), one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F.",
+ "icon_emoji_id": "ID of the custom emoji used as topic icon. Telegram Premium users can use any custom emoji, other users can only use the custom emojis contained in the inputStickerSetEmojiDefaultTopicIcons emoji pack.",
+ "random_id": "Unique client message ID to prevent duplicate sending of the same event",
+ "send_as": "Create the topic as the specified peer",
+ "title": "Topic title (maximum UTF-8 length: 128)"
+ }
+ },
+ "channels.DeactivateAllUsernames": {
+ "desc": "Disable all purchased usernames of a supergroup or channel",
+ "params": {
+ "channel": "Supergroup or channel"
+ }
+ },
+ "channels.DeleteChannel": {
+ "desc": "Delete a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup to delete"
+ }
+ },
+ "channels.DeleteHistory": {
+ "desc": "Delete the history of a supergroup",
+ "params": {
+ "channel": "Supergroup whose history must be deleted",
+ "flags": "Flags, see TL conditional fields",
+ "for_everyone": "Whether the history should be deleted for everyone",
+ "max_id": "ID of message up to which the history must be deleted"
+ }
+ },
+ "channels.DeleteMessages": {
+ "desc": "Delete messages in a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup",
+ "id": "IDs of messages to delete"
+ }
+ },
+ "channels.DeleteParticipantHistory": {
+ "desc": "Delete all messages sent by a specific participant of a given supergroup",
+ "params": {
+ "channel": "Supergroup",
+ "participant": "The participant whose messages should be deleted"
+ }
+ },
+ "channels.DeleteTopicHistory": {
+ "desc": "Delete message history of a forum topic",
+ "params": {
+ "channel": "Forum",
+ "top_msg_id": "Topic ID"
+ }
+ },
+ "channels.EditAdmin": {
+ "desc": "Modify the admin rights of a user in a supergroup/channel.",
+ "params": {
+ "admin_rights": "The admin rights",
+ "channel": "The supergroup/channel.",
+ "rank": "Indicates the role (rank) of the admin in the group: just an arbitrary string",
+ "user_id": "The ID of the user whose admin rights should be modified"
+ }
+ },
+ "channels.EditBanned": {
+ "desc": "Ban/unban/kick a user in a supergroup/channel.",
+ "params": {
+ "banned_rights": "The banned rights",
+ "channel": "The supergroup/channel.",
+ "participant": "Participant to ban"
+ }
+ },
+ "channels.EditCreator": {
+ "desc": "Transfer channel ownership",
+ "params": {
+ "channel": "Channel",
+ "password": "2FA password of account",
+ "user_id": "New channel owner"
+ }
+ },
+ "channels.EditForumTopic": {
+ "desc": "Edit forum topic; requires manage_topics rights.",
+ "params": {
+ "channel": "Supergroup",
+ "closed": "If present, will update the open/closed status of the topic.",
+ "flags": "Flags, see TL conditional fields",
+ "hidden": "If present, will hide/unhide the topic (only valid for the \"General\" topic, id=1).",
+ "icon_emoji_id": "If present, updates the custom emoji used as topic icon. Telegram Premium users can use any custom emoji, other users can only use the custom emojis contained in the inputStickerSetEmojiDefaultTopicIcons emoji pack. Pass 0 to switch to the fallback topic icon.",
+ "title": "If present, will update the topic title (maximum UTF-8 length: 128).",
+ "topic_id": "Topic ID"
+ }
+ },
+ "channels.EditLocation": {
+ "desc": "Edit location of geogroup, see here \u00bb for more info on geogroups.",
+ "params": {
+ "address": "Address string",
+ "channel": "Geogroup",
+ "geo_point": "New geolocation"
+ }
+ },
+ "channels.EditPhoto": {
+ "desc": "Change the photo of a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup whose photo should be edited",
+ "photo": "New photo"
+ }
+ },
+ "channels.EditTitle": {
+ "desc": "Edit the name of a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup",
+ "title": "New name"
+ }
+ },
+ "channels.ExportMessageLink": {
+ "desc": "Get link and embed info of a message in a channel/supergroup",
+ "params": {
+ "channel": "Channel",
+ "flags": "Flags, see TL conditional fields",
+ "grouped": "Whether to include other grouped media (for albums)",
+ "id": "Message ID",
+ "thread": "Whether to also include a thread ID, if available, inside of the link"
+ }
+ },
+ "channels.GetAdminLog": {
+ "desc": "Get the admin log of a channel/supergroup",
+ "params": {
+ "admins": "Only show events from these admins",
+ "channel": "Channel",
+ "events_filter": "Event filter",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "max_id": "Maximum ID of message to return (see pagination)",
+ "min_id": "Minimum ID of message to return (see pagination)",
+ "q": "Search query, can be empty"
+ }
+ },
+ "channels.GetAdminedPublicChannels": {
+ "desc": "Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups.",
+ "params": {
+ "by_location": "Get geogroups",
+ "check_limit": "If set and the user has reached the limit of owned public channels/supergroups/geogroups, instead of returning the channel list one of the specified errors will be returned.Useful to check if a new public channel can indeed be created, even before asking the user to enter a channel username to use in channels.checkUsername/channels.updateUsername.",
+ "flags": "Flags, see TL conditional fields",
+ "for_personal": "Set this flag to only fetch the full list of channels that may be passed to account.updatePersonalChannel to display them on our profile page."
+ }
+ },
+ "channels.GetChannelRecommendations": {
+ "desc": "Obtain a list of similarly themed public channels, selected based on similarities in their subscriber bases.",
+ "params": {
+ "channel": "The method will return channels related to the passed channel. If not set, the method will returns channels related to channels the user has joined.",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "channels.GetChannels": {
+ "desc": "Get info about channels/supergroups",
+ "params": {
+ "id": "IDs of channels/supergroups to get info about"
+ }
+ },
+ "channels.GetForumTopics": {
+ "desc": "Get topics of a forum",
+ "params": {
+ "channel": "Supergroup",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination. For optimal performance, the number of returned topics is chosen by the server and can be smaller than the specified limit.",
+ "offset_date": "Offsets for pagination, for more info click here, date of the last message of the last found topic. Use 0 or any date in the future to get results from the last topic.",
+ "offset_id": "Offsets for pagination, for more info click here, ID of the last message of the last found topic (or initially 0).",
+ "offset_topic": "Offsets for pagination, for more info click here, ID of the last found topic (or initially 0).",
+ "q": "Search query"
+ }
+ },
+ "channels.GetForumTopicsByID": {
+ "desc": "Get forum topics by their ID",
+ "params": {
+ "channel": "Forum",
+ "topics": "Topic IDs"
+ }
+ },
+ "channels.GetFullChannel": {
+ "desc": "Get full info about a supergroup, gigagroup or channel",
+ "params": {
+ "channel": "The channel, supergroup or gigagroup to get info about"
+ }
+ },
+ "channels.GetGroupsForDiscussion": {
+ "desc": "Get all groups that can be used as discussion groups.",
+ "params": {}
+ },
+ "channels.GetInactiveChannels": {
+ "desc": "Get inactive channels and supergroups",
+ "params": {}
+ },
+ "channels.GetLeftChannels": {
+ "desc": "Get a list of channels/supergroups we left, requires a takeout session, see here \u00bb for more info.",
+ "params": {
+ "offset": "Offset for pagination"
+ }
+ },
+ "channels.GetMessageAuthor": {
+ "desc": "Can only be invoked by non-bot admins of a monoforum \u00bb, obtains the original sender of a message sent by other monoforum admins to the monoforum, on behalf of the channel associated to the monoforum.",
+ "params": {
+ "channel": "ID of the monoforum.",
+ "id": "ID of the message sent by a monoforum admin."
+ }
+ },
+ "channels.GetMessages": {
+ "desc": "Get channel/supergroup messages",
+ "params": {
+ "channel": "Channel/supergroup",
+ "id": "IDs of messages to get"
+ }
+ },
+ "channels.GetParticipant": {
+ "desc": "Get info about a channel/supergroup participant",
+ "params": {
+ "channel": "Channel/supergroup",
+ "participant": "Participant to get info about"
+ }
+ },
+ "channels.GetParticipants": {
+ "desc": "Get the participants of a supergroup/channel",
+ "params": {
+ "channel": "Channel",
+ "filter": "Which participant types to fetch",
+ "hash": "Hash",
+ "limit": "Limit",
+ "offset": "Offset"
+ }
+ },
+ "channels.GetSendAs": {
+ "desc": "Obtains a list of peers that can be used to send messages in a specific group",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "for_paid_reactions": "If set, fetches the list of peers that can be used to send paid reactions to messages of a specific peer.",
+ "peer": "The group where we intend to send messages"
+ }
+ },
+ "channels.InviteToChannel": {
+ "desc": "Invite users to a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup",
+ "users": "Users to invite"
+ }
+ },
+ "channels.JoinChannel": {
+ "desc": "Join a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup to join"
+ }
+ },
+ "channels.LeaveChannel": {
+ "desc": "Leave a channel/supergroup",
+ "params": {
+ "channel": "Channel/supergroup to leave"
+ }
+ },
+ "channels.ReadHistory": {
+ "desc": "Mark channel/supergroup history as read",
+ "params": {
+ "channel": "Channel/supergroup",
+ "max_id": "ID of message up to which messages should be marked as read"
+ }
+ },
+ "channels.ReadMessageContents": {
+ "desc": "Mark channel/supergroup message contents as read, emitting an updateChannelReadMessagesContents.",
+ "params": {
+ "channel": "Channel/supergroup",
+ "id": "IDs of messages whose contents should be marked as read"
+ }
+ },
+ "channels.ReorderPinnedForumTopics": {
+ "desc": "Reorder pinned forum topics",
+ "params": {
+ "channel": "Supergroup ID",
+ "flags": "Flags, see TL conditional fields",
+ "force": "If not set, the order of only the topics present both server-side and in order will be changed (i.e. mentioning topics not pinned server-side in order will not pin them, and not mentioning topics pinned server-side will not unpin them). If set, the entire server-side pinned topic list will be replaced with order (i.e. mentioning topics not pinned server-side in order will pin them, and not mentioning topics pinned server-side will unpin them)",
+ "order": "Topic IDs \u00bb"
+ }
+ },
+ "channels.ReorderUsernames": {
+ "desc": "Reorder active usernames",
+ "params": {
+ "channel": "The supergroup or channel",
+ "order": "The new order for active usernames. All active usernames must be specified."
+ }
+ },
+ "channels.ReportAntiSpamFalsePositive": {
+ "desc": "Report a native antispam false positive",
+ "params": {
+ "channel": "Supergroup ID",
+ "msg_id": "Message ID that was mistakenly deleted by the native antispam system, taken from the admin log"
+ }
+ },
+ "channels.ReportSpam": {
+ "desc": "Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup",
+ "params": {
+ "channel": "Supergroup",
+ "id": "IDs of spam messages",
+ "participant": "Participant whose messages should be reported"
+ }
+ },
+ "channels.RestrictSponsoredMessages": {
+ "desc": "Disable ads on the specified channel, for all users.",
+ "params": {
+ "channel": "The channel.",
+ "restricted": "Whether to disable or re-enable ads."
+ }
+ },
+ "channels.SearchPosts": {
+ "desc": "Globally search for posts from public channels \u00bb (including those we aren't a member of) containing either a specific hashtag, or a full text query.",
+ "params": {
+ "allow_paid_stars": "For full text post searches (query), allows payment of the specified amount of Stars for the search, see here \u00bb for more info on the full flow.",
+ "flags": "Flags, see TL conditional fields",
+ "hashtag": "The hashtag to search, without the # character.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "offset_peer": "Offsets for pagination, for more info click here",
+ "offset_rate": "Initially 0, then set to the next_rate parameter of messages.messagesSlice, or if that is absent, the date of the last returned message.",
+ "query": "The full text query: each user has a limited amount of free full text search slots, after which payment is required, see here \u00bb for more info on the full flow."
+ }
+ },
+ "channels.SetBoostsToUnblockRestrictions": {
+ "desc": "Admins with ban_users admin rights \u00bb may allow users that apply a certain number of booosts \u00bb to the group to bypass slow mode \u00bb and other \u00bb supergroup restrictions, see here \u00bb for more info.",
+ "params": {
+ "boosts": "The number of required boosts (1-8, 0 to disable).",
+ "channel": "The supergroup."
+ }
+ },
+ "channels.SetDiscussionGroup": {
+ "desc": "Associate a group to a channel as discussion group for that channel",
+ "params": {
+ "broadcast": "Channel",
+ "group": "Discussion group to associate to the channel"
+ }
+ },
+ "channels.SetEmojiStickers": {
+ "desc": "Set a custom emoji stickerset for supergroups. Only usable after reaching at least the boost level \u00bb specified in the group_emoji_stickers_level_min \u00bb config parameter.",
+ "params": {
+ "channel": "The supergroup",
+ "stickerset": "The custom emoji stickerset to associate to the supergroup"
+ }
+ },
+ "channels.SetMainProfileTab": {
+ "desc": "Changes the main profile tab of a channel, see here \u00bb for more info.",
+ "params": {
+ "channel": "The channel.",
+ "tab": "The tab to set as main tab."
+ }
+ },
+ "channels.SetStickers": {
+ "desc": "Associate a stickerset to the supergroup",
+ "params": {
+ "channel": "Supergroup",
+ "stickerset": "The stickerset to associate"
+ }
+ },
+ "channels.ToggleAntiSpam": {
+ "desc": "Enable or disable the native antispam system.",
+ "params": {
+ "channel": "Supergroup ID. The specified supergroup must have at least telegram_antispam_group_size_min members to enable antispam functionality, as specified by the client configuration parameters.",
+ "enabled": "Enable or disable the native antispam system."
+ }
+ },
+ "channels.ToggleAutotranslation": {
+ "desc": "Toggle autotranslation in a channel, for all users: see here \u00bb for more info.",
+ "params": {
+ "channel": "The channel where to toggle autotranslation.",
+ "enabled": "Whether to enable or disable autotranslation."
+ }
+ },
+ "channels.ToggleForum": {
+ "desc": "Enable or disable forum functionality in a supergroup.",
+ "params": {
+ "channel": "Supergroup ID",
+ "enabled": "Enable or disable forum functionality",
+ "tabs": "If true enables the tabbed forum UI, otherwise enables the list-based forum UI."
+ }
+ },
+ "channels.ToggleJoinRequest": {
+ "desc": "Set whether all users should request admin approval to join the group \u00bb.",
+ "params": {
+ "channel": "Group",
+ "enabled": "Toggle"
+ }
+ },
+ "channels.ToggleJoinToSend": {
+ "desc": "Set whether all users should join a discussion group in order to comment on a post \u00bb",
+ "params": {
+ "channel": "Discussion group",
+ "enabled": "Toggle"
+ }
+ },
+ "channels.ToggleParticipantsHidden": {
+ "desc": "Hide or display the participants list in a supergroup.",
+ "params": {
+ "channel": "Supergroup ID",
+ "enabled": "If true, will hide the participants list; otherwise will unhide it."
+ }
+ },
+ "channels.TogglePreHistoryHidden": {
+ "desc": "Hide/unhide message history for new channel/supergroup users",
+ "params": {
+ "channel": "Channel/supergroup",
+ "enabled": "Hide/unhide"
+ }
+ },
+ "channels.ToggleSignatures": {
+ "desc": "Enable/disable message signatures in channels",
+ "params": {
+ "channel": "Channel",
+ "flags": "Flags, see TL conditional fields",
+ "profiles_enabled": "If set, messages from channel admins will link to their profiles, just like for group messages: can only be set if the signatures_enabled flag is set.",
+ "signatures_enabled": "If set, enables message signatures."
+ }
+ },
+ "channels.ToggleSlowMode": {
+ "desc": "Toggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds",
+ "params": {
+ "channel": "The supergroup",
+ "seconds": "Users will only be able to send one message every seconds seconds, 0 to disable the limitation"
+ }
+ },
+ "channels.ToggleUsername": {
+ "desc": "Activate or deactivate a purchased fragment.com username associated to a supergroup or channel we own.",
+ "params": {
+ "active": "Whether to activate or deactivate the username",
+ "channel": "Supergroup or channel",
+ "username": "Username"
+ }
+ },
+ "channels.ToggleViewForumAsMessages": {
+ "desc": "Users may also choose to display messages from all topics of a forum as if they were sent to a normal group, using a \"View as messages\" setting in the local client: this setting only affects the current account, and is synced to other logged in sessions using this method.",
+ "params": {
+ "channel": "The forum",
+ "enabled": "The new value of the view_forum_as_messages flag."
+ }
+ },
+ "channels.UpdateColor": {
+ "desc": "Update the accent color and background custom emoji \u00bb of a channel.",
+ "params": {
+ "background_emoji_id": "Custom emoji ID used in the accent color pattern.",
+ "channel": "Channel whose accent color should be changed.",
+ "color": "ID of the accent color palette \u00bb to use (not RGB24, see here \u00bb for more info); if not set, the default palette is used.",
+ "flags": "Flags, see TL conditional fields",
+ "for_profile": "Whether to change the accent color emoji pattern of the profile page; otherwise, the accent color and emoji pattern of messages will be changed. Channels can change both message and profile palettes; supergroups can only change the profile palette, of course after reaching the appropriate boost level."
+ }
+ },
+ "channels.UpdateEmojiStatus": {
+ "desc": "Set an emoji status for a channel or supergroup.",
+ "params": {
+ "channel": "The channel/supergroup, must have at least channel_emoji_status_level_min/group_emoji_status_level_min boosts.",
+ "emoji_status": "Emoji status to set"
+ }
+ },
+ "channels.UpdatePaidMessagesPrice": {
+ "desc": "Enable or disable paid messages \u00bb in this supergroup or monoforum.",
+ "params": {
+ "broadcast_messages_allowed": "Only usable for channels, enables or disables the associated monoforum aka direct messages.",
+ "channel": "Pass the supergroup ID for supergroups and the ID of the channel to modify the setting in the associated monoforum.",
+ "flags": "Flags, see TL conditional fields",
+ "send_paid_messages_stars": "Specifies the required amount of Telegram Stars users must pay to send messages to the supergroup or monoforum."
+ }
+ },
+ "channels.UpdatePinnedForumTopic": {
+ "desc": "Pin or unpin forum topics",
+ "params": {
+ "channel": "Supergroup ID",
+ "pinned": "Whether to pin or unpin the topic",
+ "topic_id": "Forum topic ID"
+ }
+ },
+ "channels.UpdateUsername": {
+ "desc": "Change or remove the username of a supergroup/channel",
+ "params": {
+ "channel": "Channel",
+ "username": "New username, pass an empty string to remove the username"
+ }
+ },
+ "chatlists.CheckChatlistInvite": {
+ "desc": "Obtain information about a chat folder deep link \u00bb.",
+ "params": {
+ "slug": "slug obtained from the chat folder deep link \u00bb"
+ }
+ },
+ "chatlists.DeleteExportedInvite": {
+ "desc": "Delete a previously created chat folder deep link \u00bb.",
+ "params": {
+ "chatlist": "The related folder",
+ "slug": "slug obtained from the chat folder deep link \u00bb."
+ }
+ },
+ "chatlists.EditExportedInvite": {
+ "desc": "Edit a chat folder deep link \u00bb.",
+ "params": {
+ "chatlist": "Folder ID",
+ "flags": "Flags, see TL conditional fields",
+ "peers": "If set, changes the list of peers shared with the link",
+ "slug": "slug obtained from the chat folder deep link \u00bb.",
+ "title": "If set, sets a new name for the link"
+ }
+ },
+ "chatlists.ExportChatlistInvite": {
+ "desc": "Export a folder \u00bb, creating a chat folder deep link \u00bb.",
+ "params": {
+ "chatlist": "The folder to export",
+ "peers": "The list of channels, group and supergroups to share with the link. Basic groups will automatically be converted to supergroups when invoking the method.",
+ "title": "An optional name for the link"
+ }
+ },
+ "chatlists.GetChatlistUpdates": {
+ "desc": "Fetch new chats associated with an imported chat folder deep link \u00bb. Must be invoked at most every chatlist_update_period seconds (as per the related client configuration parameter \u00bb).",
+ "params": {
+ "chatlist": "The folder"
+ }
+ },
+ "chatlists.GetExportedInvites": {
+ "desc": "List all chat folder deep links \u00bb associated to a folder",
+ "params": {
+ "chatlist": "The folder"
+ }
+ },
+ "chatlists.GetLeaveChatlistSuggestions": {
+ "desc": "Returns identifiers of pinned or always included chats from a chat folder imported using a chat folder deep link \u00bb, which are suggested to be left when the chat folder is deleted.",
+ "params": {
+ "chatlist": "Folder ID"
+ }
+ },
+ "chatlists.HideChatlistUpdates": {
+ "desc": "Dismiss new pending peers recently added to a chat folder deep link \u00bb.",
+ "params": {
+ "chatlist": "The folder"
+ }
+ },
+ "chatlists.JoinChatlistInvite": {
+ "desc": "Import a chat folder deep link \u00bb, joining some or all the chats in the folder.",
+ "params": {
+ "peers": "List of new chats to join, fetched using chatlists.checkChatlistInvite and filtered as specified in the documentation \u00bb.",
+ "slug": "slug obtained from a chat folder deep link \u00bb."
+ }
+ },
+ "chatlists.JoinChatlistUpdates": {
+ "desc": "Join channels and supergroups recently added to a chat folder deep link \u00bb.",
+ "params": {
+ "chatlist": "The folder",
+ "peers": "List of new chats to join, fetched using chatlists.getChatlistUpdates and filtered as specified in the documentation \u00bb."
+ }
+ },
+ "chatlists.LeaveChatlist": {
+ "desc": "Delete a folder imported using a chat folder deep link \u00bb",
+ "params": {
+ "chatlist": "Folder ID",
+ "peers": "Also leave the specified channels and groups"
+ }
+ },
+ "contacts.AcceptContact": {
+ "desc": "If the add contact action bar is active, add that user as contact",
+ "params": {
+ "id": "The user to add as contact"
+ }
+ },
+ "contacts.AddContact": {
+ "desc": "Add an existing telegram user as contact.",
+ "params": {
+ "add_phone_privacy_exception": "Allow the other user to see our phone number?",
+ "first_name": "First name",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Telegram ID of the other user",
+ "last_name": "Last name",
+ "phone": "User's phone number, may be omitted to simply add the user to the contact list, without a phone number."
+ }
+ },
+ "contacts.Block": {
+ "desc": "Adds a peer to a blocklist, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Peer",
+ "my_stories_from": "Whether the peer should be added to the story blocklist; if not set, the peer will be added to the main blocklist, see here \u00bb for more info."
+ }
+ },
+ "contacts.BlockFromReplies": {
+ "desc": "Stop getting notifications about discussion replies of a certain user in @replies",
+ "params": {
+ "delete_history": "Whether to delete all @replies messages from this user as well",
+ "delete_message": "Whether to delete the specified message as well",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "ID of the message in the @replies chat",
+ "report_spam": "Whether to also report this user for spam"
+ }
+ },
+ "contacts.DeleteByPhones": {
+ "desc": "Delete contacts by phone number",
+ "params": {
+ "phones": "Phone numbers"
+ }
+ },
+ "contacts.DeleteContacts": {
+ "desc": "Deletes several contacts from the list.",
+ "params": {
+ "id": "User ID list"
+ }
+ },
+ "contacts.EditCloseFriends": {
+ "desc": "Edit the close friends list, see here \u00bb for more info.",
+ "params": {
+ "id": "Full list of user IDs of close friends, see here for more info."
+ }
+ },
+ "contacts.ExportContactToken": {
+ "desc": "Generates a temporary profile link for the currently logged-in user.",
+ "params": {}
+ },
+ "contacts.GetBirthdays": {
+ "desc": "Fetch all users with birthdays that fall within +1/-1 days, relative to the current day: this method should be invoked by clients every 6-8 hours, and if the result is non-empty, it should be used to appropriately update locally cached birthday information in user.birthday.",
+ "params": {}
+ },
+ "contacts.GetBlocked": {
+ "desc": "Returns the list of blocked users.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "limit": "The number of list elements to be returned",
+ "my_stories_from": "Whether to fetch the story blocklist; if not set, will fetch the main blocklist. See here \u00bb for differences between the two.",
+ "offset": "The number of list elements to be skipped"
+ }
+ },
+ "contacts.GetContactIDs": {
+ "desc": "Get the telegram IDs of all contacts.\nReturns an array of Telegram user IDs for all contacts (0 if a contact does not have an associated Telegram account or have hidden their account using privacy settings).",
+ "params": {
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "contacts.GetContacts": {
+ "desc": "Returns the current user's contact list.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.Note that the hash is computed using the usual algorithm, passing to the algorithm first the previously returned contacts.contacts.saved_count field, then max 100000 sorted user IDs from the contact list, including the ID of the currently logged in user if it is saved as a contact. Example: tdlib implementation."
+ }
+ },
+ "contacts.GetLocated": {
+ "desc": "Get users and geochats near you, see here \u00bb for more info.",
+ "params": {
+ "background": "While the geolocation of the current user is public, clients should update it in the background every half-an-hour or so, while setting this flag. Do this only if the new location is more than 1 KM away from the previous one, or if the previous location is unknown.",
+ "flags": "Flags, see TL conditional fields",
+ "geo_point": "Geolocation",
+ "self_expires": "If set, the geolocation of the current user will be public for the specified number of seconds; pass 0x7fffffff to disable expiry, 0 to make the current geolocation private; if the flag isn't set, no changes will be applied."
+ }
+ },
+ "contacts.GetSaved": {
+ "desc": "Get all contacts, requires a takeout session, see here \u00bb for more info.",
+ "params": {}
+ },
+ "contacts.GetSponsoredPeers": {
+ "desc": "Obtain a list of sponsored peer search results for a given query",
+ "params": {
+ "q": "The query"
+ }
+ },
+ "contacts.GetStatuses": {
+ "desc": "Use this method to obtain the online statuses of all contacts with an accessible Telegram account.",
+ "params": {}
+ },
+ "contacts.GetTopPeers": {
+ "desc": "Get most used peers",
+ "params": {
+ "bots_app": "Most frequently used Main Mini Bot Apps.",
+ "bots_inline": "Most used inline bots",
+ "bots_pm": "Most used bots",
+ "channels": "Most frequently visited channels",
+ "correspondents": "Users we've chatted most frequently with",
+ "flags": "Flags, see TL conditional fields",
+ "forward_chats": "Chats to which the users often forwards messages to",
+ "forward_users": "Users to which the users often forwards messages to",
+ "groups": "Often-opened groups and supergroups",
+ "hash": "Hash used for caching, for more info click here",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination",
+ "phone_calls": "Most frequently called users"
+ }
+ },
+ "contacts.ImportCard": {
+ "desc": "Returns general information on a user using his previously exported card as input.The app may use it to open a conversation without knowing the user's phone number.",
+ "params": {}
+ },
+ "contacts.ImportContactToken": {
+ "desc": "Obtain user info from a temporary profile link.",
+ "params": {
+ "token": "The token extracted from the temporary profile link."
+ }
+ },
+ "contacts.ImportContacts": {
+ "desc": "Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info.",
+ "params": {
+ "contacts": "List of contacts to import"
+ }
+ },
+ "contacts.ResetSaved": {
+ "desc": "Removes all contacts without an associated Telegram account.",
+ "params": {}
+ },
+ "contacts.ResetTopPeerRating": {
+ "desc": "Reset rating of top peer",
+ "params": {
+ "category": "Top peer category",
+ "peer": "Peer whose rating should be reset"
+ }
+ },
+ "contacts.ResolvePhone": {
+ "desc": "Resolve a phone number to get user info, if their privacy settings allow it.",
+ "params": {
+ "phone": "Phone number in international format, possibly obtained from a phone number deep link."
+ }
+ },
+ "contacts.ResolveUsername": {
+ "desc": "Resolve a @username to get peer info",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "referer": "Referrer ID from referral links \u00bb.",
+ "username": "@username to resolve"
+ }
+ },
+ "contacts.Search": {
+ "desc": "Returns users found by username substring.",
+ "params": {
+ "limit": "Maximum number of users to be returned",
+ "q": "Target substring"
+ }
+ },
+ "contacts.SetBlocked": {
+ "desc": "Replace the contents of an entire blocklist, see here for more info \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Full content of the blocklist.",
+ "limit": "Maximum number of results to return, see pagination",
+ "my_stories_from": "Whether to edit the story blocklist; if not set, will edit the main blocklist. See here \u00bb for differences between the two."
+ }
+ },
+ "contacts.ToggleTopPeers": {
+ "desc": "Enable/disable top peers",
+ "params": {
+ "enabled": "Enable/disable"
+ }
+ },
+ "contacts.Unblock": {
+ "desc": "Deletes a peer from a blocklist, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Peer",
+ "my_stories_from": "Whether the peer should be removed from the story blocklist; if not set, the peer will be removed from the main blocklist, see here \u00bb for more info."
+ }
+ },
+ "folders.DeleteFolder": {
+ "desc": "Delete a peer folder",
+ "params": {
+ "folder_id": "Peer folder ID, for more info click here"
+ }
+ },
+ "folders.EditPeerFolders": {
+ "desc": "Edit peers in peer folder",
+ "params": {
+ "folder_peers": "New peer list"
+ }
+ },
+ "fragment.GetCollectibleInfo": {
+ "desc": "Fetch information about a fragment collectible, see here \u00bb for more info on the full flow.",
+ "params": {
+ "collectible": "Collectible to fetch info about."
+ }
+ },
+ "help.AcceptTermsOfService": {
+ "desc": "Accept the new terms of service",
+ "params": {
+ "id": "ID of terms of service"
+ }
+ },
+ "help.DismissSuggestion": {
+ "desc": "Dismiss a suggestion, see here for more info \u00bb.",
+ "params": {
+ "peer": "In the case of pending suggestions in channels, the channel ID.",
+ "suggestion": "Suggestion, see here for more info \u00bb."
+ }
+ },
+ "help.EditUserInfo": {
+ "desc": "Internal use",
+ "params": {
+ "entities": "Message entities for styled text",
+ "message": "Message",
+ "user_id": "User"
+ }
+ },
+ "help.GetAppConfig": {
+ "desc": "Get app-specific configuration, see client configuration for more info on the result.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "help.GetAppUpdate": {
+ "desc": "Returns information on update availability for the current application.",
+ "params": {
+ "source": "Source"
+ }
+ },
+ "help.GetCdnConfig": {
+ "desc": "Get configuration for CDN file downloads.",
+ "params": {}
+ },
+ "help.GetConfig": {
+ "desc": "Returns current configuration, including data center configuration.",
+ "params": {}
+ },
+ "help.GetCountriesList": {
+ "desc": "Get name, ISO code, localized name and phone codes/patterns of all available countries",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.",
+ "lang_code": "Language code of the current user"
+ }
+ },
+ "help.GetDeepLinkInfo": {
+ "desc": "Get info about an unsupported deep link, see here for more info \u00bb.",
+ "params": {
+ "path": "Path component of a tg: link"
+ }
+ },
+ "help.GetInviteText": {
+ "desc": "Returns localized text of a text message with an invitation.",
+ "params": {}
+ },
+ "help.GetNearestDc": {
+ "desc": "Returns info on data center nearest to the user.",
+ "params": {}
+ },
+ "help.GetPassportConfig": {
+ "desc": "Get passport configuration",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "help.GetPeerColors": {
+ "desc": "Get the set of accent color palettes \u00bb that can be used for message accents.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "help.GetPeerProfileColors": {
+ "desc": "Get the set of accent color palettes \u00bb that can be used in profile page backgrounds.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "help.GetPremiumPromo": {
+ "desc": "Get Telegram Premium promotion information",
+ "params": {}
+ },
+ "help.GetPromoData": {
+ "desc": "Returns a set of useful suggestions and PSA/MTProxy sponsored peers, see here \u00bb for more info.",
+ "params": {}
+ },
+ "help.GetRecentMeUrls": {
+ "desc": "Get recently used t.me links.",
+ "params": {
+ "referer": "Referrer"
+ }
+ },
+ "help.GetSupport": {
+ "desc": "Returns the support user for the \"ask a question\" feature.",
+ "params": {}
+ },
+ "help.GetSupportName": {
+ "desc": "Get localized name of the telegram support user",
+ "params": {}
+ },
+ "help.GetTermsOfServiceUpdate": {
+ "desc": "Look for updates of telegram's terms of service",
+ "params": {}
+ },
+ "help.GetTimezonesList": {
+ "desc": "Returns timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours \u00bb.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "help.GetUserInfo": {
+ "desc": "Can only be used by TSF members to obtain internal information.",
+ "params": {
+ "user_id": "User ID"
+ }
+ },
+ "help.HidePromoData": {
+ "desc": "Hide MTProxy/Public Service Announcement information",
+ "params": {
+ "peer": "Peer to hide"
+ }
+ },
+ "help.SaveAppLog": {
+ "desc": "Saves logs of application on the server.",
+ "params": {
+ "events": "List of input events"
+ }
+ },
+ "help.SetBotUpdatesStatus": {
+ "desc": "Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only",
+ "params": {
+ "message": "Error message, if present",
+ "pending_updates_count": "Number of pending updates"
+ }
+ },
+ "langpack.GetDifference": {
+ "desc": "Get new strings in language pack",
+ "params": {
+ "from_version": "Previous localization pack version",
+ "lang_code": "Either an ISO 639-1 language code or a language pack name obtained from a language pack link.",
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc)."
+ }
+ },
+ "langpack.GetLangPack": {
+ "desc": "Get localization pack strings",
+ "params": {
+ "lang_code": "Either an ISO 639-1 language code or a language pack name obtained from a language pack link.",
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc)."
+ }
+ },
+ "langpack.GetLanguage": {
+ "desc": "Get information about a language in a localization pack",
+ "params": {
+ "lang_code": "Either an ISO 639-1 language code or a language pack name obtained from a language pack link.",
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc)."
+ }
+ },
+ "langpack.GetLanguages": {
+ "desc": "Get information about all languages in a localization pack",
+ "params": {
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc)."
+ }
+ },
+ "langpack.GetStrings": {
+ "desc": "Get strings from a language pack",
+ "params": {
+ "keys": "Strings to get",
+ "lang_code": "Either an ISO 639-1 language code or a language pack name obtained from a language pack link.",
+ "lang_pack": "Platform identifier (i.e. android, tdesktop, etc)."
+ }
+ },
+ "messages.AcceptEncryption": {
+ "desc": "Confirms creation of a secret chat",
+ "params": {
+ "g_b": "B = g ^ b mod p, see Wikipedia",
+ "key_fingerprint": "64-bit fingerprint of the received key",
+ "peer": "Secret chat ID"
+ }
+ },
+ "messages.AcceptUrlAuth": {
+ "desc": "Use this to accept a Seamless Telegram Login authorization request, for more info click here \u00bb",
+ "params": {
+ "button_id": "ID of the login button",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Message ID of the message with the login button",
+ "peer": "The location of the message",
+ "url": "URL used for link URL authorization, click here for more info \u00bb",
+ "write_allowed": "Set this flag to allow the bot to send messages to you (if requested)"
+ }
+ },
+ "messages.AddChatUser": {
+ "desc": "Adds a user to a chat and sends a service message on it.",
+ "params": {
+ "chat_id": "Chat ID",
+ "fwd_limit": "Number of last messages to be forwarded",
+ "user_id": "User ID to be added"
+ }
+ },
+ "messages.AppendTodoList": {
+ "desc": "Appends one or more items to a todo list \u00bb.",
+ "params": {
+ "list": "Items to append.",
+ "msg_id": "ID of the message with the todo list.",
+ "peer": "Peer where the todo list was posted."
+ }
+ },
+ "messages.CheckChatInvite": {
+ "desc": "Check the validity of a chat invite link and get basic info about it",
+ "params": {
+ "hash": "Invite hash from chat invite deep link \u00bb."
+ }
+ },
+ "messages.CheckHistoryImport": {
+ "desc": "Obtains information about a chat export file, generated by a foreign chat app, click here for more info about imported chats \u00bb.",
+ "params": {
+ "import_head": "Beginning of the message file; up to 100 lines."
+ }
+ },
+ "messages.CheckHistoryImportPeer": {
+ "desc": "Check whether chat history exported from another chat app can be imported into a specific Telegram chat, click here for more info \u00bb.",
+ "params": {
+ "peer": "The chat where we want to import history \u00bb."
+ }
+ },
+ "messages.CheckPaidAuth": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.CheckQuickReplyShortcut": {
+ "desc": "Before offering the user the choice to add a message to a quick reply shortcut, to make sure that none of the limits specified here \u00bb were reached.",
+ "params": {
+ "shortcut": "Shorcut name (not ID!)."
+ }
+ },
+ "messages.ClearAllDrafts": {
+ "desc": "Clear all drafts.",
+ "params": {}
+ },
+ "messages.ClearRecentReactions": {
+ "desc": "Clear recently used message reactions",
+ "params": {}
+ },
+ "messages.ClearRecentStickers": {
+ "desc": "Clear recent stickers",
+ "params": {
+ "attached": "Set this flag to clear the list of stickers recently attached to photo or video files",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "messages.ClickSponsoredMessage": {
+ "desc": "Informs the server that the user has interacted with a sponsored message in one of the ways listed here \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "fullscreen": "The user expanded the video to full screen, and then clicked on it.",
+ "media": "The user clicked on the media",
+ "random_id": "The ad's unique ID."
+ }
+ },
+ "messages.CreateChat": {
+ "desc": "Creates a new chat.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "title": "Chat name",
+ "ttl_period": "Time-to-live of all messages that will be sent in the chat: once message.date+message.ttl_period === time(), the message will be deleted on the server, and must be deleted locally as well. You can use messages.setDefaultHistoryTTL to edit this value later.",
+ "users": "List of user IDs to be invited"
+ }
+ },
+ "messages.CreateForumTopic": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.DeleteChat": {
+ "desc": "Delete a chat",
+ "params": {
+ "chat_id": "Chat ID"
+ }
+ },
+ "messages.DeleteChatUser": {
+ "desc": "Deletes a user from a chat and sends a service message on it.",
+ "params": {
+ "chat_id": "Chat ID",
+ "flags": "Flags, see TL conditional fields",
+ "revoke_history": "Remove the entire chat history of the specified user in this chat.",
+ "user_id": "User ID to be deleted"
+ }
+ },
+ "messages.DeleteExportedChatInvite": {
+ "desc": "Delete a chat invite",
+ "params": {
+ "link": "Invite link",
+ "peer": "Peer"
+ }
+ },
+ "messages.DeleteFactCheck": {
+ "desc": "Delete a fact-check from a message.",
+ "params": {
+ "msg_id": "Message ID",
+ "peer": "Peer where the message was sent."
+ }
+ },
+ "messages.DeleteHistory": {
+ "desc": "Deletes communication history.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "just_clear": "Just clear history for the current user, without actually removing messages for every chat user",
+ "max_date": "Delete all messages older than this UNIX timestamp",
+ "max_id": "Maximum ID of message to delete",
+ "min_date": "Delete all messages newer than this UNIX timestamp",
+ "peer": "User or chat, communication history of which will be deleted",
+ "revoke": "Whether to delete the message history for all chat participants"
+ }
+ },
+ "messages.DeleteMessages": {
+ "desc": "Deletes messages by their identifiers.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Message ID list",
+ "revoke": "Whether to delete messages for all participants of the chat"
+ }
+ },
+ "messages.DeletePhoneCallHistory": {
+ "desc": "Delete the entire phone call history.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "revoke": "Whether to remove phone call history for participants as well"
+ }
+ },
+ "messages.DeleteQuickReplyMessages": {
+ "desc": "Delete one or more messages from a quick reply shortcut. This will also emit an updateDeleteQuickReplyMessages update.",
+ "params": {
+ "id": "IDs of shortcut messages to delete.",
+ "shortcut_id": "Shortcut ID."
+ }
+ },
+ "messages.DeleteQuickReplyShortcut": {
+ "desc": "Completely delete a quick reply shortcut.\nThis will also emit an updateDeleteQuickReply update to other logged-in sessions (and no updateDeleteQuickReplyMessages updates, even if all the messages in the shortcuts are also deleted by this method).",
+ "params": {
+ "shortcut_id": "Shortcut ID"
+ }
+ },
+ "messages.DeleteRevokedExportedChatInvites": {
+ "desc": "Delete all revoked chat invites",
+ "params": {
+ "admin_id": "ID of the admin that originally generated the revoked chat invites",
+ "peer": "Chat"
+ }
+ },
+ "messages.DeleteSavedHistory": {
+ "desc": "Deletes messages from a monoforum topic \u00bb, or deletes messages forwarded from a specific peer to saved messages \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "max_date": "Delete all messages older than this UNIX timestamp",
+ "max_id": "Maximum ID of message to delete",
+ "min_date": "Delete all messages newer than this UNIX timestamp",
+ "parent_peer": "If set, affects the messages of the passed monoforum topic \u00bb, otherwise affects saved messages \u00bb.",
+ "peer": "Peer, whose messages will be deleted from saved messages \u00bb, or the ID of the topic."
+ }
+ },
+ "messages.DeleteScheduledMessages": {
+ "desc": "Delete scheduled messages",
+ "params": {
+ "id": "Scheduled message IDs",
+ "peer": "Peer"
+ }
+ },
+ "messages.DeleteTopicHistory": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.DiscardEncryption": {
+ "desc": "Cancels a request for creation and/or delete info on secret chat.",
+ "params": {
+ "chat_id": "Secret chat ID",
+ "delete_history": "Whether to delete the entire chat history for the other user as well",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "messages.EditChatAbout": {
+ "desc": "Edit the description of a group/supergroup/channel.",
+ "params": {
+ "about": "The new description",
+ "peer": "The group/supergroup/channel."
+ }
+ },
+ "messages.EditChatAdmin": {
+ "desc": "Make a user admin in a basic group.",
+ "params": {
+ "chat_id": "The ID of the group",
+ "is_admin": "Whether to make them admin",
+ "user_id": "The user to make admin"
+ }
+ },
+ "messages.EditChatDefaultBannedRights": {
+ "desc": "Edit the default banned rights of a channel/supergroup/group.",
+ "params": {
+ "banned_rights": "The new global rights",
+ "peer": "The peer"
+ }
+ },
+ "messages.EditChatPhoto": {
+ "desc": "Changes chat photo and sends a service message on it",
+ "params": {
+ "chat_id": "Chat ID",
+ "photo": "Photo to be set"
+ }
+ },
+ "messages.EditChatTitle": {
+ "desc": "Changes chat name and sends a service message on it.",
+ "params": {
+ "chat_id": "Chat ID",
+ "title": "New chat name, different from the old one"
+ }
+ },
+ "messages.EditExportedChatInvite": {
+ "desc": "Edit an exported chat invite",
+ "params": {
+ "expire_date": "New expiration date",
+ "flags": "Flags, see TL conditional fields",
+ "link": "Invite link",
+ "peer": "Chat",
+ "request_needed": "Whether admin confirmation is required before admitting each separate user into the chat",
+ "revoked": "Whether to revoke the chat invite",
+ "title": "Description of the invite link, visible only to administrators",
+ "usage_limit": "Maximum number of users that can join using this link"
+ }
+ },
+ "messages.EditFactCheck": {
+ "desc": "Edit/create a fact-check on a message.",
+ "params": {
+ "msg_id": "Message ID",
+ "peer": "Peer where the message was sent",
+ "text": "Fact-check (maximum UTF-8 length specified in appConfig.factcheck_length_limit)."
+ }
+ },
+ "messages.EditForumTopic": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.EditInlineBotMessage": {
+ "desc": "Edit an inline bot message",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Sent inline message ID",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "media": "Media",
+ "message": "Message",
+ "no_webpage": "Disable webpage preview",
+ "reply_markup": "Reply markup for inline keyboards"
+ }
+ },
+ "messages.EditMessage": {
+ "desc": "Edit message",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of the message to edit",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "media": "New attached media",
+ "message": "New message",
+ "no_webpage": "Disable webpage preview",
+ "peer": "Where was the message sent",
+ "quick_reply_shortcut_id": "If specified, edits a quick reply shortcut message, instead \u00bb.",
+ "reply_markup": "Reply markup for inline keyboards",
+ "schedule_date": "Scheduled message date for scheduled messages"
+ }
+ },
+ "messages.EditQuickReplyShortcut": {
+ "desc": "Rename a quick reply shortcut.\nThis will emit an updateQuickReplies update to other logged-in sessions.",
+ "params": {
+ "shortcut": "New shortcut name.",
+ "shortcut_id": "Shortcut ID."
+ }
+ },
+ "messages.ExportChatInvite": {
+ "desc": "Export an invite link for a chat",
+ "params": {
+ "expire_date": "Expiration date",
+ "flags": "Flags, see TL conditional fields",
+ "legacy_revoke_permanent": "Legacy flag, reproducing legacy behavior of this method: if set, revokes all previous links before creating a new one. Kept for bot API BC, should not be used by modern clients.",
+ "peer": "Chat",
+ "request_needed": "Whether admin confirmation is required before admitting each separate user into the chat",
+ "subscription_pricing": "For Telegram Star subscriptions \u00bb, contains the pricing of the subscription the user must activate to join the private channel.",
+ "title": "Description of the invite link, visible only to administrators",
+ "usage_limit": "Maximum number of users that can join using this link"
+ }
+ },
+ "messages.FaveSticker": {
+ "desc": "Mark or unmark a sticker as favorite",
+ "params": {
+ "id": "Sticker in question",
+ "unfave": "Whether to add or remove a sticker from favorites"
+ }
+ },
+ "messages.ForwardMessage": {
+ "desc": "Forwards single messages.",
+ "params": {
+ "id": "Forwarded message ID",
+ "peer": "User or chat where a message will be forwarded",
+ "random_id": "Unique client message ID required to prevent message resending"
+ }
+ },
+ "messages.ForwardMessages": {
+ "desc": "Forwards messages by their IDs.",
+ "params": {
+ "allow_paid_floodskip": "Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.",
+ "allow_paid_stars": "For paid messages \u00bb, specifies the amount of Telegram Stars the user has agreed to pay in order to send the message.",
+ "background": "Whether to send the message in background",
+ "drop_author": "Whether to forward messages without quoting the original author",
+ "drop_media_captions": "Whether to strip captions from media",
+ "flags": "Flags, see TL conditional fields",
+ "from_peer": "Source of messages",
+ "id": "IDs of messages",
+ "noforwards": "Only for bots, disallows further re-forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled",
+ "quick_reply_shortcut": "Add the messages to the specified quick reply shortcut \u00bb, instead.",
+ "random_id": "Random ID to prevent resending of messages",
+ "reply_to": "Can only contain an inputReplyToMonoForum, to forward messages to a monoforum topic (mutually exclusive with top_msg_id).",
+ "schedule_date": "Scheduled message date for scheduled messages",
+ "send_as": "Forward the messages as the specified peer",
+ "silent": "Whether to send messages silently (no notification will be triggered on the destination clients)",
+ "suggested_post": "Used to suggest a post to a channel, see here \u00bb for more info on the full flow.",
+ "to_peer": "Destination peer",
+ "top_msg_id": "Destination forum topic",
+ "video_timestamp": "Start playing the video at the specified timestamp (seconds).",
+ "with_my_score": "When forwarding games, whether to include your score in the game"
+ }
+ },
+ "messages.GetAdminsWithInvites": {
+ "desc": "Get info about chat invites generated by admins.",
+ "params": {
+ "peer": "Chat"
+ }
+ },
+ "messages.GetAllChats": {
+ "desc": "Get all chats, channels and supergroups",
+ "params": {}
+ },
+ "messages.GetAllDrafts": {
+ "desc": "Return all message drafts.\nReturns all the latest updateDraftMessage updates related to all chats with drafts.",
+ "params": {}
+ },
+ "messages.GetAllStickers": {
+ "desc": "Get all installed stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetArchivedStickers": {
+ "desc": "Get all archived stickers",
+ "params": {
+ "emojis": "Get custom emoji stickers",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "masks": "Get mask stickers",
+ "offset_id": "Offsets for pagination, for more info click here"
+ }
+ },
+ "messages.GetAttachMenuBot": {
+ "desc": "Returns attachment menu entry for a bot mini app that can be launched from the attachment menu \u00bb",
+ "params": {
+ "bot": "Bot ID"
+ }
+ },
+ "messages.GetAttachMenuBots": {
+ "desc": "Returns installed attachment menu bot mini apps \u00bb",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetAttachedStickers": {
+ "desc": "Get stickers attached to a photo or video",
+ "params": {
+ "media": "Stickered media"
+ }
+ },
+ "messages.GetAvailableEffects": {
+ "desc": "Fetch the full list of usable animated message effects \u00bb.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetAvailableReactions": {
+ "desc": "Obtain available message reactions \u00bb",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetBotApp": {
+ "desc": "Obtain information about a direct link Mini App",
+ "params": {
+ "app": "Bot app information obtained from a Direct Mini App deep link \u00bb.",
+ "hash": "Hash used for caching, for more info click here"
+ }
+ },
+ "messages.GetBotCallbackAnswer": {
+ "desc": "Press an inline callback button and get a callback answer from the bot",
+ "params": {
+ "data": "Callback data",
+ "flags": "Flags, see TL conditional fields",
+ "game": "Whether this is a \"play game\" button",
+ "msg_id": "ID of the Message with the inline keyboard",
+ "password": "For buttons requiring you to verify your identity with your 2FA password, the SRP payload generated using SRP.",
+ "peer": "Where was the inline keyboard sent"
+ }
+ },
+ "messages.GetChatInviteImporters": {
+ "desc": "Get info about the users that joined the chat using a specific chat invite",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "link": "Invite link",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_user": "User ID for pagination: if set, offset_date must also be set.",
+ "peer": "Chat",
+ "q": "Search for a user in the pending join requests \u00bb list: only available when the requested flag is set, cannot be used together with a specific link.",
+ "requested": "If set, only returns info about users with pending join requests \u00bb",
+ "subscription_expired": "Set this flag if the link is a Telegram Star subscription link \u00bb and only members with already expired subscription must be returned."
+ }
+ },
+ "messages.GetChats": {
+ "desc": "Returns chat basic info on their IDs.",
+ "params": {
+ "id": "List of chat IDs"
+ }
+ },
+ "messages.GetCommonChats": {
+ "desc": "Get chats in common with a user",
+ "params": {
+ "limit": "Maximum number of results to return, see pagination",
+ "max_id": "Maximum ID of chat to return (see pagination)",
+ "user_id": "User ID"
+ }
+ },
+ "messages.GetCustomEmojiDocuments": {
+ "desc": "Fetch custom emoji stickers \u00bb.",
+ "params": {
+ "document_id": "Custom emoji IDs from a messageEntityCustomEmoji."
+ }
+ },
+ "messages.GetDefaultHistoryTTL": {
+ "desc": "Gets the default value of the Time-To-Live setting, applied to all new chats.",
+ "params": {}
+ },
+ "messages.GetDefaultTagReactions": {
+ "desc": "Fetch a default recommended list of saved message tag reactions.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetDhConfig": {
+ "desc": "Returns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length.",
+ "params": {
+ "random_length": "Length of the required random sequence",
+ "version": "Value of the version parameter from messages.dhConfig, available at the client"
+ }
+ },
+ "messages.GetDialogFilters": {
+ "desc": "Get folders",
+ "params": {}
+ },
+ "messages.GetDialogUnreadMarks": {
+ "desc": "Get dialogs manually marked as unread",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "parent_peer": "Can be equal to the ID of a monoforum, to fetch monoforum topics manually marked as unread."
+ }
+ },
+ "messages.GetDialogs": {
+ "desc": "Returns the current user dialog list.",
+ "params": {
+ "exclude_pinned": "Exclude pinned dialogs",
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "hash": "Hash used for caching, for more info click here",
+ "limit": "Number of list elements to be returned",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_id": "Offsets for pagination, for more info click here (top_message ID used for pagination)",
+ "offset_peer": "Offset peer for pagination"
+ }
+ },
+ "messages.GetDiscussionMessage": {
+ "desc": "Get discussion message from the associated discussion group of a channel to show it on top of the comment section, without actually joining the group",
+ "params": {
+ "msg_id": "Message ID",
+ "peer": "Channel ID"
+ }
+ },
+ "messages.GetDocumentByHash": {
+ "desc": "Get a document by its SHA256 hash, mainly used for gifs",
+ "params": {
+ "mime_type": "Mime type",
+ "sha256": "SHA256 of file",
+ "size": "Size of the file in bytes"
+ }
+ },
+ "messages.GetEmojiGroups": {
+ "desc": "Represents a list of emoji categories.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetEmojiKeywords": {
+ "desc": "Get localized emoji keywords \u00bb.",
+ "params": {
+ "lang_code": "Language code"
+ }
+ },
+ "messages.GetEmojiKeywordsDifference": {
+ "desc": "Get changed emoji keywords \u00bb.",
+ "params": {
+ "from_version": "Previous stored emoji keyword list version",
+ "lang_code": "Language code"
+ }
+ },
+ "messages.GetEmojiKeywordsLanguages": {
+ "desc": "Obtain a list of related languages that must be used when fetching emoji keyword lists \u00bb.",
+ "params": {
+ "lang_codes": "The user's language codes"
+ }
+ },
+ "messages.GetEmojiProfilePhotoGroups": {
+ "desc": "Represents a list of emoji categories, to be used when selecting custom emojis to set as profile picture.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetEmojiStatusGroups": {
+ "desc": "Represents a list of emoji categories, to be used when selecting custom emojis to set as custom emoji status.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetEmojiStickerGroups": {
+ "desc": "Represents a list of emoji categories, to be used when choosing a sticker.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetEmojiStickers": {
+ "desc": "Gets the list of currently installed custom emoji stickersets.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetEmojiURL": {
+ "desc": "Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji keywords \u00bb. The URL will be valid for 30 seconds after generation.",
+ "params": {
+ "lang_code": "Language code for which the emoji keywords will be suggested"
+ }
+ },
+ "messages.GetExportedChatInvite": {
+ "desc": "Get info about a chat invite",
+ "params": {
+ "link": "Invite link",
+ "peer": "Chat"
+ }
+ },
+ "messages.GetExportedChatInvites": {
+ "desc": "Get info about the chat invites of a specific chat",
+ "params": {
+ "admin_id": "Whether to only fetch chat invites from this admin",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_link": "Offsets for pagination, for more info click here",
+ "peer": "Chat",
+ "revoked": "Whether to fetch revoked chat invites"
+ }
+ },
+ "messages.GetExtendedMedia": {
+ "desc": "Fetch updated information about paid media, see here \u00bb for the full flow.",
+ "params": {
+ "id": "IDs of currently visible messages containing paid media.",
+ "peer": "Peer with visible paid media messages."
+ }
+ },
+ "messages.GetFactCheck": {
+ "desc": "Fetch one or more factchecks, see here \u00bb for the full flow.",
+ "params": {
+ "msg_id": "Messages that have associated factCheck constructors with the need_check flag set.",
+ "peer": "Peer where the messages were sent."
+ }
+ },
+ "messages.GetFavedStickers": {
+ "desc": "Get faved stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetFeaturedEmojiStickers": {
+ "desc": "Gets featured custom emoji stickersets.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetFeaturedStickers": {
+ "desc": "Get featured stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetForumTopics": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.GetForumTopicsByID": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.GetFullChat": {
+ "desc": "Get full info about a basic group.",
+ "params": {
+ "chat_id": "Basic group ID."
+ }
+ },
+ "messages.GetGameHighScores": {
+ "desc": "Get highscores of a game",
+ "params": {
+ "id": "ID of message with game media attachment",
+ "peer": "Where was the game sent",
+ "user_id": "Get high scores made by a certain user"
+ }
+ },
+ "messages.GetHistory": {
+ "desc": "Returns the conversation history with one interlocutor / within a chat",
+ "params": {
+ "add_offset": "Number of list elements to be skipped, negative values are also accepted.",
+ "hash": "Result hash",
+ "limit": "Number of results to return",
+ "max_id": "If a positive value was transferred, the method will return only messages with IDs less than max_id",
+ "min_id": "If a positive value was transferred, the method will return only messages with IDs more than min_id",
+ "offset_date": "Only return messages sent before the specified date",
+ "offset_id": "Only return messages starting from the specified message ID",
+ "peer": "Target peer"
+ }
+ },
+ "messages.GetInlineBotResults": {
+ "desc": "Query an inline bot",
+ "params": {
+ "bot": "The bot to query",
+ "flags": "Flags, see TL conditional fields",
+ "geo_point": "The geolocation, if requested",
+ "offset": "The offset within the results, will be passed directly as-is to the bot.",
+ "peer": "The currently opened chat",
+ "query": "The query"
+ }
+ },
+ "messages.GetInlineGameHighScores": {
+ "desc": "Get highscores of a game sent using an inline bot",
+ "params": {
+ "id": "ID of inline message",
+ "user_id": "Get high scores of a certain user"
+ }
+ },
+ "messages.GetMaskStickers": {
+ "desc": "Get installed mask stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetMessageEditData": {
+ "desc": "Find out if a media message's caption can be edited",
+ "params": {
+ "id": "ID of message",
+ "peer": "Peer where the media was sent"
+ }
+ },
+ "messages.GetMessageReactionsList": {
+ "desc": "Get message reaction list, along with the sender of each reaction.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Message ID",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination (taken from the next_offset field of the returned messages.MessageReactionsList); empty in the first request.",
+ "peer": "Peer",
+ "reaction": "Get only reactions of this type"
+ }
+ },
+ "messages.GetMessageReadParticipants": {
+ "desc": "Get which users read a specific message: only available for groups and supergroups with less than chat_read_mark_size_threshold members, read receipts will be stored for chat_read_mark_expire_period seconds after the message was sent, see client configuration for more info \u00bb.",
+ "params": {
+ "msg_id": "Message ID",
+ "peer": "Dialog"
+ }
+ },
+ "messages.GetMessages": {
+ "desc": "Returns the list of messages by their IDs.",
+ "params": {
+ "id": "Message ID list"
+ }
+ },
+ "messages.GetMessagesReactions": {
+ "desc": "Get message reactions \u00bb",
+ "params": {
+ "id": "Message IDs",
+ "peer": "Peer"
+ }
+ },
+ "messages.GetMessagesViews": {
+ "desc": "Get and increase the view counter of a message sent or forwarded from a channel",
+ "params": {
+ "id": "ID of message",
+ "increment": "Whether to mark the message as viewed and increment the view counter",
+ "peer": "Peer where the message was found"
+ }
+ },
+ "messages.GetMyStickers": {
+ "desc": "Fetch all stickersets \u00bb owned by the current user.",
+ "params": {
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here"
+ }
+ },
+ "messages.GetOldFeaturedStickers": {
+ "desc": "Method for fetching previously featured stickers",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset"
+ }
+ },
+ "messages.GetOnlines": {
+ "desc": "Get count of online users in a chat",
+ "params": {
+ "peer": "The chat"
+ }
+ },
+ "messages.GetOutboxReadDate": {
+ "desc": "Get the exact read date of one of our messages, sent to a private chat with another user.",
+ "params": {
+ "msg_id": "The message ID.",
+ "peer": "The user to whom we sent the message."
+ }
+ },
+ "messages.GetPaidReactionPrivacy": {
+ "desc": "Fetches an updatePaidReactionPrivacy update with the current default paid reaction privacy, see here \u00bb for more info.",
+ "params": {}
+ },
+ "messages.GetPeerDialogs": {
+ "desc": "Get dialog info of specified peers",
+ "params": {
+ "peers": "Peers"
+ }
+ },
+ "messages.GetPeerSettings": {
+ "desc": "Get peer settings",
+ "params": {
+ "peer": "The peer"
+ }
+ },
+ "messages.GetPinnedDialogs": {
+ "desc": "Get pinned dialogs",
+ "params": {
+ "folder_id": "Peer folder ID, for more info click here"
+ }
+ },
+ "messages.GetPinnedSavedDialogs": {
+ "desc": "Get pinned saved dialogs, see here \u00bb for more info.",
+ "params": {}
+ },
+ "messages.GetPollResults": {
+ "desc": "Get poll results",
+ "params": {
+ "msg_id": "Message ID of poll message",
+ "peer": "Peer where the poll was found"
+ }
+ },
+ "messages.GetPollVotes": {
+ "desc": "Get poll results for non-anonymous polls",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Message ID",
+ "limit": "Number of results to return",
+ "offset": "Offset for results, taken from the next_offset field of messages.votesList, initially an empty string. Note: if no more results are available, the method call will return an empty next_offset; thus, avoid providing the next_offset returned in messages.votesList if it is empty, to avoid an infinite loop.",
+ "option": "Get only results for the specified poll option",
+ "peer": "Chat where the poll was sent"
+ }
+ },
+ "messages.GetPreparedInlineMessage": {
+ "desc": "Obtain a prepared inline message generated by a mini app: invoked when handling web_app_send_prepared_message events",
+ "params": {
+ "bot": "The bot that owns the mini app that emitted the web_app_send_prepared_message event",
+ "id": "The id from the web_app_send_prepared_message event"
+ }
+ },
+ "messages.GetQuickReplies": {
+ "desc": "Fetch basic info about all existing quick reply shortcuts.",
+ "params": {
+ "hash": "Hash for pagination, generated as specified here \u00bb (not the usual algorithm used for hash generation.)"
+ }
+ },
+ "messages.GetQuickReplyMessages": {
+ "desc": "Fetch (a subset or all) messages in a quick reply shortcut \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash for pagination, generated as specified here \u00bb (not the usual algorithm used for hash generation).",
+ "id": "IDs of the messages to fetch, if empty fetches all of them.",
+ "shortcut_id": "Quick reply shortcut ID."
+ }
+ },
+ "messages.GetRecentLocations": {
+ "desc": "Get live location history of a certain user",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "limit": "Maximum number of results to return, see pagination",
+ "peer": "User"
+ }
+ },
+ "messages.GetRecentReactions": {
+ "desc": "Get recently used message reactions",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.",
+ "limit": "Maximum number of results to return, see pagination"
+ }
+ },
+ "messages.GetRecentStickers": {
+ "desc": "Get recent stickers",
+ "params": {
+ "attached": "Get stickers recently attached to photo or video files",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetReplies": {
+ "desc": "Get messages in a reply thread",
+ "params": {
+ "add_offset": "Offsets for pagination, for more info click here",
+ "hash": "Hash used for caching, for more info click here",
+ "limit": "Maximum number of results to return, see pagination",
+ "max_id": "If a positive value was transferred, the method will return only messages with ID smaller than max_id",
+ "min_id": "If a positive value was transferred, the method will return only messages with ID bigger than min_id",
+ "msg_id": "Message ID",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer"
+ }
+ },
+ "messages.GetSavedDialogs": {
+ "desc": "Returns the current saved dialog list \u00bb or monoforum topic list \u00bb.",
+ "params": {
+ "exclude_pinned": "Exclude pinned dialogs",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here",
+ "limit": "Number of list elements to be returned",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_id": "Offsets for pagination, for more info click here (top_message ID used for pagination)",
+ "offset_peer": "Offset peer for pagination",
+ "parent_peer": "If set, fetches the topic list of the passed monoforum, otherwise fetches the saved dialog list."
+ }
+ },
+ "messages.GetSavedDialogsByID": {
+ "desc": "Obtain information about specific saved message dialogs \u00bb or monoforum topics \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "ids": "IDs of dialogs (topics) to fetch.",
+ "parent_peer": "If set, fetches monoforum topics \u00bb, otherwise fetches saved message dialogs \u00bb."
+ }
+ },
+ "messages.GetSavedGifs": {
+ "desc": "Get saved GIFs.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetSavedHistory": {
+ "desc": "Fetch saved messages \u00bb forwarded from a specific peer, or fetch messages from a monoforum topic \u00bb.",
+ "params": {
+ "add_offset": "Number of list elements to be skipped, negative values are also accepted.",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Result hash",
+ "limit": "Number of results to return",
+ "max_id": "If a positive value was transferred, the method will return only messages with IDs less than max_id",
+ "min_id": "If a positive value was transferred, the method will return only messages with IDs more than min_id",
+ "offset_date": "Only return messages sent before the specified date",
+ "offset_id": "Only return messages starting from the specified message ID",
+ "parent_peer": "If set, fetches messages from the specified monoforum, otherwise fetches from saved messages.",
+ "peer": "Target peer (or topic)"
+ }
+ },
+ "messages.GetSavedReactionTags": {
+ "desc": "Fetch the full list of saved message tags created by the user.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here.",
+ "peer": "If set, returns tags only used in the specified saved message dialog."
+ }
+ },
+ "messages.GetScheduledHistory": {
+ "desc": "Get scheduled messages",
+ "params": {
+ "hash": "Hash used for caching, for more info click here. To generate the hash, populate the ids array with the id, edit_date (0 if unedited) and date (in this order) of the previously returned messages (in order, i.e. ids = [id1, (edit_date1 ?? 0), date1, id2, (edit_date2 ?? 0), date2, ...]).",
+ "peer": "Peer"
+ }
+ },
+ "messages.GetScheduledMessages": {
+ "desc": "Get scheduled messages",
+ "params": {
+ "id": "IDs of scheduled messages",
+ "peer": "Peer"
+ }
+ },
+ "messages.GetSearchCounters": {
+ "desc": "Get the number of results that would be found by a messages.search call with the same parameters",
+ "params": {
+ "filters": "Search filters",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Peer where to search",
+ "saved_peer_id": "Search within the saved message dialog \u00bb with this ID.",
+ "top_msg_id": "If set, consider only messages within the specified forum topic"
+ }
+ },
+ "messages.GetSearchResultsCalendar": {
+ "desc": "Returns information about the next messages of the specified type in the chat split by days.",
+ "params": {
+ "filter": "Message filter, inputMessagesFilterEmpty, inputMessagesFilterMyMentions filters are not supported by this method.",
+ "flags": "Flags, see TL conditional fields",
+ "offset_date": "Offsets for pagination, for more info click here",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer where to search",
+ "saved_peer_id": "Search within the saved message dialog \u00bb with this ID."
+ }
+ },
+ "messages.GetSearchResultsPositions": {
+ "desc": "Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation.",
+ "params": {
+ "filter": "Message filter, inputMessagesFilterEmpty, inputMessagesFilterMyMentions filters are not supported by this method.",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer where to search",
+ "saved_peer_id": "Search within the saved message dialog \u00bb with this ID."
+ }
+ },
+ "messages.GetSplitRanges": {
+ "desc": "Get message ranges for saving the user's chat history",
+ "params": {}
+ },
+ "messages.GetSponsoredMessages": {
+ "desc": "Get a list of sponsored messages for a peer, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Must be set when fetching sponsored messages to show on channel videos \u00bb.",
+ "peer": "The currently open channel/bot."
+ }
+ },
+ "messages.GetStatsURL": {
+ "desc": "Returns URL with the chat statistics. Currently this method can be used only for channels",
+ "params": {
+ "dark": "Pass true if a URL with the dark theme must be returned",
+ "flags": "Flags, see TL conditional fields",
+ "params": "Parameters from tg://statsrefresh?params=****** link",
+ "peer": "Chat identifier"
+ }
+ },
+ "messages.GetStickerSet": {
+ "desc": "Get info about a stickerset",
+ "params": {
+ "hash": "Hash used for caching, for more info click here",
+ "stickerset": "Stickerset"
+ }
+ },
+ "messages.GetStickers": {
+ "desc": "Get stickers by emoji",
+ "params": {
+ "emoticon": "The emoji",
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.GetSuggestedDialogFilters": {
+ "desc": "Get suggested folders",
+ "params": {}
+ },
+ "messages.GetTopReactions": {
+ "desc": "Got popular message reactions",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.",
+ "limit": "Maximum number of results to return, see pagination"
+ }
+ },
+ "messages.GetUniqueGiftChatThemes": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.GetUnreadMentions": {
+ "desc": "Get unread messages where we were mentioned",
+ "params": {
+ "add_offset": "Offsets for pagination, for more info click here",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "max_id": "Maximum message ID to return, see pagination",
+ "min_id": "Minimum message ID to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer where to look for mentions",
+ "top_msg_id": "If set, considers only messages within the specified forum topic"
+ }
+ },
+ "messages.GetUnreadReactions": {
+ "desc": "Get unread reactions to messages you sent",
+ "params": {
+ "add_offset": "Offsets for pagination, for more info click here",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "max_id": "Only return reactions for messages up until this message ID",
+ "min_id": "Only return reactions for messages starting from this message ID",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer",
+ "saved_peer_id": "If set, must be equal to the ID of a monoforum topic: will affect that topic in the monoforum passed in peer.",
+ "top_msg_id": "If set, considers only reactions to messages within the specified forum topic"
+ }
+ },
+ "messages.GetWebPage": {
+ "desc": "Get instant view page",
+ "params": {
+ "hash": "Hash used for caching, for more info click here. Note: the usual hash generation algorithm cannot be used in this case, please re-use the webPage.hash field returned by a previous call to the method, or pass 0 if this is the first call or if the previous call did not return a webPage.",
+ "url": "URL of IV page to fetch"
+ }
+ },
+ "messages.GetWebPagePreview": {
+ "desc": "Get preview of webpage",
+ "params": {
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Message from which to extract the preview"
+ }
+ },
+ "messages.GetWebViewResult": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.HideAllChatJoinRequests": {
+ "desc": "Dismiss or approve all join requests related to a specific chat or channel.",
+ "params": {
+ "approved": "Whether to dismiss or approve all chat join requests \u00bb",
+ "flags": "Flags, see TL conditional fields",
+ "link": "Only dismiss or approve join requests \u00bb initiated using this invite link",
+ "peer": "The chat or channel"
+ }
+ },
+ "messages.HideChatJoinRequest": {
+ "desc": "Dismiss or approve a chat join request related to a specific chat or channel.",
+ "params": {
+ "approved": "Whether to dismiss or approve the chat join request \u00bb",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The chat or channel",
+ "user_id": "The user whose join request \u00bb should be dismissed or approved"
+ }
+ },
+ "messages.HidePeerSettingsBar": {
+ "desc": "Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the action bar \u00bb.",
+ "params": {
+ "peer": "Peer"
+ }
+ },
+ "messages.ImportChatInvite": {
+ "desc": "Import a chat invite and join a private chat/supergroup/channel",
+ "params": {
+ "hash": "hash from a chat invite deep link"
+ }
+ },
+ "messages.InitHistoryImport": {
+ "desc": "Import chat history from a foreign chat app into a specific Telegram chat, click here for more info about imported chats \u00bb.",
+ "params": {
+ "file": "File with messages to import.",
+ "media_count": "Number of media files associated with the chat that will be uploaded using messages.uploadImportedMedia.",
+ "peer": "The Telegram chat where the history should be imported."
+ }
+ },
+ "messages.InstallStickerSet": {
+ "desc": "Install a stickerset",
+ "params": {
+ "archived": "Whether to archive stickerset",
+ "stickerset": "Stickerset to install"
+ }
+ },
+ "messages.MarkDialogUnread": {
+ "desc": "Manually mark dialog as unread",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "parent_peer": "If set, must be equal to the ID of a monoforum, and will affect the monoforum topic passed in peer.",
+ "peer": "Dialog",
+ "unread": "Mark as unread/read"
+ }
+ },
+ "messages.MigrateChat": {
+ "desc": "Turn a basic group into a supergroup",
+ "params": {
+ "chat_id": "Basic group to migrate"
+ }
+ },
+ "messages.ProlongWebView": {
+ "desc": "Indicate to the server (from the user side) that the user is still using a web app.",
+ "params": {
+ "bot": "Bot that owns the web app",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Dialog where the web app was opened.",
+ "query_id": "Web app interaction ID obtained from messages.requestWebView",
+ "reply_to": "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 terminated should be sent in reply to the specified message or story.",
+ "send_as": "Open the web app as the specified peer",
+ "silent": "Whether 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)."
+ }
+ },
+ "messages.RateTranscribedAudio": {
+ "desc": "Rate transcribed voice message",
+ "params": {
+ "good": "Whether the transcription was correct",
+ "msg_id": "Message ID",
+ "peer": "Peer where the voice message was sent",
+ "transcription_id": "Transcription ID"
+ }
+ },
+ "messages.ReadDiscussion": {
+ "desc": "Mark a thread as read",
+ "params": {
+ "msg_id": "ID of message that started the thread",
+ "peer": "Group ID",
+ "read_max_id": "ID up to which thread messages were read"
+ }
+ },
+ "messages.ReadEncryptedHistory": {
+ "desc": "Marks message history within a secret chat as read.",
+ "params": {
+ "max_date": "Maximum date value for received messages in history",
+ "peer": "Secret chat ID"
+ }
+ },
+ "messages.ReadFeaturedStickers": {
+ "desc": "Mark new featured stickers as read",
+ "params": {
+ "id": "IDs of stickersets to mark as read"
+ }
+ },
+ "messages.ReadHistory": {
+ "desc": "Marks message history as read.",
+ "params": {
+ "max_id": "If a positive value is passed, only messages with identifiers less or equal than the given one will be read",
+ "peer": "Target user or group"
+ }
+ },
+ "messages.ReadMentions": {
+ "desc": "Mark mentions as read",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Dialog",
+ "top_msg_id": "Mark as read only mentions within the specified forum topic"
+ }
+ },
+ "messages.ReadMessageContents": {
+ "desc": "Notifies the sender about the recipient having listened a voice message or watched a video, emitting an updateReadMessagesContents.",
+ "params": {
+ "id": "Message ID list"
+ }
+ },
+ "messages.ReadReactions": {
+ "desc": "Mark message reactions \u00bb as read",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Peer",
+ "saved_peer_id": "If set, must be equal to the ID of a monoforum topic: will affect that topic in the monoforum passed in peer.",
+ "top_msg_id": "Mark as read only reactions to messages within the specified forum topic"
+ }
+ },
+ "messages.ReadSavedHistory": {
+ "desc": "Mark messages as read in a monoforum topic \u00bb.",
+ "params": {
+ "max_id": "If a positive value is passed, only messages with identifiers less or equal than the given one will be read.",
+ "parent_peer": "ID of the monoforum group.",
+ "peer": "ID of the topic."
+ }
+ },
+ "messages.ReceivedMessages": {
+ "desc": "Confirms receipt of messages by a client, cancels PUSH-notification sending.",
+ "params": {
+ "max_id": "Maximum message ID available in a client."
+ }
+ },
+ "messages.ReceivedQueue": {
+ "desc": "Confirms receipt of messages in a secret chat by client, cancels push notifications.\nThe method returns a list of random_ids of messages for which push notifications were cancelled.",
+ "params": {
+ "max_qts": "Maximum qts value available at the client"
+ }
+ },
+ "messages.ReorderPinnedDialogs": {
+ "desc": "Reorder pinned dialogs",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "force": "If set, dialogs pinned server-side but not present in the order field will be unpinned.",
+ "order": "New dialog order"
+ }
+ },
+ "messages.ReorderPinnedForumTopics": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.ReorderPinnedSavedDialogs": {
+ "desc": "Reorder pinned saved message dialogs \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "force": "If set, dialogs pinned server-side but not present in the order field will be unpinned.",
+ "order": "New dialog order"
+ }
+ },
+ "messages.ReorderQuickReplies": {
+ "desc": "Reorder quick reply shortcuts.",
+ "params": {
+ "order": "IDs of all created quick reply shortcuts, in the desired order."
+ }
+ },
+ "messages.ReorderStickerSets": {
+ "desc": "Reorder installed stickersets",
+ "params": {
+ "emojis": "Reorder custom emoji stickersets",
+ "flags": "Flags, see TL conditional fields",
+ "masks": "Reorder mask stickersets",
+ "order": "New stickerset order by stickerset IDs"
+ }
+ },
+ "messages.Report": {
+ "desc": "Report a message in a chat for violation of telegram's Terms of Service",
+ "params": {
+ "id": "IDs of messages to report",
+ "message": "Comment for report moderation",
+ "option": "Menu option, intially empty",
+ "peer": "Peer"
+ }
+ },
+ "messages.ReportEncryptedSpam": {
+ "desc": "Report a secret chat for spam",
+ "params": {
+ "peer": "The secret chat to report"
+ }
+ },
+ "messages.ReportMessagesDelivery": {
+ "desc": "Used for Telegram Gateway verification messages \u00bb: indicate to the server that one or more messages were received by the client, if requested by the message.report_delivery_until_date flag or the equivalent flag in push notifications.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "The IDs of the received messages.",
+ "peer": "The peer where the messages were received.",
+ "push": "Must be set if the messages were received from a push notification."
+ }
+ },
+ "messages.ReportReaction": {
+ "desc": "Report a message reaction",
+ "params": {
+ "id": "Message ID",
+ "peer": "Peer where the message was sent",
+ "reaction_peer": "Peer that sent the reaction"
+ }
+ },
+ "messages.ReportSpam": {
+ "desc": "Report a new incoming chat for spam, if the peer settings of the chat allow us to do that",
+ "params": {
+ "peer": "Peer to report"
+ }
+ },
+ "messages.ReportSponsoredMessage": {
+ "desc": "Report a sponsored message \u00bb, see here \u00bb for more info on the full flow.",
+ "params": {
+ "option": "Chosen report option, initially an empty string, see here \u00bb for more info on the full flow.",
+ "random_id": "The ad's unique ID."
+ }
+ },
+ "messages.RequestAppWebView": {
+ "desc": "Open a bot mini app from a direct Mini App deep link, sending over user information after user confirmation.",
+ "params": {
+ "app": "The app obtained by invoking messages.getBotApp as specified in the direct Mini App deep link docs.",
+ "compact": "If 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 direct Mini App deep link is equal to compact.",
+ "flags": "Flags, see TL conditional fields",
+ "fullscreen": "If set, requests to open the mini app in fullscreen mode (as opposed to compact or normal mode). Must be set if the mode parameter of the direct Mini App deep link is equal to fullscreen.",
+ "peer": "If the client has clicked on the link in a Telegram chat, pass the chat's peer information; otherwise pass the bot's peer information, instead.",
+ "platform": "Short name of the application; 0-64 English letters, digits, and underscores",
+ "start_param": "If the startapp query string parameter is present in the direct Mini App deep link, pass it to start_param.",
+ "theme_params": "Theme parameters \u00bb",
+ "write_allowed": "Set this flag if the bot is asking permission to send messages to the user as specified in the direct Mini App deep link docs, and the user agreed."
+ }
+ },
+ "messages.RequestEncryption": {
+ "desc": "Sends a request to start a secret chat to the user.",
+ "params": {
+ "g_a": "A = g ^ a mod p, see Wikipedia",
+ "random_id": "Unique client request ID required to prevent resending. This also doubles as the chat ID.",
+ "user_id": "User ID"
+ }
+ },
+ "messages.RequestMainWebView": {
+ "desc": "Open a Main Mini App.",
+ "params": {
+ "bot": "Bot that owns the main mini app.",
+ "compact": "If 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 Main Mini App link is equal to compact.",
+ "flags": "Flags, see TL conditional fields",
+ "fullscreen": "If set, requests to open the mini app in fullscreen mode (as opposed to compact or normal mode). Must be set if the mode parameter of the Main Mini App link is equal to fullscreen.",
+ "peer": "Currently open chat, may be inputPeerEmpty if no chat is currently open.",
+ "platform": "Short name of the application; 0-64 English letters, digits, and underscores",
+ "start_param": "Start parameter, if opening from a Main Mini App link \u00bb.",
+ "theme_params": "Theme parameters \u00bb"
+ }
+ },
+ "messages.RequestSimpleWebView": {
+ "desc": "Open a bot mini app.",
+ "params": {
+ "bot": "Bot that owns the mini app",
+ "compact": "Deprecated.",
+ "flags": "Flags, see TL conditional fields",
+ "from_side_menu": "Set this flag if opening the Mini App from the installed side menu entry \u00bb.",
+ "from_switch_webview": "Whether the webapp was opened by clicking on the switch_webview button shown on top of the inline results list returned by messages.getInlineBotResults.",
+ "fullscreen": "Requests to open the app in fullscreen mode.",
+ "platform": "Short name of the application; 0-64 English letters, digits, and underscores",
+ "start_param": "Deprecated.",
+ "theme_params": "Theme parameters \u00bb",
+ "url": "Web app URL, if opening from a keyboard button or inline result"
+ }
+ },
+ "messages.RequestUrlAuth": {
+ "desc": "Get more info about a Seamless Telegram Login authorization request, for more info click here \u00bb",
+ "params": {
+ "button_id": "The ID of the button with the authorization request",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "The message",
+ "peer": "Peer where the message is located",
+ "url": "URL used for link URL authorization, click here for more info \u00bb"
+ }
+ },
+ "messages.RequestWebView": {
+ "desc": "Open a bot mini app, sending over user information after user confirmation.",
+ "params": {
+ "bot": "Bot that owns the web app",
+ "compact": "If 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.",
+ "flags": "Flags, see TL conditional fields",
+ "from_bot_menu": "Whether the webview was opened by clicking on the bot's menu button \u00bb.",
+ "fullscreen": "If 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.",
+ "peer": "Dialog where the web app is being opened, and where the resulting message will be sent (see the docs for more info \u00bb).",
+ "platform": "Short name of the application; 0-64 English letters, digits, and underscores",
+ "reply_to": "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 terminated should be sent in reply to the specified message or story.",
+ "send_as": "Open the web app as the specified peer, sending the resulting the message as the specified peer.",
+ "silent": "Whether 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).",
+ "start_param": "If 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_params": "Theme parameters \u00bb",
+ "url": "Web app URL"
+ }
+ },
+ "messages.SaveDefaultSendAs": {
+ "desc": "Change the default peer that should be used when sending messages, reactions, poll votes to a specific group",
+ "params": {
+ "peer": "Group",
+ "send_as": "The default peer that should be used when sending messages to the group"
+ }
+ },
+ "messages.SaveDraft": {
+ "desc": "Save a message draft associated to a chat.",
+ "params": {
+ "effect": "Specifies a message effect \u00bb to use for the message.",
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "media": "Attached media",
+ "message": "The draft",
+ "no_webpage": "Disable generation of the webpage preview",
+ "peer": "Destination of the message that should be sent",
+ "reply_to": "If set, indicates that the message should be sent in reply to the specified message or story.",
+ "suggested_post": "Used to suggest a post to a channel, see here \u00bb for more info on the full flow."
+ }
+ },
+ "messages.SaveGif": {
+ "desc": "Add GIF to saved gifs list",
+ "params": {
+ "id": "GIF to save",
+ "unsave": "Whether to remove GIF from saved gifs list"
+ }
+ },
+ "messages.SavePreparedInlineMessage": {
+ "desc": "Save a prepared inline message, to be shared by the user of the mini app using a web_app_send_prepared_message event",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer_types": "Types of chats where this message can be sent",
+ "result": "The message",
+ "user_id": "The user to whom the web_app_send_prepared_message event event will be sent"
+ }
+ },
+ "messages.SaveRecentSticker": {
+ "desc": "Add/remove sticker from recent stickers list",
+ "params": {
+ "attached": "Whether to add/remove stickers recently attached to photo or video files",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Sticker",
+ "unsave": "Whether to save or unsave the sticker"
+ }
+ },
+ "messages.Search": {
+ "desc": "Search for messages.",
+ "params": {
+ "add_offset": "Additional offset",
+ "filter": "Filter to return only specified message types",
+ "flags": "Flags, see TL conditional fields",
+ "from_id": "Only return messages sent by the specified user ID",
+ "hash": "Hash",
+ "limit": "Number of results to return, can be 0 to only return the message counter.",
+ "max_date": "If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned",
+ "max_id": "Maximum message ID to return",
+ "min_date": "If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned",
+ "min_id": "Minimum message ID to return",
+ "offset_id": "Only return messages starting from the specified message ID",
+ "peer": "User or chat, histories with which are searched, or (inputPeerEmpty) constructor to search in all private chats and normal groups (not channels) \u00bb. Use messages.searchGlobal to search globally in all chats, groups, supergroups and channels.",
+ "q": "Text search request",
+ "saved_peer_id": "Search within the saved message dialog \u00bb with this ID.",
+ "saved_reaction": "You may search for saved messages tagged \u00bb with one or more reactions using this flag.",
+ "top_msg_id": "Thread ID"
+ }
+ },
+ "messages.SearchCustomEmoji": {
+ "desc": "Look for custom emojis associated to a UTF8 emoji",
+ "params": {
+ "emoticon": "The emoji",
+ "hash": "Hash used for caching, for more info click here."
+ }
+ },
+ "messages.SearchEmojiStickerSets": {
+ "desc": "Search for custom emoji stickersets \u00bb",
+ "params": {
+ "exclude_featured": "Exclude featured stickersets from results",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here.",
+ "q": "Query string"
+ }
+ },
+ "messages.SearchGlobal": {
+ "desc": "Search for messages and peers globally",
+ "params": {
+ "broadcasts_only": "If set, only returns results from channels (used in the global channel search tab \u00bb).",
+ "filter": "Global search filter",
+ "flags": "Flags, see TL conditional fields",
+ "folder_id": "Peer folder ID, for more info click here",
+ "groups_only": "Whether to search only in groups",
+ "limit": "Offsets for pagination, for more info click here",
+ "max_date": "If a positive value was transferred, the method will return only messages with date smaller than max_date",
+ "min_date": "If a positive value was specified, the method will return only messages with date bigger than min_date",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "offset_peer": "Offsets for pagination, for more info click here",
+ "offset_rate": "Initially 0, then set to the next_rate parameter of messages.messagesSlice, or if that is absent, the date of the last returned message.",
+ "q": "Query",
+ "users_only": "Whether to search only in private chats"
+ }
+ },
+ "messages.SearchSentMedia": {
+ "desc": "View and search recently sent media.\nThis method does not support pagination.",
+ "params": {
+ "filter": "Message filter",
+ "limit": "Maximum number of results to return (max 100).",
+ "q": "Optional search query"
+ }
+ },
+ "messages.SearchStickerSets": {
+ "desc": "Search for stickersets",
+ "params": {
+ "exclude_featured": "Exclude featured stickersets from results",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here.",
+ "q": "Query string"
+ }
+ },
+ "messages.SearchStickers": {
+ "desc": "Search for stickers using AI-powered keyword search",
+ "params": {
+ "emojis": "If set, returns custom emoji stickers",
+ "emoticon": "Space-separated list of emojis to search for",
+ "flags": "Flags, see TL conditional fields",
+ "hash": "Hash used for caching, for more info click here. The hash may be generated locally by using the ids of the returned or stored sticker documents.",
+ "lang_code": "List of possible IETF language tags of the user's input language; may be empty if unknown",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination",
+ "q": "The search term"
+ }
+ },
+ "messages.SendBotRequestedPeer": {
+ "desc": "Send one or more chosen peers, as requested by a keyboardButtonRequestPeer button.",
+ "params": {
+ "button_id": "The button_id field from the keyboardButtonRequestPeer constructor.",
+ "msg_id": "ID of the message that contained the reply keyboard with the keyboardButtonRequestPeer button.",
+ "peer": "The bot that sent the keyboardButtonRequestPeer button.",
+ "requested_peers": "The chosen peers."
+ }
+ },
+ "messages.SendEncrypted": {
+ "desc": "Sends a text message to a secret chat.",
+ "params": {
+ "data": "TL-serialization of DecryptedMessage type, encrypted with a key that was created during chat initialization",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Secret chat ID",
+ "random_id": "Unique client message ID, necessary to avoid message resending",
+ "silent": "Send encrypted message without a notification"
+ }
+ },
+ "messages.SendEncryptedFile": {
+ "desc": "Sends a message with a file attachment to a secret chat",
+ "params": {
+ "data": "TL-serialization of DecryptedMessage type, encrypted with a key generated during chat initialization",
+ "file": "File attachment for the secret chat",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Secret chat ID",
+ "random_id": "Unique client message ID necessary to prevent message resending",
+ "silent": "Whether to send the file without triggering a notification"
+ }
+ },
+ "messages.SendEncryptedService": {
+ "desc": "Sends a service message to a secret chat.",
+ "params": {
+ "data": "TL-serialization of DecryptedMessage type, encrypted with a key generated during chat initialization",
+ "peer": "Secret chat ID",
+ "random_id": "Unique client message ID required to prevent message resending"
+ }
+ },
+ "messages.SendGroupCallEncryptedMessage": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.SendGroupCallMessage": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.SendInlineBotResult": {
+ "desc": "Send a result obtained using messages.getInlineBotResults.",
+ "params": {
+ "allow_paid_stars": "For paid messages \u00bb, specifies the amount of Telegram Stars the user has agreed to pay in order to send the message.",
+ "background": "Whether to send the message in background",
+ "clear_draft": "Whether to clear the draft",
+ "flags": "Flags, see TL conditional fields",
+ "hide_via": "Whether to hide the via @botname in the resulting message (only for bot usernames encountered in the config)",
+ "id": "Result ID from messages.getInlineBotResults",
+ "peer": "Destination",
+ "query_id": "Query ID from messages.getInlineBotResults",
+ "quick_reply_shortcut": "Add the message to the specified quick reply shortcut \u00bb, instead.",
+ "random_id": "Random ID to avoid resending the same query",
+ "reply_to": "If set, indicates that the message should be sent in reply to the specified message or story.",
+ "schedule_date": "Scheduled message date for scheduled messages",
+ "send_as": "Send this message as the specified peer",
+ "silent": "Whether to send the message silently (no notification will be triggered on the other client)"
+ }
+ },
+ "messages.SendMedia": {
+ "desc": "Send a media",
+ "params": {
+ "allow_paid_floodskip": "Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.",
+ "allow_paid_stars": "For paid messages \u00bb, specifies the amount of Telegram Stars the user has agreed to pay in order to send the message.",
+ "background": "Send message in background",
+ "clear_draft": "Clear the draft",
+ "effect": "Specifies a message effect \u00bb to use for the message.",
+ "entities": "Message entities for styled text",
+ "flags": "Flags, see TL conditional fields",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "media": "Attached media",
+ "message": "Caption",
+ "noforwards": "Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled",
+ "peer": "Destination",
+ "quick_reply_shortcut": "Add the message to the specified quick reply shortcut \u00bb, instead.",
+ "random_id": "Random ID to avoid resending the same message",
+ "reply_markup": "Reply markup for bot keyboards",
+ "reply_to": "If set, indicates that the message should be sent in reply to the specified message or story.",
+ "schedule_date": "Scheduled message date for scheduled messages",
+ "send_as": "Send this message as the specified peer",
+ "silent": "Send message silently (no notification should be triggered)",
+ "suggested_post": "Used to suggest a post to a channel, see here \u00bb for more info on the full flow.",
+ "update_stickersets_order": "Whether to move used stickersets to top, see here for more info on this flag \u00bb"
+ }
+ },
+ "messages.SendMessage": {
+ "desc": "Sends a message to a chat",
+ "params": {
+ "allow_paid_floodskip": "Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.",
+ "allow_paid_stars": "For paid messages \u00bb, specifies the amount of Telegram Stars the user has agreed to pay in order to send the message.",
+ "background": "Send this message as background message",
+ "clear_draft": "Clear the draft field",
+ "effect": "Specifies a message effect \u00bb to use for the message.",
+ "entities": "Message entities for sending styled text",
+ "flags": "Flags, see TL conditional fields",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "message": "The message",
+ "no_webpage": "Set this flag to disable generation of the webpage preview",
+ "noforwards": "Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled",
+ "peer": "The destination where the message will be sent",
+ "quick_reply_shortcut": "Add the message to the specified quick reply shortcut \u00bb, instead.",
+ "random_id": "Unique client message ID required to prevent message resending",
+ "reply_markup": "Reply markup for sending bot buttons",
+ "reply_to": "If set, indicates that the message should be sent in reply to the specified message or story. Also used to quote other messages.",
+ "schedule_date": "Scheduled message date for scheduled messages",
+ "send_as": "Send this message as the specified peer",
+ "silent": "Send this message silently (no notifications for the receivers)",
+ "suggested_post": "Used to suggest a post to a channel, see here \u00bb for more info on the full flow.",
+ "update_stickersets_order": "Whether to move used stickersets to top, see here for more info on this flag \u00bb"
+ }
+ },
+ "messages.SendMultiMedia": {
+ "desc": "Send an album or grouped media",
+ "params": {
+ "allow_paid_floodskip": "Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.",
+ "allow_paid_stars": "For paid messages \u00bb, specifies the amount of Telegram Stars the user has agreed to pay in order to send the message.",
+ "background": "Send in background?",
+ "clear_draft": "Whether to clear drafts",
+ "effect": "Specifies a message effect \u00bb to use for the message.",
+ "flags": "Flags, see TL conditional fields",
+ "invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
+ "multi_media": "The medias to send: note that they must be separately uploaded using messages.uploadMedia first, using raw inputMediaUploaded* constructors is not supported.",
+ "noforwards": "Only for bots, disallows forwarding and saving of the messages, even if the destination chat doesn't have content protection enabled",
+ "peer": "The destination chat",
+ "quick_reply_shortcut": "Add the message to the specified quick reply shortcut \u00bb, instead.",
+ "reply_to": "If set, indicates that the message should be sent in reply to the specified message or story.",
+ "schedule_date": "Scheduled message date for scheduled messages",
+ "send_as": "Send this message as the specified peer",
+ "silent": "Whether to send the album silently (no notification triggered)",
+ "update_stickersets_order": "Whether to move used stickersets to top, see here for more info on this flag \u00bb"
+ }
+ },
+ "messages.SendPaidReaction": {
+ "desc": "Sends one or more paid Telegram Star reactions \u00bb, transferring Telegram Stars \u00bb to a channel's balance.",
+ "params": {
+ "count": "The number of stars to send (each will increment the reaction counter by one).",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "The message to react to",
+ "peer": "The channel",
+ "private": "Each post with star reactions has a leaderboard with the top senders, but users can opt out of appearing there if they prefer more privacy. Not populating this field will use the default reaction privacy, stored on the server and synced to clients using updatePaidReactionPrivacy (see here for more info).",
+ "random_id": "Unique client message ID required to prevent message resending. Note: this argument must be composed of a 64-bit integer where the lower 32 bits are random, and the higher 32 bits are equal to the current unixtime, i.e. uint64_t random_id = (time() << 32) | ((uint64_t)random_uint32_t()): this differs from the random_id format of all other methods in the API, which just take 64 random bits."
+ }
+ },
+ "messages.SendQuickReplyMessages": {
+ "desc": "Send a quick reply shortcut \u00bb.",
+ "params": {
+ "id": "Specify a subset of messages from the shortcut to send; if empty, defaults to all of them.",
+ "peer": "The peer where to send the shortcut (users only, for now).",
+ "random_id": "Unique client IDs required to prevent message resending, one for each message we're sending, may be empty (but not recommended).",
+ "shortcut_id": "The ID of the quick reply shortcut to send."
+ }
+ },
+ "messages.SendReaction": {
+ "desc": "React to message.",
+ "params": {
+ "add_to_recent": "Whether to add this reaction to the recent reactions list \u00bb.",
+ "big": "Whether a bigger and longer reaction should be shown",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Message ID to react to",
+ "peer": "Peer",
+ "reaction": "A list of reactions (doesn't accept reactionPaid constructors, use messages.sendPaidReaction to send paid reactions, instead)."
+ }
+ },
+ "messages.SendScheduledMessages": {
+ "desc": "Send scheduled messages right away",
+ "params": {
+ "id": "Scheduled message IDs",
+ "peer": "Peer"
+ }
+ },
+ "messages.SendScreenshotNotification": {
+ "desc": "Notify the other user in a private chat that a screenshot of the chat was taken",
+ "params": {
+ "peer": "Other user",
+ "random_id": "Random ID to avoid message resending",
+ "reply_to": "Indicates the message that was screenshotted (the specified message ID can also be 0 to avoid indicating any specific message)."
+ }
+ },
+ "messages.SendVote": {
+ "desc": "Vote in a poll",
+ "params": {
+ "msg_id": "The message ID of the poll",
+ "options": "The options that were chosen",
+ "peer": "The chat where the poll was sent"
+ }
+ },
+ "messages.SendWebViewData": {
+ "desc": "Used by the user to relay data from an opened reply keyboard bot mini app to the bot that owns it.",
+ "params": {
+ "bot": "Bot that owns the web app",
+ "button_text": "Text of the keyboardButtonSimpleWebView that was pressed to open the web app.",
+ "data": "Data to relay to the bot, obtained from a web_app_data_send JS event.",
+ "random_id": "Unique client message ID to prevent duplicate sending of the same event"
+ }
+ },
+ "messages.SendWebViewResultMessage": {
+ "desc": "Terminate webview interaction started with messages.requestWebView, sending the specified message to the chat on behalf of the user.",
+ "params": {
+ "bot_query_id": "Webview interaction ID obtained from messages.requestWebView",
+ "result": "Message to send"
+ }
+ },
+ "messages.SetBotCallbackAnswer": {
+ "desc": "Set the callback answer to a user button press (bots only)",
+ "params": {
+ "alert": "Whether to show the message as a popup instead of a toast notification",
+ "cache_time": "Cache validity",
+ "flags": "Flags, see TL conditional fields",
+ "message": "Popup to show",
+ "query_id": "Query ID",
+ "url": "URL to open"
+ }
+ },
+ "messages.SetBotPrecheckoutResults": {
+ "desc": "Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update.\nUse this method to respond to such pre-checkout queries.\nNote: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent.",
+ "params": {
+ "error": "Required if the success isn't set. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user.",
+ "flags": "Flags, see TL conditional fields",
+ "query_id": "Unique identifier for the query to be answered",
+ "success": "Set this flag if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order, otherwise do not set it, and set the error field, instead"
+ }
+ },
+ "messages.SetBotShippingResults": {
+ "desc": "If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries.",
+ "params": {
+ "error": "Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable\"). Telegram will display this message to the user.",
+ "flags": "Flags, see TL conditional fields",
+ "query_id": "Unique identifier for the query to be answered",
+ "shipping_options": "A vector of available shipping options."
+ }
+ },
+ "messages.SetChatAvailableReactions": {
+ "desc": "Change the set of message reactions \u00bb that can be used in a certain group, supergroup or channel",
+ "params": {
+ "available_reactions": "Allowed reaction emojis",
+ "flags": "Flags, see TL conditional fields",
+ "paid_enabled": "If this flag is set and a Bool is passed, the method will enable or disable paid message reactions \u00bb. If this flag is not set, the previously stored setting will not be changed.",
+ "peer": "Group where to apply changes",
+ "reactions_limit": "This flag may be used to impose a custom limit of unique reactions (i.e. a customizable version of appConfig.reactions_uniq_max); this field and the other info set by the method will then be available to users in channelFull and chatFull. If this flag is not set, the previously configured reactions_limit will not be altered."
+ }
+ },
+ "messages.SetChatTheme": {
+ "desc": "Change the chat theme of a certain chat, see here \u00bb for more info.",
+ "params": {
+ "peer": "Private chat where to change theme",
+ "theme": "The theme to set."
+ }
+ },
+ "messages.SetChatWallPaper": {
+ "desc": "Set a custom wallpaper \u00bb in a specific private chat with another user.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "for_both": "Only for Premium users, sets the specified wallpaper for both users of the chat, without requiring confirmation from the other user.",
+ "id": "If the wallpaper was obtained from a messageActionSetChatWallPaper service message, must contain the ID of that message.",
+ "peer": "The private chat where the wallpaper will be set",
+ "revert": "If we don't like the new wallpaper the other user of the chat has chosen for us using the for_both flag, we can re-set our previous wallpaper just on our side using this flag.",
+ "settings": "Wallpaper settings, obtained as described in the wallpaper documentation \u00bb or from messageActionSetChatWallPaper.wallpaper.settings.",
+ "wallpaper": "The wallpaper \u00bb, obtained as described in the wallpaper documentation \u00bb; must not be provided when installing a wallpaper obtained from a messageActionSetChatWallPaper service message (id must be provided, instead)."
+ }
+ },
+ "messages.SetDefaultHistoryTTL": {
+ "desc": "Changes the default value of the Time-To-Live setting, applied to all new chats.",
+ "params": {
+ "period": "The new default Time-To-Live of all messages sent in new chats, in seconds."
+ }
+ },
+ "messages.SetDefaultReaction": {
+ "desc": "Change default emoji reaction to use in the quick reaction menu: the value is synced across devices and can be fetched using help.getConfig, reactions_default field.",
+ "params": {
+ "reaction": "New emoji reaction"
+ }
+ },
+ "messages.SetEncryptedTyping": {
+ "desc": "Send typing event by the current user to a secret chat.",
+ "params": {
+ "peer": "Secret chat ID",
+ "typing": "Typing.Possible values:(boolTrue), if the user started typing and more than 5 seconds have passed since the last request(boolFalse), if the user stopped typing"
+ }
+ },
+ "messages.SetGameScore": {
+ "desc": "Use this method to set the score of the specified user in a game sent as a normal message (bots only).",
+ "params": {
+ "edit_message": "Set this flag if the game message should be automatically edited to include the current scoreboard",
+ "flags": "Flags, see TL conditional fields",
+ "force": "Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters",
+ "id": "Identifier of the sent message",
+ "peer": "Unique identifier of target chat",
+ "score": "New score",
+ "user_id": "User identifier"
+ }
+ },
+ "messages.SetHistoryTTL": {
+ "desc": "Set maximum Time-To-Live of all messages in the specified chat",
+ "params": {
+ "peer": "The dialog",
+ "period": "Automatically delete all messages sent in the chat after this many seconds"
+ }
+ },
+ "messages.SetInlineBotResults": {
+ "desc": "Answer an inline query, for bots only",
+ "params": {
+ "cache_time": "The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.",
+ "flags": "Flags, see TL conditional fields",
+ "gallery": "Set this flag if the results are composed of media files",
+ "next_offset": "Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.",
+ "private": "Set this flag if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
+ "query_id": "Unique identifier for the answered query",
+ "results": "Vector of results for the inline query",
+ "switch_pm": "If passed, clients will display a button on top of the remaining inline result list with the specified text, that switches the user to a private chat with the bot and sends the bot a start message with a certain parameter.",
+ "switch_webview": "If passed, clients will display a button on top of the remaining inline result list with the specified text, that switches the user to the specified inline mode mini app."
+ }
+ },
+ "messages.SetInlineGameScore": {
+ "desc": "Use this method to set the score of the specified user in a game sent as an inline message (bots only).",
+ "params": {
+ "edit_message": "Set this flag if the game message should be automatically edited to include the current scoreboard",
+ "flags": "Flags, see TL conditional fields",
+ "force": "Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters",
+ "id": "ID of the inline message",
+ "score": "New score",
+ "user_id": "User identifier"
+ }
+ },
+ "messages.SetTyping": {
+ "desc": "Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group.",
+ "params": {
+ "action": "Type of action",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Target user or group",
+ "top_msg_id": "Topic ID"
+ }
+ },
+ "messages.SetWebViewResult": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.StartBot": {
+ "desc": "Start a conversation with a bot using a deep linking parameter",
+ "params": {
+ "bot": "The bot",
+ "peer": "The chat where to start the bot, can be the bot's private chat or a group",
+ "random_id": "Random ID to avoid resending the same message",
+ "start_param": "Deep linking parameter"
+ }
+ },
+ "messages.StartHistoryImport": {
+ "desc": "Complete the history import process, importing all messages into the chat.\nTo be called only after initializing the import with messages.initHistoryImport and uploading all files using messages.uploadImportedMedia.",
+ "params": {
+ "import_id": "Identifier of a history import session, returned by messages.initHistoryImport.",
+ "peer": "The Telegram chat where the messages should be imported, click here for more info \u00bb"
+ }
+ },
+ "messages.ToggleBotInAttachMenu": {
+ "desc": "Enable or disable web bot attachment menu \u00bb",
+ "params": {
+ "bot": "Bot ID",
+ "enabled": "Toggle",
+ "flags": "Flags, see TL conditional fields",
+ "write_allowed": "Whether the user authorizes the bot to write messages to them, if requested by attachMenuBot.request_write_access"
+ }
+ },
+ "messages.ToggleDialogFilterTags": {
+ "desc": "Enable or disable folder tags \u00bb.",
+ "params": {
+ "enabled": "Enable or disable folder tags."
+ }
+ },
+ "messages.ToggleDialogPin": {
+ "desc": "Pin/unpin a dialog",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The dialog to pin",
+ "pinned": "Whether to pin or unpin the dialog"
+ }
+ },
+ "messages.ToggleGroupCallSettings": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.ToggleNoForwards": {
+ "desc": "Enable or disable content protection on a channel or chat",
+ "params": {
+ "enabled": "Enable or disable content protection",
+ "peer": "The chat or channel"
+ }
+ },
+ "messages.TogglePaidReactionPrivacy": {
+ "desc": "Changes the privacy of already sent paid reactions on a specific message.",
+ "params": {
+ "msg_id": "The ID of the message to which we sent the paid reactions",
+ "peer": "The channel",
+ "private": "If true, makes the current anonymous in the top sender leaderboard for this message; otherwise, does the opposite."
+ }
+ },
+ "messages.TogglePeerTranslations": {
+ "desc": "Show or hide the real-time chat translation popup for a certain chat",
+ "params": {
+ "disabled": "Whether to disable or enable the real-time chat translation popup",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer"
+ }
+ },
+ "messages.ToggleSavedDialogPin": {
+ "desc": "Pin or unpin a saved message dialog \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The dialog to pin",
+ "pinned": "Whether to pin or unpin the dialog"
+ }
+ },
+ "messages.ToggleStickerSets": {
+ "desc": "Apply changes to multiple stickersets",
+ "params": {
+ "archive": "Archive the specified stickersets",
+ "flags": "Flags, see TL conditional fields",
+ "stickersets": "Stickersets to act upon",
+ "unarchive": "Unarchive the specified stickersets",
+ "uninstall": "Uninstall the specified stickersets"
+ }
+ },
+ "messages.ToggleSuggestedPostApproval": {
+ "desc": "Approve or reject a suggested post \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "ID of the suggestion message.",
+ "peer": "Both for users and channels, must contain the ID of the direct messages monoforum \u00bb (for channels, the topic ID is extracted automatically from the msg_id).",
+ "reject": "Reject the suggested post.",
+ "reject_comment": "Optional comment for rejections (can only be used if reject is set).",
+ "schedule_date": "Custom scheduling date."
+ }
+ },
+ "messages.ToggleTodoCompleted": {
+ "desc": "Mark one or more items of a todo list \u00bb as completed or not completed.",
+ "params": {
+ "completed": "Items to mark as completed.",
+ "incompleted": "Items to mark as not completed.",
+ "msg_id": "ID of the message with the todo list.",
+ "peer": "Peer where the todo list was posted."
+ }
+ },
+ "messages.TranscribeAudio": {
+ "desc": "Transcribe voice message",
+ "params": {
+ "msg_id": "Voice message ID",
+ "peer": "Peer ID where the voice message was sent"
+ }
+ },
+ "messages.TranslateText": {
+ "desc": "Translate a given text.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "A list of message IDs to translate",
+ "peer": "If the text is a chat message, the peer ID",
+ "text": "A list of styled messages to translate",
+ "to_lang": "Two-letter ISO 639-1 language code of the language to which the message is translated"
+ }
+ },
+ "messages.UninstallStickerSet": {
+ "desc": "Uninstall a stickerset",
+ "params": {
+ "stickerset": "The stickerset to uninstall"
+ }
+ },
+ "messages.UnpinAllMessages": {
+ "desc": "Unpin all pinned messages",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Chat where to unpin",
+ "saved_peer_id": "If set, must be equal to the ID of a monoforum topic, and will unpin all messages pinned in the passed monoforum topic.",
+ "top_msg_id": "Forum topic where to unpin"
+ }
+ },
+ "messages.UpdateColor": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.UpdateContactNote": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.UpdateDialogFilter": {
+ "desc": "Update folder",
+ "params": {
+ "filter": "Folder info",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Folder ID"
+ }
+ },
+ "messages.UpdateDialogFiltersOrder": {
+ "desc": "Reorder folders",
+ "params": {
+ "order": "New folder order"
+ }
+ },
+ "messages.UpdatePinnedForumTopic": {
+ "desc": "",
+ "params": {}
+ },
+ "messages.UpdatePinnedMessage": {
+ "desc": "Pin a message",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "The message to pin or unpin",
+ "peer": "The peer where to pin the message",
+ "pm_oneside": "Whether the message should only be pinned on the local side of a one-to-one chat",
+ "silent": "Pin the message silently, without triggering a notification",
+ "unpin": "Whether the message should unpinned or pinned"
+ }
+ },
+ "messages.UpdateSavedReactionTag": {
+ "desc": "Update the description of a saved message tag \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "reaction": "Reaction associated to the tag",
+ "title": "Tag description, max 12 UTF-8 characters; to remove the description call the method without setting this flag."
+ }
+ },
+ "messages.UploadEncryptedFile": {
+ "desc": "Upload encrypted file and associate it to a secret chat (without actually sending it to the chat).",
+ "params": {
+ "file": "The file",
+ "peer": "The secret chat to associate the file to"
+ }
+ },
+ "messages.UploadImportedMedia": {
+ "desc": "Upload a media file associated with an imported chat, click here for more info \u00bb.",
+ "params": {
+ "file_name": "File name",
+ "import_id": "Identifier of a history import session, returned by messages.initHistoryImport",
+ "media": "Media metadata",
+ "peer": "The Telegram chat where the media will be imported"
+ }
+ },
+ "messages.UploadMedia": {
+ "desc": "Upload a file and associate it to a chat (without actually sending it to the chat)",
+ "params": {
+ "business_connection_id": "Whether the media will be used only in the specified business connection \u00bb, and not directly by the bot.",
+ "flags": "Flags, see TL conditional fields",
+ "media": "File uploaded in chunks as described in files \u00bb",
+ "peer": "The chat, can be inputPeerEmpty for bots and inputPeerSelf for users."
+ }
+ },
+ "messages.ViewSponsoredMessage": {
+ "desc": "Mark a specific sponsored message \u00bb as read",
+ "params": {
+ "random_id": "The ad's unique ID."
+ }
+ },
+ "payments.ApplyGiftCode": {
+ "desc": "Apply a Telegram Premium giftcode \u00bb",
+ "params": {
+ "slug": "The code to apply"
+ }
+ },
+ "payments.AssignAppStoreTransaction": {
+ "desc": "Informs server about a purchase made through the App Store: for official applications only.",
+ "params": {
+ "purpose": "Payment purpose",
+ "receipt": "Receipt"
+ }
+ },
+ "payments.AssignPlayMarketTransaction": {
+ "desc": "Informs server about a purchase made through the Play Store: for official applications only.",
+ "params": {
+ "purpose": "Payment purpose",
+ "receipt": "Receipt"
+ }
+ },
+ "payments.BotCancelStarsSubscription": {
+ "desc": "Cancel a bot subscription",
+ "params": {
+ "charge_id": "The provider_charge_id from the messageActionPaymentSentMe service message sent to the bot for the first subscription payment.",
+ "flags": "Flags, see TL conditional fields",
+ "restore": "If not set, disables autorenewal of the subscriptions, and prevents the user from reactivating the subscription once the current period expires: a subscription cancelled by the bot will have the starsSubscription.bot_canceled flag set. The bot can can partially undo this operation by setting this flag: this will allow the user to reactivate the subscription.",
+ "user_id": "The ID of the user whose subscription should be (un)cancelled"
+ }
+ },
+ "payments.CanPurchaseStore": {
+ "desc": "Checks whether a purchase is possible. Must be called before in-store purchase, official apps only.",
+ "params": {
+ "purpose": "Payment purpose."
+ }
+ },
+ "payments.ChangeStarsSubscription": {
+ "desc": "Activate or deactivate a Telegram Star subscription \u00bb.",
+ "params": {
+ "canceled": "Whether to cancel or reactivate the subscription.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Always pass inputPeerSelf.",
+ "subscription_id": "ID of the subscription."
+ }
+ },
+ "payments.CheckCanSendGift": {
+ "desc": "Check if the specified gift \u00bb can be sent.",
+ "params": {
+ "gift_id": "Gift ID."
+ }
+ },
+ "payments.CheckGiftCode": {
+ "desc": "Obtain information about a Telegram Premium giftcode \u00bb",
+ "params": {
+ "slug": "The giftcode to check"
+ }
+ },
+ "payments.ClearSavedInfo": {
+ "desc": "Clear saved payment information",
+ "params": {
+ "credentials": "Remove saved payment credentials",
+ "flags": "Flags, see TL conditional fields",
+ "info": "Clear the last order settings saved by the user"
+ }
+ },
+ "payments.ConnectStarRefBot": {
+ "desc": "Join a bot's affiliate program, becoming an affiliate \u00bb",
+ "params": {
+ "bot": "The bot that offers the affiliate program",
+ "peer": "The peer that will become the affiliate: star commissions will be transferred to this peer's star balance."
+ }
+ },
+ "payments.ConvertStarGift": {
+ "desc": "Convert a received gift \u00bb into Telegram Stars: this will permanently destroy the gift, converting it into starGift.convert_stars Telegram Stars, added to the user's balance.",
+ "params": {
+ "stargift": "The gift to convert."
+ }
+ },
+ "payments.CreateStarGiftCollection": {
+ "desc": "Create a star gift collection \u00bb.",
+ "params": {
+ "peer": "Peer where to create the collection.",
+ "stargift": "Gifts added to the collection.",
+ "title": "Title of the collection."
+ }
+ },
+ "payments.DeleteStarGiftCollection": {
+ "desc": "Delete a star gift collection \u00bb.",
+ "params": {
+ "collection_id": "ID of the collection.",
+ "peer": "Peer that owns the collection."
+ }
+ },
+ "payments.EditConnectedStarRefBot": {
+ "desc": "Leave a bot's affiliate program \u00bb",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "link": "The affiliate link to revoke",
+ "peer": "The peer that was affiliated",
+ "revoked": "If set, leaves the bot's affiliate program"
+ }
+ },
+ "payments.ExportInvoice": {
+ "desc": "Generate an invoice deep link",
+ "params": {
+ "invoice_media": "Invoice"
+ }
+ },
+ "payments.FulfillStarsSubscription": {
+ "desc": "Re-join a private channel associated to an active Telegram Star subscription \u00bb.",
+ "params": {
+ "peer": "Always pass inputPeerSelf.",
+ "subscription_id": "ID of the subscription."
+ }
+ },
+ "payments.GetBankCardData": {
+ "desc": "Get info about a credit card",
+ "params": {
+ "number": "Credit card number"
+ }
+ },
+ "payments.GetConnectedStarRefBot": {
+ "desc": "Fetch info about a specific bot affiliation \u00bb",
+ "params": {
+ "bot": "The bot that offers the affiliate program",
+ "peer": "The affiliated peer"
+ }
+ },
+ "payments.GetConnectedStarRefBots": {
+ "desc": "Fetch all affiliations we have created for a certain peer",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_date": "If set, returns only results older than the specified unixtime",
+ "offset_link": "Offset for pagination, taken from the last returned connectedBotStarRef.url (initially empty)",
+ "peer": "The affiliated peer"
+ }
+ },
+ "payments.GetGiveawayInfo": {
+ "desc": "Obtain information about a Telegram Premium giveaway \u00bb.",
+ "params": {
+ "msg_id": "Message ID of the messageActionGiveawayLaunch service message",
+ "peer": "The peer where the giveaway was posted."
+ }
+ },
+ "payments.GetPaymentForm": {
+ "desc": "Get a payment form",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "invoice": "Invoice",
+ "theme_params": "Theme parameters \u00bb"
+ }
+ },
+ "payments.GetPaymentReceipt": {
+ "desc": "Get payment receipt",
+ "params": {
+ "msg_id": "Message ID of receipt",
+ "peer": "The peer where the payment receipt was sent"
+ }
+ },
+ "payments.GetPremiumGiftCodeOptions": {
+ "desc": "Obtain a list of Telegram Premium giveaway/gift code \u00bb options.",
+ "params": {
+ "boost_peer": "The channel that will start the giveaway",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "payments.GetResaleStarGifts": {
+ "desc": "Get collectible gifts of a specific type currently on resale, see here \u00bb for more info.",
+ "params": {
+ "attributes": "Optionally filter gifts with the specified attributes. If no attributes of a specific type are specified, all attributes of that type are allowed.",
+ "attributes_hash": "If a previous call to the method was made and payments.resaleStarGifts.attributes_hash was set, pass it here to avoid returning any results if they haven't changed. Otherwise, set this flag and pass 0 to return payments.resaleStarGifts.attributes_hash and payments.resaleStarGifts.attributes, these two fields will not be set if this flag is not set.",
+ "flags": "Flags, see TL conditional fields",
+ "gift_id": "Mandatory identifier of the base gift from which the collectible gift was upgraded.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination. If not equal to an empty string, payments.resaleStarGifts.counters will not be set to avoid returning the counters every time a new page is fetched.",
+ "sort_by_num": "Sort gifts by number (ascending).",
+ "sort_by_price": "Sort gifts by price (ascending)."
+ }
+ },
+ "payments.GetSavedInfo": {
+ "desc": "Get saved payment information",
+ "params": {}
+ },
+ "payments.GetSavedStarGift": {
+ "desc": "Fetch info about specific gifts owned by a peer we control.",
+ "params": {
+ "stargift": "List of gifts to fetch info about."
+ }
+ },
+ "payments.GetSavedStarGifts": {
+ "desc": "Fetch the full list of gifts owned by a peer.",
+ "params": {
+ "collection_id": "Only returns gifts within the specified collection \u00bb.",
+ "exclude_saved": "Exclude gifts pinned on the profile.",
+ "exclude_unique": "Exclude collectible gifts \u00bb.",
+ "exclude_unlimited": "Exclude gifts that do not have the starGift.limited flag set.",
+ "exclude_unsaved": "Exclude gifts not pinned on the profile.",
+ "exclude_unupgradable": "Exclude gifts that cannot be upgraded to collectible gifts \u00bb.",
+ "exclude_upgradable": "Exclude gifts that can be upgraded to collectible gifts \u00bb.",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination.",
+ "peer": "Fetch only gifts owned by the specified peer, such as: a user, with peer=inputPeerUser; a channel, with peer=inputPeerChannel; a connected business user (when executing the method as a bot, over the business connection), with peer=inputPeerUser.",
+ "sort_by_value": "If set, sorts the gifts by price instead of reception date."
+ }
+ },
+ "payments.GetStarGiftCollections": {
+ "desc": "Fetches all star gift collections \u00bb of a peer.",
+ "params": {
+ "hash": "Hash (generated as specified here \u00bb) using the starGiftCollection.hash field (not the collection_id field) of all collections returned by a previous method call, to avoid refetching the result if it hasn't changed.",
+ "peer": "The peer."
+ }
+ },
+ "payments.GetStarGiftUpgradePreview": {
+ "desc": "Obtain a preview of the possible attributes (chosen randomly) a gift \u00bb can receive after upgrading it to a collectible gift \u00bb, see here \u00bb for more info.",
+ "params": {
+ "gift_id": "The gift to upgrade."
+ }
+ },
+ "payments.GetStarGiftWithdrawalUrl": {
+ "desc": "Convert a collectible gift \u00bb to an NFT on the TON blockchain.",
+ "params": {
+ "password": "The current user's 2FA password, passed as specified here \u00bb.",
+ "stargift": "The collectible gift to export."
+ }
+ },
+ "payments.GetStarGifts": {
+ "desc": "Get a list of available gifts, see here \u00bb for more info.",
+ "params": {
+ "hash": "Hash used for caching, for more info click here.The hash may be generated locally by using the ids of the returned or stored sticker starGifts."
+ }
+ },
+ "payments.GetStarsGiftOptions": {
+ "desc": "Obtain a list of Telegram Stars gift options \u00bb as starsGiftOption constructors.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "user_id": "Receiver of the gift (optional)."
+ }
+ },
+ "payments.GetStarsGiveawayOptions": {
+ "desc": "Fetch a list of star giveaway options \u00bb.",
+ "params": {}
+ },
+ "payments.GetStarsRevenueAdsAccountUrl": {
+ "desc": "Returns a URL for a Telegram Ad platform account that can be used to set up advertisements for channel/bot in peer, paid using the Telegram Stars owned by the specified peer, see here \u00bb for more info.",
+ "params": {
+ "peer": "Channel or bot that owns the stars."
+ }
+ },
+ "payments.GetStarsRevenueStats": {
+ "desc": "Get Telegram Star revenue statistics \u00bb.",
+ "params": {
+ "dark": "Whether to enable dark theme for graph colors",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Get statistics for the specified bot, channel or ourselves (inputPeerSelf).",
+ "ton": "If set, fetches channel/bot ad revenue statistics in TON."
+ }
+ },
+ "payments.GetStarsRevenueWithdrawalUrl": {
+ "desc": "Withdraw funds from a channel or bot's star balance \u00bb.",
+ "params": {
+ "amount": "The amount of stars or nanotons to withdraw.",
+ "flags": "Flags, see TL conditional fields",
+ "password": "2FA password, see here \u00bb for more info.",
+ "peer": "Channel or bot from which to withdraw funds.",
+ "ton": "If set, withdraws channel/ad revenue in TON."
+ }
+ },
+ "payments.GetStarsStatus": {
+ "desc": "Get the current Telegram Stars balance of the current account (with peer=inputPeerSelf), or the stars balance of the bot specified in peer.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Peer of which to get the balance.",
+ "ton": "If set, returns the channel/ad revenue balance in nanotons."
+ }
+ },
+ "payments.GetStarsSubscriptions": {
+ "desc": "Obtain a list of active, expired or cancelled Telegram Star subscriptions \u00bb.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "missing_balance": "Whether to return only subscriptions expired due to an excessively low Telegram Star balance.",
+ "offset": "Offset for pagination, taken from payments.starsStatus.subscriptions_next_offset.",
+ "peer": "Always pass inputPeerSelf."
+ }
+ },
+ "payments.GetStarsTopupOptions": {
+ "desc": "Obtain a list of Telegram Stars topup options \u00bb as starsTopupOption constructors.",
+ "params": {}
+ },
+ "payments.GetStarsTransactions": {
+ "desc": "Fetch Telegram Stars transactions.",
+ "params": {
+ "ascending": "Return transactions in ascending order by date (instead of descending order by date).",
+ "flags": "Flags, see TL conditional fields",
+ "inbound": "If set, fetches only incoming transactions.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, obtained from the returned next_offset, initially an empty string \u00bb.",
+ "outbound": "If set, fetches only outgoing transactions.",
+ "peer": "Fetch the transaction history of the peer (inputPeerSelf or a bot we own).",
+ "subscription_id": "If set, fetches only transactions for the specified Telegram Star subscription \u00bb.",
+ "ton": "If set, returns the channel/ad revenue transactions in nanotons, instead."
+ }
+ },
+ "payments.GetStarsTransactionsByID": {
+ "desc": "Obtain info about Telegram Star transactions \u00bb using specific transaction IDs.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "id": "Transaction IDs.",
+ "peer": "Channel or bot.",
+ "ton": "If set, returns channel/bot ad revenue transactions in nanotons."
+ }
+ },
+ "payments.GetSuggestedStarRefBots": {
+ "desc": "Obtain a list of suggested mini apps with available affiliate programs",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, taken from payments.suggestedStarRefBots.next_offset, initially empty.",
+ "order_by_date": "If set, orders results by the creation date of the affiliate program",
+ "order_by_revenue": "If set, orders results by the expected revenue",
+ "peer": "The peer that will become the affiliate: star commissions will be transferred to this peer's star balance."
+ }
+ },
+ "payments.GetUniqueStarGift": {
+ "desc": "Obtain info about a collectible gift \u00bb using a slug obtained from a collectible gift link \u00bb.",
+ "params": {
+ "slug": "The slug."
+ }
+ },
+ "payments.GetUniqueStarGiftValueInfo": {
+ "desc": "Get information about the value of a collectible gift \u00bb.",
+ "params": {
+ "slug": "slug from a starGiftUnique."
+ }
+ },
+ "payments.LaunchPrepaidGiveaway": {
+ "desc": "Launch a prepaid giveaway \u00bb.",
+ "params": {
+ "giveaway_id": "The prepaid giveaway ID.",
+ "peer": "The peer where to launch the giveaway.",
+ "purpose": "Giveway parameters"
+ }
+ },
+ "payments.RefundStarsCharge": {
+ "desc": "Refund a Telegram Stars transaction, see here \u00bb for more info.",
+ "params": {
+ "charge_id": "Transaction ID.",
+ "user_id": "User to refund."
+ }
+ },
+ "payments.ReorderStarGiftCollections": {
+ "desc": "Reorder the star gift collections \u00bb on an owned peer's profile.",
+ "params": {
+ "order": "New collection order.",
+ "peer": "The owned peer."
+ }
+ },
+ "payments.RequestRecurringPayment": {
+ "desc": "{schema}",
+ "params": {
+ "invoice_media": "",
+ "recurring_init_charge": "",
+ "user_id": ""
+ }
+ },
+ "payments.SaveStarGift": {
+ "desc": "Display or remove a received gift \u00bb from our profile.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "stargift": "The gift to display or remove.",
+ "unsave": "If set, hides the gift from our profile."
+ }
+ },
+ "payments.SendPaymentForm": {
+ "desc": "Send compiled payment form",
+ "params": {
+ "credentials": "Payment credentials",
+ "flags": "Flags, see TL conditional fields",
+ "form_id": "Form ID",
+ "invoice": "Invoice",
+ "requested_info_id": "ID of saved and validated order info",
+ "shipping_option_id": "Chosen shipping option ID",
+ "tip_amount": "Tip, in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
+ }
+ },
+ "payments.SendStarsForm": {
+ "desc": "Make a payment using Telegram Stars, see here \u00bb for more info.",
+ "params": {
+ "form_id": "Payment form ID",
+ "invoice": "Invoice"
+ }
+ },
+ "payments.ToggleChatStarGiftNotifications": {
+ "desc": "Enables or disables the reception of notifications every time a gift \u00bb is received by the specified channel, can only be invoked by admins with post_messages admin rights.",
+ "params": {
+ "enabled": "Whether to enable or disable reception of notifications in the form of messageActionStarGiftUnique and messageActionStarGift service messages from the channel.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The channel for which to receive or not receive notifications."
+ }
+ },
+ "payments.ToggleStarGiftsPinnedToTop": {
+ "desc": "Pins a received gift on top of the profile of the user or owned channels by using payments.toggleStarGiftsPinnedToTop.",
+ "params": {
+ "peer": "The peer where to pin the gift.",
+ "stargift": "The gift to pin."
+ }
+ },
+ "payments.TransferStarGift": {
+ "desc": "Transfer a collectible gift to another user or channel: can only be used if transfer is free (i.e. messageActionStarGiftUnique.transfer_stars is not set); see here \u00bb for more info on the full flow (including the different flow to use in case the transfer isn't free).",
+ "params": {
+ "stargift": "The gift to transfer.",
+ "to_id": "Destination peer."
+ }
+ },
+ "payments.UpdateStarGiftCollection": {
+ "desc": "Add or remove gifts from a star gift collection \u00bb, or rename the collection.",
+ "params": {
+ "add_stargift": "Can contain a list of gifts to add to the collection.",
+ "collection_id": "Collection ID.",
+ "delete_stargift": "Can contain a list of gifts to remove from the collection.",
+ "flags": "Flags, see TL conditional fields",
+ "order": "Can contain the new gift order.",
+ "peer": "Peer that owns the collection.",
+ "title": "Title of the collection, to rename the collection."
+ }
+ },
+ "payments.UpdateStarGiftPrice": {
+ "desc": "A collectible gift we own \u00bb can be put up for sale on the gift marketplace \u00bb with this method, see here \u00bb for more info.",
+ "params": {
+ "resell_amount": "Resale price of the gift.",
+ "stargift": "The gift to resell."
+ }
+ },
+ "payments.UpgradeStarGift": {
+ "desc": "Upgrade a gift to a collectible gift: can only be used if the upgrade was already paid by the gift sender; see here \u00bb for more info on the full flow (including the different flow to use in case the upgrade was not paid by the gift sender).",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "keep_original_details": "Set this flag to keep the original gift text, sender and receiver in the upgraded gift as a starGiftAttributeOriginalDetails attribute.",
+ "stargift": "The gift to upgrade"
+ }
+ },
+ "payments.ValidateRequestedInfo": {
+ "desc": "Submit requested order information for validation",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "info": "Requested order information",
+ "invoice": "Invoice",
+ "save": "Save order information to re-use it for future orders"
+ }
+ },
+ "phone.AcceptCall": {
+ "desc": "Accept incoming call",
+ "params": {
+ "g_b": "Parameter for E2E encryption key exchange \u00bb",
+ "peer": "The call to accept",
+ "protocol": "Phone call settings"
+ }
+ },
+ "phone.CheckGroupCall": {
+ "desc": "Check whether the group call Server Forwarding Unit is currently receiving the streams with the specified WebRTC source IDs.\nReturns an intersection of the source IDs specified in sources, and the source IDs currently being forwarded by the SFU.",
+ "params": {
+ "call": "Group call",
+ "sources": "Source IDs"
+ }
+ },
+ "phone.ConfirmCall": {
+ "desc": "Complete phone call E2E encryption key exchange \u00bb",
+ "params": {
+ "g_a": "Parameter for E2E encryption key exchange \u00bb",
+ "key_fingerprint": "Key fingerprint",
+ "peer": "The phone call",
+ "protocol": "Phone call settings"
+ }
+ },
+ "phone.CreateConferenceCall": {
+ "desc": "Create and optionally join a new conference call.",
+ "params": {
+ "block": "Initial blockchain block (can only be used if join is set).",
+ "flags": "Flags, see TL conditional fields",
+ "join": "If set, also join the call, otherwise just create the call link.",
+ "muted": "If set, mute our microphone when joining the call (can only be used if join is set).",
+ "params": "Parameters from tgcalls (can only be used if join is set).",
+ "public_key": "Public key (can only be used if join is set).",
+ "random_id": "Unique client message ID required to prevent creation of duplicate group calls.",
+ "video_stopped": "If set, our video stream is disabled (can only be used if join is set)."
+ }
+ },
+ "phone.CreateGroupCall": {
+ "desc": "Create a group call or livestream",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "Associate the group call or livestream to the provided group/supergroup/channel",
+ "random_id": "Unique client message ID required to prevent creation of duplicate group calls",
+ "rtmp_stream": "Whether RTMP stream support should be enabled: only the group/supergroup/channel owner can use this flag.",
+ "schedule_date": "For scheduled group call or livestreams, the absolute date when the group call will start",
+ "title": "Call title"
+ }
+ },
+ "phone.DeclineConferenceCallInvite": {
+ "desc": "Declines a conference call invite.",
+ "params": {
+ "msg_id": "The ID of the messageActionConferenceCall to decline."
+ }
+ },
+ "phone.DeleteConferenceCallParticipants": {
+ "desc": "Remove participants from a conference call.",
+ "params": {
+ "block": "The block containing an appropriate e2e.chain.changeSetGroupState event",
+ "call": "The conference call.",
+ "flags": "Flags, see TL conditional fields",
+ "ids": "IDs of users to remove.",
+ "kick": "Whether this is a forced removal of active members in a conference call.",
+ "only_left": "Whether this is a removal of members that already left the conference call."
+ }
+ },
+ "phone.DiscardCall": {
+ "desc": "Refuse or end running call",
+ "params": {
+ "connection_id": "Preferred libtgvoip relay ID",
+ "duration": "Call duration",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The phone call",
+ "reason": "Why was the call discarded",
+ "video": "Whether this is a video call"
+ }
+ },
+ "phone.DiscardGroupCall": {
+ "desc": "Terminate a group call",
+ "params": {
+ "call": "The group call to terminate"
+ }
+ },
+ "phone.EditGroupCallParticipant": {
+ "desc": "Edit information about a given group call participant",
+ "params": {
+ "call": "The group call",
+ "flags": "Flags, see TL conditional fields",
+ "muted": "Whether to mute or unmute the specified participant",
+ "participant": "The group call participant (can also be the user itself)",
+ "presentation_paused": "Pause or resume the screen sharing stream",
+ "raise_hand": "Raise or lower hand",
+ "video_paused": "Pause or resume the video stream",
+ "video_stopped": "Start or stop the video stream",
+ "volume": "New volume"
+ }
+ },
+ "phone.EditGroupCallTitle": {
+ "desc": "Edit the title of a group call or livestream",
+ "params": {
+ "call": "Group call",
+ "title": "New title"
+ }
+ },
+ "phone.ExportGroupCallInvite": {
+ "desc": "Get an invite link for a group call or livestream",
+ "params": {
+ "call": "The group call",
+ "can_self_unmute": "For livestreams or muted group chats, if set, users that join using this link will be able to speak without explicitly requesting permission by (for example by raising their hand).",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "phone.GetCallConfig": {
+ "desc": "Get phone call configuration to be passed to libtgvoip's shared config",
+ "params": {}
+ },
+ "phone.GetGroupCall": {
+ "desc": "Get info about a group call",
+ "params": {
+ "call": "The group call",
+ "limit": "Maximum number of results to return, see pagination"
+ }
+ },
+ "phone.GetGroupCallChainBlocks": {
+ "desc": "Fetch the blocks of a conference blockchain \u00bb.",
+ "params": {
+ "call": "The conference.",
+ "limit": "Maximum number of blocks to return in this call, see pagination",
+ "offset": "Offset for pagination.",
+ "sub_chain_id": "Subchain ID."
+ }
+ },
+ "phone.GetGroupCallJoinAs": {
+ "desc": "Get a list of peers that can be used to join a group call, presenting yourself as a specific user/channel.",
+ "params": {
+ "peer": "The dialog whose group call or livestream we're trying to join"
+ }
+ },
+ "phone.GetGroupCallStreamChannels": {
+ "desc": "Get info about RTMP streams in a group call or livestream.\nThis method should be invoked to the same group/channel-related DC used for downloading livestream chunks.\nAs usual, the media DC is preferred, if available.",
+ "params": {
+ "call": "Group call or livestream"
+ }
+ },
+ "phone.GetGroupCallStreamRtmpUrl": {
+ "desc": "Get RTMP URL and stream key for RTMP livestreams. Can be used even before creating the actual RTMP livestream with phone.createGroupCall (the rtmp_stream flag must be set).",
+ "params": {
+ "peer": "Peer to livestream into",
+ "revoke": "Whether to revoke the previous stream key or simply return the existing one"
+ }
+ },
+ "phone.GetGroupParticipants": {
+ "desc": "Get group call participants",
+ "params": {
+ "call": "Group call",
+ "ids": "If specified, will fetch group participant info about the specified peers",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for results, taken from the next_offset field of phone.groupParticipants, initially an empty string. Note: if no more results are available, the method call will return an empty next_offset; thus, avoid providing the next_offset returned in phone.groupParticipants if it is empty, to avoid an infinite loop.",
+ "sources": "If specified, will fetch group participant info about the specified WebRTC source IDs"
+ }
+ },
+ "phone.InviteConferenceCallParticipant": {
+ "desc": "Invite a user to a conference call.",
+ "params": {
+ "call": "The conference call.",
+ "flags": "Flags, see TL conditional fields",
+ "user_id": "The user to invite.",
+ "video": "Invite the user to also turn on their video feed."
+ }
+ },
+ "phone.InviteToGroupCall": {
+ "desc": "Invite a set of users to a group call.",
+ "params": {
+ "call": "The group call",
+ "users": "The users to invite."
+ }
+ },
+ "phone.JoinGroupCall": {
+ "desc": "Join a group call",
+ "params": {
+ "block": "The block containing an appropriate e2e.chain.changeSetGroupState event.",
+ "call": "The group call",
+ "flags": "Flags, see TL conditional fields",
+ "invite_hash": "The invitation hash from the invite link \u00bb, if provided allows speaking in a livestream or muted group chat.",
+ "join_as": "Join the group call, presenting yourself as the specified user/channel",
+ "muted": "If set, the user will be muted by default upon joining.",
+ "params": "WebRTC parameters",
+ "public_key": "For conference calls, your public key.",
+ "video_stopped": "If set, the user's video will be disabled by default upon joining."
+ }
+ },
+ "phone.JoinGroupCallPresentation": {
+ "desc": "Start screen sharing in a call",
+ "params": {
+ "call": "The group call",
+ "params": "WebRTC parameters"
+ }
+ },
+ "phone.LeaveGroupCall": {
+ "desc": "Leave a group call",
+ "params": {
+ "call": "The group call",
+ "source": "Your source ID"
+ }
+ },
+ "phone.LeaveGroupCallPresentation": {
+ "desc": "Stop screen sharing in a group call",
+ "params": {
+ "call": "The group call"
+ }
+ },
+ "phone.ReceivedCall": {
+ "desc": "Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.",
+ "params": {
+ "peer": "The phone call we're currently in"
+ }
+ },
+ "phone.RequestCall": {
+ "desc": "Start a telegram phone call",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "g_a_hash": "Parameter for E2E encryption key exchange \u00bb",
+ "protocol": "Phone call settings",
+ "random_id": "Random ID to avoid resending the same object",
+ "user_id": "Destination of the phone call",
+ "video": "Whether to start a video call"
+ }
+ },
+ "phone.SaveCallDebug": {
+ "desc": "Send phone call debug data to server",
+ "params": {
+ "debug": "Debug statistics obtained from libtgvoip",
+ "peer": "Phone call"
+ }
+ },
+ "phone.SaveCallLog": {
+ "desc": "Save phone call debug information",
+ "params": {
+ "file": "Logs",
+ "peer": "Phone call"
+ }
+ },
+ "phone.SaveDefaultGroupCallJoinAs": {
+ "desc": "Set the default peer that will be used to join a group call in a specific dialog.",
+ "params": {
+ "join_as": "The default peer that will be used to join group calls in this dialog, presenting yourself as a specific user/channel.",
+ "peer": "The dialog"
+ }
+ },
+ "phone.SendConferenceCallBroadcast": {
+ "desc": "Broadcast a blockchain block to all members of a conference call, see here \u00bb for more info.",
+ "params": {
+ "block": "The block to broadcast.",
+ "call": "The conference where to broadcast the block."
+ }
+ },
+ "phone.SendSignalingData": {
+ "desc": "Send VoIP signaling data",
+ "params": {
+ "data": "Signaling payload",
+ "peer": "Phone call"
+ }
+ },
+ "phone.SetCallRating": {
+ "desc": "Rate a call, returns info about the rating message sent to the official VoIP bot.",
+ "params": {
+ "comment": "An additional comment",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The call to rate",
+ "rating": "Rating in 1-5 stars",
+ "user_initiative": "Whether the user decided on their own initiative to rate the call"
+ }
+ },
+ "phone.StartScheduledGroupCall": {
+ "desc": "Start a scheduled group call.",
+ "params": {
+ "call": "The scheduled group call"
+ }
+ },
+ "phone.ToggleGroupCallRecord": {
+ "desc": "Start or stop recording a group call: the recorded audio and video streams will be automatically sent to Saved messages (the chat with ourselves).",
+ "params": {
+ "call": "The group call or livestream",
+ "flags": "Flags, see TL conditional fields",
+ "start": "Whether to start or stop recording",
+ "title": "Recording title",
+ "video": "Whether to also record video streams",
+ "video_portrait": "If video stream recording is enabled, whether to record in portrait or landscape mode"
+ }
+ },
+ "phone.ToggleGroupCallSettings": {
+ "desc": "Change group call settings",
+ "params": {
+ "call": "Group call",
+ "flags": "Flags, see TL conditional fields",
+ "join_muted": "Whether all users will that join this group call are muted by default upon joining the group call",
+ "reset_invite_hash": "Invalidate existing invite links"
+ }
+ },
+ "phone.ToggleGroupCallStartSubscription": {
+ "desc": "Subscribe or unsubscribe to a scheduled group call",
+ "params": {
+ "call": "Scheduled group call",
+ "subscribed": "Enable or disable subscription"
+ }
+ },
+ "photos.DeletePhotos": {
+ "desc": "Deletes profile photos. The method returns a list of successfully deleted photo IDs.",
+ "params": {
+ "id": "Input photos to delete"
+ }
+ },
+ "photos.GetUserPhotos": {
+ "desc": "Returns the list of user photos.",
+ "params": {
+ "limit": "Number of list elements to be returned",
+ "max_id": "If a positive value was transferred, the method will return only photos with IDs less than the set one. This parameter is often useful when refetching file references \u00bb, as in conjuction with limit=1 and offset=-1 the photo object with the id specified in max_id can be fetched.",
+ "offset": "Number of list elements to be skipped",
+ "user_id": "User ID"
+ }
+ },
+ "photos.UpdateProfilePhoto": {
+ "desc": "Installs a previously uploaded photo as a profile photo.",
+ "params": {
+ "bot": "Can contain info of a bot we own, to change the profile photo of that bot, instead of the current user.",
+ "fallback": "If set, the chosen profile photo will be shown to users that can't display your main profile photo due to your privacy settings.",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Input photo"
+ }
+ },
+ "photos.UploadContactProfilePhoto": {
+ "desc": "Upload a custom profile picture for a contact, or suggest a new profile picture to a contact.",
+ "params": {
+ "file": "Profile photo",
+ "flags": "Flags, see TL conditional fields",
+ "save": "If set, removes a previously set personal profile picture (does not affect suggested profile pictures, to remove them simply delete the messageActionSuggestProfilePhoto service message with messages.deleteMessages).",
+ "suggest": "If set, will send a messageActionSuggestProfilePhoto service message to user_id, suggesting them to use the specified profile picture; otherwise, will set a personal profile picture for the user (only visible to the current user).",
+ "user_id": "The contact",
+ "video": "Animated profile picture video",
+ "video_emoji_markup": "Animated sticker profile picture, must contain either a videoSizeEmojiMarkup or a videoSizeStickerMarkup constructor.",
+ "video_start_ts": "Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if video or video_emoji_markup is set."
+ }
+ },
+ "photos.UploadProfilePhoto": {
+ "desc": "Updates current user profile photo.",
+ "params": {
+ "bot": "Can contain info of a bot we own, to change the profile photo of that bot, instead of the current user.",
+ "fallback": "If set, the chosen profile photo will be shown to users that can't display your main profile photo due to your privacy settings.",
+ "file": "Profile photo",
+ "flags": "Flags, see TL conditional fields",
+ "video": "Animated profile picture video",
+ "video_emoji_markup": "Animated sticker profile picture, must contain either a videoSizeEmojiMarkup or a videoSizeStickerMarkup constructor.",
+ "video_start_ts": "Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if video or video_emoji_markup is set."
+ }
+ },
+ "premium.ApplyBoost": {
+ "desc": "Apply one or more boosts \u00bb to a peer.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer to boost.",
+ "slots": "Which boost slots to assign to this peer."
+ }
+ },
+ "premium.GetBoostsList": {
+ "desc": "Obtains info about the boosts that were applied to a certain channel or supergroup (admins only)",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "gifts": "Whether to return only info about boosts received from gift codes and giveaways created by the channel/supergroup \u00bb",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, obtained from premium.boostsList.next_offset",
+ "peer": "The channel/supergroup"
+ }
+ },
+ "premium.GetBoostsStatus": {
+ "desc": "Gets the current number of boosts of a channel/supergroup.",
+ "params": {
+ "peer": "The peer."
+ }
+ },
+ "premium.GetMyBoosts": {
+ "desc": "Obtain which peers are we currently boosting, and how many boost slots we have left.",
+ "params": {}
+ },
+ "premium.GetUserBoosts": {
+ "desc": "Returns the lists of boost that were applied to a channel/supergroup by a specific user (admins only)",
+ "params": {
+ "peer": "The channel/supergroup",
+ "user_id": "The user"
+ }
+ },
+ "smsjobs.FinishJob": {
+ "desc": "Finish an SMS job (official clients only).",
+ "params": {
+ "error": "If failed, the error.",
+ "flags": "Flags, see TL conditional fields",
+ "job_id": "Job ID."
+ }
+ },
+ "smsjobs.GetSmsJob": {
+ "desc": "Get info about an SMS job (official clients only).",
+ "params": {
+ "job_id": "Job ID"
+ }
+ },
+ "smsjobs.GetStatus": {
+ "desc": "Get SMS jobs status (official clients only).",
+ "params": {}
+ },
+ "smsjobs.IsEligibleToJoin": {
+ "desc": "Check if we can process SMS jobs (official clients only).",
+ "params": {}
+ },
+ "smsjobs.Join": {
+ "desc": "Enable SMS jobs (official clients only).",
+ "params": {}
+ },
+ "smsjobs.Leave": {
+ "desc": "Disable SMS jobs (official clients only).",
+ "params": {}
+ },
+ "smsjobs.UpdateSettings": {
+ "desc": "Update SMS job settings (official clients only).",
+ "params": {
+ "allow_international": "Allow international numbers?",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "stats.GetBroadcastStats": {
+ "desc": "Get channel statistics",
+ "params": {
+ "channel": "The channel",
+ "dark": "Whether to enable dark theme for graph colors",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "stats.GetMegagroupStats": {
+ "desc": "Get supergroup statistics",
+ "params": {
+ "channel": "Supergroup ID",
+ "dark": "Whether to enable dark theme for graph colors",
+ "flags": "Flags, see TL conditional fields"
+ }
+ },
+ "stats.GetMessagePublicForwards": {
+ "desc": "Obtains a list of messages, indicating to which other public channels was a channel message forwarded.\nWill return a list of messages with peer_id equal to the public channel to which this message was forwarded.",
+ "params": {
+ "channel": "Source channel",
+ "limit": "Maximum number of results to return, see pagination",
+ "msg_id": "Source message ID",
+ "offset": "Offset for pagination, empty string on first call, then use the next_offset field of the returned constructor (if present, otherwise no more results are available)."
+ }
+ },
+ "stats.GetMessageStats": {
+ "desc": "Get message statistics",
+ "params": {
+ "channel": "Channel ID",
+ "dark": "Whether to enable dark theme for graph colors",
+ "flags": "Flags, see TL conditional fields",
+ "msg_id": "Message ID"
+ }
+ },
+ "stats.GetStoryPublicForwards": {
+ "desc": "Obtain forwards of a story as a message to public chats and reposts by public channels.",
+ "params": {
+ "id": "Story ID",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, from stats.PublicForwards.next_offset.",
+ "peer": "Peer where the story was originally posted"
+ }
+ },
+ "stats.GetStoryStats": {
+ "desc": "Get statistics for a certain story.",
+ "params": {
+ "dark": "Whether to enable the dark theme for graph colors",
+ "flags": "Flags, see TL conditional fields",
+ "id": "Story ID",
+ "peer": "The peer that posted the story"
+ }
+ },
+ "stats.LoadAsyncGraph": {
+ "desc": "Load channel statistics graph asynchronously",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "token": "Graph token from statsGraphAsync constructor",
+ "x": "Zoom value, if required"
+ }
+ },
+ "stickers.AddStickerToSet": {
+ "desc": "Add a sticker to a stickerset. The sticker set must have been created by the current user/bot.",
+ "params": {
+ "sticker": "The sticker",
+ "stickerset": "The stickerset"
+ }
+ },
+ "stickers.ChangeSticker": {
+ "desc": "Update the keywords, emojis or mask coordinates of a sticker.",
+ "params": {
+ "emoji": "If set, updates the emoji list associated to the sticker",
+ "flags": "Flags, see TL conditional fields",
+ "keywords": "If set, updates the sticker keywords (separated by commas). Can't be provided for mask stickers.",
+ "mask_coords": "If set, updates the mask coordinates",
+ "sticker": "The sticker"
+ }
+ },
+ "stickers.ChangeStickerPosition": {
+ "desc": "Changes the absolute position of a sticker in the set to which it belongs. The sticker set must have been created by the current user/bot.",
+ "params": {
+ "position": "The new position of the sticker, zero-based",
+ "sticker": "The sticker"
+ }
+ },
+ "stickers.CheckShortName": {
+ "desc": "Check whether the given short name is available",
+ "params": {
+ "short_name": "Short name"
+ }
+ },
+ "stickers.CreateStickerSet": {
+ "desc": "Create a stickerset.",
+ "params": {
+ "emojis": "Whether this is a custom emoji stickerset.",
+ "flags": "Flags, see TL conditional fields",
+ "masks": "Whether this is a mask stickerset",
+ "short_name": "Short name of sticker set, to be used in sticker deep links \u00bb. Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and, if called by a bot, must end in \"_by_\". is case insensitive. 1-64 characters.",
+ "software": "Used when importing stickers using the sticker import SDKs, specifies the name of the software that created the stickers",
+ "stickers": "Stickers",
+ "text_color": "Whether the color of TGS custom emojis contained in this set should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context. For custom emoji stickersets only.",
+ "thumb": "Thumbnail",
+ "title": "Stickerset name, 1-64 chars",
+ "user_id": "Stickerset owner"
+ }
+ },
+ "stickers.DeleteStickerSet": {
+ "desc": "Deletes a stickerset we created.",
+ "params": {
+ "stickerset": "Stickerset to delete"
+ }
+ },
+ "stickers.RemoveStickerFromSet": {
+ "desc": "Remove a sticker from the set where it belongs. The sticker set must have been created by the current user/bot.",
+ "params": {
+ "sticker": "The sticker to remove"
+ }
+ },
+ "stickers.RenameStickerSet": {
+ "desc": "Renames a stickerset.",
+ "params": {
+ "stickerset": "Stickerset to rename",
+ "title": "New stickerset title"
+ }
+ },
+ "stickers.ReplaceSticker": {
+ "desc": "Replace a sticker in a stickerset \u00bb.",
+ "params": {
+ "new_sticker": "New sticker.",
+ "sticker": "Old sticker document."
+ }
+ },
+ "stickers.SetStickerSetThumb": {
+ "desc": "Set stickerset thumbnail",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "stickerset": "Stickerset",
+ "thumb": "Thumbnail (only for normal stickersets, not custom emoji stickersets).",
+ "thumb_document_id": "Only for custom emoji stickersets, ID of a custom emoji present in the set to use as thumbnail; pass 0 to fallback to the first custom emoji of the set."
+ }
+ },
+ "stickers.SuggestShortName": {
+ "desc": "Suggests a short name for a given stickerpack name",
+ "params": {
+ "title": "Sticker pack name"
+ }
+ },
+ "stories.ActivateStealthMode": {
+ "desc": "Activates stories stealth mode, see here \u00bb for more info.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "future": "Whether to hide future story views for the next stories_stealth_future_period seconds \u00bb, as specified by the client configuration.",
+ "past": "Whether to erase views from any stories opened in the past stories_stealth_past_period seconds \u00bb, as specified by the client configuration."
+ }
+ },
+ "stories.CanSendStory": {
+ "desc": "Check whether we can post stories as the specified peer.",
+ "params": {
+ "peer": "The peer from which we wish to post stories."
+ }
+ },
+ "stories.CreateAlbum": {
+ "desc": "Creates a story album.",
+ "params": {
+ "peer": "The owned peer where to create the album.",
+ "stories": "Stories to add to the album.",
+ "title": "Album name."
+ }
+ },
+ "stories.DeleteAlbum": {
+ "desc": "Delete a story album.",
+ "params": {
+ "album_id": "ID of the album to delete.",
+ "peer": "Owned peer where the album is located."
+ }
+ },
+ "stories.DeleteStories": {
+ "desc": "Deletes some posted stories.",
+ "params": {
+ "id": "IDs of stories to delete.",
+ "peer": "Channel/user from where to delete stories."
+ }
+ },
+ "stories.EditStory": {
+ "desc": "Edit an uploaded story",
+ "params": {
+ "caption": "If specified, replaces the story caption.",
+ "entities": "Message entities for styled text in the caption, if allowed by the stories_entities client configuration parameter \u00bb.",
+ "flags": "Flags, see TL conditional fields",
+ "id": "ID of story to edit.",
+ "media": "If specified, replaces the story media.",
+ "media_areas": "Media areas associated to the story, see here \u00bb for more info.",
+ "peer": "Peer where the story was posted.",
+ "privacy_rules": "If specified, alters the privacy settings \u00bb of the story, changing who can or can't view the story."
+ }
+ },
+ "stories.ExportStoryLink": {
+ "desc": "Generate a story deep link for a specific story",
+ "params": {
+ "id": "Story ID",
+ "peer": "Peer where the story was posted"
+ }
+ },
+ "stories.GetAlbumStories": {
+ "desc": "Get stories in a story album \u00bb.",
+ "params": {
+ "album_id": "ID of the album.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination.",
+ "peer": "Peer where the album is posted."
+ }
+ },
+ "stories.GetAlbums": {
+ "desc": "Get story albums created by a peer.",
+ "params": {
+ "hash": "The hash from a previously returned stories.albums, to avoid returning any results if they haven't changed.",
+ "peer": "The peer."
+ }
+ },
+ "stories.GetAllReadPeerStories": {
+ "desc": "Obtain the latest read story ID for all peers when first logging in, returned as a list of updateReadStories updates, see here \u00bb for more info.",
+ "params": {}
+ },
+ "stories.GetAllStories": {
+ "desc": "Fetch the List of active (or active and hidden) stories, see here \u00bb for more info on watching stories.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "hidden": "If set, fetches the hidden active story list, otherwise fetches the active story list, see here \u00bb for more info on the full flow.",
+ "next": "If next and state are both set, uses the passed state to paginate to the next results; if neither state nor next are set, fetches the initial page; if state is set and next is not set, check for changes in the active/hidden peerset, see here \u00bb for more info on the full flow.",
+ "state": "If next and state are both set, uses the passed state to paginate to the next results; if neither state nor next are set, fetches the initial page; if state is set and next is not set, check for changes in the active/hidden peerset, see here \u00bb for more info on the full flow."
+ }
+ },
+ "stories.GetChatsToSend": {
+ "desc": "Obtain a list of channels where the user can post stories",
+ "params": {}
+ },
+ "stories.GetPeerMaxIDs": {
+ "desc": "Get the IDs of the maximum read stories for a set of peers.",
+ "params": {
+ "id": "Peers"
+ }
+ },
+ "stories.GetPeerStories": {
+ "desc": "Fetch the full active story list of a specific peer.",
+ "params": {
+ "peer": "Peer whose stories should be fetched"
+ }
+ },
+ "stories.GetPinnedStories": {
+ "desc": "Fetch the stories pinned on a peer's profile.",
+ "params": {
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer whose pinned stories should be fetched"
+ }
+ },
+ "stories.GetStoriesArchive": {
+ "desc": "Fetch the story archive \u00bb of a peer we control.",
+ "params": {
+ "limit": "Maximum number of results to return, see pagination",
+ "offset_id": "Offsets for pagination, for more info click here",
+ "peer": "Peer whose archived stories should be fetched"
+ }
+ },
+ "stories.GetStoriesByID": {
+ "desc": "Obtain full info about a set of stories by their IDs.",
+ "params": {
+ "id": "Story IDs",
+ "peer": "Peer where the stories were posted"
+ }
+ },
+ "stories.GetStoriesViews": {
+ "desc": "Obtain info about the view count, forward count, reactions and recent viewers of one or more stories.",
+ "params": {
+ "id": "Story IDs",
+ "peer": "Peer whose stories should be fetched"
+ }
+ },
+ "stories.GetStoryReactionsList": {
+ "desc": "Get the reaction and interaction list of a story posted to a channel, along with the sender of each reaction.",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "forwards_first": "If set, returns forwards and reposts first, then reactions, then other views; otherwise returns interactions sorted just by interaction date.",
+ "id": "Story ID",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination (taken from the next_offset field of the returned stories.StoryReactionsList); empty in the first request.",
+ "peer": "Channel",
+ "reaction": "Get only reactions of this type"
+ }
+ },
+ "stories.GetStoryViewsList": {
+ "desc": "Obtain the list of users that have viewed a specific story we posted",
+ "params": {
+ "flags": "Flags, see TL conditional fields",
+ "forwards_first": "If set, returns forwards and reposts first, then reactions, then other views; otherwise returns interactions sorted just by interaction date.",
+ "id": "Story ID",
+ "just_contacts": "Whether to only fetch view reaction/views made by our contacts",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination, obtained from stories.storyViewsList.next_offset",
+ "peer": "Peer where the story was posted",
+ "q": "Search for specific peers",
+ "reactions_first": "Whether to return storyView info about users that reacted to the story (i.e. if set, the server will first sort results by view date as usual, and then also additionally sort the list by putting storyViews with an associated reaction first in the list). Ignored if forwards_first is set."
+ }
+ },
+ "stories.IncrementStoryViews": {
+ "desc": "Increment the view counter of one or more stories.",
+ "params": {
+ "id": "IDs of the stories (maximum 200 at a time).",
+ "peer": "Peer where the stories were posted."
+ }
+ },
+ "stories.ReadStories": {
+ "desc": "Mark all stories up to a certain ID as read, for a given peer; will emit an updateReadStories update to all logged-in sessions.",
+ "params": {
+ "max_id": "Mark all stories up to and including this ID as read",
+ "peer": "The peer whose stories should be marked as read."
+ }
+ },
+ "stories.ReorderAlbums": {
+ "desc": "Reorder story albums on a profile \u00bb.",
+ "params": {
+ "order": "New order of the albums.",
+ "peer": "Peer where the albums are located."
+ }
+ },
+ "stories.Report": {
+ "desc": "Report a story.",
+ "params": {
+ "id": "IDs of the stories to report.",
+ "message": "Comment for report moderation",
+ "option": "Menu option, intially empty",
+ "peer": "The peer that uploaded the story."
+ }
+ },
+ "stories.SearchPosts": {
+ "desc": "Globally search for stories using a hashtag or a location media area, see here \u00bb for more info on the full flow.",
+ "params": {
+ "area": "A mediaAreaGeoPoint or a mediaAreaVenue. Note mediaAreaGeoPoint areas may be searched only if they have an associated address.",
+ "flags": "Flags, see TL conditional fields",
+ "hashtag": "Hashtag (without the #)",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination: initially an empty string, then the next_offset from the previously returned stories.foundStories.",
+ "peer": "If set, returns only stories posted by this peer."
+ }
+ },
+ "stories.SendReaction": {
+ "desc": "React to a story.",
+ "params": {
+ "add_to_recent": "Whether to add this reaction to the recent reactions list \u00bb.",
+ "flags": "Flags, see TL conditional fields",
+ "peer": "The peer that sent the story",
+ "reaction": "Reaction",
+ "story_id": "ID of the story to react to"
+ }
+ },
+ "stories.SendStory": {
+ "desc": "Uploads a Telegram Story.",
+ "params": {
+ "albums": "If set, adds the story to the specified albums.",
+ "caption": "Story caption.",
+ "entities": "Message entities for styled text, if allowed by the stories_entities client configuration parameter \u00bb.",
+ "flags": "Flags, see TL conditional fields",
+ "fwd_from_id": "If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id.",
+ "fwd_from_story": "If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id.",
+ "fwd_modified": "Set this flag when reposting stories with fwd_from_id+fwd_from_id, if the media was modified before reposting.",
+ "media": "The story media.",
+ "media_areas": "Media areas associated to the story, see here \u00bb for more info.",
+ "noforwards": "If set, disables forwards, screenshots, and downloads.",
+ "peer": "The peer to send the story as.",
+ "period": "Period after which the story is moved to archive (and to the profile if pinned is set), in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise.",
+ "pinned": "Whether to add the story to the profile automatically upon expiration. If not set, the story will only be added to the archive, see here \u00bb for more info.",
+ "privacy_rules": "Privacy rules for the story, indicating who can or can't view the story.",
+ "random_id": "Unique client message ID required to prevent message resending."
+ }
+ },
+ "stories.ToggleAllStoriesHidden": {
+ "desc": "Hide the active stories of a specific peer, preventing them from being displayed on the action bar on the homescreen.",
+ "params": {
+ "hidden": "Whether to hide or unhide all active stories of the peer"
+ }
+ },
+ "stories.TogglePeerStoriesHidden": {
+ "desc": "Hide the active stories of a user, preventing them from being displayed on the action bar on the homescreen, see here \u00bb for more info.",
+ "params": {
+ "hidden": "Whether to hide or unhide stories.",
+ "peer": "Peer whose stories should be (un)hidden."
+ }
+ },
+ "stories.TogglePinned": {
+ "desc": "Pin or unpin one or more stories",
+ "params": {
+ "id": "IDs of stories to pin or unpin",
+ "peer": "Peer where to pin or unpin stories",
+ "pinned": "Whether to pin or unpin the stories"
+ }
+ },
+ "stories.TogglePinnedToTop": {
+ "desc": "Pin some stories to the top of the profile, see here \u00bb for more info.",
+ "params": {
+ "id": "IDs of the stories to pin (max stories_pinned_to_top_count_max).",
+ "peer": "Peer where to pin stories."
+ }
+ },
+ "stories.UpdateAlbum": {
+ "desc": "Rename a story albums \u00bb, or add, delete or reorder stories in it.",
+ "params": {
+ "add_stories": "If set, adds the specified stories to the album.",
+ "album_id": "Album ID.",
+ "delete_stories": "If set, deletes the specified stories from the album.",
+ "flags": "Flags, see TL conditional fields",
+ "order": "If set, reorders the stories in the album by their IDs.",
+ "peer": "Peer where the album is posted.",
+ "title": "New album title."
+ }
+ },
+ "updates.GetChannelDifference": {
+ "desc": "Returns the difference between the current state of updates of a certain channel and transmitted.",
+ "params": {
+ "channel": "The channel",
+ "filter": "Messsage filter",
+ "flags": "Flags, see TL conditional fields",
+ "force": "Set to true to skip some possibly unneeded updates and reduce server-side load",
+ "limit": "How many updates to fetch, max 100000Ordinary (non-bot) users are supposed to pass 10-100",
+ "pts": "Persistent timestamp (see updates)"
+ }
+ },
+ "updates.GetDifference": {
+ "desc": "Get new updates.",
+ "params": {
+ "date": "date, see updates.",
+ "flags": "Flags, see TL conditional fields",
+ "pts": "PTS, see updates.",
+ "pts_limit": "PTS limit",
+ "pts_total_limit": "For fast updating: if provided and pts + pts_total_limit < remote pts, updates.differenceTooLong will be returned.Simply tells the server to not return the difference if it is bigger than pts_total_limitIf the remote pts is too big (> ~4000000), this field will default to 1000000",
+ "qts": "QTS, see updates.",
+ "qts_limit": "QTS limit"
+ }
+ },
+ "updates.GetState": {
+ "desc": "Returns a current state of updates.",
+ "params": {}
+ },
+ "upload.GetCdnFile": {
+ "desc": "Download a CDN file.",
+ "params": {
+ "file_token": "File token",
+ "limit": "Length of chunk to download",
+ "offset": "Offset of chunk to download"
+ }
+ },
+ "upload.GetCdnFileHashes": {
+ "desc": "Get SHA256 hashes for verifying downloaded CDN files",
+ "params": {
+ "file_token": "File",
+ "offset": "Offset from which to start getting hashes"
+ }
+ },
+ "upload.GetFile": {
+ "desc": "Returns content of a whole file or its part.",
+ "params": {
+ "cdn_supported": "Whether the current client supports CDN downloads",
+ "flags": "Flags, see TL conditional fields",
+ "limit": "Number of bytes to be returned",
+ "location": "File location",
+ "offset": "Number of bytes to be skipped",
+ "precise": "Disable some checks on limit and offset values, useful for example to stream videos by keyframes"
+ }
+ },
+ "upload.GetFileHashes": {
+ "desc": "Get SHA256 hashes for verifying downloaded files",
+ "params": {
+ "location": "File",
+ "offset": "Offset from which to get file hashes"
+ }
+ },
+ "upload.GetWebFile": {
+ "desc": "Returns content of a web file, by proxying the request through telegram, see the webfile docs for more info.",
+ "params": {
+ "limit": "Number of bytes to be returned",
+ "location": "The file to download",
+ "offset": "Number of bytes to be skipped"
+ }
+ },
+ "upload.ReuploadCdnFile": {
+ "desc": "Request a reupload of a certain file to a CDN DC.",
+ "params": {
+ "file_token": "File token",
+ "request_token": "Request token"
+ }
+ },
+ "upload.SaveBigFilePart": {
+ "desc": "Saves a part of a large file (over 10 MB in size) to be later passed to one of the methods.",
+ "params": {
+ "bytes": "Binary data, part contents",
+ "file_id": "Random file id, created by the client",
+ "file_part": "Part sequence number",
+ "file_total_parts": "Total number of parts"
+ }
+ },
+ "upload.SaveFilePart": {
+ "desc": "Saves a part of file for further sending to one of the methods.",
+ "params": {
+ "bytes": "Binary data, content of a part",
+ "file_id": "Random file identifier created by the client",
+ "file_part": "Numerical order of a part"
+ }
+ },
+ "users.GetFullUser": {
+ "desc": "Returns extended user info by ID.",
+ "params": {
+ "id": "User ID"
+ }
+ },
+ "users.GetRequirementsToContact": {
+ "desc": "Check whether we can write to the specified users, used to implement bulk checks for Premium-only messages \u00bb and paid messages \u00bb.",
+ "params": {
+ "id": "Users to check."
+ }
+ },
+ "users.GetSavedMusic": {
+ "desc": "Get songs pinned to the user's profile, see here \u00bb for more info.",
+ "params": {
+ "hash": "Hash \u00bb of the IDs of previously added songs, to avoid returning any result if there was no change.",
+ "id": "The ID of the user.",
+ "limit": "Maximum number of results to return, see pagination",
+ "offset": "Offset for pagination."
+ }
+ },
+ "users.GetSavedMusicByID": {
+ "desc": "Check if the passed songs are still pinned to the user's profile, or refresh the file references of songs pinned on a user's profile see here \u00bb for more info.",
+ "params": {
+ "documents": "The songs (here, file_reference can be empty to refresh file references).",
+ "id": "The ID of the user."
+ }
+ },
+ "users.GetUsers": {
+ "desc": "Returns basic user info according to their identifiers.",
+ "params": {
+ "id": "List of user identifiers"
+ }
+ },
+ "users.SetSecureValueErrors": {
+ "desc": "Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change).",
+ "params": {
+ "errors": "Errors",
+ "id": "The user"
+ }
+ },
+ "users.SuggestBirthday": {
+ "desc": "",
+ "params": {}
+ }
+ },
+ "type": {
+ "AccountDaysTTL": {
+ "desc": "Time-to-live of current account"
+ },
+ "AttachMenuBot": {
+ "desc": "Represents a bot mini app that can be launched from the attachment menu \u00bb"
+ },
+ "AttachMenuBotIcon": {
+ "desc": "Represents an attachment menu icon for bot mini apps \u00bb"
+ },
+ "AttachMenuBotIconColor": {
+ "desc": "Represents an attachment menu icon color for bot mini apps \u00bb"
+ },
+ "AttachMenuBots": {
+ "desc": "Represents a list of bot mini apps that can be launched from the attachment menu \u00bb"
+ },
+ "AttachMenuBotsBot": {
+ "desc": "Represents a bot mini app that can be launched from the attachment menu \u00bb"
+ },
+ "AttachMenuPeerType": {
+ "desc": "Indicates a supported peer type for a bot mini app attachment menu"
+ },
+ "Authorization": {
+ "desc": "Represents a logged-in session"
+ },
+ "AutoDownloadSettings": {
+ "desc": "Media autodownload settings"
+ },
+ "AutoSaveException": {
+ "desc": "Peer-specific autosave settings"
+ },
+ "AutoSaveSettings": {
+ "desc": "Media autosave settings"
+ },
+ "AvailableEffect": {
+ "desc": "Describes a message effect \u00bb."
+ },
+ "AvailableReaction": {
+ "desc": "Animations associated with a message reaction"
+ },
+ "BankCardOpenUrl": {
+ "desc": "Credit card info URL provided by the bank"
+ },
+ "BaseTheme": {
+ "desc": "Basic theme settings"
+ },
+ "Birthday": {
+ "desc": "Birthday information for a user."
+ },
+ "Bool": {
+ "desc": "Boolean type."
+ },
+ "Boost": {
+ "desc": "Info about one or more boosts applied by a specific user."
+ },
+ "BotApp": {
+ "desc": "Contains information about a direct link Mini App."
+ },
+ "BotAppSettings": {
+ "desc": "Mini app \u00bb settings"
+ },
+ "BotBusinessConnection": {
+ "desc": "Contains info about a bot business connection."
+ },
+ "BotCommand": {
+ "desc": "Describes a bot command that can be used in a chat"
+ },
+ "BotCommandScope": {
+ "desc": "Represents a scope where the bot commands, specified using bots.setBotCommands will be valid."
+ },
+ "BotInfo": {
+ "desc": "Info about bots (available bot commands, etc)"
+ },
+ "BotInlineMessage": {
+ "desc": "Inline message"
+ },
+ "BotInlineResult": {
+ "desc": "Results of an inline query"
+ },
+ "BotMenuButton": {
+ "desc": "Indicates the action to execute when pressing the in-UI menu button for bots"
+ },
+ "BotPreviewMedia": {
+ "desc": "Represents a Main Mini App preview media, see here \u00bb for more info."
+ },
+ "BotVerification": {
+ "desc": "Describes a bot verification icon \u00bb."
+ },
+ "BotVerifierSettings": {
+ "desc": "Info about the current verifier bot \u00bb."
+ },
+ "BusinessAwayMessage": {
+ "desc": "Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user."
+ },
+ "BusinessAwayMessageSchedule": {
+ "desc": "Specifies when should the Telegram Business away messages be sent."
+ },
+ "BusinessBotRecipients": {
+ "desc": "Specifies the private chats that a connected business bot \u00bb may receive messages and interact with."
+ },
+ "BusinessBotRights": {
+ "desc": "Business bot rights."
+ },
+ "BusinessChatLink": {
+ "desc": "Contains info about a business chat deep link \u00bb created by the current account."
+ },
+ "BusinessGreetingMessage": {
+ "desc": "Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period."
+ },
+ "BusinessIntro": {
+ "desc": "Telegram Business introduction \u00bb."
+ },
+ "BusinessLocation": {
+ "desc": "Represents the location of a Telegram Business \u00bb."
+ },
+ "BusinessRecipients": {
+ "desc": "Specifies the chats that can receive Telegram Business away \u00bb and greeting \u00bb messages."
+ },
+ "BusinessWeeklyOpen": {
+ "desc": "A time interval, indicating the opening hours of a Telegram Business."
+ },
+ "BusinessWorkHours": {
+ "desc": "Specifies a set of Telegram Business opening hours."
+ },
+ "CdnConfig": {
+ "desc": "Configuration for CDN file downloads."
+ },
+ "CdnPublicKey": {
+ "desc": "Public key to use only during handshakes to CDN DCs."
+ },
+ "ChannelAdminLogEvent": {
+ "desc": "An event in a channel admin log"
+ },
+ "ChannelAdminLogEventAction": {
+ "desc": "Channel admin log event"
+ },
+ "ChannelAdminLogEventsFilter": {
+ "desc": "Filter for fetching events in the channel admin log"
+ },
+ "ChannelLocation": {
+ "desc": "Geographical location of supergroup (geogroups)"
+ },
+ "ChannelMessagesFilter": {
+ "desc": "Filter for fetching only certain types of channel messages"
+ },
+ "ChannelParticipant": {
+ "desc": "Channel participant"
+ },
+ "ChannelParticipantsFilter": {
+ "desc": "Filter for fetching channel participants"
+ },
+ "Chat": {
+ "desc": "Object defines a group."
+ },
+ "ChatAdminRights": {
+ "desc": "Represents the rights of an admin in a channel/supergroup."
+ },
+ "ChatAdminWithInvites": {
+ "desc": "Info about chat invites generated by admins."
+ },
+ "ChatBannedRights": {
+ "desc": "Represents the rights of a normal user in a supergroup/channel/chat."
+ },
+ "ChatFull": {
+ "desc": "Full info about a channel, supergroup, gigagroup or basic group."
+ },
+ "ChatInvite": {
+ "desc": "Chat invite"
+ },
+ "ChatInviteImporter": {
+ "desc": "When and which user joined the chat using a chat invite"
+ },
+ "ChatOnlines": {
+ "desc": "Number of online users in a chat"
+ },
+ "ChatParticipant": {
+ "desc": "Details of a group member."
+ },
+ "ChatParticipants": {
+ "desc": "Object contains info on group members."
+ },
+ "ChatPhoto": {
+ "desc": "Object defines a group profile photo."
+ },
+ "ChatReactions": {
+ "desc": "Available chat reactions"
+ },
+ "ChatTheme": {
+ "desc": "A chat theme"
+ },
+ "ChatThemes": {
+ "desc": ""
+ },
+ "CodeSettings": {
+ "desc": "Settings for the code type to send"
+ },
+ "Config": {
+ "desc": "Object contains info on API configuring parameters."
+ },
+ "ConnectedBot": {
+ "desc": "Contains info about a connected business bot \u00bb."
+ },
+ "ConnectedBotStarRef": {
+ "desc": "Info about an active affiliate program we have with a Mini App"
+ },
+ "Contact": {
+ "desc": "A contact of the current user."
+ },
+ "ContactBirthday": {
+ "desc": "Birthday information of a contact."
+ },
+ "ContactStatus": {
+ "desc": "Contact status: online / offline."
+ },
+ "DataJSON": {
+ "desc": "Represent a JSON-encoded object"
+ },
+ "DcOption": {
+ "desc": "Information for connection to data center."
+ },
+ "DefaultHistoryTTL": {
+ "desc": "Contains info about the default value of the Time-To-Live setting, applied to all new chats."
+ },
+ "Dialog": {
+ "desc": "Chat info."
+ },
+ "DialogFilter": {
+ "desc": "Dialog filter (folder \u00bb)"
+ },
+ "DialogFilterSuggested": {
+ "desc": "Suggested dialog filters (folder \u00bb)"
+ },
+ "DialogPeer": {
+ "desc": "Peer, or all peers in a folder"
+ },
+ "DisallowedGiftsSettings": {
+ "desc": "Disallow the reception of specific gift types."
+ },
+ "Document": {
+ "desc": "A document."
+ },
+ "DocumentAttribute": {
+ "desc": "Various possible attributes of a document (used to define if it's a sticker, a GIF, a video, a mask sticker, an image, an audio, and so on)"
+ },
+ "DraftMessage": {
+ "desc": "Represents a message draft."
+ },
+ "EmailVerification": {
+ "desc": "Email verification code or token"
+ },
+ "EmailVerifyPurpose": {
+ "desc": "Email verification purpose"
+ },
+ "EmojiGroup": {
+ "desc": "Represents an emoji category."
+ },
+ "EmojiKeyword": {
+ "desc": "Emoji keyword"
+ },
+ "EmojiKeywordsDifference": {
+ "desc": "New emoji keywords"
+ },
+ "EmojiLanguage": {
+ "desc": "Emoji language"
+ },
+ "EmojiList": {
+ "desc": "Represents a list of custom emojis."
+ },
+ "EmojiStatus": {
+ "desc": "Emoji status"
+ },
+ "EmojiURL": {
+ "desc": "Emoji URL"
+ },
+ "EncryptedChat": {
+ "desc": "Object contains info on an encrypted chat."
+ },
+ "EncryptedFile": {
+ "desc": "Seta an encrypted file."
+ },
+ "EncryptedMessage": {
+ "desc": "Object contains encrypted message."
+ },
+ "ExportedChatInvite": {
+ "desc": "Exported chat invite"
+ },
+ "ExportedChatlistInvite": {
+ "desc": "An exported chat folder deep link \u00bb."
+ },
+ "ExportedContactToken": {
+ "desc": "Describes a temporary profile link."
+ },
+ "ExportedMessageLink": {
+ "desc": "HTTP link and embed info of channel message"
+ },
+ "ExportedStoryLink": {
+ "desc": "Represents a story deep link"
+ },
+ "FactCheck": {
+ "desc": "Represents a fact-check \u00bb created by an independent fact-checker."
+ },
+ "FileHash": {
+ "desc": "Hash of an uploaded file, to be checked for validity after download"
+ },
+ "Folder": {
+ "desc": "A folder"
+ },
+ "FolderPeer": {
+ "desc": "Peer associated to folder"
+ },
+ "ForumTopic": {
+ "desc": "Contains information about a forum topic"
+ },
+ "FoundStory": {
+ "desc": "A story found using global story search \u00bb."
+ },
+ "Game": {
+ "desc": "Indicates an already sent game"
+ },
+ "GeoPoint": {
+ "desc": "Object defines a GeoPoint."
+ },
+ "GeoPointAddress": {
+ "desc": "Address optionally associated to a geoPoint."
+ },
+ "GlobalPrivacySettings": {
+ "desc": "Global privacy settings"
+ },
+ "GroupCall": {
+ "desc": "A group call"
+ },
+ "GroupCallParticipant": {
+ "desc": "Info about a group call participant"
+ },
+ "GroupCallParticipantVideo": {
+ "desc": "Info about a video stream"
+ },
+ "GroupCallParticipantVideoSourceGroup": {
+ "desc": "Describes a group of video synchronization source identifiers"
+ },
+ "GroupCallStreamChannel": {
+ "desc": "Info about an RTMP stream in a group call or livestream"
+ },
+ "HighScore": {
+ "desc": "Game high score"
+ },
+ "ImportedContact": {
+ "desc": "Object contains info on a successfully imported contact."
+ },
+ "InlineBotSwitchPM": {
+ "desc": "The bot requested the user to message them in private"
+ },
+ "InlineBotWebView": {
+ "desc": "Specifies an inline mode mini app button, shown on top of the inline query results list."
+ },
+ "InlineQueryPeerType": {
+ "desc": "Inline query peer type."
+ },
+ "InputAppEvent": {
+ "desc": "Object contains info about an event that occurred in the application."
+ },
+ "InputBotApp": {
+ "desc": "Used to fetch information about a direct link Mini App"
+ },
+ "InputBotInlineMessage": {
+ "desc": "Represents a sent inline message from the perspective of a bot"
+ },
+ "InputBotInlineMessageID": {
+ "desc": "Represents a sent inline message from the perspective of a bot"
+ },
+ "InputBotInlineResult": {
+ "desc": "Inline bot result"
+ },
+ "InputBusinessAwayMessage": {
+ "desc": "Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user."
+ },
+ "InputBusinessBotRecipients": {
+ "desc": "Specifies the private chats that a connected business bot \u00bb may interact with."
+ },
+ "InputBusinessChatLink": {
+ "desc": "Contains info about a business chat deep link \u00bb to be created by the current account."
+ },
+ "InputBusinessGreetingMessage": {
+ "desc": "Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period."
+ },
+ "InputBusinessIntro": {
+ "desc": "Telegram Business introduction \u00bb."
+ },
+ "InputBusinessRecipients": {
+ "desc": "Specifies the chats that can receive Telegram Business away \u00bb and greeting \u00bb messages."
+ },
+ "InputChannel": {
+ "desc": "Represents a channel"
+ },
+ "InputChatPhoto": {
+ "desc": "Defines a new group profile photo."
+ },
+ "InputChatTheme": {
+ "desc": "Specifies a chat theme \u00bb."
+ },
+ "InputChatlist": {
+ "desc": "Represents a folder"
+ },
+ "InputCheckPasswordSRP": {
+ "desc": "Constructors for checking the validity of a 2FA SRP password."
+ },
+ "InputClientProxy": {
+ "desc": "Info about an MTProxy used to connect."
+ },
+ "InputCollectible": {
+ "desc": "Represents a Fragment collectible \u00bb."
+ },
+ "InputContact": {
+ "desc": "Object defines a contact from the user's phone book."
+ },
+ "InputDialogPeer": {
+ "desc": "Peer, or all peers in a certain folder"
+ },
+ "InputDocument": {
+ "desc": "Defines a document for subsequent interaction."
+ },
+ "InputEncryptedChat": {
+ "desc": "Object sets an encrypted chat ID."
+ },
+ "InputEncryptedFile": {
+ "desc": "Object sets encrypted file for attachment"
+ },
+ "InputFile": {
+ "desc": "Defines a file uploaded by the client."
+ },
+ "InputFileLocation": {
+ "desc": "Defines the location of a file for download."
+ },
+ "InputFolderPeer": {
+ "desc": "Peer in a folder"
+ },
+ "InputGame": {
+ "desc": "A game to send"
+ },
+ "InputGeoPoint": {
+ "desc": "Defines a GeoPoint."
+ },
+ "InputGroupCall": {
+ "desc": "Indicates a group call"
+ },
+ "InputInvoice": {
+ "desc": "An invoice"
+ },
+ "InputMedia": {
+ "desc": "Defines media content of a message."
+ },
+ "InputMessage": {
+ "desc": "A message"
+ },
+ "InputNotifyPeer": {
+ "desc": "Object defines the set of users and/or groups that generate notifications."
+ },
+ "InputPaymentCredentials": {
+ "desc": "Payment credentials"
+ },
+ "InputPeer": {
+ "desc": "Peer"
+ },
+ "InputPeerNotifySettings": {
+ "desc": "Notifications settings."
+ },
+ "InputPhoneCall": {
+ "desc": "Phone call"
+ },
+ "InputPhoto": {
+ "desc": "Defines a photo for further interaction."
+ },
+ "InputPrivacyKey": {
+ "desc": "Privacy keys together with privacy rules \u00bb indicate what can or can't someone do and are specified by a PrivacyKey constructor, and its input counterpart InputPrivacyKey."
+ },
+ "InputPrivacyRule": {
+ "desc": "Privacy rules indicate who can or can't do something and are specified by a PrivacyRule, and its input counterpart InputPrivacyRule."
+ },
+ "InputQuickReplyShortcut": {
+ "desc": "Represents a quick reply shortcut \u00bb."
+ },
+ "InputReplyTo": {
+ "desc": "Contains info about a message or story to reply to."
+ },
+ "InputSavedStarGift": {
+ "desc": "Points to a gift \u00bb."
+ },
+ "InputSecureFile": {
+ "desc": "Secure passport file, for more info see the passport docs \u00bb"
+ },
+ "InputSecureValue": {
+ "desc": "Secure value, for more info see the passport docs \u00bb"
+ },
+ "InputSingleMedia": {
+ "desc": "A single media in an album or grouped media sent with messages.sendMultiMedia."
+ },
+ "InputStarsTransaction": {
+ "desc": "Used to fetch info about a Telegram Star transaction \u00bb."
+ },
+ "InputStickerSet": {
+ "desc": "Represents a stickerset"
+ },
+ "InputStickerSetItem": {
+ "desc": "Sticker"
+ },
+ "InputStickeredMedia": {
+ "desc": "Represents a media with attached stickers"
+ },
+ "InputStorePaymentPurpose": {
+ "desc": "Info about a Telegram Premium purchase"
+ },
+ "InputTheme": {
+ "desc": "Cloud theme"
+ },
+ "InputThemeSettings": {
+ "desc": "Theme settings"
+ },
+ "InputUser": {
+ "desc": "Defines a user for subsequent interaction."
+ },
+ "InputWallPaper": {
+ "desc": "Wallpaper"
+ },
+ "InputWebDocument": {
+ "desc": "Specifies a document that will have to be downloaded from the URL by the telegram servers"
+ },
+ "InputWebFileLocation": {
+ "desc": "Location of remote file"
+ },
+ "Invoice": {
+ "desc": "Invoice"
+ },
+ "JSONObjectValue": {
+ "desc": "JSON key: value pair"
+ },
+ "JSONValue": {
+ "desc": "JSON value"
+ },
+ "KeyboardButton": {
+ "desc": "Bot or inline keyboard buttons"
+ },
+ "KeyboardButtonRow": {
+ "desc": "Bot or inline keyboard rows"
+ },
+ "LabeledPrice": {
+ "desc": "Labeled pricetag"
+ },
+ "LangPackDifference": {
+ "desc": "Language pack changes"
+ },
+ "LangPackLanguage": {
+ "desc": "Language pack language"
+ },
+ "LangPackString": {
+ "desc": "Language pack string"
+ },
+ "MaskCoords": {
+ "desc": "Mask coordinates (if this is a mask sticker, attached to a photo)"
+ },
+ "MediaArea": {
+ "desc": "Represents a story media area \u00bb"
+ },
+ "MediaAreaCoordinates": {
+ "desc": "Coordinates and size of a clickable rectangular area on top of a story."
+ },
+ "Message": {
+ "desc": "Object describing a message."
+ },
+ "MessageAction": {
+ "desc": "Object describing actions connected to a service message."
+ },
+ "MessageEntity": {
+ "desc": "Message entities, representing styled text in a message"
+ },
+ "MessageExtendedMedia": {
+ "desc": "Paid media, see here \u00bb for more info."
+ },
+ "MessageFwdHeader": {
+ "desc": "Info about a forwarded message"
+ },
+ "MessageMedia": {
+ "desc": "Media"
+ },
+ "MessagePeerReaction": {
+ "desc": "How a certain peer reacted to the message"
+ },
+ "MessagePeerVote": {
+ "desc": "How a user voted in a poll"
+ },
+ "MessageRange": {
+ "desc": "Indicates a range of chat messages"
+ },
+ "MessageReactions": {
+ "desc": "Message reactions \u00bb"
+ },
+ "MessageReactor": {
+ "desc": "Info about a user in the paid Star reactions leaderboard for a message."
+ },
+ "MessageReplies": {
+ "desc": "Info about post comments (for channels) or message replies (for groups)"
+ },
+ "MessageReplyHeader": {
+ "desc": "Reply information"
+ },
+ "MessageReportOption": {
+ "desc": "Report menu option"
+ },
+ "MessageViews": {
+ "desc": "View, forward counter + info about replies of a specific message"
+ },
+ "MessagesFilter": {
+ "desc": "Object describes message filter."
+ },
+ "MissingInvitee": {
+ "desc": "Info about why a specific user could not be invited \u00bb."
+ },
+ "MyBoost": {
+ "desc": "Contains information about a single boost slot \u00bb."
+ },
+ "NearestDc": {
+ "desc": "Object contains info on nearest data center."
+ },
+ "NotificationSound": {
+ "desc": "Represents a notification sound"
+ },
+ "NotifyPeer": {
+ "desc": "Object defines the set of users and/or groups that generate notifications."
+ },
+ "OutboxReadDate": {
+ "desc": "Exact read date of a private message we sent to another user."
+ },
+ "Page": {
+ "desc": "Instant view page"
+ },
+ "PageBlock": {
+ "desc": "Represents an instant view page element"
+ },
+ "PageCaption": {
+ "desc": "Page caption"
+ },
+ "PageListItem": {
+ "desc": "Item in block list"
+ },
+ "PageListOrderedItem": {
+ "desc": "Represents an instant view ordered list"
+ },
+ "PageRelatedArticle": {
+ "desc": "Related articles"
+ },
+ "PageTableCell": {
+ "desc": "Represents a table in an instant view table"
+ },
+ "PageTableRow": {
+ "desc": "Table row"
+ },
+ "PaidReactionPrivacy": {
+ "desc": "Paid reaction privacy settings \u00bb"
+ },
+ "PasswordKdfAlgo": {
+ "desc": "Key derivation function to use when generating the password hash for SRP two-factor authorization"
+ },
+ "PaymentCharge": {
+ "desc": "Charged payment"
+ },
+ "PaymentFormMethod": {
+ "desc": "Represents a payment method"
+ },
+ "PaymentRequestedInfo": {
+ "desc": "Requested payment info"
+ },
+ "PaymentSavedCredentials": {
+ "desc": "Saved payment credentials"
+ },
+ "Peer": {
+ "desc": "Identifier of a private chat, basic group, group or channel (see here \u00bb for more info)."
+ },
+ "PeerBlocked": {
+ "desc": "Info about a blocked user"
+ },
+ "PeerColor": {
+ "desc": "Represents a color palette \u00bb."
+ },
+ "PeerLocated": {
+ "desc": "Geolocated peer"
+ },
+ "PeerNotifySettings": {
+ "desc": "Notification settings."
+ },
+ "PeerSettings": {
+ "desc": "List of actions that are possible when interacting with this user, to be shown as suggested actions in the chat bar"
+ },
+ "PeerStories": {
+ "desc": "Stories associated to a peer"
+ },
+ "PendingSuggestion": {
+ "desc": "Represents a custom pending suggestion \u00bb."
+ },
+ "PhoneCall": {
+ "desc": "Phone call"
+ },
+ "PhoneCallDiscardReason": {
+ "desc": "Why was the phone call discarded?"
+ },
+ "PhoneCallProtocol": {
+ "desc": "Phone call protocol"
+ },
+ "PhoneConnection": {
+ "desc": "Phone call connection"
+ },
+ "Photo": {
+ "desc": "Object describes a photo."
+ },
+ "PhotoSize": {
+ "desc": "Location of a certain size of a picture"
+ },
+ "Poll": {
+ "desc": "Indicates a poll message"
+ },
+ "PollAnswer": {
+ "desc": "Indicates a possible answer to a poll."
+ },
+ "PollAnswerVoters": {
+ "desc": "How users voted on a certain poll answer"
+ },
+ "PollResults": {
+ "desc": "Results of poll"
+ },
+ "PopularContact": {
+ "desc": "Popular contact"
+ },
+ "PostAddress": {
+ "desc": "Shipping address"
+ },
+ "PostInteractionCounters": {
+ "desc": "Interaction counters"
+ },
+ "PremiumGiftCodeOption": {
+ "desc": "Giveaway option."
+ },
+ "PremiumGiftOption": {
+ "desc": "Telegram Premium gift option"
+ },
+ "PremiumSubscriptionOption": {
+ "desc": "Telegram Premium subscription option"
+ },
+ "PrepaidGiveaway": {
+ "desc": "Contains info about a prepaid giveaway \u00bb."
+ },
+ "PrivacyKey": {
+ "desc": "Privacy keys together with privacy rules \u00bb indicate what can or can't someone do and are specified by a PrivacyKey constructor, and its input counterpart InputPrivacyKey."
+ },
+ "PrivacyRule": {
+ "desc": "Privacy rules together with privacy keys indicate what can or can't someone do and are specified by a PrivacyRule constructor, and its input counterpart InputPrivacyRule."
+ },
+ "ProfileTab": {
+ "desc": "Represents a tab of a profile page \u00bb."
+ },
+ "PublicForward": {
+ "desc": "Contains info about the forwards of a story as a message to public chats and reposts by public channels."
+ },
+ "QuickReply": {
+ "desc": "A quick reply shortcut."
+ },
+ "Reaction": {
+ "desc": "Message reaction"
+ },
+ "ReactionCount": {
+ "desc": "Number of users that reacted with a certain emoji"
+ },
+ "ReactionNotificationsFrom": {
+ "desc": "Reaction notification settings"
+ },
+ "ReactionsNotifySettings": {
+ "desc": "Reaction notification settings, see here \u00bb for more info."
+ },
+ "ReadParticipantDate": {
+ "desc": "Contains info about when a certain participant has read a message"
+ },
+ "ReceivedNotifyMessage": {
+ "desc": "Confirmation of message receipt"
+ },
+ "RecentMeUrl": {
+ "desc": "Recent t.me urls"
+ },
+ "ReplyMarkup": {
+ "desc": "Reply markup for bot and inline keyboards"
+ },
+ "ReportReason": {
+ "desc": "Report reason"
+ },
+ "ReportResult": {
+ "desc": "Represents a report menu or result"
+ },
+ "RequestPeerType": {
+ "desc": "Filtering criteria to use for the peer selection list shown to the user."
+ },
+ "RequestedPeer": {
+ "desc": "Info about a peer, shared by a user with the currently logged in bot using messages.sendBotRequestedPeer."
+ },
+ "RequirementToContact": {
+ "desc": "Specifies a requirement that must be satisfied in order to contact a user."
+ },
+ "RestrictionReason": {
+ "desc": "Restriction reason"
+ },
+ "RichText": {
+ "desc": "Rich text"
+ },
+ "SavedContact": {
+ "desc": "Saved contact"
+ },
+ "SavedDialog": {
+ "desc": "Represents a saved message dialog \u00bb."
+ },
+ "SavedReactionTag": {
+ "desc": "Info about a saved message reaction tag \u00bb."
+ },
+ "SavedStarGift": {
+ "desc": "Represents a gift owned by a peer."
+ },
+ "SearchPostsFlood": {
+ "desc": "Indicates if the specified global post search \u00bb requires payment."
+ },
+ "SearchResultsCalendarPeriod": {
+ "desc": "Information about found messages sent on a specific day, used to split the messages in messages.searchResultsCalendar constructors by days."
+ },
+ "SearchResultsPosition": {
+ "desc": "Information about a message in a specific position"
+ },
+ "SecureCredentialsEncrypted": {
+ "desc": "Encrypted secure credentials"
+ },
+ "SecureData": {
+ "desc": "Secure passport data, for more info see the passport docs \u00bb"
+ },
+ "SecureFile": {
+ "desc": "Secure passport file, for more info see the passport docs \u00bb"
+ },
+ "SecurePasswordKdfAlgo": {
+ "desc": "KDF algorithm to use for computing telegram passport hash"
+ },
+ "SecurePlainData": {
+ "desc": "Plaintext verified passport data."
+ },
+ "SecureRequiredType": {
+ "desc": "Required secure file type"
+ },
+ "SecureSecretSettings": {
+ "desc": "Telegram passport settings"
+ },
+ "SecureValue": {
+ "desc": "Secure Telegram Passport value"
+ },
+ "SecureValueError": {
+ "desc": "Secure value error"
+ },
+ "SecureValueHash": {
+ "desc": "Secure value hash"
+ },
+ "SecureValueType": {
+ "desc": "Secure value type"
+ },
+ "SendAsPeer": {
+ "desc": "Indicates a peer that can be used to send messages"
+ },
+ "SendMessageAction": {
+ "desc": "User actions. Use this to provide users with detailed info about their chat partner's actions: typing or sending attachments of all kinds."
+ },
+ "ShippingOption": {
+ "desc": "Shipping options"
+ },
+ "SmsJob": {
+ "desc": "Info about an SMS job."
+ },
+ "SponsoredMessage": {
+ "desc": "A sponsored message"
+ },
+ "SponsoredMessageReportOption": {
+ "desc": "A report option for a sponsored message \u00bb."
+ },
+ "SponsoredPeer": {
+ "desc": "A sponsored peer."
+ },
+ "StarGift": {
+ "desc": "Represents a star gift, see here \u00bb for more info."
+ },
+ "StarGiftAttribute": {
+ "desc": "An attribute of a collectible gift \u00bb."
+ },
+ "StarGiftAttributeCounter": {
+ "desc": "Indicates the total number of gifts that have the specified attribute."
+ },
+ "StarGiftAttributeId": {
+ "desc": "Represents the identifier of a collectible gift attribute."
+ },
+ "StarGiftCollection": {
+ "desc": "Represents a star gift collection \u00bb."
+ },
+ "StarGiftUpgradePreview": {
+ "desc": ""
+ },
+ "StarGiftUpgradePrice": {
+ "desc": ""
+ },
+ "StarRefProgram": {
+ "desc": "Indo about an affiliate program offered by a bot"
+ },
+ "StarsAmount": {
+ "desc": "Describes a real (i.e. possibly decimal) amount of Telegram Stars."
+ },
+ "StarsGiftOption": {
+ "desc": "Telegram Stars gift option."
+ },
+ "StarsGiveawayOption": {
+ "desc": "Contains info about a Telegram Star giveaway option."
+ },
+ "StarsGiveawayWinnersOption": {
+ "desc": "Represents a possible option for the number of winners in a star giveaway"
+ },
+ "StarsRating": {
+ "desc": "Represents the profile's star rating, see here \u00bb for more info."
+ },
+ "StarsRevenueStatus": {
+ "desc": "Describes Telegram Star revenue balances \u00bb."
+ },
+ "StarsSubscription": {
+ "desc": "Represents a Telegram Star subscription \u00bb."
+ },
+ "StarsSubscriptionPricing": {
+ "desc": "Pricing of a Telegram Star subscription \u00bb."
+ },
+ "StarsTopupOption": {
+ "desc": "Telegram Stars topup option."
+ },
+ "StarsTransaction": {
+ "desc": "Represents a Telegram Stars transaction \u00bb."
+ },
+ "StarsTransactionPeer": {
+ "desc": "Source of an incoming Telegram Star transaction, or its recipient for outgoing Telegram Star transactions."
+ },
+ "StatsAbsValueAndPrev": {
+ "desc": "Channel statistics value pair"
+ },
+ "StatsDateRangeDays": {
+ "desc": "Channel statistics date range"
+ },
+ "StatsGraph": {
+ "desc": "Channel statistics graph"
+ },
+ "StatsGroupTopAdmin": {
+ "desc": "Most active admin in a supergroup"
+ },
+ "StatsGroupTopInviter": {
+ "desc": "Most active inviter in a supergroup"
+ },
+ "StatsGroupTopPoster": {
+ "desc": "Most active user in a supergroup"
+ },
+ "StatsPercentValue": {
+ "desc": "Channel statistics percentage"
+ },
+ "StatsURL": {
+ "desc": "URL with chat statistics"
+ },
+ "StickerKeyword": {
+ "desc": "Keywords for a certain sticker"
+ },
+ "StickerPack": {
+ "desc": "Stickerpack"
+ },
+ "StickerSet": {
+ "desc": "Represents a stickerset (stickerpack)"
+ },
+ "StickerSetCovered": {
+ "desc": "Stickerset preview"
+ },
+ "StoriesStealthMode": {
+ "desc": "Story stealth mode status"
+ },
+ "StoryAlbum": {
+ "desc": "Represents a story album \u00bb."
+ },
+ "StoryFwdHeader": {
+ "desc": "Contains info about the original poster of a reposted story."
+ },
+ "StoryItem": {
+ "desc": "Represents a Telegram Story"
+ },
+ "StoryReaction": {
+ "desc": "How a certain peer reacted to or interacted with a story"
+ },
+ "StoryView": {
+ "desc": "Story view date and reaction information"
+ },
+ "StoryViews": {
+ "desc": "Aggregated view and reaction information of a story"
+ },
+ "SuggestedPost": {
+ "desc": "Contains info about a suggested post \u00bb."
+ },
+ "TextWithEntities": {
+ "desc": "Styled text with message entities"
+ },
+ "Theme": {
+ "desc": "Cloud theme"
+ },
+ "ThemeSettings": {
+ "desc": "Theme settings"
+ },
+ "Timezone": {
+ "desc": "Timezone information."
+ },
+ "TodoCompletion": {
+ "desc": "A completed todo list \u00bb item."
+ },
+ "TodoItem": {
+ "desc": "An item of a todo list \u00bb."
+ },
+ "TodoList": {
+ "desc": "Represents a todo list \u00bb."
+ },
+ "TopPeer": {
+ "desc": "Top peer"
+ },
+ "TopPeerCategory": {
+ "desc": "Top peer category"
+ },
+ "TopPeerCategoryPeers": {
+ "desc": "Top peers by top peer category"
+ },
+ "Update": {
+ "desc": "Object contains info on events occurred."
+ },
+ "Updates": {
+ "desc": "Object which is perceived by the client without a call on its part when an event occurs."
+ },
+ "UrlAuthResult": {
+ "desc": "URL authorization result"
+ },
+ "User": {
+ "desc": "Object defines a user."
+ },
+ "UserFull": {
+ "desc": "Object contains extended user info."
+ },
+ "UserProfilePhoto": {
+ "desc": "Object contains info on the user's profile photo."
+ },
+ "UserStatus": {
+ "desc": "User online status"
+ },
+ "Username": {
+ "desc": "Contains information about a username"
+ },
+ "VideoSize": {
+ "desc": "Represents an animated video thumbnail"
+ },
+ "WallPaper": {
+ "desc": "Object contains info on a wallpaper."
+ },
+ "WallPaperSettings": {
+ "desc": "Wallpaper rendering information."
+ },
+ "WebAuthorization": {
+ "desc": "Web authorization"
+ },
+ "WebDocument": {
+ "desc": "Remote document"
+ },
+ "WebPage": {
+ "desc": "Instant View webpage preview"
+ },
+ "WebPageAttribute": {
+ "desc": "Webpage attributes"
+ },
+ "WebViewMessageSent": {
+ "desc": "Contains information about an inline message sent by a Web App on behalf of a user."
+ },
+ "WebViewResult": {
+ "desc": "Contains the webview URL with appropriate theme and user info parameters added"
+ },
+ "X": {
+ "desc": "Represents the return type of the wrapped method."
+ },
+ "account.AuthorizationForm": {
+ "desc": "Authorization form"
+ },
+ "account.Authorizations": {
+ "desc": "Logged-in sessions"
+ },
+ "account.AutoDownloadSettings": {
+ "desc": "Media autodownload settings"
+ },
+ "account.AutoSaveSettings": {
+ "desc": "Contains media autosave settings"
+ },
+ "account.BusinessChatLinks": {
+ "desc": "Contains info about business chat deep links \u00bb created by the current account."
+ },
+ "account.ChatThemes": {
+ "desc": "Available chat themes"
+ },
+ "account.ConnectedBots": {
+ "desc": "Info about currently connected business bots."
+ },
+ "account.ContentSettings": {
+ "desc": "Sensitive content settings"
+ },
+ "account.EmailVerified": {
+ "desc": "Email verification status"
+ },
+ "account.EmojiStatuses": {
+ "desc": "A list of emoji statuses"
+ },
+ "account.PaidMessagesRevenue": {
+ "desc": "Total number of non-refunded Telegram Stars a user has spent on sending us messages either directly or through a channel, see here \u00bb for more info on paid messages."
+ },
+ "account.Password": {
+ "desc": "Configuration for two-factor authorization"
+ },
+ "account.PasswordInputSettings": {
+ "desc": "Constructor for setting up a new 2FA SRP password"
+ },
+ "account.PasswordSettings": {
+ "desc": "Private info associated to the password info (recovery email, telegram passport info & so on)"
+ },
+ "account.PrivacyRules": {
+ "desc": "Privacy rules"
+ },
+ "account.ResetPasswordResult": {
+ "desc": "Result of an account.resetPassword request."
+ },
+ "account.ResolvedBusinessChatLinks": {
+ "desc": "Contains info about a single resolved business chat deep link \u00bb."
+ },
+ "account.SavedMusicIds": {
+ "desc": "List of IDs of songs (document.ids) currently pinned on our profile, see here \u00bb for more info."
+ },
+ "account.SavedRingtone": {
+ "desc": "Contains information about a saved notification sound"
+ },
+ "account.SavedRingtones": {
+ "desc": "Contains a list of saved notification sounds"
+ },
+ "account.SentEmailCode": {
+ "desc": "The email code that was sent"
+ },
+ "account.Takeout": {
+ "desc": "Takeout info"
+ },
+ "account.Themes": {
+ "desc": "Installed themes"
+ },
+ "account.TmpPassword": {
+ "desc": "Temporary password"
+ },
+ "account.WallPapers": {
+ "desc": "Wallpapers"
+ },
+ "account.WebAuthorizations": {
+ "desc": "Web authorizations"
+ },
+ "auth.Authorization": {
+ "desc": "Object contains info on user authorization."
+ },
+ "auth.CodeType": {
+ "desc": "Type of verification code that will be sent next if you call the resendCode method"
+ },
+ "auth.ExportedAuthorization": {
+ "desc": "Exported authorization"
+ },
+ "auth.LoggedOut": {
+ "desc": "Future auth token \u00bb to be used on subsequent authorizations"
+ },
+ "auth.LoginToken": {
+ "desc": "Login token (for QR code login)"
+ },
+ "auth.PasswordRecovery": {
+ "desc": "Recovery info of a 2FA password, only for accounts with a recovery email configured."
+ },
+ "auth.SentCode": {
+ "desc": "Contains info on a confirmation code message sent via SMS, phone call or Telegram."
+ },
+ "auth.SentCodeType": {
+ "desc": "Type of the verification code that was sent"
+ },
+ "bots.BotInfo": {
+ "desc": "Localized name, about text and description of a bot."
+ },
+ "bots.PopularAppBots": {
+ "desc": "Popular Main Mini Apps, to be used in the apps tab of global search \u00bb."
+ },
+ "bots.PreviewInfo": {
+ "desc": "Contains info about Main Mini App previews, see here \u00bb for more info."
+ },
+ "channels.AdminLogResults": {
+ "desc": "Admin log events"
+ },
+ "channels.ChannelParticipant": {
+ "desc": "Channel participant"
+ },
+ "channels.ChannelParticipants": {
+ "desc": "Channel/supergroup participants"
+ },
+ "channels.SendAsPeers": {
+ "desc": "A list of peers that can be used to send messages in a specific group"
+ },
+ "channels.SponsoredMessageReportResult": {
+ "desc": "Status of the method call used to report a sponsored message \u00bb."
+ },
+ "chatlists.ChatlistInvite": {
+ "desc": "Info about a chat folder deep link \u00bb."
+ },
+ "chatlists.ChatlistUpdates": {
+ "desc": "Updated info about a chat folder deep link \u00bb."
+ },
+ "chatlists.ExportedChatlistInvite": {
+ "desc": "Exported chat folder deep link \u00bb."
+ },
+ "chatlists.ExportedInvites": {
+ "desc": "A list of exported chat folder deep links \u00bb."
+ },
+ "contacts.Blocked": {
+ "desc": "Info on users from the current user's black list."
+ },
+ "contacts.ContactBirthdays": {
+ "desc": "Birthday information of our contacts."
+ },
+ "contacts.Contacts": {
+ "desc": "Info on the current user's contact list."
+ },
+ "contacts.Found": {
+ "desc": "Object contains info on users found by name substring and auxiliary data."
+ },
+ "contacts.ImportedContacts": {
+ "desc": "Object contains info on successfully imported contacts."
+ },
+ "contacts.ResolvedPeer": {
+ "desc": "Peer returned after resolving a @username"
+ },
+ "contacts.SponsoredPeers": {
+ "desc": "A list of sponsored peers."
+ },
+ "contacts.TopPeers": {
+ "desc": "Top peers"
+ },
+ "fragment.CollectibleInfo": {
+ "desc": "Info about a fragment collectible."
+ },
+ "help.AppConfig": {
+ "desc": "Contains various client configuration parameters"
+ },
+ "help.AppUpdate": {
+ "desc": "Contains info on app update availability."
+ },
+ "help.CountriesList": {
+ "desc": "Name, ISO code, localized name and phone codes/patterns of all available countries"
+ },
+ "help.Country": {
+ "desc": "Name, ISO code, localized name and phone codes/patterns of a specific country"
+ },
+ "help.CountryCode": {
+ "desc": "Country code and phone number pattern of a specific country"
+ },
+ "help.DeepLinkInfo": {
+ "desc": "Contains information about an unsupported deep link \u00bb"
+ },
+ "help.InviteText": {
+ "desc": "Object contains info on the text of a message with an invitation."
+ },
+ "help.PassportConfig": {
+ "desc": "Telegram passport configuration"
+ },
+ "help.PeerColorOption": {
+ "desc": "Contains info about a color palette \u00bb."
+ },
+ "help.PeerColorSet": {
+ "desc": "Contains info about a color palette \u00bb."
+ },
+ "help.PeerColors": {
+ "desc": "Contains info about multiple color palettes \u00bb."
+ },
+ "help.PremiumPromo": {
+ "desc": "Telegram Premium promotion information"
+ },
+ "help.PromoData": {
+ "desc": "Info about pinned MTProxy or Public Service Announcement peers."
+ },
+ "help.RecentMeUrls": {
+ "desc": "Recent t.me URLs"
+ },
+ "help.Support": {
+ "desc": "Info about the support user, relevant to the current user."
+ },
+ "help.SupportName": {
+ "desc": "Get localized name for support user"
+ },
+ "help.TermsOfService": {
+ "desc": "Contains info about the latest telegram Terms Of Service."
+ },
+ "help.TermsOfServiceUpdate": {
+ "desc": "Update of Telegram's terms of service"
+ },
+ "help.TimezonesList": {
+ "desc": "Timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours \u00bb."
+ },
+ "help.UserInfo": {
+ "desc": "User info"
+ },
+ "int": {
+ "desc": "A basic bare type, the values of which correspond to single-element sequences, i.e. numbers from -2^31 to 2^31-1 which in this case represent themselves."
+ },
+ "long": {
+ "desc": "A basic bare type, elements of which correspond to two-element sequences, representing 64-bit signed numbers (little-endian)."
+ },
+ "messages.AffectedFoundMessages": {
+ "desc": "Messages found and affected by changes"
+ },
+ "messages.AffectedHistory": {
+ "desc": "Object contains info on affected part of communication history with the user or in a chat."
+ },
+ "messages.AffectedMessages": {
+ "desc": "Messages affected by changes"
+ },
+ "messages.AllStickers": {
+ "desc": "All stickers"
+ },
+ "messages.ArchivedStickers": {
+ "desc": "Archived stickers"
+ },
+ "messages.AvailableEffects": {
+ "desc": "Full list of usable animated message effects \u00bb."
+ },
+ "messages.AvailableReactions": {
+ "desc": "Animations and metadata associated with message reactions \u00bb"
+ },
+ "messages.BotApp": {
+ "desc": "Contains information about a direct link Mini App"
+ },
+ "messages.BotCallbackAnswer": {
+ "desc": "Callback answer of bot"
+ },
+ "messages.BotPreparedInlineMessage": {
+ "desc": "Represents a prepared inline message saved by a bot, to be sent to the user via a web app \u00bb"
+ },
+ "messages.BotResults": {
+ "desc": "Result of a query to an inline bot"
+ },
+ "messages.ChatAdminsWithInvites": {
+ "desc": "Info about chat invites generated by admins."
+ },
+ "messages.ChatFull": {
+ "desc": "Full info about a channel, supergroup, gigagroup or basic group."
+ },
+ "messages.ChatInviteImporters": {
+ "desc": "List of users that imported a chat invitation link."
+ },
+ "messages.Chats": {
+ "desc": "Object contains list of chats with auxiliary data."
+ },
+ "messages.CheckedHistoryImportPeer": {
+ "desc": "Contains a confirmation text to be shown to the user, upon importing chat history, click here for more info \u00bb."
+ },
+ "messages.DhConfig": {
+ "desc": "Contains Diffie-Hellman key generation protocol parameters."
+ },
+ "messages.DialogFilters": {
+ "desc": "Folder information"
+ },
+ "messages.Dialogs": {
+ "desc": "Object contains a list of chats with messages and auxiliary data."
+ },
+ "messages.DiscussionMessage": {
+ "desc": "Info about a message thread"
+ },
+ "messages.EmojiGroups": {
+ "desc": "Represents a list of emoji categories."
+ },
+ "messages.ExportedChatInvite": {
+ "desc": "Contains info about a chat invite, and eventually a pointer to the newest chat invite."
+ },
+ "messages.ExportedChatInvites": {
+ "desc": "Info about chat invites exported by a certain admin."
+ },
+ "messages.FavedStickers": {
+ "desc": "Favorited stickers"
+ },
+ "messages.FeaturedStickers": {
+ "desc": "Featured stickers"
+ },
+ "messages.ForumTopics": {
+ "desc": "Contains information about multiple forum topics"
+ },
+ "messages.FoundStickerSets": {
+ "desc": "Found stickersets"
+ },
+ "messages.FoundStickers": {
+ "desc": "Found stickers"
+ },
+ "messages.HighScores": {
+ "desc": "High scores (in games)"
+ },
+ "messages.HistoryImport": {
+ "desc": "Identifier of a history import session, click here for more info \u00bb."
+ },
+ "messages.HistoryImportParsed": {
+ "desc": "Contains information about a chat export file, generated by a foreign chat app."
+ },
+ "messages.InactiveChats": {
+ "desc": "Inactive chat list"
+ },
+ "messages.InvitedUsers": {
+ "desc": "Contains info about successfully or unsuccessfully invited \u00bb users."
+ },
+ "messages.MessageEditData": {
+ "desc": "Message edit data for media"
+ },
+ "messages.MessageEmpty": {
+ "desc": ""
+ },
+ "messages.MessageReactionsList": {
+ "desc": "List of peers that reacted to a specific message"
+ },
+ "messages.MessageViews": {
+ "desc": "View, forward counter + info about replies"
+ },
+ "messages.Messages": {
+ "desc": "Object contains information on list of messages with auxiliary data."
+ },
+ "messages.MyStickers": {
+ "desc": "The list of stickersets owned by the current account \u00bb."
+ },
+ "messages.PeerDialogs": {
+ "desc": "List of dialogs"
+ },
+ "messages.PeerSettings": {
+ "desc": "Peer settings"
+ },
+ "messages.PreparedInlineMessage": {
+ "desc": "Represents a prepared inline message received via a bot's mini app, that can be sent to some chats \u00bb"
+ },
+ "messages.QuickReplies": {
+ "desc": "Info about quick reply shortcuts \u00bb."
+ },
+ "messages.Reactions": {
+ "desc": "A set of message reactions"
+ },
+ "messages.RecentStickers": {
+ "desc": "Recent stickers"
+ },
+ "messages.SavedDialogs": {
+ "desc": "Represents some saved message dialogs \u00bb."
+ },
+ "messages.SavedGifs": {
+ "desc": "Saved GIFs"
+ },
+ "messages.SavedReactionTags": {
+ "desc": "List of reaction tag \u00bb names assigned by the user."
+ },
+ "messages.SearchCounter": {
+ "desc": "Number of results that would be returned by a search"
+ },
+ "messages.SearchResultsCalendar": {
+ "desc": "Information about found messages sent on a specific day"
+ },
+ "messages.SearchResultsPositions": {
+ "desc": "Information about sparse positions of messages"
+ },
+ "messages.SentEncryptedMessage": {
+ "desc": "Contains info on message sent to an encrypted chat."
+ },
+ "messages.SponsoredMessages": {
+ "desc": "A set of sponsored messages associated with a channel"
+ },
+ "messages.StickerSet": {
+ "desc": "Stickerset"
+ },
+ "messages.StickerSetInstallResult": {
+ "desc": "Result of stickerset installation process"
+ },
+ "messages.Stickers": {
+ "desc": "Stickers"
+ },
+ "messages.TranscribedAudio": {
+ "desc": "Transcribed text from a voice message"
+ },
+ "messages.TranslatedText": {
+ "desc": "Translated text with entities."
+ },
+ "messages.VotesList": {
+ "desc": "How users voted in a poll"
+ },
+ "messages.WebPage": {
+ "desc": "Contains an instant view webpage."
+ },
+ "messages.WebPagePreview": {
+ "desc": "Represents a webpage preview."
+ },
+ "messages.WebViewResult": {
+ "desc": ""
+ },
+ "payments.BankCardData": {
+ "desc": "Credit card info, provided by the card's bank(s)"
+ },
+ "payments.CheckCanSendGiftResult": {
+ "desc": "Specifies if a gift can or cannot be sent."
+ },
+ "payments.CheckedGiftCode": {
+ "desc": "Info about a Telegram Premium Giftcode."
+ },
+ "payments.ConnectedStarRefBots": {
+ "desc": "Active affiliations"
+ },
+ "payments.ExportedInvoice": {
+ "desc": "Exported invoice"
+ },
+ "payments.GiveawayInfo": {
+ "desc": "Info about a Telegram Premium Giveaway."
+ },
+ "payments.PaymentForm": {
+ "desc": "Payment form"
+ },
+ "payments.PaymentReceipt": {
+ "desc": "Payment receipt"
+ },
+ "payments.PaymentResult": {
+ "desc": "Payment result"
+ },
+ "payments.ResaleStarGifts": {
+ "desc": "List of gifts currently on resale \u00bb."
+ },
+ "payments.SavedInfo": {
+ "desc": "Saved payment info"
+ },
+ "payments.SavedStarGifts": {
+ "desc": "Represents a list of gifts."
+ },
+ "payments.StarGiftCollections": {
+ "desc": "Represents a list of star gift collections \u00bb."
+ },
+ "payments.StarGiftUpgradePreview": {
+ "desc": "A preview of the possible attributes (chosen randomly) a gift \u00bb can receive after upgrading it to a collectible gift \u00bb, see here \u00bb for more info."
+ },
+ "payments.StarGiftWithdrawalUrl": {
+ "desc": "A URL that can be used to import the exported NFT on Fragment."
+ },
+ "payments.StarGifts": {
+ "desc": "Available gifts \u00bb."
+ },
+ "payments.StarsRevenueAdsAccountUrl": {
+ "desc": "Contains a URL leading to a page where the user will be able to place ads for the channel/bot, paying using Telegram Stars."
+ },
+ "payments.StarsRevenueStats": {
+ "desc": "Star revenue statistics, see here \u00bb for more info."
+ },
+ "payments.StarsRevenueWithdrawalUrl": {
+ "desc": "Contains the URL to use to withdraw Telegram Star revenue."
+ },
+ "payments.StarsStatus": {
+ "desc": "Info about the current Telegram Star subscriptions, balance and transaction history \u00bb."
+ },
+ "payments.SuggestedStarRefBots": {
+ "desc": "A list of suggested mini apps with available affiliate programs"
+ },
+ "payments.UniqueStarGift": {
+ "desc": "Represents a collectible gift \u00bb."
+ },
+ "payments.UniqueStarGiftValueInfo": {
+ "desc": "Information about the value of a collectible gift \u00bb."
+ },
+ "payments.ValidatedRequestedInfo": {
+ "desc": "Validated requested info"
+ },
+ "phone.ExportedGroupCallInvite": {
+ "desc": "An exported group call invitation."
+ },
+ "phone.GroupCall": {
+ "desc": "Contains info about a group call, and partial info about its participants."
+ },
+ "phone.GroupCallStreamChannels": {
+ "desc": "Info about RTMP streams in a group call or livestream"
+ },
+ "phone.GroupCallStreamRtmpUrl": {
+ "desc": "RTMP URL and stream key to be used in streaming software"
+ },
+ "phone.GroupParticipants": {
+ "desc": "Info about the participants of a group call or livestream"
+ },
+ "phone.JoinAsPeers": {
+ "desc": "A list of peers that can be used to join a group call, presenting yourself as a specific user/channel."
+ },
+ "phone.PhoneCall": {
+ "desc": "Phone call"
+ },
+ "photos.Photo": {
+ "desc": "Photo with auxiliary data."
+ },
+ "photos.Photos": {
+ "desc": "Object contains list of photos with auxiliary data."
+ },
+ "premium.BoostsList": {
+ "desc": "List of boosts that were applied to a peer by multiple users."
+ },
+ "premium.BoostsStatus": {
+ "desc": "Contains info about the current boost status of a peer."
+ },
+ "premium.MyBoosts": {
+ "desc": "A list of peers we are currently boosting, and how many boost slots we have left."
+ },
+ "smsjobs.EligibilityToJoin": {
+ "desc": "SMS jobs eligibility"
+ },
+ "smsjobs.Status": {
+ "desc": "Status"
+ },
+ "stats.BroadcastStats": {
+ "desc": "Channel statistics"
+ },
+ "stats.MegagroupStats": {
+ "desc": "Supergroup statistics"
+ },
+ "stats.MessageStats": {
+ "desc": "Message statistics"
+ },
+ "stats.PublicForwards": {
+ "desc": "Contains info about the forwards of a story as a message to public chats and reposts by public channels."
+ },
+ "stats.StoryStats": {
+ "desc": "Contains statistics about a story."
+ },
+ "stickers.SuggestedShortName": {
+ "desc": "A suggested short name for the specified stickerpack"
+ },
+ "storage.FileType": {
+ "desc": "Object describes the file type."
+ },
+ "stories.Albums": {
+ "desc": "Represents a list of story albums \u00bb."
+ },
+ "stories.AllStories": {
+ "desc": "Full list of active (or active and hidden) stories."
+ },
+ "stories.CanSendStoryCount": {
+ "desc": "Contains the number of available active story slots (equal to the value of the story_expiring_limit_* client configuration parameter minus the number of currently active stories)."
+ },
+ "stories.FoundStories": {
+ "desc": "Stories found using global story search \u00bb."
+ },
+ "stories.PeerStories": {
+ "desc": "Active story list of a specific peer."
+ },
+ "stories.Stories": {
+ "desc": "List of stories"
+ },
+ "stories.StoryReactionsList": {
+ "desc": "List of peers that reacted to a specific story"
+ },
+ "stories.StoryViews": {
+ "desc": "Reaction and view counters for a list of stories"
+ },
+ "stories.StoryViewsList": {
+ "desc": "Reaction and view counters for a story"
+ },
+ "updates.ChannelDifference": {
+ "desc": "Contains the difference (new messages) between our local channel state and the remote state"
+ },
+ "updates.Difference": {
+ "desc": "Occurred changes."
+ },
+ "updates.State": {
+ "desc": "Object contains info on state for further updates."
+ },
+ "upload.CdnFile": {
+ "desc": "Represents the download status of a CDN file"
+ },
+ "upload.File": {
+ "desc": "Contains info on file."
+ },
+ "upload.WebFile": {
+ "desc": "Remote file"
+ },
+ "users.SavedMusic": {
+ "desc": "List of songs (document.ids) currently pinned on a user's profile, see here \u00bb for more info."
+ },
+ "users.UserFull": {
+ "desc": "Full user information, with attached context peers for reactions"
+ },
+ "users.Users": {
+ "desc": "Describes a list of users (or bots)."
+ }
+ }
+}
\ No newline at end of file
diff --git a/compiler/api/source/main_api.tl b/compiler/api/source/main_api.tl
index d096b0e1..e31022ec 100644
--- a/compiler/api/source/main_api.tl
+++ b/compiler/api/source/main_api.tl
@@ -1,6 +1,6 @@
// https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/mtproto/scheme/api.tl
// https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/mtproto/scheme/layer.tl
-// https://github.com/TGScheme/TgSchemeLayers/blob/main/main_api.tl
+// https://github.com/TGScheme/Schema/blob/main/main_api.tl
///////////////////////////////
///////// Main application API
@@ -8,7 +8,7 @@
// This file is auto-generated by TLExtractor
-// Copyright (C) 2024 Laky-64
+// Copyright (C) 2025 Laky-64
---types---
@@ -47,11 +47,11 @@ inputMediaUploadedPhoto#1e287d04 flags:# spoiler:flags.2?true file:InputFile sti
inputMediaPhoto#b3ba0635 flags:# spoiler:flags.1?true id:InputPhoto ttl_seconds:flags.0?int = InputMedia;
inputMediaGeoPoint#f9c44144 geo_point:InputGeoPoint = InputMedia;
inputMediaContact#f8ab7dfb phone_number:string first_name:string last_name:string vcard:string = InputMedia;
-inputMediaUploadedDocument#5b38c6c1 flags:# nosound_video:flags.3?true force_file:flags.4?true spoiler:flags.5?true file:InputFile thumb:flags.2?InputFile mime_type:string attributes:Vector stickers:flags.0?Vector ttl_seconds:flags.1?int = InputMedia;
-inputMediaDocument#33473058 flags:# spoiler:flags.2?true id:InputDocument ttl_seconds:flags.0?int query:flags.1?string = InputMedia;
+inputMediaUploadedDocument#37c9330 flags:# nosound_video:flags.3?true force_file:flags.4?true spoiler:flags.5?true file:InputFile thumb:flags.2?InputFile mime_type:string attributes:Vector stickers:flags.0?Vector video_cover:flags.6?InputPhoto video_timestamp:flags.7?int ttl_seconds:flags.1?int = InputMedia;
+inputMediaDocument#a8763ab5 flags:# spoiler:flags.2?true id:InputDocument video_cover:flags.3?InputPhoto video_timestamp:flags.4?int ttl_seconds:flags.0?int query:flags.1?string = InputMedia;
inputMediaVenue#c13d1c11 geo_point:InputGeoPoint title:string address:string provider:string venue_id:string venue_type:string = InputMedia;
inputMediaPhotoExternal#e5bbfe1a flags:# spoiler:flags.1?true url:string ttl_seconds:flags.0?int = InputMedia;
-inputMediaDocumentExternal#fb52dc99 flags:# spoiler:flags.1?true url:string ttl_seconds:flags.0?int = InputMedia;
+inputMediaDocumentExternal#779600f9 flags:# spoiler:flags.1?true url:string ttl_seconds:flags.0?int video_cover:flags.2?InputPhoto video_timestamp:flags.3?int = InputMedia;
inputMediaGame#d33f43f3 id:InputGame = InputMedia;
inputMediaInvoice#405fef0d flags:# title:string description:string photo:flags.0?InputWebDocument invoice:Invoice payload:bytes provider:flags.3?string provider_data:DataJSON start_param:flags.1?string extended_media:flags.2?InputMedia = InputMedia;
inputMediaGeoLive#971fa843 flags:# stopped:flags.0?true geo_point:InputGeoPoint heading:flags.2?int period:flags.1?int proximity_notification_radius:flags.3?int = InputMedia;
@@ -60,6 +60,7 @@ inputMediaDice#e66fbf7b emoticon:string = InputMedia;
inputMediaStory#89fdd778 peer:InputPeer id:int = InputMedia;
inputMediaWebPage#c21b8849 flags:# force_large_media:flags.0?true force_small_media:flags.1?true optional:flags.2?true url:string = InputMedia;
inputMediaPaidMedia#c4103386 flags:# stars_amount:long extended_media:Vector payload:flags.0?string = InputMedia;
+inputMediaTodo#9fc55fde todo:TodoList = InputMedia;
inputChatPhotoEmpty#1ca48f57 = InputChatPhoto;
inputChatUploadedPhoto#bdcdaec0 flags:# file:flags.0?InputFile video:flags.1?InputFile video_start_ts:flags.2?double video_emoji_markup:flags.3?VideoSize = InputChatPhoto;
@@ -98,7 +99,7 @@ storage.fileMp4#b3cea0e4 = storage.FileType;
storage.fileWebp#1081464c = storage.FileType;
userEmpty#d3bc4b7a id:long = User;
-user#83314fca flags:# 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:# 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:long access_hash:flags.0?long first_name:flags.1?string last_name:flags.2?string username:flags.3?string phone:flags.4?string photo:flags.5?UserProfilePhoto status:flags.6?UserStatus bot_info_version:flags.14?int restriction_reason:flags.18?Vector bot_inline_placeholder:flags.19?string lang_code:flags.22?string emoji_status:flags.30?EmojiStatus usernames:flags2.0?Vector stories_max_id:flags2.5?int color:flags2.8?PeerColor profile_color:flags2.9?PeerColor bot_active_users:flags2.12?int = User;
+user#20b1422 flags:# 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:# 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 bot_forum_view:flags2.16?true id:long access_hash:flags.0?long first_name:flags.1?string last_name:flags.2?string username:flags.3?string phone:flags.4?string photo:flags.5?UserProfilePhoto status:flags.6?UserStatus bot_info_version:flags.14?int restriction_reason:flags.18?Vector bot_inline_placeholder:flags.19?string lang_code:flags.22?string emoji_status:flags.30?EmojiStatus usernames:flags2.0?Vector stories_max_id:flags2.5?int color:flags2.8?PeerColor profile_color:flags2.9?PeerColor bot_active_users:flags2.12?int bot_verification_icon:flags2.14?long send_paid_messages_stars:flags2.15?long = User;
userProfilePhotoEmpty#4f11bae1 = UserProfilePhoto;
userProfilePhoto#82d1f706 flags:# has_video:flags.0?true personal:flags.2?true photo_id:long stripped_thumb:flags.1?bytes dc_id:int = UserProfilePhoto;
@@ -109,15 +110,16 @@ userStatusOffline#8c703f was_online:int = UserStatus;
userStatusRecently#7b197dc8 flags:# by_me:flags.0?true = UserStatus;
userStatusLastWeek#541a1d1a flags:# by_me:flags.0?true = UserStatus;
userStatusLastMonth#65899777 flags:# by_me:flags.0?true = UserStatus;
+userStatusHidden#cf7d64b1 = UserStatus;
chatEmpty#29562865 id:long = Chat;
-chat#41cbf256 flags:# 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:long title:string photo:ChatPhoto participants_count:int date:int version:int migrated_to:flags.6?InputChannel admin_rights:flags.14?ChatAdminRights default_banned_rights:flags.18?ChatBannedRights = Chat;
+chat#41cbf256 flags:# creator:flags.0?true kicked:flags.1?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:long title:string photo:ChatPhoto participants_count:int date:int version:int migrated_to:flags.6?InputChannel admin_rights:flags.14?ChatAdminRights default_banned_rights:flags.18?ChatBannedRights = Chat;
chatForbidden#6592a1a7 id:long title:string = Chat;
-channel#fe4478bd flags:# 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:# stories_hidden:flags2.1?true stories_hidden_min:flags2.2?true stories_unavailable:flags2.3?true signature_profiles:flags2.12?true id:long access_hash:flags.13?long title:string username:flags.6?string photo:ChatPhoto date:int restriction_reason:flags.9?Vector admin_rights:flags.14?ChatAdminRights banned_rights:flags.15?ChatBannedRights default_banned_rights:flags.18?ChatBannedRights participants_count:flags.17?int usernames:flags2.0?Vector stories_max_id:flags2.4?int color:flags2.7?PeerColor profile_color:flags2.8?PeerColor emoji_status:flags2.9?EmojiStatus level:flags2.10?int subscription_until_date:flags2.11?int = Chat;
+channel#fe685355 flags:# 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:# stories_hidden:flags2.1?true stories_hidden_min:flags2.2?true stories_unavailable:flags2.3?true signature_profiles:flags2.12?true autotranslation:flags2.15?true broadcast_messages_allowed:flags2.16?true monoforum:flags2.17?true forum_tabs:flags2.19?true id:long access_hash:flags.13?long title:string username:flags.6?string photo:ChatPhoto date:int restriction_reason:flags.9?Vector admin_rights:flags.14?ChatAdminRights banned_rights:flags.15?ChatBannedRights default_banned_rights:flags.18?ChatBannedRights participants_count:flags.17?int usernames:flags2.0?Vector stories_max_id:flags2.4?int color:flags2.7?PeerColor profile_color:flags2.8?PeerColor emoji_status:flags2.9?EmojiStatus level:flags2.10?int subscription_until_date:flags2.11?int bot_verification_icon:flags2.13?long send_paid_messages_stars:flags2.14?long linked_monoforum_id:flags2.18?long = Chat;
channelForbidden#17d493d5 flags:# broadcast:flags.5?true megagroup:flags.8?true id:long access_hash:long title:string until_date:flags.16?int = Chat;
chatFull#2633421b flags:# can_set_username:flags.7?true has_scheduled:flags.8?true translations_disabled:flags.19?true id:long about:string participants:ChatParticipants chat_photo:flags.2?Photo notify_settings:PeerNotifySettings exported_invite:flags.13?ExportedChatInvite bot_info:flags.3?Vector pinned_msg_id:flags.6?int folder_id:flags.11?int call:flags.12?InputGroupCall ttl_period:flags.14?int groupcall_default_join_as:flags.15?Peer theme_emoticon:flags.16?string requests_pending:flags.17?int recent_requesters:flags.17?Vector available_reactions:flags.18?ChatReactions reactions_limit:flags.20?int = ChatFull;
-channelFull#bbab348d flags:# can_view_participants:flags.3?true can_set_username:flags.6?true can_set_stickers:flags.7?true hidden_prehistory:flags.10?true can_set_location:flags.16?true has_scheduled:flags.19?true can_view_stats:flags.20?true blocked:flags.22?true flags2:# can_delete_channel:flags2.0?true antispam:flags2.1?true participants_hidden:flags2.2?true translations_disabled:flags2.3?true stories_pinned_available:flags2.5?true view_forum_as_messages:flags2.6?true restricted_sponsored:flags2.11?true can_view_revenue:flags2.12?true paid_media_allowed:flags2.14?true can_view_stars_revenue:flags2.15?true paid_reactions_available:flags2.16?true id:long about:string participants_count:flags.0?int admins_count:flags.1?int kicked_count:flags.2?int banned_count:flags.2?int online_count:flags.13?int read_inbox_max_id:int read_outbox_max_id:int unread_count:int chat_photo:Photo notify_settings:PeerNotifySettings exported_invite:flags.23?ExportedChatInvite bot_info:Vector migrated_from_chat_id:flags.4?long migrated_from_max_id:flags.4?int pinned_msg_id:flags.5?int stickerset:flags.8?StickerSet available_min_id:flags.9?int folder_id:flags.11?int linked_chat_id:flags.14?long location:flags.15?ChannelLocation slowmode_seconds:flags.17?int slowmode_next_send_date:flags.18?int stats_dc:flags.12?int pts:int call:flags.21?InputGroupCall ttl_period:flags.24?int pending_suggestions:flags.25?Vector groupcall_default_join_as:flags.26?Peer theme_emoticon:flags.27?string requests_pending:flags.28?int recent_requesters:flags.28?Vector default_send_as:flags.29?Peer available_reactions:flags.30?ChatReactions reactions_limit:flags2.13?int stories:flags2.4?PeerStories wallpaper:flags2.7?WallPaper boosts_applied:flags2.8?int boosts_unrestrict:flags2.9?int emojiset:flags2.10?StickerSet = ChatFull;
+channelFull#e4e0b29d flags:# can_view_participants:flags.3?true can_set_username:flags.6?true can_set_stickers:flags.7?true hidden_prehistory:flags.10?true can_set_location:flags.16?true has_scheduled:flags.19?true can_view_stats:flags.20?true blocked:flags.22?true flags2:# can_delete_channel:flags2.0?true antispam:flags2.1?true participants_hidden:flags2.2?true translations_disabled:flags2.3?true stories_pinned_available:flags2.5?true view_forum_as_messages:flags2.6?true restricted_sponsored:flags2.11?true can_view_revenue:flags2.12?true paid_media_allowed:flags2.14?true can_view_stars_revenue:flags2.15?true paid_reactions_available:flags2.16?true stargifts_available:flags2.19?true paid_messages_available:flags2.20?true id:long about:string participants_count:flags.0?int admins_count:flags.1?int kicked_count:flags.2?int banned_count:flags.2?int online_count:flags.13?int read_inbox_max_id:int read_outbox_max_id:int unread_count:int chat_photo:Photo notify_settings:PeerNotifySettings exported_invite:flags.23?ExportedChatInvite bot_info:Vector migrated_from_chat_id:flags.4?long migrated_from_max_id:flags.4?int pinned_msg_id:flags.5?int stickerset:flags.8?StickerSet available_min_id:flags.9?int folder_id:flags.11?int linked_chat_id:flags.14?long location:flags.15?ChannelLocation slowmode_seconds:flags.17?int slowmode_next_send_date:flags.18?int stats_dc:flags.12?int pts:int call:flags.21?InputGroupCall ttl_period:flags.24?int pending_suggestions:flags.25?Vector groupcall_default_join_as:flags.26?Peer theme_emoticon:flags.27?string requests_pending:flags.28?int recent_requesters:flags.28?Vector default_send_as:flags.29?Peer available_reactions:flags.30?ChatReactions reactions_limit:flags2.13?int stories:flags2.4?PeerStories wallpaper:flags2.7?WallPaper boosts_applied:flags2.8?int boosts_unrestrict:flags2.9?int emojiset:flags2.10?StickerSet bot_verification:flags2.17?BotVerification stargifts_count:flags2.18?int send_paid_messages_stars:flags2.21?long main_tab:flags2.22?ProfileTab = ChatFull;
chatParticipant#c02d4007 user_id:long inviter_id:long date:int = ChatParticipant;
chatParticipantCreator#e46bcee4 user_id:long = ChatParticipant;
@@ -130,15 +132,15 @@ chatPhotoEmpty#37c1011c = ChatPhoto;
chatPhoto#1c6e1c11 flags:# has_video:flags.0?true photo_id:long stripped_thumb:flags.1?bytes dc_id:int = ChatPhoto;
messageEmpty#90a6ca84 flags:# id:int peer_id:flags.0?Peer = Message;
-message#94345242 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true post:flags.14?true from_scheduled:flags.18?true legacy:flags.19?true edit_hide:flags.21?true pinned:flags.24?true noforwards:flags.26?true invert_media:flags.27?true flags2:# offline:flags2.1?true id:int from_id:flags.8?Peer from_boosts_applied:flags.29?int peer_id:Peer saved_peer_id:flags.28?Peer fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long via_business_bot_id:flags2.0?long reply_to:flags.3?MessageReplyHeader date:int message:string media:flags.9?MessageMedia reply_markup:flags.6?ReplyMarkup entities:flags.7?Vector views:flags.10?int forwards:flags.10?int replies:flags.23?MessageReplies edit_date:flags.15?int post_author:flags.16?string grouped_id:flags.17?long reactions:flags.20?MessageReactions restriction_reason:flags.22?Vector ttl_period:flags.25?int quick_reply_shortcut_id:flags.30?int effect:flags2.2?long factcheck:flags2.3?FactCheck = Message;
-messageService#2b085862 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true post:flags.14?true legacy:flags.19?true id:int from_id:flags.8?Peer peer_id:Peer reply_to:flags.3?MessageReplyHeader date:int action:MessageAction ttl_period:flags.25?int = Message;
+message#9815cec8 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true post:flags.14?true from_scheduled:flags.18?true legacy:flags.19?true edit_hide:flags.21?true pinned:flags.24?true noforwards:flags.26?true invert_media:flags.27?true flags2:# offline:flags2.1?true video_processing_pending:flags2.4?true paid_suggested_post_stars:flags2.8?true paid_suggested_post_ton:flags2.9?true id:int from_id:flags.8?Peer from_boosts_applied:flags.29?int peer_id:Peer saved_peer_id:flags.28?Peer fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long via_business_bot_id:flags2.0?long reply_to:flags.3?MessageReplyHeader date:int message:string media:flags.9?MessageMedia reply_markup:flags.6?ReplyMarkup entities:flags.7?Vector views:flags.10?int forwards:flags.10?int replies:flags.23?MessageReplies edit_date:flags.15?int post_author:flags.16?string grouped_id:flags.17?long reactions:flags.20?MessageReactions restriction_reason:flags.22?Vector ttl_period:flags.25?int quick_reply_shortcut_id:flags.30?int effect:flags2.2?long factcheck:flags2.3?FactCheck report_delivery_until_date:flags2.5?int paid_message_stars:flags2.6?long suggested_post:flags2.7?SuggestedPost = Message;
+messageService#7a800e0a flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true reactions_are_possible:flags.9?true silent:flags.13?true post:flags.14?true legacy:flags.19?true id:int from_id:flags.8?Peer peer_id:Peer saved_peer_id:flags.28?Peer reply_to:flags.3?MessageReplyHeader date:int action:MessageAction reactions:flags.20?MessageReactions ttl_period:flags.25?int = Message;
messageMediaEmpty#3ded6320 = MessageMedia;
messageMediaPhoto#695150d7 flags:# spoiler:flags.3?true photo:flags.0?Photo ttl_seconds:flags.2?int = MessageMedia;
messageMediaGeo#56e0d474 geo:GeoPoint = MessageMedia;
messageMediaContact#70322949 phone_number:string first_name:string last_name:string vcard:string user_id:long = MessageMedia;
messageMediaUnsupported#9f84f49e = MessageMedia;
-messageMediaDocument#4cf4d72d flags:# nopremium:flags.3?true spoiler:flags.4?true video:flags.6?true round:flags.7?true voice:flags.8?true document:flags.0?Document alt_document:flags.5?Document ttl_seconds:flags.2?int = MessageMedia;
+messageMediaDocument#52d8ccd9 flags:# nopremium:flags.3?true spoiler:flags.4?true video:flags.6?true round:flags.7?true voice:flags.8?true document:flags.0?Document alt_documents:flags.5?Vector video_cover:flags.9?Photo video_timestamp:flags.10?int ttl_seconds:flags.2?int = MessageMedia;
messageMediaWebPage#ddf10c3b flags:# force_large_media:flags.0?true force_small_media:flags.1?true manual:flags.3?true safe:flags.4?true webpage:WebPage = MessageMedia;
messageMediaVenue#2ec0533f geo:GeoPoint title:string address:string provider:string venue_id:string venue_type:string = MessageMedia;
messageMediaGame#fdb19008 game:Game = MessageMedia;
@@ -150,6 +152,7 @@ messageMediaStory#68cb6283 flags:# via_mention:flags.1?true peer:Peer id:int sto
messageMediaGiveaway#aa073beb flags:# only_new_subscribers:flags.0?true winners_are_visible:flags.2?true channels:Vector countries_iso2:flags.1?Vector prize_description:flags.3?string quantity:int months:flags.4?int stars:flags.5?long until_date:int = MessageMedia;
messageMediaGiveawayResults#ceaa3ea1 flags:# only_new_subscribers:flags.0?true refunded:flags.2?true channel_id:long additional_peers_count:flags.3?int launch_msg_id:int winners_count:int unclaimed_count:int winners:Vector months:flags.4?int stars:flags.5?long prize_description:flags.1?string until_date:int = MessageMedia;
messageMediaPaidMedia#a8852491 stars_amount:long extended_media:Vector = MessageMedia;
+messageMediaToDo#8a53b014 flags:# todo:TodoList completions:flags.0?Vector = MessageMedia;
messageActionEmpty#b6aef7b0 = MessageAction;
messageActionChatCreate#bd47cbad title:string users:Vector = MessageAction;
@@ -165,8 +168,8 @@ messageActionChannelMigrateFrom#ea3948e9 title:string chat_id:long = MessageActi
messageActionPinMessage#94bd38ed = MessageAction;
messageActionHistoryClear#9fbab604 = MessageAction;
messageActionGameScore#92a72876 game_id:long score:int = MessageAction;
-messageActionPaymentSentMe#8f31b327 flags:# recurring_init:flags.2?true recurring_used:flags.3?true currency:string total_amount:long payload:bytes info:flags.0?PaymentRequestedInfo shipping_option_id:flags.1?string charge:PaymentCharge = MessageAction;
-messageActionPaymentSent#96163f56 flags:# recurring_init:flags.2?true recurring_used:flags.3?true currency:string total_amount:long invoice_slug:flags.0?string = MessageAction;
+messageActionPaymentSentMe#ffa00ccc flags:# recurring_init:flags.2?true recurring_used:flags.3?true currency:string total_amount:long payload:bytes info:flags.0?PaymentRequestedInfo shipping_option_id:flags.1?string charge:PaymentCharge subscription_until_date:flags.4?int = MessageAction;
+messageActionPaymentSent#c624b16e flags:# recurring_init:flags.2?true recurring_used:flags.3?true currency:string total_amount:long invoice_slug:flags.0?string subscription_until_date:flags.4?int = MessageAction;
messageActionPhoneCall#80e11a7f flags:# video:flags.2?true call_id:long reason:flags.0?PhoneCallDiscardReason duration:flags.1?int = MessageAction;
messageActionScreenshotTaken#4792929b = MessageAction;
messageActionCustomAction#fae69f56 message:string = MessageAction;
@@ -179,17 +182,17 @@ messageActionGroupCall#7a0d7f42 flags:# call:InputGroupCall duration:flags.0?int
messageActionInviteToGroupCall#502f92f7 call:InputGroupCall users:Vector = MessageAction;
messageActionSetMessagesTTL#3c134d7b flags:# period:int auto_setting_from:flags.0?long = MessageAction;
messageActionGroupCallScheduled#b3a07661 call:InputGroupCall schedule_date:int = MessageAction;
-messageActionSetChatTheme#aa786345 emoticon:string = MessageAction;
+messageActionSetChatTheme#b91bbd3a theme:ChatTheme = MessageAction;
messageActionChatJoinedByRequest#ebbca3cb = MessageAction;
messageActionWebViewDataSentMe#47dd8079 text:string data:string = MessageAction;
messageActionWebViewDataSent#b4c38cb5 text:string = MessageAction;
-messageActionGiftPremium#c83d6aec flags:# currency:string amount:long months:int crypto_currency:flags.0?string crypto_amount:flags.0?long = MessageAction;
-messageActionTopicCreate#d999256 flags:# title:string icon_color:int icon_emoji_id:flags.0?long = MessageAction;
+messageActionGiftPremium#6c6274fa flags:# currency:string amount:long months:int crypto_currency:flags.0?string crypto_amount:flags.0?long message:flags.1?TextWithEntities = MessageAction;
+messageActionTopicCreate#d999256 flags:# title_missing:flags.1?true title:string icon_color:int icon_emoji_id:flags.0?long = MessageAction;
messageActionTopicEdit#c0944820 flags:# title:flags.0?string icon_emoji_id:flags.1?long closed:flags.2?Bool hidden:flags.3?Bool = MessageAction;
messageActionSuggestProfilePhoto#57de635e photo:Photo = MessageAction;
messageActionRequestedPeer#31518e9b button_id:int peers:Vector = MessageAction;
messageActionSetChatWallPaper#5060a3f4 flags:# same:flags.0?true for_both:flags.1?true wallpaper:WallPaper = MessageAction;
-messageActionGiftCode#678c2e09 flags:# via_giveaway:flags.0?true unclaimed:flags.2?true boost_peer:flags.1?Peer months:int slug:string currency:flags.2?string amount:flags.2?long crypto_currency:flags.3?string crypto_amount:flags.3?long = MessageAction;
+messageActionGiftCode#56d03994 flags:# via_giveaway:flags.0?true unclaimed:flags.5?true boost_peer:flags.1?Peer months:int slug:string currency:flags.2?string amount:flags.2?long crypto_currency:flags.3?string crypto_amount:flags.3?long message:flags.4?TextWithEntities = MessageAction;
messageActionGiveawayLaunch#a80f51e4 flags:# stars:flags.0?long = MessageAction;
messageActionGiveawayResults#87e2f155 flags:# stars:flags.0?true winners_count:int unclaimed_count:int = MessageAction;
messageActionBoostApply#cc02aa6d boosts:int = MessageAction;
@@ -197,6 +200,24 @@ messageActionRequestedPeerSentMe#93b31848 button_id:int peers:Vector = MessageAction;
+messageActionTodoCompletions#cc7c5c89 completed:Vector incompleted:Vector = MessageAction;
+messageActionTodoAppendTasks#c7edbc83 list:Vector = MessageAction;
+messageActionSuggestedPostApproval#ee7a1596 flags:# rejected:flags.0?true balance_too_low:flags.1?true reject_comment:flags.2?string schedule_date:flags.3?int price:flags.4?StarsAmount = MessageAction;
+messageActionSuggestedPostSuccess#95ddcf69 price:StarsAmount = MessageAction;
+messageActionSuggestedPostRefund#69f916f8 flags:# payer_initiated:flags.0?true = MessageAction;
+messageActionGiftTon#a8a3c699 flags:# currency:string amount:long crypto_currency:string crypto_amount:long transaction_id:flags.0?string = MessageAction;
+messageActionPhoneNumberRequest#1baa035 = MessageAction;
+messageActionSuggestBirthday#2c8f2a25 birthday:Birthday = MessageAction;
+messageActionUserJoined#55555550 = MessageAction;
+messageActionUserUpdatedPhoto#55555551 new_user_photo:UserProfilePhoto = MessageAction;
+messageActionTTLChange#55555552 ttl:int = MessageAction;
+messageActionCreatedBroadcastList#55555557 = MessageAction;
+messageActionLoginUnknownLocation#555555f5 title:string address:string = MessageAction;
dialog#d58a08c6 flags:# pinned:flags.2?true unread_mark:flags.3?true view_forum_as_messages:flags.6?true peer:Peer top_message:int read_inbox_max_id:int read_outbox_max_id:int unread_count:int unread_mentions_count:int unread_reactions_count:int notify_settings:PeerNotifySettings pts:flags.0?int draft:flags.1?DraftMessage folder_id:flags.4?int ttl_period:flags.5?int = Dialog;
dialogFolder#71bd134c flags:# pinned:flags.2?true folder:Folder peer:Peer top_message:int unread_muted_peers_count:int unread_unmuted_peers_count:int unread_muted_messages_count:int unread_unmuted_messages_count:int = Dialog;
@@ -216,6 +237,7 @@ geoPoint#b2a2f663 flags:# long:double lat:double access_hash:long accuracy_radiu
auth.sentCode#5e002502 flags:# type:auth.SentCodeType phone_code_hash:string next_type:flags.1?auth.CodeType timeout:flags.2?int = auth.SentCode;
auth.sentCodeSuccess#2390fe44 authorization:auth.Authorization = auth.SentCode;
+auth.sentCodePaymentRequired#e0955a3c store_product:string phone_code_hash:string support_email_address:string support_email_subject:string currency:string amount:long = auth.SentCode;
auth.authorization#2ea2c0d4 flags:# setup_password_required:flags.1?true otherwise_relogin_days:flags.1?int tmp_sessions:flags.0?int future_auth_token:flags.2?bytes user:User = auth.Authorization;
auth.authorizationSignUpRequired#44747e9a flags:# terms_of_service:flags.0?help.TermsOfService = auth.Authorization;
@@ -232,7 +254,7 @@ inputPeerNotifySettings#cacb6ae2 flags:# show_previews:flags.0?Bool silent:flags
peerNotifySettings#99622c0c flags:# show_previews:flags.0?Bool silent:flags.1?Bool mute_until:flags.2?int ios_sound:flags.3?NotificationSound android_sound:flags.4?NotificationSound other_sound:flags.5?NotificationSound stories_muted:flags.6?Bool stories_hide_sender:flags.7?Bool stories_ios_sound:flags.8?NotificationSound stories_android_sound:flags.9?NotificationSound stories_other_sound:flags.10?NotificationSound = PeerNotifySettings;
-peerSettings#acd66c5e flags:# report_spam:flags.0?true add_contact:flags.1?true block_contact:flags.2?true share_contact:flags.3?true need_contacts_exception:flags.4?true report_geo:flags.5?true autoarchived:flags.7?true invite_members:flags.8?true request_chat_broadcast:flags.10?true business_bot_paused:flags.11?true business_bot_can_reply:flags.12?true geo_distance:flags.6?int request_chat_title:flags.9?string request_chat_date:flags.9?int business_bot_id:flags.13?long business_bot_manage_url:flags.13?string = PeerSettings;
+peerSettings#f47741f7 flags:# report_spam:flags.0?true add_contact:flags.1?true block_contact:flags.2?true share_contact:flags.3?true need_contacts_exception:flags.4?true report_geo:flags.5?true autoarchived:flags.7?true invite_members:flags.8?true request_chat_broadcast:flags.10?true business_bot_paused:flags.11?true business_bot_can_reply:flags.12?true geo_distance:flags.6?int request_chat_title:flags.9?string request_chat_date:flags.9?int business_bot_id:flags.13?long business_bot_manage_url:flags.13?string charge_paid_message_stars:flags.14?long registration_month:flags.15?string phone_country:flags.16?string name_change_date:flags.17?int photo_change_date:flags.18?int = PeerSettings;
wallPaper#a437c3ed id:long flags:# creator:flags.0?true default:flags.1?true pattern:flags.3?true dark:flags.4?true access_hash:long slug:string document:Document settings:flags.2?WallPaperSettings = WallPaper;
wallPaperNoFile#e0804116 id:long flags:# default:flags.1?true dark:flags.4?true settings:flags.2?WallPaperSettings = WallPaper;
@@ -248,7 +270,7 @@ inputReportReasonFake#f5ddd6e7 = ReportReason;
inputReportReasonIllegalDrugs#a8eb2be = ReportReason;
inputReportReasonPersonalDetails#9ec7863d = ReportReason;
-userFull#cc997720 flags:# blocked:flags.0?true phone_calls_available:flags.4?true phone_calls_private:flags.5?true can_pin_message:flags.7?true has_scheduled:flags.12?true video_calls_available:flags.13?true voice_messages_forbidden:flags.20?true translations_disabled:flags.23?true stories_pinned_available:flags.26?true blocked_my_stories_from:flags.27?true wallpaper_overridden:flags.28?true contact_require_premium:flags.29?true read_dates_private:flags.30?true flags2:# sponsored_enabled:flags2.7?true id:long about:flags.1?string settings:PeerSettings personal_photo:flags.21?Photo profile_photo:flags.2?Photo fallback_photo:flags.22?Photo notify_settings:PeerNotifySettings bot_info:flags.3?BotInfo pinned_msg_id:flags.6?int common_chats_count:int folder_id:flags.11?int ttl_period:flags.14?int theme_emoticon:flags.15?string private_forward_name:flags.16?string bot_group_admin_rights:flags.17?ChatAdminRights bot_broadcast_admin_rights:flags.18?ChatAdminRights premium_gifts:flags.19?Vector wallpaper:flags.24?WallPaper stories:flags.25?PeerStories business_work_hours:flags2.0?BusinessWorkHours business_location:flags2.1?BusinessLocation business_greeting_message:flags2.2?BusinessGreetingMessage business_away_message:flags2.3?BusinessAwayMessage business_intro:flags2.4?BusinessIntro birthday:flags2.5?Birthday personal_channel_id:flags2.6?long personal_channel_message:flags2.6?int = UserFull;
+userFull#a02bc13e flags:# blocked:flags.0?true phone_calls_available:flags.4?true phone_calls_private:flags.5?true can_pin_message:flags.7?true has_scheduled:flags.12?true video_calls_available:flags.13?true voice_messages_forbidden:flags.20?true translations_disabled:flags.23?true stories_pinned_available:flags.26?true blocked_my_stories_from:flags.27?true wallpaper_overridden:flags.28?true contact_require_premium:flags.29?true read_dates_private:flags.30?true flags2:# sponsored_enabled:flags2.7?true can_view_revenue:flags2.9?true bot_can_manage_emoji_status:flags2.10?true display_gifts_button:flags2.16?true id:long about:flags.1?string settings:PeerSettings personal_photo:flags.21?Photo profile_photo:flags.2?Photo fallback_photo:flags.22?Photo notify_settings:PeerNotifySettings bot_info:flags.3?BotInfo pinned_msg_id:flags.6?int common_chats_count:int folder_id:flags.11?int ttl_period:flags.14?int theme:flags.15?ChatTheme private_forward_name:flags.16?string bot_group_admin_rights:flags.17?ChatAdminRights bot_broadcast_admin_rights:flags.18?ChatAdminRights wallpaper:flags.24?WallPaper stories:flags.25?PeerStories business_work_hours:flags2.0?BusinessWorkHours business_location:flags2.1?BusinessLocation business_greeting_message:flags2.2?BusinessGreetingMessage business_away_message:flags2.3?BusinessAwayMessage business_intro:flags2.4?BusinessIntro birthday:flags2.5?Birthday personal_channel_id:flags2.6?long personal_channel_message:flags2.6?int stargifts_count:flags2.8?int starref_program:flags2.11?StarRefProgram bot_verification:flags2.12?BotVerification send_paid_messages_stars:flags2.14?long disallowed_stargifts:flags2.15?DisallowedGiftsSettings stars_rating:flags2.17?StarsRating stars_my_pending_rating:flags2.18?StarsRating stars_my_pending_rating_date:flags2.18?int main_tab:flags2.20?ProfileTab saved_music:flags2.21?Document note:flags2.22?TextWithEntities = UserFull;
contact#145ade0b user_id:long mutual:Bool = Contact;
@@ -268,8 +290,8 @@ messages.dialogs#15ba6c40 dialogs:Vector
