double ? = Double;

string ? = String;

int32 = Int32;

int53 = Int53;

int64 = Int64;

bytes = Bytes;

boolFalse = Bool;

boolTrue = Bool;

vector {t:Type} # [ t ] = Vector t;

//@description An object of this type can be returned on every function call, in case of an error

//@code Error code; subject to future changes. If the error code is 406, the error message must not be processed in any way and must not be displayed to the user

//@message Error message; subject to future changes

error code:int32 message:string = Error;

//@description An object of this type is returned on a successful function call for certain functions

ok = Ok;

//@description Contains parameters for TDLib initialization

//@use_test_dc If set to true, the Telegram test environment will be used instead of the production environment

//@database_directory The path to the directory for the persistent database; if empty, the current working directory will be used

//@files_directory The path to the directory for storing files; if empty, database_directory will be used

//@use_file_database If set to true, information about downloaded and uploaded files will be saved between application restarts

//@use_chat_info_database If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats. Implies use_file_database

//@use_message_database If set to true, the library will maintain a cache of chats and messages. Implies use_chat_info_database

//@use_secret_chats If set to true, support for secret chats will be enabled

//@api_id Application identifier for Telegram API access, which can be obtained at https://my.telegram.org

//@api_hash Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org

//@system_language_code IETF language tag of the user's operating system language; must be non-empty

//@device_model Model of the device the application is being run on; must be non-empty

//@system_version Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib

//@application_version Application version; must be non-empty

//@enable_storage_optimizer If set to true, old files will automatically be deleted

//@ignore_file_names If set to true, original file names will be ignored. Otherwise, downloaded files will be saved under names as close as possible to the original name

tdlibParameters use_test_dc:Bool database_directory:string files_directory:string use_file_database:Bool use_chat_info_database:Bool use_message_database:Bool use_secret_chats:Bool api_id:int32 api_hash:string system_language_code:string device_model:string system_version:string application_version:string enable_storage_optimizer:Bool ignore_file_names:Bool = TdlibParameters;

//@class AuthenticationCodeType @description Provides information about the method by which an authentication code is delivered to the user

//@description An authentication code is delivered via a private Telegram message, which can be viewed from another active session @length Length of the code

authenticationCodeTypeTelegramMessage length:int32 = AuthenticationCodeType;

//@description An authentication code is delivered via an SMS message to the specified phone number @length Length of the code

authenticationCodeTypeSms length:int32 = AuthenticationCodeType;

//@description An authentication code is delivered via a phone call to the specified phone number @length Length of the code

authenticationCodeTypeCall length:int32 = AuthenticationCodeType;

//@description An authentication code is delivered by an immediately canceled call to the specified phone number. The phone number that calls is the code that must be entered automatically @pattern Pattern of the phone number from which the call will be made

authenticationCodeTypeFlashCall pattern:string = AuthenticationCodeType;

//@description An authentication code is delivered by an immediately canceled call to the specified phone number. The last digits of the phone number that calls are the code that must be entered manually by the user @phone_number_prefix Prefix of the phone number from which the call will be made @length Number of digits in the code, excluding the prefix

authenticationCodeTypeMissedCall phone_number_prefix:string length:int32 = AuthenticationCodeType;

//@description Information about the authentication code that was sent @phone_number A phone number that is being authenticated @type The way the code was sent to the user @next_type The way the next code will be sent to the user; may be null @timeout Timeout before the code can be re-sent, in seconds

authenticationCodeInfo phone_number:string type:AuthenticationCodeType next_type:AuthenticationCodeType timeout:int32 = AuthenticationCodeInfo;

//@description Information about the email address authentication code that was sent @email_address_pattern Pattern of the email address to which an authentication code was sent @length Length of the code; 0 if unknown

emailAddressAuthenticationCodeInfo email_address_pattern:string length:int32 = EmailAddressAuthenticationCodeInfo;

//@description Represents a part of the text that needs to be formatted in some unusual way @offset Offset of the entity, in UTF-16 code units @length Length of the entity, in UTF-16 code units @type Type of the entity

textEntity offset:int32 length:int32 type:TextEntityType = TextEntity;

//@description Contains a list of text entities @entities List of text entities

textEntities entities:vector<textEntity> = TextEntities;

//@description A text with some entities @text The text @entities Entities contained in the text. Entities can be nested, but must not mutually intersect with each other.

//-Pre, Code and PreCode entities can't contain other entities. Bold, Italic, Underline, Strikethrough, and Spoiler entities can contain and to be contained in all other entities. All other entities can't contain each other

formattedText text:string entities:vector<textEntity> = FormattedText;

//@description Contains Telegram terms of service @text Text of the terms of service @min_user_age The minimum age of a user to be able to accept the terms; 0 if any @show_popup True, if a blocking popup with terms of service must be shown to the user

termsOfService text:formattedText min_user_age:int32 show_popup:Bool = TermsOfService;

//@class AuthorizationState @description Represents the current authorization state of the TDLib client

//@description TDLib needs TdlibParameters for initialization

authorizationStateWaitTdlibParameters = AuthorizationState;

//@description TDLib needs an encryption key to decrypt the local database @is_encrypted True, if the database is currently encrypted

authorizationStateWaitEncryptionKey is_encrypted:Bool = AuthorizationState;

//@description TDLib needs the user's phone number to authorize. Call `setAuthenticationPhoneNumber` to provide the phone number, or use `requestQrCodeAuthentication`, or `checkAuthenticationBotToken` for other authentication options

authorizationStateWaitPhoneNumber = AuthorizationState;

//@description TDLib needs the user's authentication code to authorize @code_info Information about the authorization code that was sent

authorizationStateWaitCode code_info:authenticationCodeInfo = AuthorizationState;

//@description The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link @link A tg:// URL for the QR code. The link will be updated frequently

authorizationStateWaitOtherDeviceConfirmation link:string = AuthorizationState;

//@description The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration @terms_of_service Telegram terms of service

authorizationStateWaitRegistration terms_of_service:termsOfService = AuthorizationState;

//@description The user has been authorized, but needs to enter a password to start using the application @password_hint Hint for the password; may be empty @has_recovery_email_address True, if a recovery email address has been set up

//@recovery_email_address_pattern Pattern of the email address to which the recovery email was sent; empty until a recovery email has been sent

authorizationStateWaitPassword password_hint:string has_recovery_email_address:Bool recovery_email_address_pattern:string = AuthorizationState;

//@description The user has been successfully authorized. TDLib is now ready to answer queries

authorizationStateReady = AuthorizationState;

//@description The user is currently logging out

authorizationStateLoggingOut = AuthorizationState;

//@description TDLib is closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a while. All resources will be freed only after authorizationStateClosed has been received

authorizationStateClosing = AuthorizationState;

//@description TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All queries will be responded to

//-with error code 500. To continue working, one must create a new instance of the TDLib client

authorizationStateClosed = AuthorizationState;

//@description Represents the current state of 2-step verification @has_password True, if a 2-step verification password is set @password_hint Hint for the password; may be empty

//@has_recovery_email_address True, if a recovery email is set @has_passport_data True, if some Telegram Passport elements were saved

//@recovery_email_address_code_info Information about the recovery email address to which the confirmation email was sent; may be null

//@pending_reset_date If not 0, point in time (Unix timestamp) after which the password can be reset immediately using resetPassword

passwordState has_password:Bool password_hint:string has_recovery_email_address:Bool has_passport_data:Bool recovery_email_address_code_info:emailAddressAuthenticationCodeInfo pending_reset_date:int32 = PasswordState;

//@description Contains information about the current recovery email address @recovery_email_address Recovery email address

recoveryEmailAddress recovery_email_address:string = RecoveryEmailAddress;

//@description Returns information about the availability of a temporary password, which can be used for payments @has_password True, if a temporary password is available @valid_for Time left before the temporary password expires, in seconds

temporaryPasswordState has_password:Bool valid_for:int32 = TemporaryPasswordState;

//@description Represents a local file

//@path Local path to the locally available file part; may be empty

//@can_be_downloaded True, if it is possible to download or generate the file

