astra
/
go-tdlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
go-tdlib/data/td_api.json

39603 lines
1.5 MiB
Executable File
Raw Blame History

{
"types": [
{
"name": "double",
"description": "",
"class": "Double",
"properties": []
},
{
"name": "string",
"description": "",
"class": "String",
"properties": []
},
{
"name": "int32",
"description": "",
"class": "Int32",
"properties": []
},
{
"name": "int53",
"description": "",
"class": "Int53",
"properties": []
},
{
"name": "int64",
"description": "",
"class": "Int64",
"properties": []
},
{
"name": "bytes",
"description": "",
"class": "Bytes",
"properties": []
},
{
"name": "boolFalse",
"description": "",
"class": "Bool",
"properties": []
},
{
"name": "boolTrue",
"description": "",
"class": "Bool",
"properties": []
},
{
"name": "vector\u003ct\u003e",
"description": "",
"class": "Vector\u003cT\u003e",
"properties": []
},
{
"name": "error",
"description": "An object of this type can be returned on every function call, in case of an error",
"class": "Error",
"properties": [
{
"name": "code",
"type": "int32",
"description": "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"
},
{
"name": "message",
"type": "string",
"description": "Error message; subject to future changes"
}
]
},
{
"name": "ok",
"description": "An object of this type is returned on a successful function call for certain functions",
"class": "Ok",
"properties": []
},
{
"name": "authenticationCodeTypeTelegramMessage",
"description": "An authentication code is delivered via a private Telegram message, which can be viewed from another active session",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeTypeSms",
"description": "An authentication code is delivered via an SMS message to the specified phone number; applications may not receive this type of code",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeTypeCall",
"description": "An authentication code is delivered via a phone call to the specified phone number",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeTypeFlashCall",
"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",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "pattern",
"type": "string",
"description": "Pattern of the phone number from which the call will be made"
}
]
},
{
"name": "authenticationCodeTypeMissedCall",
"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",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "phone_number_prefix",
"type": "string",
"description": "Prefix of the phone number from which the call will be made"
},
{
"name": "length",
"type": "int32",
"description": "Number of digits in the code, excluding the prefix"
}
]
},
{
"name": "authenticationCodeTypeFragment",
"description": "An authentication code is delivered to https://fragment.com. The user must be logged in there via a wallet owning the phone number's NFT",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL to open to receive the code"
},
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeTypeFirebaseAndroid",
"description": "An authentication code is delivered via Firebase Authentication to the official Android application",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "nonce",
"type": "bytes",
"description": "Nonce to pass to the SafetyNet Attestation API"
},
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeTypeFirebaseIos",
"description": "An authentication code is delivered via Firebase Authentication to the official iOS application",
"class": "AuthenticationCodeType",
"properties": [
{
"name": "receipt",
"type": "string",
"description": "Receipt of successful application token validation to compare with receipt from push notification"
},
{
"name": "push_timeout",
"type": "int32",
"description": "Time after the next authentication method is supposed to be used if verification push notification isn't received, in seconds"
},
{
"name": "length",
"type": "int32",
"description": "Length of the code"
}
]
},
{
"name": "authenticationCodeInfo",
"description": "Information about the authentication code that was sent",
"class": "AuthenticationCodeInfo",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "A phone number that is being authenticated"
},
{
"name": "type",
"type": "AuthenticationCodeType",
"description": "The way the code was sent to the user"
},
{
"name": "next_type",
"type": "AuthenticationCodeType",
"description": "The way the next code will be sent to the user; may be null"
},
{
"name": "timeout",
"type": "int32",
"description": "Timeout before the code can be re-sent, in seconds"
}
]
},
{
"name": "emailAddressAuthenticationCodeInfo",
"description": "Information about the email address authentication code that was sent",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [
{
"name": "email_address_pattern",
"type": "string",
"description": "Pattern of the email address to which an authentication code was sent"
},
{
"name": "length",
"type": "int32",
"description": "Length of the code; 0 if unknown"
}
]
},
{
"name": "emailAddressAuthenticationCode",
"description": "An authentication code delivered to a user's email address",
"class": "EmailAddressAuthentication",
"properties": [
{
"name": "code",
"type": "string",
"description": "The code"
}
]
},
{
"name": "emailAddressAuthenticationAppleId",
"description": "An authentication token received through Apple ID",
"class": "EmailAddressAuthentication",
"properties": [
{
"name": "token",
"type": "string",
"description": "The token"
}
]
},
{
"name": "emailAddressAuthenticationGoogleId",
"description": "An authentication token received through Google ID",
"class": "EmailAddressAuthentication",
"properties": [
{
"name": "token",
"type": "string",
"description": "The token"
}
]
},
{
"name": "emailAddressResetStateAvailable",
"description": "Email address can be reset after the given period. Call resetAuthenticationEmailAddress to reset it and allow the user to authorize with a code sent to the user's phone number",
"class": "EmailAddressResetState",
"properties": [
{
"name": "wait_period",
"type": "int32",
"description": "Time required to wait before the email address can be reset; 0 if the user is subscribed to Telegram Premium"
}
]
},
{
"name": "emailAddressResetStatePending",
"description": "Email address reset has already been requested. Call resetAuthenticationEmailAddress to check whether immediate reset is possible",
"class": "EmailAddressResetState",
"properties": [
{
"name": "reset_in",
"type": "int32",
"description": "Left time before the email address will be reset, in seconds. updateAuthorizationState is not sent when this field changes"
}
]
},
{
"name": "textEntity",
"description": "Represents a part of the text that needs to be formatted in some unusual way",
"class": "TextEntity",
"properties": [
{
"name": "offset",
"type": "int32",
"description": "Offset of the entity, in UTF-16 code units"
},
{
"name": "length",
"type": "int32",
"description": "Length of the entity, in UTF-16 code units"
},
{
"name": "type",
"type": "TextEntityType",
"description": "Type of the entity"
}
]
},
{
"name": "textEntities",
"description": "Contains a list of text entities",
"class": "TextEntities",
"properties": [
{
"name": "entities",
"type": "vector\u003ctextEntity\u003e",
"description": "List of text entities"
}
]
},
{
"name": "formattedText",
"description": "A text with some entities",
"class": "FormattedText",
"properties": [
{
"name": "text",
"type": "string",
"description": "The text"
},
{
"name": "entities",
"type": "vector\u003ctextEntity\u003e",
"description": "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. BlockQuote entities can't contain other BlockQuote entities. Bold, Italic, Underline, Strikethrough, and Spoiler entities can contain and can be part of any other entities. All other entities can't contain each other"
}
]
},
{
"name": "termsOfService",
"description": "Contains Telegram terms of service",
"class": "TermsOfService",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text of the terms of service"
},
{
"name": "min_user_age",
"type": "int32",
"description": "The minimum age of a user to be able to accept the terms; 0 if age isn't restricted"
},
{
"name": "show_popup",
"type": "Bool",
"description": "True, if a blocking popup with terms of service must be shown to the user"
}
]
},
{
"name": "authorizationStateWaitTdlibParameters",
"description": "Initialization parameters are needed. Call setTdlibParameters to provide them",
"class": "AuthorizationState",
"properties": []
},
{
"name": "authorizationStateWaitPhoneNumber",
"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",
"class": "AuthorizationState",
"properties": []
},
{
"name": "authorizationStateWaitEmailAddress",
"description": "TDLib needs the user's email address to authorize. Call setAuthenticationEmailAddress to provide the email address, or directly call checkAuthenticationEmailCode with Apple ID/Google ID token if allowed",
"class": "AuthorizationState",
"properties": [
{
"name": "allow_apple_id",
"type": "Bool",
"description": "True, if authorization through Apple ID is allowed"
},
{
"name": "allow_google_id",
"type": "Bool",
"description": "True, if authorization through Google ID is allowed"
}
]
},
{
"name": "authorizationStateWaitEmailCode",
"description": "TDLib needs the user's authentication code sent to an email address to authorize. Call checkAuthenticationEmailCode to provide the code",
"class": "AuthorizationState",
"properties": [
{
"name": "allow_apple_id",
"type": "Bool",
"description": "True, if authorization through Apple ID is allowed"
},
{
"name": "allow_google_id",
"type": "Bool",
"description": "True, if authorization through Google ID is allowed"
},
{
"name": "code_info",
"type": "emailAddressAuthenticationCodeInfo",
"description": "Information about the sent authentication code"
},
{
"name": "email_address_reset_state",
"type": "EmailAddressResetState",
"description": "Reset state of the email address; may be null if the email address can't be reset"
}
]
},
{
"name": "authorizationStateWaitCode",
"description": "TDLib needs the user's authentication code to authorize. Call checkAuthenticationCode to check the code",
"class": "AuthorizationState",
"properties": [
{
"name": "code_info",
"type": "authenticationCodeInfo",
"description": "Information about the authorization code that was sent"
}
]
},
{
"name": "authorizationStateWaitOtherDeviceConfirmation",
"description": "The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link",
"class": "AuthorizationState",
"properties": [
{
"name": "link",
"type": "string",
"description": "A tg:// URL for the QR code. The link will be updated frequently"
}
]
},
{
"name": "authorizationStateWaitRegistration",
"description": "The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration. Call registerUser to accept the terms of service and provide the data",
"class": "AuthorizationState",
"properties": [
{
"name": "terms_of_service",
"type": "termsOfService",
"description": "Telegram terms of service"
}
]
},
{
"name": "authorizationStateWaitPassword",
"description": "The user has been authorized, but needs to enter a 2-step verification password to start using the application. Call checkAuthenticationPassword to provide the password, or requestAuthenticationPasswordRecovery to recover the password, or deleteAccount to delete the account after a week",
"class": "AuthorizationState",
"properties": [
{
"name": "password_hint",
"type": "string",
"description": "Hint for the password; may be empty"
},
{
"name": "has_recovery_email_address",
"type": "Bool",
"description": "True, if a recovery email address has been set up"
},
{
"name": "has_passport_data",
"type": "Bool",
"description": "True, if some Telegram Passport elements were saved"
},
{
"name": "recovery_email_address_pattern",
"type": "string",
"description": "Pattern of the email address to which the recovery email was sent; empty until a recovery email has been sent"
}
]
},
{
"name": "authorizationStateReady",
"description": "The user has been successfully authorized. TDLib is now ready to answer general requests",
"class": "AuthorizationState",
"properties": []
},
{
"name": "authorizationStateLoggingOut",
"description": "The user is currently logging out",
"class": "AuthorizationState",
"properties": []
},
{
"name": "authorizationStateClosing",
"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",
"class": "AuthorizationState",
"properties": []
},
{
"name": "authorizationStateClosed",
"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",
"class": "AuthorizationState",
"properties": []
},
{
"name": "passwordState",
"description": "Represents the current state of 2-step verification",
"class": "PasswordState",
"properties": [
{
"name": "has_password",
"type": "Bool",
"description": "True, if a 2-step verification password is set"
},
{
"name": "password_hint",
"type": "string",
"description": "Hint for the password; may be empty"
},
{
"name": "has_recovery_email_address",
"type": "Bool",
"description": "True, if a recovery email is set"
},
{
"name": "has_passport_data",
"type": "Bool",
"description": "True, if some Telegram Passport elements were saved"
},
{
"name": "recovery_email_address_code_info",
"type": "emailAddressAuthenticationCodeInfo",
"description": "Information about the recovery email address to which the confirmation email was sent; may be null"
},
{
"name": "login_email_address_pattern",
"type": "string",
"description": "Pattern of the email address set up for logging in"
},
{
"name": "pending_reset_date",
"type": "int32",
"description": "If not 0, point in time (Unix timestamp) after which the 2-step verification password can be reset immediately using resetPassword"
}
]
},
{
"name": "recoveryEmailAddress",
"description": "Contains information about the current recovery email address",
"class": "RecoveryEmailAddress",
"properties": [
{
"name": "recovery_email_address",
"type": "string",
"description": "Recovery email address"
}
]
},
{
"name": "temporaryPasswordState",
"description": "Returns information about the availability of a temporary password, which can be used for payments",
"class": "TemporaryPasswordState",
"properties": [
{
"name": "has_password",
"type": "Bool",
"description": "True, if a temporary password is available"
},
{
"name": "valid_for",
"type": "int32",
"description": "Time left before the temporary password expires, in seconds"
}
]
},
{
"name": "localFile",
"description": "Represents a local file",
"class": "LocalFile",
"properties": [
{
"name": "path",
"type": "string",
"description": "Local path to the locally available file part; may be empty"
},
{
"name": "can_be_downloaded",
"type": "Bool",
"description": "True, if it is possible to download or generate the file"
},
{
"name": "can_be_deleted",
"type": "Bool",
"description": "True, if the file can be deleted"
},
{
"name": "is_downloading_active",
"type": "Bool",
"description": "True, if the file is currently being downloaded (or a local copy is being generated by some other means)"
},
{
"name": "is_downloading_completed",
"type": "Bool",
"description": "True, if the local copy is fully available"
},
{
"name": "download_offset",
"type": "int53",
"description": "Download will be started from this offset. downloaded_prefix_size is calculated from this offset"
},
{
"name": "downloaded_prefix_size",
"type": "int53",
"description": "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"
},
{
"name": "downloaded_size",
"type": "int53",
"description": "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"
}
]
},
{
"name": "remoteFile",
"description": "Represents a remote file",
"class": "RemoteFile",
"properties": [
{
"name": "id",
"type": "string",
"description": "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 identifier 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/addFileToDownloads 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"
},
{
"name": "unique_id",
"type": "string",
"description": "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"
},
{
"name": "is_uploading_active",
"type": "Bool",
"description": "True, if the file is currently being uploaded (or a remote copy is being generated by some other means)"
},
{
"name": "is_uploading_completed",
"type": "Bool",
"description": "True, if a remote copy is fully available"
},
{
"name": "uploaded_size",
"type": "int53",
"description": "Size of the remote available part of the file, in bytes; 0 if unknown"
}
]
},
{
"name": "file",
"description": "Represents a file",
"class": "File",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique file identifier"
},
{
"name": "size",
"type": "int53",
"description": "File size, in bytes; 0 if unknown"
},
{
"name": "expected_size",
"type": "int53",
"description": "Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress"
},
{
"name": "local",
"type": "localFile",
"description": "Information about the local copy of the file"
},
{
"name": "remote",
"type": "remoteFile",
"description": "Information about the remote copy of the file"
}
]
},
{
"name": "inputFileId",
"description": "A file defined by its unique identifier",
"class": "InputFile",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique file identifier"
}
]
},
{
"name": "inputFileRemote",
"description": "A file defined by its remote identifier. The remote identifier 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",
"class": "InputFile",
"properties": [
{
"name": "id",
"type": "string",
"description": "Remote file identifier"
}
]
},
{
"name": "inputFileLocal",
"description": "A file defined by a local path",
"class": "InputFile",
"properties": [
{
"name": "path",
"type": "string",
"description": "Local path to the file"
}
]
},
{
"name": "inputFileGenerated",
"description": "A file generated by the application",
"class": "InputFile",
"properties": [
{
"name": "original_path",
"type": "string",
"description": "Local path to a file from which the file is generated; may be empty if there is no such file"
},
{
"name": "conversion",
"type": "string",
"description": "String specifying the conversion applied to the original file; must be persistent across application restarts. Conversions beginning with '#' are reserved for internal TDLib usage"
},
{
"name": "expected_size",
"type": "int53",
"description": "Expected size of the generated file, in bytes; 0 if unknown"
}
]
},
{
"name": "photoSize",
"description": "Describes an image in JPEG format",
"class": "PhotoSize",
"properties": [
{
"name": "type",
"type": "string",
"description": "Image type (see https://core.telegram.org/constructor/photoSize)"
},
{
"name": "photo",
"type": "file",
"description": "Information about the image file"
},
{
"name": "width",
"type": "int32",
"description": "Image width"
},
{
"name": "height",
"type": "int32",
"description": "Image height"
},
{
"name": "progressive_sizes",
"type": "vector\u003cint32\u003e",
"description": "Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image; in bytes"
}
]
},
{
"name": "minithumbnail",
"description": "Thumbnail image of a very poor quality and low resolution",
"class": "Minithumbnail",
"properties": [
{
"name": "width",
"type": "int32",
"description": "Thumbnail width, usually doesn't exceed 40"
},
{
"name": "height",
"type": "int32",
"description": "Thumbnail height, usually doesn't exceed 40"
},
{
"name": "data",
"type": "bytes",
"description": "The thumbnail in JPEG format"
}
]
},
{
"name": "thumbnailFormatJpeg",
"description": "The thumbnail is in JPEG format",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatGif",
"description": "The thumbnail is in static GIF format. It will be used only for some bot inline query results",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatMpeg4",
"description": "The thumbnail is in MPEG4 format. It will be used only for some animations and videos",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatPng",
"description": "The thumbnail is in PNG format. It will be used only for background patterns",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatTgs",
"description": "The thumbnail is in TGS format. It will be used only for sticker sets",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatWebm",
"description": "The thumbnail is in WEBM format. It will be used only for sticker sets",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnailFormatWebp",
"description": "The thumbnail is in WEBP format. It will be used only for some stickers and sticker sets",
"class": "ThumbnailFormat",
"properties": []
},
{
"name": "thumbnail",
"description": "Represents a thumbnail",
"class": "Thumbnail",
"properties": [
{
"name": "format",
"type": "ThumbnailFormat",
"description": "Thumbnail format"
},
{
"name": "width",
"type": "int32",
"description": "Thumbnail width"
},
{
"name": "height",
"type": "int32",
"description": "Thumbnail height"
},
{
"name": "file",
"type": "file",
"description": "The thumbnail"
}
]
},
{
"name": "maskPointForehead",
"description": "The mask is placed relatively to the forehead",
"class": "MaskPoint",
"properties": []
},
{
"name": "maskPointEyes",
"description": "The mask is placed relatively to the eyes",
"class": "MaskPoint",
"properties": []
},
{
"name": "maskPointMouth",
"description": "The mask is placed relatively to the mouth",
"class": "MaskPoint",
"properties": []
},
{
"name": "maskPointChin",
"description": "The mask is placed relatively to the chin",
"class": "MaskPoint",
"properties": []
},
{
"name": "maskPosition",
"description": "Position on a photo where a mask is placed",
"class": "MaskPosition",
"properties": [
{
"name": "point",
"type": "MaskPoint",
"description": "Part of the face, relative to which the mask is placed"
},
{
"name": "x_shift",
"type": "double",
"description": "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)"
},
{
"name": "y_shift",
"type": "double",
"description": "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)"
},
{
"name": "scale",
"type": "double",
"description": "Mask scaling coefficient. (For example, 2.0 means a doubled size)"
}
]
},
{
"name": "stickerFormatWebp",
"description": "The sticker is an image in WEBP format",
"class": "StickerFormat",
"properties": []
},
{
"name": "stickerFormatTgs",
"description": "The sticker is an animation in TGS format",
"class": "StickerFormat",
"properties": []
},
{
"name": "stickerFormatWebm",
"description": "The sticker is a video in WEBM format",
"class": "StickerFormat",
"properties": []
},
{
"name": "stickerTypeRegular",
"description": "The sticker is a regular sticker",
"class": "StickerType",
"properties": []
},
{
"name": "stickerTypeMask",
"description": "The sticker is a mask in WEBP format to be placed on photos or videos",
"class": "StickerType",
"properties": []
},
{
"name": "stickerTypeCustomEmoji",
"description": "The sticker is a custom emoji to be used inside message text and caption",
"class": "StickerType",
"properties": []
},
{
"name": "stickerFullTypeRegular",
"description": "The sticker is a regular sticker",
"class": "StickerFullType",
"properties": [
{
"name": "premium_animation",
"type": "file",
"description": "Premium animation of the sticker; may be null. If present, only Telegram Premium users can use the sticker"
}
]
},
{
"name": "stickerFullTypeMask",
"description": "The sticker is a mask in WEBP format to be placed on photos or videos",
"class": "StickerFullType",
"properties": [
{
"name": "mask_position",
"type": "maskPosition",
"description": "Position where the mask is placed; may be null"
}
]
},
{
"name": "stickerFullTypeCustomEmoji",
"description": "The sticker is a custom emoji to be used inside message text and caption. Currently, only Telegram Premium users can use custom emoji",
"class": "StickerFullType",
"properties": [
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Identifier of the custom emoji"
},
{
"name": "needs_repainting",
"type": "Bool",
"description": "True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places"
}
]
},
{
"name": "closedVectorPath",
"description": "Represents a closed vector path. The path begins at the end point of the last command",
"class": "ClosedVectorPath",
"properties": [
{
"name": "commands",
"type": "vector\u003cVectorPathCommand\u003e",
"description": "List of vector path commands"
}
]
},
{
"name": "pollOption",
"description": "Describes one answer option of a poll",
"class": "PollOption",
"properties": [
{
"name": "text",
"type": "string",
"description": "Option text; 1-100 characters"
},
{
"name": "voter_count",
"type": "int32",
"description": "Number of voters for this option, available only for closed or voted polls"
},
{
"name": "vote_percentage",
"type": "int32",
"description": "The percentage of votes for this option; 0-100"
},
{
"name": "is_chosen",
"type": "Bool",
"description": "True, if the option was chosen by the user"
},
{
"name": "is_being_chosen",
"type": "Bool",
"description": "True, if the option is being chosen by a pending setPollAnswer request"
}
]
},
{
"name": "pollTypeRegular",
"description": "A regular poll",
"class": "PollType",
"properties": [
{
"name": "allow_multiple_answers",
"type": "Bool",
"description": "True, if multiple answer options can be chosen simultaneously"
}
]
},
{
"name": "pollTypeQuiz",
"description": "A poll in quiz mode, which has exactly one correct answer option and can be answered only once",
"class": "PollType",
"properties": [
{
"name": "correct_option_id",
"type": "int32",
"description": "0-based identifier of the correct answer option; -1 for a yet unanswered poll"
},
{
"name": "explanation",
"type": "formattedText",
"description": "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"
}
]
},
{
"name": "animation",
"description": "Describes an animation file. The animation must be encoded in GIF or MPEG4 format",
"class": "Animation",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Duration of the animation, in seconds; as defined by the sender"
},
{
"name": "width",
"type": "int32",
"description": "Width of the animation"
},
{
"name": "height",
"type": "int32",
"description": "Height of the animation"
},
{
"name": "file_name",
"type": "string",
"description": "Original name of the file; as defined by the sender"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the file, usually \"image/gif\" or \"video/mp4\""
},
{
"name": "has_stickers",
"type": "Bool",
"description": "True, if stickers were added to the animation. The list of corresponding sticker set can be received using getAttachedStickerSets"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Animation minithumbnail; may be null"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Animation thumbnail in JPEG or MPEG4 format; may be null"
},
{
"name": "animation",
"type": "file",
"description": "File containing the animation"
}
]
},
{
"name": "audio",
"description": "Describes an audio file. Audio is usually in MP3 or M4A format",
"class": "Audio",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Duration of the audio, in seconds; as defined by the sender"
},
{
"name": "title",
"type": "string",
"description": "Title of the audio; as defined by the sender"
},
{
"name": "performer",
"type": "string",
"description": "Performer of the audio; as defined by the sender"
},
{
"name": "file_name",
"type": "string",
"description": "Original name of the file; as defined by the sender"
},
{
"name": "mime_type",
"type": "string",
"description": "The MIME type of the file; as defined by the sender"
},
{
"name": "album_cover_minithumbnail",
"type": "minithumbnail",
"description": "The minithumbnail of the album cover; may be null"
},
{
"name": "album_cover_thumbnail",
"type": "thumbnail",
"description": "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 audio file; may be null"
},
{
"name": "external_album_covers",
"type": "vector\u003cthumbnail\u003e",
"description": "Album cover variants to use if the downloaded audio file contains no album cover. Provided thumbnail dimensions are approximate"
},
{
"name": "audio",
"type": "file",
"description": "File containing the audio"
}
]
},
{
"name": "document",
"description": "Describes a document of any type",
"class": "Document",
"properties": [
{
"name": "file_name",
"type": "string",
"description": "Original name of the file; as defined by the sender"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the file; as defined by the sender"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Document minithumbnail; may be null"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null"
},
{
"name": "document",
"type": "file",
"description": "File containing the document"
}
]
},
{
"name": "photo",
"description": "Describes a photo",
"class": "Photo",
"properties": [
{
"name": "has_stickers",
"type": "Bool",
"description": "True, if stickers were added to the photo. The list of corresponding sticker sets can be received using getAttachedStickerSets"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Photo minithumbnail; may be null"
},
{
"name": "sizes",
"type": "vector\u003cphotoSize\u003e",
"description": "Available variants of the photo, in different sizes"
}
]
},
{
"name": "sticker",
"description": "Describes a sticker",
"class": "Sticker",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique sticker identifier within the set; 0 if none"
},
{
"name": "set_id",
"type": "int64",
"description": "Identifier of the sticker set to which the sticker belongs; 0 if none"
},
{
"name": "width",
"type": "int32",
"description": "Sticker width; as defined by the sender"
},
{
"name": "height",
"type": "int32",
"description": "Sticker height; as defined by the sender"
},
{
"name": "emoji",
"type": "string",
"description": "Emoji corresponding to the sticker"
},
{
"name": "format",
"type": "StickerFormat",
"description": "Sticker format"
},
{
"name": "full_type",
"type": "StickerFullType",
"description": "Sticker's full type"
},
{
"name": "outline",
"type": "vector\u003cclosedVectorPath\u003e",
"description": "Sticker's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Sticker thumbnail in WEBP or JPEG format; may be null"
},
{
"name": "sticker",
"type": "file",
"description": "File containing the sticker"
}
]
},
{
"name": "video",
"description": "Describes a video file",
"class": "Video",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Duration of the video, in seconds; as defined by the sender"
},
{
"name": "width",
"type": "int32",
"description": "Video width; as defined by the sender"
},
{
"name": "height",
"type": "int32",
"description": "Video height; as defined by the sender"
},
{
"name": "file_name",
"type": "string",
"description": "Original name of the file; as defined by the sender"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the file; as defined by the sender"
},
{
"name": "has_stickers",
"type": "Bool",
"description": "True, if stickers were added to the video. The list of corresponding sticker sets can be received using getAttachedStickerSets"
},
{
"name": "supports_streaming",
"type": "Bool",
"description": "True, if the video is supposed to be streamed"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Video minithumbnail; may be null"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Video thumbnail in JPEG or MPEG4 format; as defined by the sender; may be null"
},
{
"name": "video",
"type": "file",
"description": "File containing the video"
}
]
},
{
"name": "videoNote",
"description": "Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format",
"class": "VideoNote",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Duration of the video, in seconds; as defined by the sender"
},
{
"name": "waveform",
"type": "bytes",
"description": "A waveform representation of the video note's audio in 5-bit format; may be empty if unknown"
},
{
"name": "length",
"type": "int32",
"description": "Video width and height; as defined by the sender"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Video minithumbnail; may be null"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Video thumbnail in JPEG format; as defined by the sender; may be null"
},
{
"name": "speech_recognition_result",
"type": "SpeechRecognitionResult",
"description": "Result of speech recognition in the video note; may be null"
},
{
"name": "video",
"type": "file",
"description": "File containing the video"
}
]
},
{
"name": "voiceNote",
"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",
"class": "VoiceNote",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Duration of the voice note, in seconds; as defined by the sender"
},
{
"name": "waveform",
"type": "bytes",
"description": "A waveform representation of the voice note in 5-bit format"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the file; as defined by the sender"
},
{
"name": "speech_recognition_result",
"type": "SpeechRecognitionResult",
"description": "Result of speech recognition in the voice note; may be null"
},
{
"name": "voice",
"type": "file",
"description": "File containing the voice note"
}
]
},
{
"name": "animatedEmoji",
"description": "Describes an animated or custom representation of an emoji",
"class": "AnimatedEmoji",
"properties": [
{
"name": "sticker",
"type": "sticker",
"description": "Sticker for the emoji; may be null if yet unknown for a custom emoji. If the sticker is a custom emoji, then it can have arbitrary format"
},
{
"name": "sticker_width",
"type": "int32",
"description": "Expected width of the sticker, which can be used if the sticker is null"
},
{
"name": "sticker_height",
"type": "int32",
"description": "Expected height of the sticker, which can be used if the sticker is null"
},
{
"name": "fitzpatrick_type",
"type": "int32",
"description": "Emoji modifier fitzpatrick type; 0-6; 0 if none"
},
{
"name": "sound",
"type": "file",
"description": "File containing the sound to be played when the sticker is clicked; may be null. The sound is encoded with the Opus codec, and stored inside an OGG container"
}
]
},
{
"name": "contact",
"description": "Describes a user contact",
"class": "Contact",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "Phone number of the user"
},
{
"name": "first_name",
"type": "string",
"description": "First name of the user; 1-255 characters in length"
},
{
"name": "last_name",
"type": "string",
"description": "Last name of the user"
},
{
"name": "vcard",
"type": "string",
"description": "Additional data about the user in a form of vCard; 0-2048 bytes in length"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user, if known; 0 otherwise"
}
]
},
{
"name": "location",
"description": "Describes a location on planet Earth",
"class": "Location",
"properties": [
{
"name": "latitude",
"type": "double",
"description": "Latitude of the location in degrees; as defined by the sender"
},
{
"name": "longitude",
"type": "double",
"description": "Longitude of the location, in degrees; as defined by the sender"
},
{
"name": "horizontal_accuracy",
"type": "double",
"description": "The estimated horizontal accuracy of the location, in meters; as defined by the sender. 0 if unknown"
}
]
},
{
"name": "venue",
"description": "Describes a venue",
"class": "Venue",
"properties": [
{
"name": "location",
"type": "location",
"description": "Venue location; as defined by the sender"
},
{
"name": "title",
"type": "string",
"description": "Venue name; as defined by the sender"
},
{
"name": "address",
"type": "string",
"description": "Venue address; as defined by the sender"
},
{
"name": "provider",
"type": "string",
"description": "Provider of the venue database; as defined by the sender. Currently, only \"foursquare\" and \"gplaces\" (Google Places) need to be supported"
},
{
"name": "id",
"type": "string",
"description": "Identifier of the venue in the provider database; as defined by the sender"
},
{
"name": "type",
"type": "string",
"description": "Type of the venue in the provider database; as defined by the sender"
}
]
},
{
"name": "game",
"description": "Describes a game. Use getInternalLink with internalLinkTypeGame to share the game",
"class": "Game",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique game identifier"
},
{
"name": "short_name",
"type": "string",
"description": "Game short name"
},
{
"name": "title",
"type": "string",
"description": "Game title"
},
{
"name": "text",
"type": "formattedText",
"description": "Game text, usually containing scoreboards for a game"
},
{
"name": "description",
"type": "string",
"description": "Game description"
},
{
"name": "photo",
"type": "photo",
"description": "Game photo"
},
{
"name": "animation",
"type": "animation",
"description": "Game animation; may be null"
}
]
},
{
"name": "webApp",
"description": "Describes a Web App. Use getInternalLink with internalLinkTypeWebApp to share the Web App",
"class": "WebApp",
"properties": [
{
"name": "short_name",
"type": "string",
"description": "Web App short name"
},
{
"name": "title",
"type": "string",
"description": "Web App title"
},
{
"name": "description",
"type": "string",
"description": "Web App description"
},
{
"name": "photo",
"type": "photo",
"description": "Web App photo"
},
{
"name": "animation",
"type": "animation",
"description": "Web App animation; may be null"
}
]
},
{
"name": "poll",
"description": "Describes a poll",
"class": "Poll",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique poll identifier"
},
{
"name": "question",
"type": "string",
"description": "Poll question; 1-300 characters"
},
{
"name": "options",
"type": "vector\u003cpollOption\u003e",
"description": "List of poll answer options"
},
{
"name": "total_voter_count",
"type": "int32",
"description": "Total number of voters, participating in the poll"
},
{
"name": "recent_voter_ids",
"type": "vector\u003cMessageSender\u003e",
"description": "Identifiers of recent voters, if the poll is non-anonymous"
},
{
"name": "is_anonymous",
"type": "Bool",
"description": "True, if the poll is anonymous"
},
{
"name": "type",
"type": "PollType",
"description": "Type of the poll"
},
{
"name": "open_period",
"type": "int32",
"description": "Amount of time the poll will be active after creation, in seconds"
},
{
"name": "close_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the poll will automatically be closed"
},
{
"name": "is_closed",
"type": "Bool",
"description": "True, if the poll is closed"
}
]
},
{
"name": "background",
"description": "Describes a chat background",
"class": "Background",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique background identifier"
},
{
"name": "is_default",
"type": "Bool",
"description": "True, if this is one of default backgrounds"
},
{
"name": "is_dark",
"type": "Bool",
"description": "True, if the background is dark and is recommended to be used with dark theme"
},
{
"name": "name",
"type": "string",
"description": "Unique background name"
},
{
"name": "document",
"type": "document",
"description": "Document with the background; may be null. Null only for filled and chat theme backgrounds"
},
{
"name": "type",
"type": "BackgroundType",
"description": "Type of the background"
}
]
},
{
"name": "backgrounds",
"description": "Contains a list of backgrounds",
"class": "Backgrounds",
"properties": [
{
"name": "backgrounds",
"type": "vector\u003cbackground\u003e",
"description": "A list of backgrounds"
}
]
},
{
"name": "chatBackground",
"description": "Describes a background set for a specific chat",
"class": "ChatBackground",
"properties": [
{
"name": "background",
"type": "background",
"description": "The background"
},
{
"name": "dark_theme_dimming",
"type": "int32",
"description": "Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background"
}
]
},
{
"name": "profilePhoto",
"description": "Describes a user profile photo",
"class": "ProfilePhoto",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Photo identifier; 0 for an empty photo. Can be used to find a photo in a list of user profile photos"
},
{
"name": "small",
"type": "file",
"description": "A small (160x160) user profile photo. The file can be downloaded only before the photo is changed"
},
{
"name": "big",
"type": "file",
"description": "A big (640x640) user profile photo. The file can be downloaded only before the photo is changed"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "User profile photo minithumbnail; may be null"
},
{
"name": "has_animation",
"type": "Bool",
"description": "True, if the photo has animated variant"
},
{
"name": "is_personal",
"type": "Bool",
"description": "True, if the photo is visible only for the current user"
}
]
},
{
"name": "chatPhotoInfo",
"description": "Contains basic information about the photo of a chat",
"class": "ChatPhotoInfo",
"properties": [
{
"name": "small",
"type": "file",
"description": "A small (160x160) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed"
},
{
"name": "big",
"type": "file",
"description": "A big (640x640) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Chat photo minithumbnail; may be null"
},
{
"name": "has_animation",
"type": "Bool",
"description": "True, if the photo has animated variant"
},
{
"name": "is_personal",
"type": "Bool",
"description": "True, if the photo is visible only for the current user"
}
]
},
{
"name": "userTypeRegular",
"description": "A regular user",
"class": "UserType",
"properties": []
},
{
"name": "userTypeDeleted",
"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",
"class": "UserType",
"properties": []
},
{
"name": "userTypeBot",
"description": "A bot (see https://core.telegram.org/bots)",
"class": "UserType",
"properties": [
{
"name": "can_be_edited",
"type": "Bool",
"description": "True, if the bot is owned by the current user and can be edited using the methods toggleBotUsernameIsActive, reorderBotActiveUsernames, setBotProfilePhoto, setBotName, setBotInfoDescription, and setBotInfoShortDescription"
},
{
"name": "can_join_groups",
"type": "Bool",
"description": "True, if the bot can be invited to basic group and supergroup chats"
},
{
"name": "can_read_all_group_messages",
"type": "Bool",
"description": "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"
},
{
"name": "is_inline",
"type": "Bool",
"description": "True, if the bot supports inline queries"
},
{
"name": "inline_query_placeholder",
"type": "string",
"description": "Placeholder for inline queries (displayed on the application input field)"
},
{
"name": "need_location",
"type": "Bool",
"description": "True, if the location of the user is expected to be sent with every inline query to this bot"
},
{
"name": "can_connect_to_business",
"type": "Bool",
"description": "True, if the bot supports connection to Telegram Business accounts"
},
{
"name": "can_be_added_to_attachment_menu",
"type": "Bool",
"description": "True, if the bot can be added to attachment or side menu"
}
]
},
{
"name": "userTypeUnknown",
"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",
"class": "UserType",
"properties": []
},
{
"name": "botCommand",
"description": "Represents a command supported by a bot",
"class": "BotCommand",
"properties": [
{
"name": "command",
"type": "string",
"description": "Text of the bot command"
},
{
"name": "description",
"type": "string",
"description": "Description of the bot command"
}
]
},
{
"name": "botCommands",
"description": "Contains a list of bot commands",
"class": "BotCommands",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Bot's user identifier"
},
{
"name": "commands",
"type": "vector\u003cbotCommand\u003e",
"description": "List of bot commands"
}
]
},
{
"name": "botMenuButton",
"description": "Describes a button to be shown instead of bot commands menu button",
"class": "BotMenuButton",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text of the button"
},
{
"name": "url",
"type": "string",
"description": "URL to be passed to openWebApp"
}
]
},
{
"name": "chatLocation",
"description": "Represents a location to which a chat is connected",
"class": "ChatLocation",
"properties": [
{
"name": "location",
"type": "location",
"description": "The location"
},
{
"name": "address",
"type": "string",
"description": "Location address; 1-64 characters, as defined by the chat owner"
}
]
},
{
"name": "birthdate",
"description": "Represents a birthdate of a user",
"class": "Birthdate",
"properties": [
{
"name": "day",
"type": "int32",
"description": "Day of the month; 1-31"
},
{
"name": "month",
"type": "int32",
"description": "Month of the year; 1-12"
},
{
"name": "year",
"type": "int32",
"description": "Birth year; 0 if unknown"
}
]
},
{
"name": "closeBirthdayUser",
"description": "Describes a user that had or will have a birthday soon",
"class": "CloseBirthdayUser",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "birthdate",
"type": "birthdate",
"description": "Birthdate of the user"
}
]
},
{
"name": "businessAwayMessageScheduleAlways",
"description": "Send away messages always",
"class": "BusinessAwayMessageSchedule",
"properties": []
},
{
"name": "businessAwayMessageScheduleOutsideOfOpeningHours",
"description": "Send away messages outside of the business opening hours",
"class": "BusinessAwayMessageSchedule",
"properties": []
},
{
"name": "businessAwayMessageScheduleCustom",
"description": "Send away messages only in the specified time span",
"class": "BusinessAwayMessageSchedule",
"properties": [
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the away messages will start to be sent"
},
{
"name": "end_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the away messages will stop to be sent"
}
]
},
{
"name": "businessLocation",
"description": "Represents a location of a business",
"class": "BusinessLocation",
"properties": [
{
"name": "location",
"type": "location",
"description": "The location; may be null if not specified"
},
{
"name": "address",
"type": "string",
"description": "Location address; 1-96 characters"
}
]
},
{
"name": "businessRecipients",
"description": "Describes private chats chosen for automatic interaction with a business",
"class": "BusinessRecipients",
"properties": [
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of selected private chats"
},
{
"name": "excluded_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of private chats that are always excluded; for businessConnectedBot only"
},
{
"name": "select_existing_chats",
"type": "Bool",
"description": "True, if all existing private chats are selected"
},
{
"name": "select_new_chats",
"type": "Bool",
"description": "True, if all new private chats are selected"
},
{
"name": "select_contacts",
"type": "Bool",
"description": "True, if all private chats with contacts are selected"
},
{
"name": "select_non_contacts",
"type": "Bool",
"description": "True, if all private chats with non-contacts are selected"
},
{
"name": "exclude_selected",
"type": "Bool",
"description": "If true, then all private chats except the selected are chosen. Otherwise, only the selected chats are chosen"
}
]
},
{
"name": "businessAwayMessageSettings",
"description": "Describes settings for messages that are automatically sent by a Telegram Business account when it is away",
"class": "BusinessAwayMessageSettings",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique quick reply shortcut identifier for the away messages"
},
{
"name": "recipients",
"type": "businessRecipients",
"description": "Chosen recipients of the away messages"
},
{
"name": "schedule",
"type": "BusinessAwayMessageSchedule",
"description": "Settings used to check whether the current user is away"
},
{
"name": "offline_only",
"type": "Bool",
"description": "True, if the messages must not be sent if the account was online in the last 10 minutes"
}
]
},
{
"name": "businessGreetingMessageSettings",
"description": "Describes settings for greeting messages that are automatically sent by a Telegram Business account as response to incoming messages in an inactive private chat",
"class": "BusinessGreetingMessageSettings",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique quick reply shortcut identifier for the greeting messages"
},
{
"name": "recipients",
"type": "businessRecipients",
"description": "Chosen recipients of the greeting messages"
},
{
"name": "inactivity_days",
"type": "int32",
"description": "The number of days after which a chat will be considered as inactive; currently, must be on of 7, 14, 21, or 28"
}
]
},
{
"name": "businessConnectedBot",
"description": "Describes a bot connected to a business account",
"class": "BusinessConnectedBot",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the bot"
},
{
"name": "recipients",
"type": "businessRecipients",
"description": "Private chats that will be accessible to the bot"
},
{
"name": "can_reply",
"type": "Bool",
"description": "True, if the bot can send messages to the private chats; false otherwise"
}
]
},
{
"name": "businessIntro",
"description": "Describes settings for a business account intro",
"class": "BusinessIntro",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title text of the intro"
},
{
"name": "message",
"type": "string",
"description": "Message text of the intro"
},
{
"name": "sticker",
"type": "sticker",
"description": "Greeting sticker of the intro; may be null if none"
}
]
},
{
"name": "inputBusinessIntro",
"description": "Describes settings for a business account intro to set",
"class": "InputBusinessIntro",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title text of the intro; 0-getOption(\"business_intro_title_length_max\") characters"
},
{
"name": "message",
"type": "string",
"description": "Message text of the intro; 0-getOption(\"business_intro_message_length_max\") characters"
},
{
"name": "sticker",
"type": "InputFile",
"description": "Greeting sticker of the intro; pass null if none. The sticker must belong to a sticker set and must not be a custom emoji"
}
]
},
{
"name": "businessOpeningHoursInterval",
"description": "Describes an interval of time when the business is open",
"class": "BusinessOpeningHoursInterval",
"properties": [
{
"name": "start_minute",
"type": "int32",
"description": "The first minute of the interval since start of the week; 0-7*24*60"
},
{
"name": "end_minute",
"type": "int32",
"description": "The first minute after the end of the interval since start of the week; 1-8*24*60"
}
]
},
{
"name": "businessOpeningHours",
"description": "Describes opening hours of a business",
"class": "BusinessOpeningHours",
"properties": [
{
"name": "time_zone_id",
"type": "string",
"description": "Unique time zone identifier"
},
{
"name": "opening_hours",
"type": "vector\u003cbusinessOpeningHoursInterval\u003e",
"description": "Intervals of the time when the business is open"
}
]
},
{
"name": "businessInfo",
"description": "Contains information about a Telegram Business account",
"class": "BusinessInfo",
"properties": [
{
"name": "location",
"type": "businessLocation",
"description": "Location of the business; may be null if none"
},
{
"name": "opening_hours",
"type": "businessOpeningHours",
"description": "Opening hours of the business; may be null if none. The hours are guaranteed to be valid and has already been split by week days"
},
{
"name": "greeting_message_settings",
"type": "businessGreetingMessageSettings",
"description": "The greeting message; may be null if none or the Business account is not of the current user"
},
{
"name": "away_message_settings",
"type": "businessAwayMessageSettings",
"description": "The away message; may be null if none or the Business account is not of the current user"
},
{
"name": "intro",
"type": "businessIntro",
"description": "Information about intro of the business; may be null if none"
}
]
},
{
"name": "chatPhotoStickerTypeRegularOrMask",
"description": "Information about the sticker, which was used to create the chat photo",
"class": "ChatPhotoStickerType",
"properties": [
{
"name": "sticker_set_id",
"type": "int64",
"description": "Sticker set identifier"
},
{
"name": "sticker_id",
"type": "int64",
"description": "Identifier of the sticker in the set"
}
]
},
{
"name": "chatPhotoStickerTypeCustomEmoji",
"description": "Information about the custom emoji, which was used to create the chat photo",
"class": "ChatPhotoStickerType",
"properties": [
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Identifier of the custom emoji"
}
]
},
{
"name": "chatPhotoSticker",
"description": "Information about the sticker, which was used to create the chat photo. The sticker is shown at the center of the photo and occupies at most 67% of it",
"class": "ChatPhotoSticker",
"properties": [
{
"name": "type",
"type": "ChatPhotoStickerType",
"description": "Type of the sticker"
},
{
"name": "background_fill",
"type": "BackgroundFill",
"description": "The fill to be used as background for the sticker; rotation angle in backgroundFillGradient isn't supported"
}
]
},
{
"name": "animatedChatPhoto",
"description": "Animated variant of a chat photo in MPEG4 format",
"class": "AnimatedChatPhoto",
"properties": [
{
"name": "length",
"type": "int32",
"description": "Animation width and height"
},
{
"name": "file",
"type": "file",
"description": "Information about the animation file"
},
{
"name": "main_frame_timestamp",
"type": "double",
"description": "Timestamp of the frame, used as a static chat photo"
}
]
},
{
"name": "chatPhoto",
"description": "Describes a chat or user profile photo",
"class": "ChatPhoto",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique photo identifier"
},
{
"name": "added_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the photo has been added"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Photo minithumbnail; may be null"
},
{
"name": "sizes",
"type": "vector\u003cphotoSize\u003e",
"description": "Available variants of the photo in JPEG format, in different size"
},
{
"name": "animation",
"type": "animatedChatPhoto",
"description": "A big (up to 1280x1280) animated variant of the photo in MPEG4 format; may be null"
},
{
"name": "small_animation",
"type": "animatedChatPhoto",
"description": "A small (160x160) animated variant of the photo in MPEG4 format; may be null even the big animation is available"
},
{
"name": "sticker",
"type": "chatPhotoSticker",
"description": "Sticker-based version of the chat photo; may be null"
}
]
},
{
"name": "chatPhotos",
"description": "Contains a list of chat or user profile photos",
"class": "ChatPhotos",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of photos"
},
{
"name": "photos",
"type": "vector\u003cchatPhoto\u003e",
"description": "List of photos"
}
]
},
{
"name": "inputChatPhotoPrevious",
"description": "A previously used profile photo of the current user",
"class": "InputChatPhoto",
"properties": [
{
"name": "chat_photo_id",
"type": "int64",
"description": "Identifier of the current user's profile photo to reuse"
}
]
},
{
"name": "inputChatPhotoStatic",
"description": "A static photo in JPEG format",
"class": "InputChatPhoto",
"properties": [
{
"name": "photo",
"type": "InputFile",
"description": "Photo to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed"
}
]
},
{
"name": "inputChatPhotoAnimation",
"description": "An animation in MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 1280 and be at most 2MB in size",
"class": "InputChatPhoto",
"properties": [
{
"name": "animation",
"type": "InputFile",
"description": "Animation to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed"
},
{
"name": "main_frame_timestamp",
"type": "double",
"description": "Timestamp of the frame, which will be used as static chat photo"
}
]
},
{
"name": "inputChatPhotoSticker",
"description": "A sticker on a custom background",
"class": "InputChatPhoto",
"properties": [
{
"name": "sticker",
"type": "chatPhotoSticker",
"description": "Information about the sticker"
}
]
},
{
"name": "chatPermissions",
"description": "Describes actions that a user is allowed to take in a chat",
"class": "ChatPermissions",
"properties": [
{
"name": "can_send_basic_messages",
"type": "Bool",
"description": "True, if the user can send text messages, contacts, giveaways, giveaway winners, invoices, locations, and venues"
},
{
"name": "can_send_audios",
"type": "Bool",
"description": "True, if the user can send music files"
},
{
"name": "can_send_documents",
"type": "Bool",
"description": "True, if the user can send documents"
},
{
"name": "can_send_photos",
"type": "Bool",
"description": "True, if the user can send photos"
},
{
"name": "can_send_videos",
"type": "Bool",
"description": "True, if the user can send videos"
},
{
"name": "can_send_video_notes",
"type": "Bool",
"description": "True, if the user can send video notes"
},
{
"name": "can_send_voice_notes",
"type": "Bool",
"description": "True, if the user can send voice notes"
},
{
"name": "can_send_polls",
"type": "Bool",
"description": "True, if the user can send polls"
},
{
"name": "can_send_other_messages",
"type": "Bool",
"description": "True, if the user can send animations, games, stickers, and dice and use inline bots"
},
{
"name": "can_add_web_page_previews",
"type": "Bool",
"description": "True, if the user may add a web page preview to their messages"
},
{
"name": "can_change_info",
"type": "Bool",
"description": "True, if the user can change the chat title, photo, and other settings"
},
{
"name": "can_invite_users",
"type": "Bool",
"description": "True, if the user can invite new users to the chat"
},
{
"name": "can_pin_messages",
"type": "Bool",
"description": "True, if the user can pin messages"
},
{
"name": "can_create_topics",
"type": "Bool",
"description": "True, if the user can create topics"
}
]
},
{
"name": "chatAdministratorRights",
"description": "Describes rights of the administrator",
"class": "ChatAdministratorRights",
"properties": [
{
"name": "can_manage_chat",
"type": "Bool",
"description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report supergroup spam messages and ignore slow mode. Implied by any other privilege; applicable to supergroups and channels only"
},
{
"name": "can_change_info",
"type": "Bool",
"description": "True, if the administrator can change the chat title, photo, and other settings"
},
{
"name": "can_post_messages",
"type": "Bool",
"description": "True, if the administrator can create channel posts or view channel statistics; applicable to channels only"
},
{
"name": "can_edit_messages",
"type": "Bool",
"description": "True, if the administrator can edit messages of other users and pin messages; applicable to channels only"
},
{
"name": "can_delete_messages",
"type": "Bool",
"description": "True, if the administrator can delete messages of other users"
},
{
"name": "can_invite_users",
"type": "Bool",
"description": "True, if the administrator can invite new users to the chat"
},
{
"name": "can_restrict_members",
"type": "Bool",
"description": "True, if the administrator can restrict, ban, or unban chat members or view supergroup statistics; always true for channels"
},
{
"name": "can_pin_messages",
"type": "Bool",
"description": "True, if the administrator can pin messages; applicable to basic groups and supergroups only"
},
{
"name": "can_manage_topics",
"type": "Bool",
"description": "True, if the administrator can create, rename, close, reopen, hide, and unhide forum topics; applicable to forum supergroups only"
},
{
"name": "can_promote_members",
"type": "Bool",
"description": "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"
},
{
"name": "can_manage_video_chats",
"type": "Bool",
"description": "True, if the administrator can manage video chats"
},
{
"name": "can_post_stories",
"type": "Bool",
"description": "True, if the administrator can create new chat stories, or edit and delete posted stories; applicable to supergroups and channels only"
},
{
"name": "can_edit_stories",
"type": "Bool",
"description": "True, if the administrator can edit stories posted by other users, pin stories and access story archive; applicable to supergroups and channels only"
},
{
"name": "can_delete_stories",
"type": "Bool",
"description": "True, if the administrator can delete stories posted by other users; applicable to supergroups and channels only"
},
{
"name": "is_anonymous",
"type": "Bool",
"description": "True, if the administrator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only"
}
]
},
{
"name": "premiumPaymentOption",
"description": "Describes an option for buying Telegram Premium to a user",
"class": "PremiumPaymentOption",
"properties": [
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code for Telegram Premium subscription payment"
},
{
"name": "amount",
"type": "int53",
"description": "The amount to pay, in the smallest units of the currency"
},
{
"name": "discount_percentage",
"type": "int32",
"description": "The discount associated with this option, as a percentage"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active"
},
{
"name": "store_product_id",
"type": "string",
"description": "Identifier of the store product associated with the option"
},
{
"name": "payment_link",
"type": "InternalLinkType",
"description": "An internal link to be opened for buying Telegram Premium to the user if store payment isn't possible; may be null if direct payment isn't available"
}
]
},
{
"name": "premiumStatePaymentOption",
"description": "Describes an option for buying or upgrading Telegram Premium for self",
"class": "PremiumStatePaymentOption",
"properties": [
{
"name": "payment_option",
"type": "premiumPaymentOption",
"description": "Information about the payment option"
},
{
"name": "is_current",
"type": "Bool",
"description": "True, if this is the currently used Telegram Premium subscription option"
},
{
"name": "is_upgrade",
"type": "Bool",
"description": "True, if the payment option can be used to upgrade the existing Telegram Premium subscription"
},
{
"name": "last_transaction_id",
"type": "string",
"description": "Identifier of the last in-store transaction for the currently used option"
}
]
},
{
"name": "premiumGiftCodePaymentOption",
"description": "Describes an option for creating Telegram Premium gift codes",
"class": "PremiumGiftCodePaymentOption",
"properties": [
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code for Telegram Premium gift code payment"
},
{
"name": "amount",
"type": "int53",
"description": "The amount to pay, in the smallest units of the currency"
},
{
"name": "user_count",
"type": "int32",
"description": "Number of users which will be able to activate the gift codes"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active"
},
{
"name": "store_product_id",
"type": "string",
"description": "Identifier of the store product associated with the option; may be empty if none"
},
{
"name": "store_product_quantity",
"type": "int32",
"description": "Number of times the store product must be paid"
}
]
},
{
"name": "premiumGiftCodePaymentOptions",
"description": "Contains a list of options for creating Telegram Premium gift codes",
"class": "PremiumGiftCodePaymentOptions",
"properties": [
{
"name": "options",
"type": "vector\u003cpremiumGiftCodePaymentOption\u003e",
"description": "The list of options"
}
]
},
{
"name": "premiumGiftCodeInfo",
"description": "Contains information about a Telegram Premium gift code",
"class": "PremiumGiftCodeInfo",
"properties": [
{
"name": "creator_id",
"type": "MessageSender",
"description": "Identifier of a chat or a user that created the gift code; may be null if unknown. If null and the code is from messagePremiumGiftCode message, then creator_id from the message can be used"
},
{
"name": "creation_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the code was created"
},
{
"name": "is_from_giveaway",
"type": "Bool",
"description": "True, if the gift code was created for a giveaway"
},
{
"name": "giveaway_message_id",
"type": "int53",
"description": "Identifier of the corresponding giveaway message in the creator_id chat; can be 0 or an identifier of a deleted message"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of a user for which the code was created; 0 if none"
},
{
"name": "use_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the code was activated; 0 if none"
}
]
},
{
"name": "premiumGiveawayParticipantStatusEligible",
"description": "The user is eligible for the giveaway",
"class": "PremiumGiveawayParticipantStatus",
"properties": []
},
{
"name": "premiumGiveawayParticipantStatusParticipating",
"description": "The user participates in the giveaway",
"class": "PremiumGiveawayParticipantStatus",
"properties": []
},
{
"name": "premiumGiveawayParticipantStatusAlreadyWasMember",
"description": "The user can't participate in the giveaway, because they have already been member of the chat",
"class": "PremiumGiveawayParticipantStatus",
"properties": [
{
"name": "joined_chat_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user joined the chat"
}
]
},
{
"name": "premiumGiveawayParticipantStatusAdministrator",
"description": "The user can't participate in the giveaway, because they are an administrator in one of the chats that created the giveaway",
"class": "PremiumGiveawayParticipantStatus",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat administered by the user"
}
]
},
{
"name": "premiumGiveawayParticipantStatusDisallowedCountry",
"description": "The user can't participate in the giveaway, because they phone number is from a disallowed country",
"class": "PremiumGiveawayParticipantStatus",
"properties": [
{
"name": "user_country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code of the user's country"
}
]
},
{
"name": "premiumGiveawayInfoOngoing",
"description": "Describes an ongoing giveaway",
"class": "PremiumGiveawayInfo",
"properties": [
{
"name": "creation_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the giveaway was created"
},
{
"name": "status",
"type": "PremiumGiveawayParticipantStatus",
"description": "Status of the current user in the giveaway"
},
{
"name": "is_ended",
"type": "Bool",
"description": "True, if the giveaway has ended and results are being prepared"
}
]
},
{
"name": "premiumGiveawayInfoCompleted",
"description": "Describes a completed giveaway",
"class": "PremiumGiveawayInfo",
"properties": [
{
"name": "creation_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the giveaway was created"
},
{
"name": "actual_winners_selection_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the winners were selected. May be bigger than winners selection date specified in parameters of the giveaway"
},
{
"name": "was_refunded",
"type": "Bool",
"description": "True, if the giveaway was canceled and was fully refunded"
},
{
"name": "winner_count",
"type": "int32",
"description": "Number of winners in the giveaway"
},
{
"name": "activation_count",
"type": "int32",
"description": "Number of winners, which activated their gift codes"
},
{
"name": "gift_code",
"type": "string",
"description": "Telegram Premium gift code that was received by the current user; empty if the user isn't a winner in the giveaway"
}
]
},
{
"name": "accentColor",
"description": "Contains information about supported accent color for user/chat name, background of empty chat photo, replies to messages and link previews",
"class": "AccentColor",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Accent color identifier"
},
{
"name": "built_in_accent_color_id",
"type": "int32",
"description": "Identifier of a built-in color to use in places, where only one color is needed; 0-6"
},
{
"name": "light_theme_colors",
"type": "vector\u003cint32\u003e",
"description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in light themes"
},
{
"name": "dark_theme_colors",
"type": "vector\u003cint32\u003e",
"description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in dark themes"
},
{
"name": "min_channel_chat_boost_level",
"type": "int32",
"description": "The minimum chat boost level required to use the color in a channel chat"
}
]
},
{
"name": "profileAccentColors",
"description": "Contains information about supported accent colors for user profile photo background in RGB format",
"class": "ProfileAccentColors",
"properties": [
{
"name": "palette_colors",
"type": "vector\u003cint32\u003e",
"description": "The list of 1-2 colors in RGB format, describing the colors, as expected to be shown in the color palette settings"
},
{
"name": "background_colors",
"type": "vector\u003cint32\u003e",
"description": "The list of 1-2 colors in RGB format, describing the colors, as expected to be used for the profile photo background"
},
{
"name": "story_colors",
"type": "vector\u003cint32\u003e",
"description": "The list of 2 colors in RGB format, describing the colors of the gradient to be used for the unread active story indicator around profile photo"
}
]
},
{
"name": "profileAccentColor",
"description": "Contains information about supported accent color for user profile photo background",
"class": "ProfileAccentColor",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Profile accent color identifier"
},
{
"name": "light_theme_colors",
"type": "profileAccentColors",
"description": "Accent colors expected to be used in light themes"
},
{
"name": "dark_theme_colors",
"type": "profileAccentColors",
"description": "Accent colors expected to be used in dark themes"
},
{
"name": "min_supergroup_chat_boost_level",
"type": "int32",
"description": "The minimum chat boost level required to use the color in a supergroup chat"
},
{
"name": "min_channel_chat_boost_level",
"type": "int32",
"description": "The minimum chat boost level required to use the color in a channel chat"
}
]
},
{
"name": "emojiStatus",
"description": "Describes a custom emoji to be shown instead of the Telegram Premium badge",
"class": "EmojiStatus",
"properties": [
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Identifier of the custom emoji in stickerFormatTgs format"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the status will expire; 0 if never"
}
]
},
{
"name": "emojiStatuses",
"description": "Contains a list of custom emoji identifiers for emoji statuses",
"class": "EmojiStatuses",
"properties": [
{
"name": "custom_emoji_ids",
"type": "vector\u003cint64\u003e",
"description": "The list of custom emoji identifiers"
}
]
},
{
"name": "usernames",
"description": "Describes usernames assigned to a user, a supergroup, or a channel",
"class": "Usernames",
"properties": [
{
"name": "active_usernames",
"type": "vector\u003cstring\u003e",
"description": "List of active usernames; the first one must be shown as the primary username. The order of active usernames can be changed with reorderActiveUsernames, reorderBotActiveUsernames or reorderSupergroupActiveUsernames"
},
{
"name": "disabled_usernames",
"type": "vector\u003cstring\u003e",
"description": "List of currently disabled usernames; the username can be activated with toggleUsernameIsActive, toggleBotUsernameIsActive, or toggleSupergroupUsernameIsActive"
},
{
"name": "editable_username",
"type": "string",
"description": "The active username, which can be changed with setUsername or setSupergroupUsername. Information about other active usernames can be received using getCollectibleItemInfo"
}
]
},
{
"name": "user",
"description": "Represents a user",
"class": "User",
"properties": [
{
"name": "id",
"type": "int53",
"description": "User identifier"
},
{
"name": "first_name",
"type": "string",
"description": "First name of the user"
},
{
"name": "last_name",
"type": "string",
"description": "Last name of the user"
},
{
"name": "usernames",
"type": "usernames",
"description": "Usernames of the user; may be null"
},
{
"name": "phone_number",
"type": "string",
"description": "Phone number of the user"
},
{
"name": "status",
"type": "UserStatus",
"description": "Current online status of the user"
},
{
"name": "profile_photo",
"type": "profilePhoto",
"description": "Profile photo of the user; may be null"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview. For Telegram Premium users only"
},
{
"name": "background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none. For Telegram Premium users only"
},
{
"name": "profile_accent_color_id",
"type": "int32",
"description": "Identifier of the accent color for the user's profile; -1 if none. For Telegram Premium users only"
},
{
"name": "profile_background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the background of the user's profile; 0 if none. For Telegram Premium users only"
},
{
"name": "emoji_status",
"type": "emojiStatus",
"description": "Emoji status to be shown instead of the default Telegram Premium badge; may be null. For Telegram Premium users only"
},
{
"name": "is_contact",
"type": "Bool",
"description": "The user is a contact of the current user"
},
{
"name": "is_mutual_contact",
"type": "Bool",
"description": "The user is a contact of the current user and the current user is a contact of the user"
},
{
"name": "is_close_friend",
"type": "Bool",
"description": "The user is a close friend of the current user; implies that the user is a contact"
},
{
"name": "is_verified",
"type": "Bool",
"description": "True, if the user is verified"
},
{
"name": "is_premium",
"type": "Bool",
"description": "True, if the user is a Telegram Premium user"
},
{
"name": "is_support",
"type": "Bool",
"description": "True, if the user is Telegram support account"
},
{
"name": "restriction_reason",
"type": "string",
"description": "If non-empty, it contains a human-readable description of the reason why access to this user must be restricted"
},
{
"name": "is_scam",
"type": "Bool",
"description": "True, if many users reported this user as a scam"
},
{
"name": "is_fake",
"type": "Bool",
"description": "True, if many users reported this user as a fake account"
},
{
"name": "has_active_stories",
"type": "Bool",
"description": "True, if the user has non-expired stories available to the current user"
},
{
"name": "has_unread_active_stories",
"type": "Bool",
"description": "True, if the user has unread non-expired stories available to the current user"
},
{
"name": "restricts_new_chats",
"type": "Bool",
"description": "True, if the user may restrict new chats with non-contacts. Use canSendMessageToUser to check whether the current user can message the user or try to create a chat with them"
},
{
"name": "have_access",
"type": "Bool",
"description": "If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can't be passed to any method"
},
{
"name": "type",
"type": "UserType",
"description": "Type of the user"
},
{
"name": "language_code",
"type": "string",
"description": "IETF language tag of the user's language; only available to bots"
},
{
"name": "added_to_attachment_menu",
"type": "Bool",
"description": "True, if the user added the current bot to attachment menu; only available to bots"
}
]
},
{
"name": "botInfo",
"description": "Contains information about a bot",
"class": "BotInfo",
"properties": [
{
"name": "short_description",
"type": "string",
"description": "The text that is shown on the bot's profile page and is sent together with the link when users share the bot"
},
{
"name": "description",
"type": "string",
"description": "The text shown in the chat with the bot if the chat is empty"
},
{
"name": "photo",
"type": "photo",
"description": "Photo shown in the chat with the bot if the chat is empty; may be null"
},
{
"name": "animation",
"type": "animation",
"description": "Animation shown in the chat with the bot if the chat is empty; may be null"
},
{
"name": "menu_button",
"type": "botMenuButton",
"description": "Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown"
},
{
"name": "commands",
"type": "vector\u003cbotCommand\u003e",
"description": "List of the bot commands"
},
{
"name": "default_group_administrator_rights",
"type": "chatAdministratorRights",
"description": "Default administrator rights for adding the bot to basic group and supergroup chats; may be null"
},
{
"name": "default_channel_administrator_rights",
"type": "chatAdministratorRights",
"description": "Default administrator rights for adding the bot to channels; may be null"
},
{
"name": "edit_commands_link",
"type": "InternalLinkType",
"description": "The internal link, which can be used to edit bot commands; may be null"
},
{
"name": "edit_description_link",
"type": "InternalLinkType",
"description": "The internal link, which can be used to edit bot description; may be null"
},
{
"name": "edit_description_media_link",
"type": "InternalLinkType",
"description": "The internal link, which can be used to edit the photo or animation shown in the chat with the bot if the chat is empty; may be null"
},
{
"name": "edit_settings_link",
"type": "InternalLinkType",
"description": "The internal link, which can be used to edit bot settings; may be null"
}
]
},
{
"name": "userFullInfo",
"description": "Contains full information about a user",
"class": "UserFullInfo",
"properties": [
{
"name": "personal_photo",
"type": "chatPhoto",
"description": "User profile photo set by the current user for the contact; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown. If non-null, then it is the same photo as in user.profile_photo and chat.photo. This photo isn't returned in the list of user photos"
},
{
"name": "photo",
"type": "chatPhoto",
"description": "User profile photo; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown. If non-null and personal_photo is null, then it is the same photo as in user.profile_photo and chat.photo"
},
{
"name": "public_photo",
"type": "chatPhoto",
"description": "User profile photo visible if the main photo is hidden by privacy settings; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown. If non-null and both photo and personal_photo are null, then it is the same photo as in user.profile_photo and chat.photo. This photo isn't returned in the list of user photos"
},
{
"name": "block_list",
"type": "BlockList",
"description": "Block list to which the user is added; may be null if none"
},
{
"name": "can_be_called",
"type": "Bool",
"description": "True, if the user can be called"
},
{
"name": "supports_video_calls",
"type": "Bool",
"description": "True, if a video call can be created with the user"
},
{
"name": "has_private_calls",
"type": "Bool",
"description": "True, if the user can't be called due to their privacy settings"
},
{
"name": "has_private_forwards",
"type": "Bool",
"description": "True, if the user can't be linked in forwarded messages due to their privacy settings"
},
{
"name": "has_restricted_voice_and_video_note_messages",
"type": "Bool",
"description": "True, if voice and video notes can't be sent or forwarded to the user"
},
{
"name": "has_pinned_stories",
"type": "Bool",
"description": "True, if the user has pinned stories"
},
{
"name": "need_phone_number_privacy_exception",
"type": "Bool",
"description": "True, if the current user needs to explicitly allow to share their phone number with the user when the method addContact is used"
},
{
"name": "set_chat_background",
"type": "Bool",
"description": "True, if the user set chat background for both chat users and it wasn't reverted yet"
},
{
"name": "bio",
"type": "formattedText",
"description": "A short user bio; may be null for bots"
},
{
"name": "birthdate",
"type": "birthdate",
"description": "Birthdate of the user; may be null if unknown"
},
{
"name": "personal_chat_id",
"type": "int53",
"description": "Identifier of the personal chat of the user; 0 if none"
},
{
"name": "premium_gift_options",
"type": "vector\u003cpremiumPaymentOption\u003e",
"description": "The list of available options for gifting Telegram Premium to the user"
},
{
"name": "group_in_common_count",
"type": "int32",
"description": "Number of group chats where both the other user and the current user are a member; 0 for the current user"
},
{
"name": "business_info",
"type": "businessInfo",
"description": "Information about business settings for Telegram Business accounts; may be null if none"
},
{
"name": "bot_info",
"type": "botInfo",
"description": "For bots, information about the bot; may be null if the user isn't a bot"
}
]
},
{
"name": "users",
"description": "Represents a list of users",
"class": "Users",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of users found"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "A list of user identifiers"
}
]
},
{
"name": "chatAdministrator",
"description": "Contains information about a chat administrator",
"class": "ChatAdministrator",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier of the administrator"
},
{
"name": "custom_title",
"type": "string",
"description": "Custom title of the administrator"
},
{
"name": "is_owner",
"type": "Bool",
"description": "True, if the user is the owner of the chat"
}
]
},
{
"name": "chatAdministrators",
"description": "Represents a list of chat administrators",
"class": "ChatAdministrators",
"properties": [
{
"name": "administrators",
"type": "vector\u003cchatAdministrator\u003e",
"description": "A list of chat administrators"
}
]
},
{
"name": "chatMemberStatusCreator",
"description": "The user is the owner of the chat and has all the administrator privileges",
"class": "ChatMemberStatus",
"properties": [
{
"name": "custom_title",
"type": "string",
"description": "A custom title of the owner; 0-16 characters without emojis; applicable to supergroups only"
},
{
"name": "is_anonymous",
"type": "Bool",
"description": "True, if the creator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only"
},
{
"name": "is_member",
"type": "Bool",
"description": "True, if the user is a member of the chat"
}
]
},
{
"name": "chatMemberStatusAdministrator",
"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",
"class": "ChatMemberStatus",
"properties": [
{
"name": "custom_title",
"type": "string",
"description": "A custom title of the administrator; 0-16 characters without emojis; applicable to supergroups only"
},
{
"name": "can_be_edited",
"type": "Bool",
"description": "True, if the current user can edit the administrator privileges for the called user"
},
{
"name": "rights",
"type": "chatAdministratorRights",
"description": "Rights of the administrator"
}
]
},
{
"name": "chatMemberStatusMember",
"description": "The user is a member of the chat, without any additional privileges or restrictions",
"class": "ChatMemberStatus",
"properties": []
},
{
"name": "chatMemberStatusRestricted",
"description": "The user is under certain restrictions in the chat. Not supported in basic groups and channels",
"class": "ChatMemberStatus",
"properties": [
{
"name": "is_member",
"type": "Bool",
"description": "True, if the user is a member of the chat"
},
{
"name": "restricted_until_date",
"type": "int32",
"description": "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"
},
{
"name": "permissions",
"type": "chatPermissions",
"description": "User permissions in the chat"
}
]
},
{
"name": "chatMemberStatusLeft",
"description": "The user or the chat is not a chat member",
"class": "ChatMemberStatus",
"properties": []
},
{
"name": "chatMemberStatusBanned",
"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",
"class": "ChatMemberStatus",
"properties": [
{
"name": "banned_until_date",
"type": "int32",
"description": "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"
}
]
},
{
"name": "chatMember",
"description": "Describes a user or a chat as a member of another chat",
"class": "ChatMember",
"properties": [
{
"name": "member_id",
"type": "MessageSender",
"description": "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"
},
{
"name": "inviter_user_id",
"type": "int53",
"description": "Identifier of a user that invited/promoted/banned this member in the chat; 0 if unknown"
},
{
"name": "joined_chat_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user joined/was promoted/was banned in the chat"
},
{
"name": "status",
"type": "ChatMemberStatus",
"description": "Status of the member in the chat"
}
]
},
{
"name": "chatMembers",
"description": "Contains a list of chat members",
"class": "ChatMembers",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of chat members found"
},
{
"name": "members",
"type": "vector\u003cchatMember\u003e",
"description": "A list of chat members"
}
]
},
{
"name": "chatMembersFilterContacts",
"description": "Returns contacts of the user",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "chatMembersFilterAdministrators",
"description": "Returns the owner and administrators",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "chatMembersFilterMembers",
"description": "Returns all chat members, including restricted chat members",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "chatMembersFilterMention",
"description": "Returns users which can be mentioned in the chat",
"class": "ChatMembersFilter",
"properties": [
{
"name": "message_thread_id",
"type": "int53",
"description": "If non-zero, the identifier of the current message thread"
}
]
},
{
"name": "chatMembersFilterRestricted",
"description": "Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "chatMembersFilterBanned",
"description": "Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "chatMembersFilterBots",
"description": "Returns bot members of the chat",
"class": "ChatMembersFilter",
"properties": []
},
{
"name": "supergroupMembersFilterRecent",
"description": "Returns recently active users in reverse chronological order",
"class": "SupergroupMembersFilter",
"properties": []
},
{
"name": "supergroupMembersFilterContacts",
"description": "Returns contacts of the user, which are members of the supergroup or channel",
"class": "SupergroupMembersFilter",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
]
},
{
"name": "supergroupMembersFilterAdministrators",
"description": "Returns the owner and administrators",
"class": "SupergroupMembersFilter",
"properties": []
},
{
"name": "supergroupMembersFilterSearch",
"description": "Used to search for supergroup or channel members via a (string) query",
"class": "SupergroupMembersFilter",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
]
},
{
"name": "supergroupMembersFilterRestricted",
"description": "Returns restricted supergroup members; can be used only by administrators",
"class": "SupergroupMembersFilter",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
]
},
{
"name": "supergroupMembersFilterBanned",
"description": "Returns users banned from the supergroup or channel; can be used only by administrators",
"class": "SupergroupMembersFilter",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
]
},
{
"name": "supergroupMembersFilterMention",
"description": "Returns users which can be mentioned in the supergroup",
"class": "SupergroupMembersFilter",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If non-zero, the identifier of the current message thread"
}
]
},
{
"name": "supergroupMembersFilterBots",
"description": "Returns bot members of the supergroup or channel",
"class": "SupergroupMembersFilter",
"properties": []
},
{
"name": "chatInviteLink",
"description": "Contains a chat invite link",
"class": "ChatInviteLink",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Chat invite link"
},
{
"name": "name",
"type": "string",
"description": "Name of the link"
},
{
"name": "creator_user_id",
"type": "int53",
"description": "User identifier of an administrator created the link"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the link was created"
},
{
"name": "edit_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the link will expire; 0 if never"
},
{
"name": "member_limit",
"type": "int32",
"description": "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"
},
{
"name": "member_count",
"type": "int32",
"description": "Number of chat members, which joined the chat using the link"
},
{
"name": "pending_join_request_count",
"type": "int32",
"description": "Number of pending join requests created using this link"
},
{
"name": "creates_join_request",
"type": "Bool",
"description": "True, if the link only creates join request. If true, total number of joining members will be unlimited"
},
{
"name": "is_primary",
"type": "Bool",
"description": "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"
},
{
"name": "is_revoked",
"type": "Bool",
"description": "True, if the link was revoked"
}
]
},
{
"name": "chatInviteLinks",
"description": "Contains a list of chat invite links",
"class": "ChatInviteLinks",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of chat invite links found"
},
{
"name": "invite_links",
"type": "vector\u003cchatInviteLink\u003e",
"description": "List of invite links"
}
]
},
{
"name": "chatInviteLinkCount",
"description": "Describes a chat administrator with a number of active and revoked chat invite links",
"class": "ChatInviteLinkCount",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Administrator's user identifier"
},
{
"name": "invite_link_count",
"type": "int32",
"description": "Number of active invite links"
},
{
"name": "revoked_invite_link_count",
"type": "int32",
"description": "Number of revoked invite links"
}
]
},
{
"name": "chatInviteLinkCounts",
"description": "Contains a list of chat invite link counts",
"class": "ChatInviteLinkCounts",
"properties": [
{
"name": "invite_link_counts",
"type": "vector\u003cchatInviteLinkCount\u003e",
"description": "List of invite link counts"
}
]
},
{
"name": "chatInviteLinkMember",
"description": "Describes a chat member joined a chat via an invite link",
"class": "ChatInviteLinkMember",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "joined_chat_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user joined the chat"
},
{
"name": "via_chat_folder_invite_link",
"type": "Bool",
"description": "True, if the user has joined the chat using an invite link for a chat folder"
},
{
"name": "approver_user_id",
"type": "int53",
"description": "User identifier of the chat administrator, approved user join request"
}
]
},
{
"name": "chatInviteLinkMembers",
"description": "Contains a list of chat members joined a chat via an invite link",
"class": "ChatInviteLinkMembers",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of chat members found"
},
{
"name": "members",
"type": "vector\u003cchatInviteLinkMember\u003e",
"description": "List of chat members, joined a chat via an invite link"
}
]
},
{
"name": "inviteLinkChatTypeBasicGroup",
"description": "The link is an invite link for a basic group",
"class": "InviteLinkChatType",
"properties": []
},
{
"name": "inviteLinkChatTypeSupergroup",
"description": "The link is an invite link for a supergroup",
"class": "InviteLinkChatType",
"properties": []
},
{
"name": "inviteLinkChatTypeChannel",
"description": "The link is an invite link for a channel",
"class": "InviteLinkChatType",
"properties": []
},
{
"name": "chatInviteLinkInfo",
"description": "Contains information about a chat invite link",
"class": "ChatInviteLinkInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the invite link; 0 if the user has no access to the chat before joining"
},
{
"name": "accessible_for",
"type": "int32",
"description": "If non-zero, the amount of time for which read access to the chat will remain available, in seconds"
},
{
"name": "type",
"type": "InviteLinkChatType",
"description": "Type of the chat"
},
{
"name": "title",
"type": "string",
"description": "Title of the chat"
},
{
"name": "photo",
"type": "chatPhotoInfo",
"description": "Chat photo; may be null"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color for chat title and background of chat photo"
},
{
"name": "description",
"type": "string",
"description": "Chat description"
},
{
"name": "member_count",
"type": "int32",
"description": "Number of members in the chat"
},
{
"name": "member_user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of some chat members that may be known to the current user"
},
{
"name": "creates_join_request",
"type": "Bool",
"description": "True, if the link only creates join request"
},
{
"name": "is_public",
"type": "Bool",
"description": "True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup"
},
{
"name": "is_verified",
"type": "Bool",
"description": "True, if the chat is verified"
},
{
"name": "is_scam",
"type": "Bool",
"description": "True, if many users reported this chat as a scam"
},
{
"name": "is_fake",
"type": "Bool",
"description": "True, if many users reported this chat as a fake account"
}
]
},
{
"name": "chatJoinRequest",
"description": "Describes a user that sent a join request and waits for administrator approval",
"class": "ChatJoinRequest",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user sent the join request"
},
{
"name": "bio",
"type": "string",
"description": "A short bio of the user"
}
]
},
{
"name": "chatJoinRequests",
"description": "Contains a list of requests to join a chat",
"class": "ChatJoinRequests",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of requests found"
},
{
"name": "requests",
"type": "vector\u003cchatJoinRequest\u003e",
"description": "List of the requests"
}
]
},
{
"name": "chatJoinRequestsInfo",
"description": "Contains information about pending join requests for a chat",
"class": "ChatJoinRequestsInfo",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of pending join requests"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of at most 3 users sent the newest pending join requests"
}
]
},
{
"name": "basicGroup",
"description": "Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)",
"class": "BasicGroup",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Group identifier"
},
{
"name": "member_count",
"type": "int32",
"description": "Number of members in the group"
},
{
"name": "status",
"type": "ChatMemberStatus",
"description": "Status of the current user in the group"
},
{
"name": "is_active",
"type": "Bool",
"description": "True, if the group is active"
},
{
"name": "upgraded_to_supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup to which this group was upgraded; 0 if none"
}
]
},
{
"name": "basicGroupFullInfo",
"description": "Contains full information about a basic group",
"class": "BasicGroupFullInfo",
"properties": [
{
"name": "photo",
"type": "chatPhoto",
"description": "Chat photo; may be null if empty or unknown. If non-null, then it is the same photo as in chat.photo"
},
{
"name": "description",
"type": "string",
"description": "Group description. Updated only after the basic group is opened"
},
{
"name": "creator_user_id",
"type": "int53",
"description": "User identifier of the creator of the group; 0 if unknown"
},
{
"name": "members",
"type": "vector\u003cchatMember\u003e",
"description": "Group members"
},
{
"name": "can_hide_members",
"type": "Bool",
"description": "True, if non-administrators and non-bots can be hidden in responses to getSupergroupMembers and searchChatMembers for non-administrators after upgrading the basic group to a supergroup"
},
{
"name": "can_toggle_aggressive_anti_spam",
"type": "Bool",
"description": "True, if aggressive anti-spam checks can be enabled or disabled in the supergroup after upgrading the basic group to a supergroup"
},
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "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"
},
{
"name": "bot_commands",
"type": "vector\u003cbotCommands\u003e",
"description": "List of commands of bots in the group"
}
]
},
{
"name": "supergroup",
"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",
"class": "Supergroup",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Supergroup or channel identifier"
},
{
"name": "usernames",
"type": "usernames",
"description": "Usernames of the supergroup or channel; may be null"
},
{
"name": "date",
"type": "int32",
"description": "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"
},
{
"name": "status",
"type": "ChatMemberStatus",
"description": "Status of the current user in the supergroup or channel; custom title will always be empty"
},
{
"name": "member_count",
"type": "int32",
"description": "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 getChatSimilarChats, getChatsToSendStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchChatsNearby, searchPublicChats, or in chatFolderInviteLinkInfo.missing_chat_ids, or for public chats in which where sent messages and posted stories from publicForwards, or for public chats in which where sent messages from getMessagePublicForwards response"
},
{
"name": "boost_level",
"type": "int32",
"description": "Approximate boost level for the chat"
},
{
"name": "has_linked_chat",
"type": "Bool",
"description": "True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel"
},
{
"name": "has_location",
"type": "Bool",
"description": "True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup"
},
{
"name": "sign_messages",
"type": "Bool",
"description": "True, if messages sent to the channel need to contain information about the sender. This field is only applicable to channels"
},
{
"name": "join_to_send_messages",
"type": "Bool",
"description": "True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups"
},
{
"name": "join_by_request",
"type": "Bool",
"description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat"
},
{
"name": "is_slow_mode_enabled",
"type": "Bool",
"description": "True, if the slow mode is enabled in the supergroup"
},
{
"name": "is_channel",
"type": "Bool",
"description": "True, if the supergroup is a channel"
},
{
"name": "is_broadcast_group",
"type": "Bool",
"description": "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"
},
{
"name": "is_forum",
"type": "Bool",
"description": "True, if the supergroup is a forum with topics"
},
{
"name": "is_verified",
"type": "Bool",
"description": "True, if the supergroup or channel is verified"
},
{
"name": "restriction_reason",
"type": "string",
"description": "If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted"
},
{
"name": "is_scam",
"type": "Bool",
"description": "True, if many users reported this supergroup or channel as a scam"
},
{
"name": "is_fake",
"type": "Bool",
"description": "True, if many users reported this supergroup or channel as a fake account"
},
{
"name": "has_active_stories",
"type": "Bool",
"description": "True, if the supergroup or channel has non-expired stories available to the current user"
},
{
"name": "has_unread_active_stories",
"type": "Bool",
"description": "True, if the supergroup or channel has unread non-expired stories available to the current user"
}
]
},
{
"name": "supergroupFullInfo",
"description": "Contains full information about a supergroup or channel",
"class": "SupergroupFullInfo",
"properties": [
{
"name": "photo",
"type": "chatPhoto",
"description": "Chat photo; may be null if empty or unknown. If non-null, then it is the same photo as in chat.photo"
},
{
"name": "description",
"type": "string",
"description": "Supergroup or channel description"
},
{
"name": "member_count",
"type": "int32",
"description": "Number of members in the supergroup or channel; 0 if unknown"
},
{
"name": "administrator_count",
"type": "int32",
"description": "Number of privileged users in the supergroup or channel; 0 if unknown"
},
{
"name": "restricted_count",
"type": "int32",
"description": "Number of restricted users in the supergroup; 0 if unknown"
},
{
"name": "banned_count",
"type": "int32",
"description": "Number of users banned from chat; 0 if unknown"
},
{
"name": "linked_chat_id",
"type": "int53",
"description": "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"
},
{
"name": "slow_mode_delay",
"type": "int32",
"description": "Delay between consecutive sent messages for non-administrator supergroup members, in seconds"
},
{
"name": "slow_mode_delay_expires_in",
"type": "double",
"description": "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"
},
{
"name": "can_get_members",
"type": "Bool",
"description": "True, if members of the chat can be retrieved via getSupergroupMembers or searchChatMembers"
},
{
"name": "has_hidden_members",
"type": "Bool",
"description": "True, if non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatMembers"
},
{
"name": "can_hide_members",
"type": "Bool",
"description": "True, if non-administrators and non-bots can be hidden in responses to getSupergroupMembers and searchChatMembers for non-administrators"
},
{
"name": "can_set_sticker_set",
"type": "Bool",
"description": "True, if the supergroup sticker set can be changed"
},
{
"name": "can_set_location",
"type": "Bool",
"description": "True, if the supergroup location can be changed"
},
{
"name": "can_get_statistics",
"type": "Bool",
"description": "True, if the supergroup or channel statistics are available"
},
{
"name": "can_toggle_aggressive_anti_spam",
"type": "Bool",
"description": "True, if aggressive anti-spam checks can be enabled or disabled in the supergroup"
},
{
"name": "is_all_history_available",
"type": "Bool",
"description": "True, if new chat members will have access to old messages. In public, discussion, of forum groups and all channels, old messages are always available, so this option affects only private non-forum supergroups without a linked chat. The value of this field is only available to chat administrators"
},
{
"name": "has_aggressive_anti_spam_enabled",
"type": "Bool",
"description": "True, if aggressive anti-spam checks are enabled in the supergroup. The value of this field is only available to chat administrators"
},
{
"name": "has_pinned_stories",
"type": "Bool",
"description": "True, if the supergroup or channel has pinned stories"
},
{
"name": "my_boost_count",
"type": "int32",
"description": "Number of times the current user boosted the supergroup or channel"
},
{
"name": "unrestrict_boost_count",
"type": "int32",
"description": "Number of times the supergroup must be boosted by a user to ignore slow mode and chat permission restrictions; 0 if unspecified"
},
{
"name": "sticker_set_id",
"type": "int64",
"description": "Identifier of the supergroup sticker set that must be shown before user sticker sets; 0 if none"
},
{
"name": "custom_emoji_sticker_set_id",
"type": "int64",
"description": "Identifier of the custom emoji sticker set that can be used in the supergroup without Telegram Premium subscription; 0 if none"
},
{
"name": "location",
"type": "chatLocation",
"description": "Location to which the supergroup is connected; may be null if none"
},
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "Primary invite link for the chat; may be null. For chat administrators with can_invite_users right only"
},
{
"name": "bot_commands",
"type": "vector\u003cbotCommands\u003e",
"description": "List of commands of bots in the group"
},
{
"name": "upgraded_from_basic_group_id",
"type": "int53",
"description": "Identifier of the basic group from which supergroup was upgraded; 0 if none"
},
{
"name": "upgraded_from_max_message_id",
"type": "int53",
"description": "Identifier of the last message in the basic group from which supergroup was upgraded; 0 if none"
}
]
},
{
"name": "secretChatStatePending",
"description": "The secret chat is not yet created; waiting for the other user to get online",
"class": "SecretChatState",
"properties": []
},
{
"name": "secretChatStateReady",
"description": "The secret chat is ready to use",
"class": "SecretChatState",
"properties": []
},
{
"name": "secretChatStateClosed",
"description": "The secret chat is closed",
"class": "SecretChatState",
"properties": []
},
{
"name": "secretChat",
"description": "Represents a secret chat",
"class": "SecretChat",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Secret chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the chat partner"
},
{
"name": "state",
"type": "SecretChatState",
"description": "State of the secret chat"
},
{
"name": "is_outbound",
"type": "Bool",
"description": "True, if the chat was created by the current user; false otherwise"
},
{
"name": "key_hash",
"type": "bytes",
"description": "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"
},
{
"name": "layer",
"type": "int32",
"description": "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 \u003e= 101, files bigger than 2000MB are supported if the layer \u003e= 143, spoiler and custom emoji text entities are supported if the layer \u003e= 144"
}
]
},
{
"name": "messageSenderUser",
"description": "The message was sent by a known user",
"class": "MessageSender",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user that sent the message"
}
]
},
{
"name": "messageSenderChat",
"description": "The message was sent on behalf of a chat",
"class": "MessageSender",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat that sent the message"
}
]
},
{
"name": "messageSenders",
"description": "Represents a list of message senders",
"class": "MessageSenders",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of messages senders found"
},
{
"name": "senders",
"type": "vector\u003cMessageSender\u003e",
"description": "List of message senders"
}
]
},
{
"name": "chatMessageSender",
"description": "Represents a message sender, which can be used to send messages in a chat",
"class": "ChatMessageSender",
"properties": [
{
"name": "sender",
"type": "MessageSender",
"description": "The message sender"
},
{
"name": "needs_premium",
"type": "Bool",
"description": "True, if Telegram Premium is needed to use the message sender"
}
]
},
{
"name": "chatMessageSenders",
"description": "Represents a list of message senders, which can be used to send messages in a chat",
"class": "ChatMessageSenders",
"properties": [
{
"name": "senders",
"type": "vector\u003cchatMessageSender\u003e",
"description": "List of available message senders"
}
]
},
{
"name": "messageReadDateRead",
"description": "Contains read date of the message",
"class": "MessageReadDate",
"properties": [
{
"name": "read_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was read by the other user"
}
]
},
{
"name": "messageReadDateUnread",
"description": "The message is unread yet",
"class": "MessageReadDate",
"properties": []
},
{
"name": "messageReadDateTooOld",
"description": "The message is too old to get read date",
"class": "MessageReadDate",
"properties": []
},
{
"name": "messageReadDateUserPrivacyRestricted",
"description": "The read date is unknown due to privacy settings of the other user",
"class": "MessageReadDate",
"properties": []
},
{
"name": "messageReadDateMyPrivacyRestricted",
"description": "The read date is unknown due to privacy settings of the current user, but will be known if the user subscribes to Telegram Premium",
"class": "MessageReadDate",
"properties": []
},
{
"name": "messageViewer",
"description": "Represents a viewer of a message",
"class": "MessageViewer",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier of the viewer"
},
{
"name": "view_date",
"type": "int32",
"description": "Approximate point in time (Unix timestamp) when the message was viewed"
}
]
},
{
"name": "messageViewers",
"description": "Represents a list of message viewers",
"class": "MessageViewers",
"properties": [
{
"name": "viewers",
"type": "vector\u003cmessageViewer\u003e",
"description": "List of message viewers"
}
]
},
{
"name": "messageOriginUser",
"description": "The message was originally sent by a known user",
"class": "MessageOrigin",
"properties": [
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user that originally sent the message"
}
]
},
{
"name": "messageOriginHiddenUser",
"description": "The message was originally sent by a user, which is hidden by their privacy settings",
"class": "MessageOrigin",
"properties": [
{
"name": "sender_name",
"type": "string",
"description": "Name of the sender"
}
]
},
{
"name": "messageOriginChat",
"description": "The message was originally sent on behalf of a chat",
"class": "MessageOrigin",
"properties": [
{
"name": "sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that originally sent the message"
},
{
"name": "author_signature",
"type": "string",
"description": "For messages originally sent by an anonymous chat administrator, original message author signature"
}
]
},
{
"name": "messageOriginChannel",
"description": "The message was originally a post in a channel",
"class": "MessageOrigin",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the channel chat to which the message was originally sent"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier of the original message"
},
{
"name": "author_signature",
"type": "string",
"description": "Original post author signature"
}
]
},
{
"name": "forwardSource",
"description": "Contains information about the last message from which a new message was forwarded last time",
"class": "ForwardSource",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message that was forwarded belonged; may be 0 if unknown"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message; may be 0 if unknown"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of the message; may be null if unknown or the new message was forwarded not to Saved Messages"
},
{
"name": "sender_name",
"type": "string",
"description": "Name of the sender of the message if the sender is hidden by their privacy settings"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message is sent; 0 if unknown"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the message that was forwarded is outgoing; always false if sender is unknown"
}
]
},
{
"name": "reactionTypeEmoji",
"description": "A reaction with an emoji",
"class": "ReactionType",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "Text representation of the reaction"
}
]
},
{
"name": "reactionTypeCustomEmoji",
"description": "A reaction with a custom emoji",
"class": "ReactionType",
"properties": [
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Unique identifier of the custom emoji"
}
]
},
{
"name": "messageForwardInfo",
"description": "Contains information about a forwarded message",
"class": "MessageForwardInfo",
"properties": [
{
"name": "origin",
"type": "MessageOrigin",
"description": "Origin of the forwarded message"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was originally sent"
},
{
"name": "source",
"type": "forwardSource",
"description": "For messages forwarded to the chat with the current user (Saved Messages), to the Replies bot chat, or to the channel's discussion group, information about the source message from which the message was forwarded last time; may be null for other forwards or if unknown"
},
{
"name": "public_service_announcement_type",
"type": "string",
"description": "The type of a public service announcement for the forwarded message"
}
]
},
{
"name": "messageImportInfo",
"description": "Contains information about a message created with importMessages",
"class": "MessageImportInfo",
"properties": [
{
"name": "sender_name",
"type": "string",
"description": "Name of the original sender"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was originally sent"
}
]
},
{
"name": "messageReplyInfo",
"description": "Contains information about replies to a message",
"class": "MessageReplyInfo",
"properties": [
{
"name": "reply_count",
"type": "int32",
"description": "Number of times the message was directly or indirectly replied"
},
{
"name": "recent_replier_ids",
"type": "vector\u003cMessageSender\u003e",
"description": "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"
},
{
"name": "last_read_inbox_message_id",
"type": "int53",
"description": "Identifier of the last read incoming reply to the message"
},
{
"name": "last_read_outbox_message_id",
"type": "int53",
"description": "Identifier of the last read outgoing reply to the message"
},
{
"name": "last_message_id",
"type": "int53",
"description": "Identifier of the last reply to the message"
}
]
},
{
"name": "messageReaction",
"description": "Contains information about a reaction to a message",
"class": "MessageReaction",
"properties": [
{
"name": "type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "total_count",
"type": "int32",
"description": "Number of times the reaction was added"
},
{
"name": "is_chosen",
"type": "Bool",
"description": "True, if the reaction is chosen by the current user"
},
{
"name": "used_sender_id",
"type": "MessageSender",
"description": "Identifier of the message sender used by the current user to add the reaction; may be null if unknown or the reaction isn't chosen"
},
{
"name": "recent_sender_ids",
"type": "vector\u003cMessageSender\u003e",
"description": "Identifiers of at most 3 recent message senders, added the reaction; available in private, basic group and supergroup chats"
}
]
},
{
"name": "messageReactions",
"description": "Contains a list of reactions added to a message",
"class": "MessageReactions",
"properties": [
{
"name": "reactions",
"type": "vector\u003cmessageReaction\u003e",
"description": "List of added reactions"
},
{
"name": "are_tags",
"type": "Bool",
"description": "True, if the reactions are tags and Telegram Premium users can filter messages by them"
}
]
},
{
"name": "messageInteractionInfo",
"description": "Contains information about interactions with a message",
"class": "MessageInteractionInfo",
"properties": [
{
"name": "view_count",
"type": "int32",
"description": "Number of times the message was viewed"
},
{
"name": "forward_count",
"type": "int32",
"description": "Number of times the message was forwarded"
},
{
"name": "reply_info",
"type": "messageReplyInfo",
"description": "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"
},
{
"name": "reactions",
"type": "messageReactions",
"description": "The list of reactions or tags added to the message; may be null"
}
]
},
{
"name": "unreadReaction",
"description": "Contains information about an unread reaction to a message",
"class": "UnreadReaction",
"properties": [
{
"name": "type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender, added the reaction"
},
{
"name": "is_big",
"type": "Bool",
"description": "True, if the reaction was added with a big animation"
}
]
},
{
"name": "messageSendingStatePending",
"description": "The message is being sent now, but has not yet been delivered to the server",
"class": "MessageSendingState",
"properties": [
{
"name": "sending_id",
"type": "int32",
"description": "Non-persistent message sending identifier, specified by the application"
}
]
},
{
"name": "messageSendingStateFailed",
"description": "The message failed to be sent",
"class": "MessageSendingState",
"properties": [
{
"name": "error",
"type": "error",
"description": "The cause of the message sending failure"
},
{
"name": "can_retry",
"type": "Bool",
"description": "True, if the message can be re-sent"
},
{
"name": "need_another_sender",
"type": "Bool",
"description": "True, if the message can be re-sent only on behalf of a different sender"
},
{
"name": "need_another_reply_quote",
"type": "Bool",
"description": "True, if the message can be re-sent only if another quote is chosen in the message that is replied by the given message"
},
{
"name": "need_drop_reply",
"type": "Bool",
"description": "True, if the message can be re-sent only if the message to be replied is removed. This will be done automatically by resendMessages"
},
{
"name": "retry_after",
"type": "double",
"description": "Time left before the message can be re-sent, in seconds. No update is sent when this field changes"
}
]
},
{
"name": "textQuote",
"description": "Describes manually or automatically chosen quote from another message",
"class": "TextQuote",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text of the quote. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities can be present in the text"
},
{
"name": "position",
"type": "int32",
"description": "Approximate quote position in the original message in UTF-16 code units as specified by the message sender"
},
{
"name": "is_manual",
"type": "Bool",
"description": "True, if the quote was manually chosen by the message sender"
}
]
},
{
"name": "inputTextQuote",
"description": "Describes manually chosen quote from another message",
"class": "InputTextQuote",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text of the quote; 0-getOption(\"message_reply_quote_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed to be kept and must be kept in the quote"
},
{
"name": "position",
"type": "int32",
"description": "Quote position in the original message in UTF-16 code units"
}
]
},
{
"name": "messageReplyToMessage",
"description": "Describes a message replied by a given message",
"class": "MessageReplyTo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The identifier of the chat to which the message belongs; may be 0 if the replied message is in unknown chat"
},
{
"name": "message_id",
"type": "int53",
"description": "The identifier of the message; may be 0 if the replied message is in unknown chat"
},
{
"name": "quote",
"type": "textQuote",
"description": "Chosen quote from the replied message; may be null if none"
},
{
"name": "origin",
"type": "MessageOrigin",
"description": "Information about origin of the message if the message was from another chat or topic; may be null for messages from the same chat"
},
{
"name": "origin_send_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was sent if the message was from another chat or topic; 0 for messages from the same chat"
},
{
"name": "content",
"type": "MessageContent",
"description": "Media content of the message if the message was from another chat or topic; may be null for messages from the same chat and messages without media. Can be only one of the following types: messageAnimation, messageAudio, messageContact, messageDice, messageDocument, messageGame, messageInvoice, messageLocation, messagePhoto, messagePoll, messagePremiumGiveaway, messagePremiumGiveawayWinners, messageSticker, messageStory, messageText (for link preview), messageVenue, messageVideo, messageVideoNote, or messageVoiceNote"
}
]
},
{
"name": "messageReplyToStory",
"description": "Describes a story replied by a given message",
"class": "MessageReplyTo",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the story"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the story"
}
]
},
{
"name": "inputMessageReplyToMessage",
"description": "Describes a message to be replied",
"class": "InputMessageReplyTo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The identifier of the chat to which the message to be replied belongs; pass 0 if the message to be replied is in the same chat. Must always be 0 for replies in secret chats. A message can be replied in another chat or topic only if message.can_be_replied_in_another_chat"
},
{
"name": "message_id",
"type": "int53",
"description": "The identifier of the message to be replied in the same or the specified chat"
},
{
"name": "quote",
"type": "inputTextQuote",
"description": "Quote from the message to be replied; pass null if none. Must always be null for replies in secret chats"
}
]
},
{
"name": "inputMessageReplyToStory",
"description": "Describes a story to be replied",
"class": "InputMessageReplyTo",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the story. Currently, stories can be replied only in the sender's chat and channel stories can't be replied"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the story"
}
]
},
{
"name": "message",
"description": "Describes a message",
"class": "Message",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Message identifier; unique for the chat to which the message belongs"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of the message"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "sending_state",
"type": "MessageSendingState",
"description": "The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent"
},
{
"name": "scheduling_state",
"type": "MessageSchedulingState",
"description": "The scheduling state of the message; may be null if the message isn't scheduled"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the message is outgoing"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is pinned"
},
{
"name": "is_from_offline",
"type": "Bool",
"description": "True, if the message was sent because of a scheduled action by the message sender, for example, as away, or greeting service message"
},
{
"name": "can_be_edited",
"type": "Bool",
"description": "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"
},
{
"name": "can_be_forwarded",
"type": "Bool",
"description": "True, if the message can be forwarded"
},
{
"name": "can_be_replied_in_another_chat",
"type": "Bool",
"description": "True, if the message can be replied in another chat or topic"
},
{
"name": "can_be_saved",
"type": "Bool",
"description": "True, if content of the message can be saved locally or copied"
},
{
"name": "can_be_deleted_only_for_self",
"type": "Bool",
"description": "True, if the message can be deleted only for the current user while other users will continue to see it"
},
{
"name": "can_be_deleted_for_all_users",
"type": "Bool",
"description": "True, if the message can be deleted for all users"
},
{
"name": "can_get_added_reactions",
"type": "Bool",
"description": "True, if the list of added reactions is available through getMessageAddedReactions"
},
{
"name": "can_get_statistics",
"type": "Bool",
"description": "True, if the message statistics are available through getMessageStatistics"
},
{
"name": "can_get_message_thread",
"type": "Bool",
"description": "True, if information about the message thread is available through getMessageThread and getMessageThreadHistory"
},
{
"name": "can_get_read_date",
"type": "Bool",
"description": "True, if read date of the message can be received through getMessageReadDate"
},
{
"name": "can_get_viewers",
"type": "Bool",
"description": "True, if chat members already viewed the message can be received through getMessageViewers"
},
{
"name": "can_get_media_timestamp_links",
"type": "Bool",
"description": "True, if media timestamp links can be generated for media timestamp entities in the message text, caption or web page description through getMessageLink"
},
{
"name": "can_report_reactions",
"type": "Bool",
"description": "True, if reactions on the message can be reported through reportMessageReactions"
},
{
"name": "has_timestamped_media",
"type": "Bool",
"description": "True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message"
},
{
"name": "is_channel_post",
"type": "Bool",
"description": "True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts"
},
{
"name": "is_topic_message",
"type": "Bool",
"description": "True, if the message is a forum topic message"
},
{
"name": "contains_unread_mention",
"type": "Bool",
"description": "True, if the message contains an unread mention for the current user"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was sent"
},
{
"name": "edit_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was last edited"
},
{
"name": "forward_info",
"type": "messageForwardInfo",
"description": "Information about the initial message sender; may be null if none or unknown"
},
{
"name": "import_info",
"type": "messageImportInfo",
"description": "Information about the initial message for messages created with importMessages; may be null if the message isn't imported"
},
{
"name": "interaction_info",
"type": "messageInteractionInfo",
"description": "Information about interactions with the message; may be null if none"
},
{
"name": "unread_reactions",
"type": "vector\u003cunreadReaction\u003e",
"description": "Information about unread reactions added to the message"
},
{
"name": "reply_to",
"type": "MessageReplyTo",
"description": "Information about the message or the story this message is replying to; may be null if none"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If non-zero, the identifier of the message thread the message belongs to; unique within the chat to which the message belongs"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of the Saved Messages topic for the message; 0 for messages not from Saved Messages"
},
{
"name": "self_destruct_type",
"type": "MessageSelfDestructType",
"description": "The message's self-destruct type; may be null if none"
},
{
"name": "self_destruct_in",
"type": "double",
"description": "Time left before the message self-destruct timer expires, in seconds; 0 if self-destruction isn't scheduled yet"
},
{
"name": "auto_delete_in",
"type": "double",
"description": "Time left before the message will be automatically deleted by message_auto_delete_time setting of the chat, in seconds; 0 if never"
},
{
"name": "via_bot_user_id",
"type": "int53",
"description": "If non-zero, the user identifier of the inline bot through which this message was sent"
},
{
"name": "sender_business_bot_user_id",
"type": "int53",
"description": "If non-zero, the user identifier of the business bot that sent this message"
},
{
"name": "sender_boost_count",
"type": "int32",
"description": "Number of times the sender of the message boosted the supergroup at the time the message was sent; 0 if none or unknown. For messages sent by the current user, supergroupFullInfo.my_boost_count must be used instead"
},
{
"name": "author_signature",
"type": "string",
"description": "For channel posts and anonymous group messages, optional author signature"
},
{
"name": "media_album_id",
"type": "int64",
"description": "Unique identifier of an album this message belongs to. Only audios, documents, photos and videos can be grouped together in albums"
},
{
"name": "restriction_reason",
"type": "string",
"description": "If non-empty, contains a human-readable description of the reason why access to this message must be restricted"
},
{
"name": "content",
"type": "MessageContent",
"description": "Content of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "Reply markup for the message; may be null if none"
}
]
},
{
"name": "messages",
"description": "Contains a list of messages",
"class": "Messages",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of messages found"
},
{
"name": "messages",
"type": "vector\u003cmessage\u003e",
"description": "List of messages; messages may be null"
}
]
},
{
"name": "foundMessages",
"description": "Contains a list of messages found by a search",
"class": "FoundMessages",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of messages found; -1 if unknown"
},
{
"name": "messages",
"type": "vector\u003cmessage\u003e",
"description": "List of messages"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "foundChatMessages",
"description": "Contains a list of messages found by a search in a given chat",
"class": "FoundChatMessages",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of messages found; -1 if unknown"
},
{
"name": "messages",
"type": "vector\u003cmessage\u003e",
"description": "List of messages"
},
{
"name": "next_from_message_id",
"type": "int53",
"description": "The offset for the next request. If 0, there are no more results"
}
]
},
{
"name": "messagePosition",
"description": "Contains information about a message in a specific position",
"class": "MessagePosition",
"properties": [
{
"name": "position",
"type": "int32",
"description": "0-based message position in the full list of suitable messages"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was sent"
}
]
},
{
"name": "messagePositions",
"description": "Contains a list of message positions",
"class": "MessagePositions",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of messages found"
},
{
"name": "positions",
"type": "vector\u003cmessagePosition\u003e",
"description": "List of message positions"
}
]
},
{
"name": "messageCalendarDay",
"description": "Contains information about found messages sent on a specific day",
"class": "MessageCalendarDay",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of found messages sent on the day"
},
{
"name": "message",
"type": "message",
"description": "First message sent on the day"
}
]
},
{
"name": "messageCalendar",
"description": "Contains information about found messages, split by days according to the option \"utc_time_offset\"",
"class": "MessageCalendar",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of found messages"
},
{
"name": "days",
"type": "vector\u003cmessageCalendarDay\u003e",
"description": "Information about messages sent"
}
]
},
{
"name": "businessMessage",
"description": "Describes a message from a business account as received by a bot",
"class": "BusinessMessage",
"properties": [
{
"name": "message",
"type": "message",
"description": "The message"
},
{
"name": "reply_to_message",
"type": "message",
"description": "Message that is replied by the message in the same chat; may be null if none"
}
]
},
{
"name": "businessMessages",
"description": "Contains a list of messages from a business account as received by a bot",
"class": "BusinessMessages",
"properties": [
{
"name": "messages",
"type": "vector\u003cbusinessMessage\u003e",
"description": "List of business messages"
}
]
},
{
"name": "messageSourceChatHistory",
"description": "The message is from a chat history",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceMessageThreadHistory",
"description": "The message is from a message thread history",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceForumTopicHistory",
"description": "The message is from a forum topic history",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceHistoryPreview",
"description": "The message is from chat, message thread or forum topic history preview",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceChatList",
"description": "The message is from a chat list or a forum topic list",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceSearch",
"description": "The message is from search results, including file downloads, local file list, outgoing document messages, calendar",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceChatEventLog",
"description": "The message is from a chat event log",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceNotification",
"description": "The message is from a notification",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceScreenshot",
"description": "The message was screenshotted; the source must be used only if the message content was visible during the screenshot",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSourceOther",
"description": "The message is from some other source",
"class": "MessageSource",
"properties": []
},
{
"name": "messageSponsorTypeBot",
"description": "The sponsor is a bot",
"class": "MessageSponsorType",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the bot"
},
{
"name": "link",
"type": "InternalLinkType",
"description": "An internal link to be opened when the sponsored message is clicked"
}
]
},
{
"name": "messageSponsorTypeWebApp",
"description": "The sponsor is a web app",
"class": "MessageSponsorType",
"properties": [
{
"name": "web_app_title",
"type": "string",
"description": "Web App title"
},
{
"name": "link",
"type": "InternalLinkType",
"description": "An internal link to be opened when the sponsored message is clicked"
}
]
},
{
"name": "messageSponsorTypePublicChannel",
"description": "The sponsor is a public channel chat",
"class": "MessageSponsorType",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Sponsor chat identifier"
},
{
"name": "link",
"type": "InternalLinkType",
"description": "An internal link to be opened when the sponsored message is clicked; may be null if the sponsor chat needs to be opened instead"
}
]
},
{
"name": "messageSponsorTypePrivateChannel",
"description": "The sponsor is a private channel chat",
"class": "MessageSponsorType",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the chat"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link for the channel"
}
]
},
{
"name": "messageSponsorTypeWebsite",
"description": "The sponsor is a website",
"class": "MessageSponsorType",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL of the website"
},
{
"name": "name",
"type": "string",
"description": "Name of the website"
}
]
},
{
"name": "messageSponsor",
"description": "Information about the sponsor of a message",
"class": "MessageSponsor",
"properties": [
{
"name": "type",
"type": "MessageSponsorType",
"description": "Type of the sponsor"
},
{
"name": "photo",
"type": "chatPhotoInfo",
"description": "Photo of the sponsor; may be null if must not be shown"
},
{
"name": "info",
"type": "string",
"description": "Additional optional information about the sponsor to be shown along with the message"
}
]
},
{
"name": "sponsoredMessage",
"description": "Describes a sponsored message",
"class": "SponsoredMessage",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages"
},
{
"name": "is_recommended",
"type": "Bool",
"description": "True, if the message needs to be labeled as \"recommended\" instead of \"sponsored\""
},
{
"name": "can_be_reported",
"type": "Bool",
"description": "True, if the message can be reported to Telegram moderators through reportChatSponsoredMessage"
},
{
"name": "content",
"type": "MessageContent",
"description": "Content of the message. Currently, can be only of the type messageText"
},
{
"name": "sponsor",
"type": "messageSponsor",
"description": "Information about the sponsor of the message"
},
{
"name": "button_text",
"type": "string",
"description": "If non-empty, text for the message action button"
},
{
"name": "additional_info",
"type": "string",
"description": "If non-empty, additional information about the sponsored message to be shown along with the message"
}
]
},
{
"name": "sponsoredMessages",
"description": "Contains a list of sponsored messages",
"class": "SponsoredMessages",
"properties": [
{
"name": "messages",
"type": "vector\u003csponsoredMessage\u003e",
"description": "List of sponsored messages"
},
{
"name": "messages_between",
"type": "int32",
"description": "The minimum number of messages between shown sponsored messages, or 0 if only one sponsored message must be shown after all ordinary messages"
}
]
},
{
"name": "reportChatSponsoredMessageOption",
"description": "Describes an option to report a sponsored message",
"class": "ReportChatSponsoredMessageOption",
"properties": [
{
"name": "id",
"type": "bytes",
"description": "Unique identifier of the option"
},
{
"name": "text",
"type": "string",
"description": "Text of the option"
}
]
},
{
"name": "reportChatSponsoredMessageResultOk",
"description": "The message was reported successfully",
"class": "ReportChatSponsoredMessageResult",
"properties": []
},
{
"name": "reportChatSponsoredMessageResultFailed",
"description": "The sponsored message is too old or not found",
"class": "ReportChatSponsoredMessageResult",
"properties": []
},
{
"name": "reportChatSponsoredMessageResultOptionRequired",
"description": "The user must choose an option to report the message and repeat request with the chosen option",
"class": "ReportChatSponsoredMessageResult",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title for the option choice"
},
{
"name": "options",
"type": "vector\u003creportChatSponsoredMessageOption\u003e",
"description": "List of available options"
}
]
},
{
"name": "reportChatSponsoredMessageResultAdsHidden",
"description": "Sponsored messages were hidden for the user in all chats",
"class": "ReportChatSponsoredMessageResult",
"properties": []
},
{
"name": "reportChatSponsoredMessageResultPremiumRequired",
"description": "The user asked to hide sponsored messages, but Telegram Premium is required for this",
"class": "ReportChatSponsoredMessageResult",
"properties": []
},
{
"name": "fileDownload",
"description": "Describes a file added to file download list",
"class": "FileDownload",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "File identifier"
},
{
"name": "message",
"type": "message",
"description": "The message with the file"
},
{
"name": "add_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the file was added to the download list"
},
{
"name": "complete_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the file downloading was completed; 0 if the file downloading isn't completed"
},
{
"name": "is_paused",
"type": "Bool",
"description": "True, if downloading of the file is paused"
}
]
},
{
"name": "downloadedFileCounts",
"description": "Contains number of being downloaded and recently downloaded files found",
"class": "DownloadedFileCounts",
"properties": [
{
"name": "active_count",
"type": "int32",
"description": "Number of active file downloads found, including paused"
},
{
"name": "paused_count",
"type": "int32",
"description": "Number of paused file downloads found"
},
{
"name": "completed_count",
"type": "int32",
"description": "Number of completed file downloads found"
}
]
},
{
"name": "foundFileDownloads",
"description": "Contains a list of downloaded files, found by a search",
"class": "FoundFileDownloads",
"properties": [
{
"name": "total_counts",
"type": "downloadedFileCounts",
"description": "Total number of suitable files, ignoring offset"
},
{
"name": "files",
"type": "vector\u003cfileDownload\u003e",
"description": "The list of files"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "notificationSettingsScopePrivateChats",
"description": "Notification settings applied to all private and secret chats when the corresponding chat setting has a default value",
"class": "NotificationSettingsScope",
"properties": []
},
{
"name": "notificationSettingsScopeGroupChats",
"description": "Notification settings applied to all basic group and supergroup chats when the corresponding chat setting has a default value",
"class": "NotificationSettingsScope",
"properties": []
},
{
"name": "notificationSettingsScopeChannelChats",
"description": "Notification settings applied to all channel chats when the corresponding chat setting has a default value",
"class": "NotificationSettingsScope",
"properties": []
},
{
"name": "chatNotificationSettings",
"description": "Contains information about notification settings for a chat or a forum topic",
"class": "ChatNotificationSettings",
"properties": [
{
"name": "use_default_mute_for",
"type": "Bool",
"description": "If true, the value for the relevant type of chat or the forum chat is used instead of mute_for"
},
{
"name": "mute_for",
"type": "int32",
"description": "Time left before notifications will be unmuted, in seconds"
},
{
"name": "use_default_sound",
"type": "Bool",
"description": "If true, the value for the relevant type of chat or the forum chat is used instead of sound_id"
},
{
"name": "sound_id",
"type": "int64",
"description": "Identifier of the notification sound to be played for messages; 0 if sound is disabled"
},
{
"name": "use_default_show_preview",
"type": "Bool",
"description": "If true, the value for the relevant type of chat or the forum chat is used instead of show_preview"
},
{
"name": "show_preview",
"type": "Bool",
"description": "True, if message content must be displayed in notifications"
},
{
"name": "use_default_mute_stories",
"type": "Bool",
"description": "If true, the value for the relevant type of chat is used instead of mute_stories"
},
{
"name": "mute_stories",
"type": "Bool",
"description": "True, if story notifications are disabled for the chat"
},
{
"name": "use_default_story_sound",
"type": "Bool",
"description": "If true, the value for the relevant type of chat is used instead of story_sound_id"
},
{
"name": "story_sound_id",
"type": "int64",
"description": "Identifier of the notification sound to be played for stories; 0 if sound is disabled"
},
{
"name": "use_default_show_story_sender",
"type": "Bool",
"description": "If true, the value for the relevant type of chat is used instead of show_story_sender"
},
{
"name": "show_story_sender",
"type": "Bool",
"description": "True, if the sender of stories must be displayed in notifications"
},
{
"name": "use_default_disable_pinned_message_notifications",
"type": "Bool",
"description": "If true, the value for the relevant type of chat or the forum chat is used instead of disable_pinned_message_notifications"
},
{
"name": "disable_pinned_message_notifications",
"type": "Bool",
"description": "If true, notifications for incoming pinned messages will be created as for an ordinary unread message"
},
{
"name": "use_default_disable_mention_notifications",
"type": "Bool",
"description": "If true, the value for the relevant type of chat or the forum chat is used instead of disable_mention_notifications"
},
{
"name": "disable_mention_notifications",
"type": "Bool",
"description": "If true, notifications for messages with mentions will be created as for an ordinary unread message"
}
]
},
{
"name": "scopeNotificationSettings",
"description": "Contains information about notification settings for several chats",
"class": "ScopeNotificationSettings",
"properties": [
{
"name": "mute_for",
"type": "int32",
"description": "Time left before notifications will be unmuted, in seconds"
},
{
"name": "sound_id",
"type": "int64",
"description": "Identifier of the notification sound to be played; 0 if sound is disabled"
},
{
"name": "show_preview",
"type": "Bool",
"description": "True, if message content must be displayed in notifications"
},
{
"name": "use_default_mute_stories",
"type": "Bool",
"description": "If true, story notifications are received only for the first 5 chats from topChatCategoryUsers regardless of the value of mute_stories"
},
{
"name": "mute_stories",
"type": "Bool",
"description": "True, if story notifications are disabled"
},
{
"name": "story_sound_id",
"type": "int64",
"description": "Identifier of the notification sound to be played for stories; 0 if sound is disabled"
},
{
"name": "show_story_sender",
"type": "Bool",
"description": "True, if the sender of stories must be displayed in notifications"
},
{
"name": "disable_pinned_message_notifications",
"type": "Bool",
"description": "True, if notifications for incoming pinned messages will be created as for an ordinary unread message"
},
{
"name": "disable_mention_notifications",
"type": "Bool",
"description": "True, if notifications for messages with mentions will be created as for an ordinary unread message"
}
]
},
{
"name": "draftMessage",
"description": "Contains information about a message draft",
"class": "DraftMessage",
"properties": [
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message to be replied; must be of the type inputMessageReplyToMessage; may be null if none"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the draft was created"
},
{
"name": "input_message_text",
"type": "InputMessageContent",
"description": "Content of the message draft; must be of the type inputMessageText, inputMessageVideoNote, or inputMessageVoiceNote"
}
]
},
{
"name": "chatTypePrivate",
"description": "An ordinary chat with a user",
"class": "ChatType",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
]
},
{
"name": "chatTypeBasicGroup",
"description": "A basic group (a chat with 0-200 other users)",
"class": "ChatType",
"properties": [
{
"name": "basic_group_id",
"type": "int53",
"description": "Basic group identifier"
}
]
},
{
"name": "chatTypeSupergroup",
"description": "A supergroup or channel (with unlimited members)",
"class": "ChatType",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup or channel identifier"
},
{
"name": "is_channel",
"type": "Bool",
"description": "True, if the supergroup is a channel"
}
]
},
{
"name": "chatTypeSecret",
"description": "A secret chat with a user",
"class": "ChatType",
"properties": [
{
"name": "secret_chat_id",
"type": "int32",
"description": "Secret chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier of the other user in the secret chat"
}
]
},
{
"name": "chatFolderIcon",
"description": "Represents an icon for a chat folder",
"class": "ChatFolderIcon",
"properties": [
{
"name": "name",
"type": "string",
"description": "The chosen icon name for short folder 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\", \"Airplane\", \"Book\", \"Light\", \"Like\", \"Money\", \"Note\", \"Palette\""
}
]
},
{
"name": "chatFolder",
"description": "Represents a folder for user chats",
"class": "ChatFolder",
"properties": [
{
"name": "title",
"type": "string",
"description": "The title of the folder; 1-12 characters without line feeds"
},
{
"name": "icon",
"type": "chatFolderIcon",
"description": "The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder"
},
{
"name": "color_id",
"type": "int32",
"description": "The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is didabled. Can't be changed if folder tags are disabled or the current user doesn't have Telegram Premium subscription"
},
{
"name": "is_shareable",
"type": "Bool",
"description": "True, if at least one link has been created for the folder"
},
{
"name": "pinned_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The chat identifiers of pinned chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium"
},
{
"name": "included_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The chat identifiers of always included chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium"
},
{
"name": "excluded_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The chat identifiers of always excluded chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium"
},
{
"name": "exclude_muted",
"type": "Bool",
"description": "True, if muted chats need to be excluded"
},
{
"name": "exclude_read",
"type": "Bool",
"description": "True, if read chats need to be excluded"
},
{
"name": "exclude_archived",
"type": "Bool",
"description": "True, if archived chats need to be excluded"
},
{
"name": "include_contacts",
"type": "Bool",
"description": "True, if contacts need to be included"
},
{
"name": "include_non_contacts",
"type": "Bool",
"description": "True, if non-contact users need to be included"
},
{
"name": "include_bots",
"type": "Bool",
"description": "True, if bots need to be included"
},
{
"name": "include_groups",
"type": "Bool",
"description": "True, if basic groups and supergroups need to be included"
},
{
"name": "include_channels",
"type": "Bool",
"description": "True, if channels need to be included"
}
]
},
{
"name": "chatFolderInfo",
"description": "Contains basic information about a chat folder",
"class": "ChatFolderInfo",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique chat folder identifier"
},
{
"name": "title",
"type": "string",
"description": "The title of the folder; 1-12 characters without line feeds"
},
{
"name": "icon",
"type": "chatFolderIcon",
"description": "The chosen or default icon for the chat folder"
},
{
"name": "color_id",
"type": "int32",
"description": "The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is didabled"
},
{
"name": "is_shareable",
"type": "Bool",
"description": "True, if at least one link has been created for the folder"
},
{
"name": "has_my_invite_links",
"type": "Bool",
"description": "True, if the chat folder has invite links created by the current user"
}
]
},
{
"name": "chatFolderInviteLink",
"description": "Contains a chat folder invite link",
"class": "ChatFolderInviteLink",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "The chat folder invite link"
},
{
"name": "name",
"type": "string",
"description": "Name of the link"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of chats, included in the link"
}
]
},
{
"name": "chatFolderInviteLinks",
"description": "Represents a list of chat folder invite links",
"class": "ChatFolderInviteLinks",
"properties": [
{
"name": "invite_links",
"type": "vector\u003cchatFolderInviteLink\u003e",
"description": "List of the invite links"
}
]
},
{
"name": "chatFolderInviteLinkInfo",
"description": "Contains information about an invite link to a chat folder",
"class": "ChatFolderInviteLinkInfo",
"properties": [
{
"name": "chat_folder_info",
"type": "chatFolderInfo",
"description": "Basic information about the chat folder; chat folder identifier will be 0 if the user didn't have the chat folder yet"
},
{
"name": "missing_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the chats from the link, which aren't added to the folder yet"
},
{
"name": "added_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the chats from the link, which are added to the folder already"
}
]
},
{
"name": "recommendedChatFolder",
"description": "Describes a recommended chat folder",
"class": "RecommendedChatFolder",
"properties": [
{
"name": "folder",
"type": "chatFolder",
"description": "The chat folder"
},
{
"name": "description",
"type": "string",
"description": "Chat folder description"
}
]
},
{
"name": "recommendedChatFolders",
"description": "Contains a list of recommended chat folders",
"class": "RecommendedChatFolders",
"properties": [
{
"name": "chat_folders",
"type": "vector\u003crecommendedChatFolder\u003e",
"description": "List of recommended chat folders"
}
]
},
{
"name": "archiveChatListSettings",
"description": "Contains settings for automatic moving of chats to and from the Archive chat lists",
"class": "ArchiveChatListSettings",
"properties": [
{
"name": "archive_and_mute_new_chats_from_unknown_users",
"type": "Bool",
"description": "True, if new chats from non-contacts will be automatically archived and muted. Can be set to true only if the option \"can_archive_and_mute_new_chats_from_unknown_users\" is true"
},
{
"name": "keep_unmuted_chats_archived",
"type": "Bool",
"description": "True, if unmuted chats will be kept in the Archive chat list when they get a new message"
},
{
"name": "keep_chats_from_folders_archived",
"type": "Bool",
"description": "True, if unmuted chats, that are always included or pinned in a folder, will be kept in the Archive chat list when they get a new message. Ignored if keep_unmuted_chats_archived == true"
}
]
},
{
"name": "chatListMain",
"description": "A main list of chats",
"class": "ChatList",
"properties": []
},
{
"name": "chatListArchive",
"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",
"class": "ChatList",
"properties": []
},
{
"name": "chatListFolder",
"description": "A list of chats added to a chat folder",
"class": "ChatList",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
]
},
{
"name": "chatLists",
"description": "Contains a list of chat lists",
"class": "ChatLists",
"properties": [
{
"name": "chat_lists",
"type": "vector\u003cChatList\u003e",
"description": "List of chat lists"
}
]
},
{
"name": "chatSourceMtprotoProxy",
"description": "The chat is sponsored by the user's MTProxy server",
"class": "ChatSource",
"properties": []
},
{
"name": "chatSourcePublicServiceAnnouncement",
"description": "The chat contains a public service announcement",
"class": "ChatSource",
"properties": [
{
"name": "type",
"type": "string",
"description": "The type of the announcement"
},
{
"name": "text",
"type": "string",
"description": "The text of the announcement"
}
]
},
{
"name": "chatPosition",
"description": "Describes a position of a chat in a chat list",
"class": "ChatPosition",
"properties": [
{
"name": "list",
"type": "ChatList",
"description": "The chat list"
},
{
"name": "order",
"type": "int64",
"description": "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"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the chat is pinned in the chat list"
},
{
"name": "source",
"type": "ChatSource",
"description": "Source of the chat in the chat list; may be null"
}
]
},
{
"name": "chatAvailableReactionsAll",
"description": "All reactions are available in the chat",
"class": "ChatAvailableReactions",
"properties": []
},
{
"name": "chatAvailableReactionsSome",
"description": "Only specific reactions are available in the chat",
"class": "ChatAvailableReactions",
"properties": [
{
"name": "reactions",
"type": "vector\u003cReactionType\u003e",
"description": "The list of reactions"
}
]
},
{
"name": "savedMessagesTag",
"description": "Represents a tag used in Saved Messages or a Saved Messages topic",
"class": "SavedMessagesTag",
"properties": [
{
"name": "tag",
"type": "ReactionType",
"description": "The tag"
},
{
"name": "label",
"type": "string",
"description": "Label of the tag; 0-12 characters. Always empty if the tag is returned for a Saved Messages topic"
},
{
"name": "count",
"type": "int32",
"description": "Number of times the tag was used; may be 0 if the tag has non-empty label"
}
]
},
{
"name": "savedMessagesTags",
"description": "Contains a list of tags used in Saved Messages",
"class": "SavedMessagesTags",
"properties": [
{
"name": "tags",
"type": "vector\u003csavedMessagesTag\u003e",
"description": "List of tags"
}
]
},
{
"name": "videoChat",
"description": "Describes a video chat",
"class": "VideoChat",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier of an active video chat; 0 if none. Full information about the video chat can be received through the method getGroupCall"
},
{
"name": "has_participants",
"type": "Bool",
"description": "True, if the video chat has participants"
},
{
"name": "default_participant_id",
"type": "MessageSender",
"description": "Default group call participant identifier to join the video chat; may be null"
}
]
},
{
"name": "chat",
"description": "A chat. (Can be a private chat, basic group, supergroup, or secret chat)",
"class": "Chat",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Chat unique identifier"
},
{
"name": "type",
"type": "ChatType",
"description": "Type of the chat"
},
{
"name": "title",
"type": "string",
"description": "Chat title"
},
{
"name": "photo",
"type": "chatPhotoInfo",
"description": "Chat photo; may be null"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color for message sender name, and backgrounds of chat photo, reply header, and link preview"
},
{
"name": "background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the reply header and link preview background for messages sent by the chat; 0 if none"
},
{
"name": "profile_accent_color_id",
"type": "int32",
"description": "Identifier of the profile accent color for the chat's profile; -1 if none"
},
{
"name": "profile_background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the background of the chat's profile; 0 if none"
},
{
"name": "permissions",
"type": "chatPermissions",
"description": "Actions that non-administrator chat members are allowed to take in the chat"
},
{
"name": "last_message",
"type": "message",
"description": "Last message in the chat; may be null if none or unknown"
},
{
"name": "positions",
"type": "vector\u003cchatPosition\u003e",
"description": "Positions of the chat in chat lists"
},
{
"name": "chat_lists",
"type": "vector\u003cChatList\u003e",
"description": "Chat lists to which the chat belongs. A chat can have a non-zero position in a chat list even it doesn't belong to the chat list and have no position in a chat list even it belongs to the chat list"
},
{
"name": "message_sender_id",
"type": "MessageSender",
"description": "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"
},
{
"name": "block_list",
"type": "BlockList",
"description": "Block list to which the chat is added; may be null if none"
},
{
"name": "has_protected_content",
"type": "Bool",
"description": "True, if chat content can't be saved locally, forwarded, or copied"
},
{
"name": "is_translatable",
"type": "Bool",
"description": "True, if translation of all messages in the chat must be suggested to the user"
},
{
"name": "is_marked_as_unread",
"type": "Bool",
"description": "True, if the chat is marked as unread"
},
{
"name": "view_as_topics",
"type": "Bool",
"description": "True, if the chat is a forum supergroup that must be shown in the \"View as topics\" mode, or Saved Messages chat that must be shown in the \"View as chats\""
},
{
"name": "has_scheduled_messages",
"type": "Bool",
"description": "True, if the chat has scheduled messages"
},
{
"name": "can_be_deleted_only_for_self",
"type": "Bool",
"description": "True, if the chat messages can be deleted only for the current user while other users will continue to see the messages"
},
{
"name": "can_be_deleted_for_all_users",
"type": "Bool",
"description": "True, if the chat messages can be deleted for all users"
},
{
"name": "can_be_reported",
"type": "Bool",
"description": "True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto"
},
{
"name": "default_disable_notification",
"type": "Bool",
"description": "Default value of the disable_notification parameter, used when a message is sent to the chat"
},
{
"name": "unread_count",
"type": "int32",
"description": "Number of unread messages in the chat"
},
{
"name": "last_read_inbox_message_id",
"type": "int53",
"description": "Identifier of the last read incoming message"
},
{
"name": "last_read_outbox_message_id",
"type": "int53",
"description": "Identifier of the last read outgoing message"
},
{
"name": "unread_mention_count",
"type": "int32",
"description": "Number of unread messages with a mention/reply in the chat"
},
{
"name": "unread_reaction_count",
"type": "int32",
"description": "Number of messages with unread reactions in the chat"
},
{
"name": "notification_settings",
"type": "chatNotificationSettings",
"description": "Notification settings for the chat"
},
{
"name": "available_reactions",
"type": "ChatAvailableReactions",
"description": "Types of reaction, available in the chat"
},
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "Current message auto-delete or self-destruct timer setting for the chat, in seconds; 0 if disabled. Self-destruct timer in secret chats starts after the message or its content is viewed. Auto-delete timer in other chats starts from the send date"
},
{
"name": "emoji_status",
"type": "emojiStatus",
"description": "Emoji status to be shown along with chat title; may be null"
},
{
"name": "background",
"type": "chatBackground",
"description": "Background set for the chat; may be null if none"
},
{
"name": "theme_name",
"type": "string",
"description": "If non-empty, name of a theme, set for the chat"
},
{
"name": "action_bar",
"type": "ChatActionBar",
"description": "Information about actions which must be possible to do through the chat action bar; may be null if none"
},
{
"name": "video_chat",
"type": "videoChat",
"description": "Information about video chat of the chat"
},
{
"name": "pending_join_requests",
"type": "chatJoinRequestsInfo",
"description": "Information about pending join requests; may be null if none"
},
{
"name": "reply_markup_message_id",
"type": "int53",
"description": "Identifier of the message from which reply markup needs to be used; 0 if there is no default custom reply markup in the chat"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "A draft of a message in the chat; may be null if none"
},
{
"name": "client_data",
"type": "string",
"description": "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"
}
]
},
{
"name": "chats",
"description": "Represents a list of chats",
"class": "Chats",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of chats found"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "List of chat identifiers"
}
]
},
{
"name": "chatNearby",
"description": "Describes a chat located nearby",
"class": "ChatNearby",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "distance",
"type": "int32",
"description": "Distance to the chat location, in meters"
}
]
},
{
"name": "chatsNearby",
"description": "Represents a list of chats located nearby",
"class": "ChatsNearby",
"properties": [
{
"name": "users_nearby",
"type": "vector\u003cchatNearby\u003e",
"description": "List of users nearby"
},
{
"name": "supergroups_nearby",
"type": "vector\u003cchatNearby\u003e",
"description": "List of location-based supergroups nearby"
}
]
},
{
"name": "publicChatTypeHasUsername",
"description": "The chat is public, because it has an active username",
"class": "PublicChatType",
"properties": []
},
{
"name": "publicChatTypeIsLocationBased",
"description": "The chat is public, because it is a location-based supergroup",
"class": "PublicChatType",
"properties": []
},
{
"name": "chatActionBarReportSpam",
"description": "The chat can be reported as spam using the method reportChat with the reason reportReasonSpam. If the chat is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown",
"class": "ChatActionBar",
"properties": [
{
"name": "can_unarchive",
"type": "Bool",
"description": "If true, the chat was automatically archived and can be moved back to the main chat list using addChatToList simultaneously with setting chat notification settings to default using setChatNotificationSettings"
}
]
},
{
"name": "chatActionBarReportUnrelatedLocation",
"description": "The chat is a location-based supergroup, which can be reported as having unrelated location using the method reportChat with the reason reportReasonUnrelatedLocation",
"class": "ChatActionBar",
"properties": []
},
{
"name": "chatActionBarInviteMembers",
"description": "The chat is a recently created group chat to which new members can be invited",
"class": "ChatActionBar",
"properties": []
},
{
"name": "chatActionBarReportAddBlock",
"description": "The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method setMessageSenderBlockList, or the other user can be added to the contact list using the method addContact. If the chat is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown",
"class": "ChatActionBar",
"properties": [
{
"name": "can_unarchive",
"type": "Bool",
"description": "If true, the chat was automatically archived and can be moved back to the main chat list using addChatToList simultaneously with setting chat notification settings to default using setChatNotificationSettings"
},
{
"name": "distance",
"type": "int32",
"description": "If non-negative, the current user was found by the other user through searchChatsNearby and this is the distance between the users"
}
]
},
{
"name": "chatActionBarAddContact",
"description": "The chat is a private or secret chat and the other user can be added to the contact list using the method addContact",
"class": "ChatActionBar",
"properties": []
},
{
"name": "chatActionBarSharePhoneNumber",
"description": "The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other user using the method sharePhoneNumber",
"class": "ChatActionBar",
"properties": []
},
{
"name": "chatActionBarJoinRequest",
"description": "The chat is a private chat with an administrator of a chat to which the user sent join request",
"class": "ChatActionBar",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the chat to which the join request was sent"
},
{
"name": "is_channel",
"type": "Bool",
"description": "True, if the join request was sent to a channel chat"
},
{
"name": "request_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the join request was sent"
}
]
},
{
"name": "keyboardButtonTypeText",
"description": "A simple button, with text that must be sent when the button is pressed",
"class": "KeyboardButtonType",
"properties": []
},
{
"name": "keyboardButtonTypeRequestPhoneNumber",
"description": "A button that sends the user's phone number when pressed; available only in private chats",
"class": "KeyboardButtonType",
"properties": []
},
{
"name": "keyboardButtonTypeRequestLocation",
"description": "A button that sends the user's location when pressed; available only in private chats",
"class": "KeyboardButtonType",
"properties": []
},
{
"name": "keyboardButtonTypeRequestPoll",
"description": "A button that allows the user to create and send a poll when pressed; available only in private chats",
"class": "KeyboardButtonType",
"properties": [
{
"name": "force_regular",
"type": "Bool",
"description": "If true, only regular polls must be allowed to create"
},
{
"name": "force_quiz",
"type": "Bool",
"description": "If true, only polls in quiz mode must be allowed to create"
}
]
},
{
"name": "keyboardButtonTypeRequestUsers",
"description": "A button that requests users to be shared by the current user; available only in private chats. Use the method shareUsersWithBot to complete the request",
"class": "KeyboardButtonType",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique button identifier"
},
{
"name": "restrict_user_is_bot",
"type": "Bool",
"description": "True, if the shared users must or must not be bots"
},
{
"name": "user_is_bot",
"type": "Bool",
"description": "True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false"
},
{
"name": "restrict_user_is_premium",
"type": "Bool",
"description": "True, if the shared users must or must not be Telegram Premium users"
},
{
"name": "user_is_premium",
"type": "Bool",
"description": "True, if the shared users must be Telegram Premium users; otherwise, the shared users must not be Telegram Premium users. Ignored if restrict_user_is_premium is false"
},
{
"name": "max_quantity",
"type": "int32",
"description": "The maximum number of users to share"
},
{
"name": "request_name",
"type": "Bool",
"description": "Pass true to request name of the users; bots only"
},
{
"name": "request_username",
"type": "Bool",
"description": "Pass true to request username of the users; bots only"
},
{
"name": "request_photo",
"type": "Bool",
"description": "Pass true to request photo of the users; bots only"
}
]
},
{
"name": "keyboardButtonTypeRequestChat",
"description": "A button that requests a chat to be shared by the current user; available only in private chats. Use the method shareChatWithBot to complete the request",
"class": "KeyboardButtonType",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique button identifier"
},
{
"name": "chat_is_channel",
"type": "Bool",
"description": "True, if the chat must be a channel; otherwise, a basic group or a supergroup chat is shared"
},
{
"name": "restrict_chat_is_forum",
"type": "Bool",
"description": "True, if the chat must or must not be a forum supergroup"
},
{
"name": "chat_is_forum",
"type": "Bool",
"description": "True, if the chat must be a forum supergroup; otherwise, the chat must not be a forum supergroup. Ignored if restrict_chat_is_forum is false"
},
{
"name": "restrict_chat_has_username",
"type": "Bool",
"description": "True, if the chat must or must not have a username"
},
{
"name": "chat_has_username",
"type": "Bool",
"description": "True, if the chat must have a username; otherwise, the chat must not have a username. Ignored if restrict_chat_has_username is false"
},
{
"name": "chat_is_created",
"type": "Bool",
"description": "True, if the chat must be created by the current user"
},
{
"name": "user_administrator_rights",
"type": "chatAdministratorRights",
"description": "Expected user administrator rights in the chat; may be null if they aren't restricted"
},
{
"name": "bot_administrator_rights",
"type": "chatAdministratorRights",
"description": "Expected bot administrator rights in the chat; may be null if they aren't restricted"
},
{
"name": "bot_is_member",
"type": "Bool",
"description": "True, if the bot must be a member of the chat; for basic group and supergroup chats only"
},
{
"name": "request_title",
"type": "Bool",
"description": "Pass true to request title of the chat; bots only"
},
{
"name": "request_username",
"type": "Bool",
"description": "Pass true to request username of the chat; bots only"
},
{
"name": "request_photo",
"type": "Bool",
"description": "Pass true to request photo of the chat; bots only"
}
]
},
{
"name": "keyboardButtonTypeWebApp",
"description": "A button that opens a Web App by calling getWebAppUrl",
"class": "KeyboardButtonType",
"properties": [
{
"name": "url",
"type": "string",
"description": "An HTTP URL to pass to getWebAppUrl"
}
]
},
{
"name": "keyboardButton",
"description": "Represents a single button in a bot keyboard",
"class": "KeyboardButton",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text of the button"
},
{
"name": "type",
"type": "KeyboardButtonType",
"description": "Type of the button"
}
]
},
{
"name": "inlineKeyboardButtonTypeUrl",
"description": "A button that opens a specified URL",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "url",
"type": "string",
"description": "HTTP or tg:// URL to open"
}
]
},
{
"name": "inlineKeyboardButtonTypeLoginUrl",
"description": "A button that opens a specified URL and automatically authorize the current user by calling getLoginUrlInfo",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "url",
"type": "string",
"description": "An HTTP URL to pass to getLoginUrlInfo"
},
{
"name": "id",
"type": "int53",
"description": "Unique button identifier"
},
{
"name": "forward_text",
"type": "string",
"description": "If non-empty, new text of the button in forwarded messages"
}
]
},
{
"name": "inlineKeyboardButtonTypeWebApp",
"description": "A button that opens a Web App by calling openWebApp",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "url",
"type": "string",
"description": "An HTTP URL to pass to openWebApp"
}
]
},
{
"name": "inlineKeyboardButtonTypeCallback",
"description": "A button that sends a callback query to a bot",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "data",
"type": "bytes",
"description": "Data to be sent to the bot via a callback query"
}
]
},
{
"name": "inlineKeyboardButtonTypeCallbackWithPassword",
"description": "A button that asks for the 2-step verification password of the current user and then sends a callback query to a bot",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "data",
"type": "bytes",
"description": "Data to be sent to the bot via a callback query"
}
]
},
{
"name": "inlineKeyboardButtonTypeCallbackGame",
"description": "A button with a game that sends a callback query to a bot. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageGame",
"class": "InlineKeyboardButtonType",
"properties": []
},
{
"name": "inlineKeyboardButtonTypeSwitchInline",
"description": "A button that forces an inline query to the bot to be inserted in the input field",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "query",
"type": "string",
"description": "Inline query to be sent to the bot"
},
{
"name": "target_chat",
"type": "TargetChat",
"description": "Target chat from which to send the inline query"
}
]
},
{
"name": "inlineKeyboardButtonTypeBuy",
"description": "A button to buy something. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageInvoice",
"class": "InlineKeyboardButtonType",
"properties": []
},
{
"name": "inlineKeyboardButtonTypeUser",
"description": "A button with a user reference to be handled in the same way as textEntityTypeMentionName entities",
"class": "InlineKeyboardButtonType",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
]
},
{
"name": "inlineKeyboardButton",
"description": "Represents a single button in an inline keyboard",
"class": "InlineKeyboardButton",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text of the button"
},
{
"name": "type",
"type": "InlineKeyboardButtonType",
"description": "Type of the button"
}
]
},
{
"name": "replyMarkupRemoveKeyboard",
"description": "Instructs application to remove the keyboard once this message has been received. This kind of keyboard can't be received in an incoming message; instead, updateChatReplyMarkup with message_id == 0 will be sent",
"class": "ReplyMarkup",
"properties": [
{
"name": "is_personal",
"type": "Bool",
"description": "True, if the keyboard is removed only for the mentioned users or the target user of a reply"
}
]
},
{
"name": "replyMarkupForceReply",
"description": "Instructs application to force a reply to this message",
"class": "ReplyMarkup",
"properties": [
{
"name": "is_personal",
"type": "Bool",
"description": "True, if a forced reply must automatically be shown to the current user. For outgoing messages, specify true to show the forced reply only for the mentioned users and for the target user of a reply"
},
{
"name": "input_field_placeholder",
"type": "string",
"description": "If non-empty, the placeholder to be shown in the input field when the reply is active; 0-64 characters"
}
]
},
{
"name": "replyMarkupShowKeyboard",
"description": "Contains a custom keyboard layout to quickly reply to bots",
"class": "ReplyMarkup",
"properties": [
{
"name": "rows",
"type": "vector\u003cvector\u003ckeyboardButton\u003e\u003e",
"description": "A list of rows of bot keyboard buttons"
},
{
"name": "is_persistent",
"type": "Bool",
"description": "True, if the keyboard is supposed to always be shown when the ordinary keyboard is hidden"
},
{
"name": "resize_keyboard",
"type": "Bool",
"description": "True, if the application needs to resize the keyboard vertically"
},
{
"name": "one_time",
"type": "Bool",
"description": "True, if the application needs to hide the keyboard after use"
},
{
"name": "is_personal",
"type": "Bool",
"description": "True, if the keyboard must automatically be shown to the current user. For outgoing messages, specify true to show the keyboard only for the mentioned users and for the target user of a reply"
},
{
"name": "input_field_placeholder",
"type": "string",
"description": "If non-empty, the placeholder to be shown in the input field when the keyboard is active; 0-64 characters"
}
]
},
{
"name": "replyMarkupInlineKeyboard",
"description": "Contains an inline keyboard layout",
"class": "ReplyMarkup",
"properties": [
{
"name": "rows",
"type": "vector\u003cvector\u003cinlineKeyboardButton\u003e\u003e",
"description": "A list of rows of inline keyboard buttons"
}
]
},
{
"name": "loginUrlInfoOpen",
"description": "An HTTP URL needs to be open",
"class": "LoginUrlInfo",
"properties": [
{
"name": "url",
"type": "string",
"description": "The URL to open"
},
{
"name": "skip_confirmation",
"type": "Bool",
"description": "True, if there is no need to show an ordinary open URL confirmation"
}
]
},
{
"name": "loginUrlInfoRequestConfirmation",
"description": "An authorization confirmation dialog needs to be shown to the user",
"class": "LoginUrlInfo",
"properties": [
{
"name": "url",
"type": "string",
"description": "An HTTP URL to be opened"
},
{
"name": "domain",
"type": "string",
"description": "A domain of the URL"
},
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of a bot linked with the website"
},
{
"name": "request_write_access",
"type": "Bool",
"description": "True, if the user must be asked for the permission to the bot to send them messages"
}
]
},
{
"name": "foundWebApp",
"description": "Contains information about a Web App found by its short name",
"class": "FoundWebApp",
"properties": [
{
"name": "web_app",
"type": "webApp",
"description": "The Web App"
},
{
"name": "request_write_access",
"type": "Bool",
"description": "True, if the user must be asked for the permission to the bot to send them messages"
},
{
"name": "skip_confirmation",
"type": "Bool",
"description": "True, if there is no need to show an ordinary open URL confirmation before opening the Web App. The field must be ignored and confirmation must be shown anyway if the Web App link was hidden"
}
]
},
{
"name": "webAppInfo",
"description": "Contains information about a Web App",
"class": "WebAppInfo",
"properties": [
{
"name": "launch_id",
"type": "int64",
"description": "Unique identifier for the Web App launch"
},
{
"name": "url",
"type": "string",
"description": "A Web App URL to open in a web view"
}
]
},
{
"name": "messageThreadInfo",
"description": "Contains information about a message thread",
"class": "MessageThreadInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message thread belongs"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier, unique within the chat"
},
{
"name": "reply_info",
"type": "messageReplyInfo",
"description": "Information about the message thread; may be null for forum topic threads"
},
{
"name": "unread_message_count",
"type": "int32",
"description": "Approximate number of unread messages in the message thread"
},
{
"name": "messages",
"type": "vector\u003cmessage\u003e",
"description": "The messages from which the thread starts. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id)"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "A draft of a message in the message thread; may be null if none"
}
]
},
{
"name": "savedMessagesTopicTypeMyNotes",
"description": "Topic containing messages sent by the current user of forwarded from an unknown chat",
"class": "SavedMessagesTopicType",
"properties": []
},
{
"name": "savedMessagesTopicTypeAuthorHidden",
"description": "Topic containing messages forwarded from a user with hidden privacy",
"class": "SavedMessagesTopicType",
"properties": []
},
{
"name": "savedMessagesTopicTypeSavedFromChat",
"description": "Topic containing messages forwarded from a specific chat",
"class": "SavedMessagesTopicType",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
}
]
},
{
"name": "savedMessagesTopic",
"description": "Contains information about a Saved Messages topic",
"class": "SavedMessagesTopic",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Unique topic identifier"
},
{
"name": "type",
"type": "SavedMessagesTopicType",
"description": "Type of the topic"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the topic is pinned"
},
{
"name": "order",
"type": "int64",
"description": "A parameter used to determine order of the topic in the topic list. Topics must be sorted by the order in descending order"
},
{
"name": "last_message",
"type": "message",
"description": "Last message in the topic; may be null if none or unknown"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "A draft of a message in the topic; may be null if none"
}
]
},
{
"name": "forumTopicIcon",
"description": "Describes a forum topic icon",
"class": "ForumTopicIcon",
"properties": [
{
"name": "color",
"type": "int32",
"description": "Color of the topic icon in RGB format"
},
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Unique identifier of the custom emoji shown on the topic icon; 0 if none"
}
]
},
{
"name": "forumTopicInfo",
"description": "Contains basic information about a forum topic",
"class": "ForumTopicInfo",
"properties": [
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the topic"
},
{
"name": "name",
"type": "string",
"description": "Name of the topic"
},
{
"name": "icon",
"type": "forumTopicIcon",
"description": "Icon of the topic"
},
{
"name": "creation_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the topic was created"
},
{
"name": "creator_id",
"type": "MessageSender",
"description": "Identifier of the creator of the topic"
},
{
"name": "is_general",
"type": "Bool",
"description": "True, if the topic is the General topic list"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the topic was created by the current user"
},
{
"name": "is_closed",
"type": "Bool",
"description": "True, if the topic is closed"
},
{
"name": "is_hidden",
"type": "Bool",
"description": "True, if the topic is hidden above the topic list and closed; for General topic only"
}
]
},
{
"name": "forumTopic",
"description": "Describes a forum topic",
"class": "ForumTopic",
"properties": [
{
"name": "info",
"type": "forumTopicInfo",
"description": "Basic information about the topic"
},
{
"name": "last_message",
"type": "message",
"description": "Last message in the topic; may be null if unknown"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the topic is pinned in the topic list"
},
{
"name": "unread_count",
"type": "int32",
"description": "Number of unread messages in the topic"
},
{
"name": "last_read_inbox_message_id",
"type": "int53",
"description": "Identifier of the last read incoming message"
},
{
"name": "last_read_outbox_message_id",
"type": "int53",
"description": "Identifier of the last read outgoing message"
},
{
"name": "unread_mention_count",
"type": "int32",
"description": "Number of unread messages with a mention/reply in the topic"
},
{
"name": "unread_reaction_count",
"type": "int32",
"description": "Number of messages with unread reactions in the topic"
},
{
"name": "notification_settings",
"type": "chatNotificationSettings",
"description": "Notification settings for the topic"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "A draft of a message in the topic; may be null if none"
}
]
},
{
"name": "forumTopics",
"description": "Describes a list of forum topics",
"class": "ForumTopics",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of forum topics found"
},
{
"name": "topics",
"type": "vector\u003cforumTopic\u003e",
"description": "List of forum topics"
},
{
"name": "next_offset_date",
"type": "int32",
"description": "Offset date for the next getForumTopics request"
},
{
"name": "next_offset_message_id",
"type": "int53",
"description": "Offset message identifier for the next getForumTopics request"
},
{
"name": "next_offset_message_thread_id",
"type": "int53",
"description": "Offset message thread identifier for the next getForumTopics request"
}
]
},
{
"name": "linkPreviewOptions",
"description": "Options to be used for generation of a link preview",
"class": "LinkPreviewOptions",
"properties": [
{
"name": "is_disabled",
"type": "Bool",
"description": "True, if link preview must be disabled"
},
{
"name": "url",
"type": "string",
"description": "URL to use for link preview. If empty, then the first URL found in the message text will be used"
},
{
"name": "force_small_media",
"type": "Bool",
"description": "True, if shown media preview must be small; ignored in secret chats or if the URL isn't explicitly specified"
},
{
"name": "force_large_media",
"type": "Bool",
"description": "True, if shown media preview must be large; ignored in secret chats or if the URL isn't explicitly specified"
},
{
"name": "show_above_text",
"type": "Bool",
"description": "True, if link preview must be shown above message text; otherwise, the link preview will be shown below the message text; ignored in secret chats"
}
]
},
{
"name": "sharedUser",
"description": "Contains information about a user shared with a bot",
"class": "SharedUser",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "first_name",
"type": "string",
"description": "First name of the user; for bots only"
},
{
"name": "last_name",
"type": "string",
"description": "Last name of the user; for bots only"
},
{
"name": "username",
"type": "string",
"description": "Username of the user; for bots only"
},
{
"name": "photo",
"type": "photo",
"description": "Profile photo of the user; for bots only; may be null"
}
]
},
{
"name": "sharedChat",
"description": "Contains information about a chat shared with a bot",
"class": "SharedChat",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "title",
"type": "string",
"description": "Title of the chat; for bots only"
},
{
"name": "username",
"type": "string",
"description": "Username of the chat; for bots only"
},
{
"name": "photo",
"type": "photo",
"description": "Photo of the chat; for bots only; may be null"
}
]
},
{
"name": "richTextPlain",
"description": "A plain text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text"
}
]
},
{
"name": "richTextBold",
"description": "A bold rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextItalic",
"description": "An italicized rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextUnderline",
"description": "An underlined rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextStrikethrough",
"description": "A strikethrough rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextFixed",
"description": "A fixed-width rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextUrl",
"description": "A rich text URL link",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
},
{
"name": "url",
"type": "string",
"description": "URL"
},
{
"name": "is_cached",
"type": "Bool",
"description": "True, if the URL has cached instant view server-side"
}
]
},
{
"name": "richTextEmailAddress",
"description": "A rich text email link",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
},
{
"name": "email_address",
"type": "string",
"description": "Email address"
}
]
},
{
"name": "richTextSubscript",
"description": "A subscript rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextSuperscript",
"description": "A superscript rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextMarked",
"description": "A marked rich text",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
}
]
},
{
"name": "richTextPhoneNumber",
"description": "A rich text phone number",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Text"
},
{
"name": "phone_number",
"type": "string",
"description": "Phone number"
}
]
},
{
"name": "richTextIcon",
"description": "A small image inside the text",
"class": "RichText",
"properties": [
{
"name": "document",
"type": "document",
"description": "The image represented as a document. The image can be in GIF, JPEG or PNG format"
},
{
"name": "width",
"type": "int32",
"description": "Width of a bounding box in which the image must be shown; 0 if unknown"
},
{
"name": "height",
"type": "int32",
"description": "Height of a bounding box in which the image must be shown; 0 if unknown"
}
]
},
{
"name": "richTextReference",
"description": "A reference to a richTexts object on the same web page",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "The text"
},
{
"name": "anchor_name",
"type": "string",
"description": "The name of a richTextAnchor object, which is the first element of the target richTexts object"
},
{
"name": "url",
"type": "string",
"description": "An HTTP URL, opening the reference"
}
]
},
{
"name": "richTextAnchor",
"description": "An anchor",
"class": "RichText",
"properties": [
{
"name": "name",
"type": "string",
"description": "Anchor name"
}
]
},
{
"name": "richTextAnchorLink",
"description": "A link to an anchor on the same web page",
"class": "RichText",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "The link text"
},
{
"name": "anchor_name",
"type": "string",
"description": "The anchor name. If the name is empty, the link must bring back to top"
},
{
"name": "url",
"type": "string",
"description": "An HTTP URL, opening the anchor"
}
]
},
{
"name": "richTexts",
"description": "A concatenation of rich texts",
"class": "RichText",
"properties": [
{
"name": "texts",
"type": "vector\u003cRichText\u003e",
"description": "Texts"
}
]
},
{
"name": "pageBlockCaption",
"description": "Contains a caption of an instant view web page block, consisting of a text and a trailing credit",
"class": "PageBlockCaption",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Content of the caption"
},
{
"name": "credit",
"type": "RichText",
"description": "Block credit (like HTML tag \u003ccite\u003e)"
}
]
},
{
"name": "pageBlockListItem",
"description": "Describes an item of a list page block",
"class": "PageBlockListItem",
"properties": [
{
"name": "label",
"type": "string",
"description": "Item label"
},
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Item blocks"
}
]
},
{
"name": "pageBlockHorizontalAlignmentLeft",
"description": "The content must be left-aligned",
"class": "PageBlockHorizontalAlignment",
"properties": []
},
{
"name": "pageBlockHorizontalAlignmentCenter",
"description": "The content must be center-aligned",
"class": "PageBlockHorizontalAlignment",
"properties": []
},
{
"name": "pageBlockHorizontalAlignmentRight",
"description": "The content must be right-aligned",
"class": "PageBlockHorizontalAlignment",
"properties": []
},
{
"name": "pageBlockVerticalAlignmentTop",
"description": "The content must be top-aligned",
"class": "PageBlockVerticalAlignment",
"properties": []
},
{
"name": "pageBlockVerticalAlignmentMiddle",
"description": "The content must be middle-aligned",
"class": "PageBlockVerticalAlignment",
"properties": []
},
{
"name": "pageBlockVerticalAlignmentBottom",
"description": "The content must be bottom-aligned",
"class": "PageBlockVerticalAlignment",
"properties": []
},
{
"name": "pageBlockTableCell",
"description": "Represents a cell of a table",
"class": "PageBlockTableCell",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Cell text; may be null. If the text is null, then the cell must be invisible"
},
{
"name": "is_header",
"type": "Bool",
"description": "True, if it is a header cell"
},
{
"name": "colspan",
"type": "int32",
"description": "The number of columns the cell spans"
},
{
"name": "rowspan",
"type": "int32",
"description": "The number of rows the cell spans"
},
{
"name": "align",
"type": "PageBlockHorizontalAlignment",
"description": "Horizontal cell content alignment"
},
{
"name": "valign",
"type": "PageBlockVerticalAlignment",
"description": "Vertical cell content alignment"
}
]
},
{
"name": "pageBlockRelatedArticle",
"description": "Contains information about a related article",
"class": "PageBlockRelatedArticle",
"properties": [
{
"name": "url",
"type": "string",
"description": "Related article URL"
},
{
"name": "title",
"type": "string",
"description": "Article title; may be empty"
},
{
"name": "description",
"type": "string",
"description": "Article description; may be empty"
},
{
"name": "photo",
"type": "photo",
"description": "Article photo; may be null"
},
{
"name": "author",
"type": "string",
"description": "Article author; may be empty"
},
{
"name": "publish_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the article was published; 0 if unknown"
}
]
},
{
"name": "pageBlockTitle",
"description": "The title of a page",
"class": "PageBlock",
"properties": [
{
"name": "title",
"type": "RichText",
"description": "Title"
}
]
},
{
"name": "pageBlockSubtitle",
"description": "The subtitle of a page",
"class": "PageBlock",
"properties": [
{
"name": "subtitle",
"type": "RichText",
"description": "Subtitle"
}
]
},
{
"name": "pageBlockAuthorDate",
"description": "The author and publishing date of a page",
"class": "PageBlock",
"properties": [
{
"name": "author",
"type": "RichText",
"description": "Author"
},
{
"name": "publish_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the article was published; 0 if unknown"
}
]
},
{
"name": "pageBlockHeader",
"description": "A header",
"class": "PageBlock",
"properties": [
{
"name": "header",
"type": "RichText",
"description": "Header"
}
]
},
{
"name": "pageBlockSubheader",
"description": "A subheader",
"class": "PageBlock",
"properties": [
{
"name": "subheader",
"type": "RichText",
"description": "Subheader"
}
]
},
{
"name": "pageBlockKicker",
"description": "A kicker",
"class": "PageBlock",
"properties": [
{
"name": "kicker",
"type": "RichText",
"description": "Kicker"
}
]
},
{
"name": "pageBlockParagraph",
"description": "A text paragraph",
"class": "PageBlock",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Paragraph text"
}
]
},
{
"name": "pageBlockPreformatted",
"description": "A preformatted text paragraph",
"class": "PageBlock",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Paragraph text"
},
{
"name": "language",
"type": "string",
"description": "Programming language for which the text needs to be formatted"
}
]
},
{
"name": "pageBlockFooter",
"description": "The footer of a page",
"class": "PageBlock",
"properties": [
{
"name": "footer",
"type": "RichText",
"description": "Footer"
}
]
},
{
"name": "pageBlockDivider",
"description": "An empty block separating a page",
"class": "PageBlock",
"properties": []
},
{
"name": "pageBlockAnchor",
"description": "An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor",
"class": "PageBlock",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the anchor"
}
]
},
{
"name": "pageBlockList",
"description": "A list of data blocks",
"class": "PageBlock",
"properties": [
{
"name": "items",
"type": "vector\u003cpageBlockListItem\u003e",
"description": "The items of the list"
}
]
},
{
"name": "pageBlockBlockQuote",
"description": "A block quote",
"class": "PageBlock",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Quote text"
},
{
"name": "credit",
"type": "RichText",
"description": "Quote credit"
}
]
},
{
"name": "pageBlockPullQuote",
"description": "A pull quote",
"class": "PageBlock",
"properties": [
{
"name": "text",
"type": "RichText",
"description": "Quote text"
},
{
"name": "credit",
"type": "RichText",
"description": "Quote credit"
}
]
},
{
"name": "pageBlockAnimation",
"description": "An animation",
"class": "PageBlock",
"properties": [
{
"name": "animation",
"type": "animation",
"description": "Animation file; may be null"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Animation caption"
},
{
"name": "need_autoplay",
"type": "Bool",
"description": "True, if the animation must be played automatically"
}
]
},
{
"name": "pageBlockAudio",
"description": "An audio file",
"class": "PageBlock",
"properties": [
{
"name": "audio",
"type": "audio",
"description": "Audio file; may be null"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Audio file caption"
}
]
},
{
"name": "pageBlockPhoto",
"description": "A photo",
"class": "PageBlock",
"properties": [
{
"name": "photo",
"type": "photo",
"description": "Photo file; may be null"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Photo caption"
},
{
"name": "url",
"type": "string",
"description": "URL that needs to be opened when the photo is clicked"
}
]
},
{
"name": "pageBlockVideo",
"description": "A video",
"class": "PageBlock",
"properties": [
{
"name": "video",
"type": "video",
"description": "Video file; may be null"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Video caption"
},
{
"name": "need_autoplay",
"type": "Bool",
"description": "True, if the video must be played automatically"
},
{
"name": "is_looped",
"type": "Bool",
"description": "True, if the video must be looped"
}
]
},
{
"name": "pageBlockVoiceNote",
"description": "A voice note",
"class": "PageBlock",
"properties": [
{
"name": "voice_note",
"type": "voiceNote",
"description": "Voice note; may be null"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Voice note caption"
}
]
},
{
"name": "pageBlockCover",
"description": "A page cover",
"class": "PageBlock",
"properties": [
{
"name": "cover",
"type": "PageBlock",
"description": "Cover"
}
]
},
{
"name": "pageBlockEmbedded",
"description": "An embedded web page",
"class": "PageBlock",
"properties": [
{
"name": "url",
"type": "string",
"description": "Web page URL, if available"
},
{
"name": "html",
"type": "string",
"description": "HTML-markup of the embedded page"
},
{
"name": "poster_photo",
"type": "photo",
"description": "Poster photo, if available; may be null"
},
{
"name": "width",
"type": "int32",
"description": "Block width; 0 if unknown"
},
{
"name": "height",
"type": "int32",
"description": "Block height; 0 if unknown"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Block caption"
},
{
"name": "is_full_width",
"type": "Bool",
"description": "True, if the block must be full width"
},
{
"name": "allow_scrolling",
"type": "Bool",
"description": "True, if scrolling needs to be allowed"
}
]
},
{
"name": "pageBlockEmbeddedPost",
"description": "An embedded post",
"class": "PageBlock",
"properties": [
{
"name": "url",
"type": "string",
"description": "Web page URL"
},
{
"name": "author",
"type": "string",
"description": "Post author"
},
{
"name": "author_photo",
"type": "photo",
"description": "Post author photo; may be null"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the post was created; 0 if unknown"
},
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Post content"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Post caption"
}
]
},
{
"name": "pageBlockCollage",
"description": "A collage",
"class": "PageBlock",
"properties": [
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Collage item contents"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Block caption"
}
]
},
{
"name": "pageBlockSlideshow",
"description": "A slideshow",
"class": "PageBlock",
"properties": [
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Slideshow item contents"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Block caption"
}
]
},
{
"name": "pageBlockChatLink",
"description": "A link to a chat",
"class": "PageBlock",
"properties": [
{
"name": "title",
"type": "string",
"description": "Chat title"
},
{
"name": "photo",
"type": "chatPhotoInfo",
"description": "Chat photo; may be null"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color for chat title and background of chat photo"
},
{
"name": "username",
"type": "string",
"description": "Chat username by which all other information about the chat can be resolved"
}
]
},
{
"name": "pageBlockTable",
"description": "A table",
"class": "PageBlock",
"properties": [
{
"name": "caption",
"type": "RichText",
"description": "Table caption"
},
{
"name": "cells",
"type": "vector\u003cvector\u003cpageBlockTableCell\u003e\u003e",
"description": "Table cells"
},
{
"name": "is_bordered",
"type": "Bool",
"description": "True, if the table is bordered"
},
{
"name": "is_striped",
"type": "Bool",
"description": "True, if the table is striped"
}
]
},
{
"name": "pageBlockDetails",
"description": "A collapsible block",
"class": "PageBlock",
"properties": [
{
"name": "header",
"type": "RichText",
"description": "Always visible heading for the block"
},
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Block contents"
},
{
"name": "is_open",
"type": "Bool",
"description": "True, if the block is open by default"
}
]
},
{
"name": "pageBlockRelatedArticles",
"description": "Related articles",
"class": "PageBlock",
"properties": [
{
"name": "header",
"type": "RichText",
"description": "Block header"
},
{
"name": "articles",
"type": "vector\u003cpageBlockRelatedArticle\u003e",
"description": "List of related articles"
}
]
},
{
"name": "pageBlockMap",
"description": "A map",
"class": "PageBlock",
"properties": [
{
"name": "location",
"type": "location",
"description": "Location of the map center"
},
{
"name": "zoom",
"type": "int32",
"description": "Map zoom level"
},
{
"name": "width",
"type": "int32",
"description": "Map width"
},
{
"name": "height",
"type": "int32",
"description": "Map height"
},
{
"name": "caption",
"type": "pageBlockCaption",
"description": "Block caption"
}
]
},
{
"name": "webPageInstantView",
"description": "Describes an instant view page for a web page",
"class": "WebPageInstantView",
"properties": [
{
"name": "page_blocks",
"type": "vector\u003cPageBlock\u003e",
"description": "Content of the web page"
},
{
"name": "view_count",
"type": "int32",
"description": "Number of the instant view views; 0 if unknown"
},
{
"name": "version",
"type": "int32",
"description": "Version of the instant view; currently, can be 1 or 2"
},
{
"name": "is_rtl",
"type": "Bool",
"description": "True, if the instant view must be shown from right to left"
},
{
"name": "is_full",
"type": "Bool",
"description": "True, if the instant view contains the full page. A network request might be needed to get the full web page instant view"
},
{
"name": "feedback_link",
"type": "InternalLinkType",
"description": "An internal link to be opened to leave feedback about the instant view"
}
]
},
{
"name": "webPage",
"description": "Describes a link preview",
"class": "WebPage",
"properties": [
{
"name": "url",
"type": "string",
"description": "Original URL of the link"
},
{
"name": "display_url",
"type": "string",
"description": "URL to display"
},
{
"name": "type",
"type": "string",
"description": "Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else"
},
{
"name": "site_name",
"type": "string",
"description": "Short name of the site (e.g., Google Docs, App Store)"
},
{
"name": "title",
"type": "string",
"description": "Title of the content"
},
{
"name": "description",
"type": "formattedText",
"description": "Description of the content"
},
{
"name": "photo",
"type": "photo",
"description": "Image representing the content; may be null"
},
{
"name": "embed_url",
"type": "string",
"description": "URL to show in the embedded preview"
},
{
"name": "embed_type",
"type": "string",
"description": "MIME type of the embedded preview, (e.g., text/html or video/mp4)"
},
{
"name": "embed_width",
"type": "int32",
"description": "Width of the embedded preview"
},
{
"name": "embed_height",
"type": "int32",
"description": "Height of the embedded preview"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the content, in seconds"
},
{
"name": "author",
"type": "string",
"description": "Author of the content"
},
{
"name": "has_large_media",
"type": "Bool",
"description": "True, if size of media in the preview can be changed"
},
{
"name": "show_large_media",
"type": "Bool",
"description": "True, if large media preview must be shown; otherwise, the media preview must be shown small and only the first frame must be shown for videos"
},
{
"name": "skip_confirmation",
"type": "Bool",
"description": "True, if there is no need to show an ordinary open URL confirmation, when opening the URL from the preview, because the URL is shown in the message text in clear"
},
{
"name": "show_above_text",
"type": "Bool",
"description": "True, if the link preview must be shown above message text; otherwise, the link preview must be shown below the message text"
},
{
"name": "animation",
"type": "animation",
"description": "Preview of the content as an animation, if available; may be null"
},
{
"name": "audio",
"type": "audio",
"description": "Preview of the content as an audio file, if available; may be null"
},
{
"name": "document",
"type": "document",
"description": "Preview of the content as a document, if available; may be null"
},
{
"name": "sticker",
"type": "sticker",
"description": "Preview of the content as a sticker for small WEBP files, if available; may be null"
},
{
"name": "video",
"type": "video",
"description": "Preview of the content as a video, if available; may be null"
},
{
"name": "video_note",
"type": "videoNote",
"description": "Preview of the content as a video note, if available; may be null"
},
{
"name": "voice_note",
"type": "voiceNote",
"description": "Preview of the content as a voice note, if available; may be null"
},
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the previewed story; 0 if none"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the previewed story; 0 if none"
},
{
"name": "instant_view_version",
"type": "int32",
"description": "Version of web page instant view (currently, can be 1 or 2); 0 if none"
}
]
},
{
"name": "countryInfo",
"description": "Contains information about a country",
"class": "CountryInfo",
"properties": [
{
"name": "country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code"
},
{
"name": "name",
"type": "string",
"description": "Native name of the country"
},
{
"name": "english_name",
"type": "string",
"description": "English name of the country"
},
{
"name": "is_hidden",
"type": "Bool",
"description": "True, if the country must be hidden from the list of all countries"
},
{
"name": "calling_codes",
"type": "vector\u003cstring\u003e",
"description": "List of country calling codes"
}
]
},
{
"name": "countries",
"description": "Contains information about countries",
"class": "Countries",
"properties": [
{
"name": "countries",
"type": "vector\u003ccountryInfo\u003e",
"description": "The list of countries"
}
]
},
{
"name": "phoneNumberInfo",
"description": "Contains information about a phone number",
"class": "PhoneNumberInfo",
"properties": [
{
"name": "country",
"type": "countryInfo",
"description": "Information about the country to which the phone number belongs; may be null"
},
{
"name": "country_calling_code",
"type": "string",
"description": "The part of the phone number denoting country calling code or its part"
},
{
"name": "formatted_phone_number",
"type": "string",
"description": "The phone number without country calling code formatted accordingly to local rules. Expected digits are returned as '-', but even more digits might be entered by the user"
},
{
"name": "is_anonymous",
"type": "Bool",
"description": "True, if the phone number was bought at https://fragment.com and isn't tied to a SIM card. Information about the phone number can be received using getCollectibleItemInfo"
}
]
},
{
"name": "collectibleItemTypeUsername",
"description": "A username",
"class": "CollectibleItemType",
"properties": [
{
"name": "username",
"type": "string",
"description": "The username"
}
]
},
{
"name": "collectibleItemTypePhoneNumber",
"description": "A phone number",
"class": "CollectibleItemType",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "The phone number"
}
]
},
{
"name": "collectibleItemInfo",
"description": "Contains information about a collectible item and its last purchase",
"class": "CollectibleItemInfo",
"properties": [
{
"name": "purchase_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the item was purchased"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the paid amount"
},
{
"name": "amount",
"type": "int53",
"description": "The paid amount, in the smallest units of the currency"
},
{
"name": "cryptocurrency",
"type": "string",
"description": "Cryptocurrency used to pay for the item"
},
{
"name": "cryptocurrency_amount",
"type": "int64",
"description": "The paid amount, in the smallest units of the cryptocurrency"
},
{
"name": "url",
"type": "string",
"description": "Individual URL for the item on https://fragment.com"
}
]
},
{
"name": "bankCardActionOpenUrl",
"description": "Describes an action associated with a bank card number",
"class": "BankCardActionOpenUrl",
"properties": [
{
"name": "text",
"type": "string",
"description": "Action text"
},
{
"name": "url",
"type": "string",
"description": "The URL to be opened"
}
]
},
{
"name": "bankCardInfo",
"description": "Information about a bank card",
"class": "BankCardInfo",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the bank card description"
},
{
"name": "actions",
"type": "vector\u003cbankCardActionOpenUrl\u003e",
"description": "Actions that can be done with the bank card number"
}
]
},
{
"name": "address",
"description": "Describes an address",
"class": "Address",
"properties": [
{
"name": "country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code"
},
{
"name": "state",
"type": "string",
"description": "State, if applicable"
},
{
"name": "city",
"type": "string",
"description": "City"
},
{
"name": "street_line1",
"type": "string",
"description": "First line of the address"
},
{
"name": "street_line2",
"type": "string",
"description": "Second line of the address"
},
{
"name": "postal_code",
"type": "string",
"description": "Address postal code"
}
]
},
{
"name": "themeParameters",
"description": "Contains parameters of the application theme",
"class": "ThemeParameters",
"properties": [
{
"name": "background_color",
"type": "int32",
"description": "A color of the background in the RGB24 format"
},
{
"name": "secondary_background_color",
"type": "int32",
"description": "A secondary color for the background in the RGB24 format"
},
{
"name": "header_background_color",
"type": "int32",
"description": "A color of the header background in the RGB24 format"
},
{
"name": "section_background_color",
"type": "int32",
"description": "A color of the section background in the RGB24 format"
},
{
"name": "text_color",
"type": "int32",
"description": "A color of text in the RGB24 format"
},
{
"name": "accent_text_color",
"type": "int32",
"description": "An accent color of the text in the RGB24 format"
},
{
"name": "section_header_text_color",
"type": "int32",
"description": "A color of text on the section headers in the RGB24 format"
},
{
"name": "subtitle_text_color",
"type": "int32",
"description": "A color of the subtitle text in the RGB24 format"
},
{
"name": "destructive_text_color",
"type": "int32",
"description": "A color of the text for destructive actions in the RGB24 format"
},
{
"name": "hint_color",
"type": "int32",
"description": "A color of hints in the RGB24 format"
},
{
"name": "link_color",
"type": "int32",
"description": "A color of links in the RGB24 format"
},
{
"name": "button_color",
"type": "int32",
"description": "A color of the buttons in the RGB24 format"
},
{
"name": "button_text_color",
"type": "int32",
"description": "A color of text on the buttons in the RGB24 format"
}
]
},
{
"name": "labeledPricePart",
"description": "Portion of the price of a product (e.g., \"delivery cost\", \"tax amount\")",
"class": "LabeledPricePart",
"properties": [
{
"name": "label",
"type": "string",
"description": "Label for this portion of the product price"
},
{
"name": "amount",
"type": "int53",
"description": "Currency amount in the smallest units of the currency"
}
]
},
{
"name": "invoice",
"description": "Product invoice",
"class": "Invoice",
"properties": [
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code"
},
{
"name": "price_parts",
"type": "vector\u003clabeledPricePart\u003e",
"description": "A list of objects used to calculate the total price of the product"
},
{
"name": "max_tip_amount",
"type": "int53",
"description": "The maximum allowed amount of tip in the smallest units of the currency"
},
{
"name": "suggested_tip_amounts",
"type": "vector\u003cint53\u003e",
"description": "Suggested amounts of tip in the smallest units of the currency"
},
{
"name": "recurring_payment_terms_of_service_url",
"type": "string",
"description": "An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay"
},
{
"name": "terms_of_service_url",
"type": "string",
"description": "An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay"
},
{
"name": "is_test",
"type": "Bool",
"description": "True, if the payment is a test payment"
},
{
"name": "need_name",
"type": "Bool",
"description": "True, if the user's name is needed for payment"
},
{
"name": "need_phone_number",
"type": "Bool",
"description": "True, if the user's phone number is needed for payment"
},
{
"name": "need_email_address",
"type": "Bool",
"description": "True, if the user's email address is needed for payment"
},
{
"name": "need_shipping_address",
"type": "Bool",
"description": "True, if the user's shipping address is needed for payment"
},
{
"name": "send_phone_number_to_provider",
"type": "Bool",
"description": "True, if the user's phone number will be sent to the provider"
},
{
"name": "send_email_address_to_provider",
"type": "Bool",
"description": "True, if the user's email address will be sent to the provider"
},
{
"name": "is_flexible",
"type": "Bool",
"description": "True, if the total price depends on the shipping method"
}
]
},
{
"name": "orderInfo",
"description": "Order information",
"class": "OrderInfo",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the user"
},
{
"name": "phone_number",
"type": "string",
"description": "Phone number of the user"
},
{
"name": "email_address",
"type": "string",
"description": "Email address of the user"
},
{
"name": "shipping_address",
"type": "address",
"description": "Shipping address for this order; may be null"
}
]
},
{
"name": "shippingOption",
"description": "One shipping option",
"class": "ShippingOption",
"properties": [
{
"name": "id",
"type": "string",
"description": "Shipping option identifier"
},
{
"name": "title",
"type": "string",
"description": "Option title"
},
{
"name": "price_parts",
"type": "vector\u003clabeledPricePart\u003e",
"description": "A list of objects used to calculate the total shipping costs"
}
]
},
{
"name": "savedCredentials",
"description": "Contains information about saved payment credentials",
"class": "SavedCredentials",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the saved credentials"
},
{
"name": "title",
"type": "string",
"description": "Title of the saved credentials"
}
]
},
{
"name": "inputCredentialsSaved",
"description": "Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password",
"class": "InputCredentials",
"properties": [
{
"name": "saved_credentials_id",
"type": "string",
"description": "Identifier of the saved credentials"
}
]
},
{
"name": "inputCredentialsNew",
"description": "Applies if a user enters new credentials on a payment provider website",
"class": "InputCredentials",
"properties": [
{
"name": "data",
"type": "string",
"description": "JSON-encoded data with the credential identifier from the payment provider"
},
{
"name": "allow_save",
"type": "Bool",
"description": "True, if the credential identifier can be saved on the server side"
}
]
},
{
"name": "inputCredentialsApplePay",
"description": "Applies if a user enters new credentials using Apple Pay",
"class": "InputCredentials",
"properties": [
{
"name": "data",
"type": "string",
"description": "JSON-encoded data with the credential identifier"
}
]
},
{
"name": "inputCredentialsGooglePay",
"description": "Applies if a user enters new credentials using Google Pay",
"class": "InputCredentials",
"properties": [
{
"name": "data",
"type": "string",
"description": "JSON-encoded data with the credential identifier"
}
]
},
{
"name": "paymentProviderSmartGlocal",
"description": "Smart Glocal payment provider",
"class": "PaymentProvider",
"properties": [
{
"name": "public_token",
"type": "string",
"description": "Public payment token"
},
{
"name": "tokenize_url",
"type": "string",
"description": "URL for sending card tokenization requests"
}
]
},
{
"name": "paymentProviderStripe",
"description": "Stripe payment provider",
"class": "PaymentProvider",
"properties": [
{
"name": "publishable_key",
"type": "string",
"description": "Stripe API publishable key"
},
{
"name": "need_country",
"type": "Bool",
"description": "True, if the user country must be provided"
},
{
"name": "need_postal_code",
"type": "Bool",
"description": "True, if the user ZIP/postal code must be provided"
},
{
"name": "need_cardholder_name",
"type": "Bool",
"description": "True, if the cardholder name must be provided"
}
]
},
{
"name": "paymentProviderOther",
"description": "Some other payment provider, for which a web payment form must be shown",
"class": "PaymentProvider",
"properties": [
{
"name": "url",
"type": "string",
"description": "Payment form URL"
}
]
},
{
"name": "paymentOption",
"description": "Describes an additional payment option",
"class": "PaymentOption",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title for the payment option"
},
{
"name": "url",
"type": "string",
"description": "Payment form URL to be opened in a web view"
}
]
},
{
"name": "paymentForm",
"description": "Contains information about an invoice payment form",
"class": "PaymentForm",
"properties": [
{
"name": "id",
"type": "int64",
"description": "The payment form identifier"
},
{
"name": "invoice",
"type": "invoice",
"description": "Full information about the invoice"
},
{
"name": "seller_bot_user_id",
"type": "int53",
"description": "User identifier of the seller bot"
},
{
"name": "payment_provider_user_id",
"type": "int53",
"description": "User identifier of the payment provider bot"
},
{
"name": "payment_provider",
"type": "PaymentProvider",
"description": "Information about the payment provider"
},
{
"name": "additional_payment_options",
"type": "vector\u003cpaymentOption\u003e",
"description": "The list of additional payment options"
},
{
"name": "saved_order_info",
"type": "orderInfo",
"description": "Saved server-side order information; may be null"
},
{
"name": "saved_credentials",
"type": "vector\u003csavedCredentials\u003e",
"description": "The list of saved payment credentials"
},
{
"name": "can_save_credentials",
"type": "Bool",
"description": "True, if the user can choose to save credentials"
},
{
"name": "need_password",
"type": "Bool",
"description": "True, if the user will be able to save credentials, if sets up a 2-step verification password"
},
{
"name": "product_title",
"type": "string",
"description": "Product title"
},
{
"name": "product_description",
"type": "formattedText",
"description": "Product description"
},
{
"name": "product_photo",
"type": "photo",
"description": "Product photo; may be null"
}
]
},
{
"name": "validatedOrderInfo",
"description": "Contains a temporary identifier of validated order information, which is stored for one hour, and the available shipping options",
"class": "ValidatedOrderInfo",
"properties": [
{
"name": "order_info_id",
"type": "string",
"description": "Temporary identifier of the order information"
},
{
"name": "shipping_options",
"type": "vector\u003cshippingOption\u003e",
"description": "Available shipping options"
}
]
},
{
"name": "paymentResult",
"description": "Contains the result of a payment request",
"class": "PaymentResult",
"properties": [
{
"name": "success",
"type": "Bool",
"description": "True, if the payment request was successful; otherwise, the verification_url will be non-empty"
},
{
"name": "verification_url",
"type": "string",
"description": "URL for additional payment credentials verification"
}
]
},
{
"name": "paymentReceipt",
"description": "Contains information about a successful payment",
"class": "PaymentReceipt",
"properties": [
{
"name": "title",
"type": "string",
"description": "Product title"
},
{
"name": "description",
"type": "formattedText",
"description": "Product description"
},
{
"name": "photo",
"type": "photo",
"description": "Product photo; may be null"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the payment was made"
},
{
"name": "seller_bot_user_id",
"type": "int53",
"description": "User identifier of the seller bot"
},
{
"name": "payment_provider_user_id",
"type": "int53",
"description": "User identifier of the payment provider bot"
},
{
"name": "invoice",
"type": "invoice",
"description": "Information about the invoice"
},
{
"name": "order_info",
"type": "orderInfo",
"description": "Order information; may be null"
},
{
"name": "shipping_option",
"type": "shippingOption",
"description": "Chosen shipping option; may be null"
},
{
"name": "credentials_title",
"type": "string",
"description": "Title of the saved credentials chosen by the buyer"
},
{
"name": "tip_amount",
"type": "int53",
"description": "The amount of tip chosen by the buyer in the smallest units of the currency"
}
]
},
{
"name": "inputInvoiceMessage",
"description": "An invoice from a message of the type messageInvoice",
"class": "InputInvoice",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
}
]
},
{
"name": "inputInvoiceName",
"description": "An invoice from a link of the type internalLinkTypeInvoice",
"class": "InputInvoice",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the invoice"
}
]
},
{
"name": "inputInvoiceTelegram",
"description": "An invoice for a payment toward Telegram; must not be used in the in-store apps",
"class": "InputInvoice",
"properties": [
{
"name": "purpose",
"type": "TelegramPaymentPurpose",
"description": "Transaction purpose"
}
]
},
{
"name": "messageExtendedMediaPreview",
"description": "The media is hidden until the invoice is paid",
"class": "MessageExtendedMedia",
"properties": [
{
"name": "width",
"type": "int32",
"description": "Media width; 0 if unknown"
},
{
"name": "height",
"type": "int32",
"description": "Media height; 0 if unknown"
},
{
"name": "duration",
"type": "int32",
"description": "Media duration, in seconds; 0 if unknown"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Media minithumbnail; may be null"
},
{
"name": "caption",
"type": "formattedText",
"description": "Media caption"
}
]
},
{
"name": "messageExtendedMediaPhoto",
"description": "The media is a photo",
"class": "MessageExtendedMedia",
"properties": [
{
"name": "photo",
"type": "photo",
"description": "The photo"
},
{
"name": "caption",
"type": "formattedText",
"description": "Photo caption"
}
]
},
{
"name": "messageExtendedMediaVideo",
"description": "The media is a video",
"class": "MessageExtendedMedia",
"properties": [
{
"name": "video",
"type": "video",
"description": "The video"
},
{
"name": "caption",
"type": "formattedText",
"description": "Photo caption"
}
]
},
{
"name": "messageExtendedMediaUnsupported",
"description": "The media is unsupported",
"class": "MessageExtendedMedia",
"properties": [
{
"name": "caption",
"type": "formattedText",
"description": "Media caption"
}
]
},
{
"name": "premiumGiveawayParameters",
"description": "Describes parameters of a Telegram Premium giveaway",
"class": "PremiumGiveawayParameters",
"properties": [
{
"name": "boosted_chat_id",
"type": "int53",
"description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the winners of the giveaway for duration of the Premium subscription. If the chat is a channel, then can_post_messages right is required in the channel, otherwise, the user must be an administrator in the supergroup"
},
{
"name": "additional_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of other supergroup or channel chats that must be subscribed by the users to be eligible for the giveaway. There can be up to getOption(\"giveaway_additional_chat_count_max\") additional chats"
},
{
"name": "winners_selection_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the giveaway is expected to be performed; must be 60-getOption(\"giveaway_duration_max\") seconds in the future in scheduled giveaways"
},
{
"name": "only_new_members",
"type": "Bool",
"description": "True, if only new members of the chats will be eligible for the giveaway"
},
{
"name": "has_public_winners",
"type": "Bool",
"description": "True, if the list of winners of the giveaway will be available to everyone"
},
{
"name": "country_codes",
"type": "vector\u003cstring\u003e",
"description": "The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be eligible for the giveaway. If empty, then all users can participate in the giveaway. There can be up to getOption(\"giveaway_country_count_max\") chosen countries. Users with phone number that was bought at https://fragment.com can participate in any giveaway and the country code \"FT\" must not be specified in the list"
},
{
"name": "prize_description",
"type": "string",
"description": "Additional description of the giveaway prize; 0-128 characters"
}
]
},
{
"name": "datedFile",
"description": "File with the date it was uploaded",
"class": "DatedFile",
"properties": [
{
"name": "file",
"type": "file",
"description": "The file"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the file was uploaded"
}
]
},
{
"name": "passportElementTypePersonalDetails",
"description": "A Telegram Passport element containing the user's personal details",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypePassport",
"description": "A Telegram Passport element containing the user's passport",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeDriverLicense",
"description": "A Telegram Passport element containing the user's driver license",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeIdentityCard",
"description": "A Telegram Passport element containing the user's identity card",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeInternalPassport",
"description": "A Telegram Passport element containing the user's internal passport",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeAddress",
"description": "A Telegram Passport element containing the user's address",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeUtilityBill",
"description": "A Telegram Passport element containing the user's utility bill",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeBankStatement",
"description": "A Telegram Passport element containing the user's bank statement",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeRentalAgreement",
"description": "A Telegram Passport element containing the user's rental agreement",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypePassportRegistration",
"description": "A Telegram Passport element containing the registration page of the user's passport",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeTemporaryRegistration",
"description": "A Telegram Passport element containing the user's temporary registration",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypePhoneNumber",
"description": "A Telegram Passport element containing the user's phone number",
"class": "PassportElementType",
"properties": []
},
{
"name": "passportElementTypeEmailAddress",
"description": "A Telegram Passport element containing the user's email address",
"class": "PassportElementType",
"properties": []
},
{
"name": "date",
"description": "Represents a date according to the Gregorian calendar",
"class": "Date",
"properties": [
{
"name": "day",
"type": "int32",
"description": "Day of the month; 1-31"
},
{
"name": "month",
"type": "int32",
"description": "Month; 1-12"
},
{
"name": "year",
"type": "int32",
"description": "Year; 1-9999"
}
]
},
{
"name": "personalDetails",
"description": "Contains the user's personal details",
"class": "PersonalDetails",
"properties": [
{
"name": "first_name",
"type": "string",
"description": "First name of the user written in English; 1-255 characters"
},
{
"name": "middle_name",
"type": "string",
"description": "Middle name of the user written in English; 0-255 characters"
},
{
"name": "last_name",
"type": "string",
"description": "Last name of the user written in English; 1-255 characters"
},
{
"name": "native_first_name",
"type": "string",
"description": "Native first name of the user; 1-255 characters"
},
{
"name": "native_middle_name",
"type": "string",
"description": "Native middle name of the user; 0-255 characters"
},
{
"name": "native_last_name",
"type": "string",
"description": "Native last name of the user; 1-255 characters"
},
{
"name": "birthdate",
"type": "date",
"description": "Birthdate of the user"
},
{
"name": "gender",
"type": "string",
"description": "Gender of the user, \"male\" or \"female\""
},
{
"name": "country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code of the user's country"
},
{
"name": "residence_country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code of the user's residence country"
}
]
},
{
"name": "identityDocument",
"description": "An identity document",
"class": "IdentityDocument",
"properties": [
{
"name": "number",
"type": "string",
"description": "Document number; 1-24 characters"
},
{
"name": "expiration_date",
"type": "date",
"description": "Document expiration date; may be null if not applicable"
},
{
"name": "front_side",
"type": "datedFile",
"description": "Front side of the document"
},
{
"name": "reverse_side",
"type": "datedFile",
"description": "Reverse side of the document; only for driver license and identity card; may be null"
},
{
"name": "selfie",
"type": "datedFile",
"description": "Selfie with the document; may be null"
},
{
"name": "translation",
"type": "vector\u003cdatedFile\u003e",
"description": "List of files containing a certified English translation of the document"
}
]
},
{
"name": "inputIdentityDocument",
"description": "An identity document to be saved to Telegram Passport",
"class": "InputIdentityDocument",
"properties": [
{
"name": "number",
"type": "string",
"description": "Document number; 1-24 characters"
},
{
"name": "expiration_date",
"type": "date",
"description": "Document expiration date; pass null if not applicable"
},
{
"name": "front_side",
"type": "InputFile",
"description": "Front side of the document"
},
{
"name": "reverse_side",
"type": "InputFile",
"description": "Reverse side of the document; only for driver license and identity card; pass null otherwise"
},
{
"name": "selfie",
"type": "InputFile",
"description": "Selfie with the document; pass null if unavailable"
},
{
"name": "translation",
"type": "vector\u003cInputFile\u003e",
"description": "List of files containing a certified English translation of the document"
}
]
},
{
"name": "personalDocument",
"description": "A personal document, containing some information about a user",
"class": "PersonalDocument",
"properties": [
{
"name": "files",
"type": "vector\u003cdatedFile\u003e",
"description": "List of files containing the pages of the document"
},
{
"name": "translation",
"type": "vector\u003cdatedFile\u003e",
"description": "List of files containing a certified English translation of the document"
}
]
},
{
"name": "inputPersonalDocument",
"description": "A personal document to be saved to Telegram Passport",
"class": "InputPersonalDocument",
"properties": [
{
"name": "files",
"type": "vector\u003cInputFile\u003e",
"description": "List of files containing the pages of the document"
},
{
"name": "translation",
"type": "vector\u003cInputFile\u003e",
"description": "List of files containing a certified English translation of the document"
}
]
},
{
"name": "passportElementPersonalDetails",
"description": "A Telegram Passport element containing the user's personal details",
"class": "PassportElement",
"properties": [
{
"name": "personal_details",
"type": "personalDetails",
"description": "Personal details of the user"
}
]
},
{
"name": "passportElementPassport",
"description": "A Telegram Passport element containing the user's passport",
"class": "PassportElement",
"properties": [
{
"name": "passport",
"type": "identityDocument",
"description": "Passport"
}
]
},
{
"name": "passportElementDriverLicense",
"description": "A Telegram Passport element containing the user's driver license",
"class": "PassportElement",
"properties": [
{
"name": "driver_license",
"type": "identityDocument",
"description": "Driver license"
}
]
},
{
"name": "passportElementIdentityCard",
"description": "A Telegram Passport element containing the user's identity card",
"class": "PassportElement",
"properties": [
{
"name": "identity_card",
"type": "identityDocument",
"description": "Identity card"
}
]
},
{
"name": "passportElementInternalPassport",
"description": "A Telegram Passport element containing the user's internal passport",
"class": "PassportElement",
"properties": [
{
"name": "internal_passport",
"type": "identityDocument",
"description": "Internal passport"
}
]
},
{
"name": "passportElementAddress",
"description": "A Telegram Passport element containing the user's address",
"class": "PassportElement",
"properties": [
{
"name": "address",
"type": "address",
"description": "Address"
}
]
},
{
"name": "passportElementUtilityBill",
"description": "A Telegram Passport element containing the user's utility bill",
"class": "PassportElement",
"properties": [
{
"name": "utility_bill",
"type": "personalDocument",
"description": "Utility bill"
}
]
},
{
"name": "passportElementBankStatement",
"description": "A Telegram Passport element containing the user's bank statement",
"class": "PassportElement",
"properties": [
{
"name": "bank_statement",
"type": "personalDocument",
"description": "Bank statement"
}
]
},
{
"name": "passportElementRentalAgreement",
"description": "A Telegram Passport element containing the user's rental agreement",
"class": "PassportElement",
"properties": [
{
"name": "rental_agreement",
"type": "personalDocument",
"description": "Rental agreement"
}
]
},
{
"name": "passportElementPassportRegistration",
"description": "A Telegram Passport element containing the user's passport registration pages",
"class": "PassportElement",
"properties": [
{
"name": "passport_registration",
"type": "personalDocument",
"description": "Passport registration pages"
}
]
},
{
"name": "passportElementTemporaryRegistration",
"description": "A Telegram Passport element containing the user's temporary registration",
"class": "PassportElement",
"properties": [
{
"name": "temporary_registration",
"type": "personalDocument",
"description": "Temporary registration"
}
]
},
{
"name": "passportElementPhoneNumber",
"description": "A Telegram Passport element containing the user's phone number",
"class": "PassportElement",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "Phone number"
}
]
},
{
"name": "passportElementEmailAddress",
"description": "A Telegram Passport element containing the user's email address",
"class": "PassportElement",
"properties": [
{
"name": "email_address",
"type": "string",
"description": "Email address"
}
]
},
{
"name": "inputPassportElementPersonalDetails",
"description": "A Telegram Passport element to be saved containing the user's personal details",
"class": "InputPassportElement",
"properties": [
{
"name": "personal_details",
"type": "personalDetails",
"description": "Personal details of the user"
}
]
},
{
"name": "inputPassportElementPassport",
"description": "A Telegram Passport element to be saved containing the user's passport",
"class": "InputPassportElement",
"properties": [
{
"name": "passport",
"type": "inputIdentityDocument",
"description": "The passport to be saved"
}
]
},
{
"name": "inputPassportElementDriverLicense",
"description": "A Telegram Passport element to be saved containing the user's driver license",
"class": "InputPassportElement",
"properties": [
{
"name": "driver_license",
"type": "inputIdentityDocument",
"description": "The driver license to be saved"
}
]
},
{
"name": "inputPassportElementIdentityCard",
"description": "A Telegram Passport element to be saved containing the user's identity card",
"class": "InputPassportElement",
"properties": [
{
"name": "identity_card",
"type": "inputIdentityDocument",
"description": "The identity card to be saved"
}
]
},
{
"name": "inputPassportElementInternalPassport",
"description": "A Telegram Passport element to be saved containing the user's internal passport",
"class": "InputPassportElement",
"properties": [
{
"name": "internal_passport",
"type": "inputIdentityDocument",
"description": "The internal passport to be saved"
}
]
},
{
"name": "inputPassportElementAddress",
"description": "A Telegram Passport element to be saved containing the user's address",
"class": "InputPassportElement",
"properties": [
{
"name": "address",
"type": "address",
"description": "The address to be saved"
}
]
},
{
"name": "inputPassportElementUtilityBill",
"description": "A Telegram Passport element to be saved containing the user's utility bill",
"class": "InputPassportElement",
"properties": [
{
"name": "utility_bill",
"type": "inputPersonalDocument",
"description": "The utility bill to be saved"
}
]
},
{
"name": "inputPassportElementBankStatement",
"description": "A Telegram Passport element to be saved containing the user's bank statement",
"class": "InputPassportElement",
"properties": [
{
"name": "bank_statement",
"type": "inputPersonalDocument",
"description": "The bank statement to be saved"
}
]
},
{
"name": "inputPassportElementRentalAgreement",
"description": "A Telegram Passport element to be saved containing the user's rental agreement",
"class": "InputPassportElement",
"properties": [
{
"name": "rental_agreement",
"type": "inputPersonalDocument",
"description": "The rental agreement to be saved"
}
]
},
{
"name": "inputPassportElementPassportRegistration",
"description": "A Telegram Passport element to be saved containing the user's passport registration",
"class": "InputPassportElement",
"properties": [
{
"name": "passport_registration",
"type": "inputPersonalDocument",
"description": "The passport registration page to be saved"
}
]
},
{
"name": "inputPassportElementTemporaryRegistration",
"description": "A Telegram Passport element to be saved containing the user's temporary registration",
"class": "InputPassportElement",
"properties": [
{
"name": "temporary_registration",
"type": "inputPersonalDocument",
"description": "The temporary registration document to be saved"
}
]
},
{
"name": "inputPassportElementPhoneNumber",
"description": "A Telegram Passport element to be saved containing the user's phone number",
"class": "InputPassportElement",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "The phone number to be saved"
}
]
},
{
"name": "inputPassportElementEmailAddress",
"description": "A Telegram Passport element to be saved containing the user's email address",
"class": "InputPassportElement",
"properties": [
{
"name": "email_address",
"type": "string",
"description": "The email address to be saved"
}
]
},
{
"name": "passportElements",
"description": "Contains information about saved Telegram Passport elements",
"class": "PassportElements",
"properties": [
{
"name": "elements",
"type": "vector\u003cPassportElement\u003e",
"description": "Telegram Passport elements"
}
]
},
{
"name": "passportElementErrorSourceUnspecified",
"description": "The element contains an error in an unspecified place. The error will be considered resolved when new data is added",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementErrorSourceDataField",
"description": "One of the data fields contains an error. The error will be considered resolved when the value of the field changes",
"class": "PassportElementErrorSource",
"properties": [
{
"name": "field_name",
"type": "string",
"description": "Field name"
}
]
},
{
"name": "passportElementErrorSourceFrontSide",
"description": "The front side of the document contains an error. The error will be considered resolved when the file with the front side changes",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementErrorSourceReverseSide",
"description": "The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementErrorSourceSelfie",
"description": "The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementErrorSourceTranslationFile",
"description": "One of files with the translation of the document contains an error. The error will be considered resolved when the file changes",
"class": "PassportElementErrorSource",
"properties": [
{
"name": "file_index",
"type": "int32",
"description": "Index of a file with the error"
}
]
},
{
"name": "passportElementErrorSourceTranslationFiles",
"description": "The translation of the document contains an error. The error will be considered resolved when the list of translation files changes",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementErrorSourceFile",
"description": "The file contains an error. The error will be considered resolved when the file changes",
"class": "PassportElementErrorSource",
"properties": [
{
"name": "file_index",
"type": "int32",
"description": "Index of a file with the error"
}
]
},
{
"name": "passportElementErrorSourceFiles",
"description": "The list of attached files contains an error. The error will be considered resolved when the list of files changes",
"class": "PassportElementErrorSource",
"properties": []
},
{
"name": "passportElementError",
"description": "Contains the description of an error in a Telegram Passport element",
"class": "PassportElementError",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Type of the Telegram Passport element which has the error"
},
{
"name": "message",
"type": "string",
"description": "Error message"
},
{
"name": "source",
"type": "PassportElementErrorSource",
"description": "Error source"
}
]
},
{
"name": "passportSuitableElement",
"description": "Contains information about a Telegram Passport element that was requested by a service",
"class": "PassportSuitableElement",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Type of the element"
},
{
"name": "is_selfie_required",
"type": "Bool",
"description": "True, if a selfie is required with the identity document"
},
{
"name": "is_translation_required",
"type": "Bool",
"description": "True, if a certified English translation is required with the document"
},
{
"name": "is_native_name_required",
"type": "Bool",
"description": "True, if personal details must include the user's name in the language of their country of residence"
}
]
},
{
"name": "passportRequiredElement",
"description": "Contains a description of the required Telegram Passport element that was requested by a service",
"class": "PassportRequiredElement",
"properties": [
{
"name": "suitable_elements",
"type": "vector\u003cpassportSuitableElement\u003e",
"description": "List of Telegram Passport elements any of which is enough to provide"
}
]
},
{
"name": "passportAuthorizationForm",
"description": "Contains information about a Telegram Passport authorization form that was requested",
"class": "PassportAuthorizationForm",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique identifier of the authorization form"
},
{
"name": "required_elements",
"type": "vector\u003cpassportRequiredElement\u003e",
"description": "Telegram Passport elements that must be provided to complete the form"
},
{
"name": "privacy_policy_url",
"type": "string",
"description": "URL for the privacy policy of the service; may be empty"
}
]
},
{
"name": "passportElementsWithErrors",
"description": "Contains information about a Telegram Passport elements and corresponding errors",
"class": "PassportElementsWithErrors",
"properties": [
{
"name": "elements",
"type": "vector\u003cPassportElement\u003e",
"description": "Telegram Passport elements"
},
{
"name": "errors",
"type": "vector\u003cpassportElementError\u003e",
"description": "Errors in the elements that are already available"
}
]
},
{
"name": "encryptedCredentials",
"description": "Contains encrypted Telegram Passport data credentials",
"class": "EncryptedCredentials",
"properties": [
{
"name": "data",
"type": "bytes",
"description": "The encrypted credentials"
},
{
"name": "hash",
"type": "bytes",
"description": "The decrypted data hash"
},
{
"name": "secret",
"type": "bytes",
"description": "Secret for data decryption, encrypted with the service's public key"
}
]
},
{
"name": "encryptedPassportElement",
"description": "Contains information about an encrypted Telegram Passport element; for bots only",
"class": "EncryptedPassportElement",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Type of Telegram Passport element"
},
{
"name": "data",
"type": "bytes",
"description": "Encrypted JSON-encoded data about the user"
},
{
"name": "front_side",
"type": "datedFile",
"description": "The front side of an identity document"
},
{
"name": "reverse_side",
"type": "datedFile",
"description": "The reverse side of an identity document; may be null"
},
{
"name": "selfie",
"type": "datedFile",
"description": "Selfie with the document; may be null"
},
{
"name": "translation",
"type": "vector\u003cdatedFile\u003e",
"description": "List of files containing a certified English translation of the document"
},
{
"name": "files",
"type": "vector\u003cdatedFile\u003e",
"description": "List of attached files"
},
{
"name": "value",
"type": "string",
"description": "Unencrypted data, phone number or email address"
},
{
"name": "hash",
"type": "string",
"description": "Hash of the entire element"
}
]
},
{
"name": "inputPassportElementErrorSourceUnspecified",
"description": "The element contains an error in an unspecified place. The error will be considered resolved when new data is added",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "element_hash",
"type": "bytes",
"description": "Current hash of the entire element"
}
]
},
{
"name": "inputPassportElementErrorSourceDataField",
"description": "A data field contains an error. The error is considered resolved when the field's value changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "field_name",
"type": "string",
"description": "Field name"
},
{
"name": "data_hash",
"type": "bytes",
"description": "Current data hash"
}
]
},
{
"name": "inputPassportElementErrorSourceFrontSide",
"description": "The front side of the document contains an error. The error is considered resolved when the file with the front side of the document changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hash",
"type": "bytes",
"description": "Current hash of the file containing the front side"
}
]
},
{
"name": "inputPassportElementErrorSourceReverseSide",
"description": "The reverse side of the document contains an error. The error is considered resolved when the file with the reverse side of the document changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hash",
"type": "bytes",
"description": "Current hash of the file containing the reverse side"
}
]
},
{
"name": "inputPassportElementErrorSourceSelfie",
"description": "The selfie contains an error. The error is considered resolved when the file with the selfie changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hash",
"type": "bytes",
"description": "Current hash of the file containing the selfie"
}
]
},
{
"name": "inputPassportElementErrorSourceTranslationFile",
"description": "One of the files containing the translation of the document contains an error. The error is considered resolved when the file with the translation changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hash",
"type": "bytes",
"description": "Current hash of the file containing the translation"
}
]
},
{
"name": "inputPassportElementErrorSourceTranslationFiles",
"description": "The translation of the document contains an error. The error is considered resolved when the list of files changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hashes",
"type": "vector\u003cbytes\u003e",
"description": "Current hashes of all files with the translation"
}
]
},
{
"name": "inputPassportElementErrorSourceFile",
"description": "The file contains an error. The error is considered resolved when the file changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hash",
"type": "bytes",
"description": "Current hash of the file which has the error"
}
]
},
{
"name": "inputPassportElementErrorSourceFiles",
"description": "The list of attached files contains an error. The error is considered resolved when the file list changes",
"class": "InputPassportElementErrorSource",
"properties": [
{
"name": "file_hashes",
"type": "vector\u003cbytes\u003e",
"description": "Current hashes of all attached files"
}
]
},
{
"name": "inputPassportElementError",
"description": "Contains the description of an error in a Telegram Passport element; for bots only",
"class": "InputPassportElementError",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Type of Telegram Passport element that has the error"
},
{
"name": "message",
"type": "string",
"description": "Error message"
},
{
"name": "source",
"type": "InputPassportElementErrorSource",
"description": "Error source"
}
]
},
{
"name": "messageText",
"description": "A text message",
"class": "MessageContent",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text of the message"
},
{
"name": "web_page",
"type": "webPage",
"description": "A link preview attached to the message; may be null"
},
{
"name": "link_preview_options",
"type": "linkPreviewOptions",
"description": "Options which were used for generation of the link preview; may be null if default options were used"
}
]
},
{
"name": "messageAnimation",
"description": "An animation message (GIF-style).",
"class": "MessageContent",
"properties": [
{
"name": "animation",
"type": "animation",
"description": "The animation description"
},
{
"name": "caption",
"type": "formattedText",
"description": "Animation caption"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the animation preview must be covered by a spoiler animation"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the animation thumbnail must be blurred and the animation must be shown only while tapped"
}
]
},
{
"name": "messageAudio",
"description": "An audio message",
"class": "MessageContent",
"properties": [
{
"name": "audio",
"type": "audio",
"description": "The audio description"
},
{
"name": "caption",
"type": "formattedText",
"description": "Audio caption"
}
]
},
{
"name": "messageDocument",
"description": "A document message (general file)",
"class": "MessageContent",
"properties": [
{
"name": "document",
"type": "document",
"description": "The document description"
},
{
"name": "caption",
"type": "formattedText",
"description": "Document caption"
}
]
},
{
"name": "messagePhoto",
"description": "A photo message",
"class": "MessageContent",
"properties": [
{
"name": "photo",
"type": "photo",
"description": "The photo"
},
{
"name": "caption",
"type": "formattedText",
"description": "Photo caption"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the photo preview must be covered by a spoiler animation"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the photo must be blurred and must be shown only while tapped"
}
]
},
{
"name": "messageSticker",
"description": "A sticker message",
"class": "MessageContent",
"properties": [
{
"name": "sticker",
"type": "sticker",
"description": "The sticker description"
},
{
"name": "is_premium",
"type": "Bool",
"description": "True, if premium animation of the sticker must be played"
}
]
},
{
"name": "messageVideo",
"description": "A video message",
"class": "MessageContent",
"properties": [
{
"name": "video",
"type": "video",
"description": "The video description"
},
{
"name": "caption",
"type": "formattedText",
"description": "Video caption"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the video preview must be covered by a spoiler animation"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the video thumbnail must be blurred and the video must be shown only while tapped"
}
]
},
{
"name": "messageVideoNote",
"description": "A video note message",
"class": "MessageContent",
"properties": [
{
"name": "video_note",
"type": "videoNote",
"description": "The video note description"
},
{
"name": "is_viewed",
"type": "Bool",
"description": "True, if at least one of the recipients has viewed the video note"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the video note thumbnail must be blurred and the video note must be shown only while tapped"
}
]
},
{
"name": "messageVoiceNote",
"description": "A voice note message",
"class": "MessageContent",
"properties": [
{
"name": "voice_note",
"type": "voiceNote",
"description": "The voice note description"
},
{
"name": "caption",
"type": "formattedText",
"description": "Voice note caption"
},
{
"name": "is_listened",
"type": "Bool",
"description": "True, if at least one of the recipients has listened to the voice note"
}
]
},
{
"name": "messageExpiredPhoto",
"description": "A self-destructed photo message",
"class": "MessageContent",
"properties": []
},
{
"name": "messageExpiredVideo",
"description": "A self-destructed video message",
"class": "MessageContent",
"properties": []
},
{
"name": "messageExpiredVideoNote",
"description": "A self-destructed video note message",
"class": "MessageContent",
"properties": []
},
{
"name": "messageExpiredVoiceNote",
"description": "A self-destructed voice note message",
"class": "MessageContent",
"properties": []
},
{
"name": "messageLocation",
"description": "A message with a location",
"class": "MessageContent",
"properties": [
{
"name": "location",
"type": "location",
"description": "The location description"
},
{
"name": "live_period",
"type": "int32",
"description": "Time relative to the message send date, for which the location can be updated, in seconds"
},
{
"name": "expires_in",
"type": "int32",
"description": "Left time for which the location can be updated, in seconds. updateMessageContent is not sent when this field changes"
},
{
"name": "heading",
"type": "int32",
"description": "For live locations, a direction in which the location moves, in degrees; 1-360. If 0 the direction is unknown"
},
{
"name": "proximity_alert_radius",
"type": "int32",
"description": "For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Available only to the message sender"
}
]
},
{
"name": "messageVenue",
"description": "A message with information about a venue",
"class": "MessageContent",
"properties": [
{
"name": "venue",
"type": "venue",
"description": "The venue description"
}
]
},
{
"name": "messageContact",
"description": "A message with a user contact",
"class": "MessageContent",
"properties": [
{
"name": "contact",
"type": "contact",
"description": "The contact description"
}
]
},
{
"name": "messageAnimatedEmoji",
"description": "A message with an animated emoji",
"class": "MessageContent",
"properties": [
{
"name": "animated_emoji",
"type": "animatedEmoji",
"description": "The animated emoji"
},
{
"name": "emoji",
"type": "string",
"description": "The corresponding emoji"
}
]
},
{
"name": "messageDice",
"description": "A dice message. The dice value is randomly generated by the server",
"class": "MessageContent",
"properties": [
{
"name": "initial_state",
"type": "DiceStickers",
"description": "The animated stickers with the initial dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known"
},
{
"name": "final_state",
"type": "DiceStickers",
"description": "The animated stickers with the final dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known"
},
{
"name": "emoji",
"type": "string",
"description": "Emoji on which the dice throw animation is based"
},
{
"name": "value",
"type": "int32",
"description": "The dice value. If the value is 0, the dice don't have final state yet"
},
{
"name": "success_animation_frame_number",
"type": "int32",
"description": "Number of frame after which a success animation like a shower of confetti needs to be shown on updateMessageSendSucceeded"
}
]
},
{
"name": "messageGame",
"description": "A message with a game",
"class": "MessageContent",
"properties": [
{
"name": "game",
"type": "game",
"description": "The game description"
}
]
},
{
"name": "messagePoll",
"description": "A message with a poll",
"class": "MessageContent",
"properties": [
{
"name": "poll",
"type": "poll",
"description": "The poll description"
}
]
},
{
"name": "messageStory",
"description": "A message with a forwarded story",
"class": "MessageContent",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
},
{
"name": "via_mention",
"type": "Bool",
"description": "True, if the story was automatically forwarded because of a mention of the user"
}
]
},
{
"name": "messageInvoice",
"description": "A message with an invoice from a bot. Use getInternalLink with internalLinkTypeBotStart to share the invoice",
"class": "MessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Product title"
},
{
"name": "description",
"type": "formattedText",
"description": "Product description"
},
{
"name": "photo",
"type": "photo",
"description": "Product photo; may be null"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the product price"
},
{
"name": "total_amount",
"type": "int53",
"description": "Product total price in the smallest units of the currency"
},
{
"name": "start_parameter",
"type": "string",
"description": "Unique invoice bot start_parameter to be passed to getInternalLink"
},
{
"name": "is_test",
"type": "Bool",
"description": "True, if the invoice is a test invoice"
},
{
"name": "need_shipping_address",
"type": "Bool",
"description": "True, if the shipping address must be specified"
},
{
"name": "receipt_message_id",
"type": "int53",
"description": "The identifier of the message with the receipt, after the product has been purchased"
},
{
"name": "extended_media",
"type": "MessageExtendedMedia",
"description": "Extended media attached to the invoice; may be null"
}
]
},
{
"name": "messageCall",
"description": "A message with information about an ended call",
"class": "MessageContent",
"properties": [
{
"name": "is_video",
"type": "Bool",
"description": "True, if the call was a video call"
},
{
"name": "discard_reason",
"type": "CallDiscardReason",
"description": "Reason why the call was discarded"
},
{
"name": "duration",
"type": "int32",
"description": "Call duration, in seconds"
}
]
},
{
"name": "messageVideoChatScheduled",
"description": "A new video chat was scheduled",
"class": "MessageContent",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of the video chat. The video chat can be received through the method getGroupCall"
},
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator"
}
]
},
{
"name": "messageVideoChatStarted",
"description": "A newly created video chat",
"class": "MessageContent",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of the video chat. The video chat can be received through the method getGroupCall"
}
]
},
{
"name": "messageVideoChatEnded",
"description": "A message with information about an ended video chat",
"class": "MessageContent",
"properties": [
{
"name": "duration",
"type": "int32",
"description": "Call duration, in seconds"
}
]
},
{
"name": "messageInviteVideoChatParticipants",
"description": "A message with information about an invite to a video chat",
"class": "MessageContent",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of the video chat. The video chat can be received through the method getGroupCall"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Invited user identifiers"
}
]
},
{
"name": "messageBasicGroupChatCreate",
"description": "A newly created basic group",
"class": "MessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the basic group"
},
{
"name": "member_user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of members in the basic group"
}
]
},
{
"name": "messageSupergroupChatCreate",
"description": "A newly created supergroup or channel",
"class": "MessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the supergroup or channel"
}
]
},
{
"name": "messageChatChangeTitle",
"description": "An updated chat title",
"class": "MessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "New chat title"
}
]
},
{
"name": "messageChatChangePhoto",
"description": "An updated chat photo",
"class": "MessageContent",
"properties": [
{
"name": "photo",
"type": "chatPhoto",
"description": "New chat photo"
}
]
},
{
"name": "messageChatDeletePhoto",
"description": "A deleted chat photo",
"class": "MessageContent",
"properties": []
},
{
"name": "messageChatAddMembers",
"description": "New chat members were added",
"class": "MessageContent",
"properties": [
{
"name": "member_user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of the new members"
}
]
},
{
"name": "messageChatJoinByLink",
"description": "A new member joined the chat via an invite link",
"class": "MessageContent",
"properties": []
},
{
"name": "messageChatJoinByRequest",
"description": "A new member was accepted to the chat by an administrator",
"class": "MessageContent",
"properties": []
},
{
"name": "messageChatDeleteMember",
"description": "A chat member was deleted",
"class": "MessageContent",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier of the deleted chat member"
}
]
},
{
"name": "messageChatUpgradeTo",
"description": "A basic group was upgraded to a supergroup and was deactivated as the result",
"class": "MessageContent",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup to which the basic group was upgraded"
}
]
},
{
"name": "messageChatUpgradeFrom",
"description": "A supergroup has been created from a basic group",
"class": "MessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the newly created supergroup"
},
{
"name": "basic_group_id",
"type": "int53",
"description": "The identifier of the original basic group"
}
]
},
{
"name": "messagePinMessage",
"description": "A message has been pinned",
"class": "MessageContent",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the pinned message, can be an identifier of a deleted message or 0"
}
]
},
{
"name": "messageScreenshotTaken",
"description": "A screenshot of a message in the chat has been taken",
"class": "MessageContent",
"properties": []
},
{
"name": "messageChatSetBackground",
"description": "A new background was set in the chat",
"class": "MessageContent",
"properties": [
{
"name": "old_background_message_id",
"type": "int53",
"description": "Identifier of the message with a previously set same background; 0 if none. Can be an identifier of a deleted message"
},
{
"name": "background",
"type": "chatBackground",
"description": "The new background"
},
{
"name": "only_for_self",
"type": "Bool",
"description": "True, if the background was set only for self"
}
]
},
{
"name": "messageChatSetTheme",
"description": "A theme in the chat has been changed",
"class": "MessageContent",
"properties": [
{
"name": "theme_name",
"type": "string",
"description": "If non-empty, name of a new theme, set for the chat. Otherwise, chat theme was reset to the default one"
}
]
},
{
"name": "messageChatSetMessageAutoDeleteTime",
"description": "The auto-delete or self-destruct timer for messages in the chat has been changed",
"class": "MessageContent",
"properties": [
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "New value auto-delete or self-destruct time, in seconds; 0 if disabled"
},
{
"name": "from_user_id",
"type": "int53",
"description": "If not 0, a user identifier, which default setting was automatically applied"
}
]
},
{
"name": "messageChatBoost",
"description": "The chat was boosted by the sender of the message",
"class": "MessageContent",
"properties": [
{
"name": "boost_count",
"type": "int32",
"description": "Number of times the chat was boosted"
}
]
},
{
"name": "messageForumTopicCreated",
"description": "A forum topic has been created",
"class": "MessageContent",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the topic"
},
{
"name": "icon",
"type": "forumTopicIcon",
"description": "Icon of the topic"
}
]
},
{
"name": "messageForumTopicEdited",
"description": "A forum topic has been edited",
"class": "MessageContent",
"properties": [
{
"name": "name",
"type": "string",
"description": "If non-empty, the new name of the topic"
},
{
"name": "edit_icon_custom_emoji_id",
"type": "Bool",
"description": "True, if icon's custom_emoji_id is changed"
},
{
"name": "icon_custom_emoji_id",
"type": "int64",
"description": "New unique identifier of the custom emoji shown on the topic icon; 0 if none. Must be ignored if edit_icon_custom_emoji_id is false"
}
]
},
{
"name": "messageForumTopicIsClosedToggled",
"description": "A forum topic has been closed or opened",
"class": "MessageContent",
"properties": [
{
"name": "is_closed",
"type": "Bool",
"description": "True, if the topic was closed; otherwise, the topic was reopened"
}
]
},
{
"name": "messageForumTopicIsHiddenToggled",
"description": "A General forum topic has been hidden or unhidden",
"class": "MessageContent",
"properties": [
{
"name": "is_hidden",
"type": "Bool",
"description": "True, if the topic was hidden; otherwise, the topic was unhidden"
}
]
},
{
"name": "messageSuggestProfilePhoto",
"description": "A profile photo was suggested to a user in a private chat",
"class": "MessageContent",
"properties": [
{
"name": "photo",
"type": "chatPhoto",
"description": "The suggested chat photo. Use the method setProfilePhoto with inputChatPhotoPrevious to apply the photo"
}
]
},
{
"name": "messageCustomServiceAction",
"description": "A non-standard action has happened in the chat",
"class": "MessageContent",
"properties": [
{
"name": "text",
"type": "string",
"description": "Message text to be shown in the chat"
}
]
},
{
"name": "messageGameScore",
"description": "A new high score was achieved in a game",
"class": "MessageContent",
"properties": [
{
"name": "game_message_id",
"type": "int53",
"description": "Identifier of the message with the game, can be an identifier of a deleted message"
},
{
"name": "game_id",
"type": "int64",
"description": "Identifier of the game; may be different from the games presented in the message with the game"
},
{
"name": "score",
"type": "int32",
"description": "New score"
}
]
},
{
"name": "messagePaymentSuccessful",
"description": "A payment has been completed",
"class": "MessageContent",
"properties": [
{
"name": "invoice_chat_id",
"type": "int53",
"description": "Identifier of the chat, containing the corresponding invoice message"
},
{
"name": "invoice_message_id",
"type": "int53",
"description": "Identifier of the message with the corresponding invoice; can be 0 or an identifier of a deleted message"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the price of the product"
},
{
"name": "total_amount",
"type": "int53",
"description": "Total price for the product, in the smallest units of the currency"
},
{
"name": "is_recurring",
"type": "Bool",
"description": "True, if this is a recurring payment"
},
{
"name": "is_first_recurring",
"type": "Bool",
"description": "True, if this is the first recurring payment"
},
{
"name": "invoice_name",
"type": "string",
"description": "Name of the invoice; may be empty if unknown"
}
]
},
{
"name": "messagePaymentSuccessfulBot",
"description": "A payment has been completed; for bots only",
"class": "MessageContent",
"properties": [
{
"name": "currency",
"type": "string",
"description": "Currency for price of the product"
},
{
"name": "total_amount",
"type": "int53",
"description": "Total price for the product, in the smallest units of the currency"
},
{
"name": "is_recurring",
"type": "Bool",
"description": "True, if this is a recurring payment"
},
{
"name": "is_first_recurring",
"type": "Bool",
"description": "True, if this is the first recurring payment"
},
{
"name": "invoice_payload",
"type": "bytes",
"description": "Invoice payload"
},
{
"name": "shipping_option_id",
"type": "string",
"description": "Identifier of the shipping option chosen by the user; may be empty if not applicable"
},
{
"name": "order_info",
"type": "orderInfo",
"description": "Information about the order; may be null"
},
{
"name": "telegram_payment_charge_id",
"type": "string",
"description": "Telegram payment identifier"
},
{
"name": "provider_payment_charge_id",
"type": "string",
"description": "Provider payment identifier"
}
]
},
{
"name": "messageGiftedPremium",
"description": "Telegram Premium was gifted to the user",
"class": "MessageContent",
"properties": [
{
"name": "gifter_user_id",
"type": "int53",
"description": "The identifier of a user that gifted Telegram Premium; 0 if the gift was anonymous"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the paid amount"
},
{
"name": "amount",
"type": "int53",
"description": "The paid amount, in the smallest units of the currency"
},
{
"name": "cryptocurrency",
"type": "string",
"description": "Cryptocurrency used to pay for the gift; may be empty if none"
},
{
"name": "cryptocurrency_amount",
"type": "int64",
"description": "The paid amount, in the smallest units of the cryptocurrency; 0 if none"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active"
},
{
"name": "sticker",
"type": "sticker",
"description": "A sticker to be shown in the message; may be null if unknown"
}
]
},
{
"name": "messagePremiumGiftCode",
"description": "A Telegram Premium gift code was created for the user",
"class": "MessageContent",
"properties": [
{
"name": "creator_id",
"type": "MessageSender",
"description": "Identifier of a chat or a user that created the gift code; may be null if unknown"
},
{
"name": "is_from_giveaway",
"type": "Bool",
"description": "True, if the gift code was created for a giveaway"
},
{
"name": "is_unclaimed",
"type": "Bool",
"description": "True, if the winner for the corresponding Telegram Premium subscription wasn't chosen"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the paid amount; empty if unknown"
},
{
"name": "amount",
"type": "int53",
"description": "The paid amount, in the smallest units of the currency; 0 if unknown"
},
{
"name": "cryptocurrency",
"type": "string",
"description": "Cryptocurrency used to pay for the gift; may be empty if none or unknown"
},
{
"name": "cryptocurrency_amount",
"type": "int64",
"description": "The paid amount, in the smallest units of the cryptocurrency; 0 if unknown"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
},
{
"name": "sticker",
"type": "sticker",
"description": "A sticker to be shown in the message; may be null if unknown"
},
{
"name": "code",
"type": "string",
"description": "The gift code"
}
]
},
{
"name": "messagePremiumGiveawayCreated",
"description": "A Telegram Premium giveaway was created for the chat",
"class": "MessageContent",
"properties": []
},
{
"name": "messagePremiumGiveaway",
"description": "A Telegram Premium giveaway",
"class": "MessageContent",
"properties": [
{
"name": "parameters",
"type": "premiumGiveawayParameters",
"description": "Giveaway parameters"
},
{
"name": "winner_count",
"type": "int32",
"description": "Number of users which will receive Telegram Premium subscription gift codes"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
},
{
"name": "sticker",
"type": "sticker",
"description": "A sticker to be shown in the message; may be null if unknown"
}
]
},
{
"name": "messagePremiumGiveawayCompleted",
"description": "A Telegram Premium giveaway without public winners has been completed for the chat",
"class": "MessageContent",
"properties": [
{
"name": "giveaway_message_id",
"type": "int53",
"description": "Identifier of the message with the giveaway; can be 0 if the message was deleted"
},
{
"name": "winner_count",
"type": "int32",
"description": "Number of winners in the giveaway"
},
{
"name": "unclaimed_prize_count",
"type": "int32",
"description": "Number of undistributed prizes"
}
]
},
{
"name": "messagePremiumGiveawayWinners",
"description": "A Telegram Premium giveaway with public winners has been completed for the chat",
"class": "MessageContent",
"properties": [
{
"name": "boosted_chat_id",
"type": "int53",
"description": "Identifier of the channel chat, which was automatically boosted by the winners of the giveaway for duration of the Premium subscription"
},
{
"name": "giveaway_message_id",
"type": "int53",
"description": "Identifier of the message with the giveaway in the boosted chat"
},
{
"name": "additional_chat_count",
"type": "int32",
"description": "Number of other chats that participated in the giveaway"
},
{
"name": "actual_winners_selection_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the winners were selected. May be bigger than winners selection date specified in parameters of the giveaway"
},
{
"name": "only_new_members",
"type": "Bool",
"description": "True, if only new members of the chats were eligible for the giveaway"
},
{
"name": "was_refunded",
"type": "Bool",
"description": "True, if the giveaway was canceled and was fully refunded"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
},
{
"name": "prize_description",
"type": "string",
"description": "Additional description of the giveaway prize"
},
{
"name": "winner_count",
"type": "int32",
"description": "Total number of winners in the giveaway"
},
{
"name": "winner_user_ids",
"type": "vector\u003cint53\u003e",
"description": "Up to 100 user identifiers of the winners of the giveaway"
},
{
"name": "unclaimed_prize_count",
"type": "int32",
"description": "Number of undistributed prizes"
}
]
},
{
"name": "messageContactRegistered",
"description": "A contact has registered with Telegram",
"class": "MessageContent",
"properties": []
},
{
"name": "messageUsersShared",
"description": "The current user shared users, which were requested by the bot",
"class": "MessageContent",
"properties": [
{
"name": "users",
"type": "vector\u003csharedUser\u003e",
"description": "The shared users"
},
{
"name": "button_id",
"type": "int32",
"description": "Identifier of the keyboard button with the request"
}
]
},
{
"name": "messageChatShared",
"description": "The current user shared a chat, which was requested by the bot",
"class": "MessageContent",
"properties": [
{
"name": "chat",
"type": "sharedChat",
"description": "The shared chat"
},
{
"name": "button_id",
"type": "int32",
"description": "Identifier of the keyboard button with the request"
}
]
},
{
"name": "messageBotWriteAccessAllowed",
"description": "The user allowed the bot to send messages",
"class": "MessageContent",
"properties": [
{
"name": "reason",
"type": "BotWriteAccessAllowReason",
"description": "The reason why the bot was allowed to write messages"
}
]
},
{
"name": "messageWebAppDataSent",
"description": "Data from a Web App has been sent to a bot",
"class": "MessageContent",
"properties": [
{
"name": "button_text",
"type": "string",
"description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App"
}
]
},
{
"name": "messageWebAppDataReceived",
"description": "Data from a Web App has been received; for bots only",
"class": "MessageContent",
"properties": [
{
"name": "button_text",
"type": "string",
"description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App"
},
{
"name": "data",
"type": "string",
"description": "The data"
}
]
},
{
"name": "messagePassportDataSent",
"description": "Telegram Passport data has been sent to a bot",
"class": "MessageContent",
"properties": [
{
"name": "types",
"type": "vector\u003cPassportElementType\u003e",
"description": "List of Telegram Passport element types sent"
}
]
},
{
"name": "messagePassportDataReceived",
"description": "Telegram Passport data has been received; for bots only",
"class": "MessageContent",
"properties": [
{
"name": "elements",
"type": "vector\u003cencryptedPassportElement\u003e",
"description": "List of received Telegram Passport elements"
},
{
"name": "credentials",
"type": "encryptedCredentials",
"description": "Encrypted data credentials"
}
]
},
{
"name": "messageProximityAlertTriggered",
"description": "A user in the chat came within proximity alert range",
"class": "MessageContent",
"properties": [
{
"name": "traveler_id",
"type": "MessageSender",
"description": "The identifier of a user or chat that triggered the proximity alert"
},
{
"name": "watcher_id",
"type": "MessageSender",
"description": "The identifier of a user or chat that subscribed for the proximity alert"
},
{
"name": "distance",
"type": "int32",
"description": "The distance between the users"
}
]
},
{
"name": "messageUnsupported",
"description": "A message content that is not supported in the current TDLib version",
"class": "MessageContent",
"properties": []
},
{
"name": "textEntityTypeMention",
"description": "A mention of a user, a supergroup, or a channel by their username",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeHashtag",
"description": "A hashtag text, beginning with \"#\"",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeCashtag",
"description": "A cashtag text, beginning with \"$\" and consisting of capital English letters (e.g., \"$USD\")",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeBotCommand",
"description": "A bot command, beginning with \"/\"",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeUrl",
"description": "An HTTP URL",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeEmailAddress",
"description": "An email address",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypePhoneNumber",
"description": "A phone number",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeBankCardNumber",
"description": "A bank card number. The getBankCardInfo method can be used to get information about the bank card",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeBold",
"description": "A bold text",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeItalic",
"description": "An italic text",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeUnderline",
"description": "An underlined text",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeStrikethrough",
"description": "A strikethrough text",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeSpoiler",
"description": "A spoiler text",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeCode",
"description": "Text that must be formatted as if inside a code HTML tag",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypePre",
"description": "Text that must be formatted as if inside a pre HTML tag",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypePreCode",
"description": "Text that must be formatted as if inside pre, and code HTML tags",
"class": "TextEntityType",
"properties": [
{
"name": "language",
"type": "string",
"description": "Programming language of the code; as defined by the sender"
}
]
},
{
"name": "textEntityTypeBlockQuote",
"description": "Text that must be formatted as if inside a blockquote HTML tag",
"class": "TextEntityType",
"properties": []
},
{
"name": "textEntityTypeTextUrl",
"description": "A text description shown instead of a raw URL",
"class": "TextEntityType",
"properties": [
{
"name": "url",
"type": "string",
"description": "HTTP or tg:// URL to be opened when the link is clicked"
}
]
},
{
"name": "textEntityTypeMentionName",
"description": "A text shows instead of a raw mention of the user (e.g., when the user has no username)",
"class": "TextEntityType",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the mentioned user"
}
]
},
{
"name": "textEntityTypeCustomEmoji",
"description": "A custom emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emoji",
"class": "TextEntityType",
"properties": [
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Unique identifier of the custom emoji"
}
]
},
{
"name": "textEntityTypeMediaTimestamp",
"description": "A media timestamp",
"class": "TextEntityType",
"properties": [
{
"name": "media_timestamp",
"type": "int32",
"description": "Timestamp from which a video/audio/video note/voice note/story playing must start, in seconds. The media can be in the content or the web page preview of the current message, or in the same places in the replied message"
}
]
},
{
"name": "inputThumbnail",
"description": "A thumbnail to be sent along with a file; must be in JPEG or WEBP format for stickers, and less than 200 KB in size",
"class": "InputThumbnail",
"properties": [
{
"name": "thumbnail",
"type": "InputFile",
"description": "Thumbnail file to send. Sending thumbnails by file_id is currently not supported"
},
{
"name": "width",
"type": "int32",
"description": "Thumbnail width, usually shouldn't exceed 320. Use 0 if unknown"
},
{
"name": "height",
"type": "int32",
"description": "Thumbnail height, usually shouldn't exceed 320. Use 0 if unknown"
}
]
},
{
"name": "messageSchedulingStateSendAtDate",
"description": "The message will be sent at the specified date",
"class": "MessageSchedulingState",
"properties": [
{
"name": "send_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message will be sent. The date must be within 367 days in the future"
}
]
},
{
"name": "messageSchedulingStateSendWhenOnline",
"description": "The message will be sent when the other user is online. Applicable to private chats only and when the exact online status of the other user is known",
"class": "MessageSchedulingState",
"properties": []
},
{
"name": "messageSelfDestructTypeTimer",
"description": "The message will be self-destructed in the specified time after its content was opened",
"class": "MessageSelfDestructType",
"properties": [
{
"name": "self_destruct_time",
"type": "int32",
"description": "The message's self-destruct time, in seconds; must be between 0 and 60 in private chats"
}
]
},
{
"name": "messageSelfDestructTypeImmediately",
"description": "The message can be opened only once and will be self-destructed once closed",
"class": "MessageSelfDestructType",
"properties": []
},
{
"name": "messageSendOptions",
"description": "Options to be used when a message is sent",
"class": "MessageSendOptions",
"properties": [
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification for the message"
},
{
"name": "from_background",
"type": "Bool",
"description": "Pass true if the message is sent from the background"
},
{
"name": "protect_content",
"type": "Bool",
"description": "Pass true if the content of the message must be protected from forwarding and saving; for bots only"
},
{
"name": "update_order_of_installed_sticker_sets",
"type": "Bool",
"description": "Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum"
},
{
"name": "scheduling_state",
"type": "MessageSchedulingState",
"description": "Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, live location messages and self-destructing messages can't be scheduled"
},
{
"name": "sending_id",
"type": "int32",
"description": "Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates"
},
{
"name": "only_preview",
"type": "Bool",
"description": "Pass true to get a fake message instead of actually sending them"
}
]
},
{
"name": "messageCopyOptions",
"description": "Options to be used when a message content is copied without reference to the original sender. Service messages, messages with messageInvoice, messagePremiumGiveaway, or messagePremiumGiveawayWinners content can't be copied",
"class": "MessageCopyOptions",
"properties": [
{
"name": "send_copy",
"type": "Bool",
"description": "True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local"
},
{
"name": "replace_caption",
"type": "Bool",
"description": "True, if media caption of the message copy needs to be replaced. Ignored if send_copy is false"
},
{
"name": "new_caption",
"type": "formattedText",
"description": "New message caption; pass null to copy message without caption. Ignored if replace_caption is false"
}
]
},
{
"name": "inputMessageText",
"description": "A text message",
"class": "InputMessageContent",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Formatted text to be sent; 0-getOption(\"message_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, Code, Pre, PreCode, TextUrl and MentionName entities are allowed to be specified manually"
},
{
"name": "link_preview_options",
"type": "linkPreviewOptions",
"description": "Options to be used for generation of a link preview; may be null if none; pass null to use default link preview options"
},
{
"name": "clear_draft",
"type": "Bool",
"description": "True, if a chat message draft must be deleted"
}
]
},
{
"name": "inputMessageAnimation",
"description": "An animation message (GIF-style).",
"class": "InputMessageContent",
"properties": [
{
"name": "animation",
"type": "InputFile",
"description": "Animation file to be sent"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Animation thumbnail; pass null to skip thumbnail uploading"
},
{
"name": "added_sticker_file_ids",
"type": "vector\u003cint32\u003e",
"description": "File identifiers of the stickers added to the animation, if applicable"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the animation, in seconds"
},
{
"name": "width",
"type": "int32",
"description": "Width of the animation; may be replaced by the server"
},
{
"name": "height",
"type": "int32",
"description": "Height of the animation; may be replaced by the server"
},
{
"name": "caption",
"type": "formattedText",
"description": "Animation caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the animation preview must be covered by a spoiler animation; not supported in secret chats"
}
]
},
{
"name": "inputMessageAudio",
"description": "An audio message",
"class": "InputMessageContent",
"properties": [
{
"name": "audio",
"type": "InputFile",
"description": "Audio file to be sent"
},
{
"name": "album_cover_thumbnail",
"type": "inputThumbnail",
"description": "Thumbnail of the cover for the album; pass null to skip thumbnail uploading"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the audio, in seconds; may be replaced by the server"
},
{
"name": "title",
"type": "string",
"description": "Title of the audio; 0-64 characters; may be replaced by the server"
},
{
"name": "performer",
"type": "string",
"description": "Performer of the audio; 0-64 characters, may be replaced by the server"
},
{
"name": "caption",
"type": "formattedText",
"description": "Audio caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
}
]
},
{
"name": "inputMessageDocument",
"description": "A document message (general file)",
"class": "InputMessageContent",
"properties": [
{
"name": "document",
"type": "InputFile",
"description": "Document to be sent"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Document thumbnail; pass null to skip thumbnail uploading"
},
{
"name": "disable_content_type_detection",
"type": "Bool",
"description": "Pass true to disable automatic file type detection and send the document as a file. Always true for files sent to secret chats"
},
{
"name": "caption",
"type": "formattedText",
"description": "Document caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
}
]
},
{
"name": "inputMessagePhoto",
"description": "A photo message",
"class": "InputMessageContent",
"properties": [
{
"name": "photo",
"type": "InputFile",
"description": "Photo to send. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Photo thumbnail to be sent; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats"
},
{
"name": "added_sticker_file_ids",
"type": "vector\u003cint32\u003e",
"description": "File identifiers of the stickers added to the photo, if applicable"
},
{
"name": "width",
"type": "int32",
"description": "Photo width"
},
{
"name": "height",
"type": "int32",
"description": "Photo height"
},
{
"name": "caption",
"type": "formattedText",
"description": "Photo caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
},
{
"name": "self_destruct_type",
"type": "MessageSelfDestructType",
"description": "Photo self-destruct type; pass null if none; private chats only"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the photo preview must be covered by a spoiler animation; not supported in secret chats"
}
]
},
{
"name": "inputMessageSticker",
"description": "A sticker message",
"class": "InputMessageContent",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker to be sent"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Sticker thumbnail; pass null to skip thumbnail uploading"
},
{
"name": "width",
"type": "int32",
"description": "Sticker width"
},
{
"name": "height",
"type": "int32",
"description": "Sticker height"
},
{
"name": "emoji",
"type": "string",
"description": "Emoji used to choose the sticker"
}
]
},
{
"name": "inputMessageVideo",
"description": "A video message",
"class": "InputMessageContent",
"properties": [
{
"name": "video",
"type": "InputFile",
"description": "Video to be sent"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Video thumbnail; pass null to skip thumbnail uploading"
},
{
"name": "added_sticker_file_ids",
"type": "vector\u003cint32\u003e",
"description": "File identifiers of the stickers added to the video, if applicable"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the video, in seconds"
},
{
"name": "width",
"type": "int32",
"description": "Video width"
},
{
"name": "height",
"type": "int32",
"description": "Video height"
},
{
"name": "supports_streaming",
"type": "Bool",
"description": "True, if the video is supposed to be streamed"
},
{
"name": "caption",
"type": "formattedText",
"description": "Video caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
},
{
"name": "self_destruct_type",
"type": "MessageSelfDestructType",
"description": "Video self-destruct type; pass null if none; private chats only"
},
{
"name": "has_spoiler",
"type": "Bool",
"description": "True, if the video preview must be covered by a spoiler animation; not supported in secret chats"
}
]
},
{
"name": "inputMessageVideoNote",
"description": "A video note message",
"class": "InputMessageContent",
"properties": [
{
"name": "video_note",
"type": "InputFile",
"description": "Video note to be sent"
},
{
"name": "thumbnail",
"type": "inputThumbnail",
"description": "Video thumbnail; may be null if empty; pass null to skip thumbnail uploading"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the video, in seconds; 0-60"
},
{
"name": "length",
"type": "int32",
"description": "Video width and height; must be positive and not greater than 640"
},
{
"name": "self_destruct_type",
"type": "MessageSelfDestructType",
"description": "Video note self-destruct type; may be null if none; pass null if none; private chats only"
}
]
},
{
"name": "inputMessageVoiceNote",
"description": "A voice note message",
"class": "InputMessageContent",
"properties": [
{
"name": "voice_note",
"type": "InputFile",
"description": "Voice note to be sent"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the voice note, in seconds"
},
{
"name": "waveform",
"type": "bytes",
"description": "Waveform representation of the voice note in 5-bit format"
},
{
"name": "caption",
"type": "formattedText",
"description": "Voice note caption; may be null if empty; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters"
},
{
"name": "self_destruct_type",
"type": "MessageSelfDestructType",
"description": "Voice note self-destruct type; may be null if none; pass null if none; private chats only"
}
]
},
{
"name": "inputMessageLocation",
"description": "A message with a location",
"class": "InputMessageContent",
"properties": [
{
"name": "location",
"type": "location",
"description": "Location to be sent"
},
{
"name": "live_period",
"type": "int32",
"description": "Period for which the location can be updated, in seconds; must be between 60 and 86400 for a live location and 0 otherwise"
},
{
"name": "heading",
"type": "int32",
"description": "For live locations, a direction in which the location moves, in degrees; 1-360. Pass 0 if unknown"
},
{
"name": "proximity_alert_radius",
"type": "int32",
"description": "For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled. Can't be enabled in channels and Saved Messages"
}
]
},
{
"name": "inputMessageVenue",
"description": "A message with information about a venue",
"class": "InputMessageContent",
"properties": [
{
"name": "venue",
"type": "venue",
"description": "Venue to send"
}
]
},
{
"name": "inputMessageContact",
"description": "A message containing a user contact",
"class": "InputMessageContent",
"properties": [
{
"name": "contact",
"type": "contact",
"description": "Contact to send"
}
]
},
{
"name": "inputMessageDice",
"description": "A dice message",
"class": "InputMessageContent",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "Emoji on which the dice throw animation is based"
},
{
"name": "clear_draft",
"type": "Bool",
"description": "True, if the chat message draft must be deleted"
}
]
},
{
"name": "inputMessageGame",
"description": "A message with a game; not supported for channels or secret chats",
"class": "InputMessageContent",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the bot that owns the game"
},
{
"name": "game_short_name",
"type": "string",
"description": "Short name of the game"
}
]
},
{
"name": "inputMessageInvoice",
"description": "A message with an invoice; can be used only by bots",
"class": "InputMessageContent",
"properties": [
{
"name": "invoice",
"type": "invoice",
"description": "Invoice"
},
{
"name": "title",
"type": "string",
"description": "Product title; 1-32 characters"
},
{
"name": "description",
"type": "string",
"description": "Product description; 0-255 characters"
},
{
"name": "photo_url",
"type": "string",
"description": "Product photo URL; optional"
},
{
"name": "photo_size",
"type": "int32",
"description": "Product photo size"
},
{
"name": "photo_width",
"type": "int32",
"description": "Product photo width"
},
{
"name": "photo_height",
"type": "int32",
"description": "Product photo height"
},
{
"name": "payload",
"type": "bytes",
"description": "The invoice payload"
},
{
"name": "provider_token",
"type": "string",
"description": "Payment provider token"
},
{
"name": "provider_data",
"type": "string",
"description": "JSON-encoded data about the invoice, which will be shared with the payment provider"
},
{
"name": "start_parameter",
"type": "string",
"description": "Unique invoice bot deep link parameter for the generation of this invoice. If empty, it would be possible to pay directly from forwards of the invoice message"
},
{
"name": "extended_media_content",
"type": "InputMessageContent",
"description": "The content of extended media attached to the invoice. The content of the message to be sent. Must be one of the following types: inputMessagePhoto, inputMessageVideo"
}
]
},
{
"name": "inputMessagePoll",
"description": "A message with a poll. Polls can't be sent to secret chats. Polls can be sent only to a private chat with a bot",
"class": "InputMessageContent",
"properties": [
{
"name": "question",
"type": "string",
"description": "Poll question; 1-255 characters (up to 300 characters for bots)"
},
{
"name": "options",
"type": "vector\u003cstring\u003e",
"description": "List of poll answer options, 2-10 strings 1-100 characters each"
},
{
"name": "is_anonymous",
"type": "Bool",
"description": "True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels"
},
{
"name": "type",
"type": "PollType",
"description": "Type of the poll"
},
{
"name": "open_period",
"type": "int32",
"description": "Amount of time the poll will be active after creation, in seconds; for bots only"
},
{
"name": "close_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the poll will automatically be closed; for bots only"
},
{
"name": "is_closed",
"type": "Bool",
"description": "True, if the poll needs to be sent already closed; for bots only"
}
]
},
{
"name": "inputMessageStory",
"description": "A message with a forwarded story. Stories can't be sent to secret chats. A story can be forwarded only if story.can_be_forwarded",
"class": "InputMessageContent",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
}
]
},
{
"name": "inputMessageForwarded",
"description": "A forwarded message",
"class": "InputMessageContent",
"properties": [
{
"name": "from_chat_id",
"type": "int53",
"description": "Identifier for the chat this forwarded message came from"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message to forward. A message can be forwarded only if message.can_be_forwarded"
},
{
"name": "in_game_share",
"type": "Bool",
"description": "True, if a game message is being shared from a launched game; applies only to game messages"
},
{
"name": "copy_options",
"type": "messageCopyOptions",
"description": "Options to be used to copy content of the message without reference to the original sender; pass null to forward the message as usual"
}
]
},
{
"name": "searchMessagesFilterEmpty",
"description": "Returns all found messages, no filter is applied",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterAnimation",
"description": "Returns only animation messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterAudio",
"description": "Returns only audio messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterDocument",
"description": "Returns only document messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterPhoto",
"description": "Returns only photo messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterVideo",
"description": "Returns only video messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterVoiceNote",
"description": "Returns only voice note messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterPhotoAndVideo",
"description": "Returns only photo and video messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterUrl",
"description": "Returns only messages containing URLs",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterChatPhoto",
"description": "Returns only messages containing chat photos",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterVideoNote",
"description": "Returns only video note messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterVoiceAndVideoNote",
"description": "Returns only voice and video note messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterMention",
"description": "Returns only messages with mentions of the current user, or messages that are replies to their messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterUnreadMention",
"description": "Returns only messages with unread mentions of the current user, or messages that are replies to their messages. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterUnreadReaction",
"description": "Returns only messages with unread reactions for the current user. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterFailedToSend",
"description": "Returns only failed to send messages. This filter can be used only if the message database is used",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "searchMessagesFilterPinned",
"description": "Returns only pinned messages",
"class": "SearchMessagesFilter",
"properties": []
},
{
"name": "chatActionTyping",
"description": "The user is typing a message",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionRecordingVideo",
"description": "The user is recording a video",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionUploadingVideo",
"description": "The user is uploading a video",
"class": "ChatAction",
"properties": [
{
"name": "progress",
"type": "int32",
"description": "Upload progress, as a percentage"
}
]
},
{
"name": "chatActionRecordingVoiceNote",
"description": "The user is recording a voice note",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionUploadingVoiceNote",
"description": "The user is uploading a voice note",
"class": "ChatAction",
"properties": [
{
"name": "progress",
"type": "int32",
"description": "Upload progress, as a percentage"
}
]
},
{
"name": "chatActionUploadingPhoto",
"description": "The user is uploading a photo",
"class": "ChatAction",
"properties": [
{
"name": "progress",
"type": "int32",
"description": "Upload progress, as a percentage"
}
]
},
{
"name": "chatActionUploadingDocument",
"description": "The user is uploading a document",
"class": "ChatAction",
"properties": [
{
"name": "progress",
"type": "int32",
"description": "Upload progress, as a percentage"
}
]
},
{
"name": "chatActionChoosingSticker",
"description": "The user is picking a sticker to send",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionChoosingLocation",
"description": "The user is picking a location or venue to send",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionChoosingContact",
"description": "The user is picking a contact to send",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionStartPlayingGame",
"description": "The user has started to play a game",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionRecordingVideoNote",
"description": "The user is recording a video note",
"class": "ChatAction",
"properties": []
},
{
"name": "chatActionUploadingVideoNote",
"description": "The user is uploading a video note",
"class": "ChatAction",
"properties": [
{
"name": "progress",
"type": "int32",
"description": "Upload progress, as a percentage"
}
]
},
{
"name": "chatActionWatchingAnimations",
"description": "The user is watching animations sent by the other party by clicking on an animated emoji",
"class": "ChatAction",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "The animated emoji"
}
]
},
{
"name": "chatActionCancel",
"description": "The user has canceled the previous action",
"class": "ChatAction",
"properties": []
},
{
"name": "userStatusEmpty",
"description": "The user's status has never been changed",
"class": "UserStatus",
"properties": []
},
{
"name": "userStatusOnline",
"description": "The user is online",
"class": "UserStatus",
"properties": [
{
"name": "expires",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user's online status will expire"
}
]
},
{
"name": "userStatusOffline",
"description": "The user is offline",
"class": "UserStatus",
"properties": [
{
"name": "was_online",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user was last online"
}
]
},
{
"name": "userStatusRecently",
"description": "The user was online recently",
"class": "UserStatus",
"properties": [
{
"name": "by_my_privacy_settings",
"type": "Bool",
"description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium"
}
]
},
{
"name": "userStatusLastWeek",
"description": "The user is offline, but was online last week",
"class": "UserStatus",
"properties": [
{
"name": "by_my_privacy_settings",
"type": "Bool",
"description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium"
}
]
},
{
"name": "userStatusLastMonth",
"description": "The user is offline, but was online last month",
"class": "UserStatus",
"properties": [
{
"name": "by_my_privacy_settings",
"type": "Bool",
"description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium"
}
]
},
{
"name": "emojiKeyword",
"description": "Represents an emoji with its keyword",
"class": "EmojiKeyword",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "The emoji"
},
{
"name": "keyword",
"type": "string",
"description": "The keyword"
}
]
},
{
"name": "emojiKeywords",
"description": "Represents a list of emoji with their keywords",
"class": "EmojiKeywords",
"properties": [
{
"name": "emoji_keywords",
"type": "vector\u003cemojiKeyword\u003e",
"description": "List of emoji with their keywords"
}
]
},
{
"name": "stickers",
"description": "Represents a list of stickers",
"class": "Stickers",
"properties": [
{
"name": "stickers",
"type": "vector\u003csticker\u003e",
"description": "List of stickers"
}
]
},
{
"name": "emojis",
"description": "Represents a list of emoji",
"class": "Emojis",
"properties": [
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "List of emojis"
}
]
},
{
"name": "stickerSet",
"description": "Represents a sticker set",
"class": "StickerSet",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Identifier of the sticker set"
},
{
"name": "title",
"type": "string",
"description": "Title of the sticker set"
},
{
"name": "name",
"type": "string",
"description": "Name of the sticker set"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed"
},
{
"name": "thumbnail_outline",
"type": "vector\u003cclosedVectorPath\u003e",
"description": "Sticker set thumbnail's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner"
},
{
"name": "is_owned",
"type": "Bool",
"description": "True, if the sticker set is owned by the current user"
},
{
"name": "is_installed",
"type": "Bool",
"description": "True, if the sticker set has been installed by the current user"
},
{
"name": "is_archived",
"type": "Bool",
"description": "True, if the sticker set has been archived. A sticker set can't be installed and archived simultaneously"
},
{
"name": "is_official",
"type": "Bool",
"description": "True, if the sticker set is official"
},
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers in the set"
},
{
"name": "needs_repainting",
"type": "Bool",
"description": "True, if stickers in the sticker set are custom emoji that must be repainted; for custom emoji sticker sets only"
},
{
"name": "is_allowed_as_chat_emoji_status",
"type": "Bool",
"description": "True, if stickers in the sticker set are custom emoji that can be used as chat emoji status; for custom emoji sticker sets only"
},
{
"name": "is_viewed",
"type": "Bool",
"description": "True for already viewed trending sticker sets"
},
{
"name": "stickers",
"type": "vector\u003csticker\u003e",
"description": "List of stickers in this set"
},
{
"name": "emojis",
"type": "vector\u003cemojis\u003e",
"description": "A list of emoji corresponding to the stickers in the same order. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object"
}
]
},
{
"name": "stickerSetInfo",
"description": "Represents short information about a sticker set",
"class": "StickerSetInfo",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Identifier of the sticker set"
},
{
"name": "title",
"type": "string",
"description": "Title of the sticker set"
},
{
"name": "name",
"type": "string",
"description": "Name of the sticker set"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed"
},
{
"name": "thumbnail_outline",
"type": "vector\u003cclosedVectorPath\u003e",
"description": "Sticker set thumbnail's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner"
},
{
"name": "is_owned",
"type": "Bool",
"description": "True, if the sticker set is owned by the current user"
},
{
"name": "is_installed",
"type": "Bool",
"description": "True, if the sticker set has been installed by the current user"
},
{
"name": "is_archived",
"type": "Bool",
"description": "True, if the sticker set has been archived. A sticker set can't be installed and archived simultaneously"
},
{
"name": "is_official",
"type": "Bool",
"description": "True, if the sticker set is official"
},
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers in the set"
},
{
"name": "needs_repainting",
"type": "Bool",
"description": "True, if stickers in the sticker set are custom emoji that must be repainted; for custom emoji sticker sets only"
},
{
"name": "is_allowed_as_chat_emoji_status",
"type": "Bool",
"description": "True, if stickers in the sticker set are custom emoji that can be used as chat emoji status; for custom emoji sticker sets only"
},
{
"name": "is_viewed",
"type": "Bool",
"description": "True for already viewed trending sticker sets"
},
{
"name": "size",
"type": "int32",
"description": "Total number of stickers in the set"
},
{
"name": "covers",
"type": "vector\u003csticker\u003e",
"description": "Up to the first 5 stickers from the set, depending on the context. If the application needs more stickers the full sticker set needs to be requested"
}
]
},
{
"name": "stickerSets",
"description": "Represents a list of sticker sets",
"class": "StickerSets",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of sticker sets found"
},
{
"name": "sets",
"type": "vector\u003cstickerSetInfo\u003e",
"description": "List of sticker sets"
}
]
},
{
"name": "trendingStickerSets",
"description": "Represents a list of trending sticker sets",
"class": "TrendingStickerSets",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of trending sticker sets"
},
{
"name": "sets",
"type": "vector\u003cstickerSetInfo\u003e",
"description": "List of trending sticker sets"
},
{
"name": "is_premium",
"type": "Bool",
"description": "True, if the list contains sticker sets with premium stickers"
}
]
},
{
"name": "emojiCategory",
"description": "Contains a list of similar emoji to search for in getStickers and searchStickers",
"class": "EmojiCategory",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the category"
},
{
"name": "icon",
"type": "sticker",
"description": "Custom emoji sticker, which represents icon of the category"
},
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "List of emojis in the category"
}
]
},
{
"name": "emojiCategories",
"description": "Represents a list of emoji categories",
"class": "EmojiCategories",
"properties": [
{
"name": "categories",
"type": "vector\u003cemojiCategory\u003e",
"description": "List of categories"
}
]
},
{
"name": "emojiCategoryTypeDefault",
"description": "The category must be used by default",
"class": "EmojiCategoryType",
"properties": []
},
{
"name": "emojiCategoryTypeEmojiStatus",
"description": "The category must be used for emoji status selection",
"class": "EmojiCategoryType",
"properties": []
},
{
"name": "emojiCategoryTypeChatPhoto",
"description": "The category must be used for chat photo emoji selection",
"class": "EmojiCategoryType",
"properties": []
},
{
"name": "storyAreaPosition",
"description": "Describes position of a clickable rectangle area on a story media",
"class": "StoryAreaPosition",
"properties": [
{
"name": "x_percentage",
"type": "double",
"description": "The abscissa of the rectangle's center, as a percentage of the media width"
},
{
"name": "y_percentage",
"type": "double",
"description": "The ordinate of the rectangle's center, as a percentage of the media height"
},
{
"name": "width_percentage",
"type": "double",
"description": "The width of the rectangle, as a percentage of the media width"
},
{
"name": "height_percentage",
"type": "double",
"description": "The height of the rectangle, as a percentage of the media height"
},
{
"name": "rotation_angle",
"type": "double",
"description": "Clockwise rotation angle of the rectangle, in degrees; 0-360"
}
]
},
{
"name": "storyAreaTypeLocation",
"description": "An area pointing to a location",
"class": "StoryAreaType",
"properties": [
{
"name": "location",
"type": "location",
"description": "The location"
}
]
},
{
"name": "storyAreaTypeVenue",
"description": "An area pointing to a venue",
"class": "StoryAreaType",
"properties": [
{
"name": "venue",
"type": "venue",
"description": "Information about the venue"
}
]
},
{
"name": "storyAreaTypeSuggestedReaction",
"description": "An area pointing to a suggested reaction. App needs to show a clickable reaction on the area and call setStoryReaction when the are is clicked",
"class": "StoryAreaType",
"properties": [
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "total_count",
"type": "int32",
"description": "Number of times the reaction was added"
},
{
"name": "is_dark",
"type": "Bool",
"description": "True, if reaction has a dark background"
},
{
"name": "is_flipped",
"type": "Bool",
"description": "True, if reaction corner is flipped"
}
]
},
{
"name": "storyAreaTypeMessage",
"description": "An area pointing to a message",
"class": "StoryAreaType",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
}
]
},
{
"name": "storyArea",
"description": "Describes a clickable rectangle area on a story media",
"class": "StoryArea",
"properties": [
{
"name": "position",
"type": "storyAreaPosition",
"description": "Position of the area"
},
{
"name": "type",
"type": "StoryAreaType",
"description": "Type of the area"
}
]
},
{
"name": "inputStoryAreaTypeLocation",
"description": "An area pointing to a location",
"class": "InputStoryAreaType",
"properties": [
{
"name": "location",
"type": "location",
"description": "The location"
}
]
},
{
"name": "inputStoryAreaTypeFoundVenue",
"description": "An area pointing to a venue found by the bot getOption(\"venue_search_bot_username\")",
"class": "InputStoryAreaType",
"properties": [
{
"name": "query_id",
"type": "int64",
"description": "Identifier of the inline query, used to found the venue"
},
{
"name": "result_id",
"type": "string",
"description": "Identifier of the inline query result"
}
]
},
{
"name": "inputStoryAreaTypePreviousVenue",
"description": "An area pointing to a venue already added to the story",
"class": "InputStoryAreaType",
"properties": [
{
"name": "venue_provider",
"type": "string",
"description": "Provider of the venue"
},
{
"name": "venue_id",
"type": "string",
"description": "Identifier of the venue in the provider database"
}
]
},
{
"name": "inputStoryAreaTypeSuggestedReaction",
"description": "An area pointing to a suggested reaction",
"class": "InputStoryAreaType",
"properties": [
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "is_dark",
"type": "Bool",
"description": "True, if reaction has a dark background"
},
{
"name": "is_flipped",
"type": "Bool",
"description": "True, if reaction corner is flipped"
}
]
},
{
"name": "inputStoryAreaTypeMessage",
"description": "An area pointing to a message",
"class": "InputStoryAreaType",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the message. Currently, the chat must be a supergroup or a channel chat"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message. Only successfully sent non-scheduled messages can be specified"
}
]
},
{
"name": "inputStoryArea",
"description": "Describes a clickable rectangle area on a story media to be added",
"class": "InputStoryArea",
"properties": [
{
"name": "position",
"type": "storyAreaPosition",
"description": "Position of the area"
},
{
"name": "type",
"type": "InputStoryAreaType",
"description": "Type of the area"
}
]
},
{
"name": "inputStoryAreas",
"description": "Contains a list of story areas to be added",
"class": "InputStoryAreas",
"properties": [
{
"name": "areas",
"type": "vector\u003cinputStoryArea\u003e",
"description": "List of input story areas. Currently, a story can have up to 10 inputStoryAreaTypeLocation, inputStoryAreaTypeFoundVenue, and inputStoryAreaTypePreviousVenue areas, up to getOption(\"story_suggested_reaction_area_count_max\") inputStoryAreaTypeSuggestedReaction areas, and up to 1 inputStoryAreaTypeMessage area"
}
]
},
{
"name": "storyVideo",
"description": "Describes a video file sent in a story",
"class": "StoryVideo",
"properties": [
{
"name": "duration",
"type": "double",
"description": "Duration of the video, in seconds"
},
{
"name": "width",
"type": "int32",
"description": "Video width"
},
{
"name": "height",
"type": "int32",
"description": "Video height"
},
{
"name": "has_stickers",
"type": "Bool",
"description": "True, if stickers were added to the video. The list of corresponding sticker sets can be received using getAttachedStickerSets"
},
{
"name": "is_animation",
"type": "Bool",
"description": "True, if the video has no sound"
},
{
"name": "minithumbnail",
"type": "minithumbnail",
"description": "Video minithumbnail; may be null"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Video thumbnail in JPEG or MPEG4 format; may be null"
},
{
"name": "preload_prefix_size",
"type": "int32",
"description": "Size of file prefix, which is supposed to be preloaded, in bytes"
},
{
"name": "video",
"type": "file",
"description": "File containing the video"
}
]
},
{
"name": "storyContentPhoto",
"description": "A photo story",
"class": "StoryContent",
"properties": [
{
"name": "photo",
"type": "photo",
"description": "The photo"
}
]
},
{
"name": "storyContentVideo",
"description": "A video story",
"class": "StoryContent",
"properties": [
{
"name": "video",
"type": "storyVideo",
"description": "The video in MPEG4 format"
},
{
"name": "alternative_video",
"type": "storyVideo",
"description": "Alternative version of the video in MPEG4 format, encoded by x264 codec; may be null"
}
]
},
{
"name": "storyContentUnsupported",
"description": "A story content that is not supported in the current TDLib version",
"class": "StoryContent",
"properties": []
},
{
"name": "inputStoryContentPhoto",
"description": "A photo story",
"class": "InputStoryContent",
"properties": [
{
"name": "photo",
"type": "InputFile",
"description": "Photo to send. The photo must be at most 10 MB in size. The photo size must be 1080x1920"
},
{
"name": "added_sticker_file_ids",
"type": "vector\u003cint32\u003e",
"description": "File identifiers of the stickers added to the photo, if applicable"
}
]
},
{
"name": "inputStoryContentVideo",
"description": "A video story",
"class": "InputStoryContent",
"properties": [
{
"name": "video",
"type": "InputFile",
"description": "Video to be sent. The video size must be 720x1280. The video must be streamable and stored in MPEG4 format, after encoding with x265 codec and key frames added each second"
},
{
"name": "added_sticker_file_ids",
"type": "vector\u003cint32\u003e",
"description": "File identifiers of the stickers added to the video, if applicable"
},
{
"name": "duration",
"type": "double",
"description": "Precise duration of the video, in seconds; 0-60"
},
{
"name": "is_animation",
"type": "Bool",
"description": "True, if the video has no sound"
}
]
},
{
"name": "storyListMain",
"description": "The list of stories, shown in the main chat list and folder chat lists",
"class": "StoryList",
"properties": []
},
{
"name": "storyListArchive",
"description": "The list of stories, shown in the Arvhive chat list",
"class": "StoryList",
"properties": []
},
{
"name": "storyOriginPublicStory",
"description": "The original story was a public story with known sender",
"class": "StoryOrigin",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat that posted original story"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier of the original story"
}
]
},
{
"name": "storyOriginHiddenUser",
"description": "The original story was sent by an unknown user",
"class": "StoryOrigin",
"properties": [
{
"name": "sender_name",
"type": "string",
"description": "Name of the story sender"
}
]
},
{
"name": "storyRepostInfo",
"description": "Contains information about original story that was reposted",
"class": "StoryRepostInfo",
"properties": [
{
"name": "origin",
"type": "StoryOrigin",
"description": "Origin of the story that was reposted"
},
{
"name": "is_content_modified",
"type": "Bool",
"description": "True, if story content was modified during reposting; otherwise, story wasn't modified"
}
]
},
{
"name": "storyInteractionInfo",
"description": "Contains information about interactions with a story",
"class": "StoryInteractionInfo",
"properties": [
{
"name": "view_count",
"type": "int32",
"description": "Number of times the story was viewed"
},
{
"name": "forward_count",
"type": "int32",
"description": "Number of times the story was forwarded; 0 if none or unknown"
},
{
"name": "reaction_count",
"type": "int32",
"description": "Number of reactions added to the story; 0 if none or unknown"
},
{
"name": "recent_viewer_user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of at most 3 recent viewers of the story"
}
]
},
{
"name": "story",
"description": "Represents a story",
"class": "Story",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique story identifier among stories of the given sender"
},
{
"name": "sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of the story; may be null if the story is posted on behalf of the sender_chat_id"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the story was published"
},
{
"name": "is_being_sent",
"type": "Bool",
"description": "True, if the story is being sent by the current user"
},
{
"name": "is_being_edited",
"type": "Bool",
"description": "True, if the story is being edited by the current user"
},
{
"name": "is_edited",
"type": "Bool",
"description": "True, if the story was edited"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the story is saved in the sender's profile and will be available there after expiration"
},
{
"name": "is_visible_only_for_self",
"type": "Bool",
"description": "True, if the story is visible only for the current user"
},
{
"name": "can_be_deleted",
"type": "Bool",
"description": "True, if the story can be deleted"
},
{
"name": "can_be_edited",
"type": "Bool",
"description": "True, if the story can be edited"
},
{
"name": "can_be_forwarded",
"type": "Bool",
"description": "True, if the story can be forwarded as a message. Otherwise, screenshots and saving of the story content must be also forbidden"
},
{
"name": "can_be_replied",
"type": "Bool",
"description": "True, if the story can be replied in the chat with the story sender"
},
{
"name": "can_toggle_is_pinned",
"type": "Bool",
"description": "True, if the story's is_pinned value can be changed"
},
{
"name": "can_get_statistics",
"type": "Bool",
"description": "True, if the story statistics are available through getStoryStatistics"
},
{
"name": "can_get_interactions",
"type": "Bool",
"description": "True, if interactions with the story can be received through getStoryInteractions"
},
{
"name": "has_expired_viewers",
"type": "Bool",
"description": "True, if users viewed the story can't be received, because the story has expired more than getOption(\"story_viewers_expiration_delay\") seconds ago"
},
{
"name": "repost_info",
"type": "storyRepostInfo",
"description": "Information about the original story; may be null if the story wasn't reposted"
},
{
"name": "interaction_info",
"type": "storyInteractionInfo",
"description": "Information about interactions with the story; may be null if the story isn't owned or there were no interactions"
},
{
"name": "chosen_reaction_type",
"type": "ReactionType",
"description": "Type of the chosen reaction; may be null if none"
},
{
"name": "privacy_settings",
"type": "StoryPrivacySettings",
"description": "Privacy rules affecting story visibility; may be approximate for non-owned stories"
},
{
"name": "content",
"type": "StoryContent",
"description": "Content of the story"
},
{
"name": "areas",
"type": "vector\u003cstoryArea\u003e",
"description": "Clickable areas to be shown on the story content"
},
{
"name": "caption",
"type": "formattedText",
"description": "Caption of the story"
}
]
},
{
"name": "stories",
"description": "Represents a list of stories",
"class": "Stories",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of stories found"
},
{
"name": "stories",
"type": "vector\u003cstory\u003e",
"description": "The list of stories"
}
]
},
{
"name": "storyFullId",
"description": "Contains identifier of a story along with identifier of its sender",
"class": "StoryFullId",
"properties": [
{
"name": "sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Unique story identifier among stories of the given sender"
}
]
},
{
"name": "storyInfo",
"description": "Contains basic information about a story",
"class": "StoryInfo",
"properties": [
{
"name": "story_id",
"type": "int32",
"description": "Unique story identifier among stories of the given sender"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the story was published"
},
{
"name": "is_for_close_friends",
"type": "Bool",
"description": "True, if the story is available only to close friends"
}
]
},
{
"name": "chatActiveStories",
"description": "Describes active stories posted by a chat",
"class": "ChatActiveStories",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the stories"
},
{
"name": "list",
"type": "StoryList",
"description": "Identifier of the story list in which the stories are shown; may be null if the stories aren't shown in a story list"
},
{
"name": "order",
"type": "int53",
"description": "A parameter used to determine order of the stories in the story list; 0 if the stories doesn't need to be shown in the story list. Stories must be sorted by the pair (order, story_sender_chat_id) in descending order"
},
{
"name": "max_read_story_id",
"type": "int32",
"description": "Identifier of the last read active story"
},
{
"name": "stories",
"type": "vector\u003cstoryInfo\u003e",
"description": "Basic information about the stories; use getStory to get full information about the stories. The stories are in a chronological order (i.e., in order of increasing story identifiers)"
}
]
},
{
"name": "storyInteractionTypeView",
"description": "A view of the story",
"class": "StoryInteractionType",
"properties": [
{
"name": "chosen_reaction_type",
"type": "ReactionType",
"description": "Type of the reaction that was chosen by the viewer; may be null if none"
}
]
},
{
"name": "storyInteractionTypeForward",
"description": "A forward of the story as a message",
"class": "StoryInteractionType",
"properties": [
{
"name": "message",
"type": "message",
"description": "The message with story forward"
}
]
},
{
"name": "storyInteractionTypeRepost",
"description": "A repost of the story as a story",
"class": "StoryInteractionType",
"properties": [
{
"name": "story",
"type": "story",
"description": "The reposted story"
}
]
},
{
"name": "storyInteraction",
"description": "Represents interaction with a story",
"class": "StoryInteraction",
"properties": [
{
"name": "actor_id",
"type": "MessageSender",
"description": "Identifier of the user or chat that made the interaction"
},
{
"name": "interaction_date",
"type": "int32",
"description": "Approximate point in time (Unix timestamp) when the interaction happened"
},
{
"name": "block_list",
"type": "BlockList",
"description": "Block list to which the actor is added; may be null if none or for chat stories"
},
{
"name": "type",
"type": "StoryInteractionType",
"description": "Type of the interaction"
}
]
},
{
"name": "storyInteractions",
"description": "Represents a list of interactions with a story",
"class": "StoryInteractions",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of interactions found"
},
{
"name": "total_forward_count",
"type": "int32",
"description": "Approximate total number of found forwards and reposts; always 0 for chat stories"
},
{
"name": "total_reaction_count",
"type": "int32",
"description": "Approximate total number of found reactions; always 0 for chat stories"
},
{
"name": "interactions",
"type": "vector\u003cstoryInteraction\u003e",
"description": "List of story interactions"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "quickReplyMessage",
"description": "Describes a message that can be used for quick reply",
"class": "QuickReplyMessage",
"properties": [
{
"name": "id",
"type": "int53",
"description": "Unique message identifier among all quick replies"
},
{
"name": "sending_state",
"type": "MessageSendingState",
"description": "The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent"
},
{
"name": "can_be_edited",
"type": "Bool",
"description": "True, if the message can be edited"
},
{
"name": "reply_to_message_id",
"type": "int53",
"description": "Information about the identifier of the quick reply message to which the message replies"
},
{
"name": "via_bot_user_id",
"type": "int53",
"description": "If non-zero, the user identifier of the bot through which this message was sent"
},
{
"name": "media_album_id",
"type": "int64",
"description": "Unique identifier of an album this message belongs to. Only audios, documents, photos and videos can be grouped together in albums"
},
{
"name": "content",
"type": "MessageContent",
"description": "Content of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "Inline keyboard reply markup for the message; may be null if none"
}
]
},
{
"name": "quickReplyShortcut",
"description": "Describes a shortcut that can be used for a quick reply",
"class": "QuickReplyShortcut",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique shortcut identifier"
},
{
"name": "name",
"type": "string",
"description": "The name of the shortcut that can be used to use the shortcut"
},
{
"name": "first_message",
"type": "quickReplyMessage",
"description": "The first shortcut message"
},
{
"name": "message_count",
"type": "int32",
"description": "The total number of messages in the shortcut"
}
]
},
{
"name": "publicForwardMessage",
"description": "Contains a public forward as a message",
"class": "PublicForward",
"properties": [
{
"name": "message",
"type": "message",
"description": "Information about the message"
}
]
},
{
"name": "publicForwardStory",
"description": "Contains a public repost to a story",
"class": "PublicForward",
"properties": [
{
"name": "story",
"type": "story",
"description": "Information about the story"
}
]
},
{
"name": "publicForwards",
"description": "Represents a list of public forwards and reposts as a story of a message or a story",
"class": "PublicForwards",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of messages and stories found"
},
{
"name": "forwards",
"type": "vector\u003cPublicForward\u003e",
"description": "List of found public forwards and reposts"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "chatBoostLevelFeatures",
"description": "Contains a list of features available on a specific chat boost level",
"class": "ChatBoostLevelFeatures",
"properties": [
{
"name": "level",
"type": "int32",
"description": "Target chat boost level"
},
{
"name": "story_per_day_count",
"type": "int32",
"description": "Number of stories that the chat can publish daily"
},
{
"name": "custom_emoji_reaction_count",
"type": "int32",
"description": "Number of custom emoji reactions that can be added to the list of available reactions"
},
{
"name": "title_color_count",
"type": "int32",
"description": "Number of custom colors for chat title"
},
{
"name": "profile_accent_color_count",
"type": "int32",
"description": "Number of custom colors for profile photo background"
},
{
"name": "can_set_profile_background_custom_emoji",
"type": "Bool",
"description": "True, if custom emoji for profile background can be set"
},
{
"name": "accent_color_count",
"type": "int32",
"description": "Number of custom colors for background of empty chat photo, replies to messages and link previews"
},
{
"name": "can_set_background_custom_emoji",
"type": "Bool",
"description": "True, if custom emoji for reply header and link preview background can be set"
},
{
"name": "can_set_emoji_status",
"type": "Bool",
"description": "True, if emoji status can be set"
},
{
"name": "chat_theme_background_count",
"type": "int32",
"description": "Number of chat theme backgrounds that can be set as chat background"
},
{
"name": "can_set_custom_background",
"type": "Bool",
"description": "True, if custom background can be set in the chat for all users"
},
{
"name": "can_set_custom_emoji_sticker_set",
"type": "Bool",
"description": "True, if custom emoji sticker set can be set for the chat"
},
{
"name": "can_recognize_speech",
"type": "Bool",
"description": "True, if speech recognition can be used for video note and voice note messages by all users"
}
]
},
{
"name": "chatBoostFeatures",
"description": "Contains a list of features available on the first chat boost levels",
"class": "ChatBoostFeatures",
"properties": [
{
"name": "features",
"type": "vector\u003cchatBoostLevelFeatures\u003e",
"description": "The list of features"
},
{
"name": "min_profile_background_custom_emoji_boost_level",
"type": "int32",
"description": "The minimum boost level required to set custom emoji for profile background"
},
{
"name": "min_background_custom_emoji_boost_level",
"type": "int32",
"description": "The minimum boost level required to set custom emoji for reply header and link preview background; for channel chats only"
},
{
"name": "min_emoji_status_boost_level",
"type": "int32",
"description": "The minimum boost level required to set emoji status"
},
{
"name": "min_chat_theme_background_boost_level",
"type": "int32",
"description": "The minimum boost level required to set a chat theme background as chat background"
},
{
"name": "min_custom_background_boost_level",
"type": "int32",
"description": "The minimum boost level required to set custom chat background"
},
{
"name": "min_custom_emoji_sticker_set_boost_level",
"type": "int32",
"description": "The minimum boost level required to set custom emoji sticker set for the chat; for supergroup chats only"
},
{
"name": "min_speech_recognition_boost_level",
"type": "int32",
"description": "The minimum boost level allowing to recognize speech in video note and voice note messages for non-Premium users; for supergroup chats only"
}
]
},
{
"name": "chatBoostSourceGiftCode",
"description": "The chat created a Telegram Premium gift code for a user",
"class": "ChatBoostSource",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of a user, for which the gift code was created"
},
{
"name": "gift_code",
"type": "string",
"description": "The created Telegram Premium gift code, which is known only if this is a gift code for the current user, or it has already been claimed"
}
]
},
{
"name": "chatBoostSourceGiveaway",
"description": "The chat created a Telegram Premium giveaway",
"class": "ChatBoostSource",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of a user that won in the giveaway; 0 if none"
},
{
"name": "gift_code",
"type": "string",
"description": "The created Telegram Premium gift code if it was used by the user or can be claimed by the current user; an empty string otherwise"
},
{
"name": "giveaway_message_id",
"type": "int53",
"description": "Identifier of the corresponding giveaway message; can be an identifier of a deleted message"
},
{
"name": "is_unclaimed",
"type": "Bool",
"description": "True, if the winner for the corresponding Telegram Premium subscription wasn't chosen, because there were not enough participants"
}
]
},
{
"name": "chatBoostSourcePremium",
"description": "A user with Telegram Premium subscription or gifted Telegram Premium boosted the chat",
"class": "ChatBoostSource",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user"
}
]
},
{
"name": "prepaidPremiumGiveaway",
"description": "Describes a prepaid Telegram Premium giveaway",
"class": "PrepaidPremiumGiveaway",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique identifier of the prepaid giveaway"
},
{
"name": "winner_count",
"type": "int32",
"description": "Number of users which will receive Telegram Premium subscription gift codes"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
},
{
"name": "payment_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the giveaway was paid"
}
]
},
{
"name": "chatBoostStatus",
"description": "Describes current boost status of a chat",
"class": "ChatBoostStatus",
"properties": [
{
"name": "boost_url",
"type": "string",
"description": "An HTTP URL, which can be used to boost the chat"
},
{
"name": "applied_slot_ids",
"type": "vector\u003cint32\u003e",
"description": "Identifiers of boost slots of the current user applied to the chat"
},
{
"name": "level",
"type": "int32",
"description": "Current boost level of the chat"
},
{
"name": "gift_code_boost_count",
"type": "int32",
"description": "The number of boosts received by the chat from created Telegram Premium gift codes and giveaways; always 0 if the current user isn't an administrator in the chat"
},
{
"name": "boost_count",
"type": "int32",
"description": "The number of boosts received by the chat"
},
{
"name": "current_level_boost_count",
"type": "int32",
"description": "The number of boosts added to reach the current level"
},
{
"name": "next_level_boost_count",
"type": "int32",
"description": "The number of boosts needed to reach the next level; 0 if the next level isn't available"
},
{
"name": "premium_member_count",
"type": "int32",
"description": "Approximate number of Telegram Premium subscribers joined the chat; always 0 if the current user isn't an administrator in the chat"
},
{
"name": "premium_member_percentage",
"type": "double",
"description": "A percentage of Telegram Premium subscribers joined the chat; always 0 if the current user isn't an administrator in the chat"
},
{
"name": "prepaid_giveaways",
"type": "vector\u003cprepaidPremiumGiveaway\u003e",
"description": "The list of prepaid giveaways available for the chat; only for chat administrators"
}
]
},
{
"name": "chatBoost",
"description": "Describes a boost applied to a chat",
"class": "ChatBoost",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the boost"
},
{
"name": "count",
"type": "int32",
"description": "The number of identical boosts applied"
},
{
"name": "source",
"type": "ChatBoostSource",
"description": "Source of the boost"
},
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the chat was boosted"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the boost will expire"
}
]
},
{
"name": "foundChatBoosts",
"description": "Contains a list of boosts applied to a chat",
"class": "FoundChatBoosts",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of boosts applied to the chat"
},
{
"name": "boosts",
"type": "vector\u003cchatBoost\u003e",
"description": "List of boosts"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "chatBoostSlot",
"description": "Describes a slot for chat boost",
"class": "ChatBoostSlot",
"properties": [
{
"name": "slot_id",
"type": "int32",
"description": "Unique identifier of the slot"
},
{
"name": "currently_boosted_chat_id",
"type": "int53",
"description": "Identifier of the currently boosted chat; 0 if none"
},
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the chat was boosted; 0 if none"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the boost will expire"
},
{
"name": "cooldown_until_date",
"type": "int32",
"description": "Point in time (Unix timestamp) after which the boost can be used for another chat"
}
]
},
{
"name": "chatBoostSlots",
"description": "Contains a list of chat boost slots",
"class": "ChatBoostSlots",
"properties": [
{
"name": "slots",
"type": "vector\u003cchatBoostSlot\u003e",
"description": "List of boost slots"
}
]
},
{
"name": "callDiscardReasonEmpty",
"description": "The call wasn't discarded, or the reason is unknown",
"class": "CallDiscardReason",
"properties": []
},
{
"name": "callDiscardReasonMissed",
"description": "The call was ended before the conversation started. It was canceled by the caller or missed by the other party",
"class": "CallDiscardReason",
"properties": []
},
{
"name": "callDiscardReasonDeclined",
"description": "The call was ended before the conversation started. It was declined by the other party",
"class": "CallDiscardReason",
"properties": []
},
{
"name": "callDiscardReasonDisconnected",
"description": "The call was ended during the conversation because the users were disconnected",
"class": "CallDiscardReason",
"properties": []
},
{
"name": "callDiscardReasonHungUp",
"description": "The call was ended because one of the parties hung up",
"class": "CallDiscardReason",
"properties": []
},
{
"name": "callProtocol",
"description": "Specifies the supported call protocols",
"class": "CallProtocol",
"properties": [
{
"name": "udp_p2p",
"type": "Bool",
"description": "True, if UDP peer-to-peer connections are supported"
},
{
"name": "udp_reflector",
"type": "Bool",
"description": "True, if connection through UDP reflectors is supported"
},
{
"name": "min_layer",
"type": "int32",
"description": "The minimum supported API layer; use 65"
},
{
"name": "max_layer",
"type": "int32",
"description": "The maximum supported API layer; use 92"
},
{
"name": "library_versions",
"type": "vector\u003cstring\u003e",
"description": "List of supported tgcalls versions"
}
]
},
{
"name": "callServerTypeTelegramReflector",
"description": "A Telegram call reflector",
"class": "CallServerType",
"properties": [
{
"name": "peer_tag",
"type": "bytes",
"description": "A peer tag to be used with the reflector"
},
{
"name": "is_tcp",
"type": "Bool",
"description": "True, if the server uses TCP instead of UDP"
}
]
},
{
"name": "callServerTypeWebrtc",
"description": "A WebRTC server",
"class": "CallServerType",
"properties": [
{
"name": "username",
"type": "string",
"description": "Username to be used for authentication"
},
{
"name": "password",
"type": "string",
"description": "Authentication password"
},
{
"name": "supports_turn",
"type": "Bool",
"description": "True, if the server supports TURN"
},
{
"name": "supports_stun",
"type": "Bool",
"description": "True, if the server supports STUN"
}
]
},
{
"name": "callServer",
"description": "Describes a server for relaying call data",
"class": "CallServer",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Server identifier"
},
{
"name": "ip_address",
"type": "string",
"description": "Server IPv4 address"
},
{
"name": "ipv6_address",
"type": "string",
"description": "Server IPv6 address"
},
{
"name": "port",
"type": "int32",
"description": "Server port number"
},
{
"name": "type",
"type": "CallServerType",
"description": "Server type"
}
]
},
{
"name": "callId",
"description": "Contains the call identifier",
"class": "CallId",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Call identifier"
}
]
},
{
"name": "groupCallId",
"description": "Contains the group call identifier",
"class": "GroupCallId",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Group call identifier"
}
]
},
{
"name": "callStatePending",
"description": "The call is pending, waiting to be accepted by a user",
"class": "CallState",
"properties": [
{
"name": "is_created",
"type": "Bool",
"description": "True, if the call has already been created by the server"
},
{
"name": "is_received",
"type": "Bool",
"description": "True, if the call has already been received by the other party"
}
]
},
{
"name": "callStateExchangingKeys",
"description": "The call has been answered and encryption keys are being exchanged",
"class": "CallState",
"properties": []
},
{
"name": "callStateReady",
"description": "The call is ready to use",
"class": "CallState",
"properties": [
{
"name": "protocol",
"type": "callProtocol",
"description": "Call protocols supported by the other call participant"
},
{
"name": "servers",
"type": "vector\u003ccallServer\u003e",
"description": "List of available call servers"
},
{
"name": "config",
"type": "string",
"description": "A JSON-encoded call config"
},
{
"name": "encryption_key",
"type": "bytes",
"description": "Call encryption key"
},
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "Encryption key emojis fingerprint"
},
{
"name": "allow_p2p",
"type": "Bool",
"description": "True, if peer-to-peer connection is allowed by users privacy settings"
}
]
},
{
"name": "callStateHangingUp",
"description": "The call is hanging up after discardCall has been called",
"class": "CallState",
"properties": []
},
{
"name": "callStateDiscarded",
"description": "The call has ended successfully",
"class": "CallState",
"properties": [
{
"name": "reason",
"type": "CallDiscardReason",
"description": "The reason why the call has ended"
},
{
"name": "need_rating",
"type": "Bool",
"description": "True, if the call rating must be sent to the server"
},
{
"name": "need_debug_information",
"type": "Bool",
"description": "True, if the call debug information must be sent to the server"
},
{
"name": "need_log",
"type": "Bool",
"description": "True, if the call log must be sent to the server"
}
]
},
{
"name": "callStateError",
"description": "The call has ended with an error",
"class": "CallState",
"properties": [
{
"name": "error",
"type": "error",
"description": "Error. An error with the code 4005000 will be returned if an outgoing call is missed because of an expired timeout"
}
]
},
{
"name": "groupCallVideoQualityThumbnail",
"description": "The worst available video quality",
"class": "GroupCallVideoQuality",
"properties": []
},
{
"name": "groupCallVideoQualityMedium",
"description": "The medium video quality",
"class": "GroupCallVideoQuality",
"properties": []
},
{
"name": "groupCallVideoQualityFull",
"description": "The best available video quality",
"class": "GroupCallVideoQuality",
"properties": []
},
{
"name": "groupCallStream",
"description": "Describes an available stream in a group call",
"class": "GroupCallStream",
"properties": [
{
"name": "channel_id",
"type": "int32",
"description": "Identifier of an audio/video channel"
},
{
"name": "scale",
"type": "int32",
"description": "Scale of segment durations in the stream. The duration is 1000/(2**scale) milliseconds"
},
{
"name": "time_offset",
"type": "int53",
"description": "Point in time when the stream currently ends; Unix timestamp in milliseconds"
}
]
},
{
"name": "groupCallStreams",
"description": "Represents a list of group call streams",
"class": "GroupCallStreams",
"properties": [
{
"name": "streams",
"type": "vector\u003cgroupCallStream\u003e",
"description": "A list of group call streams"
}
]
},
{
"name": "rtmpUrl",
"description": "Represents an RTMP URL",
"class": "RtmpUrl",
"properties": [
{
"name": "url",
"type": "string",
"description": "The URL"
},
{
"name": "stream_key",
"type": "string",
"description": "Stream key"
}
]
},
{
"name": "groupCallRecentSpeaker",
"description": "Describes a recently speaking participant in a group call",
"class": "GroupCallRecentSpeaker",
"properties": [
{
"name": "participant_id",
"type": "MessageSender",
"description": "Group call participant identifier"
},
{
"name": "is_speaking",
"type": "Bool",
"description": "True, is the user has spoken recently"
}
]
},
{
"name": "groupCall",
"description": "Describes a group call",
"class": "GroupCall",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "title",
"type": "string",
"description": "Group call title"
},
{
"name": "scheduled_start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 if it is already active or was ended"
},
{
"name": "enabled_start_notification",
"type": "Bool",
"description": "True, if the group call is scheduled and the current user will receive a notification when the group call starts"
},
{
"name": "is_active",
"type": "Bool",
"description": "True, if the call is active"
},
{
"name": "is_rtmp_stream",
"type": "Bool",
"description": "True, if the chat is an RTMP stream instead of an ordinary video chat"
},
{
"name": "is_joined",
"type": "Bool",
"description": "True, if the call is joined"
},
{
"name": "need_rejoin",
"type": "Bool",
"description": "True, if user was kicked from the call because of network loss and the call needs to be rejoined"
},
{
"name": "can_be_managed",
"type": "Bool",
"description": "True, if the current user can manage the group call"
},
{
"name": "participant_count",
"type": "int32",
"description": "Number of participants in the group call"
},
{
"name": "has_hidden_listeners",
"type": "Bool",
"description": "True, if group call participants, which are muted, aren't returned in participant list"
},
{
"name": "loaded_all_participants",
"type": "Bool",
"description": "True, if all group call participants are loaded"
},
{
"name": "recent_speakers",
"type": "vector\u003cgroupCallRecentSpeaker\u003e",
"description": "At most 3 recently speaking users in the group call"
},
{
"name": "is_my_video_enabled",
"type": "Bool",
"description": "True, if the current user's video is enabled"
},
{
"name": "is_my_video_paused",
"type": "Bool",
"description": "True, if the current user's video is paused"
},
{
"name": "can_enable_video",
"type": "Bool",
"description": "True, if the current user can broadcast video or share screen"
},
{
"name": "mute_new_participants",
"type": "Bool",
"description": "True, if only group call administrators can unmute new participants"
},
{
"name": "can_toggle_mute_new_participants",
"type": "Bool",
"description": "True, if the current user can enable or disable mute_new_participants setting"
},
{
"name": "record_duration",
"type": "int32",
"description": "Duration of the ongoing group call recording, in seconds; 0 if none. An updateGroupCall update is not triggered when value of this field changes, but the same recording goes on"
},
{
"name": "is_video_recorded",
"type": "Bool",
"description": "True, if a video file is being recorded for the call"
},
{
"name": "duration",
"type": "int32",
"description": "Call duration, in seconds; for ended calls only"
}
]
},
{
"name": "groupCallVideoSourceGroup",
"description": "Describes a group of video synchronization source identifiers",
"class": "GroupCallVideoSourceGroup",
"properties": [
{
"name": "semantics",
"type": "string",
"description": "The semantics of sources, one of \"SIM\" or \"FID\""
},
{
"name": "source_ids",
"type": "vector\u003cint32\u003e",
"description": "The list of synchronization source identifiers"
}
]
},
{
"name": "groupCallParticipantVideoInfo",
"description": "Contains information about a group call participant's video channel",
"class": "GroupCallParticipantVideoInfo",
"properties": [
{
"name": "source_groups",
"type": "vector\u003cgroupCallVideoSourceGroup\u003e",
"description": "List of synchronization source groups of the video"
},
{
"name": "endpoint_id",
"type": "string",
"description": "Video channel endpoint identifier"
},
{
"name": "is_paused",
"type": "Bool",
"description": "True, if the video is paused. This flag needs to be ignored, if new video frames are received"
}
]
},
{
"name": "groupCallParticipant",
"description": "Represents a group call participant",
"class": "GroupCallParticipant",
"properties": [
{
"name": "participant_id",
"type": "MessageSender",
"description": "Identifier of the group call participant"
},
{
"name": "audio_source_id",
"type": "int32",
"description": "User's audio channel synchronization source identifier"
},
{
"name": "screen_sharing_audio_source_id",
"type": "int32",
"description": "User's screen sharing audio channel synchronization source identifier"
},
{
"name": "video_info",
"type": "groupCallParticipantVideoInfo",
"description": "Information about user's video channel; may be null if there is no active video"
},
{
"name": "screen_sharing_video_info",
"type": "groupCallParticipantVideoInfo",
"description": "Information about user's screen sharing video channel; may be null if there is no active screen sharing video"
},
{
"name": "bio",
"type": "string",
"description": "The participant user's bio or the participant chat's description"
},
{
"name": "is_current_user",
"type": "Bool",
"description": "True, if the participant is the current user"
},
{
"name": "is_speaking",
"type": "Bool",
"description": "True, if the participant is speaking as set by setGroupCallParticipantIsSpeaking"
},
{
"name": "is_hand_raised",
"type": "Bool",
"description": "True, if the participant hand is raised"
},
{
"name": "can_be_muted_for_all_users",
"type": "Bool",
"description": "True, if the current user can mute the participant for all other group call participants"
},
{
"name": "can_be_unmuted_for_all_users",
"type": "Bool",
"description": "True, if the current user can allow the participant to unmute themselves or unmute the participant (if the participant is the current user)"
},
{
"name": "can_be_muted_for_current_user",
"type": "Bool",
"description": "True, if the current user can mute the participant only for self"
},
{
"name": "can_be_unmuted_for_current_user",
"type": "Bool",
"description": "True, if the current user can unmute the participant for self"
},
{
"name": "is_muted_for_all_users",
"type": "Bool",
"description": "True, if the participant is muted for all users"
},
{
"name": "is_muted_for_current_user",
"type": "Bool",
"description": "True, if the participant is muted for the current user"
},
{
"name": "can_unmute_self",
"type": "Bool",
"description": "True, if the participant is muted for all users, but can unmute themselves"
},
{
"name": "volume_level",
"type": "int32",
"description": "Participant's volume level; 1-20000 in hundreds of percents"
},
{
"name": "order",
"type": "string",
"description": "User's order in the group call participant list. Orders must be compared lexicographically. The bigger is order, the higher is user in the list. If order is empty, the user must be removed from the participant list"
}
]
},
{
"name": "callProblemEcho",
"description": "The user heard their own voice",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemNoise",
"description": "The user heard background noise",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemInterruptions",
"description": "The other side kept disappearing",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemDistortedSpeech",
"description": "The speech was distorted",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemSilentLocal",
"description": "The user couldn't hear the other side",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemSilentRemote",
"description": "The other side couldn't hear the user",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemDropped",
"description": "The call ended unexpectedly",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemDistortedVideo",
"description": "The video was distorted",
"class": "CallProblem",
"properties": []
},
{
"name": "callProblemPixelatedVideo",
"description": "The video was pixelated",
"class": "CallProblem",
"properties": []
},
{
"name": "call",
"description": "Describes a call",
"class": "Call",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Call identifier, not persistent"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier of the other call participant"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the call is outgoing"
},
{
"name": "is_video",
"type": "Bool",
"description": "True, if the call is a video call"
},
{
"name": "state",
"type": "CallState",
"description": "Call state"
}
]
},
{
"name": "firebaseAuthenticationSettingsAndroid",
"description": "Settings for Firebase Authentication in the official Android application",
"class": "FirebaseAuthenticationSettings",
"properties": []
},
{
"name": "firebaseAuthenticationSettingsIos",
"description": "Settings for Firebase Authentication in the official iOS application",
"class": "FirebaseAuthenticationSettings",
"properties": [
{
"name": "device_token",
"type": "string",
"description": "Device token from Apple Push Notification service"
},
{
"name": "is_app_sandbox",
"type": "Bool",
"description": "True, if App Sandbox is enabled"
}
]
},
{
"name": "phoneNumberAuthenticationSettings",
"description": "Contains settings for the authentication of the user's phone number",
"class": "PhoneNumberAuthenticationSettings",
"properties": [
{
"name": "allow_flash_call",
"type": "Bool",
"description": "Pass true if the authentication code may be sent via a flash call to the specified phone number"
},
{
"name": "allow_missed_call",
"type": "Bool",
"description": "Pass true if the authentication code may be sent via a missed call to the specified phone number"
},
{
"name": "is_current_phone_number",
"type": "Bool",
"description": "Pass true if the authenticated phone number is used on the current device"
},
{
"name": "allow_sms_retriever_api",
"type": "Bool",
"description": "For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services \u003e= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details"
},
{
"name": "firebase_authentication_settings",
"type": "FirebaseAuthenticationSettings",
"description": "For official Android and iOS applications only; pass null otherwise. Settings for Firebase Authentication"
},
{
"name": "authentication_tokens",
"type": "vector\u003cstring\u003e",
"description": "List of up to 20 authentication tokens, recently received in updateOption(\"authentication_token\") in previously logged out sessions"
}
]
},
{
"name": "addedReaction",
"description": "Represents a reaction applied to a message",
"class": "AddedReaction",
"properties": [
{
"name": "type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the chat member, applied the reaction"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the reaction was added by the current user"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the reaction was added"
}
]
},
{
"name": "addedReactions",
"description": "Represents a list of reactions added to a message",
"class": "AddedReactions",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "The total number of found reactions"
},
{
"name": "reactions",
"type": "vector\u003caddedReaction\u003e",
"description": "The list of added reactions"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "availableReaction",
"description": "Represents an available reaction",
"class": "AvailableReaction",
"properties": [
{
"name": "type",
"type": "ReactionType",
"description": "Type of the reaction"
},
{
"name": "needs_premium",
"type": "Bool",
"description": "True, if Telegram Premium is needed to send the reaction"
}
]
},
{
"name": "availableReactions",
"description": "Represents a list of reactions that can be added to a message",
"class": "AvailableReactions",
"properties": [
{
"name": "top_reactions",
"type": "vector\u003cavailableReaction\u003e",
"description": "List of reactions to be shown at the top"
},
{
"name": "recent_reactions",
"type": "vector\u003cavailableReaction\u003e",
"description": "List of recently used reactions"
},
{
"name": "popular_reactions",
"type": "vector\u003cavailableReaction\u003e",
"description": "List of popular reactions"
},
{
"name": "allow_custom_emoji",
"type": "Bool",
"description": "True, if any custom emoji reaction can be added by Telegram Premium subscribers"
},
{
"name": "are_tags",
"type": "Bool",
"description": "True, if the reactions will be tags and the message can be found by them"
},
{
"name": "unavailability_reason",
"type": "ReactionUnavailabilityReason",
"description": "The reason why the current user can't add reactions to the message, despite some other users can; may be null if none"
}
]
},
{
"name": "emojiReaction",
"description": "Contains information about an emoji reaction",
"class": "EmojiReaction",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "Text representation of the reaction"
},
{
"name": "title",
"type": "string",
"description": "Reaction title"
},
{
"name": "is_active",
"type": "Bool",
"description": "True, if the reaction can be added to new messages and enabled in chats"
},
{
"name": "static_icon",
"type": "sticker",
"description": "Static icon for the reaction"
},
{
"name": "appear_animation",
"type": "sticker",
"description": "Appear animation for the reaction"
},
{
"name": "select_animation",
"type": "sticker",
"description": "Select animation for the reaction"
},
{
"name": "activate_animation",
"type": "sticker",
"description": "Activate animation for the reaction"
},
{
"name": "effect_animation",
"type": "sticker",
"description": "Effect animation for the reaction"
},
{
"name": "around_animation",
"type": "sticker",
"description": "Around animation for the reaction; may be null"
},
{
"name": "center_animation",
"type": "sticker",
"description": "Center animation for the reaction; may be null"
}
]
},
{
"name": "reactionUnavailabilityReasonAnonymousAdministrator",
"description": "The user is an anonymous administrator in the supergroup, but isn't a creator of it, so they can't vote on behalf of the supergroup",
"class": "ReactionUnavailabilityReason",
"properties": []
},
{
"name": "reactionUnavailabilityReasonGuest",
"description": "The user isn't a member of the supergroup and can't send messages and reactions there without joining",
"class": "ReactionUnavailabilityReason",
"properties": []
},
{
"name": "animations",
"description": "Represents a list of animations",
"class": "Animations",
"properties": [
{
"name": "animations",
"type": "vector\u003canimation\u003e",
"description": "List of animations"
}
]
},
{
"name": "diceStickersRegular",
"description": "A regular animated sticker",
"class": "DiceStickers",
"properties": [
{
"name": "sticker",
"type": "sticker",
"description": "The animated sticker with the dice animation"
}
]
},
{
"name": "diceStickersSlotMachine",
"description": "Animated stickers to be combined into a slot machine",
"class": "DiceStickers",
"properties": [
{
"name": "background",
"type": "sticker",
"description": "The animated sticker with the slot machine background. The background animation must start playing after all reel animations finish"
},
{
"name": "lever",
"type": "sticker",
"description": "The animated sticker with the lever animation. The lever animation must play once in the initial dice state"
},
{
"name": "left_reel",
"type": "sticker",
"description": "The animated sticker with the left reel"
},
{
"name": "center_reel",
"type": "sticker",
"description": "The animated sticker with the center reel"
},
{
"name": "right_reel",
"type": "sticker",
"description": "The animated sticker with the right reel"
}
]
},
{
"name": "importedContacts",
"description": "Represents the result of an importContacts request",
"class": "ImportedContacts",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of the imported contacts in the same order as they were specified in the request; 0 if the contact is not yet a registered user"
},
{
"name": "importer_count",
"type": "vector\u003cint32\u003e",
"description": "The number of users that imported the corresponding contact; 0 for already registered users or if unavailable"
}
]
},
{
"name": "speechRecognitionResultPending",
"description": "The speech recognition is ongoing",
"class": "SpeechRecognitionResult",
"properties": [
{
"name": "partial_text",
"type": "string",
"description": "Partially recognized text"
}
]
},
{
"name": "speechRecognitionResultText",
"description": "The speech recognition successfully finished",
"class": "SpeechRecognitionResult",
"properties": [
{
"name": "text",
"type": "string",
"description": "Recognized text"
}
]
},
{
"name": "speechRecognitionResultError",
"description": "The speech recognition failed",
"class": "SpeechRecognitionResult",
"properties": [
{
"name": "error",
"type": "error",
"description": "Recognition error. An error with a message \"MSG_VOICE_TOO_LONG\" is returned when media duration is too big to be recognized"
}
]
},
{
"name": "businessConnection",
"description": "Describes a connection of the bot with a business account",
"class": "BusinessConnection",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the connection"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the business user that created the connection"
},
{
"name": "user_chat_id",
"type": "int53",
"description": "Chat identifier of the private chat with the user"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the connection was established"
},
{
"name": "can_reply",
"type": "Bool",
"description": "True, if the bot can send messages to the connected user; false otherwise"
},
{
"name": "is_enabled",
"type": "Bool",
"description": "True, if the connection is enabled; false otherwise"
}
]
},
{
"name": "attachmentMenuBotColor",
"description": "Describes a color to highlight a bot added to attachment menu",
"class": "AttachmentMenuBotColor",
"properties": [
{
"name": "light_color",
"type": "int32",
"description": "Color in the RGB24 format for light themes"
},
{
"name": "dark_color",
"type": "int32",
"description": "Color in the RGB24 format for dark themes"
}
]
},
{
"name": "attachmentMenuBot",
"description": "Represents a bot, which can be added to attachment or side menu",
"class": "AttachmentMenuBot",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the bot"
},
{
"name": "supports_self_chat",
"type": "Bool",
"description": "True, if the bot supports opening from attachment menu in the chat with the bot"
},
{
"name": "supports_user_chats",
"type": "Bool",
"description": "True, if the bot supports opening from attachment menu in private chats with ordinary users"
},
{
"name": "supports_bot_chats",
"type": "Bool",
"description": "True, if the bot supports opening from attachment menu in private chats with other bots"
},
{
"name": "supports_group_chats",
"type": "Bool",
"description": "True, if the bot supports opening from attachment menu in basic group and supergroup chats"
},
{
"name": "supports_channel_chats",
"type": "Bool",
"description": "True, if the bot supports opening from attachment menu in channel chats"
},
{
"name": "request_write_access",
"type": "Bool",
"description": "True, if the user must be asked for the permission to send messages to the bot"
},
{
"name": "is_added",
"type": "Bool",
"description": "True, if the bot was explicitly added by the user. If the bot isn't added, then on the first bot launch toggleBotIsAddedToAttachmentMenu must be called and the bot must be added or removed"
},
{
"name": "show_in_attachment_menu",
"type": "Bool",
"description": "True, if the bot must be shown in the attachment menu"
},
{
"name": "show_in_side_menu",
"type": "Bool",
"description": "True, if the bot must be shown in the side menu"
},
{
"name": "show_disclaimer_in_side_menu",
"type": "Bool",
"description": "True, if a disclaimer, why the bot is shown in the side menu, is needed"
},
{
"name": "name",
"type": "string",
"description": "Name for the bot in attachment menu"
},
{
"name": "name_color",
"type": "attachmentMenuBotColor",
"description": "Color to highlight selected name of the bot if appropriate; may be null"
},
{
"name": "default_icon",
"type": "file",
"description": "Default icon for the bot in SVG format; may be null"
},
{
"name": "ios_static_icon",
"type": "file",
"description": "Icon for the bot in SVG format for the official iOS app; may be null"
},
{
"name": "ios_animated_icon",
"type": "file",
"description": "Icon for the bot in TGS format for the official iOS app; may be null"
},
{
"name": "ios_side_menu_icon",
"type": "file",
"description": "Icon for the bot in PNG format for the official iOS app side menu; may be null"
},
{
"name": "android_icon",
"type": "file",
"description": "Icon for the bot in TGS format for the official Android app; may be null"
},
{
"name": "android_side_menu_icon",
"type": "file",
"description": "Icon for the bot in SVG format for the official Android app side menu; may be null"
},
{
"name": "macos_icon",
"type": "file",
"description": "Icon for the bot in TGS format for the official native macOS app; may be null"
},
{
"name": "macos_side_menu_icon",
"type": "file",
"description": "Icon for the bot in PNG format for the official macOS app side menu; may be null"
},
{
"name": "icon_color",
"type": "attachmentMenuBotColor",
"description": "Color to highlight selected icon of the bot if appropriate; may be null"
},
{
"name": "web_app_placeholder",
"type": "file",
"description": "Default placeholder for opened Web Apps in SVG format; may be null"
}
]
},
{
"name": "sentWebAppMessage",
"description": "Information about the message sent by answerWebAppQuery",
"class": "SentWebAppMessage",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Identifier of the sent inline message, if known"
}
]
},
{
"name": "botWriteAccessAllowReasonConnectedWebsite",
"description": "The user connected a website by logging in using Telegram Login Widget on it",
"class": "BotWriteAccessAllowReason",
"properties": [
{
"name": "domain_name",
"type": "string",
"description": "Domain name of the connected website"
}
]
},
{
"name": "botWriteAccessAllowReasonAddedToAttachmentMenu",
"description": "The user added the bot to attachment or side menu using toggleBotIsAddedToAttachmentMenu",
"class": "BotWriteAccessAllowReason",
"properties": []
},
{
"name": "botWriteAccessAllowReasonLaunchedWebApp",
"description": "The user launched a Web App using getWebAppLinkUrl",
"class": "BotWriteAccessAllowReason",
"properties": [
{
"name": "web_app",
"type": "webApp",
"description": "Information about the Web App"
}
]
},
{
"name": "botWriteAccessAllowReasonAcceptedRequest",
"description": "The user accepted bot's request to send messages with allowBotToSendMessages",
"class": "BotWriteAccessAllowReason",
"properties": []
},
{
"name": "httpUrl",
"description": "Contains an HTTP URL",
"class": "HttpUrl",
"properties": [
{
"name": "url",
"type": "string",
"description": "The URL"
}
]
},
{
"name": "userLink",
"description": "Contains an HTTPS URL, which can be used to get information about a user",
"class": "UserLink",
"properties": [
{
"name": "url",
"type": "string",
"description": "The URL"
},
{
"name": "expires_in",
"type": "int32",
"description": "Left time for which the link is valid, in seconds; 0 if the link is a public username link"
}
]
},
{
"name": "inputInlineQueryResultAnimation",
"description": "Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC video",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the query result"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the result thumbnail (JPEG, GIF, or MPEG4), if it exists"
},
{
"name": "thumbnail_mime_type",
"type": "string",
"description": "MIME type of the video thumbnail. If non-empty, must be one of \"image/jpeg\", \"image/gif\" and \"video/mp4\""
},
{
"name": "video_url",
"type": "string",
"description": "The URL of the video file (file size must not exceed 1MB)"
},
{
"name": "video_mime_type",
"type": "string",
"description": "MIME type of the video file. Must be one of \"image/gif\" and \"video/mp4\""
},
{
"name": "video_duration",
"type": "int32",
"description": "Duration of the video, in seconds"
},
{
"name": "video_width",
"type": "int32",
"description": "Width of the video"
},
{
"name": "video_height",
"type": "int32",
"description": "Height of the video"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultArticle",
"description": "Represents a link to an article or web page",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "url",
"type": "string",
"description": "URL of the result, if it exists"
},
{
"name": "hide_url",
"type": "Bool",
"description": "True, if the URL must be not shown"
},
{
"name": "title",
"type": "string",
"description": "Title of the result"
},
{
"name": "description",
"type": "string",
"description": "A short description of the result"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the result thumbnail, if it exists"
},
{
"name": "thumbnail_width",
"type": "int32",
"description": "Thumbnail width, if known"
},
{
"name": "thumbnail_height",
"type": "int32",
"description": "Thumbnail height, if known"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultAudio",
"description": "Represents a link to an MP3 audio file",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the audio file"
},
{
"name": "performer",
"type": "string",
"description": "Performer of the audio file"
},
{
"name": "audio_url",
"type": "string",
"description": "The URL of the audio file"
},
{
"name": "audio_duration",
"type": "int32",
"description": "Audio file duration, in seconds"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAudio, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultContact",
"description": "Represents a user contact",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "contact",
"type": "contact",
"description": "User contact"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the result thumbnail, if it exists"
},
{
"name": "thumbnail_width",
"type": "int32",
"description": "Thumbnail width, if known"
},
{
"name": "thumbnail_height",
"type": "int32",
"description": "Thumbnail height, if known"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultDocument",
"description": "Represents a link to a file",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the resulting file"
},
{
"name": "description",
"type": "string",
"description": "Short description of the result, if known"
},
{
"name": "document_url",
"type": "string",
"description": "URL of the file"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the file content; only \"application/pdf\" and \"application/zip\" are currently allowed"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "The URL of the file thumbnail, if it exists"
},
{
"name": "thumbnail_width",
"type": "int32",
"description": "Width of the thumbnail"
},
{
"name": "thumbnail_height",
"type": "int32",
"description": "Height of the thumbnail"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageDocument, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultGame",
"description": "Represents a game",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "game_short_name",
"type": "string",
"description": "Short name of the game"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
}
]
},
{
"name": "inputInlineQueryResultLocation",
"description": "Represents a point on the map",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "location",
"type": "location",
"description": "Location result"
},
{
"name": "live_period",
"type": "int32",
"description": "Amount of time relative to the message sent time until the location can be updated, in seconds"
},
{
"name": "title",
"type": "string",
"description": "Title of the result"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the result thumbnail, if it exists"
},
{
"name": "thumbnail_width",
"type": "int32",
"description": "Thumbnail width, if known"
},
{
"name": "thumbnail_height",
"type": "int32",
"description": "Thumbnail height, if known"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultPhoto",
"description": "Represents link to a JPEG image",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the result, if known"
},
{
"name": "description",
"type": "string",
"description": "A short description of the result, if known"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the photo thumbnail, if it exists"
},
{
"name": "photo_url",
"type": "string",
"description": "The URL of the JPEG photo (photo size must not exceed 5MB)"
},
{
"name": "photo_width",
"type": "int32",
"description": "Width of the photo"
},
{
"name": "photo_height",
"type": "int32",
"description": "Height of the photo"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessagePhoto, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultSticker",
"description": "Represents a link to a WEBP, TGS, or WEBM sticker",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the sticker thumbnail, if it exists"
},
{
"name": "sticker_url",
"type": "string",
"description": "The URL of the WEBP, TGS, or WEBM sticker (sticker file size must not exceed 5MB)"
},
{
"name": "sticker_width",
"type": "int32",
"description": "Width of the sticker"
},
{
"name": "sticker_height",
"type": "int32",
"description": "Height of the sticker"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageSticker, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultVenue",
"description": "Represents information about a venue",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "venue",
"type": "venue",
"description": "Venue result"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "URL of the result thumbnail, if it exists"
},
{
"name": "thumbnail_width",
"type": "int32",
"description": "Thumbnail width, if known"
},
{
"name": "thumbnail_height",
"type": "int32",
"description": "Thumbnail height, if known"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultVideo",
"description": "Represents a link to a page containing an embedded video player or a video file",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the result"
},
{
"name": "description",
"type": "string",
"description": "A short description of the result, if known"
},
{
"name": "thumbnail_url",
"type": "string",
"description": "The URL of the video thumbnail (JPEG), if it exists"
},
{
"name": "video_url",
"type": "string",
"description": "URL of the embedded video player or video file"
},
{
"name": "mime_type",
"type": "string",
"description": "MIME type of the content of the video URL, only \"text/html\" or \"video/mp4\" are currently supported"
},
{
"name": "video_width",
"type": "int32",
"description": "Width of the video"
},
{
"name": "video_height",
"type": "int32",
"description": "Height of the video"
},
{
"name": "video_duration",
"type": "int32",
"description": "Video duration, in seconds"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageVideo, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inputInlineQueryResultVoiceNote",
"description": "Represents a link to an opus-encoded audio file within an OGG container, single channel audio",
"class": "InputInlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "title",
"type": "string",
"description": "Title of the voice note"
},
{
"name": "voice_note_url",
"type": "string",
"description": "The URL of the voice note file"
},
{
"name": "voice_note_duration",
"type": "int32",
"description": "Duration of the voice note, in seconds"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageVoiceNote, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact"
}
]
},
{
"name": "inlineQueryResultArticle",
"description": "Represents a link to an article or web page",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "url",
"type": "string",
"description": "URL of the result, if it exists"
},
{
"name": "hide_url",
"type": "Bool",
"description": "True, if the URL must be not shown"
},
{
"name": "title",
"type": "string",
"description": "Title of the result"
},
{
"name": "description",
"type": "string",
"description": "A short description of the result"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Result thumbnail in JPEG format; may be null"
}
]
},
{
"name": "inlineQueryResultContact",
"description": "Represents a user contact",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "contact",
"type": "contact",
"description": "A user contact"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Result thumbnail in JPEG format; may be null"
}
]
},
{
"name": "inlineQueryResultLocation",
"description": "Represents a point on the map",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "location",
"type": "location",
"description": "Location result"
},
{
"name": "title",
"type": "string",
"description": "Title of the result"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Result thumbnail in JPEG format; may be null"
}
]
},
{
"name": "inlineQueryResultVenue",
"description": "Represents information about a venue",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "venue",
"type": "venue",
"description": "Venue result"
},
{
"name": "thumbnail",
"type": "thumbnail",
"description": "Result thumbnail in JPEG format; may be null"
}
]
},
{
"name": "inlineQueryResultGame",
"description": "Represents information about a game",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "game",
"type": "game",
"description": "Game result"
}
]
},
{
"name": "inlineQueryResultAnimation",
"description": "Represents an animation file",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "animation",
"type": "animation",
"description": "Animation file"
},
{
"name": "title",
"type": "string",
"description": "Animation title"
}
]
},
{
"name": "inlineQueryResultAudio",
"description": "Represents an audio file",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "audio",
"type": "audio",
"description": "Audio file"
}
]
},
{
"name": "inlineQueryResultDocument",
"description": "Represents a document",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "document",
"type": "document",
"description": "Document"
},
{
"name": "title",
"type": "string",
"description": "Document title"
},
{
"name": "description",
"type": "string",
"description": "Document description"
}
]
},
{
"name": "inlineQueryResultPhoto",
"description": "Represents a photo",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "photo",
"type": "photo",
"description": "Photo"
},
{
"name": "title",
"type": "string",
"description": "Title of the result, if known"
},
{
"name": "description",
"type": "string",
"description": "A short description of the result, if known"
}
]
},
{
"name": "inlineQueryResultSticker",
"description": "Represents a sticker",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "sticker",
"type": "sticker",
"description": "Sticker"
}
]
},
{
"name": "inlineQueryResultVideo",
"description": "Represents a video",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "video",
"type": "video",
"description": "Video"
},
{
"name": "title",
"type": "string",
"description": "Title of the video"
},
{
"name": "description",
"type": "string",
"description": "Description of the video"
}
]
},
{
"name": "inlineQueryResultVoiceNote",
"description": "Represents a voice note",
"class": "InlineQueryResult",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique identifier of the query result"
},
{
"name": "voice_note",
"type": "voiceNote",
"description": "Voice note"
},
{
"name": "title",
"type": "string",
"description": "Title of the voice note"
}
]
},
{
"name": "inlineQueryResultsButtonTypeStartBot",
"description": "Describes the button that opens a private chat with the bot and sends a start message to the bot with the given parameter",
"class": "InlineQueryResultsButtonType",
"properties": [
{
"name": "parameter",
"type": "string",
"description": "The parameter for the bot start message"
}
]
},
{
"name": "inlineQueryResultsButtonTypeWebApp",
"description": "Describes the button that opens a Web App by calling getWebAppUrl",
"class": "InlineQueryResultsButtonType",
"properties": [
{
"name": "url",
"type": "string",
"description": "An HTTP URL to pass to getWebAppUrl"
}
]
},
{
"name": "inlineQueryResultsButton",
"description": "Represents a button to be shown above inline query results",
"class": "InlineQueryResultsButton",
"properties": [
{
"name": "text",
"type": "string",
"description": "The text of the button"
},
{
"name": "type",
"type": "InlineQueryResultsButtonType",
"description": "Type of the button"
}
]
},
{
"name": "inlineQueryResults",
"description": "Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query",
"class": "InlineQueryResults",
"properties": [
{
"name": "inline_query_id",
"type": "int64",
"description": "Unique identifier of the inline query"
},
{
"name": "button",
"type": "inlineQueryResultsButton",
"description": "Button to be shown above inline query results; may be null"
},
{
"name": "results",
"type": "vector\u003cInlineQueryResult\u003e",
"description": "Results of the query"
},
{
"name": "next_offset",
"type": "string",
"description": "The offset for the next request. If empty, then there are no more results"
}
]
},
{
"name": "callbackQueryPayloadData",
"description": "The payload for a general callback button",
"class": "CallbackQueryPayload",
"properties": [
{
"name": "data",
"type": "bytes",
"description": "Data that was attached to the callback button"
}
]
},
{
"name": "callbackQueryPayloadDataWithPassword",
"description": "The payload for a callback button requiring password",
"class": "CallbackQueryPayload",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password for the current user"
},
{
"name": "data",
"type": "bytes",
"description": "Data that was attached to the callback button"
}
]
},
{
"name": "callbackQueryPayloadGame",
"description": "The payload for a game callback button",
"class": "CallbackQueryPayload",
"properties": [
{
"name": "game_short_name",
"type": "string",
"description": "A short name of the game that was attached to the callback button"
}
]
},
{
"name": "callbackQueryAnswer",
"description": "Contains a bot's answer to a callback query",
"class": "CallbackQueryAnswer",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text of the answer"
},
{
"name": "show_alert",
"type": "Bool",
"description": "True, if an alert must be shown to the user instead of a toast notification"
},
{
"name": "url",
"type": "string",
"description": "URL to be opened"
}
]
},
{
"name": "customRequestResult",
"description": "Contains the result of a custom request",
"class": "CustomRequestResult",
"properties": [
{
"name": "result",
"type": "string",
"description": "A JSON-serialized result"
}
]
},
{
"name": "gameHighScore",
"description": "Contains one row of the game high score table",
"class": "GameHighScore",
"properties": [
{
"name": "position",
"type": "int32",
"description": "Position in the high score table"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "score",
"type": "int32",
"description": "User score"
}
]
},
{
"name": "gameHighScores",
"description": "Contains a list of game high scores",
"class": "GameHighScores",
"properties": [
{
"name": "scores",
"type": "vector\u003cgameHighScore\u003e",
"description": "A list of game high scores"
}
]
},
{
"name": "chatEventMessageEdited",
"description": "A message was edited",
"class": "ChatEventAction",
"properties": [
{
"name": "old_message",
"type": "message",
"description": "The original message before the edit"
},
{
"name": "new_message",
"type": "message",
"description": "The message after it was edited"
}
]
},
{
"name": "chatEventMessageDeleted",
"description": "A message was deleted",
"class": "ChatEventAction",
"properties": [
{
"name": "message",
"type": "message",
"description": "Deleted message"
},
{
"name": "can_report_anti_spam_false_positive",
"type": "Bool",
"description": "True, if the message deletion can be reported via reportSupergroupAntiSpamFalsePositive"
}
]
},
{
"name": "chatEventMessagePinned",
"description": "A message was pinned",
"class": "ChatEventAction",
"properties": [
{
"name": "message",
"type": "message",
"description": "Pinned message"
}
]
},
{
"name": "chatEventMessageUnpinned",
"description": "A message was unpinned",
"class": "ChatEventAction",
"properties": [
{
"name": "message",
"type": "message",
"description": "Unpinned message"
}
]
},
{
"name": "chatEventPollStopped",
"description": "A poll in a message was stopped",
"class": "ChatEventAction",
"properties": [
{
"name": "message",
"type": "message",
"description": "The message with the poll"
}
]
},
{
"name": "chatEventMemberJoined",
"description": "A new member joined the chat",
"class": "ChatEventAction",
"properties": []
},
{
"name": "chatEventMemberJoinedByInviteLink",
"description": "A new member joined the chat via an invite link",
"class": "ChatEventAction",
"properties": [
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "Invite link used to join the chat"
},
{
"name": "via_chat_folder_invite_link",
"type": "Bool",
"description": "True, if the user has joined the chat using an invite link for a chat folder"
}
]
},
{
"name": "chatEventMemberJoinedByRequest",
"description": "A new member was accepted to the chat by an administrator",
"class": "ChatEventAction",
"properties": [
{
"name": "approver_user_id",
"type": "int53",
"description": "User identifier of the chat administrator, approved user join request"
},
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "Invite link used to join the chat; may be null"
}
]
},
{
"name": "chatEventMemberInvited",
"description": "A new chat member was invited",
"class": "ChatEventAction",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "New member user identifier"
},
{
"name": "status",
"type": "ChatMemberStatus",
"description": "New member status"
}
]
},
{
"name": "chatEventMemberLeft",
"description": "A member left the chat",
"class": "ChatEventAction",
"properties": []
},
{
"name": "chatEventMemberPromoted",
"description": "A chat member has gained/lost administrator status, or the list of their administrator privileges has changed",
"class": "ChatEventAction",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Affected chat member user identifier"
},
{
"name": "old_status",
"type": "ChatMemberStatus",
"description": "Previous status of the chat member"
},
{
"name": "new_status",
"type": "ChatMemberStatus",
"description": "New status of the chat member"
}
]
},
{
"name": "chatEventMemberRestricted",
"description": "A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed",
"class": "ChatEventAction",
"properties": [
{
"name": "member_id",
"type": "MessageSender",
"description": "Affected chat member identifier"
},
{
"name": "old_status",
"type": "ChatMemberStatus",
"description": "Previous status of the chat member"
},
{
"name": "new_status",
"type": "ChatMemberStatus",
"description": "New status of the chat member"
}
]
},
{
"name": "chatEventAvailableReactionsChanged",
"description": "The chat available reactions were changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_available_reactions",
"type": "ChatAvailableReactions",
"description": "Previous chat available reactions"
},
{
"name": "new_available_reactions",
"type": "ChatAvailableReactions",
"description": "New chat available reactions"
}
]
},
{
"name": "chatEventBackgroundChanged",
"description": "The chat background was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_background",
"type": "chatBackground",
"description": "Previous background; may be null if none"
},
{
"name": "new_background",
"type": "chatBackground",
"description": "New background; may be null if none"
}
]
},
{
"name": "chatEventDescriptionChanged",
"description": "The chat description was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_description",
"type": "string",
"description": "Previous chat description"
},
{
"name": "new_description",
"type": "string",
"description": "New chat description"
}
]
},
{
"name": "chatEventEmojiStatusChanged",
"description": "The chat emoji status was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_emoji_status",
"type": "emojiStatus",
"description": "Previous emoji status; may be null if none"
},
{
"name": "new_emoji_status",
"type": "emojiStatus",
"description": "New emoji status; may be null if none"
}
]
},
{
"name": "chatEventLinkedChatChanged",
"description": "The linked chat of a supergroup was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_linked_chat_id",
"type": "int53",
"description": "Previous supergroup linked chat identifier"
},
{
"name": "new_linked_chat_id",
"type": "int53",
"description": "New supergroup linked chat identifier"
}
]
},
{
"name": "chatEventLocationChanged",
"description": "The supergroup location was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_location",
"type": "chatLocation",
"description": "Previous location; may be null"
},
{
"name": "new_location",
"type": "chatLocation",
"description": "New location; may be null"
}
]
},
{
"name": "chatEventMessageAutoDeleteTimeChanged",
"description": "The message auto-delete timer was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_message_auto_delete_time",
"type": "int32",
"description": "Previous value of message_auto_delete_time"
},
{
"name": "new_message_auto_delete_time",
"type": "int32",
"description": "New value of message_auto_delete_time"
}
]
},
{
"name": "chatEventPermissionsChanged",
"description": "The chat permissions were changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_permissions",
"type": "chatPermissions",
"description": "Previous chat permissions"
},
{
"name": "new_permissions",
"type": "chatPermissions",
"description": "New chat permissions"
}
]
},
{
"name": "chatEventPhotoChanged",
"description": "The chat photo was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_photo",
"type": "chatPhoto",
"description": "Previous chat photo value; may be null"
},
{
"name": "new_photo",
"type": "chatPhoto",
"description": "New chat photo value; may be null"
}
]
},
{
"name": "chatEventSlowModeDelayChanged",
"description": "The slow_mode_delay setting of a supergroup was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_slow_mode_delay",
"type": "int32",
"description": "Previous value of slow_mode_delay, in seconds"
},
{
"name": "new_slow_mode_delay",
"type": "int32",
"description": "New value of slow_mode_delay, in seconds"
}
]
},
{
"name": "chatEventStickerSetChanged",
"description": "The supergroup sticker set was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_sticker_set_id",
"type": "int64",
"description": "Previous identifier of the chat sticker set; 0 if none"
},
{
"name": "new_sticker_set_id",
"type": "int64",
"description": "New identifier of the chat sticker set; 0 if none"
}
]
},
{
"name": "chatEventCustomEmojiStickerSetChanged",
"description": "The supergroup sticker set with allowed custom emoji was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_sticker_set_id",
"type": "int64",
"description": "Previous identifier of the chat sticker set; 0 if none"
},
{
"name": "new_sticker_set_id",
"type": "int64",
"description": "New identifier of the chat sticker set; 0 if none"
}
]
},
{
"name": "chatEventTitleChanged",
"description": "The chat title was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_title",
"type": "string",
"description": "Previous chat title"
},
{
"name": "new_title",
"type": "string",
"description": "New chat title"
}
]
},
{
"name": "chatEventUsernameChanged",
"description": "The chat editable username was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_username",
"type": "string",
"description": "Previous chat username"
},
{
"name": "new_username",
"type": "string",
"description": "New chat username"
}
]
},
{
"name": "chatEventActiveUsernamesChanged",
"description": "The chat active usernames were changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_usernames",
"type": "vector\u003cstring\u003e",
"description": "Previous list of active usernames"
},
{
"name": "new_usernames",
"type": "vector\u003cstring\u003e",
"description": "New list of active usernames"
}
]
},
{
"name": "chatEventAccentColorChanged",
"description": "The chat accent color or background custom emoji were changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_accent_color_id",
"type": "int32",
"description": "Previous identifier of chat accent color"
},
{
"name": "old_background_custom_emoji_id",
"type": "int64",
"description": "Previous identifier of the custom emoji; 0 if none"
},
{
"name": "new_accent_color_id",
"type": "int32",
"description": "New identifier of chat accent color"
},
{
"name": "new_background_custom_emoji_id",
"type": "int64",
"description": "New identifier of the custom emoji; 0 if none"
}
]
},
{
"name": "chatEventProfileAccentColorChanged",
"description": "The chat's profile accent color or profile background custom emoji were changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_profile_accent_color_id",
"type": "int32",
"description": "Previous identifier of chat's profile accent color; -1 if none"
},
{
"name": "old_profile_background_custom_emoji_id",
"type": "int64",
"description": "Previous identifier of the custom emoji; 0 if none"
},
{
"name": "new_profile_accent_color_id",
"type": "int32",
"description": "New identifier of chat's profile accent color; -1 if none"
},
{
"name": "new_profile_background_custom_emoji_id",
"type": "int64",
"description": "New identifier of the custom emoji; 0 if none"
}
]
},
{
"name": "chatEventHasProtectedContentToggled",
"description": "The has_protected_content setting of a channel was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "has_protected_content",
"type": "Bool",
"description": "New value of has_protected_content"
}
]
},
{
"name": "chatEventInvitesToggled",
"description": "The can_invite_users permission of a supergroup chat was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "can_invite_users",
"type": "Bool",
"description": "New value of can_invite_users permission"
}
]
},
{
"name": "chatEventIsAllHistoryAvailableToggled",
"description": "The is_all_history_available setting of a supergroup was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "is_all_history_available",
"type": "Bool",
"description": "New value of is_all_history_available"
}
]
},
{
"name": "chatEventHasAggressiveAntiSpamEnabledToggled",
"description": "The has_aggressive_anti_spam_enabled setting of a supergroup was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "has_aggressive_anti_spam_enabled",
"type": "Bool",
"description": "New value of has_aggressive_anti_spam_enabled"
}
]
},
{
"name": "chatEventSignMessagesToggled",
"description": "The sign_messages setting of a channel was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "sign_messages",
"type": "Bool",
"description": "New value of sign_messages"
}
]
},
{
"name": "chatEventInviteLinkEdited",
"description": "A chat invite link was edited",
"class": "ChatEventAction",
"properties": [
{
"name": "old_invite_link",
"type": "chatInviteLink",
"description": "Previous information about the invite link"
},
{
"name": "new_invite_link",
"type": "chatInviteLink",
"description": "New information about the invite link"
}
]
},
{
"name": "chatEventInviteLinkRevoked",
"description": "A chat invite link was revoked",
"class": "ChatEventAction",
"properties": [
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "The invite link"
}
]
},
{
"name": "chatEventInviteLinkDeleted",
"description": "A revoked chat invite link was deleted",
"class": "ChatEventAction",
"properties": [
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "The invite link"
}
]
},
{
"name": "chatEventVideoChatCreated",
"description": "A video chat was created",
"class": "ChatEventAction",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of the video chat. The video chat can be received through the method getGroupCall"
}
]
},
{
"name": "chatEventVideoChatEnded",
"description": "A video chat was ended",
"class": "ChatEventAction",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of the video chat. The video chat can be received through the method getGroupCall"
}
]
},
{
"name": "chatEventVideoChatMuteNewParticipantsToggled",
"description": "The mute_new_participants setting of a video chat was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "mute_new_participants",
"type": "Bool",
"description": "New value of the mute_new_participants setting"
}
]
},
{
"name": "chatEventVideoChatParticipantIsMutedToggled",
"description": "A video chat participant was muted or unmuted",
"class": "ChatEventAction",
"properties": [
{
"name": "participant_id",
"type": "MessageSender",
"description": "Identifier of the affected group call participant"
},
{
"name": "is_muted",
"type": "Bool",
"description": "New value of is_muted"
}
]
},
{
"name": "chatEventVideoChatParticipantVolumeLevelChanged",
"description": "A video chat participant volume level was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "participant_id",
"type": "MessageSender",
"description": "Identifier of the affected group call participant"
},
{
"name": "volume_level",
"type": "int32",
"description": "New value of volume_level; 1-20000 in hundreds of percents"
}
]
},
{
"name": "chatEventIsForumToggled",
"description": "The is_forum setting of a channel was toggled",
"class": "ChatEventAction",
"properties": [
{
"name": "is_forum",
"type": "Bool",
"description": "New value of is_forum"
}
]
},
{
"name": "chatEventForumTopicCreated",
"description": "A new forum topic was created",
"class": "ChatEventAction",
"properties": [
{
"name": "topic_info",
"type": "forumTopicInfo",
"description": "Information about the topic"
}
]
},
{
"name": "chatEventForumTopicEdited",
"description": "A forum topic was edited",
"class": "ChatEventAction",
"properties": [
{
"name": "old_topic_info",
"type": "forumTopicInfo",
"description": "Old information about the topic"
},
{
"name": "new_topic_info",
"type": "forumTopicInfo",
"description": "New information about the topic"
}
]
},
{
"name": "chatEventForumTopicToggleIsClosed",
"description": "A forum topic was closed or reopened",
"class": "ChatEventAction",
"properties": [
{
"name": "topic_info",
"type": "forumTopicInfo",
"description": "New information about the topic"
}
]
},
{
"name": "chatEventForumTopicToggleIsHidden",
"description": "The General forum topic was hidden or unhidden",
"class": "ChatEventAction",
"properties": [
{
"name": "topic_info",
"type": "forumTopicInfo",
"description": "New information about the topic"
}
]
},
{
"name": "chatEventForumTopicDeleted",
"description": "A forum topic was deleted",
"class": "ChatEventAction",
"properties": [
{
"name": "topic_info",
"type": "forumTopicInfo",
"description": "Information about the topic"
}
]
},
{
"name": "chatEventForumTopicPinned",
"description": "A pinned forum topic was changed",
"class": "ChatEventAction",
"properties": [
{
"name": "old_topic_info",
"type": "forumTopicInfo",
"description": "Information about the old pinned topic; may be null"
},
{
"name": "new_topic_info",
"type": "forumTopicInfo",
"description": "Information about the new pinned topic; may be null"
}
]
},
{
"name": "chatEvent",
"description": "Represents a chat event",
"class": "ChatEvent",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Chat event identifier"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the event happened"
},
{
"name": "member_id",
"type": "MessageSender",
"description": "Identifier of the user or chat who performed the action"
},
{
"name": "action",
"type": "ChatEventAction",
"description": "The action"
}
]
},
{
"name": "chatEvents",
"description": "Contains a list of chat events",
"class": "ChatEvents",
"properties": [
{
"name": "events",
"type": "vector\u003cchatEvent\u003e",
"description": "List of events"
}
]
},
{
"name": "chatEventLogFilters",
"description": "Represents a set of filters used to obtain a chat event log",
"class": "ChatEventLogFilters",
"properties": [
{
"name": "message_edits",
"type": "Bool",
"description": "True, if message edits need to be returned"
},
{
"name": "message_deletions",
"type": "Bool",
"description": "True, if message deletions need to be returned"
},
{
"name": "message_pins",
"type": "Bool",
"description": "True, if pin/unpin events need to be returned"
},
{
"name": "member_joins",
"type": "Bool",
"description": "True, if members joining events need to be returned"
},
{
"name": "member_leaves",
"type": "Bool",
"description": "True, if members leaving events need to be returned"
},
{
"name": "member_invites",
"type": "Bool",
"description": "True, if invited member events need to be returned"
},
{
"name": "member_promotions",
"type": "Bool",
"description": "True, if member promotion/demotion events need to be returned"
},
{
"name": "member_restrictions",
"type": "Bool",
"description": "True, if member restricted/unrestricted/banned/unbanned events need to be returned"
},
{
"name": "info_changes",
"type": "Bool",
"description": "True, if changes in chat information need to be returned"
},
{
"name": "setting_changes",
"type": "Bool",
"description": "True, if changes in chat settings need to be returned"
},
{
"name": "invite_link_changes",
"type": "Bool",
"description": "True, if changes to invite links need to be returned"
},
{
"name": "video_chat_changes",
"type": "Bool",
"description": "True, if video chat actions need to be returned"
},
{
"name": "forum_changes",
"type": "Bool",
"description": "True, if forum-related actions need to be returned"
}
]
},
{
"name": "languagePackStringValueOrdinary",
"description": "An ordinary language pack string",
"class": "LanguagePackStringValue",
"properties": [
{
"name": "value",
"type": "string",
"description": "String value"
}
]
},
{
"name": "languagePackStringValuePluralized",
"description": "A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information",
"class": "LanguagePackStringValue",
"properties": [
{
"name": "zero_value",
"type": "string",
"description": "Value for zero objects"
},
{
"name": "one_value",
"type": "string",
"description": "Value for one object"
},
{
"name": "two_value",
"type": "string",
"description": "Value for two objects"
},
{
"name": "few_value",
"type": "string",
"description": "Value for few objects"
},
{
"name": "many_value",
"type": "string",
"description": "Value for many objects"
},
{
"name": "other_value",
"type": "string",
"description": "Default value"
}
]
},
{
"name": "languagePackStringValueDeleted",
"description": "A deleted language pack string, the value must be taken from the built-in English language pack",
"class": "LanguagePackStringValue",
"properties": []
},
{
"name": "languagePackString",
"description": "Represents one language pack string",
"class": "LanguagePackString",
"properties": [
{
"name": "key",
"type": "string",
"description": "String key"
},
{
"name": "value",
"type": "LanguagePackStringValue",
"description": "String value; pass null if the string needs to be taken from the built-in English language pack"
}
]
},
{
"name": "languagePackStrings",
"description": "Contains a list of language pack strings",
"class": "LanguagePackStrings",
"properties": [
{
"name": "strings",
"type": "vector\u003clanguagePackString\u003e",
"description": "A list of language pack strings"
}
]
},
{
"name": "languagePackInfo",
"description": "Contains information about a language pack",
"class": "LanguagePackInfo",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique language pack identifier"
},
{
"name": "base_language_pack_id",
"type": "string",
"description": "Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it must be fetched from base language pack. Unsupported in custom language packs"
},
{
"name": "name",
"type": "string",
"description": "Language name"
},
{
"name": "native_name",
"type": "string",
"description": "Name of the language in that language"
},
{
"name": "plural_code",
"type": "string",
"description": "A language code to be used to apply plural forms. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information"
},
{
"name": "is_official",
"type": "Bool",
"description": "True, if the language pack is official"
},
{
"name": "is_rtl",
"type": "Bool",
"description": "True, if the language pack strings are RTL"
},
{
"name": "is_beta",
"type": "Bool",
"description": "True, if the language pack is a beta language pack"
},
{
"name": "is_installed",
"type": "Bool",
"description": "True, if the language pack is installed by the current user"
},
{
"name": "total_string_count",
"type": "int32",
"description": "Total number of non-deleted strings from the language pack"
},
{
"name": "translated_string_count",
"type": "int32",
"description": "Total number of translated strings from the language pack"
},
{
"name": "local_string_count",
"type": "int32",
"description": "Total number of non-deleted strings from the language pack available locally"
},
{
"name": "translation_url",
"type": "string",
"description": "Link to language translation interface; empty for custom local language packs"
}
]
},
{
"name": "localizationTargetInfo",
"description": "Contains information about the current localization target",
"class": "LocalizationTargetInfo",
"properties": [
{
"name": "language_packs",
"type": "vector\u003clanguagePackInfo\u003e",
"description": "List of available language packs for this application"
}
]
},
{
"name": "premiumLimitTypeSupergroupCount",
"description": "The maximum number of joined supergroups and channels",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypePinnedChatCount",
"description": "The maximum number of pinned chats in the main chat list",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeCreatedPublicChatCount",
"description": "The maximum number of created public chats",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeSavedAnimationCount",
"description": "The maximum number of saved animations",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeFavoriteStickerCount",
"description": "The maximum number of favorite stickers",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeChatFolderCount",
"description": "The maximum number of chat folders",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeChatFolderChosenChatCount",
"description": "The maximum number of pinned and always included, or always excluded chats in a chat folder",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypePinnedArchivedChatCount",
"description": "The maximum number of pinned chats in the archive chat list",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypePinnedSavedMessagesTopicCount",
"description": "The maximum number of pinned Saved Messages topics",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeCaptionLength",
"description": "The maximum length of sent media caption",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeBioLength",
"description": "The maximum length of the user's bio",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeChatFolderInviteLinkCount",
"description": "The maximum number of invite links for a chat folder",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeShareableChatFolderCount",
"description": "The maximum number of added shareable chat folders",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeActiveStoryCount",
"description": "The maximum number of active stories",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeWeeklySentStoryCount",
"description": "The maximum number of stories sent per week",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeMonthlySentStoryCount",
"description": "The maximum number of stories sent per month",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeStoryCaptionLength",
"description": "The maximum length of captions of sent stories",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeStorySuggestedReactionAreaCount",
"description": "The maximum number of suggested reaction areas on a story",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumLimitTypeSimilarChatCount",
"description": "The maximum number of received similar chats",
"class": "PremiumLimitType",
"properties": []
},
{
"name": "premiumFeatureIncreasedLimits",
"description": "Increased limits",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureIncreasedUploadFileSize",
"description": "Increased maximum upload file size",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureImprovedDownloadSpeed",
"description": "Improved download speed",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureVoiceRecognition",
"description": "The ability to convert voice notes to text",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureDisabledAds",
"description": "Disabled ads",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureUniqueReactions",
"description": "Allowed to use more reactions",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureUniqueStickers",
"description": "Allowed to use premium stickers with unique effects",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureCustomEmoji",
"description": "Allowed to use custom emoji stickers in message texts and captions",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureAdvancedChatManagement",
"description": "Ability to change position of the main chat list, archive and mute all new chats from non-contacts, and completely disable notifications about the user's contacts joined Telegram",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureProfileBadge",
"description": "A badge in the user's profile",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureEmojiStatus",
"description": "The ability to show an emoji status along with the user's name",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureAnimatedProfilePhoto",
"description": "Profile photo animation on message and chat screens",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureForumTopicIcon",
"description": "The ability to set a custom emoji as a forum topic icon",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureAppIcons",
"description": "Allowed to set a premium application icons",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureRealTimeChatTranslation",
"description": "Allowed to translate chat messages real-time",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureUpgradedStories",
"description": "Allowed to use many additional features for stories",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureChatBoost",
"description": "The ability to boost chats",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureAccentColor",
"description": "The ability to choose accent color for replies and user profile",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureBackgroundForBoth",
"description": "The ability to set private chat background for both users",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureSavedMessagesTags",
"description": "The ability to use tags in Saved Messages",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureMessagePrivacy",
"description": "The ability to disallow incoming voice and video note messages in private chats using setUserPrivacySettingRules with userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages and to restrict incoming messages from non-contacts using setNewChatPrivacySettings",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureLastSeenTimes",
"description": "The ability to view last seen and read times of other users even they can't view last seen or read time for the current user",
"class": "PremiumFeature",
"properties": []
},
{
"name": "premiumFeatureBusiness",
"description": "The ability to use Business features",
"class": "PremiumFeature",
"properties": []
},
{
"name": "businessFeatureLocation",
"description": "The ability to set location",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureOpeningHours",
"description": "The ability to set opening hours",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureQuickReplies",
"description": "The ability to use quick replies",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureGreetingMessage",
"description": "The ability to set up a greeting message",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureAwayMessage",
"description": "The ability to set up an away message",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureAccountLinks",
"description": "The ability to create links to the business account with predefined message text",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureIntro",
"description": "The ability to customize intro",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureBots",
"description": "The ability to connect a bot to the account",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureEmojiStatus",
"description": "The ability to show an emoji status along with the business name",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureChatFolderTags",
"description": "The ability to display folder names for each chat in the chat list",
"class": "BusinessFeature",
"properties": []
},
{
"name": "businessFeatureUpgradedStories",
"description": "Allowed to use many additional features for stories",
"class": "BusinessFeature",
"properties": []
},
{
"name": "premiumStoryFeaturePriorityOrder",
"description": "Stories of the current user are displayed before stories of non-Premium contacts, supergroups, and channels",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeatureStealthMode",
"description": "The ability to hide the fact that the user viewed other's stories",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeaturePermanentViewsHistory",
"description": "The ability to check who opened the current user's stories after they expire",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeatureCustomExpirationDuration",
"description": "The ability to set custom expiration duration for stories",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeatureSaveStories",
"description": "The ability to save other's unprotected stories",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeatureLinksAndFormatting",
"description": "The ability to use links and formatting in story caption",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumStoryFeatureVideoQuality",
"description": "The ability to choose better quality for viewed stories",
"class": "PremiumStoryFeature",
"properties": []
},
{
"name": "premiumLimit",
"description": "Contains information about a limit, increased for Premium users",
"class": "PremiumLimit",
"properties": [
{
"name": "type",
"type": "PremiumLimitType",
"description": "The type of the limit"
},
{
"name": "default_value",
"type": "int32",
"description": "Default value of the limit"
},
{
"name": "premium_value",
"type": "int32",
"description": "Value of the limit for Premium users"
}
]
},
{
"name": "premiumFeatures",
"description": "Contains information about features, available to Premium users",
"class": "PremiumFeatures",
"properties": [
{
"name": "features",
"type": "vector\u003cPremiumFeature\u003e",
"description": "The list of available features"
},
{
"name": "limits",
"type": "vector\u003cpremiumLimit\u003e",
"description": "The list of limits, increased for Premium users"
},
{
"name": "payment_link",
"type": "InternalLinkType",
"description": "An internal link to be opened to pay for Telegram Premium if store payment isn't possible; may be null if direct payment isn't available"
}
]
},
{
"name": "businessFeatures",
"description": "Contains information about features, available to Business user accounts",
"class": "BusinessFeatures",
"properties": [
{
"name": "features",
"type": "vector\u003cBusinessFeature\u003e",
"description": "The list of available business features"
}
]
},
{
"name": "premiumSourceLimitExceeded",
"description": "A limit was exceeded",
"class": "PremiumSource",
"properties": [
{
"name": "limit_type",
"type": "PremiumLimitType",
"description": "Type of the exceeded limit"
}
]
},
{
"name": "premiumSourceFeature",
"description": "A user tried to use a Premium feature",
"class": "PremiumSource",
"properties": [
{
"name": "feature",
"type": "PremiumFeature",
"description": "The used feature"
}
]
},
{
"name": "premiumSourceBusinessFeature",
"description": "A user tried to use a Business feature",
"class": "PremiumSource",
"properties": [
{
"name": "feature",
"type": "BusinessFeature",
"description": "The used feature; pass null if none specific feature was used"
}
]
},
{
"name": "premiumSourceStoryFeature",
"description": "A user tried to use a Premium story feature",
"class": "PremiumSource",
"properties": [
{
"name": "feature",
"type": "PremiumStoryFeature",
"description": "The used feature"
}
]
},
{
"name": "premiumSourceLink",
"description": "A user opened an internal link of the type internalLinkTypePremiumFeatures",
"class": "PremiumSource",
"properties": [
{
"name": "referrer",
"type": "string",
"description": "The referrer from the link"
}
]
},
{
"name": "premiumSourceSettings",
"description": "A user opened the Premium features screen from settings",
"class": "PremiumSource",
"properties": []
},
{
"name": "premiumFeaturePromotionAnimation",
"description": "Describes a promotion animation for a Premium feature",
"class": "PremiumFeaturePromotionAnimation",
"properties": [
{
"name": "feature",
"type": "PremiumFeature",
"description": "Premium feature"
},
{
"name": "animation",
"type": "animation",
"description": "Promotion animation for the feature"
}
]
},
{
"name": "businessFeaturePromotionAnimation",
"description": "Describes a promotion animation for a Business feature",
"class": "BusinessFeaturePromotionAnimation",
"properties": [
{
"name": "feature",
"type": "BusinessFeature",
"description": "Business feature"
},
{
"name": "animation",
"type": "animation",
"description": "Promotion animation for the feature"
}
]
},
{
"name": "premiumState",
"description": "Contains state of Telegram Premium subscription and promotion videos for Premium features",
"class": "PremiumState",
"properties": [
{
"name": "state",
"type": "formattedText",
"description": "Text description of the state of the current Premium subscription; may be empty if the current user has no Telegram Premium subscription"
},
{
"name": "payment_options",
"type": "vector\u003cpremiumStatePaymentOption\u003e",
"description": "The list of available options for buying Telegram Premium"
},
{
"name": "animations",
"type": "vector\u003cpremiumFeaturePromotionAnimation\u003e",
"description": "The list of available promotion animations for Premium features"
},
{
"name": "business_animations",
"type": "vector\u003cbusinessFeaturePromotionAnimation\u003e",
"description": "The list of available promotion animations for Business features"
}
]
},
{
"name": "storePaymentPurposePremiumSubscription",
"description": "The user subscribing to Telegram Premium",
"class": "StorePaymentPurpose",
"properties": [
{
"name": "is_restore",
"type": "Bool",
"description": "Pass true if this is a restore of a Telegram Premium purchase; only for App Store"
},
{
"name": "is_upgrade",
"type": "Bool",
"description": "Pass true if this is an upgrade from a monthly subscription to early subscription; only for App Store"
}
]
},
{
"name": "storePaymentPurposeGiftedPremium",
"description": "The user gifting Telegram Premium to another user",
"class": "StorePaymentPurpose",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user to which Premium was gifted"
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code of the payment currency"
},
{
"name": "amount",
"type": "int53",
"description": "Paid amount, in the smallest units of the currency"
}
]
},
{
"name": "storePaymentPurposePremiumGiftCodes",
"description": "The user creating Telegram Premium gift codes for other users",
"class": "StorePaymentPurpose",
"properties": [
{
"name": "boosted_chat_id",
"type": "int53",
"description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the users for duration of the Premium subscription and which is administered by the user; 0 if none"
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code of the payment currency"
},
{
"name": "amount",
"type": "int53",
"description": "Paid amount, in the smallest units of the currency"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the users which can activate the gift codes"
}
]
},
{
"name": "storePaymentPurposePremiumGiveaway",
"description": "The user creating a Telegram Premium giveaway",
"class": "StorePaymentPurpose",
"properties": [
{
"name": "parameters",
"type": "premiumGiveawayParameters",
"description": "Giveaway parameters"
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code of the payment currency"
},
{
"name": "amount",
"type": "int53",
"description": "Paid amount, in the smallest units of the currency"
}
]
},
{
"name": "telegramPaymentPurposePremiumGiftCodes",
"description": "The user creating Telegram Premium gift codes for other users",
"class": "TelegramPaymentPurpose",
"properties": [
{
"name": "boosted_chat_id",
"type": "int53",
"description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the users for duration of the Premium subscription and which is administered by the user; 0 if none"
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code of the payment currency"
},
{
"name": "amount",
"type": "int53",
"description": "Paid amount, in the smallest units of the currency"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the users which can activate the gift codes"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active for the users"
}
]
},
{
"name": "telegramPaymentPurposePremiumGiveaway",
"description": "The user creating a Telegram Premium giveaway",
"class": "TelegramPaymentPurpose",
"properties": [
{
"name": "parameters",
"type": "premiumGiveawayParameters",
"description": "Giveaway parameters"
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 currency code of the payment currency"
},
{
"name": "amount",
"type": "int53",
"description": "Paid amount, in the smallest units of the currency"
},
{
"name": "winner_count",
"type": "int32",
"description": "Number of users which will be able to activate the gift codes"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active for the users"
}
]
},
{
"name": "//-To",
"description": "",
"class": "https://my.telegram.org",
"properties": []
},
{
"name": "deviceTokenFirebaseCloudMessaging",
"description": "A token for Firebase Cloud Messaging",
"class": "DeviceToken",
"properties": [
{
"name": "token",
"type": "string",
"description": "Device registration token; may be empty to deregister a device"
},
{
"name": "encrypt",
"type": "Bool",
"description": "True, if push notifications must be additionally encrypted"
}
]
},
{
"name": "deviceTokenApplePush",
"description": "A token for Apple Push Notification service",
"class": "DeviceToken",
"properties": [
{
"name": "device_token",
"type": "string",
"description": "Device token; may be empty to deregister a device"
},
{
"name": "is_app_sandbox",
"type": "Bool",
"description": "True, if App Sandbox is enabled"
}
]
},
{
"name": "deviceTokenApplePushVoIP",
"description": "A token for Apple Push Notification service VoIP notifications",
"class": "DeviceToken",
"properties": [
{
"name": "device_token",
"type": "string",
"description": "Device token; may be empty to deregister a device"
},
{
"name": "is_app_sandbox",
"type": "Bool",
"description": "True, if App Sandbox is enabled"
},
{
"name": "encrypt",
"type": "Bool",
"description": "True, if push notifications must be additionally encrypted"
}
]
},
{
"name": "deviceTokenWindowsPush",
"description": "A token for Windows Push Notification Services",
"class": "DeviceToken",
"properties": [
{
"name": "access_token",
"type": "string",
"description": "The access token that will be used to send notifications; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenMicrosoftPush",
"description": "A token for Microsoft Push Notification Service",
"class": "DeviceToken",
"properties": [
{
"name": "channel_uri",
"type": "string",
"description": "Push notification channel URI; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenMicrosoftPushVoIP",
"description": "A token for Microsoft Push Notification Service VoIP channel",
"class": "DeviceToken",
"properties": [
{
"name": "channel_uri",
"type": "string",
"description": "Push notification channel URI; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenWebPush",
"description": "A token for web Push API",
"class": "DeviceToken",
"properties": [
{
"name": "endpoint",
"type": "string",
"description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device"
},
{
"name": "p256dh_base64url",
"type": "string",
"description": "Base64url-encoded P-256 elliptic curve Diffie-Hellman public key"
},
{
"name": "auth_base64url",
"type": "string",
"description": "Base64url-encoded authentication secret"
}
]
},
{
"name": "deviceTokenSimplePush",
"description": "A token for Simple Push API for Firefox OS",
"class": "DeviceToken",
"properties": [
{
"name": "endpoint",
"type": "string",
"description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenUbuntuPush",
"description": "A token for Ubuntu Push Client service",
"class": "DeviceToken",
"properties": [
{
"name": "token",
"type": "string",
"description": "Token; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenBlackBerryPush",
"description": "A token for BlackBerry Push Service",
"class": "DeviceToken",
"properties": [
{
"name": "token",
"type": "string",
"description": "Token; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenTizenPush",
"description": "A token for Tizen Push Service",
"class": "DeviceToken",
"properties": [
{
"name": "reg_id",
"type": "string",
"description": "Push service registration identifier; may be empty to deregister a device"
}
]
},
{
"name": "deviceTokenHuaweiPush",
"description": "A token for HUAWEI Push Service",
"class": "DeviceToken",
"properties": [
{
"name": "token",
"type": "string",
"description": "Device registration token; may be empty to deregister a device"
},
{
"name": "encrypt",
"type": "Bool",
"description": "True, if push notifications must be additionally encrypted"
}
]
},
{
"name": "pushReceiverId",
"description": "Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification",
"class": "PushReceiverId",
"properties": [
{
"name": "id",
"type": "int64",
"description": "The globally unique identifier of push notification subscription"
}
]
},
{
"name": "backgroundFillSolid",
"description": "Describes a solid fill of a background",
"class": "BackgroundFill",
"properties": [
{
"name": "color",
"type": "int32",
"description": "A color of the background in the RGB24 format"
}
]
},
{
"name": "backgroundFillGradient",
"description": "Describes a gradient fill of a background",
"class": "BackgroundFill",
"properties": [
{
"name": "top_color",
"type": "int32",
"description": "A top color of the background in the RGB24 format"
},
{
"name": "bottom_color",
"type": "int32",
"description": "A bottom color of the background in the RGB24 format"
},
{
"name": "rotation_angle",
"type": "int32",
"description": "Clockwise rotation angle of the gradient, in degrees; 0-359. Must always be divisible by 45"
}
]
},
{
"name": "backgroundFillFreeformGradient",
"description": "Describes a freeform gradient fill of a background",
"class": "BackgroundFill",
"properties": [
{
"name": "colors",
"type": "vector\u003cint32\u003e",
"description": "A list of 3 or 4 colors of the freeform gradients in the RGB24 format"
}
]
},
{
"name": "backgroundTypeWallpaper",
"description": "A wallpaper in JPEG format",
"class": "BackgroundType",
"properties": [
{
"name": "is_blurred",
"type": "Bool",
"description": "True, if the wallpaper must be downscaled to fit in 450x450 square and then box-blurred with radius 12"
},
{
"name": "is_moving",
"type": "Bool",
"description": "True, if the background needs to be slightly moved when device is tilted"
}
]
},
{
"name": "backgroundTypePattern",
"description": "A PNG or TGV (gzipped subset of SVG with MIME type \"application/x-tgwallpattern\") pattern to be combined with the background fill chosen by the user",
"class": "BackgroundType",
"properties": [
{
"name": "fill",
"type": "BackgroundFill",
"description": "Fill of the background"
},
{
"name": "intensity",
"type": "int32",
"description": "Intensity of the pattern when it is shown above the filled background; 0-100."
},
{
"name": "is_inverted",
"type": "Bool",
"description": "True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only"
},
{
"name": "is_moving",
"type": "Bool",
"description": "True, if the background needs to be slightly moved when device is tilted"
}
]
},
{
"name": "backgroundTypeFill",
"description": "A filled background",
"class": "BackgroundType",
"properties": [
{
"name": "fill",
"type": "BackgroundFill",
"description": "The background fill"
}
]
},
{
"name": "backgroundTypeChatTheme",
"description": "A background from a chat theme; can be used only as a chat background in channels",
"class": "BackgroundType",
"properties": [
{
"name": "theme_name",
"type": "string",
"description": "Name of the chat theme"
}
]
},
{
"name": "inputBackgroundLocal",
"description": "A background from a local file",
"class": "InputBackground",
"properties": [
{
"name": "background",
"type": "InputFile",
"description": "Background file to use. Only inputFileLocal and inputFileGenerated are supported. The file must be in JPEG format for wallpapers and in PNG format for patterns"
}
]
},
{
"name": "inputBackgroundRemote",
"description": "A background from the server",
"class": "InputBackground",
"properties": [
{
"name": "background_id",
"type": "int64",