//@can_be_deleted True, if the file can be deleted

//@is_downloading_active True, if the file is currently being downloaded (or a local copy is being generated by some other means)

//@is_downloading_completed True, if the local copy is fully available

//@download_offset Download will be started from this offset. downloaded_prefix_size is calculated from this offset

//@downloaded_prefix_size If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes

//@downloaded_size Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage

localFile path:string can_be_downloaded:Bool can_be_deleted:Bool is_downloading_active:Bool is_downloading_completed:Bool download_offset:int32 downloaded_prefix_size:int32 downloaded_size:int32 = LocalFile;

//@description Represents a remote file

//@id Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers.

//-If the ID starts with "http://" or "https://", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known.

//-If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and "#url#" as the conversion string. Application must generate the file by downloading it to the specified location

//@unique_id Unique file identifier; may be empty if unknown. The unique file identifier which is the same for the same file even for different users and is persistent over time

//@is_uploading_active True, if the file is currently being uploaded (or a remote copy is being generated by some other means)

//@is_uploading_completed True, if a remote copy is fully available

//@uploaded_size Size of the remote available part of the file, in bytes; 0 if unknown

remoteFile id:string unique_id:string is_uploading_active:Bool is_uploading_completed:Bool uploaded_size:int32 = RemoteFile;

//@description Represents a file

//@id Unique file identifier

//@size File size, in bytes; 0 if unknown

//@expected_size Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress

//@local Information about the local copy of the file

//@remote Information about the remote copy of the file

file id:int32 size:int32 expected_size:int32 local:localFile remote:remoteFile = File;

//@class InputFile @description Points to a file

//@description A file defined by its unique ID @id Unique file identifier

inputFileId id:int32 = InputFile;

//@description A file defined by its remote ID. The remote ID is guaranteed to be usable only if the corresponding file is still accessible to the user and known to TDLib.

//-For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application

//@id Remote file identifier

inputFileRemote id:string = InputFile;

//@description A file defined by a local path @path Local path to the file

inputFileLocal path:string = InputFile;

//@description A file generated by the application @original_path Local path to a file from which the file is generated; may be empty if there is no such file

//@conversion String specifying the conversion applied to the original file; must be persistent across application restarts. Conversions beginning with '#' are reserved for internal TDLib usage

//@expected_size Expected size of the generated file, in bytes; 0 if unknown

inputFileGenerated original_path:string conversion:string expected_size:int32 = InputFile;

//@description Describes an image in JPEG format @type Image type (see https://core.telegram.org/constructor/photoSize)

//@photo Information about the image file @width Image width @height Image height

//@progressive_sizes Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image; in bytes

photoSize type:string photo:file width:int32 height:int32 progressive_sizes:vector<int32> = PhotoSize;

//@description Thumbnail image of a very poor quality and low resolution @width Thumbnail width, usually doesn't exceed 40 @height Thumbnail height, usually doesn't exceed 40 @data The thumbnail in JPEG format

minithumbnail width:int32 height:int32 data:bytes = Minithumbnail;

//@class ThumbnailFormat @description Describes format of the thumbnail

//@description The thumbnail is in JPEG format

thumbnailFormatJpeg = ThumbnailFormat;

//@description The thumbnail is in PNG format. It will be used only for background patterns

thumbnailFormatPng = ThumbnailFormat;

//@description The thumbnail is in WEBP format. It will be used only for some stickers

thumbnailFormatWebp = ThumbnailFormat;

//@description The thumbnail is in static GIF format. It will be used only for some bot inline results

thumbnailFormatGif = ThumbnailFormat;

//@description The thumbnail is in TGS format. It will be used only for animated sticker sets

thumbnailFormatTgs = ThumbnailFormat;

//@description The thumbnail is in MPEG4 format. It will be used only for some animations and videos

thumbnailFormatMpeg4 = ThumbnailFormat;

//@description Represents a thumbnail @format Thumbnail format @width Thumbnail width @height Thumbnail height @file The thumbnail

thumbnail format:ThumbnailFormat width:int32 height:int32 file:file = Thumbnail;

//@class MaskPoint @description Part of the face, relative to which a mask is placed

//@description The mask is placed relatively to the forehead

maskPointForehead = MaskPoint;

//@description The mask is placed relatively to the eyes

maskPointEyes = MaskPoint;

//@description The mask is placed relatively to the mouth

maskPointMouth = MaskPoint;

//@description The mask is placed relatively to the chin

maskPointChin = MaskPoint;

//@description Position on a photo where a mask is placed @point Part of the face, relative to which the mask is placed

//@x_shift Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)

//@y_shift Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. (For example, 1.0 will place the mask just below the default mask position)

//@scale Mask scaling coefficient. (For example, 2.0 means a doubled size)

maskPosition point:MaskPoint x_shift:double y_shift:double scale:double = MaskPosition;

//@description Represents a closed vector path. The path begins at the end point of the last command @commands List of vector path commands

closedVectorPath commands:vector<VectorPathCommand> = ClosedVectorPath;

//@description Describes one answer option of a poll @text Option text; 1-100 characters @voter_count Number of voters for this option, available only for closed or voted polls @vote_percentage The percentage of votes for this option; 0-100

//@is_chosen True, if the option was chosen by the user @is_being_chosen True, if the option is being chosen by a pending setPollAnswer request

pollOption text:string voter_count:int32 vote_percentage:int32 is_chosen:Bool is_being_chosen:Bool = PollOption;

//@class PollType @description Describes the type of a poll

//@description A regular poll @allow_multiple_answers True, if multiple answer options can be chosen simultaneously

pollTypeRegular allow_multiple_answers:Bool = PollType;

//@description A poll in quiz mode, which has exactly one correct answer option and can be answered only once

//@correct_option_id 0-based identifier of the correct answer option; -1 for a yet unanswered poll

//@explanation Text that is shown when the user chooses an incorrect answer or taps on the lamp icon; 0-200 characters with at most 2 line feeds; empty for a yet unanswered poll

pollTypeQuiz correct_option_id:int32 explanation:formattedText = PollType;

//@description Describes an animation file. The animation must be encoded in GIF or MPEG4 format @duration Duration of the animation, in seconds; as defined by the sender @width Width of the animation @height Height of the animation

//@file_name Original name of the file; as defined by the sender @mime_type MIME type of the file, usually "image/gif" or "video/mp4"

//@has_stickers True, if stickers were added to the animation. The list of corresponding sticker set can be received using getAttachedStickerSets

//@minithumbnail Animation minithumbnail; may be null @thumbnail Animation thumbnail in JPEG or MPEG4 format; may be null @animation File containing the animation

animation duration:int32 width:int32 height:int32 file_name:string mime_type:string has_stickers:Bool minithumbnail:minithumbnail thumbnail:thumbnail animation:file = Animation;

//@description Describes an audio file. Audio is usually in MP3 or M4A format @duration Duration of the audio, in seconds; as defined by the sender @title Title of the audio; as defined by the sender @performer Performer of the audio; as defined by the sender

//@file_name Original name of the file; as defined by the sender @mime_type The MIME type of the file; as defined by the sender @album_cover_minithumbnail The minithumbnail of the album cover; may be null

//@album_cover_thumbnail The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail is supposed to be extracted from the downloaded file; may be null @audio File containing the audio

audio duration:int32 title:string performer:string file_name:string mime_type:string album_cover_minithumbnail:minithumbnail album_cover_thumbnail:thumbnail audio:file = Audio;

//@description Describes a document of any type @file_name Original name of the file; as defined by the sender @mime_type MIME type of the file; as defined by the sender

//@minithumbnail Document minithumbnail; may be null @thumbnail Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null @document File containing the document

document file_name:string mime_type:string minithumbnail:minithumbnail thumbnail:thumbnail document:file = Document;

//@description Describes a photo @has_stickers True, if stickers were added to the photo. The list of corresponding sticker sets can be received using getAttachedStickerSets

//@minithumbnail Photo minithumbnail; may be null @sizes Available variants of the photo, in different sizes

photo has_stickers:Bool minithumbnail:minithumbnail sizes:vector<photoSize> = Photo;

//@description Describes a sticker @set_id The identifier of the sticker set to which the sticker belongs; 0 if none @width Sticker width; as defined by the sender @height Sticker height; as defined by the sender

//@emoji Emoji corresponding to the sticker @is_animated True, if the sticker is an animated sticker in TGS format @is_mask True, if the sticker is a mask @mask_position Position where the mask is placed; may be null

//@outline Sticker's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner @thumbnail Sticker thumbnail in WEBP or JPEG format; may be null @sticker File containing the sticker

sticker set_id:int64 width:int32 height:int32 emoji:string is_animated:Bool is_mask:Bool mask_position:maskPosition outline:vector<closedVectorPath> thumbnail:thumbnail sticker:file = Sticker;

//@description Describes a video file @duration Duration of the video, in seconds; as defined by the sender @width Video width; as defined by the sender @height Video height; as defined by the sender

//@file_name Original name of the file; as defined by the sender @mime_type MIME type of the file; as defined by the sender

//@has_stickers True, if stickers were added to the video. The list of corresponding sticker sets can be received using getAttachedStickerSets

//@supports_streaming True, if the video is supposed to be streamed @minithumbnail Video minithumbnail; may be null

//@thumbnail Video thumbnail in JPEG or MPEG4 format; as defined by the sender; may be null @video File containing the video

video duration:int32 width:int32 height:int32 file_name:string mime_type:string has_stickers:Bool supports_streaming:Bool minithumbnail:minithumbnail thumbnail:thumbnail video:file = Video;

//@description Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format @duration Duration of the video, in seconds; as defined by the sender

//@length Video width and height; as defined by the sender @minithumbnail Video minithumbnail; may be null

//@thumbnail Video thumbnail in JPEG format; as defined by the sender; may be null @video File containing the video

videoNote duration:int32 length:int32 minithumbnail:minithumbnail thumbnail:thumbnail video:file = VideoNote;

//@description Describes a voice note. The voice note must be encoded with the Opus codec, and stored inside an OGG container. Voice notes can have only a single audio channel @duration Duration of the voice note, in seconds; as defined by the sender

//@waveform A waveform representation of the voice note in 5-bit format @mime_type MIME type of the file; as defined by the sender @voice File containing the voice note

voiceNote duration:int32 waveform:bytes mime_type:string voice:file = VoiceNote;

//@description Describes an animated representation of an emoji

//@sticker Animated sticker for the emoji

//@fitzpatrick_type Emoji modifier fitzpatrick type; 0-6; 0 if none

//@sound File containing the sound to be played when the animated emoji is clicked if any; may be null. The sound is encoded with the Opus codec, and stored inside an OGG container

animatedEmoji sticker:sticker fitzpatrick_type:int32 sound:file = AnimatedEmoji;

//@description Describes a user contact @phone_number Phone number of the user @first_name First name of the user; 1-255 characters in length @last_name Last name of the user @vcard Additional data about the user in a form of vCard; 0-2048 bytes in length @user_id Identifier of the user, if known; otherwise 0

contact phone_number:string first_name:string last_name:string vcard:string user_id:int53 = Contact;

//@description Describes a location on planet Earth @latitude Latitude of the location in degrees; as defined by the sender @longitude Longitude of the location, in degrees; as defined by the sender

//@horizontal_accuracy The estimated horizontal accuracy of the location, in meters; as defined by the sender. 0 if unknown

location latitude:double longitude:double horizontal_accuracy:double = Location;

//@description Describes a venue @location Venue location; as defined by the sender @title Venue name; as defined by the sender @address Venue address; as defined by the sender @provider Provider of the venue database; as defined by the sender. Currently, only "foursquare" and "gplaces" (Google Places) need to be supported

//@id Identifier of the venue in the provider database; as defined by the sender @type Type of the venue in the provider database; as defined by the sender

venue location:location title:string address:string provider:string id:string type:string = Venue;

//@description Describes a game @id Game ID @short_name Game short name. To share a game use the URL https://t.me/{bot_username}?game={game_short_name} @title Game title @text Game text, usually containing scoreboards for a game

//@param_description Game description @photo Game photo @animation Game animation; may be null

game id:int64 short_name:string title:string text:formattedText description:string photo:photo animation:animation = Game;

//@description Describes a poll @id Unique poll identifier @question Poll question; 1-300 characters @options List of poll answer options

//@total_voter_count Total number of voters, participating in the poll @recent_voter_user_ids User identifiers of recent voters, if the poll is non-anonymous

//@is_anonymous True, if the poll is anonymous @type Type of the poll

//@open_period Amount of time the poll will be active after creation, in seconds @close_date Point in time (Unix timestamp) when the poll will automatically be closed @is_closed True, if the poll is closed

poll id:int64 question:string options:vector<pollOption> total_voter_count:int32 recent_voter_user_ids:vector<int53> is_anonymous:Bool type:PollType open_period:int32 close_date:int32 is_closed:Bool = Poll;

//@description Describes a user profile photo @id Photo identifier; 0 for an empty photo. Can be used to find a photo in a list of user profile photos

//@small A small (160x160) user profile photo. The file can be downloaded only before the photo is changed

//@big A big (640x640) user profile photo. The file can be downloaded only before the photo is changed

//@minithumbnail User profile photo minithumbnail; may be null

//@has_animation True, if the photo has animated variant

profilePhoto id:int64 small:file big:file minithumbnail:minithumbnail has_animation:Bool = ProfilePhoto;

//@description Contains basic information about the photo of a chat

//@small A small (160x160) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed

//@big A big (640x640) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed

//@minithumbnail Chat photo minithumbnail; may be null

//@has_animation True, if the photo has animated variant

chatPhotoInfo small:file big:file minithumbnail:minithumbnail has_animation:Bool = ChatPhotoInfo;

//@class UserType @description Represents the type of a user. The following types are possible: regular users, deleted users and bots

//@description A regular user

userTypeRegular = UserType;

//@description A deleted user or deleted bot. No information on the user besides the user identifier is available. It is not possible to perform any active actions on this type of user

userTypeDeleted = UserType;

//@description A bot (see https://core.telegram.org/bots) @can_join_groups True, if the bot can be invited to basic group and supergroup chats

//@can_read_all_group_messages True, if the bot can read all messages in basic group or supergroup chats and not just those addressed to the bot. In private and channel chats a bot can always read all messages

//@is_inline True, if the bot supports inline queries @inline_query_placeholder Placeholder for inline queries (displayed on the application input field) @need_location True, if the location of the user is expected to be sent with every inline query to this bot

userTypeBot can_join_groups:Bool can_read_all_group_messages:Bool is_inline:Bool inline_query_placeholder:string need_location:Bool = UserType;

//@description No information on the user besides the user identifier is available, yet this user has not been deleted. This object is extremely rare and must be handled like a deleted user. It is not possible to perform any actions on users of this type

userTypeUnknown = UserType;

//@description Represents a command supported by a bot @command Text of the bot command @param_description Description of the bot command

botCommand command:string description:string = BotCommand;

//@description Contains a list of bot commands @bot_user_id Bot's user identifier @commands List of bot commands

botCommands bot_user_id:int53 commands:vector<botCommand> = BotCommands;

//@description Represents a location to which a chat is connected @location The location @address Location address; 1-64 characters, as defined by the chat owner

chatLocation location:location address:string = ChatLocation;

//@description Animated variant of a chat photo in MPEG4 format

//@length Animation width and height

//@file Information about the animation file

//@main_frame_timestamp Timestamp of the frame, used as a static chat photo

animatedChatPhoto length:int32 file:file main_frame_timestamp:double = AnimatedChatPhoto;

//@description Describes a chat or user profile photo

//@id Unique photo identifier

//@added_date Point in time (Unix timestamp) when the photo has been added

//@minithumbnail Photo minithumbnail; may be null

//@sizes Available variants of the photo in JPEG format, in different size

//@animation Animated variant of the photo in MPEG4 format; may be null

chatPhoto id:int64 added_date:int32 minithumbnail:minithumbnail sizes:vector<photoSize> animation:animatedChatPhoto = ChatPhoto;

//@description Contains a list of chat or user profile photos @total_count Total number of photos @photos List of photos

chatPhotos total_count:int32 photos:vector<chatPhoto> = ChatPhotos;

//@class InputChatPhoto @description Describes a photo to be set as a user profile or chat photo

//@description A previously used profile photo of the current user @chat_photo_id Identifier of the current user's profile photo to reuse

inputChatPhotoPrevious chat_photo_id:int64 = InputChatPhoto;

//@description A static photo in JPEG format @photo Photo to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed

inputChatPhotoStatic photo:InputFile = InputChatPhoto;

//@description An animation in MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 800 and be at most 2MB in size

//@animation Animation to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed

//@main_frame_timestamp Timestamp of the frame, which will be used as static chat photo

inputChatPhotoAnimation animation:InputFile main_frame_timestamp:double = InputChatPhoto;

//@description Represents a user

//@id User identifier

//@first_name First name of the user

//@last_name Last name of the user

//@username Username of the user

//@phone_number Phone number of the user

//@status Current online status of the user

//@profile_photo Profile photo of the user; may be null

//@is_contact The user is a contact of the current user

//@is_mutual_contact The user is a contact of the current user and the current user is a contact of the user

//@is_verified True, if the user is verified

//@is_support True, if the user is Telegram support account

//@restriction_reason If non-empty, it contains a human-readable description of the reason why access to this user must be restricted

//@is_scam True, if many users reported this user as a scam

//@is_fake True, if many users reported this user as a fake account

//@have_access If false, the user is inaccessible, and the only information known about the user is inside this class. It can't be passed to any method except GetUser

//@type Type of the user

//@language_code IETF language tag of the user's language; only available to bots

user id:int53 first_name:string last_name:string username:string phone_number:string status:UserStatus profile_photo:profilePhoto is_contact:Bool is_mutual_contact:Bool is_verified:Bool is_support:Bool restriction_reason:string is_scam:Bool is_fake:Bool have_access:Bool type:UserType language_code:string = User;

//@description Contains full information about a user

//@photo User profile photo; may be null

//@is_blocked True, if the user is blocked by the current user

//@can_be_called True, if the user can be called

//@supports_video_calls True, if a video call can be created with the user

//@has_private_calls True, if the user can't be called due to their privacy settings

//@has_private_forwards True, if the user can't be linked in forwarded messages due to their privacy settings

//@need_phone_number_privacy_exception True, if the current user needs to explicitly allow to share their phone number with the user when the method addContact is used

//@bio A short user bio

//@share_text For bots, the text that is shown on the bot's profile page and is sent together with the link when users share the bot

//@param_description For bots, the text shown in the chat with the bot if the chat is empty

//@group_in_common_count Number of group chats where both the other user and the current user are a member; 0 for the current user

//@commands For bots, list of the bot commands

userFullInfo photo:chatPhoto is_blocked:Bool can_be_called:Bool supports_video_calls:Bool has_private_calls:Bool has_private_forwards:Bool need_phone_number_privacy_exception:Bool bio:string share_text:string description:string group_in_common_count:int32 commands:vector<botCommand> = UserFullInfo;

//@description Represents a list of users @total_count Approximate total count of users found @user_ids A list of user identifiers

users total_count:int32 user_ids:vector<int53> = Users;

//@description Contains information about a chat administrator @user_id User identifier of the administrator @custom_title Custom title of the administrator @is_owner True, if the user is the owner of the chat

chatAdministrator user_id:int53 custom_title:string is_owner:Bool = ChatAdministrator;

//@description Represents a list of chat administrators @administrators A list of chat administrators

chatAdministrators administrators:vector<chatAdministrator> = ChatAdministrators;

//@description Describes actions that a user is allowed to take in a chat

//@can_send_messages True, if the user can send text messages, contacts, locations, and venues

//@can_send_media_messages True, if the user can send audio files, documents, photos, videos, video notes, and voice notes. Implies can_send_messages permissions

//@can_send_polls True, if the user can send polls. Implies can_send_messages permissions

//@can_send_other_messages True, if the user can send animations, games, stickers, and dice and use inline bots. Implies can_send_messages permissions

//@can_add_web_page_previews True, if the user may add a web page preview to their messages. Implies can_send_messages permissions

//@can_change_info True, if the user can change the chat title, photo, and other settings

//@can_invite_users True, if the user can invite new users to the chat

//@can_pin_messages True, if the user can pin messages

chatPermissions can_send_messages:Bool can_send_media_messages:Bool can_send_polls:Bool can_send_other_messages:Bool can_add_web_page_previews:Bool can_change_info:Bool can_invite_users:Bool can_pin_messages:Bool = ChatPermissions;

//@class ChatMemberStatus @description Provides information about the status of a member in a chat

//@description The user is the owner of the chat and has all the administrator privileges

//@custom_title A custom title of the owner; 0-16 characters without emojis; applicable to supergroups only

//@is_anonymous True, if the creator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only

//@is_member True, if the user is a member of the chat

chatMemberStatusCreator custom_title:string is_anonymous:Bool is_member:Bool = ChatMemberStatus;

//@description The user is a member of the chat and has some additional privileges. In basic groups, administrators can edit and delete messages sent by others, add new members, ban unprivileged members, and manage video chats. In supergroups and channels, there are more detailed options for administrator privileges

//@custom_title A custom title of the administrator; 0-16 characters without emojis; applicable to supergroups only

//@can_be_edited True, if the current user can edit the administrator privileges for the called user

//@can_manage_chat True, if the administrator can get chat event log, get chat statistics, get message statistics in channels, get channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other privilege; applicable to supergroups and channels only

//@can_change_info True, if the administrator can change the chat title, photo, and other settings

//@can_post_messages True, if the administrator can create channel posts; applicable to channels only

//@can_edit_messages True, if the administrator can edit messages of other users and pin messages; applicable to channels only

//@can_delete_messages True, if the administrator can delete messages of other users

//@can_invite_users True, if the administrator can invite new users to the chat

//@can_restrict_members True, if the administrator can restrict, ban, or unban chat members; always true for channels

//@can_pin_messages True, if the administrator can pin messages; applicable to basic groups and supergroups only

//@can_promote_members True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that were directly or indirectly promoted by them

//@can_manage_video_chats True, if the administrator can manage video chats

//@is_anonymous True, if the administrator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only

chatMemberStatusAdministrator custom_title:string can_be_edited:Bool can_manage_chat:Bool can_change_info:Bool can_post_messages:Bool can_edit_messages:Bool can_delete_messages:Bool can_invite_users:Bool can_restrict_members:Bool can_pin_messages:Bool can_promote_members:Bool can_manage_video_chats:Bool is_anonymous:Bool = ChatMemberStatus;

//@description The user is a member of the chat, without any additional privileges or restrictions

chatMemberStatusMember = ChatMemberStatus;

//@description The user is under certain restrictions in the chat. Not supported in basic groups and channels

//@is_member True, if the user is a member of the chat

//@restricted_until_date Point in time (Unix timestamp) when restrictions will be lifted from the user; 0 if never. If the user is restricted for more than 366 days or for less than 30 seconds from the current time, the user is considered to be restricted forever

//@permissions User permissions in the chat

chatMemberStatusRestricted is_member:Bool restricted_until_date:int32 permissions:chatPermissions = ChatMemberStatus;

//@description The user or the chat is not a chat member

chatMemberStatusLeft = ChatMemberStatus;

//@description The user or the chat was banned (and hence is not a member of the chat). Implies the user can't return to the chat, view messages, or be used as a participant identifier to join a video chat of the chat

//@banned_until_date Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Always 0 in basic groups

chatMemberStatusBanned banned_until_date:int32 = ChatMemberStatus;

//@description Describes a user or a chat as a member of another chat

//@member_id Identifier of the chat member. Currently, other chats can be only Left or Banned. Only supergroups and channels can have other chats as Left or Banned members and these chats must be supergroups or channels

//@inviter_user_id Identifier of a user that invited/promoted/banned this member in the chat; 0 if unknown

//@joined_chat_date Point in time (Unix timestamp) when the user joined the chat

//@status Status of the member in the chat

chatMember member_id:MessageSender inviter_user_id:int53 joined_chat_date:int32 status:ChatMemberStatus = ChatMember;

//@description Contains a list of chat members @total_count Approximate total count of chat members found @members A list of chat members

chatMembers total_count:int32 members:vector<chatMember> = ChatMembers;

//@class ChatMembersFilter @description Specifies the kind of chat members to return in searchChatMembers

//@description Returns contacts of the user

chatMembersFilterContacts = ChatMembersFilter;

//@description Returns the owner and administrators

chatMembersFilterAdministrators = ChatMembersFilter;

//@description Returns all chat members, including restricted chat members

chatMembersFilterMembers = ChatMembersFilter;

//@description Returns users which can be mentioned in the chat @message_thread_id If non-zero, the identifier of the current message thread

chatMembersFilterMention message_thread_id:int53 = ChatMembersFilter;

//@description Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup

chatMembersFilterRestricted = ChatMembersFilter;

//@description Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel

chatMembersFilterBanned = ChatMembersFilter;

//@description Returns bot members of the chat

chatMembersFilterBots = ChatMembersFilter;

//@class SupergroupMembersFilter @description Specifies the kind of chat members to return in getSupergroupMembers

//@description Returns recently active users in reverse chronological order

supergroupMembersFilterRecent = SupergroupMembersFilter;

//@description Returns contacts of the user, which are members of the supergroup or channel @query Query to search for

supergroupMembersFilterContacts query:string = SupergroupMembersFilter;

//@description Returns the owner and administrators

supergroupMembersFilterAdministrators = SupergroupMembersFilter;

//@description Used to search for supergroup or channel members via a (string) query @query Query to search for

supergroupMembersFilterSearch query:string = SupergroupMembersFilter;

//@description Returns restricted supergroup members; can be used only by administrators @query Query to search for

supergroupMembersFilterRestricted query:string = SupergroupMembersFilter;

//@description Returns users banned from the supergroup or channel; can be used only by administrators @query Query to search for

supergroupMembersFilterBanned query:string = SupergroupMembersFilter;

//@description Returns users which can be mentioned in the supergroup @query Query to search for @message_thread_id If non-zero, the identifier of the current message thread

supergroupMembersFilterMention query:string message_thread_id:int53 = SupergroupMembersFilter;

//@description Returns bot members of the supergroup or channel

supergroupMembersFilterBots = SupergroupMembersFilter;

//@description Contains a chat invite link

//@invite_link Chat invite link

//@name Name of the link

//@creator_user_id User identifier of an administrator created the link

//@date Point in time (Unix timestamp) when the link was created

//@edit_date Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown

//@expiration_date Point in time (Unix timestamp) when the link will expire; 0 if never

//@member_limit The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval

//@member_count Number of chat members, which joined the chat using the link

//@pending_join_request_count Number of pending join requests created using this link

//@creates_join_request True, if the link only creates join request. If true, total number of joining members will be unlimited

//@is_primary True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time

//@is_revoked True, if the link was revoked

chatInviteLink invite_link:string name:string creator_user_id:int53 date:int32 edit_date:int32 expiration_date:int32 member_limit:int32 member_count:int32 pending_join_request_count:int32 creates_join_request:Bool is_primary:Bool is_revoked:Bool = ChatInviteLink;

//@description Contains a list of chat invite links @total_count Approximate total count of chat invite links found @invite_links List of invite links

chatInviteLinks total_count:int32 invite_links:vector<chatInviteLink> = ChatInviteLinks;

//@description Describes a chat administrator with a number of active and revoked chat invite links

//@user_id Administrator's user identifier

//@invite_link_count Number of active invite links

//@revoked_invite_link_count Number of revoked invite links

chatInviteLinkCount user_id:int53 invite_link_count:int32 revoked_invite_link_count:int32 = ChatInviteLinkCount;

//@description Contains a list of chat invite link counts @invite_link_counts List of invite link counts

chatInviteLinkCounts invite_link_counts:vector<chatInviteLinkCount> = ChatInviteLinkCounts;

//@description Describes a chat member joined a chat via an invite link @user_id User identifier @joined_chat_date Point in time (Unix timestamp) when the user joined the chat @approver_user_id User identifier of the chat administrator, approved user join request

chatInviteLinkMember user_id:int53 joined_chat_date:int32 approver_user_id:int53 = ChatInviteLinkMember;

//@description Contains a list of chat members joined a chat via an invite link @total_count Approximate total count of chat members found @members List of chat members, joined a chat via an invite link

chatInviteLinkMembers total_count:int32 members:vector<chatInviteLinkMember> = ChatInviteLinkMembers;

//@description Contains information about a chat invite link

//@chat_id Chat identifier of the invite link; 0 if the user has no access to the chat before joining

//@accessible_for If non-zero, the amount of time for which read access to the chat will remain available, in seconds

//@type Type of the chat

//@title Title of the chat

//@photo Chat photo; may be null

//@param_description Chat description

//@member_count Number of members in the chat

//@member_user_ids User identifiers of some chat members that may be known to the current user

//@creates_join_request True, if the link only creates join request

//@is_public True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup

chatInviteLinkInfo chat_id:int53 accessible_for:int32 type:ChatType title:string photo:chatPhotoInfo description:string member_count:int32 member_user_ids:vector<int53> creates_join_request:Bool is_public:Bool = ChatInviteLinkInfo;

//@description Describes a user that sent a join request and waits for administrator approval @user_id User identifier @date Point in time (Unix timestamp) when the user sent the join request @bio A short bio of the user

chatJoinRequest user_id:int53 date:int32 bio:string = ChatJoinRequest;

//@description Contains a list of requests to join a chat @total_count Approximate total count of requests found @requests List of the requests

chatJoinRequests total_count:int32 requests:vector<chatJoinRequest> = ChatJoinRequests;

//@description Contains information about pending join requests for a chat @total_count Total number of pending join requests @user_ids Identifiers of at most 3 users sent the newest pending join requests

chatJoinRequestsInfo total_count:int32 user_ids:vector<int53> = ChatJoinRequestsInfo;

//@description Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)

//@id Group identifier

//@member_count Number of members in the group

//@status Status of the current user in the group

//@is_active True, if the group is active

//@upgraded_to_supergroup_id Identifier of the supergroup to which this group was upgraded; 0 if none

basicGroup id:int53 member_count:int32 status:ChatMemberStatus is_active:Bool upgraded_to_supergroup_id:int53 = BasicGroup;

//@description Contains full information about a basic group

//@photo Chat photo; may be null

//@param_description Group description. Updated only after the basic group is opened

//@creator_user_id User identifier of the creator of the group; 0 if unknown

//@members Group members

//@invite_link Primary invite link for this group; may be null. For chat administrators with can_invite_users right only. Updated only after the basic group is opened

//@bot_commands List of commands of bots in the group

basicGroupFullInfo photo:chatPhoto description:string creator_user_id:int53 members:vector<chatMember> invite_link:chatInviteLink bot_commands:vector<botCommands> = BasicGroupFullInfo;

//@description Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers

//@id Supergroup or channel identifier

//@username Username of the supergroup or channel; empty for private supergroups or channels

//@date Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member

//@status Status of the current user in the supergroup or channel; custom title will be always empty

//@member_count Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through searchPublicChats, searchChatsNearby, getInactiveSupergroupChats, getSuitableDiscussionChats, getGroupsInCommon, or getUserPrivacySettingRules

//@has_linked_chat True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel

//@has_location True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup

//@sign_messages True, if messages sent to the channel need to contain information about the sender. This field is only applicable to channels

//@is_slow_mode_enabled True, if the slow mode is enabled in the supergroup

//@is_channel True, if the supergroup is a channel

//@is_broadcast_group True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members

//@is_verified True, if the supergroup or channel is verified

//@restriction_reason If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted

//@is_scam True, if many users reported this supergroup or channel as a scam

//@is_fake True, if many users reported this supergroup or channel as a fake account

supergroup id:int53 username:string date:int32 status:ChatMemberStatus member_count:int32 has_linked_chat:Bool has_location:Bool sign_messages:Bool is_slow_mode_enabled:Bool is_channel:Bool is_broadcast_group:Bool is_verified:Bool restriction_reason:string is_scam:Bool is_fake:Bool = Supergroup;

//@description Contains full information about a supergroup or channel

//@photo Chat photo; may be null

//@param_description Supergroup or channel description

//@member_count Number of members in the supergroup or channel; 0 if unknown

//@administrator_count Number of privileged users in the supergroup or channel; 0 if unknown

//@restricted_count Number of restricted users in the supergroup; 0 if unknown

//@banned_count Number of users banned from chat; 0 if unknown

//@linked_chat_id Chat identifier of a discussion group for the channel, or a channel, for which the supergroup is the designated discussion group; 0 if none or unknown

//@slow_mode_delay Delay between consecutive sent messages for non-administrator supergroup members, in seconds

//@slow_mode_delay_expires_in Time left before next message can be sent in the supergroup, in seconds. An updateSupergroupFullInfo update is not triggered when value of this field changes, but both new and old values are non-zero

//@can_get_members True, if members of the chat can be retrieved

//@can_set_username True, if the chat username can be changed

//@can_set_sticker_set True, if the supergroup sticker set can be changed

//@can_set_location True, if the supergroup location can be changed

//@can_get_statistics True, if the supergroup or channel statistics are available

//@is_all_history_available True, if new chat members will have access to old messages. In public or discussion groups and both public and private channels, old messages are always available, so this option affects only private supergroups without a linked chat. The value of this field is only available for chat administrators

//@sticker_set_id Identifier of the supergroup sticker set; 0 if none

//@location Location to which the supergroup is connected; may be null

//@invite_link Primary invite link for this chat; may be null. For chat administrators with can_invite_users right only

//@bot_commands List of commands of bots in the group

//@upgraded_from_basic_group_id Identifier of the basic group from which supergroup was upgraded; 0 if none

//@upgraded_from_max_message_id Identifier of the last message in the basic group from which supergroup was upgraded; 0 if none

supergroupFullInfo photo:chatPhoto description:string member_count:int32 administrator_count:int32 restricted_count:int32 banned_count:int32 linked_chat_id:int53 slow_mode_delay:int32 slow_mode_delay_expires_in:double can_get_members:Bool can_set_username:Bool can_set_sticker_set:Bool can_set_location:Bool can_get_statistics:Bool is_all_history_available:Bool sticker_set_id:int64 location:chatLocation invite_link:chatInviteLink bot_commands:vector<botCommands> upgraded_from_basic_group_id:int53 upgraded_from_max_message_id:int53 = SupergroupFullInfo;

//@class SecretChatState @description Describes the current secret chat state

//@description The secret chat is not yet created; waiting for the other user to get online

secretChatStatePending = SecretChatState;

//@description The secret chat is ready to use

secretChatStateReady = SecretChatState;

//@description The secret chat is closed

secretChatStateClosed = SecretChatState;

//@description Represents a secret chat

//@id Secret chat identifier

//@user_id Identifier of the chat partner

//@state State of the secret chat

//@is_outbound True, if the chat was created by the current user; otherwise false

//@key_hash Hash of the currently used key for comparison with the hash of the chat partner's key. This is a string of 36 little-endian bytes, which must be split into groups of 2 bits, each denoting a pixel of one of 4 colors FFFFFF, D5E6F3, 2D5775, and 2F99C9.

//-The pixels must be used to make a 12x12 square image filled from left to right, top to bottom. Alternatively, the first 32 bytes of the hash can be converted to the hexadecimal format and printed as 32 2-digit hex numbers

//@layer Secret chat layer; determines features supported by the chat partner's application. Nested text entities and underline and strikethrough entities are supported if the layer >= 101

secretChat id:int32 user_id:int53 state:SecretChatState is_outbound:Bool key_hash:bytes layer:int32 = SecretChat;

//@class MessageSender @description Contains information about the sender of a message

//@description The message was sent by a known user @user_id Identifier of the user that sent the message

messageSenderUser user_id:int53 = MessageSender;

//@description The message was sent on behalf of a chat @chat_id Identifier of the chat that sent the message

messageSenderChat chat_id:int53 = MessageSender;

//@description Represents a list of message senders @total_count Approximate total count of messages senders found @senders List of message senders

messageSenders total_count:int32 senders:vector<MessageSender> = MessageSenders;

//@class MessageForwardOrigin @description Contains information about the origin of a forwarded message

//@description The message was originally sent by a known user @sender_user_id Identifier of the user that originally sent the message

messageForwardOriginUser sender_user_id:int53 = MessageForwardOrigin;

//@description The message was originally sent on behalf of a chat

//@sender_chat_id Identifier of the chat that originally sent the message

//@author_signature For messages originally sent by an anonymous chat administrator, original message author signature

messageForwardOriginChat sender_chat_id:int53 author_signature:string = MessageForwardOrigin;

//@description The message was originally sent by a user, which is hidden by their privacy settings @sender_name Name of the sender

messageForwardOriginHiddenUser sender_name:string = MessageForwardOrigin;

//@description The message was originally a post in a channel

//@chat_id Identifier of the chat from which the message was originally forwarded

//@message_id Message identifier of the original message

//@author_signature Original post author signature

messageForwardOriginChannel chat_id:int53 message_id:int53 author_signature:string = MessageForwardOrigin;

//@description The message was imported from an exported message history @sender_name Name of the sender

messageForwardOriginMessageImport sender_name:string = MessageForwardOrigin;

//@description Contains information about a forwarded message

//@origin Origin of a forwarded message

//@date Point in time (Unix timestamp) when the message was originally sent

//@public_service_announcement_type The type of a public service announcement for the forwarded message

//@from_chat_id For messages forwarded to the chat with the current user (Saved Messages), to the Replies bot chat, or to the channel's discussion group, the identifier of the chat from which the message was forwarded last time; 0 if unknown

//@from_message_id For messages forwarded to the chat with the current user (Saved Messages), to the Replies bot chat, or to the channel's discussion group, the identifier of the original message from which the new message was forwarded last time; 0 if unknown

messageForwardInfo origin:MessageForwardOrigin date:int32 public_service_announcement_type:string from_chat_id:int53 from_message_id:int53 = MessageForwardInfo;

//@description Contains information about replies to a message

//@reply_count Number of times the message was directly or indirectly replied

//@recent_replier_ids Identifiers of at most 3 recent repliers to the message; available in channels with a discussion supergroup. The users and chats are expected to be inaccessible: only their photo and name will be available

//@last_read_inbox_message_id Identifier of the last read incoming reply to the message

//@last_read_outbox_message_id Identifier of the last read outgoing reply to the message

//@last_message_id Identifier of the last reply to the message

messageReplyInfo reply_count:int32 recent_replier_ids:vector<MessageSender> last_read_inbox_message_id:int53 last_read_outbox_message_id:int53 last_message_id:int53 = MessageReplyInfo;

//@description Contains information about interactions with a message

//@view_count Number of times the message was viewed

//@forward_count Number of times the message was forwarded

//@reply_info Information about direct or indirect replies to the message; may be null. Currently, available only in channels with a discussion supergroup and discussion supergroups for messages, which are not replies itself

messageInteractionInfo view_count:int32 forward_count:int32 reply_info:messageReplyInfo = MessageInteractionInfo;

//@class MessageSendingState @description Contains information about the sending state of the message

//@description The message is being sent now, but has not yet been delivered to the server

messageSendingStatePending = MessageSendingState;

//@description The message failed to be sent @error_code An error code; 0 if unknown @error_message Error message

//@can_retry True, if the message can be re-sent

//@need_another_sender True, if the message can be re-sent only on behalf of a different sender

//@retry_after Time left before the message can be re-sent, in seconds. No update is sent when this field changes

messageSendingStateFailed error_code:int32 error_message:string can_retry:Bool need_another_sender:Bool retry_after:double = MessageSendingState;

//@description Describes a message

//@id Message identifier; unique for the chat to which the message belongs

//@sender_id Identifier of the sender of the message

//@chat_id Chat identifier

//@sending_state The sending state of the message; may be null

//@scheduling_state The scheduling state of the message; may be null

//@is_outgoing True, if the message is outgoing

//@is_pinned True, if the message is pinned

//@can_be_edited True, if the message can be edited. For live location and poll messages this fields shows whether editMessageLiveLocation or stopPoll can be used with this message by the application

//@can_be_forwarded True, if the message can be forwarded

//@can_be_saved True, if content of the message can be saved locally or copied

//@can_be_deleted_only_for_self True, if the message can be deleted only for the current user while other users will continue to see it

//@can_be_deleted_for_all_users True, if the message can be deleted for all users

//@can_get_statistics True, if the message statistics are available

//@can_get_message_thread True, if the message thread info is available

//@can_get_viewers True, if chat members already viewed the message can be received through getMessageViewers

//@can_get_media_timestamp_links True, if media timestamp links can be generated for media timestamp entities in the message text, caption or web page description

//@has_timestamped_media True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message

//@is_channel_post True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts

//@contains_unread_mention True, if the message contains an unread mention for the current user

//@date Point in time (Unix timestamp) when the message was sent

//@edit_date Point in time (Unix timestamp) when the message was last edited

//@forward_info Information about the initial message sender; may be null

//@interaction_info Information about interactions with the message; may be null

//@reply_in_chat_id If non-zero, the identifier of the chat to which the replied message belongs; Currently, only messages in the Replies chat can have different reply_in_chat_id and chat_id

//@reply_to_message_id If non-zero, the identifier of the message this message is replying to; can be the identifier of a deleted message

//@message_thread_id If non-zero, the identifier of the message thread the message belongs to; unique within the chat to which the message belongs

//@ttl For self-destructing messages, the message's TTL (Time To Live), in seconds; 0 if none. TDLib will send updateDeleteMessages or updateMessageContent once the TTL expires

//@ttl_expires_in Time left before the message expires, in seconds. If the TTL timer isn't started yet, equals to the value of the ttl field

//@via_bot_user_id If non-zero, the user identifier of the bot through which this message was sent

//@author_signature For channel posts and anonymous group messages, optional author signature

//@media_album_id Unique identifier of an album this message belongs to. Only audios, documents, photos and videos can be grouped together in albums

//@restriction_reason If non-empty, contains a human-readable description of the reason why access to this message must be restricted

//@content Content of the message

//@reply_markup Reply markup for the message; may be null

message id:int53 sender_id:MessageSender chat_id:int53 sending_state:MessageSendingState scheduling_state:MessageSchedulingState is_outgoing:Bool is_pinned:Bool can_be_edited:Bool can_be_forwarded:Bool can_be_saved:Bool can_be_deleted_only_for_self:Bool can_be_deleted_for_all_users:Bool can_get_statistics:Bool can_get_message_thread:Bool can_get_viewers:Bool can_get_media_timestamp_links:Bool has_timestamped_media:Bool is_channel_post:Bool contains_unread_mention:Bool date:int32 edit_date:int32 forward_info:messageForwardInfo interaction_info:messageInteractionInfo reply_in_chat_id:int53 reply_to_message_id:int53 message_thread_id:int53 ttl:int32 ttl_expires_in:double via_bot_user_id:int53 author_signature:string media_album_id:int64 restriction_reason:string content:MessageContent reply_markup:ReplyMarkup = Message;

//@description Contains a list of messages @total_count Approximate total count of messages found @messages List of messages; messages may be null

messages total_count:int32 messages:vector<message> = Messages;

//@description Contains a list of messages found by a search @total_count Approximate total count of messages found; -1 if unknown @messages List of messages @next_offset The offset for the next request. If empty, there are no more results

foundMessages total_count:int32 messages:vector<message> next_offset:string = FoundMessages;

//@description Contains information about a message in a specific position @position 0-based message position in the full list of suitable messages @message_id Message identifier @date Point in time (Unix timestamp) when the message was sent

messagePosition position:int32 message_id:int53 date:int32 = MessagePosition;

//@description Contains a list of message positions @total_count Total count of messages found @positions List of message positions

messagePositions total_count:int32 positions:vector<messagePosition> = MessagePositions;

//@description Contains information about found messages sent on a specific day @total_count Total number of found messages sent on the day @message First message sent on the day

messageCalendarDay total_count:int32 message:message = MessageCalendarDay;

//@description Contains information about found messages, split by days according to the option "utc_time_offset" @total_count Total number of found messages @days Information about messages sent

messageCalendar total_count:int32 days:vector<messageCalendarDay> = MessageCalendar;

//@description Describes a sponsored message

//@message_id Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages

//@sponsor_chat_id Sponsor chat identifier; 0 if the sponsor chat is accessible through an invite link

//@sponsor_chat_info Information about the sponsor chat; may be null unless sponsor_chat_id == 0

//@link An internal link to be opened when the sponsored message is clicked; may be null. If null, the sponsor chat needs to be opened instead

//@content Content of the message. Currently, can be only of the type messageText

sponsoredMessage message_id:int53 sponsor_chat_id:int53 sponsor_chat_info:chatInviteLinkInfo link:InternalLinkType content:MessageContent = SponsoredMessage;

//@class NotificationSettingsScope @description Describes the types of chats to which notification settings are relevant

//@description Notification settings applied to all private and secret chats when the corresponding chat setting has a default value

notificationSettingsScopePrivateChats = NotificationSettingsScope;

//@description Notification settings applied to all basic groups and supergroups when the corresponding chat setting has a default value

notificationSettingsScopeGroupChats = NotificationSettingsScope;

//@description Notification settings applied to all channels when the corresponding chat setting has a default value

notificationSettingsScopeChannelChats = NotificationSettingsScope;

//@description Contains information about notification settings for a chat

//@use_default_mute_for If true, mute_for is ignored and the value for the relevant type of chat is used instead @mute_for Time left before notifications will be unmuted, in seconds

//@use_default_sound If true, sound is ignored and the value for the relevant type of chat is used instead @sound The name of an audio file to be used for notification sounds; only applies to iOS applications

//@use_default_show_preview If true, show_preview is ignored and the value for the relevant type of chat is used instead @show_preview True, if message content must be displayed in notifications

//@use_default_disable_pinned_message_notifications If true, disable_pinned_message_notifications is ignored and the value for the relevant type of chat is used instead @disable_pinned_message_notifications If true, notifications for incoming pinned messages will be created as for an ordinary unread message

//@use_default_disable_mention_notifications If true, disable_mention_notifications is ignored and the value for the relevant type of chat is used instead @disable_mention_notifications If true, notifications for messages with mentions will be created as for an ordinary unread message

chatNotificationSettings use_default_mute_for:Bool mute_for:int32 use_default_sound:Bool sound:string use_default_show_preview:Bool show_preview:Bool use_default_disable_pinned_message_notifications:Bool disable_pinned_message_notifications:Bool use_default_disable_mention_notifications:Bool disable_mention_notifications:Bool = ChatNotificationSettings;

//@description Contains information about notification settings for several chats

//@mute_for Time left before notifications will be unmuted, in seconds

//@sound The name of an audio file to be used for notification sounds; only applies to iOS applications

//@show_preview True, if message content must be displayed in notifications

//@disable_pinned_message_notifications True, if notifications for incoming pinned messages will be created as for an ordinary unread message

//@disable_mention_notifications True, if notifications for messages with mentions will be created as for an ordinary unread message

scopeNotificationSettings mute_for:int32 sound:string show_preview:Bool disable_pinned_message_notifications:Bool disable_mention_notifications:Bool = ScopeNotificationSettings;

//@description Contains information about a message draft

//@reply_to_message_id Identifier of the message to reply to; 0 if none

//@date Point in time (Unix timestamp) when the draft was created

//@input_message_text Content of the message draft; must be of the type inputMessageText

draftMessage reply_to_message_id:int53 date:int32 input_message_text:InputMessageContent = DraftMessage;

//@class ChatType @description Describes the type of a chat

//@description An ordinary chat with a user @user_id User identifier

chatTypePrivate user_id:int53 = ChatType;

//@description A basic group (a chat with 0-200 other users) @basic_group_id Basic group identifier

chatTypeBasicGroup basic_group_id:int53 = ChatType;

//@description A supergroup or channel (with unlimited members) @supergroup_id Supergroup or channel identifier @is_channel True, if the supergroup is a channel

chatTypeSupergroup supergroup_id:int53 is_channel:Bool = ChatType;

//@description A secret chat with a user @secret_chat_id Secret chat identifier @user_id User identifier of the secret chat peer

chatTypeSecret secret_chat_id:int32 user_id:int53 = ChatType;

//@description Represents a filter of user chats

//@title The title of the filter; 1-12 characters without line feeds

//@icon_name The chosen icon name for short filter representation. If non-empty, must be one of "All", "Unread", "Unmuted", "Bots", "Channels", "Groups", "Private", "Custom", "Setup", "Cat", "Crown", "Favorite", "Flower", "Game", "Home", "Love", "Mask", "Party", "Sport", "Study", "Trade", "Travel", "Work".

//-If empty, use getChatFilterDefaultIconName to get default icon name for the filter

//@pinned_chat_ids The chat identifiers of pinned chats in the filtered chat list

//@included_chat_ids The chat identifiers of always included chats in the filtered chat list

//@excluded_chat_ids The chat identifiers of always excluded chats in the filtered chat list

//@exclude_muted True, if muted chats need to be excluded

//@exclude_read True, if read chats need to be excluded

//@exclude_archived True, if archived chats need to be excluded

//@include_contacts True, if contacts need to be included

//@include_non_contacts True, if non-contact users need to be included

//@include_bots True, if bots need to be included

//@include_groups True, if basic groups and supergroups need to be included

//@include_channels True, if channels need to be included

chatFilter title:string icon_name:string pinned_chat_ids:vector<int53> included_chat_ids:vector<int53> excluded_chat_ids:vector<int53> exclude_muted:Bool exclude_read:Bool exclude_archived:Bool include_contacts:Bool include_non_contacts:Bool include_bots:Bool include_groups:Bool include_channels:Bool = ChatFilter;

//@description Contains basic information about a chat filter

//@id Unique chat filter identifier

//@title The title of the filter; 1-12 characters without line feeds

//@icon_name The chosen or default icon name for short filter representation. One of "All", "Unread", "Unmuted", "Bots", "Channels", "Groups", "Private", "Custom", "Setup", "Cat", "Crown", "Favorite", "Flower", "Game", "Home", "Love", "Mask", "Party", "Sport", "Study", "Trade", "Travel", "Work"

chatFilterInfo id:int32 title:string icon_name:string = ChatFilterInfo;

//@description Describes a recommended chat filter @filter The chat filter @param_description Chat filter description

recommendedChatFilter filter:chatFilter description:string = RecommendedChatFilter;

//@description Contains a list of recommended chat filters @chat_filters List of recommended chat filters

recommendedChatFilters chat_filters:vector<recommendedChatFilter> = RecommendedChatFilters;

//@class ChatList @description Describes a list of chats

//@description A main list of chats

chatListMain = ChatList;

//@description A list of chats usually located at the top of the main chat list. Unmuted chats are automatically moved from the Archive to the Main chat list when a new message arrives

chatListArchive = ChatList;

//@description A list of chats belonging to a chat filter @chat_filter_id Chat filter identifier

chatListFilter chat_filter_id:int32 = ChatList;

//@description Contains a list of chat lists @chat_lists List of chat lists

chatLists chat_lists:vector<ChatList> = ChatLists;

//@class ChatSource @description Describes a reason why an external chat is shown in a chat list

//@description The chat is sponsored by the user's MTProxy server

chatSourceMtprotoProxy = ChatSource;

//@description The chat contains a public service announcement @type The type of the announcement @text The text of the announcement

chatSourcePublicServiceAnnouncement type:string text:string = ChatSource;

//@description Describes a position of a chat in a chat list

//@list The chat list

//@order A parameter used to determine order of the chat in the chat list. Chats must be sorted by the pair (order, chat.id) in descending order

//@is_pinned True, if the chat is pinned in the chat list

//@source Source of the chat in the chat list; may be null

chatPosition list:ChatList order:int64 is_pinned:Bool source:ChatSource = ChatPosition;

//@description Describes a video chat

//@group_call_id Group call identifier of an active video chat; 0 if none. Full information about the video chat can be received through the method getGroupCall

//@has_participants True, if the video chat has participants

//@default_participant_id Default group call participant identifier to join the video chat; may be null

videoChat group_call_id:int32 has_participants:Bool default_participant_id:MessageSender = VideoChat;

//@description A chat. (Can be a private chat, basic group, supergroup, or secret chat)

//@id Chat unique identifier

//@type Type of the chat

//@title Chat title

//@photo Chat photo; may be null

//@permissions Actions that non-administrator chat members are allowed to take in the chat

//@last_message Last message in the chat; may be null

//@positions Positions of the chat in chat lists

//@message_sender_id Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can't change message sender

//@has_protected_content True, if chat content can't be saved locally, forwarded, or copied

//@is_marked_as_unread True, if the chat is marked as unread

//@is_blocked True, if the chat is blocked by the current user and private messages from the chat can't be received

//@has_scheduled_messages True, if the chat has scheduled messages

//@can_be_deleted_only_for_self True, if the chat messages can be deleted only for the current user while other users will continue to see the messages

//@can_be_deleted_for_all_users True, if the chat messages can be deleted for all users

//@can_be_reported True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto

//@default_disable_notification Default value of the disable_notification parameter, used when a message is sent to the chat

//@unread_count Number of unread messages in the chat

//@last_read_inbox_message_id Identifier of the last read incoming message

//@last_read_outbox_message_id Identifier of the last read outgoing message

//@unread_mention_count Number of unread messages with a mention/reply in the chat

//@notification_settings Notification settings for this chat

//@message_ttl Current message Time To Live setting (self-destruct timer) for the chat; 0 if not defined. TTL is counted from the time message or its content is viewed in secret chats and from the send date in other chats

//@theme_name If non-empty, name of a theme, set for the chat

//@action_bar Information about actions which must be possible to do through the chat action bar; may be null

//@video_chat Information about video chat of the chat

//@pending_join_requests Information about pending join requests; may be null

//@reply_markup_message_id Identifier of the message from which reply markup needs to be used; 0 if there is no default custom reply markup in the chat

//@draft_message A draft of a message in the chat; may be null

//@client_data Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used

chat id:int53 type:ChatType title:string photo:chatPhotoInfo permissions:chatPermissions last_message:message positions:vector<chatPosition> message_sender_id:MessageSender has_protected_content:Bool is_marked_as_unread:Bool is_blocked:Bool has_scheduled_messages:Bool can_be_deleted_only_for_self:Bool can_be_deleted_for_all_users:Bool can_be_reported:Bool default_disable_notification:Bool unread_count:int32 last_read_inbox_message_id:int53 last_read_outbox_message_id:int53 unread_mention_count:int32 notification_settings:chatNotificationSettings message_ttl:int32 theme_name:string action_bar:ChatActionBar video_chat:videoChat pending_join_requests:chatJoinRequestsInfo reply_markup_message_id:int53 draft_message:draftMessage client_data:string = Chat;

//@description Represents a list of chats @total_count Approximate total count of chats found @chat_ids List of chat identifiers

chats total_count:int32 chat_ids:vector<int53> = Chats;

//@description Describes a chat located nearby @chat_id Chat identifier @distance Distance to the chat location, in meters

chatNearby chat_id:int53 distance:int32 = ChatNearby;

//@description Represents a list of chats located nearby @users_nearby List of users nearby @supergroups_nearby List of location-based supergroups nearby