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",
"description": "The background identifier"
}
]
},
{
"name": "inputBackgroundPrevious",
"description": "A background previously set in the chat; for chat backgrounds only",
"class": "InputBackground",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message with the background"
}
]
},
{
"name": "themeSettings",
"description": "Describes theme settings",
"class": "ThemeSettings",
"properties": [
{
"name": "accent_color",
"type": "int32",
"description": "Theme accent color in ARGB format"
},
{
"name": "background",
"type": "background",
"description": "The background to be used in chats; may be null"
},
{
"name": "outgoing_message_fill",
"type": "BackgroundFill",
"description": "The fill to be used as a background for outgoing messages"
},
{
"name": "animate_outgoing_message_fill",
"type": "Bool",
"description": "If true, the freeform gradient fill needs to be animated on every sent message"
},
{
"name": "outgoing_message_accent_color",
"type": "int32",
"description": "Accent color of outgoing messages in ARGB format"
}
]
},
{
"name": "chatTheme",
"description": "Describes a chat theme",
"class": "ChatTheme",
"properties": [
{
"name": "name",
"type": "string",
"description": "Theme name"
},
{
"name": "light_settings",
"type": "themeSettings",
"description": "Theme settings for a light chat theme"
},
{
"name": "dark_settings",
"type": "themeSettings",
"description": "Theme settings for a dark chat theme"
}
]
},
{
"name": "timeZone",
"description": "Describes a time zone",
"class": "TimeZone",
"properties": [
{
"name": "id",
"type": "string",
"description": "Unique time zone identifier"
},
{
"name": "name",
"type": "string",
"description": "Time zone name"
},
{
"name": "utc_time_offset",
"type": "int32",
"description": "Current UTC time offset for the time zone"
}
]
},
{
"name": "timeZones",
"description": "Contains a list of time zones",
"class": "TimeZones",
"properties": [
{
"name": "time_zones",
"type": "vector\u003ctimeZone\u003e",
"description": "A list of time zones"
}
]
},
{
"name": "hashtags",
"description": "Contains a list of hashtags",
"class": "Hashtags",
"properties": [
{
"name": "hashtags",
"type": "vector\u003cstring\u003e",
"description": "A list of hashtags"
}
]
},
{
"name": "canSendStoryResultOk",
"description": "A story can be sent",
"class": "CanSendStoryResult",
"properties": []
},
{
"name": "canSendStoryResultPremiumNeeded",
"description": "The user must subscribe to Telegram Premium to be able to post stories",
"class": "CanSendStoryResult",
"properties": []
},
{
"name": "canSendStoryResultBoostNeeded",
"description": "The chat must be boosted first by Telegram Premium subscribers to post more stories. Call getChatBoostStatus to get current boost status of the chat",
"class": "CanSendStoryResult",
"properties": []
},
{
"name": "canSendStoryResultActiveStoryLimitExceeded",
"description": "The limit for the number of active stories exceeded. The user can buy Telegram Premium, delete an active story, or wait for the oldest story to expire",
"class": "CanSendStoryResult",
"properties": []
},
{
"name": "canSendStoryResultWeeklyLimitExceeded",
"description": "The weekly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time",
"class": "CanSendStoryResult",
"properties": [
{
"name": "retry_after",
"type": "int32",
"description": "Time left before the user can send the next story"
}
]
},
{
"name": "canSendStoryResultMonthlyLimitExceeded",
"description": "The monthly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time",
"class": "CanSendStoryResult",
"properties": [
{
"name": "retry_after",
"type": "int32",
"description": "Time left before the user can send the next story"
}
]
},
{
"name": "canTransferOwnershipResultOk",
"description": "The session can be used",
"class": "CanTransferOwnershipResult",
"properties": []
},
{
"name": "canTransferOwnershipResultPasswordNeeded",
"description": "The 2-step verification needs to be enabled first",
"class": "CanTransferOwnershipResult",
"properties": []
},
{
"name": "canTransferOwnershipResultPasswordTooFresh",
"description": "The 2-step verification was enabled recently, user needs to wait",
"class": "CanTransferOwnershipResult",
"properties": [
{
"name": "retry_after",
"type": "int32",
"description": "Time left before the session can be used to transfer ownership of a chat, in seconds"
}
]
},
{
"name": "canTransferOwnershipResultSessionTooFresh",
"description": "The session was created recently, user needs to wait",
"class": "CanTransferOwnershipResult",
"properties": [
{
"name": "retry_after",
"type": "int32",
"description": "Time left before the session can be used to transfer ownership of a chat, in seconds"
}
]
},
{
"name": "checkChatUsernameResultOk",
"description": "The username can be set",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkChatUsernameResultUsernameInvalid",
"description": "The username is invalid",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkChatUsernameResultUsernameOccupied",
"description": "The username is occupied",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkChatUsernameResultUsernamePurchasable",
"description": "The username can be purchased at https://fragment.com. Information about the username can be received using getCollectibleItemInfo",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkChatUsernameResultPublicChatsTooMany",
"description": "The user has too many chats with username, one of them must be made private first",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkChatUsernameResultPublicGroupsUnavailable",
"description": "The user can't be a member of a public supergroup",
"class": "CheckChatUsernameResult",
"properties": []
},
{
"name": "checkStickerSetNameResultOk",
"description": "The name can be set",
"class": "CheckStickerSetNameResult",
"properties": []
},
{
"name": "checkStickerSetNameResultNameInvalid",
"description": "The name is invalid",
"class": "CheckStickerSetNameResult",
"properties": []
},
{
"name": "checkStickerSetNameResultNameOccupied",
"description": "The name is occupied",
"class": "CheckStickerSetNameResult",
"properties": []
},
{
"name": "resetPasswordResultOk",
"description": "The password was reset",
"class": "ResetPasswordResult",
"properties": []
},
{
"name": "resetPasswordResultPending",
"description": "The password reset request is pending",
"class": "ResetPasswordResult",
"properties": [
{
"name": "pending_reset_date",
"type": "int32",
"description": "Point in time (Unix timestamp) after which the password can be reset immediately using resetPassword"
}
]
},
{
"name": "resetPasswordResultDeclined",
"description": "The password reset request was declined",
"class": "ResetPasswordResult",
"properties": [
{
"name": "retry_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the password reset can be retried"
}
]
},
{
"name": "messageFileTypePrivate",
"description": "The messages were exported from a private chat",
"class": "MessageFileType",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the other party; may be empty if unrecognized"
}
]
},
{
"name": "messageFileTypeGroup",
"description": "The messages were exported from a group chat",
"class": "MessageFileType",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the group chat; may be empty if unrecognized"
}
]
},
{
"name": "messageFileTypeUnknown",
"description": "The messages were exported from a chat of unknown type",
"class": "MessageFileType",
"properties": []
},
{
"name": "pushMessageContentHidden",
"description": "A general message with hidden content",
"class": "PushMessageContent",
"properties": [
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentAnimation",
"description": "An animation message (GIF-style).",
"class": "PushMessageContent",
"properties": [
{
"name": "animation",
"type": "animation",
"description": "Message content; may be null"
},
{
"name": "caption",
"type": "string",
"description": "Animation caption"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentAudio",
"description": "An audio message",
"class": "PushMessageContent",
"properties": [
{
"name": "audio",
"type": "audio",
"description": "Message content; may be null"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentContact",
"description": "A message with a user contact",
"class": "PushMessageContent",
"properties": [
{
"name": "name",
"type": "string",
"description": "Contact's name"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentContactRegistered",
"description": "A contact has registered with Telegram",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentDocument",
"description": "A document message (a general file)",
"class": "PushMessageContent",
"properties": [
{
"name": "document",
"type": "document",
"description": "Message content; may be null"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentGame",
"description": "A message with a game",
"class": "PushMessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Game title, empty for pinned game message"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentGameScore",
"description": "A new high score was achieved in a game",
"class": "PushMessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "Game title, empty for pinned message"
},
{
"name": "score",
"type": "int32",
"description": "New score, 0 for pinned message"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentInvoice",
"description": "A message with an invoice from a bot",
"class": "PushMessageContent",
"properties": [
{
"name": "price",
"type": "string",
"description": "Product price"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentLocation",
"description": "A message with a location",
"class": "PushMessageContent",
"properties": [
{
"name": "is_live",
"type": "Bool",
"description": "True, if the location is live"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentPhoto",
"description": "A photo message",
"class": "PushMessageContent",
"properties": [
{
"name": "photo",
"type": "photo",
"description": "Message content; may be null"
},
{
"name": "caption",
"type": "string",
"description": "Photo caption"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the photo is secret"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentPoll",
"description": "A message with a poll",
"class": "PushMessageContent",
"properties": [
{
"name": "question",
"type": "string",
"description": "Poll question"
},
{
"name": "is_regular",
"type": "Bool",
"description": "True, if the poll is regular and not in quiz mode"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentPremiumGiftCode",
"description": "A message with a Telegram Premium gift code created for the user",
"class": "PushMessageContent",
"properties": [
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation"
}
]
},
{
"name": "pushMessageContentPremiumGiveaway",
"description": "A message with a Telegram Premium giveaway",
"class": "PushMessageContent",
"properties": [
{
"name": "winner_count",
"type": "int32",
"description": "Number of users which will receive Telegram Premium subscription gift codes; 0 for pinned message"
},
{
"name": "month_count",
"type": "int32",
"description": "Number of months the Telegram Premium subscription will be active after code activation; 0 for pinned message"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentScreenshotTaken",
"description": "A screenshot of a message in the chat has been taken",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentSticker",
"description": "A message with a sticker",
"class": "PushMessageContent",
"properties": [
{
"name": "sticker",
"type": "sticker",
"description": "Message content; may be null"
},
{
"name": "emoji",
"type": "string",
"description": "Emoji corresponding to the sticker; may be empty"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentStory",
"description": "A message with a story",
"class": "PushMessageContent",
"properties": [
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentText",
"description": "A text message",
"class": "PushMessageContent",
"properties": [
{
"name": "text",
"type": "string",
"description": "Message text"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentVideo",
"description": "A video message",
"class": "PushMessageContent",
"properties": [
{
"name": "video",
"type": "video",
"description": "Message content; may be null"
},
{
"name": "caption",
"type": "string",
"description": "Video caption"
},
{
"name": "is_secret",
"type": "Bool",
"description": "True, if the video is secret"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentVideoNote",
"description": "A video note message",
"class": "PushMessageContent",
"properties": [
{
"name": "video_note",
"type": "videoNote",
"description": "Message content; may be null"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentVoiceNote",
"description": "A voice note message",
"class": "PushMessageContent",
"properties": [
{
"name": "voice_note",
"type": "voiceNote",
"description": "Message content; may be null"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is a pinned message with the specified content"
}
]
},
{
"name": "pushMessageContentBasicGroupChatCreate",
"description": "A newly created basic group",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentChatAddMembers",
"description": "New chat members were invited to a group",
"class": "PushMessageContent",
"properties": [
{
"name": "member_name",
"type": "string",
"description": "Name of the added member"
},
{
"name": "is_current_user",
"type": "Bool",
"description": "True, if the current user was added to the group"
},
{
"name": "is_returned",
"type": "Bool",
"description": "True, if the user has returned to the group themselves"
}
]
},
{
"name": "pushMessageContentChatChangePhoto",
"description": "A chat photo was edited",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentChatChangeTitle",
"description": "A chat title was edited",
"class": "PushMessageContent",
"properties": [
{
"name": "title",
"type": "string",
"description": "New chat title"
}
]
},
{
"name": "pushMessageContentChatSetBackground",
"description": "A chat background was edited",
"class": "PushMessageContent",
"properties": [
{
"name": "is_same",
"type": "Bool",
"description": "True, if the set background is the same as the background of the current user"
}
]
},
{
"name": "pushMessageContentChatSetTheme",
"description": "A chat theme was edited",
"class": "PushMessageContent",
"properties": [
{
"name": "theme_name",
"type": "string",
"description": "If non-empty, name of a new theme, set for the chat. Otherwise, the chat theme was reset to the default one"
}
]
},
{
"name": "pushMessageContentChatDeleteMember",
"description": "A chat member was deleted",
"class": "PushMessageContent",
"properties": [
{
"name": "member_name",
"type": "string",
"description": "Name of the deleted member"
},
{
"name": "is_current_user",
"type": "Bool",
"description": "True, if the current user was deleted from the group"
},
{
"name": "is_left",
"type": "Bool",
"description": "True, if the user has left the group themselves"
}
]
},
{
"name": "pushMessageContentChatJoinByLink",
"description": "A new member joined the chat via an invite link",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentChatJoinByRequest",
"description": "A new member was accepted to the chat by an administrator",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentRecurringPayment",
"description": "A new recurring payment was made by the current user",
"class": "PushMessageContent",
"properties": [
{
"name": "amount",
"type": "string",
"description": "The paid amount"
}
]
},
{
"name": "pushMessageContentSuggestProfilePhoto",
"description": "A profile photo was suggested to the user",
"class": "PushMessageContent",
"properties": []
},
{
"name": "pushMessageContentMessageForwards",
"description": "A forwarded messages",
"class": "PushMessageContent",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Number of forwarded messages"
}
]
},
{
"name": "pushMessageContentMediaAlbum",
"description": "A media album",
"class": "PushMessageContent",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Number of messages in the album"
},
{
"name": "has_photos",
"type": "Bool",
"description": "True, if the album has at least one photo"
},
{
"name": "has_videos",
"type": "Bool",
"description": "True, if the album has at least one video file"
},
{
"name": "has_audios",
"type": "Bool",
"description": "True, if the album has at least one audio file"
},
{
"name": "has_documents",
"type": "Bool",
"description": "True, if the album has at least one document"
}
]
},
{
"name": "notificationTypeNewMessage",
"description": "New message was received",
"class": "NotificationType",
"properties": [
{
"name": "message",
"type": "message",
"description": "The message"
},
{
"name": "show_preview",
"type": "Bool",
"description": "True, if message content must be displayed in notifications"
}
]
},
{
"name": "notificationTypeNewSecretChat",
"description": "New secret chat was created",
"class": "NotificationType",
"properties": []
},
{
"name": "notificationTypeNewCall",
"description": "New call was received",
"class": "NotificationType",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
}
]
},
{
"name": "notificationTypeNewPushMessage",
"description": "New message was received through a push notification",
"class": "NotificationType",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "The message identifier. The message will not be available in the chat history, but the identifier can be used in viewMessages, or as a message to be replied in the same chat"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of the message. Corresponding user or chat may be inaccessible"
},
{
"name": "sender_name",
"type": "string",
"description": "Name of the sender"
},
{
"name": "is_outgoing",
"type": "Bool",
"description": "True, if the message is outgoing"
},
{
"name": "content",
"type": "PushMessageContent",
"description": "Push message content"
}
]
},
{
"name": "notificationGroupTypeMessages",
"description": "A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages",
"class": "NotificationGroupType",
"properties": []
},
{
"name": "notificationGroupTypeMentions",
"description": "A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current user, replies to their messages, or a pinned message",
"class": "NotificationGroupType",
"properties": []
},
{
"name": "notificationGroupTypeSecretChat",
"description": "A group containing a notification of type notificationTypeNewSecretChat",
"class": "NotificationGroupType",
"properties": []
},
{
"name": "notificationGroupTypeCalls",
"description": "A group containing notifications of type notificationTypeNewCall",
"class": "NotificationGroupType",
"properties": []
},
{
"name": "notificationSound",
"description": "Describes a notification sound in MP3 format",
"class": "NotificationSound",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique identifier of the notification sound"
},
{
"name": "duration",
"type": "int32",
"description": "Duration of the sound, in seconds"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the sound was created"
},
{
"name": "title",
"type": "string",
"description": "Title of the notification sound"
},
{
"name": "data",
"type": "string",
"description": "Arbitrary data, defined while the sound was uploaded"
},
{
"name": "sound",
"type": "file",
"description": "File containing the sound"
}
]
},
{
"name": "notificationSounds",
"description": "Contains a list of notification sounds",
"class": "NotificationSounds",
"properties": [
{
"name": "notification_sounds",
"type": "vector\u003cnotificationSound\u003e",
"description": "A list of notification sounds"
}
]
},
{
"name": "notification",
"description": "Contains information about a notification",
"class": "Notification",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique persistent identifier of this notification"
},
{
"name": "date",
"type": "int32",
"description": "Notification date"
},
{
"name": "is_silent",
"type": "Bool",
"description": "True, if the notification was explicitly sent without sound"
},
{
"name": "type",
"type": "NotificationType",
"description": "Notification type"
}
]
},
{
"name": "notificationGroup",
"description": "Describes a group of notifications",
"class": "NotificationGroup",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique persistent auto-incremented from 1 identifier of the notification group"
},
{
"name": "type",
"type": "NotificationGroupType",
"description": "Type of the group"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat to which all notifications in the group belong"
},
{
"name": "total_count",
"type": "int32",
"description": "Total number of active notifications in the group"
},
{
"name": "notifications",
"type": "vector\u003cnotification\u003e",
"description": "The list of active notifications"
}
]
},
{
"name": "optionValueBoolean",
"description": "Represents a boolean option",
"class": "OptionValue",
"properties": [
{
"name": "value",
"type": "Bool",
"description": "The value of the option"
}
]
},
{
"name": "optionValueEmpty",
"description": "Represents an unknown option or an option which has a default value",
"class": "OptionValue",
"properties": []
},
{
"name": "optionValueInteger",
"description": "Represents an integer option",
"class": "OptionValue",
"properties": [
{
"name": "value",
"type": "int64",
"description": "The value of the option"
}
]
},
{
"name": "optionValueString",
"description": "Represents a string option",
"class": "OptionValue",
"properties": [
{
"name": "value",
"type": "string",
"description": "The value of the option"
}
]
},
{
"name": "jsonObjectMember",
"description": "Represents one member of a JSON object",
"class": "JsonObjectMember",
"properties": [
{
"name": "key",
"type": "string",
"description": "Member's key"
},
{
"name": "value",
"type": "JsonValue",
"description": "Member's value"
}
]
},
{
"name": "jsonValueNull",
"description": "Represents a null JSON value",
"class": "JsonValue",
"properties": []
},
{
"name": "jsonValueBoolean",
"description": "Represents a boolean JSON value",
"class": "JsonValue",
"properties": [
{
"name": "value",
"type": "Bool",
"description": "The value"
}
]
},
{
"name": "jsonValueNumber",
"description": "Represents a numeric JSON value",
"class": "JsonValue",
"properties": [
{
"name": "value",
"type": "double",
"description": "The value"
}
]
},
{
"name": "jsonValueString",
"description": "Represents a string JSON value",
"class": "JsonValue",
"properties": [
{
"name": "value",
"type": "string",
"description": "The value"
}
]
},
{
"name": "jsonValueArray",
"description": "Represents a JSON array",
"class": "JsonValue",
"properties": [
{
"name": "values",
"type": "vector\u003cJsonValue\u003e",
"description": "The list of array elements"
}
]
},
{
"name": "jsonValueObject",
"description": "Represents a JSON object",
"class": "JsonValue",
"properties": [
{
"name": "members",
"type": "vector\u003cjsonObjectMember\u003e",
"description": "The list of object members"
}
]
},
{
"name": "storyPrivacySettingsEveryone",
"description": "The story can be viewed by everyone",
"class": "StoryPrivacySettings",
"properties": [
{
"name": "except_user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the users that can't see the story; always unknown and empty for non-owned stories"
}
]
},
{
"name": "storyPrivacySettingsContacts",
"description": "The story can be viewed by all contacts except chosen users",
"class": "StoryPrivacySettings",
"properties": [
{
"name": "except_user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of the contacts that can't see the story; always unknown and empty for non-owned stories"
}
]
},
{
"name": "storyPrivacySettingsCloseFriends",
"description": "The story can be viewed by all close friends",
"class": "StoryPrivacySettings",
"properties": []
},
{
"name": "storyPrivacySettingsSelectedUsers",
"description": "The story can be viewed by certain specified users",
"class": "StoryPrivacySettings",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the users; always unknown and empty for non-owned stories"
}
]
},
{
"name": "userPrivacySettingRuleAllowAll",
"description": "A rule to allow all users to do something",
"class": "UserPrivacySettingRule",
"properties": []
},
{
"name": "userPrivacySettingRuleAllowContacts",
"description": "A rule to allow all contacts of the user to do something",
"class": "UserPrivacySettingRule",
"properties": []
},
{
"name": "userPrivacySettingRuleAllowPremiumUsers",
"description": "A rule to allow all Premium Users to do something; currently, allowed only for userPrivacySettingAllowChatInvites",
"class": "UserPrivacySettingRule",
"properties": []
},
{
"name": "userPrivacySettingRuleAllowUsers",
"description": "A rule to allow certain specified users to do something",
"class": "UserPrivacySettingRule",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "The user identifiers, total number of users in all rules must not exceed 1000"
}
]
},
{
"name": "userPrivacySettingRuleAllowChatMembers",
"description": "A rule to allow all members of certain specified basic groups and supergroups to doing something",
"class": "UserPrivacySettingRule",
"properties": [
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The chat identifiers, total number of chats in all rules must not exceed 20"
}
]
},
{
"name": "userPrivacySettingRuleRestrictAll",
"description": "A rule to restrict all users from doing something",
"class": "UserPrivacySettingRule",
"properties": []
},
{
"name": "userPrivacySettingRuleRestrictContacts",
"description": "A rule to restrict all contacts of the user from doing something",
"class": "UserPrivacySettingRule",
"properties": []
},
{
"name": "userPrivacySettingRuleRestrictUsers",
"description": "A rule to restrict all specified users from doing something",
"class": "UserPrivacySettingRule",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "The user identifiers, total number of users in all rules must not exceed 1000"
}
]
},
{
"name": "userPrivacySettingRuleRestrictChatMembers",
"description": "A rule to restrict all members of specified basic groups and supergroups from doing something",
"class": "UserPrivacySettingRule",
"properties": [
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The chat identifiers, total number of chats in all rules must not exceed 20"
}
]
},
{
"name": "userPrivacySettingRules",
"description": "A list of privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting for a given user. If no rule matches, the action is not allowed",
"class": "UserPrivacySettingRules",
"properties": [
{
"name": "rules",
"type": "vector\u003cUserPrivacySettingRule\u003e",
"description": "A list of rules"
}
]
},
{
"name": "userPrivacySettingShowStatus",
"description": "A privacy setting for managing whether the user's online status is visible",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingShowProfilePhoto",
"description": "A privacy setting for managing whether the user's profile photo is visible",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingShowLinkInForwardedMessages",
"description": "A privacy setting for managing whether a link to the user's account is included in forwarded messages",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingShowPhoneNumber",
"description": "A privacy setting for managing whether the user's phone number is visible",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingShowBio",
"description": "A privacy setting for managing whether the user's bio is visible",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingShowBirthdate",
"description": "A privacy setting for managing whether the user's birthdate is visible",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingAllowChatInvites",
"description": "A privacy setting for managing whether the user can be invited to chats",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingAllowCalls",
"description": "A privacy setting for managing whether the user can be called",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingAllowPeerToPeerCalls",
"description": "A privacy setting for managing whether peer-to-peer connections can be used for calls",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingAllowFindingByPhoneNumber",
"description": "A privacy setting for managing whether the user can be found by their phone number. Checked only if the phone number is not known to the other user. Can be set only to \"Allow contacts\" or \"Allow all\"",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages",
"description": "A privacy setting for managing whether the user can receive voice and video messages in private chats; for Telegram Premium users only",
"class": "UserPrivacySetting",
"properties": []
},
{
"name": "readDatePrivacySettings",
"description": "Contains privacy settings for message read date in private chats. Read dates are always shown to the users that can see online status of the current user regardless of this setting",
"class": "ReadDatePrivacySettings",
"properties": [
{
"name": "show_read_date",
"type": "Bool",
"description": "True, if message read date is shown to other users in private chats. If false and the current user isn't a Telegram Premium user, then they will not be able to see other's message read date."
}
]
},
{
"name": "newChatPrivacySettings",
"description": "Contains privacy settings for new chats with non-contacts",
"class": "NewChatPrivacySettings",
"properties": [
{
"name": "allow_new_chats_from_unknown_users",
"type": "Bool",
"description": "True, if non-contacts users are able to write first to the current user. Telegram Premium subscribers are able to write first regardless of this setting"
}
]
},
{
"name": "canSendMessageToUserResultOk",
"description": "The user can be messaged",
"class": "CanSendMessageToUserResult",
"properties": []
},
{
"name": "canSendMessageToUserResultUserIsDeleted",
"description": "The user can't be messaged, because they are deleted or unknown",
"class": "CanSendMessageToUserResult",
"properties": []
},
{
"name": "canSendMessageToUserResultUserRestrictsNewChats",
"description": "The user can't be messaged, because they restrict new chats with non-contacts",
"class": "CanSendMessageToUserResult",
"properties": []
},
{
"name": "accountTtl",
"description": "Contains information about the period of inactivity after which the current user's account will automatically be deleted",
"class": "AccountTtl",
"properties": [
{
"name": "days",
"type": "int32",
"description": "Number of days of inactivity before the account will be flagged for deletion; 30-366 days"
}
]
},
{
"name": "messageAutoDeleteTime",
"description": "Contains default auto-delete timer setting for new chats",
"class": "MessageAutoDeleteTime",
"properties": [
{
"name": "time",
"type": "int32",
"description": "Message auto-delete time, in seconds. If 0, then messages aren't deleted automatically"
}
]
},
{
"name": "sessionTypeAndroid",
"description": "The session is running on an Android device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeApple",
"description": "The session is running on a generic Apple device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeBrave",
"description": "The session is running on the Brave browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeChrome",
"description": "The session is running on the Chrome browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeEdge",
"description": "The session is running on the Edge browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeFirefox",
"description": "The session is running on the Firefox browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeIpad",
"description": "The session is running on an iPad device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeIphone",
"description": "The session is running on an iPhone device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeLinux",
"description": "The session is running on a Linux device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeMac",
"description": "The session is running on a Mac device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeOpera",
"description": "The session is running on the Opera browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeSafari",
"description": "The session is running on the Safari browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeUbuntu",
"description": "The session is running on an Ubuntu device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeUnknown",
"description": "The session is running on an unknown type of device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeVivaldi",
"description": "The session is running on the Vivaldi browser",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeWindows",
"description": "The session is running on a Windows device",
"class": "SessionType",
"properties": []
},
{
"name": "sessionTypeXbox",
"description": "The session is running on an Xbox console",
"class": "SessionType",
"properties": []
},
{
"name": "session",
"description": "Contains information about one session in a Telegram application used by the current user. Sessions must be shown to the user in the returned order",
"class": "Session",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Session identifier"
},
{
"name": "is_current",
"type": "Bool",
"description": "True, if this session is the current session"
},
{
"name": "is_password_pending",
"type": "Bool",
"description": "True, if a 2-step verification password is needed to complete authorization of the session"
},
{
"name": "is_unconfirmed",
"type": "Bool",
"description": "True, if the session wasn't confirmed from another session"
},
{
"name": "can_accept_secret_chats",
"type": "Bool",
"description": "True, if incoming secret chats can be accepted by the session"
},
{
"name": "can_accept_calls",
"type": "Bool",
"description": "True, if incoming calls can be accepted by the session"
},
{
"name": "type",
"type": "SessionType",
"description": "Session type based on the system and application version, which can be used to display a corresponding icon"
},
{
"name": "api_id",
"type": "int32",
"description": "Telegram API identifier, as provided by the application"
},
{
"name": "application_name",
"type": "string",
"description": "Name of the application, as provided by the application"
},
{
"name": "application_version",
"type": "string",
"description": "The version of the application, as provided by the application"
},
{
"name": "is_official_application",
"type": "Bool",
"description": "True, if the application is an official application or uses the api_id of an official application"
},
{
"name": "device_model",
"type": "string",
"description": "Model of the device the application has been run or is running on, as provided by the application"
},
{
"name": "platform",
"type": "string",
"description": "Operating system the application has been run or is running on, as provided by the application"
},
{
"name": "system_version",
"type": "string",
"description": "Version of the operating system the application has been run or is running on, as provided by the application"
},
{
"name": "log_in_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user has logged in"
},
{
"name": "last_active_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the session was last used"
},
{
"name": "ip_address",
"type": "string",
"description": "IP address from which the session was created, in human-readable format"
},
{
"name": "location",
"type": "string",
"description": "A human-readable description of the location from which the session was created, based on the IP address"
}
]
},
{
"name": "sessions",
"description": "Contains a list of sessions",
"class": "Sessions",
"properties": [
{
"name": "sessions",
"type": "vector\u003csession\u003e",
"description": "List of sessions"
},
{
"name": "inactive_session_ttl_days",
"type": "int32",
"description": "Number of days of inactivity before sessions will automatically be terminated; 1-366 days"
}
]
},
{
"name": "unconfirmedSession",
"description": "Contains information about an unconfirmed session",
"class": "UnconfirmedSession",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Session identifier"
},
{
"name": "log_in_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user has logged in"
},
{
"name": "device_model",
"type": "string",
"description": "Model of the device that was used for the session creation, as provided by the application"
},
{
"name": "location",
"type": "string",
"description": "A human-readable description of the location from which the session was created, based on the IP address"
}
]
},
{
"name": "connectedWebsite",
"description": "Contains information about one website the current user is logged in with Telegram",
"class": "ConnectedWebsite",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Website identifier"
},
{
"name": "domain_name",
"type": "string",
"description": "The domain name of the website"
},
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of a bot linked with the website"
},
{
"name": "browser",
"type": "string",
"description": "The version of a browser used to log in"
},
{
"name": "platform",
"type": "string",
"description": "Operating system the browser is running on"
},
{
"name": "log_in_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user was logged in"
},
{
"name": "last_active_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when obtained authorization was last used"
},
{
"name": "ip_address",
"type": "string",
"description": "IP address from which the user was logged in, in human-readable format"
},
{
"name": "location",
"type": "string",
"description": "Human-readable description of a country and a region from which the user was logged in, based on the IP address"
}
]
},
{
"name": "connectedWebsites",
"description": "Contains a list of websites the current user is logged in with Telegram",
"class": "ConnectedWebsites",
"properties": [
{
"name": "websites",
"type": "vector\u003cconnectedWebsite\u003e",
"description": "List of connected websites"
}
]
},
{
"name": "reportReasonSpam",
"description": "The chat contains spam messages",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonViolence",
"description": "The chat promotes violence",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonPornography",
"description": "The chat contains pornographic messages",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonChildAbuse",
"description": "The chat has child abuse related content",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonCopyright",
"description": "The chat contains copyrighted content",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonUnrelatedLocation",
"description": "The location-based chat is unrelated to its stated location",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonFake",
"description": "The chat represents a fake account",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonIllegalDrugs",
"description": "The chat has illegal drugs related content",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonPersonalDetails",
"description": "The chat contains messages with personal details",
"class": "ReportReason",
"properties": []
},
{
"name": "reportReasonCustom",
"description": "A custom reason provided by the user",
"class": "ReportReason",
"properties": []
},
{
"name": "targetChatCurrent",
"description": "The currently opened chat needs to be kept",
"class": "TargetChat",
"properties": []
},
{
"name": "targetChatChosen",
"description": "The chat needs to be chosen by the user among chats of the specified types",
"class": "TargetChat",
"properties": [
{
"name": "allow_user_chats",
"type": "Bool",
"description": "True, if private chats with ordinary users are allowed"
},
{
"name": "allow_bot_chats",
"type": "Bool",
"description": "True, if private chats with other bots are allowed"
},
{
"name": "allow_group_chats",
"type": "Bool",
"description": "True, if basic group and supergroup chats are allowed"
},
{
"name": "allow_channel_chats",
"type": "Bool",
"description": "True, if channel chats are allowed"
}
]
},
{
"name": "targetChatInternalLink",
"description": "The chat needs to be open with the provided internal link",
"class": "TargetChat",
"properties": [
{
"name": "link",
"type": "InternalLinkType",
"description": "An internal link pointing to the chat"
}
]
},
{
"name": "internalLinkTypeActiveSessions",
"description": "The link is a link to the Devices section of the application. Use getActiveSessions to get the list of active sessions and show them to the user",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeAttachmentMenuBot",
"description": "The link is a link to an attachment menu bot to be opened in the specified or a chosen chat. Process given target_chat to open the chat. Then, call searchPublicChat with the given bot username, check that the user is a bot and can be added to attachment menu. Then, use getAttachmentMenuBot to receive information about the bot. If the bot isn't added to attachment menu, then show a disclaimer about Mini Apps being a third-party apps, ask the user to accept their Terms of service and confirm adding the bot to side and attachment menu. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. If the attachment menu bot can't be used in the opened chat, show an error to the user. If the bot is added to attachment menu and can be used in the chat, then use openWebApp with the given URL",
"class": "InternalLinkType",
"properties": [
{
"name": "target_chat",
"type": "TargetChat",
"description": "Target chat to be opened"
},
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot"
},
{
"name": "url",
"type": "string",
"description": "URL to be passed to openWebApp"
}
]
},
{
"name": "internalLinkTypeAuthenticationCode",
"description": "The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization state is authorizationStateWaitCode",
"class": "InternalLinkType",
"properties": [
{
"name": "code",
"type": "string",
"description": "The authentication code"
}
]
},
{
"name": "internalLinkTypeBackground",
"description": "The link is a link to a background. Call searchBackground with the given background name to process the link If background is found and the user wants to apply it, then call setDefaultBackground",
"class": "InternalLinkType",
"properties": [
{
"name": "background_name",
"type": "string",
"description": "Name of the background"
}
]
},
{
"name": "internalLinkTypeBotAddToChannel",
"description": "The link is a link to a Telegram bot, which is supposed to be added to a channel chat as an administrator. Call searchPublicChat with the given bot username and check that the user is a bot, ask the current user to select a channel chat to add the bot to as an administrator. Then, call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights and combine received rights with the requested administrator rights. Then, show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed rights",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot"
},
{
"name": "administrator_rights",
"type": "chatAdministratorRights",
"description": "Expected administrator rights for the bot"
}
]
},
{
"name": "internalLinkTypeBotStart",
"description": "The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the user is a bot, show START button in the chat with the bot, and then call sendBotStartMessage with the given start parameter after the button is pressed",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot"
},
{
"name": "start_parameter",
"type": "string",
"description": "The parameter to be passed to sendBotStartMessage"
},
{
"name": "autostart",
"type": "Bool",
"description": "True, if sendBotStartMessage must be called automatically without showing the START button"
}
]
},
{
"name": "internalLinkTypeBotStartInGroup",
"description": "The link is a link to a Telegram bot, which is supposed to be added to a group chat. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to groups, ask the current user to select a basic group or a supergroup chat to add the bot to, taking into account that bots can be added to a public supergroup only by administrators of the supergroup. If administrator rights are provided by the link, call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights, combine received rights with the requested administrator rights, show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed administrator rights. Before call to setChatMemberStatus it may be required to upgrade the chosen basic group chat to a supergroup chat. Then, if start_parameter isn't empty, call sendBotStartMessage with the given start parameter and the chosen chat; otherwise, just send /start message with bot's username added to the chat.",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot"
},
{
"name": "start_parameter",
"type": "string",
"description": "The parameter to be passed to sendBotStartMessage"
},
{
"name": "administrator_rights",
"type": "chatAdministratorRights",
"description": "Expected administrator rights for the bot; may be null"
}
]
},
{
"name": "internalLinkTypeChangePhoneNumber",
"description": "The link is a link to the change phone number section of the app",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeChatBoost",
"description": "The link is a link to boost a Telegram chat. Call getChatBoostLinkInfo with the given URL to process the link. If the chat is found, then call getChatBoostStatus and getAvailableChatBoostSlots to get the current boost status and check whether the chat can be boosted. If the user wants to boost the chat and the chat can be boosted, then call boostChat",
"class": "InternalLinkType",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL to be passed to getChatBoostLinkInfo"
}
]
},
{
"name": "internalLinkTypeChatFolderInvite",
"description": "The link is an invite link to a chat folder. Call checkChatFolderInviteLink with the given invite link to process the link. If the link is valid and the user wants to join the chat folder, then call addChatFolderByInviteLink",
"class": "InternalLinkType",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Internal representation of the invite link"
}
]
},
{
"name": "internalLinkTypeChatFolderSettings",
"description": "The link is a link to the folder section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeChatInvite",
"description": "The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link. If the link is valid and the user wants to join the chat, then call joinChatByInviteLink",
"class": "InternalLinkType",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Internal representation of the invite link"
}
]
},
{
"name": "internalLinkTypeDefaultMessageAutoDeleteTimerSettings",
"description": "The link is a link to the default message auto-delete timer settings section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeEditProfileSettings",
"description": "The link is a link to the edit profile section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeGame",
"description": "The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot, ask the current user to select a chat to send the game, and then call sendMessage with inputMessageGame",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot that owns the game"
},
{
"name": "game_short_name",
"type": "string",
"description": "Short name of the game"
}
]
},
{
"name": "internalLinkTypeInstantView",
"description": "The link must be opened in an Instant View. Call getWebPageInstantView with the given URL to process the link. If Instant View is found, then show it, otherwise, open the fallback URL in an external browser",
"class": "InternalLinkType",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL to be passed to getWebPageInstantView"
},
{
"name": "fallback_url",
"type": "string",
"description": "An URL to open if getWebPageInstantView fails"
}
]
},
{
"name": "internalLinkTypeInvoice",
"description": "The link is a link to an invoice. Call getPaymentForm with the given invoice name to process the link",
"class": "InternalLinkType",
"properties": [
{
"name": "invoice_name",
"type": "string",
"description": "Name of the invoice"
}
]
},
{
"name": "internalLinkTypeLanguagePack",
"description": "The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process the link. If the language pack is found and the user wants to apply it, then call setOption for the option \"language_pack_id\"",
"class": "InternalLinkType",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Language pack identifier"
}
]
},
{
"name": "internalLinkTypeLanguageSettings",
"description": "The link is a link to the language section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeMessage",
"description": "The link is a link to a Telegram message or a forum topic. Call getMessageLinkInfo with the given URL to process the link, and then open received forum topic or chat and show the message there",
"class": "InternalLinkType",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL to be passed to getMessageLinkInfo"
}
]
},
{
"name": "internalLinkTypeMessageDraft",
"description": "The link contains a message draft text. A share screen needs to be shown to the user, then the chosen chat must be opened and the text is added to the input field",
"class": "InternalLinkType",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Message draft text"
},
{
"name": "contains_link",
"type": "Bool",
"description": "True, if the first line of the text contains a link. If true, the input field needs to be focused and the text after the link must be selected"
}
]
},
{
"name": "internalLinkTypePassportDataRequest",
"description": "The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to process the link if the link was received from outside of the application; otherwise, ignore it",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the service's bot; the corresponding user may be unknown yet"
},
{
"name": "scope",
"type": "string",
"description": "Telegram Passport element types requested by the service"
},
{
"name": "public_key",
"type": "string",
"description": "Service's public key"
},
{
"name": "nonce",
"type": "string",
"description": "Unique request identifier provided by the service"
},
{
"name": "callback_url",
"type": "string",
"description": "An HTTP URL to open once the request is finished, canceled, or failed with the parameters tg_passport=success, tg_passport=cancel, or tg_passport=error\u0026error=... respectively. If empty, then onActivityResult method must be used to return response on Android, or the link tgbot{bot_user_id}://passport/success or tgbot{bot_user_id}://passport/cancel must be opened otherwise"
}
]
},
{
"name": "internalLinkTypePhoneNumberConfirmation",
"description": "The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberConfirmationCode with the given hash and phone number to process the link. If succeeded, call checkPhoneNumberConfirmationCode to check entered by the user code, or resendPhoneNumberConfirmationCode to resend it",
"class": "InternalLinkType",
"properties": [
{
"name": "hash",
"type": "string",
"description": "Hash value from the link"
},
{
"name": "phone_number",
"type": "string",
"description": "Phone number value from the link"
}
]
},
{
"name": "internalLinkTypePremiumFeatures",
"description": "The link is a link to the Premium features screen of the application from which the user can subscribe to Telegram Premium. Call getPremiumFeatures with the given referrer to process the link",
"class": "InternalLinkType",
"properties": [
{
"name": "referrer",
"type": "string",
"description": "Referrer specified in the link"
}
]
},
{
"name": "internalLinkTypePremiumGift",
"description": "The link is a link to the screen for gifting Telegram Premium subscriptions to friends via inputInvoiceTelegram payments or in-store purchases",
"class": "InternalLinkType",
"properties": [
{
"name": "referrer",
"type": "string",
"description": "Referrer specified in the link"
}
]
},
{
"name": "internalLinkTypePremiumGiftCode",
"description": "The link is a link with a Telegram Premium gift code. Call checkPremiumGiftCode with the given code to process the link. If the code is valid and the user wants to apply it, then call applyPremiumGiftCode",
"class": "InternalLinkType",
"properties": [
{
"name": "code",
"type": "string",
"description": "The Telegram Premium gift code"
}
]
},
{
"name": "internalLinkTypePrivacyAndSecuritySettings",
"description": "The link is a link to the privacy and security section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeProxy",
"description": "The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxy",
"class": "InternalLinkType",
"properties": [
{
"name": "server",
"type": "string",
"description": "Proxy server domain or IP address"
},
{
"name": "port",
"type": "int32",
"description": "Proxy server port"
},
{
"name": "type",
"type": "ProxyType",
"description": "Type of the proxy"
}
]
},
{
"name": "internalLinkTypePublicChat",
"description": "The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link If the chat is found, open its profile information screen or the chat itself",
"class": "InternalLinkType",
"properties": [
{
"name": "chat_username",
"type": "string",
"description": "Username of the chat"
}
]
},
{
"name": "internalLinkTypeQrCodeAuthentication",
"description": "The link can be used to login the current user on another device, but it must be scanned from QR-code using in-app camera. An alert similar to \"This code can be used to allow someone to log in to your Telegram account. To confirm Telegram login, please go to Settings \u003e Devices \u003e Scan QR and scan the code\" needs to be shown",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeRestorePurchases",
"description": "The link forces restore of App Store purchases when opened. For official iOS application only",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeSettings",
"description": "The link is a link to application settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeSideMenuBot",
"description": "The link is a link to a bot, which can be installed to the side menu. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to attachment menu. Then, use getAttachmentMenuBot to receive information about the bot. If the bot isn't added to side menu, then show a disclaimer about Mini Apps being a third-party apps, ask the user to accept their Terms of service and confirm adding the bot to side and attachment menu. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. If the bot is added to side menu, then use getWebAppUrl with the given URL and open the returned URL as a Web App",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot"
},
{
"name": "url",
"type": "string",
"description": "URL to be passed to getWebAppUrl"
}
]
},
{
"name": "internalLinkTypeStickerSet",
"description": "The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and show the sticker set. If the sticker set is found and the user wants to add it, then call changeStickerSet",
"class": "InternalLinkType",
"properties": [
{
"name": "sticker_set_name",
"type": "string",
"description": "Name of the sticker set"
},
{
"name": "expect_custom_emoji",
"type": "Bool",
"description": "True, if the sticker set is expected to contain custom emoji"
}
]
},
{
"name": "internalLinkTypeStory",
"description": "The link is a link to a story. Call searchPublicChat with the given sender username, then call getStory with the received chat identifier and the given story identifier, then show the story if received",
"class": "InternalLinkType",
"properties": [
{
"name": "story_sender_username",
"type": "string",
"description": "Username of the sender of the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
}
]
},
{
"name": "internalLinkTypeTheme",
"description": "The link is a link to a theme. TDLib has no theme support yet",
"class": "InternalLinkType",
"properties": [
{
"name": "theme_name",
"type": "string",
"description": "Name of the theme"
}
]
},
{
"name": "internalLinkTypeThemeSettings",
"description": "The link is a link to the theme section of the app settings",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeUnknownDeepLink",
"description": "The link is an unknown tg: link. Call getDeepLinkInfo to process the link",
"class": "InternalLinkType",
"properties": [
{
"name": "link",
"type": "string",
"description": "Link to be passed to getDeepLinkInfo"
}
]
},
{
"name": "internalLinkTypeUnsupportedProxy",
"description": "The link is a link to an unsupported proxy. An alert can be shown to the user",
"class": "InternalLinkType",
"properties": []
},
{
"name": "internalLinkTypeUserPhoneNumber",
"description": "The link is a link to a user by its phone number. Call searchUserByPhoneNumber with the given phone number to process the link. If the user is found, then call createPrivateChat and open the chat",
"class": "InternalLinkType",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "Phone number of the user"
}
]
},
{
"name": "internalLinkTypeUserToken",
"description": "The link is a link to a user by a temporary token. Call searchUserByToken with the given token to process the link. If the user is found, then call createPrivateChat and open the chat",
"class": "InternalLinkType",
"properties": [
{
"name": "token",
"type": "string",
"description": "The token"
}
]
},
{
"name": "internalLinkTypeVideoChat",
"description": "The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinGroupCall with the given invite hash to process the link",
"class": "InternalLinkType",
"properties": [
{
"name": "chat_username",
"type": "string",
"description": "Username of the chat with the video chat"
},
{
"name": "invite_hash",
"type": "string",
"description": "If non-empty, invite hash to be used to join the video chat without being muted by administrators"
},
{
"name": "is_live_stream",
"type": "Bool",
"description": "True, if the video chat is expected to be a live stream in a channel or a broadcast group"
}
]
},
{
"name": "internalLinkTypeWebApp",
"description": "The link is a link to a Web App. Call searchPublicChat with the given bot username, check that the user is a bot, then call searchWebApp with the received bot and the given web_app_short_name. Process received foundWebApp by showing a confirmation dialog if needed. If the bot can be added to attachment or side menu, but isn't added yet, then show a disclaimer about Mini Apps being a third-party apps instead of the dialog and ask the user to accept their Terms of service. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. Then, call getWebAppLinkUrl and open the returned URL as a Web App",
"class": "InternalLinkType",
"properties": [
{
"name": "bot_username",
"type": "string",
"description": "Username of the bot that owns the Web App"
},
{
"name": "web_app_short_name",
"type": "string",
"description": "Short name of the Web App"
},
{
"name": "start_parameter",
"type": "string",
"description": "Start parameter to be passed to getWebAppLinkUrl"
}
]
},
{
"name": "messageLink",
"description": "Contains an HTTPS link to a message in a supergroup or channel, or a forum topic",
"class": "MessageLink",
"properties": [
{
"name": "link",
"type": "string",
"description": "The link"
},
{
"name": "is_public",
"type": "Bool",
"description": "True, if the link will work for non-members of the chat"
}
]
},
{
"name": "messageLinkInfo",
"description": "Contains information about a link to a message or a forum topic in a chat",
"class": "MessageLinkInfo",
"properties": [
{
"name": "is_public",
"type": "Bool",
"description": "True, if the link is a public link for a message or a forum topic in a chat"
},
{
"name": "chat_id",
"type": "int53",
"description": "If found, identifier of the chat to which the link points, 0 otherwise"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If found, identifier of the message thread in which to open the message, or a forum topic to open if the message is missing"
},
{
"name": "message",
"type": "message",
"description": "If found, the linked message; may be null"
},
{
"name": "media_timestamp",
"type": "int32",
"description": "Timestamp from which the video/audio/video note/voice note/story playing must start, in seconds; 0 if not specified. The media can be in the message content or in its web page preview"
},
{
"name": "for_album",
"type": "Bool",
"description": "True, if the whole media album to which the message belongs is linked"
}
]
},
{
"name": "chatBoostLink",
"description": "Contains an HTTPS link to boost a chat",
"class": "ChatBoostLink",
"properties": [
{
"name": "link",
"type": "string",
"description": "The link"
},
{
"name": "is_public",
"type": "Bool",
"description": "True, if the link will work for non-members of the chat"
}
]
},
{
"name": "chatBoostLinkInfo",
"description": "Contains information about a link to boost a chat",
"class": "ChatBoostLinkInfo",
"properties": [
{
"name": "is_public",
"type": "Bool",
"description": "True, if the link will work for non-members of the chat"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the link points; 0 if the chat isn't found"
}
]
},
{
"name": "blockListMain",
"description": "The main block list that disallows writing messages to the current user, receiving their status and photo, viewing of stories, and some other actions",
"class": "BlockList",
"properties": []
},
{
"name": "blockListStories",
"description": "The block list that disallows viewing of stories of the current user",
"class": "BlockList",
"properties": []
},
{
"name": "filePart",
"description": "Contains a part of a file",
"class": "FilePart",
"properties": [
{
"name": "data",
"type": "bytes",
"description": "File bytes"
}
]
},
{
"name": "fileTypeNone",
"description": "The data is not a file",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeAnimation",
"description": "The file is an animation",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeAudio",
"description": "The file is an audio file",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeDocument",
"description": "The file is a document",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeNotificationSound",
"description": "The file is a notification sound",
"class": "FileType",
"properties": []
},
{
"name": "fileTypePhoto",
"description": "The file is a photo",
"class": "FileType",
"properties": []
},
{
"name": "fileTypePhotoStory",
"description": "The file is a photo published as a story",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeProfilePhoto",
"description": "The file is a profile photo",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeSecret",
"description": "The file was sent to a secret chat (the file type is not known to the server)",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeSecretThumbnail",
"description": "The file is a thumbnail of a file from a secret chat",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeSecure",
"description": "The file is a file from Secure storage used for storing Telegram Passport files",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeSticker",
"description": "The file is a sticker",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeThumbnail",
"description": "The file is a thumbnail of another file",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeUnknown",
"description": "The file type is not yet known",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeVideo",
"description": "The file is a video",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeVideoNote",
"description": "The file is a video note",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeVideoStory",
"description": "The file is a video published as a story",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeVoiceNote",
"description": "The file is a voice note",
"class": "FileType",
"properties": []
},
{
"name": "fileTypeWallpaper",
"description": "The file is a wallpaper or a background pattern",
"class": "FileType",
"properties": []
},
{
"name": "storageStatisticsByFileType",
"description": "Contains the storage usage statistics for a specific file type",
"class": "StorageStatisticsByFileType",
"properties": [
{
"name": "file_type",
"type": "FileType",
"description": "File type"
},
{
"name": "size",
"type": "int53",
"description": "Total size of the files, in bytes"
},
{
"name": "count",
"type": "int32",
"description": "Total number of files"
}
]
},
{
"name": "storageStatisticsByChat",
"description": "Contains the storage usage statistics for a specific chat",
"class": "StorageStatisticsByChat",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier; 0 if none"
},
{
"name": "size",
"type": "int53",
"description": "Total size of the files in the chat, in bytes"
},
{
"name": "count",
"type": "int32",
"description": "Total number of files in the chat"
},
{
"name": "by_file_type",
"type": "vector\u003cstorageStatisticsByFileType\u003e",
"description": "Statistics split by file types"
}
]
},
{
"name": "storageStatistics",
"description": "Contains the exact storage usage statistics split by chats and file type",
"class": "StorageStatistics",
"properties": [
{
"name": "size",
"type": "int53",
"description": "Total size of files, in bytes"
},
{
"name": "count",
"type": "int32",
"description": "Total number of files"
},
{
"name": "by_chat",
"type": "vector\u003cstorageStatisticsByChat\u003e",
"description": "Statistics split by chats"
}
]
},
{
"name": "storageStatisticsFast",
"description": "Contains approximate storage usage statistics, excluding files of unknown file type",
"class": "StorageStatisticsFast",
"properties": [
{
"name": "files_size",
"type": "int53",
"description": "Approximate total size of files, in bytes"
},
{
"name": "file_count",
"type": "int32",
"description": "Approximate number of files"
},
{
"name": "database_size",
"type": "int53",
"description": "Size of the database"
},
{
"name": "language_pack_database_size",
"type": "int53",
"description": "Size of the language pack database"
},
{
"name": "log_size",
"type": "int53",
"description": "Size of the TDLib internal log"
}
]
},
{
"name": "databaseStatistics",
"description": "Contains database statistics",
"class": "DatabaseStatistics",
"properties": [
{
"name": "statistics",
"type": "string",
"description": "Database statistics in an unspecified human-readable format"
}
]
},
{
"name": "networkTypeNone",
"description": "The network is not available",
"class": "NetworkType",
"properties": []
},
{
"name": "networkTypeMobile",
"description": "A mobile network",
"class": "NetworkType",
"properties": []
},
{
"name": "networkTypeMobileRoaming",
"description": "A mobile roaming network",
"class": "NetworkType",
"properties": []
},
{
"name": "networkTypeWiFi",
"description": "A Wi-Fi network",
"class": "NetworkType",
"properties": []
},
{
"name": "networkTypeOther",
"description": "A different network type (e.g., Ethernet network)",
"class": "NetworkType",
"properties": []
},
{
"name": "networkStatisticsEntryFile",
"description": "Contains information about the total amount of data that was used to send and receive files",
"class": "NetworkStatisticsEntry",
"properties": [
{
"name": "file_type",
"type": "FileType",
"description": "Type of the file the data is part of; pass null if the data isn't related to files"
},
{
"name": "network_type",
"type": "NetworkType",
"description": "Type of the network the data was sent through. Call setNetworkType to maintain the actual network type"
},
{
"name": "sent_bytes",
"type": "int53",
"description": "Total number of bytes sent"
},
{
"name": "received_bytes",
"type": "int53",
"description": "Total number of bytes received"
}
]
},
{
"name": "networkStatisticsEntryCall",
"description": "Contains information about the total amount of data that was used for calls",
"class": "NetworkStatisticsEntry",
"properties": [
{
"name": "network_type",
"type": "NetworkType",
"description": "Type of the network the data was sent through. Call setNetworkType to maintain the actual network type"
},
{
"name": "sent_bytes",
"type": "int53",
"description": "Total number of bytes sent"
},
{
"name": "received_bytes",
"type": "int53",
"description": "Total number of bytes received"
},
{
"name": "duration",
"type": "double",
"description": "Total call duration, in seconds"
}
]
},
{
"name": "networkStatistics",
"description": "A full list of available network statistic entries",
"class": "NetworkStatistics",
"properties": [
{
"name": "since_date",
"type": "int32",
"description": "Point in time (Unix timestamp) from which the statistics are collected"
},
{
"name": "entries",
"type": "vector\u003cNetworkStatisticsEntry\u003e",
"description": "Network statistics entries"
}
]
},
{
"name": "autoDownloadSettings",
"description": "Contains auto-download settings",
"class": "AutoDownloadSettings",
"properties": [
{
"name": "is_auto_download_enabled",
"type": "Bool",
"description": "True, if the auto-download is enabled"
},
{
"name": "max_photo_file_size",
"type": "int32",
"description": "The maximum size of a photo file to be auto-downloaded, in bytes"
},
{
"name": "max_video_file_size",
"type": "int53",
"description": "The maximum size of a video file to be auto-downloaded, in bytes"
},
{
"name": "max_other_file_size",
"type": "int53",
"description": "The maximum size of other file types to be auto-downloaded, in bytes"
},
{
"name": "video_upload_bitrate",
"type": "int32",
"description": "The maximum suggested bitrate for uploaded videos, in kbit/s"
},
{
"name": "preload_large_videos",
"type": "Bool",
"description": "True, if the beginning of video files needs to be preloaded for instant playback"
},
{
"name": "preload_next_audio",
"type": "Bool",
"description": "True, if the next audio track needs to be preloaded while the user is listening to an audio file"
},
{
"name": "preload_stories",
"type": "Bool",
"description": "True, if stories needs to be preloaded"
},
{
"name": "use_less_data_for_calls",
"type": "Bool",
"description": "True, if \"use less data for calls\" option needs to be enabled"
}
]
},
{
"name": "autoDownloadSettingsPresets",
"description": "Contains auto-download settings presets for the current user",
"class": "AutoDownloadSettingsPresets",
"properties": [
{
"name": "low",
"type": "autoDownloadSettings",
"description": "Preset with lowest settings; supposed to be used by default when roaming"
},
{
"name": "medium",
"type": "autoDownloadSettings",
"description": "Preset with medium settings; supposed to be used by default when using mobile data"
},
{
"name": "high",
"type": "autoDownloadSettings",
"description": "Preset with highest settings; supposed to be used by default when connected on Wi-Fi"
}
]
},
{
"name": "autosaveSettingsScopePrivateChats",
"description": "Autosave settings applied to all private chats without chat-specific settings",
"class": "AutosaveSettingsScope",
"properties": []
},
{
"name": "autosaveSettingsScopeGroupChats",
"description": "Autosave settings applied to all basic group and supergroup chats without chat-specific settings",
"class": "AutosaveSettingsScope",
"properties": []
},
{
"name": "autosaveSettingsScopeChannelChats",
"description": "Autosave settings applied to all channel chats without chat-specific settings",
"class": "AutosaveSettingsScope",
"properties": []
},
{
"name": "autosaveSettingsScopeChat",
"description": "Autosave settings applied to a chat",
"class": "AutosaveSettingsScope",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
]
},
{
"name": "scopeAutosaveSettings",
"description": "Contains autosave settings for an autosave settings scope",
"class": "ScopeAutosaveSettings",
"properties": [
{
"name": "autosave_photos",
"type": "Bool",
"description": "True, if photo autosave is enabled"
},
{
"name": "autosave_videos",
"type": "Bool",
"description": "True, if video autosave is enabled"
},
{
"name": "max_video_file_size",
"type": "int53",
"description": "The maximum size of a video file to be autosaved, in bytes; 512 KB - 4000 MB"
}
]
},
{
"name": "autosaveSettingsException",
"description": "Contains autosave settings for a chat, which overrides default settings for the corresponding scope",
"class": "AutosaveSettingsException",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "settings",
"type": "scopeAutosaveSettings",
"description": "Autosave settings for the chat"
}
]
},
{
"name": "autosaveSettings",
"description": "Describes autosave settings",
"class": "AutosaveSettings",
"properties": [
{
"name": "private_chat_settings",
"type": "scopeAutosaveSettings",
"description": "Default autosave settings for private chats"
},
{
"name": "group_settings",
"type": "scopeAutosaveSettings",
"description": "Default autosave settings for basic group and supergroup chats"
},
{
"name": "channel_settings",
"type": "scopeAutosaveSettings",
"description": "Default autosave settings for channel chats"
},
{
"name": "exceptions",
"type": "vector\u003cautosaveSettingsException\u003e",
"description": "Autosave settings for specific chats"
}
]
},
{
"name": "connectionStateWaitingForNetwork",
"description": "Waiting for the network to become available. Use setNetworkType to change the available network type",
"class": "ConnectionState",
"properties": []
},
{
"name": "connectionStateConnectingToProxy",
"description": "Establishing a connection with a proxy server",
"class": "ConnectionState",
"properties": []
},
{
"name": "connectionStateConnecting",
"description": "Establishing a connection to the Telegram servers",
"class": "ConnectionState",
"properties": []
},
{
"name": "connectionStateUpdating",
"description": "Downloading data supposed to be received while the application was offline",
"class": "ConnectionState",
"properties": []
},
{
"name": "connectionStateReady",
"description": "There is a working connection to the Telegram servers",
"class": "ConnectionState",
"properties": []
},
{
"name": "topChatCategoryUsers",
"description": "A category containing frequently used private chats with non-bot users",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryBots",
"description": "A category containing frequently used private chats with bot users",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryGroups",
"description": "A category containing frequently used basic groups and supergroups",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryChannels",
"description": "A category containing frequently used channels",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryInlineBots",
"description": "A category containing frequently used chats with inline bots sorted by their usage in inline mode",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryCalls",
"description": "A category containing frequently used chats used for calls",
"class": "TopChatCategory",
"properties": []
},
{
"name": "topChatCategoryForwardChats",
"description": "A category containing frequently used chats used to forward messages",
"class": "TopChatCategory",
"properties": []
},
{
"name": "foundPosition",
"description": "Contains 0-based match position",
"class": "FoundPosition",
"properties": [
{
"name": "position",
"type": "int32",
"description": "The position of the match"
}
]
},
{
"name": "foundPositions",
"description": "Contains 0-based positions of matched objects",
"class": "FoundPositions",
"properties": [
{
"name": "total_count",
"type": "int32",
"description": "Total number of matched objects"
},
{
"name": "positions",
"type": "vector\u003cint32\u003e",
"description": "The positions of the matched objects"
}
]
},
{
"name": "tMeUrlTypeUser",
"description": "A URL linking to a user",
"class": "TMeUrlType",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user"
}
]
},
{
"name": "tMeUrlTypeSupergroup",
"description": "A URL linking to a public supergroup or channel",
"class": "TMeUrlType",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
}
]
},
{
"name": "tMeUrlTypeChatInvite",
"description": "A chat invite link",
"class": "TMeUrlType",
"properties": [
{
"name": "info",
"type": "chatInviteLinkInfo",
"description": "Information about the chat invite link"
}
]
},
{
"name": "tMeUrlTypeStickerSet",
"description": "A URL linking to a sticker set",
"class": "TMeUrlType",
"properties": [
{
"name": "sticker_set_id",
"type": "int64",
"description": "Identifier of the sticker set"
}
]
},
{
"name": "tMeUrl",
"description": "Represents a URL linking to an internal Telegram entity",
"class": "TMeUrl",
"properties": [
{
"name": "url",
"type": "string",
"description": "URL"
},
{
"name": "type",
"type": "TMeUrlType",
"description": "Type of the URL"
}
]
},
{
"name": "tMeUrls",
"description": "Contains a list of t.me URLs",
"class": "TMeUrls",
"properties": [
{
"name": "urls",
"type": "vector\u003ctMeUrl\u003e",
"description": "List of URLs"
}
]
},
{
"name": "suggestedActionEnableArchiveAndMuteNewChats",
"description": "Suggests the user to enable archive_and_mute_new_chats_from_unknown_users setting in archiveChatListSettings",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionCheckPassword",
"description": "Suggests the user to check whether they still remember their 2-step verification password",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionCheckPhoneNumber",
"description": "Suggests the user to check whether authorization phone number is correct and change the phone number if it is inaccessible",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionViewChecksHint",
"description": "Suggests the user to view a hint about the meaning of one and two check marks on sent messages",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionConvertToBroadcastGroup",
"description": "Suggests the user to convert specified supergroup to a broadcast group",
"class": "SuggestedAction",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup identifier"
}
]
},
{
"name": "suggestedActionSetPassword",
"description": "Suggests the user to set a 2-step verification password to be able to log in again",
"class": "SuggestedAction",
"properties": [
{
"name": "authorization_delay",
"type": "int32",
"description": "The number of days to pass between consecutive authorizations if the user declines to set password; if 0, then the user is advised to set the password for security reasons"
}
]
},
{
"name": "suggestedActionUpgradePremium",
"description": "Suggests the user to upgrade the Premium subscription from monthly payments to annual payments",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionRestorePremium",
"description": "Suggests the user to restore a recently expired Premium subscription",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionSubscribeToAnnualPremium",
"description": "Suggests the user to subscribe to the Premium subscription with annual payments",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionGiftPremiumForChristmas",
"description": "Suggests the user to gift Telegram Premium to friends for Christmas",
"class": "SuggestedAction",
"properties": []
},
{
"name": "suggestedActionSetBirthdate",
"description": "Suggests the user to set birthdate",
"class": "SuggestedAction",
"properties": []
},
{
"name": "count",
"description": "Contains a counter",
"class": "Count",
"properties": [
{
"name": "count",
"type": "int32",
"description": "Count"
}
]
},
{
"name": "text",
"description": "Contains some text",
"class": "Text",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text"
}
]
},
{
"name": "seconds",
"description": "Contains a value representing a number of seconds",
"class": "Seconds",
"properties": [
{
"name": "seconds",
"type": "double",
"description": "Number of seconds"
}
]
},
{
"name": "fileDownloadedPrefixSize",
"description": "Contains size of downloaded prefix of a file",
"class": "FileDownloadedPrefixSize",
"properties": [
{
"name": "size",
"type": "int53",
"description": "The prefix size, in bytes"
}
]
},
{
"name": "deepLinkInfo",
"description": "Contains information about a tg: deep link",
"class": "DeepLinkInfo",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text to be shown to the user"
},
{
"name": "need_update_application",
"type": "Bool",
"description": "True, if the user must be asked to update the application"
}
]
},
{
"name": "textParseModeMarkdown",
"description": "The text uses Markdown-style formatting",
"class": "TextParseMode",
"properties": [
{
"name": "version",
"type": "int32",
"description": "Version of the parser: 0 or 1 - Telegram Bot API \"Markdown\" parse mode, 2 - Telegram Bot API \"MarkdownV2\" parse mode"
}
]
},
{
"name": "textParseModeHTML",
"description": "The text uses HTML-style formatting. The same as Telegram Bot API \"HTML\" parse mode",
"class": "TextParseMode",
"properties": []
},
{
"name": "proxyTypeSocks5",
"description": "A SOCKS5 proxy server",
"class": "ProxyType",
"properties": [
{
"name": "username",
"type": "string",
"description": "Username for logging in; may be empty"
},
{
"name": "password",
"type": "string",
"description": "Password for logging in; may be empty"
}
]
},
{
"name": "proxyTypeHttp",
"description": "A HTTP transparent proxy server",
"class": "ProxyType",
"properties": [
{
"name": "username",
"type": "string",
"description": "Username for logging in; may be empty"
},
{
"name": "password",
"type": "string",
"description": "Password for logging in; may be empty"
},
{
"name": "http_only",
"type": "Bool",
"description": "Pass true if the proxy supports only HTTP requests and doesn't support transparent TCP connections via HTTP CONNECT method"
}
]
},
{
"name": "proxyTypeMtproto",
"description": "An MTProto proxy server",
"class": "ProxyType",
"properties": [
{
"name": "secret",
"type": "string",
"description": "The proxy's secret in hexadecimal encoding"
}
]
},
{
"name": "proxy",
"description": "Contains information about a proxy server",
"class": "Proxy",
"properties": [
{
"name": "id",
"type": "int32",
"description": "Unique identifier of the proxy"
},
{
"name": "server",
"type": "string",
"description": "Proxy server domain or IP address"
},
{
"name": "port",
"type": "int32",
"description": "Proxy server port"
},
{
"name": "last_used_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the proxy was last used; 0 if never"
},
{
"name": "is_enabled",
"type": "Bool",
"description": "True, if the proxy is enabled now"
},
{
"name": "type",
"type": "ProxyType",
"description": "Type of the proxy"
}
]
},
{
"name": "proxies",
"description": "Represents a list of proxy servers",
"class": "Proxies",
"properties": [
{
"name": "proxies",
"type": "vector\u003cproxy\u003e",
"description": "List of proxy servers"
}
]
},
{
"name": "inputSticker",
"description": "A sticker to be added to a sticker set",
"class": "InputSticker",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "File with the sticker; must fit in a 512x512 square. For WEBP stickers the file must be in WEBP or PNG format, which will be converted to WEBP server-side. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements"
},
{
"name": "format",
"type": "StickerFormat",
"description": "Format of the sticker"
},
{
"name": "emojis",
"type": "string",
"description": "String with 1-20 emoji corresponding to the sticker"
},
{
"name": "mask_position",
"type": "maskPosition",
"description": "Position where the mask is placed; pass null if not specified"
},
{
"name": "keywords",
"type": "vector\u003cstring\u003e",
"description": "List of up to 20 keywords with total length up to 64 characters, which can be used to find the sticker"
}
]
},
{
"name": "dateRange",
"description": "Represents a date range",
"class": "DateRange",
"properties": [
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) at which the date range begins"
},
{
"name": "end_date",
"type": "int32",
"description": "Point in time (Unix timestamp) at which the date range ends"
}
]
},
{
"name": "statisticalValue",
"description": "A value with information about its recent changes",
"class": "StatisticalValue",
"properties": [
{
"name": "value",
"type": "double",
"description": "The current value"
},
{
"name": "previous_value",
"type": "double",
"description": "The value for the previous day"
},
{
"name": "growth_rate_percentage",
"type": "double",
"description": "The growth rate of the value, as a percentage"
}
]
},
{
"name": "statisticalGraphData",
"description": "A graph data",
"class": "StatisticalGraph",
"properties": [
{
"name": "json_data",
"type": "string",
"description": "Graph data in JSON format"
},
{
"name": "zoom_token",
"type": "string",
"description": "If non-empty, a token which can be used to receive a zoomed in graph"
}
]
},
{
"name": "statisticalGraphAsync",
"description": "The graph data to be asynchronously loaded through getStatisticalGraph",
"class": "StatisticalGraph",
"properties": [
{
"name": "token",
"type": "string",
"description": "The token to use for data loading"
}
]
},
{
"name": "statisticalGraphError",
"description": "An error message to be shown to the user instead of the graph",
"class": "StatisticalGraph",
"properties": [
{
"name": "error_message",
"type": "string",
"description": "The error message"
}
]
},
{
"name": "chatStatisticsObjectTypeMessage",
"description": "Describes a message sent in the chat",
"class": "ChatStatisticsObjectType",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
}
]
},
{
"name": "chatStatisticsObjectTypeStory",
"description": "Describes a story sent by the chat",
"class": "ChatStatisticsObjectType",
"properties": [
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
}
]
},
{
"name": "chatStatisticsInteractionInfo",
"description": "Contains statistics about interactions with a message sent in the chat or a story sent by the chat",
"class": "ChatStatisticsInteractionInfo",
"properties": [
{
"name": "object_type",
"type": "ChatStatisticsObjectType",
"description": "Type of the object"
},
{
"name": "view_count",
"type": "int32",
"description": "Number of times the object was viewed"
},
{
"name": "forward_count",
"type": "int32",
"description": "Number of times the object was forwarded"
},
{
"name": "reaction_count",
"type": "int32",
"description": "Number of times reactions were added to the object"
}
]
},
{
"name": "chatStatisticsMessageSenderInfo",
"description": "Contains statistics about messages sent by a user",
"class": "ChatStatisticsMessageSenderInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "sent_message_count",
"type": "int32",
"description": "Number of sent messages"
},
{
"name": "average_character_count",
"type": "int32",
"description": "Average number of characters in sent messages; 0 if unknown"
}
]
},
{
"name": "chatStatisticsAdministratorActionsInfo",
"description": "Contains statistics about administrator actions done by a user",
"class": "ChatStatisticsAdministratorActionsInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Administrator user identifier"
},
{
"name": "deleted_message_count",
"type": "int32",
"description": "Number of messages deleted by the administrator"
},
{
"name": "banned_user_count",
"type": "int32",
"description": "Number of users banned by the administrator"
},
{
"name": "restricted_user_count",
"type": "int32",
"description": "Number of users restricted by the administrator"
}
]
},
{
"name": "chatStatisticsInviterInfo",
"description": "Contains statistics about number of new members invited by a user",
"class": "ChatStatisticsInviterInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "added_member_count",
"type": "int32",
"description": "Number of new members invited by the user"
}
]
},
{
"name": "chatStatisticsSupergroup",
"description": "A detailed statistics about a supergroup chat",
"class": "ChatStatistics",
"properties": [
{
"name": "period",
"type": "dateRange",
"description": "A period to which the statistics applies"
},
{
"name": "member_count",
"type": "statisticalValue",
"description": "Number of members in the chat"
},
{
"name": "message_count",
"type": "statisticalValue",
"description": "Number of messages sent to the chat"
},
{
"name": "viewer_count",
"type": "statisticalValue",
"description": "Number of users who viewed messages in the chat"
},
{
"name": "sender_count",
"type": "statisticalValue",
"description": "Number of users who sent messages to the chat"
},
{
"name": "member_count_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of members in the chat"
},
{
"name": "join_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of members joined and left the chat"
},
{
"name": "join_by_source_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of new member joins per source"
},
{
"name": "language_graph",
"type": "StatisticalGraph",
"description": "A graph containing distribution of active users per language"
},
{
"name": "message_content_graph",
"type": "StatisticalGraph",
"description": "A graph containing distribution of sent messages by content type"
},
{
"name": "action_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of different actions in the chat"
},
{
"name": "day_graph",
"type": "StatisticalGraph",
"description": "A graph containing distribution of message views per hour"
},
{
"name": "week_graph",
"type": "StatisticalGraph",
"description": "A graph containing distribution of message views per day of week"
},
{
"name": "top_senders",
"type": "vector\u003cchatStatisticsMessageSenderInfo\u003e",
"description": "List of users sent most messages in the last week"
},
{
"name": "top_administrators",
"type": "vector\u003cchatStatisticsAdministratorActionsInfo\u003e",
"description": "List of most active administrators in the last week"
},
{
"name": "top_inviters",
"type": "vector\u003cchatStatisticsInviterInfo\u003e",
"description": "List of most active inviters of new members in the last week"
}
]
},
{
"name": "chatStatisticsChannel",
"description": "A detailed statistics about a channel chat",
"class": "ChatStatistics",
"properties": [
{
"name": "period",
"type": "dateRange",
"description": "A period to which the statistics applies"
},
{
"name": "member_count",
"type": "statisticalValue",
"description": "Number of members in the chat"
},
{
"name": "mean_message_view_count",
"type": "statisticalValue",
"description": "Mean number of times the recently sent messages were viewed"
},
{
"name": "mean_message_share_count",
"type": "statisticalValue",
"description": "Mean number of times the recently sent messages were shared"
},
{
"name": "mean_message_reaction_count",
"type": "statisticalValue",
"description": "Mean number of times reactions were added to the recently sent messages"
},
{
"name": "mean_story_view_count",
"type": "statisticalValue",
"description": "Mean number of times the recently sent stories were viewed"
},
{
"name": "mean_story_share_count",
"type": "statisticalValue",
"description": "Mean number of times the recently sent stories were shared"
},
{
"name": "mean_story_reaction_count",
"type": "statisticalValue",
"description": "Mean number of times reactions were added to the recently sent stories"
},
{
"name": "enabled_notifications_percentage",
"type": "double",
"description": "A percentage of users with enabled notifications for the chat; 0-100"
},
{
"name": "member_count_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of members in the chat"
},
{
"name": "join_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of members joined and left the chat"
},
{
"name": "mute_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of members muted and unmuted the chat"
},
{
"name": "view_count_by_hour_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of message views in a given hour in the last two weeks"
},
{
"name": "view_count_by_source_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of message views per source"
},
{
"name": "join_by_source_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of new member joins per source"
},
{
"name": "language_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of users viewed chat messages per language"
},
{
"name": "message_interaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of chat message views and shares"
},
{
"name": "message_reaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of reactions on messages"
},
{
"name": "story_interaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of story views and shares"
},
{
"name": "story_reaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of reactions on stories"
},
{
"name": "instant_view_interaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of views of associated with the chat instant views"
},
{
"name": "recent_interactions",
"type": "vector\u003cchatStatisticsInteractionInfo\u003e",
"description": "Detailed statistics about number of views and shares of recently sent messages and stories"
}
]
},
{
"name": "messageStatistics",
"description": "A detailed statistics about a message",
"class": "MessageStatistics",
"properties": [
{
"name": "message_interaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of message views and shares"
},
{
"name": "message_reaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of message reactions"
}
]
},
{
"name": "storyStatistics",
"description": "A detailed statistics about a story",
"class": "StoryStatistics",
"properties": [
{
"name": "story_interaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of story views and shares"
},
{
"name": "story_reaction_graph",
"type": "StatisticalGraph",
"description": "A graph containing number of story reactions"
}
]
},
{
"name": "point",
"description": "A point on a Cartesian plane",
"class": "Point",
"properties": [
{
"name": "x",
"type": "double",
"description": "The point's first coordinate"
},
{
"name": "y",
"type": "double",
"description": "The point's second coordinate"
}
]
},
{
"name": "vectorPathCommandLine",
"description": "A straight line to a given point",
"class": "VectorPathCommand",
"properties": [
{
"name": "end_point",
"type": "point",
"description": "The end point of the straight line"
}
]
},
{
"name": "vectorPathCommandCubicBezierCurve",
"description": "A cubic Bézier curve to a given point",
"class": "VectorPathCommand",
"properties": [
{
"name": "start_control_point",
"type": "point",
"description": "The start control point of the curve"
},
{
"name": "end_control_point",
"type": "point",
"description": "The end control point of the curve"
},
{
"name": "end_point",
"type": "point",
"description": "The end point of the curve"
}
]
},
{
"name": "botCommandScopeDefault",
"description": "A scope covering all users",
"class": "BotCommandScope",
"properties": []
},
{
"name": "botCommandScopeAllPrivateChats",
"description": "A scope covering all private chats",
"class": "BotCommandScope",
"properties": []
},
{
"name": "botCommandScopeAllGroupChats",
"description": "A scope covering all group and supergroup chats",
"class": "BotCommandScope",
"properties": []
},
{
"name": "botCommandScopeAllChatAdministrators",
"description": "A scope covering all group and supergroup chat administrators",
"class": "BotCommandScope",
"properties": []
},
{
"name": "botCommandScopeChat",
"description": "A scope covering all members of a chat",
"class": "BotCommandScope",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
]
},
{
"name": "botCommandScopeChatAdministrators",
"description": "A scope covering all administrators of a chat",
"class": "BotCommandScope",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
]
},
{
"name": "botCommandScopeChatMember",
"description": "A scope covering a member of a chat",
"class": "BotCommandScope",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
]
},
{
"name": "updateAuthorizationState",
"description": "The user authorization state has changed",
"class": "Update",
"properties": [
{
"name": "authorization_state",
"type": "AuthorizationState",
"description": "New authorization state"
}
]
},
{
"name": "updateNewMessage",
"description": "A new message was received; can also be an outgoing message",
"class": "Update",
"properties": [
{
"name": "message",
"type": "message",
"description": "The new message"
}
]
},
{
"name": "updateMessageSendAcknowledged",
"description": "A request to send a message has reached the Telegram server. This doesn't mean that the message will be sent successfully. This update is sent only if the option \"use_quick_ack\" is set to true. This update may be sent multiple times for the same message",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat identifier of the sent message"
},
{
"name": "message_id",
"type": "int53",
"description": "A temporary message identifier"
}
]
},
{
"name": "updateMessageSendSucceeded",
"description": "A message has been successfully sent",
"class": "Update",
"properties": [
{
"name": "message",
"type": "message",
"description": "The sent message. Usually only the message identifier, date, and content are changed, but almost all other fields can also change"
},
{
"name": "old_message_id",
"type": "int53",
"description": "The previous temporary message identifier"
}
]
},
{
"name": "updateMessageSendFailed",
"description": "A message failed to send. Be aware that some messages being sent can be irrecoverably deleted, in which case updateDeleteMessages will be received instead of this update",
"class": "Update",
"properties": [
{
"name": "message",
"type": "message",
"description": "The failed to send message"
},
{
"name": "old_message_id",
"type": "int53",
"description": "The previous temporary message identifier"
},
{
"name": "error",
"type": "error",
"description": "The cause of the message sending failure"
}
]
},
{
"name": "updateMessageContent",
"description": "The message content has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "new_content",
"type": "MessageContent",
"description": "New message content"
}
]
},
{
"name": "updateMessageEdited",
"description": "A message was edited. Changes in the message content will come in a separate updateMessageContent",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "edit_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the message was edited"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "New message reply markup; may be null"
}
]
},
{
"name": "updateMessageIsPinned",
"description": "The message pinned state was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "The message identifier"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "True, if the message is pinned"
}
]
},
{
"name": "updateMessageInteractionInfo",
"description": "The information about interactions with a message has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "interaction_info",
"type": "messageInteractionInfo",
"description": "New information about interactions with the message; may be null"
}
]
},
{
"name": "updateMessageContentOpened",
"description": "The message content was opened. Updates voice note messages to \"listened\", video note messages to \"viewed\" and starts the self-destruct timer",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
}
]
},
{
"name": "updateMessageMentionRead",
"description": "A message with an unread mention was read",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "unread_mention_count",
"type": "int32",
"description": "The new number of unread mention messages left in the chat"
}
]
},
{
"name": "updateMessageUnreadReactions",
"description": "The list of unread reactions added to a message was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "unread_reactions",
"type": "vector\u003cunreadReaction\u003e",
"description": "The new list of unread reactions"
},
{
"name": "unread_reaction_count",
"type": "int32",
"description": "The new number of messages with unread reactions left in the chat"
}
]
},
{
"name": "updateMessageLiveLocationViewed",
"description": "A message with a live location was viewed. When the update is received, the application is supposed to update the live location",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the live location message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message with live location"
}
]
},
{
"name": "updateNewChat",
"description": "A new chat has been loaded/created. This update is guaranteed to come before the chat identifier is returned to the application. The chat field changes will be reported through separate updates",
"class": "Update",
"properties": [
{
"name": "chat",
"type": "chat",
"description": "The chat"
}
]
},
{
"name": "updateChatTitle",
"description": "The title of a chat was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "title",
"type": "string",
"description": "The new chat title"
}
]
},
{
"name": "updateChatPhoto",
"description": "A chat photo was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "photo",
"type": "chatPhotoInfo",
"description": "The new chat photo; may be null"
}
]
},
{
"name": "updateChatAccentColors",
"description": "Chat accent colors have changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "The new chat accent color identifier"
},
{
"name": "background_custom_emoji_id",
"type": "int64",
"description": "The new identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none"
},
{
"name": "profile_accent_color_id",
"type": "int32",
"description": "The new chat profile accent color identifier; -1 if none"
},
{
"name": "profile_background_custom_emoji_id",
"type": "int64",
"description": "The new identifier of a custom emoji to be shown on the profile background; 0 if none"
}
]
},
{
"name": "updateChatPermissions",
"description": "Chat permissions were changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "permissions",
"type": "chatPermissions",
"description": "The new chat permissions"
}
]
},
{
"name": "updateChatLastMessage",
"description": "The last message of a chat was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "last_message",
"type": "message",
"description": "The new last message in the chat; may be null if the last message became unknown. While the last message is unknown, new messages can be added to the chat without corresponding updateNewMessage update"
},
{
"name": "positions",
"type": "vector\u003cchatPosition\u003e",
"description": "The new chat positions in the chat lists"
}
]
},
{
"name": "updateChatPosition",
"description": "The position of a chat in a chat list has changed. An updateChatLastMessage or updateChatDraftMessage update might be sent instead of the update",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "position",
"type": "chatPosition",
"description": "New chat position. If new order is 0, then the chat needs to be removed from the list"
}
]
},
{
"name": "updateChatAddedToList",
"description": "A chat was added to a chat list",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list to which the chat was added"
}
]
},
{
"name": "updateChatRemovedFromList",
"description": "A chat was removed from a chat list",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list from which the chat was removed"
}
]
},
{
"name": "updateChatReadInbox",
"description": "Incoming messages were read or the number of unread messages has been changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "last_read_inbox_message_id",
"type": "int53",
"description": "Identifier of the last read incoming message"
},
{
"name": "unread_count",
"type": "int32",
"description": "The number of unread messages left in the chat"
}
]
},
{
"name": "updateChatReadOutbox",
"description": "Outgoing messages were read",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "last_read_outbox_message_id",
"type": "int53",
"description": "Identifier of last read outgoing message"
}
]
},
{
"name": "updateChatActionBar",
"description": "The chat action bar was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "action_bar",
"type": "ChatActionBar",
"description": "The new value of the action bar; may be null"
}
]
},
{
"name": "updateChatAvailableReactions",
"description": "The chat available reactions were changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "available_reactions",
"type": "ChatAvailableReactions",
"description": "The new reactions, available in the chat"
}
]
},
{
"name": "updateChatDraftMessage",
"description": "A chat draft has changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the content of the draft, this update mustn't be applied",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "The new draft message; may be null if none"
},
{
"name": "positions",
"type": "vector\u003cchatPosition\u003e",
"description": "The new chat positions in the chat lists"
}
]
},
{
"name": "updateChatEmojiStatus",
"description": "Chat emoji status has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "emoji_status",
"type": "emojiStatus",
"description": "The new chat emoji status; may be null"
}
]
},
{
"name": "updateChatMessageSender",
"description": "The message sender that is selected to send messages in a chat has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_sender_id",
"type": "MessageSender",
"description": "New value of message_sender_id; may be null if the user can't change message sender"
}
]
},
{
"name": "updateChatMessageAutoDeleteTime",
"description": "The message auto-delete or self-destruct timer setting for a chat was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "New value of message_auto_delete_time"
}
]
},
{
"name": "updateChatNotificationSettings",
"description": "Notification settings for a chat were changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "notification_settings",
"type": "chatNotificationSettings",
"description": "The new notification settings"
}
]
},
{
"name": "updateChatPendingJoinRequests",
"description": "The chat pending join requests were changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "pending_join_requests",
"type": "chatJoinRequestsInfo",
"description": "The new data about pending join requests; may be null"
}
]
},
{
"name": "updateChatReplyMarkup",
"description": "The default chat reply markup was changed. Can occur because new messages with reply markup were received or because an old reply markup was hidden by the user",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"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": "updateChatBackground",
"description": "The chat background was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "background",
"type": "chatBackground",
"description": "The new chat background; may be null if background was reset to default"
}
]
},
{
"name": "updateChatTheme",
"description": "The chat theme was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "theme_name",
"type": "string",
"description": "The new name of the chat theme; may be empty if theme was reset to default"
}
]
},
{
"name": "updateChatUnreadMentionCount",
"description": "The chat unread_mention_count has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "unread_mention_count",
"type": "int32",
"description": "The number of unread mention messages left in the chat"
}
]
},
{
"name": "updateChatUnreadReactionCount",
"description": "The chat unread_reaction_count has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "unread_reaction_count",
"type": "int32",
"description": "The number of messages with unread reactions left in the chat"
}
]
},
{
"name": "updateChatVideoChat",
"description": "A chat video chat state has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "video_chat",
"type": "videoChat",
"description": "New value of video_chat"
}
]
},
{
"name": "updateChatDefaultDisableNotification",
"description": "The value of the default disable_notification parameter, used when a message is sent to the chat, was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "default_disable_notification",
"type": "Bool",
"description": "The new default_disable_notification value"
}
]
},
{
"name": "updateChatHasProtectedContent",
"description": "A chat content was allowed or restricted for saving",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "has_protected_content",
"type": "Bool",
"description": "New value of has_protected_content"
}
]
},
{
"name": "updateChatIsTranslatable",
"description": "Translation of chat messages was enabled or disabled",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_translatable",
"type": "Bool",
"description": "New value of is_translatable"
}
]
},
{
"name": "updateChatIsMarkedAsUnread",
"description": "A chat was marked as unread or was read",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_marked_as_unread",
"type": "Bool",
"description": "New value of is_marked_as_unread"
}
]
},
{
"name": "updateChatViewAsTopics",
"description": "A chat default appearance has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "view_as_topics",
"type": "Bool",
"description": "New value of view_as_topics"
}
]
},
{
"name": "updateChatBlockList",
"description": "A chat was blocked or unblocked",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "block_list",
"type": "BlockList",
"description": "Block list to which the chat is added; may be null if none"
}
]
},
{
"name": "updateChatHasScheduledMessages",
"description": "A chat's has_scheduled_messages field has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "has_scheduled_messages",
"type": "Bool",
"description": "New value of has_scheduled_messages"
}
]
},
{
"name": "updateChatFolders",
"description": "The list of chat folders or a chat folder has changed",
"class": "Update",
"properties": [
{
"name": "chat_folders",
"type": "vector\u003cchatFolderInfo\u003e",
"description": "The new list of chat folders"
},
{
"name": "main_chat_list_position",
"type": "int32",
"description": "Position of the main chat list among chat folders, 0-based"
},
{
"name": "are_tags_enabled",
"type": "Bool",
"description": "True, if folder tags are enabled"
}
]
},
{
"name": "updateChatOnlineMemberCount",
"description": "The number of online group members has changed. This update with non-zero number of online group members is sent only for currently opened chats. There is no guarantee that it is sent just after the number of online users has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "online_member_count",
"type": "int32",
"description": "New number of online members in the chat, or 0 if unknown"
}
]
},
{
"name": "updateSavedMessagesTopic",
"description": "Basic information about a Saved Messages topic has changed. This update is guaranteed to come before the topic identifier is returned to the application",
"class": "Update",
"properties": [
{
"name": "topic",
"type": "savedMessagesTopic",
"description": "New data about the topic"
}
]
},
{
"name": "updateSavedMessagesTopicCount",
"description": "Number of Saved Messages topics has changed",
"class": "Update",
"properties": [
{
"name": "topic_count",
"type": "int32",
"description": "Approximate total number of Saved Messages topics"
}
]
},
{
"name": "updateQuickReplyShortcut",
"description": "Basic information about a quick reply shortcut has changed. This update is guaranteed to come before the quick shortcut name is returned to the application",
"class": "Update",
"properties": [
{
"name": "shortcut",
"type": "quickReplyShortcut",
"description": "New data about the shortcut"
}
]
},
{
"name": "updateQuickReplyShortcutDeleted",
"description": "A quick reply shortcut and all its messages were deleted",
"class": "Update",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "The identifier of the deleted shortcut"
}
]
},
{
"name": "updateQuickReplyShortcuts",
"description": "The list of quick reply shortcuts has changed",
"class": "Update",
"properties": [
{
"name": "shortcut_ids",
"type": "vector\u003cint32\u003e",
"description": "The new list of identifiers of quick reply shortcuts"
}
]
},
{
"name": "updateQuickReplyShortcutMessages",
"description": "The list of quick reply shortcut messages has changed",
"class": "Update",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "The identifier of the shortcut"
},
{
"name": "messages",
"type": "vector\u003cquickReplyMessage\u003e",
"description": "The new list of quick reply messages for the shortcut in order from the first to the last sent"
}
]
},
{
"name": "updateForumTopicInfo",
"description": "Basic information about a topic in a forum chat was changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "info",
"type": "forumTopicInfo",
"description": "New information about the topic"
}
]
},
{
"name": "updateScopeNotificationSettings",
"description": "Notification settings for some type of chats were updated",
"class": "Update",
"properties": [
{
"name": "scope",
"type": "NotificationSettingsScope",
"description": "Types of chats for which notification settings were updated"
},
{
"name": "notification_settings",
"type": "scopeNotificationSettings",
"description": "The new notification settings"
}
]
},
{
"name": "updateNotification",
"description": "A notification was changed",
"class": "Update",
"properties": [
{
"name": "notification_group_id",
"type": "int32",
"description": "Unique notification group identifier"
},
{
"name": "notification",
"type": "notification",
"description": "Changed notification"
}
]
},
{
"name": "updateNotificationGroup",
"description": "A list of active notifications in a notification group has changed",
"class": "Update",
"properties": [
{
"name": "notification_group_id",
"type": "int32",
"description": "Unique notification group identifier"
},
{
"name": "type",
"type": "NotificationGroupType",
"description": "New type of the notification group"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat to which all notifications in the group belong"
},
{
"name": "notification_settings_chat_id",
"type": "int53",
"description": "Chat identifier, which notification settings must be applied to the added notifications"
},
{
"name": "notification_sound_id",
"type": "int64",
"description": "Identifier of the notification sound to be played; 0 if sound is disabled"
},
{
"name": "total_count",
"type": "int32",
"description": "Total number of unread notifications in the group, can be bigger than number of active notifications"
},
{
"name": "added_notifications",
"type": "vector\u003cnotification\u003e",
"description": "List of added group notifications, sorted by notification identifier"
},
{
"name": "removed_notification_ids",
"type": "vector\u003cint32\u003e",
"description": "Identifiers of removed group notifications, sorted by notification identifier"
}
]
},
{
"name": "updateActiveNotifications",
"description": "Contains active notifications that were shown on previous application launches. This update is sent only if the message database is used. In that case it comes once before any updateNotification and updateNotificationGroup update",
"class": "Update",
"properties": [
{
"name": "groups",
"type": "vector\u003cnotificationGroup\u003e",
"description": "Lists of active notification groups"
}
]
},
{
"name": "updateHavePendingNotifications",
"description": "Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some pending notifications",
"class": "Update",
"properties": [
{
"name": "have_delayed_notifications",
"type": "Bool",
"description": "True, if there are some delayed notification updates, which will be sent soon"
},
{
"name": "have_unreceived_notifications",
"type": "Bool",
"description": "True, if there can be some yet unreceived notifications, which are being fetched from the server"
}
]
},
{
"name": "updateDeleteMessages",
"description": "Some messages were deleted",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the deleted messages"
},
{
"name": "is_permanent",
"type": "Bool",
"description": "True, if the messages are permanently deleted by a user (as opposed to just becoming inaccessible)"
},
{
"name": "from_cache",
"type": "Bool",
"description": "True, if the messages are deleted only from the cache and can possibly be retrieved again in the future"
}
]
},
{
"name": "updateChatAction",
"description": "A message sender activity in the chat has changed",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the action was performed"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of a message sender performing the action"
},
{
"name": "action",
"type": "ChatAction",
"description": "The action"
}
]
},
{
"name": "updateUserStatus",
"description": "The user went online or offline",
"class": "Update",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "status",
"type": "UserStatus",
"description": "New status of the user"
}
]
},
{
"name": "updateUser",
"description": "Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the application",
"class": "Update",
"properties": [
{
"name": "user",
"type": "user",
"description": "New data about the user"
}
]
},
{
"name": "updateBasicGroup",
"description": "Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the application",
"class": "Update",
"properties": [
{
"name": "basic_group",
"type": "basicGroup",
"description": "New data about the group"
}
]
},
{
"name": "updateSupergroup",
"description": "Some data of a supergroup or a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the application",
"class": "Update",
"properties": [
{
"name": "supergroup",
"type": "supergroup",
"description": "New data about the supergroup"
}
]
},
{
"name": "updateSecretChat",
"description": "Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the application",
"class": "Update",
"properties": [
{
"name": "secret_chat",
"type": "secretChat",
"description": "New data about the secret chat"
}
]
},
{
"name": "updateUserFullInfo",
"description": "Some data in userFullInfo has been changed",
"class": "Update",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "user_full_info",
"type": "userFullInfo",
"description": "New full information about the user"
}
]
},
{
"name": "updateBasicGroupFullInfo",
"description": "Some data in basicGroupFullInfo has been changed",
"class": "Update",
"properties": [
{
"name": "basic_group_id",
"type": "int53",
"description": "Identifier of a basic group"
},
{
"name": "basic_group_full_info",
"type": "basicGroupFullInfo",
"description": "New full information about the group"
}
]
},
{
"name": "updateSupergroupFullInfo",
"description": "Some data in supergroupFullInfo has been changed",
"class": "Update",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
},
{
"name": "supergroup_full_info",
"type": "supergroupFullInfo",
"description": "New full information about the supergroup"
}
]
},
{
"name": "updateServiceNotification",
"description": "A service notification from the server was received. Upon receiving this the application must show a popup with the content of the notification",
"class": "Update",
"properties": [
{
"name": "type",
"type": "string",
"description": "Notification type. If type begins with \"AUTH_KEY_DROP_\", then two buttons \"Cancel\" and \"Log out\" must be shown under notification; if user presses the second, all local data must be destroyed using Destroy method"
},
{
"name": "content",
"type": "MessageContent",
"description": "Notification content"
}
]
},
{
"name": "updateFile",
"description": "Information about a file was updated",
"class": "Update",
"properties": [
{
"name": "file",
"type": "file",
"description": "New data about the file"
}
]
},
{
"name": "updateFileGenerationStart",
"description": "The file generation process needs to be started by the application",
"class": "Update",
"properties": [
{
"name": "generation_id",
"type": "int64",
"description": "Unique identifier for the generation process"
},
{
"name": "original_path",
"type": "string",
"description": "The path to a file from which a new file is generated; may be empty"
},
{
"name": "destination_path",
"type": "string",
"description": "The path to a file that must be created and where the new file is generated"
},
{
"name": "conversion",
"type": "string",
"description": "String specifying the conversion applied to the original file. If conversion is \"#url#\" than original_path contains an HTTP/HTTPS URL of a file, which must be downloaded by the application"
}
]
},
{
"name": "updateFileGenerationStop",
"description": "File generation is no longer needed",
"class": "Update",
"properties": [
{
"name": "generation_id",
"type": "int64",
"description": "Unique identifier for the generation process"
}
]
},
{
"name": "updateFileDownloads",
"description": "The state of the file download list has changed",
"class": "Update",
"properties": [
{
"name": "total_size",
"type": "int53",
"description": "Total size of files in the file download list, in bytes"
},
{
"name": "total_count",
"type": "int32",
"description": "Total number of files in the file download list"
},
{
"name": "downloaded_size",
"type": "int53",
"description": "Total downloaded size of files in the file download list, in bytes"
}
]
},
{
"name": "updateFileAddedToDownloads",
"description": "A file was added to the file download list. This update is sent only after file download list is loaded for the first time",
"class": "Update",
"properties": [
{
"name": "file_download",
"type": "fileDownload",
"description": "The added file download"
},
{
"name": "counts",
"type": "downloadedFileCounts",
"description": "New number of being downloaded and recently downloaded files found"
}
]
},
{
"name": "updateFileDownload",
"description": "A file download was changed. This update is sent only after file download list is loaded for the first time",
"class": "Update",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "File identifier"
},
{
"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": "counts",
"type": "downloadedFileCounts",
"description": "New number of being downloaded and recently downloaded files found"
}
]
},
{
"name": "updateFileRemovedFromDownloads",
"description": "A file was removed from the file download list. This update is sent only after file download list is loaded for the first time",
"class": "Update",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "File identifier"
},
{
"name": "counts",
"type": "downloadedFileCounts",
"description": "New number of being downloaded and recently downloaded files found"
}
]
},
{
"name": "updateCall",
"description": "New call was created or information about a call was updated",
"class": "Update",
"properties": [
{
"name": "call",
"type": "call",
"description": "New data about a call"
}
]
},
{
"name": "updateGroupCall",
"description": "Information about a group call was updated",
"class": "Update",
"properties": [
{
"name": "group_call",
"type": "groupCall",
"description": "New data about a group call"
}
]
},
{
"name": "updateGroupCallParticipant",
"description": "Information about a group call participant was changed. The updates are sent only after the group call is received through getGroupCall and only if the call is joined or being joined",
"class": "Update",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Identifier of group call"
},
{
"name": "participant",
"type": "groupCallParticipant",
"description": "New data about a participant"
}
]
},
{
"name": "updateNewCallSignalingData",
"description": "New call signaling data arrived",
"class": "Update",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "The call identifier"
},
{
"name": "data",
"type": "bytes",
"description": "The data"
}
]
},
{
"name": "updateUserPrivacySettingRules",
"description": "Some privacy setting rules have been changed",
"class": "Update",
"properties": [
{
"name": "setting",
"type": "UserPrivacySetting",
"description": "The privacy setting"
},
{
"name": "rules",
"type": "userPrivacySettingRules",
"description": "New privacy rules"
}
]
},
{
"name": "updateUnreadMessageCount",
"description": "Number of unread messages in a chat list has changed. This update is sent only if the message database is used",
"class": "Update",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list with changed number of unread messages"
},
{
"name": "unread_count",
"type": "int32",
"description": "Total number of unread messages"
},
{
"name": "unread_unmuted_count",
"type": "int32",
"description": "Total number of unread messages in unmuted chats"
}
]
},
{
"name": "updateUnreadChatCount",
"description": "Number of unread chats, i.e. with unread messages or marked as unread, has changed. This update is sent only if the message database is used",
"class": "Update",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list with changed number of unread messages"
},
{
"name": "total_count",
"type": "int32",
"description": "Approximate total number of chats in the chat list"
},
{
"name": "unread_count",
"type": "int32",
"description": "Total number of unread chats"
},
{
"name": "unread_unmuted_count",
"type": "int32",
"description": "Total number of unread unmuted chats"
},
{
"name": "marked_as_unread_count",
"type": "int32",
"description": "Total number of chats marked as unread"
},
{
"name": "marked_as_unread_unmuted_count",
"type": "int32",
"description": "Total number of unmuted chats marked as unread"
}
]
},
{
"name": "updateStory",
"description": "A story was changed",
"class": "Update",
"properties": [
{
"name": "story",
"type": "story",
"description": "The new information about the story"
}
]
},
{
"name": "updateStoryDeleted",
"description": "A story became inaccessible",
"class": "Update",
"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": "updateStorySendSucceeded",
"description": "A story has been successfully sent",
"class": "Update",
"properties": [
{
"name": "story",
"type": "story",
"description": "The sent story"
},
{
"name": "old_story_id",
"type": "int32",
"description": "The previous temporary story identifier"
}
]
},
{
"name": "updateStorySendFailed",
"description": "A story failed to send. If the story sending is canceled, then updateStoryDeleted will be received instead of this update",
"class": "Update",
"properties": [
{
"name": "story",
"type": "story",
"description": "The failed to send story"
},
{
"name": "error",
"type": "error",
"description": "The cause of the story sending failure"
},
{
"name": "error_type",
"type": "CanSendStoryResult",
"description": "Type of the error; may be null if unknown"
}
]
},
{
"name": "updateChatActiveStories",
"description": "The list of active stories posted by a specific chat has changed",
"class": "Update",
"properties": [
{
"name": "active_stories",
"type": "chatActiveStories",
"description": "The new list of active stories"
}
]
},
{
"name": "updateStoryListChatCount",
"description": "Number of chats in a story list has changed",
"class": "Update",
"properties": [
{
"name": "story_list",
"type": "StoryList",
"description": "The story list"
},
{
"name": "chat_count",
"type": "int32",
"description": "Approximate total number of chats with active stories in the list"
}
]
},
{
"name": "updateStoryStealthMode",
"description": "Story stealth mode settings have changed",
"class": "Update",
"properties": [
{
"name": "active_until_date",
"type": "int32",
"description": "Point in time (Unix timestamp) until stealth mode is active; 0 if it is disabled"
},
{
"name": "cooldown_until_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when stealth mode can be enabled again; 0 if there is no active cooldown"
}
]
},
{
"name": "updateOption",
"description": "An option changed its value",
"class": "Update",
"properties": [
{
"name": "name",
"type": "string",
"description": "The option name"
},
{
"name": "value",
"type": "OptionValue",
"description": "The new option value"
}
]
},
{
"name": "updateStickerSet",
"description": "A sticker set has changed",
"class": "Update",
"properties": [
{
"name": "sticker_set",
"type": "stickerSet",
"description": "The sticker set"
}
]
},
{
"name": "updateInstalledStickerSets",
"description": "The list of installed sticker sets was updated",
"class": "Update",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the affected stickers"
},
{
"name": "sticker_set_ids",
"type": "vector\u003cint64\u003e",
"description": "The new list of installed ordinary sticker sets"
}
]
},
{
"name": "updateTrendingStickerSets",
"description": "The list of trending sticker sets was updated or some of them were viewed",
"class": "Update",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the affected stickers"
},
{
"name": "sticker_sets",
"type": "trendingStickerSets",
"description": "The prefix of the list of trending sticker sets with the newest trending sticker sets"
}
]
},
{
"name": "updateRecentStickers",
"description": "The list of recently used stickers was updated",
"class": "Update",
"properties": [
{
"name": "is_attached",
"type": "Bool",
"description": "True, if the list of stickers attached to photo or video files was updated; otherwise, the list of sent stickers is updated"
},
{
"name": "sticker_ids",
"type": "vector\u003cint32\u003e",
"description": "The new list of file identifiers of recently used stickers"
}
]
},
{
"name": "updateFavoriteStickers",
"description": "The list of favorite stickers was updated",
"class": "Update",
"properties": [
{
"name": "sticker_ids",
"type": "vector\u003cint32\u003e",
"description": "The new list of file identifiers of favorite stickers"
}
]
},
{
"name": "updateSavedAnimations",
"description": "The list of saved animations was updated",
"class": "Update",
"properties": [
{
"name": "animation_ids",
"type": "vector\u003cint32\u003e",
"description": "The new list of file identifiers of saved animations"
}
]
},
{
"name": "updateSavedNotificationSounds",
"description": "The list of saved notification sounds was updated. This update may not be sent until information about a notification sound was requested for the first time",
"class": "Update",
"properties": [
{
"name": "notification_sound_ids",
"type": "vector\u003cint64\u003e",
"description": "The new list of identifiers of saved notification sounds"
}
]
},
{
"name": "updateDefaultBackground",
"description": "The default background has changed",
"class": "Update",
"properties": [
{
"name": "for_dark_theme",
"type": "Bool",
"description": "True, if default background for dark theme has changed"
},
{
"name": "background",
"type": "background",
"description": "The new default background; may be null"
}
]
},
{
"name": "updateChatThemes",
"description": "The list of available chat themes has changed",
"class": "Update",
"properties": [
{
"name": "chat_themes",
"type": "vector\u003cchatTheme\u003e",
"description": "The new list of chat themes"
}
]
},
{
"name": "updateAccentColors",
"description": "The list of supported accent colors has changed",
"class": "Update",
"properties": [
{
"name": "colors",
"type": "vector\u003caccentColor\u003e",
"description": "Information about supported colors; colors with identifiers 0 (red), 1 (orange), 2 (purple/violet), 3 (green), 4 (cyan), 5 (blue), 6 (pink) must always be supported and aren't included in the list. The exact colors for the accent colors with identifiers 0-6 must be taken from the app theme"
},
{
"name": "available_accent_color_ids",
"type": "vector\u003cint32\u003e",
"description": "The list of accent color identifiers, which can be set through setAccentColor and setChatAccentColor. The colors must be shown in the specififed order"
}
]
},
{
"name": "updateProfileAccentColors",
"description": "The list of supported accent colors for user profiles has changed",
"class": "Update",
"properties": [
{
"name": "colors",
"type": "vector\u003cprofileAccentColor\u003e",
"description": "Information about supported colors"
},
{
"name": "available_accent_color_ids",
"type": "vector\u003cint32\u003e",
"description": "The list of accent color identifiers, which can be set through setProfileAccentColor and setChatProfileAccentColor. The colors must be shown in the specififed order"
}
]
},
{
"name": "updateLanguagePackStrings",
"description": "Some language pack strings have been updated",
"class": "Update",
"properties": [
{
"name": "localization_target",
"type": "string",
"description": "Localization target to which the language pack belongs"
},
{
"name": "language_pack_id",
"type": "string",
"description": "Identifier of the updated language pack"
},
{
"name": "strings",
"type": "vector\u003clanguagePackString\u003e",
"description": "List of changed language pack strings; empty if all strings have changed"
}
]
},
{
"name": "updateConnectionState",
"description": "The connection state has changed. This update must be used only to show a human-readable description of the connection state",
"class": "Update",
"properties": [
{
"name": "state",
"type": "ConnectionState",
"description": "The new connection state"
}
]
},
{
"name": "updateTermsOfService",
"description": "New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method must be called with the reason \"Decline ToS update\"",
"class": "Update",
"properties": [
{
"name": "terms_of_service_id",
"type": "string",
"description": "Identifier of the terms of service"
},
{
"name": "terms_of_service",
"type": "termsOfService",
"description": "The new terms of service"
}
]
},
{
"name": "updateUsersNearby",
"description": "The list of users nearby has changed. The update is guaranteed to be sent only 60 seconds after a successful searchChatsNearby request",
"class": "Update",
"properties": [
{
"name": "users_nearby",
"type": "vector\u003cchatNearby\u003e",
"description": "The new list of users nearby"
}
]
},
{
"name": "updateUnconfirmedSession",
"description": "The first unconfirmed session has changed",
"class": "Update",
"properties": [
{
"name": "session",
"type": "unconfirmedSession",
"description": "The unconfirmed session; may be null if none"
}
]
},
{
"name": "updateAttachmentMenuBots",
"description": "The list of bots added to attachment or side menu has changed",
"class": "Update",
"properties": [
{
"name": "bots",
"type": "vector\u003cattachmentMenuBot\u003e",
"description": "The new list of bots. The bots must not be shown on scheduled messages screen"
}
]
},
{
"name": "updateWebAppMessageSent",
"description": "A message was sent by an opened Web App, so the Web App needs to be closed",
"class": "Update",
"properties": [
{
"name": "web_app_launch_id",
"type": "int64",
"description": "Identifier of Web App launch"
}
]
},
{
"name": "updateActiveEmojiReactions",
"description": "The list of active emoji reactions has changed",
"class": "Update",
"properties": [
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "The new list of active emoji reactions"
}
]
},
{
"name": "updateDefaultReactionType",
"description": "The type of default reaction has changed",
"class": "Update",
"properties": [
{
"name": "reaction_type",
"type": "ReactionType",
"description": "The new type of the default reaction"
}
]
},
{
"name": "updateSavedMessagesTags",
"description": "Tags used in Saved Messages or a Saved Messages topic have changed",
"class": "Update",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which tags were changed; 0 if tags for the whole chat has changed"
},
{
"name": "tags",
"type": "savedMessagesTags",
"description": "The new tags"
}
]
},
{
"name": "updateSpeechRecognitionTrial",
"description": "The parameters of speech recognition without Telegram Premium subscription has changed",
"class": "Update",
"properties": [
{
"name": "max_media_duration",
"type": "int32",
"description": "The maximum allowed duration of media for speech recognition without Telegram Premium subscription, in seconds"
},
{
"name": "weekly_count",
"type": "int32",
"description": "The total number of allowed speech recognitions per week; 0 if none"
},
{
"name": "left_count",
"type": "int32",
"description": "Number of left speech recognition attempts this week"
},
{
"name": "next_reset_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the weekly number of tries will reset; 0 if unknown"
}
]
},
{
"name": "updateDiceEmojis",
"description": "The list of supported dice emojis has changed",
"class": "Update",
"properties": [
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "The new list of supported dice emojis"
}
]
},
{
"name": "updateAnimatedEmojiMessageClicked",
"description": "Some animated emoji message was clicked and a big animated sticker must be played if the message is visible on the screen. chatActionWatchingAnimations with the text of the message needs to be sent if the sticker is played",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "sticker",
"type": "sticker",
"description": "The animated sticker to be played"
}
]
},
{
"name": "updateAnimationSearchParameters",
"description": "The parameters of animation search through getOption(\"animation_search_bot_username\") bot has changed",
"class": "Update",
"properties": [
{
"name": "provider",
"type": "string",
"description": "Name of the animation search provider"
},
{
"name": "emojis",
"type": "vector\u003cstring\u003e",
"description": "The new list of emojis suggested for searching"
}
]
},
{
"name": "updateSuggestedActions",
"description": "The list of suggested to the user actions has changed",
"class": "Update",
"properties": [
{
"name": "added_actions",
"type": "vector\u003cSuggestedAction\u003e",
"description": "Added suggested actions"
},
{
"name": "removed_actions",
"type": "vector\u003cSuggestedAction\u003e",
"description": "Removed suggested actions"
}
]
},
{
"name": "updateContactCloseBirthdays",
"description": "The list of contacts that had birthdays recently or will have birthday soon has changed",
"class": "Update",
"properties": [
{
"name": "close_birthday_users",
"type": "vector\u003ccloseBirthdayUser\u003e",
"description": "List of contact users with close birthday"
}
]
},
{
"name": "updateAddChatMembersPrivacyForbidden",
"description": "Adding users to a chat has failed because of their privacy settings. An invite link can be shared with the users if appropriate",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of users, which weren't added because of their privacy settings"
}
]
},
{
"name": "updateAutosaveSettings",
"description": "Autosave settings for some type of chats were updated",
"class": "Update",
"properties": [
{
"name": "scope",
"type": "AutosaveSettingsScope",
"description": "Type of chats for which autosave settings were updated"
},
{
"name": "settings",
"type": "scopeAutosaveSettings",
"description": "The new autosave settings; may be null if the settings are reset to default"
}
]
},
{
"name": "updateBusinessConnection",
"description": "A business connection has changed; for bots only",
"class": "Update",
"properties": [
{
"name": "connection",
"type": "businessConnection",
"description": "New data about the connection"
}
]
},
{
"name": "updateNewBusinessMessage",
"description": "A new message was added to a business account; for bots only",
"class": "Update",
"properties": [
{
"name": "connection_id",
"type": "string",
"description": "Unique identifier of the business connection"
},
{
"name": "message",
"type": "businessMessage",
"description": "The new message"
}
]
},
{
"name": "updateBusinessMessageEdited",
"description": "A message in a business account was edited; for bots only",
"class": "Update",
"properties": [
{
"name": "connection_id",
"type": "string",
"description": "Unique identifier of the business connection"
},
{
"name": "message",
"type": "businessMessage",
"description": "The edited message"
}
]
},
{
"name": "updateBusinessMessagesDeleted",
"description": "Messages in a business account were deleted; for bots only",
"class": "Update",
"properties": [
{
"name": "connection_id",
"type": "string",
"description": "Unique identifier of the business connection"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat in the business account in which messages were deleted"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Unique message identifiers of the deleted messages"
}
]
},
{
"name": "updateNewInlineQuery",
"description": "A new incoming inline query; for bots only",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique query identifier"
},
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "user_location",
"type": "location",
"description": "User location; may be null"
},
{
"name": "chat_type",
"type": "ChatType",
"description": "The type of the chat from which the query originated; may be null if unknown"
},
{
"name": "query",
"type": "string",
"description": "Text of the query"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return"
}
]
},
{
"name": "updateNewChosenInlineResult",
"description": "The user has chosen a result of an inline query; for bots only",
"class": "Update",
"properties": [
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "user_location",
"type": "location",
"description": "User location; may be null"
},
{
"name": "query",
"type": "string",
"description": "Text of the query"
},
{
"name": "result_id",
"type": "string",
"description": "Identifier of the chosen result"
},
{
"name": "inline_message_id",
"type": "string",
"description": "Identifier of the sent inline message, if known"
}
]
},
{
"name": "updateNewCallbackQuery",
"description": "A new incoming callback query; for bots only",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique query identifier"
},
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat where the query was sent"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message from which the query originated"
},
{
"name": "chat_instance",
"type": "int64",
"description": "Identifier that uniquely corresponds to the chat to which the message was sent"
},
{
"name": "payload",
"type": "CallbackQueryPayload",
"description": "Query payload"
}
]
},
{
"name": "updateNewInlineCallbackQuery",
"description": "A new incoming callback query from a message sent via a bot; for bots only",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique query identifier"
},
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "inline_message_id",
"type": "string",
"description": "Identifier of the inline message from which the query originated"
},
{
"name": "chat_instance",
"type": "int64",
"description": "An identifier uniquely corresponding to the chat a message was sent to"
},
{
"name": "payload",
"type": "CallbackQueryPayload",
"description": "Query payload"
}
]
},
{
"name": "updateNewShippingQuery",
"description": "A new incoming shipping query; for bots only. Only for invoices with flexible price",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique query identifier"
},
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "invoice_payload",
"type": "string",
"description": "Invoice payload"
},
{
"name": "shipping_address",
"type": "address",
"description": "User shipping address"
}
]
},
{
"name": "updateNewPreCheckoutQuery",
"description": "A new incoming pre-checkout query; for bots only. Contains full information about a checkout",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "Unique query identifier"
},
{
"name": "sender_user_id",
"type": "int53",
"description": "Identifier of the user who sent the query"
},
{
"name": "currency",
"type": "string",
"description": "Currency for the product price"
},
{
"name": "total_amount",
"type": "int53",
"description": "Total price for the product, in the smallest units of the currency"
},
{
"name": "invoice_payload",
"type": "bytes",
"description": "Invoice payload"
},
{
"name": "shipping_option_id",
"type": "string",
"description": "Identifier of a 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": "updateNewCustomEvent",
"description": "A new incoming event; for bots only",
"class": "Update",
"properties": [
{
"name": "event",
"type": "string",
"description": "A JSON-serialized event"
}
]
},
{
"name": "updateNewCustomQuery",
"description": "A new incoming query; for bots only",
"class": "Update",
"properties": [
{
"name": "id",
"type": "int64",
"description": "The query identifier"
},
{
"name": "data",
"type": "string",
"description": "JSON-serialized query data"
},
{
"name": "timeout",
"type": "int32",
"description": "Query timeout"
}
]
},
{
"name": "updatePoll",
"description": "A poll was updated; for bots only",
"class": "Update",
"properties": [
{
"name": "poll",
"type": "poll",
"description": "New data about the poll"
}
]
},
{
"name": "updatePollAnswer",
"description": "A user changed the answer to a poll; for bots only",
"class": "Update",
"properties": [
{
"name": "poll_id",
"type": "int64",
"description": "Unique poll identifier"
},
{
"name": "voter_id",
"type": "MessageSender",
"description": "Identifier of the message sender that changed the answer to the poll"
},
{
"name": "option_ids",
"type": "vector\u003cint32\u003e",
"description": "0-based identifiers of answer options, chosen by the user"
}
]
},
{
"name": "updateChatMember",
"description": "User rights changed in a chat; for bots only",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "actor_user_id",
"type": "int53",
"description": "Identifier of the user, changing the rights"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the user rights were changed"
},
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "If user has joined the chat using an invite link, the invite link; may be null"
},
{
"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": "old_chat_member",
"type": "chatMember",
"description": "Previous chat member"
},
{
"name": "new_chat_member",
"type": "chatMember",
"description": "New chat member"
}
]
},
{
"name": "updateNewChatJoinRequest",
"description": "A user sent a join request to a chat; for bots only",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "request",
"type": "chatJoinRequest",
"description": "Join request"
},
{
"name": "user_chat_id",
"type": "int53",
"description": "Chat identifier of the private chat with the user"
},
{
"name": "invite_link",
"type": "chatInviteLink",
"description": "The invite link, which was used to send join request; may be null"
}
]
},
{
"name": "updateChatBoost",
"description": "A chat boost has changed; for bots only",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "boost",
"type": "chatBoost",
"description": "New information about the boost"
}
]
},
{
"name": "updateMessageReaction",
"description": "User changed its reactions on a message with public reactions; for bots only",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "actor_id",
"type": "MessageSender",
"description": "Identifier of the user or chat that changed reactions"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the reactions were changed"
},
{
"name": "old_reaction_types",
"type": "vector\u003cReactionType\u003e",
"description": "Old list of chosen reactions"
},
{
"name": "new_reaction_types",
"type": "vector\u003cReactionType\u003e",
"description": "New list of chosen reactions"
}
]
},
{
"name": "updateMessageReactions",
"description": "Reactions added to a message with anonymous reactions have changed; for bots only",
"class": "Update",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the reactions were changed"
},
{
"name": "reactions",
"type": "vector\u003cmessageReaction\u003e",
"description": "The list of reactions added to the message"
}
]
},
{
"name": "updates",
"description": "Contains a list of updates",
"class": "Updates",
"properties": [
{
"name": "updates",
"type": "vector\u003cUpdate\u003e",
"description": "List of updates"
}
]
},
{
"name": "logStreamDefault",
"description": "The log is written to stderr or an OS specific log",
"class": "LogStream",
"properties": []
},
{
"name": "logStreamFile",
"description": "The log is written to a file",
"class": "LogStream",
"properties": [
{
"name": "path",
"type": "string",
"description": "Path to the file to where the internal TDLib log will be written"
},
{
"name": "max_file_size",
"type": "int53",
"description": "The maximum size of the file to where the internal TDLib log is written before the file will automatically be rotated, in bytes"
},
{
"name": "redirect_stderr",
"type": "Bool",
"description": "Pass true to additionally redirect stderr to the log file. Ignored on Windows"
}
]
},
{
"name": "logStreamEmpty",
"description": "The log is written nowhere",
"class": "LogStream",
"properties": []
},
{
"name": "logVerbosityLevel",
"description": "Contains a TDLib internal log verbosity level",
"class": "LogVerbosityLevel",
"properties": [
{
"name": "verbosity_level",
"type": "int32",
"description": "Log verbosity level"
}
]
},
{
"name": "logTags",
"description": "Contains a list of available TDLib internal log tags",
"class": "LogTags",
"properties": [
{
"name": "tags",
"type": "vector\u003cstring\u003e",
"description": "List of log tags"
}
]
},
{
"name": "userSupportInfo",
"description": "Contains custom information about the user",
"class": "UserSupportInfo",
"properties": [
{
"name": "message",
"type": "formattedText",
"description": "Information message"
},
{
"name": "author",
"type": "string",
"description": "Information author"
},
{
"name": "date",
"type": "int32",
"description": "Information change date"
}
]
},
{
"name": "testInt",
"description": "A simple object containing a number; for testing only",
"class": "TestInt",
"properties": [
{
"name": "value",
"type": "int32",
"description": "Number"
}
]
},
{
"name": "testString",
"description": "A simple object containing a string; for testing only",
"class": "TestString",
"properties": [
{
"name": "value",
"type": "string",
"description": "String"
}
]
},
{
"name": "testBytes",
"description": "A simple object containing a sequence of bytes; for testing only",
"class": "TestBytes",
"properties": [
{
"name": "value",
"type": "bytes",
"description": "Bytes"
}
]
},
{
"name": "testVectorInt",
"description": "A simple object containing a vector of numbers; for testing only",
"class": "TestVectorInt",
"properties": [
{
"name": "value",
"type": "vector\u003cint32\u003e",
"description": "Vector of numbers"
}
]
},
{
"name": "testVectorIntObject",
"description": "A simple object containing a vector of objects that hold a number; for testing only",
"class": "TestVectorIntObject",
"properties": [
{
"name": "value",
"type": "vector\u003ctestInt\u003e",
"description": "Vector of objects"
}
]
},
{
"name": "testVectorString",
"description": "A simple object containing a vector of strings; for testing only",
"class": "TestVectorString",
"properties": [
{
"name": "value",
"type": "vector\u003cstring\u003e",
"description": "Vector of strings"
}
]
},
{
"name": "testVectorStringObject",
"description": "A simple object containing a vector of objects that hold a string; for testing only",
"class": "TestVectorStringObject",
"properties": [
{
"name": "value",
"type": "vector\u003ctestString\u003e",
"description": "Vector of objects"
}
]
}
],
"classes": [
{
"name": "AuthenticationCodeType",
"description": "Provides information about the method by which an authentication code is delivered to the user"
},
{
"name": "EmailAddressAuthentication",
"description": "Contains authentication data for a email address"
},
{
"name": "EmailAddressResetState",
"description": "Describes reset state of a email address"
},
{
"name": "AuthorizationState",
"description": "Represents the current authorization state of the TDLib client"
},
{
"name": "InputFile",
"description": "Points to a file"
},
{
"name": "ThumbnailFormat",
"description": "Describes format of a thumbnail"
},
{
"name": "MaskPoint",
"description": "Part of the face, relative to which a mask is placed"
},
{
"name": "StickerFormat",
"description": "Describes format of a sticker"
},
{
"name": "StickerType",
"description": "Describes type of a sticker"
},
{
"name": "StickerFullType",
"description": "Contains full information about sticker type"
},
{
"name": "PollType",
"description": "Describes the type of a poll"
},
{
"name": "UserType",
"description": "Represents the type of a user. The following types are possible: regular users, deleted users and bots"
},
{
"name": "BusinessAwayMessageSchedule",
"description": "Describes conditions for sending of away messages by a Telegram Business account"
},
{
"name": "ChatPhotoStickerType",
"description": "Describes type of a sticker, which was used to create a chat photo"
},
{
"name": "InputChatPhoto",
"description": "Describes a photo to be set as a user profile or chat photo"
},
{
"name": "PremiumGiveawayParticipantStatus",
"description": "Contains information about status of a user in a Telegram Premium giveaway"
},
{
"name": "PremiumGiveawayInfo",
"description": "Contains information about Telegram Premium giveaway"
},
{
"name": "ChatMemberStatus",
"description": "Provides information about the status of a member in a chat"
},
{
"name": "ChatMembersFilter",
"description": "Specifies the kind of chat members to return in searchChatMembers"
},
{
"name": "SupergroupMembersFilter",
"description": "Specifies the kind of chat members to return in getSupergroupMembers"
},
{
"name": "InviteLinkChatType",
"description": "Describes the type of a chat to which points an invite link"
},
{
"name": "SecretChatState",
"description": "Describes the current secret chat state"
},
{
"name": "MessageSender",
"description": "Contains information about the sender of a message"
},
{
"name": "MessageReadDate",
"description": "Describes read date of a recent outgoing message in a private chat"
},
{
"name": "MessageOrigin",
"description": "Contains information about the origin of a message"
},
{
"name": "ReactionType",
"description": "Describes type of message reaction"
},
{
"name": "MessageSendingState",
"description": "Contains information about the sending state of the message"
},
{
"name": "MessageReplyTo",
"description": "Contains information about the message or the story a message is replying to"
},
{
"name": "InputMessageReplyTo",
"description": "Contains information about the message or the story to be replied"
},
{
"name": "MessageSource",
"description": "Describes source of a message"
},
{
"name": "MessageSponsorType",
"description": "Describes type of a message sponsor"
},
{
"name": "ReportChatSponsoredMessageResult",
"description": "Describes result of sponsored message report"
},
{
"name": "NotificationSettingsScope",
"description": "Describes the types of chats to which notification settings are relevant"
},
{
"name": "ChatType",
"description": "Describes the type of a chat"
},
{
"name": "ChatList",
"description": "Describes a list of chats"
},
{
"name": "ChatSource",
"description": "Describes a reason why an external chat is shown in a chat list"
},
{
"name": "ChatAvailableReactions",
"description": "Describes reactions available in the chat"
},
{
"name": "PublicChatType",
"description": "Describes a type of public chats"
},
{
"name": "ChatActionBar",
"description": "Describes actions which must be possible to do through a chat action bar"
},
{
"name": "KeyboardButtonType",
"description": "Describes a keyboard button type"
},
{
"name": "InlineKeyboardButtonType",
"description": "Describes the type of an inline keyboard button"
},
{
"name": "ReplyMarkup",
"description": "Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots"
},
{
"name": "LoginUrlInfo",
"description": "Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl"
},
{
"name": "SavedMessagesTopicType",
"description": "Describes type of a Saved Messages topic"
},
{
"name": "RichText",
"description": "Describes a text object inside an instant-view web page"
},
{
"name": "PageBlockHorizontalAlignment",
"description": "Describes a horizontal alignment of a table cell content"
},
{
"name": "PageBlockVerticalAlignment",
"description": "Describes a Vertical alignment of a table cell content"
},
{
"name": "PageBlock",
"description": "Describes a block of an instant view web page"
},
{
"name": "CollectibleItemType",
"description": "Describes a collectible item that can be purchased at https://fragment.com"
},
{
"name": "InputCredentials",
"description": "Contains information about the payment method chosen by the user"
},
{
"name": "PaymentProvider",
"description": "Contains information about a payment provider"
},
{
"name": "InputInvoice",
"description": "Describes an invoice to process"
},
{
"name": "MessageExtendedMedia",
"description": "Describes a media, which is attached to an invoice"
},
{
"name": "PassportElementType",
"description": "Contains the type of a Telegram Passport element"
},
{
"name": "PassportElement",
"description": "Contains information about a Telegram Passport element"
},
{
"name": "InputPassportElement",
"description": "Contains information about a Telegram Passport element to be saved"
},
{
"name": "PassportElementErrorSource",
"description": "Contains the description of an error in a Telegram Passport element"
},
{
"name": "InputPassportElementErrorSource",
"description": "Contains the description of an error in a Telegram Passport element; for bots only"
},
{
"name": "MessageContent",
"description": "Contains the content of a message"
},
{
"name": "TextEntityType",
"description": "Represents a part of the text which must be formatted differently"
},
{
"name": "MessageSchedulingState",
"description": "Contains information about the time when a scheduled message will be sent"
},
{
"name": "MessageSelfDestructType",
"description": "Describes when a message will be self-destructed"
},
{
"name": "InputMessageContent",
"description": "The content of a message to send"
},
{
"name": "SearchMessagesFilter",
"description": "Represents a filter for message search results"
},
{
"name": "ChatAction",
"description": "Describes the different types of activity in a chat"
},
{
"name": "UserStatus",
"description": "Describes the last time the user was online"
},
{
"name": "EmojiCategoryType",
"description": "Describes type of an emoji category"
},
{
"name": "StoryAreaType",
"description": "Describes type of a clickable rectangle area on a story media"
},
{
"name": "InputStoryAreaType",
"description": "Describes type of a clickable rectangle area on a story media to be added"
},
{
"name": "StoryContent",
"description": "Contains the content of a story"
},
{
"name": "InputStoryContent",
"description": "The content of a story to send"
},
{
"name": "StoryList",
"description": "Describes a list of stories"
},
{
"name": "StoryOrigin",
"description": "Contains information about the origin of a story that was reposted"
},
{
"name": "StoryInteractionType",
"description": "Describes type of interaction with a story"
},
{
"name": "PublicForward",
"description": "Describes a public forward or repost of a story"
},
{
"name": "ChatBoostSource",
"description": "Describes source of a chat boost"
},
{
"name": "CallDiscardReason",
"description": "Describes the reason why a call was discarded"
},
{
"name": "CallServerType",
"description": "Describes the type of a call server"
},
{
"name": "CallState",
"description": "Describes the current call state"
},
{
"name": "GroupCallVideoQuality",
"description": "Describes the quality of a group call video"
},
{
"name": "CallProblem",
"description": "Describes the exact type of a problem with a call"
},
{
"name": "FirebaseAuthenticationSettings",
"description": "Contains settings for Firebase Authentication in the official applications"
},
{
"name": "ReactionUnavailabilityReason",
"description": "Describes why the current user can't add reactions to the message, despite some other users can"
},
{
"name": "DiceStickers",
"description": "Contains animated stickers which must be used for dice animation rendering"
},
{
"name": "SpeechRecognitionResult",
"description": "Describes result of speech recognition in a voice note"
},
{
"name": "BotWriteAccessAllowReason",
"description": "Describes a reason why a bot was allowed to write messages to the current user"
},
{
"name": "InputInlineQueryResult",
"description": "Represents a single result of an inline query; for bots only"
},
{
"name": "InlineQueryResult",
"description": "Represents a single result of an inline query"
},
{
"name": "InlineQueryResultsButtonType",
"description": "Represents a type of a button in results of inline query"
},
{
"name": "CallbackQueryPayload",
"description": "Represents a payload of a callback query"
},
{
"name": "ChatEventAction",
"description": "Represents a chat event"
},
{
"name": "LanguagePackStringValue",
"description": "Represents the value of a string in a language pack"
},
{
"name": "PremiumLimitType",
"description": "Describes type of a limit, increased for Premium users"
},
{
"name": "PremiumFeature",
"description": "Describes a feature available to Premium users"
},
{
"name": "BusinessFeature",
"description": "Describes a feature available to Business user accounts"
},
{
"name": "PremiumStoryFeature",
"description": "Describes a story feature available to Premium users"
},
{
"name": "PremiumSource",
"description": "Describes a source from which the Premium features screen is opened"
},
{
"name": "StorePaymentPurpose",
"description": "Describes a purpose of an in-store payment"
},
{
"name": "TelegramPaymentPurpose",
"description": "Describes a purpose of a payment toward Telegram"
},
{
"name": "DeviceToken",
"description": "Represents a data needed to subscribe for push notifications through registerDevice method."
},
{
"name": "BackgroundFill",
"description": "Describes a fill of a background"
},
{
"name": "BackgroundType",
"description": "Describes the type of a background"
},
{
"name": "InputBackground",
"description": "Contains information about background to set"
},
{
"name": "CanSendStoryResult",
"description": "Represents result of checking whether the current user can send a story in the specific chat"
},
{
"name": "CanTransferOwnershipResult",
"description": "Represents result of checking whether the current session can be used to transfer a chat ownership to another user"
},
{
"name": "CheckChatUsernameResult",
"description": "Represents result of checking whether a username can be set for a chat"
},
{
"name": "CheckStickerSetNameResult",
"description": "Represents result of checking whether a name can be used for a new sticker set"
},
{
"name": "ResetPasswordResult",
"description": "Represents result of 2-step verification password reset"
},
{
"name": "MessageFileType",
"description": "Contains information about a file with messages exported from another app"
},
{
"name": "PushMessageContent",
"description": "Contains content of a push message notification"
},
{
"name": "NotificationType",
"description": "Contains detailed information about a notification"
},
{
"name": "NotificationGroupType",
"description": "Describes the type of notifications in a notification group"
},
{
"name": "OptionValue",
"description": "Represents the value of an option"
},
{
"name": "JsonValue",
"description": "Represents a JSON value"
},
{
"name": "StoryPrivacySettings",
"description": "Describes privacy settings of a story"
},
{
"name": "UserPrivacySettingRule",
"description": "Represents a single rule for managing user privacy settings"
},
{
"name": "UserPrivacySetting",
"description": "Describes available user privacy settings"
},
{
"name": "CanSendMessageToUserResult",
"description": "Describes result of canSendMessageToUser"
},
{
"name": "SessionType",
"description": "Represents the type of a session"
},
{
"name": "ReportReason",
"description": "Describes the reason why a chat is reported"
},
{
"name": "TargetChat",
"description": "Describes the target chat to be opened"
},
{
"name": "InternalLinkType",
"description": "Describes an internal https://t.me or tg: link, which must be processed by the application in a special way"
},
{
"name": "BlockList",
"description": "Describes a type of a block list"
},
{
"name": "FileType",
"description": "Represents the type of a file"
},
{
"name": "NetworkType",
"description": "Represents the type of a network"
},
{
"name": "NetworkStatisticsEntry",
"description": "Contains statistics about network usage"
},
{
"name": "AutosaveSettingsScope",
"description": "Describes scope of autosave settings"
},
{
"name": "ConnectionState",
"description": "Describes the current state of the connection to Telegram servers"
},
{
"name": "TopChatCategory",
"description": "Represents the categories of chats for which a list of frequently used chats can be retrieved"
},
{
"name": "TMeUrlType",
"description": "Describes the type of a URL linking to an internal Telegram entity"
},
{
"name": "SuggestedAction",
"description": "Describes an action suggested to the current user"
},
{
"name": "TextParseMode",
"description": "Describes the way the text needs to be parsed for text entities"
},
{
"name": "ProxyType",
"description": "Describes the type of a proxy server"
},
{
"name": "StatisticalGraph",
"description": "Describes a statistical graph"
},
{
"name": "ChatStatisticsObjectType",
"description": "Describes type of an object, for which statistics are provided"
},
{
"name": "ChatStatistics",
"description": "Contains a detailed statistics about a chat"
},
{
"name": "VectorPathCommand",
"description": "Represents a vector path command"
},
{
"name": "BotCommandScope",
"description": "Represents the scope to which bot commands are relevant"
},
{
"name": "Update",
"description": "Contains notifications about data changes"
},
{
"name": "LogStream",
"description": "Describes a stream to which TDLib internal log is written"
}
],
"functions": [
{
"name": "getAuthorizationState",
"description": "Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state. Can be called before initialization",
"class": "AuthorizationState",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "setTdlibParameters",
"description": "Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters",
"class": "Ok",
"properties": [
{
"name": "use_test_dc",
"type": "Bool",
"description": "Pass true to use Telegram test environment instead of the production environment"
},
{
"name": "database_directory",
"type": "string",
"description": "The path to the directory for the persistent database; if empty, the current working directory will be used"
},
{
"name": "files_directory",
"type": "string",
"description": "The path to the directory for storing files; if empty, database_directory will be used"
},
{
"name": "database_encryption_key",
"type": "bytes",
"description": "Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned"
},
{
"name": "use_file_database",
"type": "Bool",
"description": "Pass true to keep information about downloaded and uploaded files between application restarts"
},
{
"name": "use_chat_info_database",
"type": "Bool",
"description": "Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database"
},
{
"name": "use_message_database",
"type": "Bool",
"description": "Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database"
},
{
"name": "use_secret_chats",
"type": "Bool",
"description": "Pass true to enable support for secret chats"
},
{
"name": "api_id",
"type": "int32",
"description": "Application identifier for Telegram API access, which can be obtained at https://my.telegram.org"
},
{
"name": "api_hash",
"type": "string",
"description": "Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org"
},
{
"name": "system_language_code",
"type": "string",
"description": "IETF language tag of the user's operating system language; must be non-empty"
},
{
"name": "device_model",
"type": "string",
"description": "Model of the device the application is being run on; must be non-empty"
},
{
"name": "system_version",
"type": "string",
"description": "Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib"
},
{
"name": "application_version",
"type": "string",
"description": "Application version; must be non-empty"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setAuthenticationPhoneNumber",
"description": "Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "The phone number of the user, in international format"
},
{
"name": "settings",
"type": "phoneNumberAuthenticationSettings",
"description": "Settings for the authentication of the user's phone number; pass null to use default settings"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setAuthenticationEmailAddress",
"description": "Sets the email address of the user and sends an authentication code to the email address. Works only when the current authorization state is authorizationStateWaitEmailAddress",
"class": "Ok",
"properties": [
{
"name": "email_address",
"type": "string",
"description": "The email address of the user"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "resendAuthenticationCode",
"description": "Resends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode, the next_code_type of the result is not null and the server-specified timeout has passed, or when the current authorization state is authorizationStateWaitEmailCode",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "checkAuthenticationEmailCode",
"description": "Checks the authentication of a email address. Works only when the current authorization state is authorizationStateWaitEmailCode",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "EmailAddressAuthentication",
"description": "Email address authentication to check"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "checkAuthenticationCode",
"description": "Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "Authentication code to check"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "requestQrCodeAuthentication",
"description": "Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "other_user_ids",
"type": "vector\u003cint53\u003e",
"description": "List of user identifiers of other users currently using the application"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "registerUser",
"description": "Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration",
"class": "Ok",
"properties": [
{
"name": "first_name",
"type": "string",
"description": "The first name of the user; 1-64 characters"
},
{
"name": "last_name",
"type": "string",
"description": "The last name of the user; 0-64 characters"
},
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification about the current user joining Telegram for other users that added them to contact list"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "resetAuthenticationEmailAddress",
"description": "Resets the login email address. May return an error with a message \"TASK_ALREADY_EXISTS\" if reset is still pending. Works only when the current authorization state is authorizationStateWaitEmailCode and authorization_state.can_reset_email_address == true",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "checkAuthenticationPassword",
"description": "Checks the 2-step verification password for correctness. Works only when the current authorization state is authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password to check"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "requestAuthenticationPasswordRecovery",
"description": "Requests to send a 2-step verification password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "checkAuthenticationPasswordRecoveryCode",
"description": "Checks whether a 2-step verification password recovery code sent to an email address is valid. Works only when the current authorization state is authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "recovery_code",
"type": "string",
"description": "Recovery code to check"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "recoverAuthenticationPassword",
"description": "Recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "recovery_code",
"type": "string",
"description": "Recovery code to check"
},
{
"name": "new_password",
"type": "string",
"description": "New 2-step verification password of the user; may be empty to remove the password"
},
{
"name": "new_hint",
"type": "string",
"description": "New password hint; may be empty"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "sendAuthenticationFirebaseSms",
"description": "Sends Firebase Authentication SMS to the phone number of the user. Works only when the current authorization state is authorizationStateWaitCode and the server returned code of the type authenticationCodeTypeFirebaseAndroid or authenticationCodeTypeFirebaseIos",
"class": "Ok",
"properties": [
{
"name": "token",
"type": "string",
"description": "SafetyNet Attestation API token for the Android application, or secret from push notification for the iOS application"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "checkAuthenticationBotToken",
"description": "Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in",
"class": "Ok",
"properties": [
{
"name": "token",
"type": "string",
"description": "The bot token"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "logOut",
"description": "Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes, updateAuthorizationState with authorizationStateClosed will be sent",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "close",
"description": "Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent. Can be called before initialization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "destroy",
"description": "Closes the TDLib instance, destroying all local data without a proper logout. The current user session will remain in the list of all active sessions. All local data will be destroyed. After the destruction completes updateAuthorizationState with authorizationStateClosed will be sent. Can be called before authorization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "confirmQrCodeAuthentication",
"description": "Confirms QR code authentication on another device. Returns created session on success",
"class": "Session",
"properties": [
{
"name": "link",
"type": "string",
"description": "A link from a QR code. The link must be scanned by the in-app camera"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getCurrentState",
"description": "Returns all updates needed to restore current TDLib state, i.e. all actual updateAuthorizationState/updateUser/updateNewChat and others. This is especially useful if TDLib is run in a separate process. Can be called before initialization",
"class": "Updates",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "setDatabaseEncryptionKey",
"description": "Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain",
"class": "Ok",
"properties": [
{
"name": "new_encryption_key",
"type": "bytes",
"description": "New encryption key"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getPasswordState",
"description": "Returns the current state of 2-step verification",
"class": "PasswordState",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setPassword",
"description": "Changes the 2-step verification password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed",
"class": "PasswordState",
"properties": [
{
"name": "old_password",
"type": "string",
"description": "Previous 2-step verification password of the user"
},
{
"name": "new_password",
"type": "string",
"description": "New 2-step verification password of the user; may be empty to remove the password"
},
{
"name": "new_hint",
"type": "string",
"description": "New password hint; may be empty"
},
{
"name": "set_recovery_email_address",
"type": "Bool",
"description": "Pass true to change also the recovery email address"
},
{
"name": "new_recovery_email_address",
"type": "string",
"description": "New recovery email address; may be empty"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setLoginEmailAddress",
"description": "Changes the login email address of the user. The email address can be changed only if the current user already has login email and passwordState.login_email_address_pattern is non-empty. The change will not be applied until the new login email address is confirmed with checkLoginEmailAddressCode. To use Apple ID/Google ID instead of a email address, call checkLoginEmailAddressCode directly",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [
{
"name": "new_login_email_address",
"type": "string",
"description": "New login email address"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendLoginEmailAddressCode",
"description": "Resends the login email address verification code",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkLoginEmailAddressCode",
"description": "Checks the login email address authentication",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "EmailAddressAuthentication",
"description": "Email address authentication to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecoveryEmailAddress",
"description": "Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a password provided by the user",
"class": "RecoveryEmailAddress",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password for the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setRecoveryEmailAddress",
"description": "Changes the 2-step verification recovery email address of the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed. If new_recovery_email_address is the same as the email address that is currently set up, this call succeeds immediately and aborts all other requests waiting for an email confirmation",
"class": "PasswordState",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
},
{
"name": "new_recovery_email_address",
"type": "string",
"description": "New recovery email address"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkRecoveryEmailAddressCode",
"description": "Checks the 2-step verification recovery email address verification code",
"class": "PasswordState",
"properties": [
{
"name": "code",
"type": "string",
"description": "Verification code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendRecoveryEmailAddressCode",
"description": "Resends the 2-step verification recovery email address verification code",
"class": "PasswordState",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "cancelRecoveryEmailAddressVerification",
"description": "Cancels verification of the 2-step verification recovery email address",
"class": "PasswordState",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "requestPasswordRecovery",
"description": "Requests to send a 2-step verification password recovery code to an email address that was previously set up",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkPasswordRecoveryCode",
"description": "Checks whether a 2-step verification password recovery code sent to an email address is valid",
"class": "Ok",
"properties": [
{
"name": "recovery_code",
"type": "string",
"description": "Recovery code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "recoverPassword",
"description": "Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up",
"class": "PasswordState",
"properties": [
{
"name": "recovery_code",
"type": "string",
"description": "Recovery code to check"
},
{
"name": "new_password",
"type": "string",
"description": "New 2-step verification password of the user; may be empty to remove the password"
},
{
"name": "new_hint",
"type": "string",
"description": "New password hint; may be empty"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resetPassword",
"description": "Removes 2-step verification password without previous password and access to recovery email address. The password can't be reset immediately and the request needs to be repeated after the specified time",
"class": "ResetPasswordResult",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "cancelPasswordReset",
"description": "Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date \u003e 0",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "createTemporaryPassword",
"description": "Creates a new temporary password for processing payments",
"class": "TemporaryPasswordState",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
},
{
"name": "valid_for",
"type": "int32",
"description": "Time during which the temporary password will be valid, in seconds; must be between 60 and 86400"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getTemporaryPasswordState",
"description": "Returns information about the current temporary password",
"class": "TemporaryPasswordState",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getMe",
"description": "Returns the current user",
"class": "User",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getUser",
"description": "Returns information about a user by their identifier. This is an offline request if the current user is not a bot",
"class": "User",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getUserFullInfo",
"description": "Returns full information about a user by their identifier",
"class": "UserFullInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getBasicGroup",
"description": "Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot",
"class": "BasicGroup",
"properties": [
{
"name": "basic_group_id",
"type": "int53",
"description": "Basic group identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getBasicGroupFullInfo",
"description": "Returns full information about a basic group by its identifier",
"class": "BasicGroupFullInfo",
"properties": [
{
"name": "basic_group_id",
"type": "int53",
"description": "Basic group identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getSupergroup",
"description": "Returns information about a supergroup or a channel by its identifier. This is an offline request if the current user is not a bot",
"class": "Supergroup",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup or channel identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getSupergroupFullInfo",
"description": "Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute",
"class": "SupergroupFullInfo",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup or channel identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getSecretChat",
"description": "Returns information about a secret chat by its identifier. This is an offline request",
"class": "SecretChat",
"properties": [
{
"name": "secret_chat_id",
"type": "int32",
"description": "Secret chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChat",
"description": "Returns information about a chat by its identifier; this is an offline request if the current user is not a bot",
"class": "Chat",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getMessage",
"description": "Returns information about a message",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message to get"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getMessageLocally",
"description": "Returns information about a message, if it is available without sending network request. This is an offline request",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message to get"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getRepliedMessage",
"description": "Returns information about a non-bundled message that is replied by a given message. Also, returns the pinned message, the game message, the invoice message, the message with a previously set same background, the giveaway message, and the topic creation message for messages of the types messagePinMessage, messageGameScore, messagePaymentSuccessful, messageChatSetBackground, messagePremiumGiveawayCompleted and topic messages without non-bundled replied message respectively",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the reply message"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatPinnedMessage",
"description": "Returns information about a newest pinned message in the chat",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the message belongs to"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getCallbackQueryMessage",
"description": "Returns information about a message with the callback button that originated a callback query; for bots only",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "callback_query_id",
"type": "int64",
"description": "Identifier of the callback query"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getMessages",
"description": "Returns information about messages. If a message is not found, returns null on the corresponding position of the result",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat the messages belong to"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the messages to get"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getMessageThread",
"description": "Returns information about a message thread. Can be used only if message.can_get_message_thread == true",
"class": "MessageThreadInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageReadDate",
"description": "Returns read date of a recent outgoing message in a private chat. The method can be called if message.can_get_read_date == true and the message is read",
"class": "MessageReadDate",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageViewers",
"description": "Returns viewers of a recent outgoing message in a basic group or a supergroup chat. For video notes and voice notes only users, opened content of the message, are returned. The method can be called if message.can_get_viewers == true",
"class": "MessageViewers",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getFile",
"description": "Returns information about a file; this is an offline request",
"class": "File",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file to get"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getRemoteFile",
"description": "Returns information about a file by its remote identifier; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even the request succeeds, the file can be used only if it is still accessible to the user. 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": "File",
"properties": [
{
"name": "remote_file_id",
"type": "string",
"description": "Remote identifier of the file to get"
},
{
"name": "file_type",
"type": "FileType",
"description": "File type; pass null if unknown"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "loadChats",
"description": "Loads more chats from a chat list. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded",
"class": "Ok",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list in which to load chats; pass null to load chats from the main chat list"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChats",
"description": "Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats and updates processing instead to maintain chat lists in a consistent state",
"class": "Chats",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list in which to return chats; pass null to get chats from the main chat list"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchPublicChat",
"description": "Searches a public chat by its username. Currently, only private chats, supergroups and channels can be public. Returns the chat if found; otherwise, an error is returned",
"class": "Chat",
"properties": [
{
"name": "username",
"type": "string",
"description": "Username to be resolved"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchPublicChats",
"description": "Searches public chats by looking for specified query in their username and title. Currently, only private chats, supergroups and channels can be public. Returns a meaningful number of results. Excludes private chats with contacts and chats from the chat list from the results",
"class": "Chats",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchChats",
"description": "Searches for the specified query in the title and username of already known chats; this is an offline request. Returns chats in the order seen in the main chat list",
"class": "Chats",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for. If the query is empty, returns up to 50 recently found chats"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchChatsOnServer",
"description": "Searches for the specified query in the title and username of already known chats via request to the server. Returns chats in the order seen in the main chat list",
"class": "Chats",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchChatsNearby",
"description": "Returns a list of users and location-based supergroups nearby. The list of users nearby will be updated for 60 seconds after the request by the updates updateUsersNearby. The request must be sent again every 25 seconds with adjusted location to not miss new chats",
"class": "ChatsNearby",
"properties": [
{
"name": "location",
"type": "location",
"description": "Current user location"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatSimilarChats",
"description": "Returns a list of chats similar to the given chat",
"class": "Chats",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the target chat; must be an identifier of a channel chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatSimilarChatCount",
"description": "Returns approximate number of chats similar to the given chat",
"class": "Count",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the target chat; must be an identifier of a channel chat"
},
{
"name": "return_local",
"type": "Bool",
"description": "Pass true to get the number of chats without sending network requests, or -1 if the number of chats is unknown locally"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "openChatSimilarChat",
"description": "Informs TDLib that a chat was opened from the list of similar chats. The method is independent from openChat and closeChat methods",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the original chat, which similar chats were requested"
},
{
"name": "opened_chat_id",
"type": "int53",
"description": "Identifier of the opened chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getTopChats",
"description": "Returns a list of frequently used chats",
"class": "Chats",
"properties": [
{
"name": "category",
"type": "TopChatCategory",
"description": "Category of chats to be returned"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned; up to 30"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeTopChat",
"description": "Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled",
"class": "Ok",
"properties": [
{
"name": "category",
"type": "TopChatCategory",
"description": "Category of frequently used chats"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchRecentlyFoundChats",
"description": "Searches for the specified query in the title and username of up to 50 recently found chats; this is an offline request",
"class": "Chats",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addRecentlyFoundChat",
"description": "Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, it will be removed from the list first",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to add"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeRecentlyFoundChat",
"description": "Removes a chat from the list of recently found chats",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to be removed"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clearRecentlyFoundChats",
"description": "Clears the list of recently found chats",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecentlyOpenedChats",
"description": "Returns recently opened chats; this is an offline request. Returns chats in the order of last opening",
"class": "Chats",
"properties": [
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkChatUsername",
"description": "Checks whether a username can be set for a chat",
"class": "CheckChatUsernameResult",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier; must be identifier of a supergroup chat, or a channel chat, or a private chat with self, or 0 if the chat is being created"
},
{
"name": "username",
"type": "string",
"description": "Username to be checked"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getCreatedPublicChats",
"description": "Returns a list of public chats of the specified type, owned by the user",
"class": "Chats",
"properties": [
{
"name": "type",
"type": "PublicChatType",
"description": "Type of the public chats to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkCreatedPublicChatsLimit",
"description": "Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached. The limit can be increased with Telegram Premium",
"class": "Ok",
"properties": [
{
"name": "type",
"type": "PublicChatType",
"description": "Type of the public chats, for which to check the limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSuitableDiscussionChats",
"description": "Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Returned basic group chats must be first upgraded to supergroups before they can be set as a discussion group. To set a returned supergroup as a discussion group, access to its old messages must be enabled using toggleSupergroupIsAllHistoryAvailable first",
"class": "Chats",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getInactiveSupergroupChats",
"description": "Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error. Also, the limit can be increased with Telegram Premium",
"class": "Chats",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getSuitablePersonalChats",
"description": "Returns a list of channel chats, which can be used as a personal chat",
"class": "Chats",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "loadSavedMessagesTopics",
"description": "Loads more Saved Messages topics. The loaded topics will be sent through updateSavedMessagesTopic. Topics are sorted by their topic.order in descending order. Returns a 404 error if all topics have been loaded",
"class": "Ok",
"properties": [
{
"name": "limit",
"type": "int32",
"description": "The maximum number of topics to be loaded. For optimal performance, the number of loaded topics is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedMessagesTopicHistory",
"description": "Returns messages in a Saved Messages topic. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id)",
"class": "Messages",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which messages will be fetched"
},
{
"name": "from_message_id",
"type": "int53",
"description": "Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message"
},
{
"name": "offset",
"type": "int32",
"description": "Specify 0 to get results from exactly the message from_message_id or a negative offset up to 99 to get additionally some newer messages"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedMessagesTopicMessageByDate",
"description": "Returns the last message sent in a Saved Messages topic no later than the specified date",
"class": "Message",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which message will be returned"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) relative to which to search for messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteSavedMessagesTopicHistory",
"description": "Deletes all messages in a Saved Messages topic",
"class": "Ok",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which messages will be deleted"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteSavedMessagesTopicMessagesByDate",
"description": "Deletes all messages between the specified dates in a Saved Messages topic. Messages sent in the last 30 seconds will not be deleted",
"class": "Ok",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which messages will be deleted"
},
{
"name": "min_date",
"type": "int32",
"description": "The minimum date of the messages to delete"
},
{
"name": "max_date",
"type": "int32",
"description": "The maximum date of the messages to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSavedMessagesTopicIsPinned",
"description": "Changes the pinned state of a Saved Messages topic. There can be up to getOption(\"pinned_saved_messages_topic_count_max\") pinned topics. The limit can be increased with Telegram Premium",
"class": "Ok",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic to pin or unpin"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "Pass true to pin the topic; pass false to unpin it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPinnedSavedMessagesTopics",
"description": "Changes the order of pinned Saved Messages topics",
"class": "Ok",
"properties": [
{
"name": "saved_messages_topic_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the new pinned Saved Messages topics"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getGroupsInCommon",
"description": "Returns a list of common group chats with a given user. Chats are sorted by their type and creation date",
"class": "Chats",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "offset_chat_id",
"type": "int53",
"description": "Chat identifier starting from which to return chats; use 0 for the first request"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chats to be returned; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatHistory",
"description": "Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. This is an offline request if only_local is true",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "from_message_id",
"type": "int53",
"description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message"
},
{
"name": "offset",
"type": "int32",
"description": "Specify 0 to get results from exactly the message from_message_id or a negative offset up to 99 to get additionally some newer messages"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
},
{
"name": "only_local",
"type": "Bool",
"description": "Pass true to get only messages that are available without sending network requests"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageThreadHistory",
"description": "Returns messages in a message thread of a message. Can be used only if message.can_get_message_thread == true. Message thread of a channel message is in the channel's linked supergroup. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier, which thread history needs to be returned"
},
{
"name": "from_message_id",
"type": "int53",
"description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message"
},
{
"name": "offset",
"type": "int32",
"description": "Specify 0 to get results from exactly the message from_message_id or a negative offset up to 99 to get additionally some newer messages"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChatHistory",
"description": "Deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "remove_from_chat_list",
"type": "Bool",
"description": "Pass true to remove the chat from all chat lists"
},
{
"name": "revoke",
"type": "Bool",
"description": "Pass true to delete chat history for all users"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChat",
"description": "Deletes a chat along with all messages in the corresponding chat for all chat members. For group chats this will release the usernames and remove all members. Use the field chat.can_be_deleted_for_all_users to find whether the method can be applied to the chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchChatMessages",
"description": "Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, sender_id, filter and message_thread_id search criteria is expected to be supported, only if it is required for Telegram official application implementation",
"class": "FoundChatMessages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to search messages"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats"
},
{
"name": "from_message_id",
"type": "int53",
"description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message"
},
{
"name": "offset",
"type": "int32",
"description": "Specify 0 to get results from exactly the message from_message_id or a negative offset to get the specified message and some newer messages"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Additional filter for messages to search; pass null to search for all messages"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, only messages in the specified thread will be returned; supergroups only"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not 0, only messages in the specified Saved Messages topic will be returned; pass 0 to return all messages, or for chats other than Saved Messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchMessages",
"description": "Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit",
"class": "FoundMessages",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function"
},
{
"name": "min_date",
"type": "int32",
"description": "If not 0, the minimum date of the messages to return"
},
{
"name": "max_date",
"type": "int32",
"description": "If not 0, the maximum date of the messages to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchSecretMessages",
"description": "Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib",
"class": "FoundMessages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to search. Specify 0 to search in all secret chats"
},
{
"name": "query",
"type": "string",
"description": "Query to search for. If empty, searchChatMessages must be used instead"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Additional filter for messages to search; pass null to search for all messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchSavedMessages",
"description": "Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing message_id For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit",
"class": "FoundChatMessages",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages"
},
{
"name": "tag",
"type": "ReactionType",
"description": "Tag to search for; pass null to return all suitable messages"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "from_message_id",
"type": "int53",
"description": "Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message"
},
{
"name": "offset",
"type": "int32",
"description": "Specify 0 to get results from exactly the message from_message_id or a negative offset to get the specified message and some newer messages"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchCallMessages",
"description": "Searches for call messages. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib",
"class": "FoundMessages",
"properties": [
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit"
},
{
"name": "only_missed",
"type": "Bool",
"description": "Pass true to search only for messages with missed/declined calls"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchOutgoingDocumentMessages",
"description": "Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the results in reverse chronological order",
"class": "FoundMessages",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for in document file name and message caption"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteAllCallMessages",
"description": "Deletes all call messages",
"class": "Ok",
"properties": [
{
"name": "revoke",
"type": "Bool",
"description": "Pass true to delete the messages for all users"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchChatRecentLocationMessages",
"description": "Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getActiveLiveLocationMessages",
"description": "Returns all active live locations that need to be updated by the application. The list is persistent across application restarts only if the message database is used",
"class": "Messages",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatMessageByDate",
"description": "Returns the last message sent in a chat no later than the specified date",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "date",
"type": "int32",
"description": "Point in time (Unix timestamp) relative to which to search for messages"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatSparseMessagePositions",
"description": "Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database",
"class": "MessagePositions",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to return information about message positions"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, and searchMessagesFilterUnreadReaction are unsupported in this function"
},
{
"name": "from_message_id",
"type": "int53",
"description": "The message identifier from which to return information about message positions"
},
{
"name": "limit",
"type": "int32",
"description": "The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages, or for chats other than Saved Messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatMessageCalendar",
"description": "Returns information about the next messages of the specified type in the chat split by days. Returns the results in reverse chronological order. Can return partial result for the last returned day. Behavior of this method depends on the value of the option \"utc_time_offset\"",
"class": "MessageCalendar",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to return information about messages"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, and searchMessagesFilterUnreadReaction are unsupported in this function"
},
{
"name": "from_message_id",
"type": "int53",
"description": "The message identifier from which to return information about messages; use 0 to get results from the last message"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages, or for chats other than Saved Messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatMessageCount",
"description": "Returns approximate number of messages of the specified type in the chat",
"class": "Count",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to count messages"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Filter for message content; searchMessagesFilterEmpty is unsupported in this function"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not 0, only messages in the specified Saved Messages topic will be counted; pass 0 to count all messages, or for chats other than Saved Messages"
},
{
"name": "return_local",
"type": "Bool",
"description": "Pass true to get the number of messages without sending network requests, or -1 if the number of messages is unknown locally"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatMessagePosition",
"description": "Returns approximate 1-based position of a message among messages, which can be found by the specified filter in the chat. Cannot be used in secret chats",
"class": "Count",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which to find message position"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "filter",
"type": "SearchMessagesFilter",
"description": "Filter for message content; searchMessagesFilterEmpty, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, and searchMessagesFilterFailedToSend are unsupported in this function"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, only messages in the specified thread will be considered; supergroups only"
},
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all relevant messages, or for chats other than Saved Messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatScheduledMessages",
"description": "Returns all scheduled messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id)",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatSponsoredMessages",
"description": "Returns sponsored messages to be shown in a chat; for channel chats only",
"class": "SponsoredMessages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clickChatSponsoredMessage",
"description": "Informs TDLib that the user opened the sponsored chat via the button, the name, the photo, or a mention in the sponsored message",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the sponsored message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the sponsored message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportChatSponsoredMessage",
"description": "Reports a sponsored message to Telegram moderators",
"class": "ReportChatSponsoredMessageResult",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the sponsored message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the sponsored message"
},
{
"name": "option_id",
"type": "bytes",
"description": "Option identifier chosen by the user; leave empty for the initial request"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeNotification",
"description": "Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user",
"class": "Ok",
"properties": [
{
"name": "notification_group_id",
"type": "int32",
"description": "Identifier of notification group to which the notification belongs"
},
{
"name": "notification_id",
"type": "int32",
"description": "Identifier of removed notification"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeNotificationGroup",
"description": "Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user",
"class": "Ok",
"properties": [
{
"name": "notification_group_id",
"type": "int32",
"description": "Notification group identifier"
},
{
"name": "max_notification_id",
"type": "int32",
"description": "The maximum identifier of removed notifications"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageLink",
"description": "Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request",
"class": "MessageLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "media_timestamp",
"type": "int32",
"description": "If not 0, timestamp from which the video/audio/video note/voice note/story playing must start, in seconds. The media can be in the message content or in its web page preview"
},
{
"name": "for_album",
"type": "Bool",
"description": "Pass true to create a link for the whole media album"
},
{
"name": "in_message_thread",
"type": "Bool",
"description": "Pass true to create a link to the message as a channel post comment, in a message thread, or a forum topic"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getMessageEmbeddingCode",
"description": "Returns an HTML code for embedding the message. Available only for messages in supergroups and channels with a username",
"class": "Text",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "for_album",
"type": "Bool",
"description": "Pass true to return an HTML code for embedding of the whole media album"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageLinkInfo",
"description": "Returns information about a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage",
"class": "MessageLinkInfo",
"properties": [
{
"name": "url",
"type": "string",
"description": "The message link"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "translateText",
"description": "Translates a text to the given language. If the current user is a Telegram Premium user, then text formatting is preserved",
"class": "FormattedText",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text to translate"
},
{
"name": "to_language_code",
"type": "string",
"description": "Language code of the language to which the message is translated. Must be one of \"af\", \"sq\", \"am\", \"ar\", \"hy\", \"az\", \"eu\", \"be\", \"bn\", \"bs\", \"bg\", \"ca\", \"ceb\", \"zh-CN\", \"zh\", \"zh-Hans\", \"zh-TW\", \"zh-Hant\", \"co\", \"hr\", \"cs\", \"da\", \"nl\", \"en\", \"eo\", \"et\", \"fi\", \"fr\", \"fy\", \"gl\", \"ka\", \"de\", \"el\", \"gu\", \"ht\", \"ha\", \"haw\", \"he\", \"iw\", \"hi\", \"hmn\", \"hu\", \"is\", \"ig\", \"id\", \"in\", \"ga\", \"it\", \"ja\", \"jv\", \"kn\", \"kk\", \"km\", \"rw\", \"ko\", \"ku\", \"ky\", \"lo\", \"la\", \"lv\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"mt\", \"mi\", \"mr\", \"mn\", \"my\", \"ne\", \"no\", \"ny\", \"or\", \"ps\", \"fa\", \"pl\", \"pt\", \"pa\", \"ro\", \"ru\", \"sm\", \"gd\", \"sr\", \"st\", \"sn\", \"sd\", \"si\", \"sk\", \"sl\", \"so\", \"es\", \"su\", \"sw\", \"sv\", \"tl\", \"tg\", \"ta\", \"tt\", \"te\", \"th\", \"tr\", \"tk\", \"uk\", \"ur\", \"ug\", \"uz\", \"vi\", \"cy\", \"xh\", \"yi\", \"ji\", \"yo\", \"zu\""
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "translateMessageText",
"description": "Extracts text or caption of the given message and translates it to the given language. If the current user is a Telegram Premium user, then text formatting is preserved",
"class": "FormattedText",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "to_language_code",
"type": "string",
"description": "Language code of the language to which the message is translated. Must be one of \"af\", \"sq\", \"am\", \"ar\", \"hy\", \"az\", \"eu\", \"be\", \"bn\", \"bs\", \"bg\", \"ca\", \"ceb\", \"zh-CN\", \"zh\", \"zh-Hans\", \"zh-TW\", \"zh-Hant\", \"co\", \"hr\", \"cs\", \"da\", \"nl\", \"en\", \"eo\", \"et\", \"fi\", \"fr\", \"fy\", \"gl\", \"ka\", \"de\", \"el\", \"gu\", \"ht\", \"ha\", \"haw\", \"he\", \"iw\", \"hi\", \"hmn\", \"hu\", \"is\", \"ig\", \"id\", \"in\", \"ga\", \"it\", \"ja\", \"jv\", \"kn\", \"kk\", \"km\", \"rw\", \"ko\", \"ku\", \"ky\", \"lo\", \"la\", \"lv\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"mt\", \"mi\", \"mr\", \"mn\", \"my\", \"ne\", \"no\", \"ny\", \"or\", \"ps\", \"fa\", \"pl\", \"pt\", \"pa\", \"ro\", \"ru\", \"sm\", \"gd\", \"sr\", \"st\", \"sn\", \"sd\", \"si\", \"sk\", \"sl\", \"so\", \"es\", \"su\", \"sw\", \"sv\", \"tl\", \"tg\", \"ta\", \"tt\", \"te\", \"th\", \"tr\", \"tk\", \"uk\", \"ur\", \"ug\", \"uz\", \"vi\", \"cy\", \"xh\", \"yi\", \"ji\", \"yo\", \"zu\""
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "recognizeSpeech",
"description": "Recognizes speech in a video note or a voice note message. The message must be successfully sent, must not be scheduled, and must be from a non-secret chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "rateSpeechRecognition",
"description": "Rates recognized speech in a video note or a voice note message",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "is_good",
"type": "Bool",
"description": "Pass true if the speech recognition is good"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatAvailableMessageSenders",
"description": "Returns list of message sender identifiers, which can be used to send messages in a chat",
"class": "ChatMessageSenders",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatMessageSender",
"description": "Selects a message sender to send messages in a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_sender_id",
"type": "MessageSender",
"description": "New message sender for the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendMessage",
"description": "Sends a message. Returns the sent message",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the message will be sent"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message or story to be replied; pass null if none"
},
{
"name": "options",
"type": "messageSendOptions",
"description": "Options to be used to send the message; pass null to use default options"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "Markup for replying to the message; pass null if none; for bots only"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "sendMessageAlbum",
"description": "Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be grouped into an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns sent messages",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the messages will be sent"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message or story to be replied; pass null if none"
},
{
"name": "options",
"type": "messageSendOptions",
"description": "Options to be used to send the messages; pass null to use default options"
},
{
"name": "input_message_contents",
"type": "vector\u003cInputMessageContent\u003e",
"description": "Contents of messages to be sent. At most 10 messages can be added to an album"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "sendBotStartMessage",
"description": "Invites a bot to a chat (if it is not yet a member) and sends it the /start command; requires can_invite_users member right. Bots can't be invited to a private chat other than the chat with the bot. Bots can't be invited to channels (although they can be added as admins) and secret chats. Returns the sent message",
"class": "Message",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the bot"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the target chat"
},
{
"name": "parameter",
"type": "string",
"description": "A hidden parameter sent to the bot for deep linking purposes (https://core.telegram.org/bots#deep-linking)"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendInlineQueryResultMessage",
"description": "Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the message will be sent"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message or story to be replied; pass null if none"
},
{
"name": "options",
"type": "messageSendOptions",
"description": "Options to be used to send the message; pass null to use default options"
},
{
"name": "query_id",
"type": "int64",
"description": "Identifier of the inline query"
},
{
"name": "result_id",
"type": "string",
"description": "Identifier of the inline query result"
},
{
"name": "hide_via_bot",
"type": "Bool",
"description": "Pass true to hide the bot, via which the message is sent. Can be used only for bots getOption(\"animation_search_bot_username\"), getOption(\"photo_search_bot_username\"), and getOption(\"venue_search_bot_username\")"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "forwardMessages",
"description": "Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can't be forwarded, null will be returned instead of the message",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which to forward messages"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the message will be sent; for forum threads only"
},
{
"name": "from_chat_id",
"type": "int53",
"description": "Identifier of the chat from which to forward messages"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously. A message can be forwarded only if message.can_be_forwarded"
},
{
"name": "options",
"type": "messageSendOptions",
"description": "Options to be used to send the messages; pass null to use default options"
},
{
"name": "send_copy",
"type": "Bool",
"description": "Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local"
},
{
"name": "remove_caption",
"type": "Bool",
"description": "Pass true to remove media captions of message copies. Ignored if send_copy is false"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "sendQuickReplyShortcutMessages",
"description": "Sends messages from a quick reply shortcut. Requires Telegram Business subscription",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which to send messages. The chat must be a private chat with a regular user"
},
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique identifier of the quick reply shortcut"
},
{
"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"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "resendMessages",
"description": "Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry is true and after specified in messageSendingStateFailed.retry_after time passed. If a message is re-sent, the corresponding failed to send message is deleted. Returns the sent messages in the same order as the message identifiers passed in message_ids. If a message can't be re-sent, null will be returned instead of the message",
"class": "Messages",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to send messages"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the messages to resend. Message identifiers must be in a strictly increasing order"
},
{
"name": "quote",
"type": "inputTextQuote",
"description": "New manually chosen quote from the message to be replied; pass null if none. Ignored if more than one message is re-sent, or if messageSendingStateFailed.need_another_reply_quote == false"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "addLocalMessage",
"description": "Adds a local message to a chat. The message is persistent across application restarts only if the message database is used. Returns the added message",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of the message"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message or story to be replied; pass null if none"
},
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification for the message"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be added"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteMessages",
"description": "Deletes messages",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the messages to be deleted"
},
{
"name": "revoke",
"type": "Bool",
"description": "Pass true to delete messages for all chat members. Always true for supergroups, channels and secret chats"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "deleteChatMessagesBySender",
"description": "Deletes all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator privileges",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender of messages to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChatMessagesByDate",
"description": "Deletes all messages between the specified dates in a chat. Supported only for private chats and basic groups. Messages sent in the last 30 seconds will not be deleted",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "min_date",
"type": "int32",
"description": "The minimum date of the messages to delete"
},
{
"name": "max_date",
"type": "int32",
"description": "The maximum date of the messages to delete"
},
{
"name": "revoke",
"type": "Bool",
"description": "Pass true to delete chat messages for all users; private chats only"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "editMessageText",
"description": "Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on the server side",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "New text content of the message. Must be of type inputMessageText"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editMessageLiveLocation",
"description": "Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
},
{
"name": "location",
"type": "location",
"description": "New location content of the message; pass null to stop sharing the live location"
},
{
"name": "heading",
"type": "int32",
"description": "The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown"
},
{
"name": "proximity_alert_radius",
"type": "int32",
"description": "The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editMessageMedia",
"description": "Edits the content of a message with an animation, an audio, a document, a photo or a video, including message caption. If only the caption needs to be edited, use editMessageCaption instead. The media can't be edited if the message was set to self-destruct or to a self-destructing media. The type of message content in an album can't be changed with exception of replacing a photo with a video or vice versa. Returns the edited message after the edit is completed on the server side",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editMessageCaption",
"description": "Edits the message content caption. Returns the edited message after the edit is completed on the server side",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
},
{
"name": "caption",
"type": "formattedText",
"description": "New message content caption; 0-getOption(\"message_caption_length_max\") characters; pass null to remove caption"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editMessageReplyMarkup",
"description": "Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editInlineMessageText",
"description": "Edits the text of an inline text or game message sent via a bot; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "New text content of the message. Must be of type inputMessageText"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editInlineMessageLiveLocation",
"description": "Edits the content of a live location in an inline message sent via a bot; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none"
},
{
"name": "location",
"type": "location",
"description": "New location content of the message; pass null to stop sharing the live location"
},
{
"name": "heading",
"type": "int32",
"description": "The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown"
},
{
"name": "proximity_alert_radius",
"type": "int32",
"description": "The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editInlineMessageMedia",
"description": "Edits the content of a message with an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editInlineMessageCaption",
"description": "Edits the caption of an inline message sent via a bot; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none"
},
{
"name": "caption",
"type": "formattedText",
"description": "New message content caption; pass null to remove caption; 0-getOption(\"message_caption_length_max\") characters"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editInlineMessageReplyMarkup",
"description": "Edits the reply markup of an inline message sent via a bot; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "editMessageSchedulingState",
"description": "Edits the time when a scheduled message will be sent. Scheduling state of all messages in the same album or forwarded together with the message will be also changed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat the message belongs to"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "scheduling_state",
"type": "MessageSchedulingState",
"description": "The new message scheduling state; pass null to send the message immediately"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendBusinessMessage",
"description": "Sends a message on behalf of a business account; for bots only. Returns the message after it was sent",
"class": "BusinessMessage",
"properties": [
{
"name": "business_connection_id",
"type": "string",
"description": "Unique identifier of business connection on behalf of which to send the request"
},
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message to be replied; pass null if none"
},
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification for the message"
},
{
"name": "protect_content",
"type": "Bool",
"description": "Pass true if the content of the message must be protected from forwarding and saving"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "Markup for replying to the message; pass null if none"
},
{
"name": "input_message_content",
"type": "InputMessageContent",
"description": "The content of the message to be sent"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "sendBusinessMessageAlbum",
"description": "Sends 2-10 messages grouped together into an album on behalf of a business account; for bots only. Currently, only audio, document, photo and video messages can be grouped into an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns sent messages",
"class": "BusinessMessages",
"properties": [
{
"name": "business_connection_id",
"type": "string",
"description": "Unique identifier of business connection on behalf of which to send the request"
},
{
"name": "chat_id",
"type": "int53",
"description": "Target chat"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message to be replied; pass null if none"
},
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification for the message"
},
{
"name": "protect_content",
"type": "Bool",
"description": "Pass true if the content of the message must be protected from forwarding and saving"
},
{
"name": "input_message_contents",
"type": "vector\u003cInputMessageContent\u003e",
"description": "Contents of messages to be sent. At most 10 messages can be added to an album"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "checkQuickReplyShortcutName",
"description": "Checks validness of a name for a quick reply shortcut. Can be called synchronously",
"class": "Ok",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the shortcut; 1-32 characters"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "loadQuickReplyShortcuts",
"description": "Loads quick reply shortcuts created by the current user. The loaded topics will be sent through updateQuickReplyShortcuts",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setQuickReplyShortcutName",
"description": "Changes name of a quick reply shortcut",
"class": "Ok",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique identifier of the quick reply shortcut"
},
{
"name": "name",
"type": "string",
"description": "New name for the shortcut. Use checkQuickReplyShortcutName to check its validness"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteQuickReplyShortcut",
"description": "Deletes a quick reply shortcut",
"class": "Ok",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique identifier of the quick reply shortcut"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderQuickReplyShortcuts",
"description": "Changes the order of quick reply shortcuts",
"class": "Ok",
"properties": [
{
"name": "shortcut_ids",
"type": "vector\u003cint32\u003e",
"description": "The new order of quick reply shortcuts"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "loadQuickReplyShortcutMessages",
"description": "Loads quick reply messages that can be sent by a given quick reply shortcut. The loaded messages will be sent through updateQuickReplyShortcutMessages",
"class": "Ok",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique identifier of the quick reply shortcut"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteQuickReplyShortcutMessages",
"description": "Deletes specified quick reply messages",
"class": "Ok",
"properties": [
{
"name": "shortcut_id",
"type": "int32",
"description": "Unique identifier of the quick reply shortcut to which the messages belong"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Unique identifiers of the messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getForumTopicDefaultIcons",
"description": "Returns list of custom emojis, which can be used as forum topic icon by all users",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "createForumTopic",
"description": "Creates a topic in a forum supergroup chat; requires can_manage_topics administrator or can_create_topics member right in the supergroup",
"class": "ForumTopicInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "name",
"type": "string",
"description": "Name of the topic; 1-128 characters"
},
{
"name": "icon",
"type": "forumTopicIcon",
"description": "Icon of the topic. Icon color must be one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F. Telegram Premium users can use any custom emoji as topic icon, other users can use only a custom emoji returned by getForumTopicDefaultIcons"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editForumTopic",
"description": "Edits title and icon of a topic in a forum supergroup chat; requires can_manage_topics right in the supergroup unless the user is creator of the topic",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
},
{
"name": "name",
"type": "string",
"description": "New name of the topic; 0-128 characters. If empty, the previous topic name is kept"
},
{
"name": "edit_icon_custom_emoji",
"type": "Bool",
"description": "Pass true to edit the icon of the topic. Icon of the General topic can't be edited"
},
{
"name": "icon_custom_emoji_id",
"type": "int64",
"description": "Identifier of the new custom emoji for topic icon; pass 0 to remove the custom emoji. Ignored if edit_icon_custom_emoji is false. Telegram Premium users can use any custom emoji, other users can use only a custom emoji returned by getForumTopicDefaultIcons"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getForumTopic",
"description": "Returns information about a forum topic",
"class": "ForumTopic",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getForumTopicLink",
"description": "Returns an HTTPS link to a topic in a forum chat. This is an offline request",
"class": "MessageLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getForumTopics",
"description": "Returns found forum topics in a forum chat. This is a temporary method for getting information about topic list from the server",
"class": "ForumTopics",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the forum chat"
},
{
"name": "query",
"type": "string",
"description": "Query to search for in the forum topic's name"
},
{
"name": "offset_date",
"type": "int32",
"description": "The date starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last topic"
},
{
"name": "offset_message_id",
"type": "int53",
"description": "The message identifier of the last message in the last found topic, or 0 for the first request"
},
{
"name": "offset_message_thread_id",
"type": "int53",
"description": "The message thread identifier of the last found topic, or 0 for the first request"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of forum topics to be returned; up to 100. For optimal performance, the number of returned forum topics is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setForumTopicNotificationSettings",
"description": "Changes the notification settings of a forum topic",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
},
{
"name": "notification_settings",
"type": "chatNotificationSettings",
"description": "New notification settings for the forum topic. If the topic is muted for more than 366 days, it is considered to be muted forever"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleForumTopicIsClosed",
"description": "Toggles whether a topic is closed in a forum supergroup chat; requires can_manage_topics right in the supergroup unless the user is creator of the topic",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
},
{
"name": "is_closed",
"type": "Bool",
"description": "Pass true to close the topic; pass false to reopen it"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleGeneralForumTopicIsHidden",
"description": "Toggles whether a General topic is hidden in a forum supergroup chat; requires can_manage_topics right in the supergroup",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "is_hidden",
"type": "Bool",
"description": "Pass true to hide and close the General topic; pass false to unhide it"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleForumTopicIsPinned",
"description": "Changes the pinned state of a forum topic; requires can_manage_topics right in the supergroup. There can be up to getOption(\"pinned_forum_topic_count_max\") pinned forum topics",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "Pass true to pin the topic; pass false to unpin it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPinnedForumTopics",
"description": "Changes the order of pinned forum topics; requires can_manage_topics right in the supergroup",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_ids",
"type": "vector\u003cint53\u003e",
"description": "The new list of pinned forum topics"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteForumTopic",
"description": "Deletes all messages in a forum topic; requires can_delete_messages administrator right in the supergroup unless the user is creator of the topic, the topic has no messages from other users and has at most 11 messages",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier of the forum topic"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getEmojiReaction",
"description": "Returns information about an emoji reaction. Returns a 404 error if the reaction is not found",
"class": "EmojiReaction",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "Text representation of the reaction"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getCustomEmojiReactionAnimations",
"description": "Returns TGS stickers with generic animations for custom emoji reactions",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageAvailableReactions",
"description": "Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatAvailableReactions for the chat, or updateMessageInteractionInfo for the message",
"class": "AvailableReactions",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "row_size",
"type": "int32",
"description": "Number of reaction per row, 5-25"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clearRecentReactions",
"description": "Clears the list of recently used reactions",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "addMessageReaction",
"description": "Adds a reaction or a tag to a message. Use getMessageAvailableReactions to receive the list of available reactions for the message",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Type of the reaction to add"
},
{
"name": "is_big",
"type": "Bool",
"description": "Pass true if the reaction is added with a big animation"
},
{
"name": "update_recent_reactions",
"type": "Bool",
"description": "Pass true if the reaction needs to be added to recent reactions; tags are never added to the list of recent reactions"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeMessageReaction",
"description": "Removes a reaction from a message. A chosen reaction can always be removed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Type of the reaction to remove"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setMessageReactions",
"description": "Sets reactions on a message; for bots only",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reaction_types",
"type": "vector\u003cReactionType\u003e",
"description": "Types of the reaction to set"
},
{
"name": "is_big",
"type": "Bool",
"description": "Pass true if the reactions are added with a big animation"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getMessageAddedReactions",
"description": "Returns reactions added for a message, along with their sender",
"class": "AddedReactions",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the message belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Type of the reactions to return; pass null to return all added reactions"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of reactions to be returned; must be positive and can't be greater than 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setDefaultReactionType",
"description": "Changes type of default reaction for the current user",
"class": "Ok",
"properties": [
{
"name": "reaction_type",
"type": "ReactionType",
"description": "New type of the default reaction"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedMessagesTags",
"description": "Returns tags used in Saved Messages or a Saved Messages topic",
"class": "SavedMessagesTags",
"properties": [
{
"name": "saved_messages_topic_id",
"type": "int53",
"description": "Identifier of Saved Messages topic which tags will be returned; pass 0 to get all Saved Messages tags"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setSavedMessagesTagLabel",
"description": "Changes label of a Saved Messages tag; for Telegram Premium users only",
"class": "Ok",
"properties": [
{
"name": "tag",
"type": "ReactionType",
"description": "The tag which label will be changed"
},
{
"name": "label",
"type": "string",
"description": "New label for the tag; 0-12 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchQuote",
"description": "Searches for a given quote in a text. Returns found quote start position in UTF-16 code units. Returns a 404 error if the quote is not found. Can be called synchronously",
"class": "FoundPosition",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Text in which to search for the quote"
},
{
"name": "quote",
"type": "formattedText",
"description": "Quote to search for"
},
{
"name": "quote_position",
"type": "int32",
"description": "Approximate quote position in UTF-16 code units"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getTextEntities",
"description": "Returns all entities (mentions, hashtags, cashtags, bot commands, bank card numbers, URLs, and email addresses) found in the text. Can be called synchronously",
"class": "TextEntities",
"properties": [
{
"name": "text",
"type": "string",
"description": "The text in which to look for entities"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "parseTextEntities",
"description": "Parses Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, Code, Pre, PreCode, TextUrl and MentionName entities from a marked-up text. Can be called synchronously",
"class": "FormattedText",
"properties": [
{
"name": "text",
"type": "string",
"description": "The text to parse"
},
{
"name": "parse_mode",
"type": "TextParseMode",
"description": "Text parse mode"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "parseMarkdown",
"description": "Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously",
"class": "FormattedText",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "The text to parse. For example, \"__italic__ ~~strikethrough~~ ||spoiler|| **bold** `code` ```pre``` __[italic__ text_url](telegram.org) __italic**bold italic__bold**\""
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getMarkdownText",
"description": "Replaces text entities with Markdown formatting in a human-friendly format. Entities that can't be represented in Markdown unambiguously are kept as is. Can be called synchronously",
"class": "FormattedText",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "The text"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getCountryFlagEmoji",
"description": "Returns an emoji for the given country. Returns an empty string on failure. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code as received from getCountries"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getFileMimeType",
"description": "Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "file_name",
"type": "string",
"description": "The name of the file or path to the file"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getFileExtension",
"description": "Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "mime_type",
"type": "string",
"description": "The MIME type of the file"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "cleanFileName",
"description": "Removes potentially dangerous characters from the name of a file. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "file_name",
"type": "string",
"description": "File name or path to the file"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getLanguagePackString",
"description": "Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously",
"class": "LanguagePackStringValue",
"properties": [
{
"name": "language_pack_database_path",
"type": "string",
"description": "Path to the language pack database in which strings are stored"
},
{
"name": "localization_target",
"type": "string",
"description": "Localization target to which the language pack belongs"
},
{
"name": "language_pack_id",
"type": "string",
"description": "Language pack identifier"
},
{
"name": "key",
"type": "string",
"description": "Language pack key of the string to be returned"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getJsonValue",
"description": "Converts a JSON-serialized string to corresponding JsonValue object. Can be called synchronously",
"class": "JsonValue",
"properties": [
{
"name": "json",
"type": "string",
"description": "The JSON-serialized string"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getJsonString",
"description": "Converts a JsonValue object to corresponding JSON-serialized string. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "json_value",
"type": "JsonValue",
"description": "The JsonValue object"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getThemeParametersJsonString",
"description": "Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously",
"class": "Text",
"properties": [
{
"name": "theme",
"type": "themeParameters",
"description": "Theme parameters to convert to JSON"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "setPollAnswer",
"description": "Changes the user answer to a poll. A poll in quiz mode can be answered only once",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the poll belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message containing the poll"
},
{
"name": "option_ids",
"type": "vector\u003cint32\u003e",
"description": "0-based identifiers of answer options, chosen by the user. User can choose more than 1 answer option only is the poll allows multiple answers"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPollVoters",
"description": "Returns message senders voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib",
"class": "MessageSenders",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the poll belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message containing the poll"
},
{
"name": "option_id",
"type": "int32",
"description": "0-based identifier of the answer option"
},
{
"name": "offset",
"type": "int32",
"description": "Number of voters to skip in the result; must be non-negative"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of voters to be returned; must be positive and can't be greater than 50. For optimal performance, the number of returned voters is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "stopPoll",
"description": "Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag is set",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to which the poll belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message containing the poll"
},
{
"name": "reply_markup",
"type": "ReplyMarkup",
"description": "The new message reply markup; pass null if none; for bots only"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "hideSuggestedAction",
"description": "Hides a suggested action",
"class": "Ok",
"properties": [
{
"name": "action",
"type": "SuggestedAction",
"description": "Suggested action to hide"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getBusinessConnection",
"description": "Returns information about a business connection by its identifier; for bots only",
"class": "BusinessConnection",
"properties": [
{
"name": "connection_id",
"type": "string",
"description": "Identifier of the business connection to return"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getLoginUrlInfo",
"description": "Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button",
"class": "LoginUrlInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message with the button"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier of the message with the button"
},
{
"name": "button_id",
"type": "int53",
"description": "Button identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getLoginUrl",
"description": "Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button",
"class": "HttpUrl",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message with the button"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier of the message with the button"
},
{
"name": "button_id",
"type": "int53",
"description": "Button identifier"
},
{
"name": "allow_write_access",
"type": "Bool",
"description": "Pass true to allow the bot to send messages to the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "shareUsersWithBot",
"description": "Shares users after pressing a keyboardButtonTypeRequestUsers button with the bot",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the bot"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message with the button"
},
{
"name": "button_id",
"type": "int32",
"description": "Identifier of the button"
},
{
"name": "shared_user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the shared users"
},
{
"name": "only_check",
"type": "Bool",
"description": "Pass true to check that the users can be shared by the button instead of actually sharing them"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "shareChatWithBot",
"description": "Shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the bot"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message with the button"
},
{
"name": "button_id",
"type": "int32",
"description": "Identifier of the button"
},
{
"name": "shared_chat_id",
"type": "int53",
"description": "Identifier of the shared chat"
},
{
"name": "only_check",
"type": "Bool",
"description": "Pass true to check that the chat can be shared by the button instead of actually sharing it. Doesn't check bot_is_member and bot_administrator_rights restrictions. If the bot must be a member, then all chats from getGroupsInCommon and all chats, where the user can add the bot, are suitable. In the latter case the bot will be automatically added to the chat. If the bot must be an administrator, then all chats, where the bot already has requested rights or can be added to administrators by the user, are suitable. In the latter case the bot will be automatically granted requested rights"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getInlineQueryResults",
"description": "Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires",
"class": "InlineQueryResults",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat where the query was sent"
},
{
"name": "user_location",
"type": "location",
"description": "Location of the user; pass null if unknown or the bot doesn't need user's location"
},
{
"name": "query",
"type": "string",
"description": "Text of the query"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return; use empty string to get the first chunk of results"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "answerInlineQuery",
"description": "Sets the result of an inline query; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_query_id",
"type": "int64",
"description": "Identifier of the inline query"
},
{
"name": "is_personal",
"type": "Bool",
"description": "Pass true if results may be cached and returned only for the user that sent the query. By default, results may be returned to any user who sends the same query"
},
{
"name": "button",
"type": "inlineQueryResultsButton",
"description": "Button to be shown above inline query results; pass null if none"
},
{
"name": "results",
"type": "vector\u003cInputInlineQueryResult\u003e",
"description": "The results of the query"
},
{
"name": "cache_time",
"type": "int32",
"description": "Allowed time to cache the results of the query, in seconds"
},
{
"name": "next_offset",
"type": "string",
"description": "Offset for the next inline query; pass an empty string if there are no more results"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "searchWebApp",
"description": "Returns information about a Web App by its short name. Returns a 404 error if the Web App is not found",
"class": "FoundWebApp",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "web_app_short_name",
"type": "string",
"description": "Short name of the Web App"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getWebAppLinkUrl",
"description": "Returns an HTTPS URL of a Web App to open after a link of the type internalLinkTypeWebApp is clicked",
"class": "HttpUrl",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which the link was clicked; pass 0 if none"
},
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "web_app_short_name",
"type": "string",
"description": "Short name of the Web App"
},
{
"name": "start_parameter",
"type": "string",
"description": "Start parameter from internalLinkTypeWebApp"
},
{
"name": "theme",
"type": "themeParameters",
"description": "Preferred Web App theme; pass null to use the default theme"
},
{
"name": "application_name",
"type": "string",
"description": "Short name of the application; 0-64 English letters, digits, and underscores"
},
{
"name": "allow_write_access",
"type": "Bool",
"description": "Pass true if the current user allowed the bot to send them messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getWebAppUrl",
"description": "Returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, an inlineQueryResultsButtonTypeWebApp button, or an internalLinkTypeSideMenuBot link",
"class": "HttpUrl",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "url",
"type": "string",
"description": "The URL from a keyboardButtonTypeWebApp button, inlineQueryResultsButtonTypeWebApp button, an internalLinkTypeSideMenuBot link, or an empty when the bot is opened from the side menu"
},
{
"name": "theme",
"type": "themeParameters",
"description": "Preferred Web App theme; pass null to use the default theme"
},
{
"name": "application_name",
"type": "string",
"description": "Short name of the application; 0-64 English letters, digits, and underscores"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendWebAppData",
"description": "Sends data received from a keyboardButtonTypeWebApp Web App to a bot",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "button_text",
"type": "string",
"description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App"
},
{
"name": "data",
"type": "string",
"description": "The data"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "openWebApp",
"description": "Informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once",
"class": "WebAppInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat in which the Web App is opened. The Web App can't be opened in secret chats"
},
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the bot, providing the Web App"
},
{
"name": "url",
"type": "string",
"description": "The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise"
},
{
"name": "theme",
"type": "themeParameters",
"description": "Preferred Web App theme; pass null to use the default theme"
},
{
"name": "application_name",
"type": "string",
"description": "Short name of the application; 0-64 English letters, digits, and underscores"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the message will be sent"
},
{
"name": "reply_to",
"type": "InputMessageReplyTo",
"description": "Information about the message or story to be replied in the message sent by the Web App; pass null if none"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "closeWebApp",
"description": "Informs TDLib that a previously opened Web App was closed",
"class": "Ok",
"properties": [
{
"name": "web_app_launch_id",
"type": "int64",
"description": "Identifier of Web App launch, received from openWebApp"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "answerWebAppQuery",
"description": "Sets the result of interaction with a Web App and sends corresponding message on behalf of the user to the chat from which the query originated; for bots only",
"class": "SentWebAppMessage",
"properties": [
{
"name": "web_app_query_id",
"type": "string",
"description": "Identifier of the Web App query"
},
{
"name": "result",
"type": "InputInlineQueryResult",
"description": "The result of the query"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getCallbackQueryAnswer",
"description": "Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires",
"class": "CallbackQueryAnswer",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat with the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message from which the query originated"
},
{
"name": "payload",
"type": "CallbackQueryPayload",
"description": "Query payload"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "answerCallbackQuery",
"description": "Sets the result of a callback query; for bots only",
"class": "Ok",
"properties": [
{
"name": "callback_query_id",
"type": "int64",
"description": "Identifier of the callback query"
},
{
"name": "text",
"type": "string",
"description": "Text of the answer"
},
{
"name": "show_alert",
"type": "Bool",
"description": "Pass true to show an alert to the user instead of a toast notification"
},
{
"name": "url",
"type": "string",
"description": "URL to be opened"
},
{
"name": "cache_time",
"type": "int32",
"description": "Time during which the result of the query can be cached, in seconds"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "answerShippingQuery",
"description": "Sets the result of a shipping query; for bots only",
"class": "Ok",
"properties": [
{
"name": "shipping_query_id",
"type": "int64",
"description": "Identifier of the shipping query"
},
{
"name": "shipping_options",
"type": "vector\u003cshippingOption\u003e",
"description": "Available shipping options"
},
{
"name": "error_message",
"type": "string",
"description": "An error message, empty on success"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "answerPreCheckoutQuery",
"description": "Sets the result of a pre-checkout query; for bots only",
"class": "Ok",
"properties": [
{
"name": "pre_checkout_query_id",
"type": "int64",
"description": "Identifier of the pre-checkout query"
},
{
"name": "error_message",
"type": "string",
"description": "An error message, empty on success"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setGameScore",
"description": "Updates the game score of the specified user in the game; for bots only",
"class": "Message",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat to which the message with the game belongs"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "edit_message",
"type": "Bool",
"description": "Pass true to edit the game message to include the current scoreboard"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "score",
"type": "int32",
"description": "The new score"
},
{
"name": "force",
"type": "Bool",
"description": "Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setInlineGameScore",
"description": "Updates the game score of the specified user in a game; for bots only",
"class": "Ok",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "edit_message",
"type": "Bool",
"description": "Pass true to edit the game message to include the current scoreboard"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "score",
"type": "int32",
"description": "The new score"
},
{
"name": "force",
"type": "Bool",
"description": "Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getGameHighScores",
"description": "Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots only",
"class": "GameHighScores",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "The chat that contains the message with the game"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getInlineGameHighScores",
"description": "Returns game high scores and some part of the high score table in the range of the specified user; for bots only",
"class": "GameHighScores",
"properties": [
{
"name": "inline_message_id",
"type": "string",
"description": "Inline message identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "deleteChatReplyMarkup",
"description": "Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a replyMarkupForceReply reply markup has been used. An updateChatReplyMarkup update will be sent if the reply markup is changed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "The message identifier of the used keyboard"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendChatAction",
"description": "Sends a notification about user activity in a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the action was performed"
},
{
"name": "business_connection_id",
"type": "string",
"description": "Unique identifier of business connection on behalf of which to send the request; for bots only"
},
{
"name": "action",
"type": "ChatAction",
"description": "The action description; pass null to cancel the currently active action"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "openChat",
"description": "Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (e.g., in supergroups and channels all updates are received only for opened chats)",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "closeChat",
"description": "Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "viewMessages",
"description": "Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels)",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "The identifiers of the messages being viewed"
},
{
"name": "source",
"type": "MessageSource",
"description": "Source of the message view; pass null to guess the source based on chat open state"
},
{
"name": "force_read",
"type": "Bool",
"description": "Pass true to mark as read the specified messages even the chat is closed"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "openMessageContent",
"description": "Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location or venue, or has listened to an audio file or voice note message). An updateMessageContentOpened update will be generated if something has changed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the message with the opened content"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clickAnimatedEmojiMessage",
"description": "Informs TDLib that a message with an animated emoji was clicked by the user. Returns a big animated sticker to be played or a 404 error if usual animation needs to be played",
"class": "Sticker",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the clicked message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getInternalLink",
"description": "Returns an HTTPS or a tg: link with the given type. Can be called before authorization",
"class": "HttpUrl",
"properties": [
{
"name": "type",
"type": "InternalLinkType",
"description": "Expected type of the link"
},
{
"name": "is_http",
"type": "Bool",
"description": "Pass true to create an HTTPS link (only available for some link types); pass false to create a tg: link"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getInternalLinkType",
"description": "Returns information about the type of an internal link. Returns a 404 error if the link is not internal. Can be called before authorization",
"class": "InternalLinkType",
"properties": [
{
"name": "link",
"type": "string",
"description": "The link"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getExternalLinkInfo",
"description": "Returns information about an action to be done when the current user clicks an external link. Don't use this method for links from secret chats if web page preview is disabled in secret chats",
"class": "LoginUrlInfo",
"properties": [
{
"name": "link",
"type": "string",
"description": "The link"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getExternalLink",
"description": "Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed",
"class": "HttpUrl",
"properties": [
{
"name": "link",
"type": "string",
"description": "The HTTP link"
},
{
"name": "allow_write_access",
"type": "Bool",
"description": "Pass true if the current user allowed the bot, returned in getExternalLinkInfo, to send them messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "readAllChatMentions",
"description": "Marks all mentions in a chat as read",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "readAllMessageThreadMentions",
"description": "Marks all mentions in a forum topic as read",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier in which mentions are marked as read"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "readAllChatReactions",
"description": "Marks all reactions in a chat or a forum topic as read",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "readAllMessageThreadReactions",
"description": "Marks all reactions in a forum topic as read",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier in which reactions are marked as read"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createPrivateChat",
"description": "Returns an existing chat corresponding to a given user",
"class": "Chat",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "force",
"type": "Bool",
"description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createBasicGroupChat",
"description": "Returns an existing chat corresponding to a known basic group",
"class": "Chat",
"properties": [
{
"name": "basic_group_id",
"type": "int53",
"description": "Basic group identifier"
},
{
"name": "force",
"type": "Bool",
"description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createSupergroupChat",
"description": "Returns an existing chat corresponding to a known supergroup or channel",
"class": "Chat",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup or channel identifier"
},
{
"name": "force",
"type": "Bool",
"description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createSecretChat",
"description": "Returns an existing chat corresponding to a known secret chat",
"class": "Chat",
"properties": [
{
"name": "secret_chat_id",
"type": "int32",
"description": "Secret chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createNewBasicGroupChat",
"description": "Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns the newly created chat",
"class": "Chat",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of users to be added to the basic group; may be empty to create a basic group without other members"
},
{
"name": "title",
"type": "string",
"description": "Title of the new basic group; 1-128 characters"
},
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "Message auto-delete time value, in seconds; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createNewSupergroupChat",
"description": "Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat",
"class": "Chat",
"properties": [
{
"name": "title",
"type": "string",
"description": "Title of the new chat; 1-128 characters"
},
{
"name": "is_forum",
"type": "Bool",
"description": "Pass true to create a forum supergroup chat"
},
{
"name": "is_channel",
"type": "Bool",
"description": "Pass true to create a channel chat; ignored if a forum is created"
},
{
"name": "description",
"type": "string",
"description": "Chat description; 0-255 characters"
},
{
"name": "location",
"type": "chatLocation",
"description": "Chat location if a location-based supergroup is being created; pass null to create an ordinary supergroup chat"
},
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "Message auto-delete time value, in seconds; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically"
},
{
"name": "for_import",
"type": "Bool",
"description": "Pass true to create a supergroup for importing messages using importMessages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createNewSecretChat",
"description": "Creates a new secret chat. Returns the newly created chat",
"class": "Chat",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the target user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "upgradeBasicGroupChatToSupergroupChat",
"description": "Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires owner privileges. Deactivates the original basic group",
"class": "Chat",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat to upgrade"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatListsToAddChat",
"description": "Returns chat lists to which the chat can be added. This is an offline request",
"class": "ChatLists",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addChatToList",
"description": "Adds a chat to a chat list. A chat can't be simultaneously in Main and Archive chat lists, so it is automatically removed from another one if needed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "chat_list",
"type": "ChatList",
"description": "The chat list. Use getChatListsToAddChat to get suitable chat lists"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolder",
"description": "Returns information about a chat folder by its identifier",
"class": "ChatFolder",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createChatFolder",
"description": "Creates new chat folder. Returns information about the created chat folder. There can be up to getOption(\"chat_folder_count_max\") chat folders, but the limit can be increased with Telegram Premium",
"class": "ChatFolderInfo",
"properties": [
{
"name": "folder",
"type": "chatFolder",
"description": "The new chat folder"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "editChatFolder",
"description": "Edits existing chat folder. Returns information about the edited chat folder",
"class": "ChatFolderInfo",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "folder",
"type": "chatFolder",
"description": "The edited chat folder"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChatFolder",
"description": "Deletes existing chat folder",
"class": "Ok",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "leave_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the chats to leave. The chats must be pinned or always included in the folder"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolderChatsToLeave",
"description": "Returns identifiers of pinned or always included chats from a chat folder, which are suggested to be left when the chat folder is deleted",
"class": "Chats",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolderChatCount",
"description": "Returns approximate number of chats in a being created chat folder. Main and archive chat lists must be fully preloaded for this function to work correctly",
"class": "Count",
"properties": [
{
"name": "folder",
"type": "chatFolder",
"description": "The new chat folder"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderChatFolders",
"description": "Changes the order of chat folders",
"class": "Ok",
"properties": [
{
"name": "chat_folder_ids",
"type": "vector\u003cint32\u003e",
"description": "Identifiers of chat folders in the new correct order"
},
{
"name": "main_chat_list_position",
"type": "int32",
"description": "Position of the main chat list among chat folders, 0-based. Can be non-zero only for Premium users"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatFolderTags",
"description": "Toggles whether chat folder tags are enabled",
"class": "Ok",
"properties": [
{
"name": "are_tags_enabled",
"type": "Bool",
"description": "Pass true to enable folder tags; pass false to disable them"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecommendedChatFolders",
"description": "Returns recommended chat folders for the current user",
"class": "RecommendedChatFolders",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolderDefaultIconName",
"description": "Returns default icon name for a folder. Can be called synchronously",
"class": "ChatFolderIcon",
"properties": [
{
"name": "folder",
"type": "chatFolder",
"description": "Chat folder"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getChatsForChatFolderInviteLink",
"description": "Returns identifiers of chats from a chat folder, suitable for adding to a chat folder invite link",
"class": "Chats",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createChatFolderInviteLink",
"description": "Creates a new invite link for a chat folder. A link can be created for a chat folder if it has only pinned and included chats",
"class": "ChatFolderInviteLink",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "name",
"type": "string",
"description": "Name of the link; 0-32 characters"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of chats to be accessible by the invite link. Use getChatsForChatFolderInviteLink to get suitable chats. Basic groups will be automatically converted to supergroups before link creation"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolderInviteLinks",
"description": "Returns invite links created by the current user for a shareable chat folder",
"class": "ChatFolderInviteLinks",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "editChatFolderInviteLink",
"description": "Edits an invite link for a chat folder",
"class": "ChatFolderInviteLink",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be edited"
},
{
"name": "name",
"type": "string",
"description": "New name of the link; 0-32 characters"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "New identifiers of chats to be accessible by the invite link. Use getChatsForChatFolderInviteLink to get suitable chats. Basic groups will be automatically converted to supergroups before link editing"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChatFolderInviteLink",
"description": "Deletes an invite link for a chat folder",
"class": "Ok",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be deleted"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkChatFolderInviteLink",
"description": "Checks the validity of an invite link for a chat folder and returns information about the corresponding chat folder",
"class": "ChatFolderInviteLinkInfo",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be checked"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addChatFolderByInviteLink",
"description": "Adds a chat folder by an invite link",
"class": "Ok",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Invite link for the chat folder"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the chats added to the chat folder. The chats are automatically joined if they aren't joined yet"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatFolderNewChats",
"description": "Returns new chats added to a shareable chat folder by its owner. The method must be called at most once in getOption(\"chat_folder_new_chats_update_period\") for the given chat folder",
"class": "Chats",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "processChatFolderNewChats",
"description": "Process new chats added to a shareable chat folder by its owner",
"class": "Ok",
"properties": [
{
"name": "chat_folder_id",
"type": "int32",
"description": "Chat folder identifier"
},
{
"name": "added_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the new chats, which are added to the chat folder. The chats are automatically joined if they aren't joined yet"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getArchiveChatListSettings",
"description": "Returns settings for automatic moving of chats to and from the Archive chat lists",
"class": "ArchiveChatListSettings",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setArchiveChatListSettings",
"description": "Changes settings for automatic moving of chats to and from the Archive chat lists",
"class": "Ok",
"properties": [
{
"name": "settings",
"type": "archiveChatListSettings",
"description": "New settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatTitle",
"description": "Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "title",
"type": "string",
"description": "New title of the chat; 1-128 characters"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatPhoto",
"description": "Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "photo",
"type": "InputChatPhoto",
"description": "New chat photo; pass null to delete the chat photo"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatAccentColor",
"description": "Changes accent color and background custom emoji of a channel chat. Requires can_change_info administrator right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color to use. The chat must have at least accentColor.min_channel_chat_boost_level boost level to pass the corresponding color"
},
{
"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. Use chatBoostLevelFeatures.can_set_background_custom_emoji to check whether a custom emoji can be set"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatProfileAccentColor",
"description": "Changes accent color and background custom emoji for profile of a supergroup or channel chat. Requires can_change_info administrator right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "profile_accent_color_id",
"type": "int32",
"description": "Identifier of the accent color to use for profile; pass -1 if none. The chat must have at least profileAccentColor.min_supergroup_chat_boost_level for supergroups or profileAccentColor.min_channel_chat_boost_level for channels boost level to pass the corresponding color"
},
{
"name": "profile_background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the chat's profile photo background; 0 if none. Use chatBoostLevelFeatures.can_set_profile_background_custom_emoji to check whether a custom emoji can be set"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatMessageAutoDeleteTime",
"description": "Changes the message auto-delete or self-destruct (for secret chats) time in a chat. Requires change_info administrator right in basic groups, supergroups and channels Message auto-delete time can't be changed in a chat with the current user (Saved Messages) and the chat 777000 (Telegram).",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_auto_delete_time",
"type": "int32",
"description": "New time value, in seconds; unless the chat is secret, it must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatEmojiStatus",
"description": "Changes the emoji status of a chat. Use chatBoostLevelFeatures.can_set_emoji_status to check whether an emoji status can be set. Requires can_change_info administrator right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "emoji_status",
"type": "emojiStatus",
"description": "New emoji status; pass null to remove emoji status"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatPermissions",
"description": "Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "permissions",
"type": "chatPermissions",
"description": "New non-administrator members permissions in the chat"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatBackground",
"description": "Sets the background in a specific chat. Supported only in private and secret chats with non-deleted users, and in chats with sufficient boost level and can_change_info administrator right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "background",
"type": "InputBackground",
"description": "The input background to use; pass null to create a new filled or chat theme background"
},
{
"name": "type",
"type": "BackgroundType",
"description": "Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn't supported for private and secret chats. Use chatBoostLevelFeatures.chat_theme_background_count and chatBoostLevelFeatures.can_set_custom_background to check whether the background type can be set in the boosted chat"
},
{
"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": "only_for_self",
"type": "Bool",
"description": "Pass true to set background only for self; pass false to set background for all chat users. Always false for backgrounds set in boosted chats. Background can be set for both users only by Telegram Premium users and if set background isn't of the type inputBackgroundPrevious"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteChatBackground",
"description": "Deletes background in a specific chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "restore_previous",
"type": "Bool",
"description": "Pass true to restore previously set background. Can be used only in private and secret chats with non-deleted users if userFullInfo.set_chat_background == true. Supposed to be used from messageChatSetBackground messages with the currently set background that was set for both sides by the other user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatTheme",
"description": "Changes the chat theme. Supported only in private and secret chats",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "theme_name",
"type": "string",
"description": "Name of the new chat theme; pass an empty string to return the default theme"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatDraftMessage",
"description": "Changes the draft message in a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "If not 0, the message thread identifier in which the draft was changed"
},
{
"name": "draft_message",
"type": "draftMessage",
"description": "New draft message; pass null to remove the draft. All files in draft message content must be of the type inputFileLocal. Media thumbnails and captions are ignored"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatNotificationSettings",
"description": "Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "notification_settings",
"type": "chatNotificationSettings",
"description": "New notification settings for the chat. If the chat is muted for more than 366 days, it is considered to be muted forever"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatHasProtectedContent",
"description": "Changes the ability of users to save, forward, or copy chat content. Supported only for basic groups, supergroups and channels. Requires owner privileges",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "has_protected_content",
"type": "Bool",
"description": "New value of has_protected_content"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatViewAsTopics",
"description": "Changes the view_as_topics setting of a forum chat or Saved Messages",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "view_as_topics",
"type": "Bool",
"description": "New value of view_as_topics"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatIsTranslatable",
"description": "Changes the translatable state of a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_translatable",
"type": "Bool",
"description": "New value of is_translatable"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatIsMarkedAsUnread",
"description": "Changes the marked as unread state of a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_marked_as_unread",
"type": "Bool",
"description": "New value of is_marked_as_unread"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatDefaultDisableNotification",
"description": "Changes the value of the default disable_notification parameter, used when a message is sent to a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "default_disable_notification",
"type": "Bool",
"description": "New value of default_disable_notification"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatAvailableReactions",
"description": "Changes reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "available_reactions",
"type": "ChatAvailableReactions",
"description": "Reactions available in the chat. All explicitly specified emoji reactions must be active. In channel chats up to the chat's boost level custom emoji reactions can be explicitly specified"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatClientData",
"description": "Changes application-specific data associated with a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "client_data",
"type": "string",
"description": "New value of client_data"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatDescription",
"description": "Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "description",
"type": "string",
"description": "New chat description; 0-255 characters"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setChatDiscussionGroup",
"description": "Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the channel chat. Pass 0 to remove a link from the supergroup passed in the second argument to a linked channel chat (requires can_pin_messages member right in the supergroup)"
},
{
"name": "discussion_chat_id",
"type": "int53",
"description": "Identifier of a new channel's discussion group. Use 0 to remove the discussion group. Use the method getSuitableDiscussionChats to find all suitable groups. Basic group chats must be first upgraded to supergroup chats. If new chat members don't have access to old messages in the supergroup, then toggleSupergroupIsAllHistoryAvailable must be used first to change that"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatLocation",
"description": "Changes the location of a chat. Available only for some location-based supergroups, use supergroupFullInfo.can_set_location to check whether the method is allowed to use",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "location",
"type": "chatLocation",
"description": "New location for the chat; must be valid and not null"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatSlowModeDelay",
"description": "Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members right",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "slow_mode_delay",
"type": "int32",
"description": "New slow mode delay for the chat, in seconds; must be one of 0, 10, 30, 60, 300, 900, 3600"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "pinChatMessage",
"description": "Pins a message in a chat; requires can_pin_messages member right if the chat is a basic group or supergroup, or can_edit_messages administrator right if the chat is a channel",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the new pinned message"
},
{
"name": "disable_notification",
"type": "Bool",
"description": "Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats"
},
{
"name": "only_for_self",
"type": "Bool",
"description": "Pass true to pin the message only for self; private chats only"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "unpinChatMessage",
"description": "Removes a pinned message from a chat; requires can_pin_messages member right if the chat is a basic group or supergroup, or can_edit_messages administrator right if the chat is a channel",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the removed pinned message"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "unpinAllChatMessages",
"description": "Removes all pinned messages from a chat; requires can_pin_messages member right if the chat is a basic group or supergroup, or can_edit_messages administrator right if the chat is a channel",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "unpinAllMessageThreadMessages",
"description": "Removes all pinned messages from a forum topic; requires can_pin_messages member right in the supergroup",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "message_thread_id",
"type": "int53",
"description": "Message thread identifier in which messages will be unpinned"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "joinChat",
"description": "Adds the current user as a new member to a chat. Private and secret chats can't be joined using this method. May return an error with a message \"INVITE_REQUEST_SENT\" if only a join request was created",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "leaveChat",
"description": "Removes the current user from chat members. Private and secret chats can't be left using this method",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "addChatMember",
"description": "Adds a new member to a chat; requires can_invite_users member right. Members can't be added to private or secret chats",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user"
},
{
"name": "forward_limit",
"type": "int32",
"description": "The number of earlier messages from the chat to be forwarded to the new member; up to 100. Ignored for supergroups and channels, or if the added user is a bot"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addChatMembers",
"description": "Adds multiple new members to a chat; requires can_invite_users member right. Currently, this method is only available for supergroups and channels. This method can't be used to join a chat. Members can't be added to a channel if it has more than 200 members",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of the users to be added to the chat. The maximum number of added users is 20 for supergroups and 100 for channels"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatMemberStatus",
"description": "Changes the status of a chat member; requires can_invite_users member right to add a chat member, can_promote_members administrator right to change administrator rights of the member, and can_restrict_members administrator right to change restrictions of a user. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters needs to be passed",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "member_id",
"type": "MessageSender",
"description": "Member identifier. Chats can be only banned and unbanned in supergroups and channels"
},
{
"name": "status",
"type": "ChatMemberStatus",
"description": "The new status of the member in the chat"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "banChatMember",
"description": "Bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "member_id",
"type": "MessageSender",
"description": "Member identifier"
},
{
"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. Ignored in basic groups and if a chat is banned"
},
{
"name": "revoke_messages",
"type": "Bool",
"description": "Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "canTransferOwnership",
"description": "Checks whether the current session can be used to transfer a chat ownership to another user",
"class": "CanTransferOwnershipResult",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "transferChatOwnership",
"description": "Changes the owner of a chat; requires owner privileges in the chat. Use the method canTransferOwnership to check whether the ownership can be transferred from the current session. Available only for supergroups and channel chats",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user to which transfer the ownership. The ownership can't be transferred to a bot or to a deleted user"
},
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatMember",
"description": "Returns information about a single member of a chat",
"class": "ChatMember",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "member_id",
"type": "MessageSender",
"description": "Member identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchChatMembers",
"description": "Searches for a specified query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights if the chat is a channel",
"class": "ChatMembers",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of users to be returned; up to 200"
},
{
"name": "filter",
"type": "ChatMembersFilter",
"description": "The type of users to search for; pass null to search among all chat members"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatAdministrators",
"description": "Returns a list of administrators of the chat with their custom titles",
"class": "ChatAdministrators",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "clearAllDraftMessages",
"description": "Clears message drafts in all chats",
"class": "Ok",
"properties": [
{
"name": "exclude_secret_chats",
"type": "Bool",
"description": "Pass true to keep local message drafts in secret chats"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedNotificationSound",
"description": "Returns saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with the specified identifier",
"class": "NotificationSounds",
"properties": [
{
"name": "notification_sound_id",
"type": "int64",
"description": "Identifier of the notification sound"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedNotificationSounds",
"description": "Returns list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used",
"class": "NotificationSounds",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "addSavedNotificationSound",
"description": "Adds a new notification sound to the list of saved notification sounds. The new notification sound is added to the top of the list. If it is already in the list, its position isn't changed",
"class": "NotificationSound",
"properties": [
{
"name": "sound",
"type": "InputFile",
"description": "Notification sound file to add"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeSavedNotificationSound",
"description": "Removes a notification sound from the list of saved notification sounds",
"class": "Ok",
"properties": [
{
"name": "notification_sound_id",
"type": "int64",
"description": "Identifier of the notification sound"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatNotificationSettingsExceptions",
"description": "Returns list of chats with non-default notification settings for new messages",
"class": "Chats",
"properties": [
{
"name": "scope",
"type": "NotificationSettingsScope",
"description": "If specified, only chats from the scope will be returned; pass null to return chats from all scopes"
},
{
"name": "compare_sound",
"type": "Bool",
"description": "Pass true to include in the response chats with only non-default sound"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getScopeNotificationSettings",
"description": "Returns the notification settings for chats of a given type",
"class": "ScopeNotificationSettings",
"properties": [
{
"name": "scope",
"type": "NotificationSettingsScope",
"description": "Types of chats for which to return the notification settings information"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setScopeNotificationSettings",
"description": "Changes notification settings for chats of a given type",
"class": "Ok",
"properties": [
{
"name": "scope",
"type": "NotificationSettingsScope",
"description": "Types of chats for which to change the notification settings"
},
{
"name": "notification_settings",
"type": "scopeNotificationSettings",
"description": "The new notification settings for the given scope"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resetAllNotificationSettings",
"description": "Resets all notification settings to their default values. By default, all chats are unmuted and message previews are shown",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleChatIsPinned",
"description": "Changes the pinned state of a chat. There can be up to getOption(\"pinned_chat_count_max\")/getOption(\"pinned_archived_chat_count_max\") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium",
"class": "Ok",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "Chat list in which to change the pinned state of the chat"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "Pass true to pin the chat; pass false to unpin it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPinnedChats",
"description": "Changes the order of pinned chats",
"class": "Ok",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "Chat list in which to change the order of pinned chats"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "The new list of pinned chats"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "readChatList",
"description": "Traverse all chats in a chat list and marks all messages in the chats as read",
"class": "Ok",
"properties": [
{
"name": "chat_list",
"type": "ChatList",
"description": "Chat list in which to mark all chats as read"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStory",
"description": "Returns a story",
"class": "Story",
"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": "only_local",
"type": "Bool",
"description": "Pass true to get only locally available information without sending network requests"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatsToSendStories",
"description": "Returns supergroup and channel chats in which the current user has the right to post stories. The chats must be rechecked with canSendStory before actually trying to post a story there",
"class": "Chats",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "canSendStory",
"description": "Checks whether the current user can send a story on behalf of a chat; requires can_post_stories right for supergroup and channel chats",
"class": "CanSendStoryResult",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendStory",
"description": "Sends a new story to a chat; requires can_post_stories right for supergroup and channel chats. Returns a temporary story",
"class": "Story",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat that will post the story"
},
{
"name": "content",
"type": "InputStoryContent",
"description": "Content of the story"
},
{
"name": "areas",
"type": "inputStoryAreas",
"description": "Clickable rectangle areas to be shown on the story media; pass null if none"
},
{
"name": "caption",
"type": "formattedText",
"description": "Story caption; pass null to use an empty caption; 0-getOption(\"story_caption_length_max\") characters; can have entities only if getOption(\"can_use_text_entities_in_story_caption\")"
},
{
"name": "privacy_settings",
"type": "StoryPrivacySettings",
"description": "The privacy settings for the story; ignored for stories sent to supergroup and channel chats"
},
{
"name": "active_period",
"type": "int32",
"description": "Period after which the story is moved to archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise"
},
{
"name": "from_story_full_id",
"type": "storyFullId",
"description": "Full identifier of the original story, which content was used to create the story"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "Pass true to keep the story accessible after expiration"
},
{
"name": "protect_content",
"type": "Bool",
"description": "Pass true if the content of the story must be protected from forwarding and screenshotting"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "editStory",
"description": "Changes content and caption of a story. Can be called only if story.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Identifier of the story to edit"
},
{
"name": "content",
"type": "InputStoryContent",
"description": "New content of the story; pass null to keep the current content"
},
{
"name": "areas",
"type": "inputStoryAreas",
"description": "New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can't be edited if story content isn't changed"
},
{
"name": "caption",
"type": "formattedText",
"description": "New story caption; pass null to keep the current caption"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setStoryPrivacySettings",
"description": "Changes privacy settings of a story. The method can be called only for stories posted on behalf of the current user and if story.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "story_id",
"type": "int32",
"description": "Identifier of the story"
},
{
"name": "privacy_settings",
"type": "StoryPrivacySettings",
"description": "The new privacy settigs for the story"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleStoryIsPinned",
"description": "Toggles whether a story is accessible after expiration. Can be called only if story.can_toggle_is_pinned == true",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Identifier of the story"
},
{
"name": "is_pinned",
"type": "Bool",
"description": "Pass true to make the story accessible after expiration; pass false to make it private"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteStory",
"description": "Deletes a previously sent story. Can be called only if story.can_be_deleted == true",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "Identifier of the chat that posted the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Identifier of the story to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStoryNotificationSettingsExceptions",
"description": "Returns list of chats with non-default notification settings for stories",
"class": "Chats",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "loadActiveStories",
"description": "Loads more active stories from a story list. The loaded stories will be sent through updates. Active stories are sorted by the pair (active_stories.order, active_stories.story_sender_chat_id) in descending order. Returns a 404 error if all active stories have been loaded",
"class": "Ok",
"properties": [
{
"name": "story_list",
"type": "StoryList",
"description": "The story list in which to load active stories"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setChatActiveStoriesList",
"description": "Changes story list in which stories from the chat are shown",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat that posted stories"
},
{
"name": "story_list",
"type": "StoryList",
"description": "New list for active stories posted by the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatActiveStories",
"description": "Returns the list of active stories posted by the given chat",
"class": "ChatActiveStories",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatPinnedStories",
"description": "Returns the list of pinned stories posted by the given chat. The stories are returned in a reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib",
"class": "Stories",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "from_story_id",
"type": "int32",
"description": "Identifier of the story starting from which stories must be returned; use 0 to get results from the last story"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of stories to be returned For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatArchivedStories",
"description": "Returns the list of all stories posted by the given chat; requires can_edit_stories right in the chat. The stories are returned in a reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib",
"class": "Stories",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "from_story_id",
"type": "int32",
"description": "Identifier of the story starting from which stories must be returned; use 0 to get results from the last story"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of stories to be returned For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "openStory",
"description": "Informs TDLib that a story is opened and is being viewed by the user",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the opened story"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the story"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "closeStory",
"description": "Informs TDLib that a story is closed by the user",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the story to close"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the story"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStoryAvailableReactions",
"description": "Returns reactions, which can be chosen for a story",
"class": "AvailableReactions",
"properties": [
{
"name": "row_size",
"type": "int32",
"description": "Number of reaction per row, 5-25"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setStoryReaction",
"description": "Changes chosen reaction on a story that has already been sent",
"class": "Ok",
"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": "reaction_type",
"type": "ReactionType",
"description": "Type of the reaction to set; pass null to remove the reaction. `reactionTypeCustomEmoji` reactions can be used only by Telegram Premium users"
},
{
"name": "update_recent_reactions",
"type": "Bool",
"description": "Pass true if the reaction needs to be added to recent reactions"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStoryInteractions",
"description": "Returns interactions with a story. The method can be called only for stories posted on behalf of the current user",
"class": "StoryInteractions",
"properties": [
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
},
{
"name": "query",
"type": "string",
"description": "Query to search for in names, usernames and titles; may be empty to get all relevant interactions"
},
{
"name": "only_contacts",
"type": "Bool",
"description": "Pass true to get only interactions by contacts; pass false to get all relevant interactions"
},
{
"name": "prefer_forwards",
"type": "Bool",
"description": "Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date"
},
{
"name": "prefer_with_reaction",
"type": "Bool",
"description": "Pass true to get interactions with reaction first; pass false to get interactions sorted just by interaction date. Ignored if prefer_forwards == true"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of story interactions to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatStoryInteractions",
"description": "Returns interactions with a story posted in a chat. Can be used only if story is posted on behalf of a chat and the user is an administrator in the chat",
"class": "StoryInteractions",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the story"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
},
{
"name": "reaction_type",
"type": "ReactionType",
"description": "Pass the default heart reaction or a suggested reaction type to receive only interactions with the specified reaction type; pass null to receive all interactions"
},
{
"name": "prefer_forwards",
"type": "Bool",
"description": "Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of story interactions to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportStory",
"description": "Reports a story to the Telegram moderators",
"class": "Ok",
"properties": [
{
"name": "story_sender_chat_id",
"type": "int53",
"description": "The identifier of the sender of the story to report"
},
{
"name": "story_id",
"type": "int32",
"description": "The identifier of the story to report"
},
{
"name": "reason",
"type": "ReportReason",
"description": "The reason for reporting the story"
},
{
"name": "text",
"type": "string",
"description": "Additional report details; 0-1024 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "activateStoryStealthMode",
"description": "Activates stealth mode for stories, which hides all views of stories from the current user in the last \"story_stealth_mode_past_period\" seconds and for the next \"story_stealth_mode_future_period\" seconds; for Telegram Premium users only",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getStoryPublicForwards",
"description": "Returns forwards of a story as a message to public chats and reposts by public channels. Can be used only if the story is posted on behalf of the current user or story.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib",
"class": "PublicForwards",
"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": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatBoostLevelFeatures",
"description": "Returns list of features available on the specific chat boost level; this is an offline request",
"class": "ChatBoostLevelFeatures",
"properties": [
{
"name": "is_channel",
"type": "Bool",
"description": "Pass true to get the list of features for channels; pass false to get the list of features for supergroups"
},
{
"name": "level",
"type": "int32",
"description": "Chat boost level"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatBoostFeatures",
"description": "Returns list of features available on the first 10 chat boost levels; this is an offline request",
"class": "ChatBoostFeatures",
"properties": [
{
"name": "is_channel",
"type": "Bool",
"description": "Pass true to get the list of features for channels; pass false to get the list of features for supergroups"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAvailableChatBoostSlots",
"description": "Returns the list of available chat boost slots for the current user",
"class": "ChatBoostSlots",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatBoostStatus",
"description": "Returns the current boost status for a supergroup or a channel chat",
"class": "ChatBoostStatus",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "boostChat",
"description": "Boosts a chat and returns the list of available chat boost slots for the current user after the boost",
"class": "ChatBoostSlots",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "slot_ids",
"type": "vector\u003cint32\u003e",
"description": "Identifiers of boost slots of the current user from which to apply boosts to the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatBoostLink",
"description": "Returns an HTTPS link to boost the specified supergroup or channel chat",
"class": "ChatBoostLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatBoostLinkInfo",
"description": "Returns information about a link to boost a chat. Can be called for any internal link of the type internalLinkTypeChatBoost",
"class": "ChatBoostLinkInfo",
"properties": [
{
"name": "url",
"type": "string",
"description": "The link to boost a chat"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatBoosts",
"description": "Returns list of boosts applied to a chat; requires administrator rights in the chat",
"class": "FoundChatBoosts",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "only_gift_codes",
"type": "Bool",
"description": "Pass true to receive only boosts received from gift codes and giveaways created by the chat"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of boosts to be returned; up to 100. For optimal performance, the number of returned boosts can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getUserChatBoosts",
"description": "Returns list of boosts applied to a chat by a given user; requires administrator rights in the chat; for bots only",
"class": "FoundChatBoosts",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the chat"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getAttachmentMenuBot",
"description": "Returns information about a bot that can be added to attachment or side menu",
"class": "AttachmentMenuBot",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Bot's user identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleBotIsAddedToAttachmentMenu",
"description": "Adds or removes a bot to attachment and side menu. Bot can be added to the menu, only if userTypeBot.can_be_added_to_attachment_menu == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Bot's user identifier"
},
{
"name": "is_added",
"type": "Bool",
"description": "Pass true to add the bot to attachment menu; pass false to remove the bot from attachment menu"
},
{
"name": "allow_write_access",
"type": "Bool",
"description": "Pass true if the current user allowed the bot to send them messages. Ignored if is_added is false"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getThemedEmojiStatuses",
"description": "Returns up to 8 emoji statuses, which must be shown right after the default Premium Badge in the emoji status list for self status",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecentEmojiStatuses",
"description": "Returns recent emoji statuses for self status",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDefaultEmojiStatuses",
"description": "Returns default emoji statuses for self status",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "clearRecentEmojiStatuses",
"description": "Clears the list of recently used emoji statuses for self status",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getThemedChatEmojiStatuses",
"description": "Returns up to 8 emoji statuses, which must be shown in the emoji status list for chats",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDefaultChatEmojiStatuses",
"description": "Returns default emoji statuses for chats",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDisallowedChatEmojiStatuses",
"description": "Returns the list of emoji statuses, which can't be used as chat emoji status, even they are from a sticker set with is_allowed_as_chat_emoji_status == true",
"class": "EmojiStatuses",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "downloadFile",
"description": "Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates",
"class": "File",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file to download"
},
{
"name": "priority",
"type": "int32",
"description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first"
},
{
"name": "offset",
"type": "int53",
"description": "The starting position from which the file needs to be downloaded"
},
{
"name": "limit",
"type": "int53",
"description": "Number of bytes which need to be downloaded starting from the \"offset\" position before the download will automatically be canceled; use 0 to download without a limit"
},
{
"name": "synchronous",
"type": "Bool",
"description": "Pass true to return response only after the file download has succeeded, has failed, has been canceled, or a new downloadFile request with different offset/limit parameters was sent; pass false to return file state immediately, just after the download has been started"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getFileDownloadedPrefixSize",
"description": "Returns file downloaded prefix size from a given offset, in bytes",
"class": "FileDownloadedPrefixSize",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file"
},
{
"name": "offset",
"type": "int53",
"description": "Offset from which downloaded prefix size needs to be calculated"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "cancelDownloadFile",
"description": "Stops the downloading of a file. If a file has already been downloaded, does nothing",
"class": "Ok",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of a file to stop downloading"
},
{
"name": "only_if_pending",
"type": "Bool",
"description": "Pass true to stop downloading only if it hasn't been started, i.e. request hasn't been sent to server"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getSuggestedFileName",
"description": "Returns suggested name for saving a file in a given directory",
"class": "Text",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file"
},
{
"name": "directory",
"type": "string",
"description": "Directory in which the file is supposed to be saved"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "preliminaryUploadFile",
"description": "Preliminary uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. Updates updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it is sent in a message",
"class": "File",
"properties": [
{
"name": "file",
"type": "InputFile",
"description": "File to upload"
},
{
"name": "file_type",
"type": "FileType",
"description": "File type; pass null if unknown"
},
{
"name": "priority",
"type": "int32",
"description": "Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "cancelPreliminaryUploadFile",
"description": "Stops the preliminary uploading of a file. Supported only for files uploaded by using preliminaryUploadFile. For other files the behavior is undefined",
"class": "Ok",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file to stop uploading"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "writeGeneratedFilePart",
"description": "Writes a part of a generated file. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct write to the destination file",
"class": "Ok",
"properties": [
{
"name": "generation_id",
"type": "int64",
"description": "The identifier of the generation process"
},
{
"name": "offset",
"type": "int53",
"description": "The offset from which to write the data to the file"
},
{
"name": "data",
"type": "bytes",
"description": "The data to write"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setFileGenerationProgress",
"description": "Informs TDLib on a file generation progress",
"class": "Ok",
"properties": [
{
"name": "generation_id",
"type": "int64",
"description": "The identifier of the generation process"
},
{
"name": "expected_size",
"type": "int53",
"description": "Expected size of the generated file, in bytes; 0 if unknown"
},
{
"name": "local_prefix_size",
"type": "int53",
"description": "The number of bytes already generated"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "finishFileGeneration",
"description": "Finishes the file generation",
"class": "Ok",
"properties": [
{
"name": "generation_id",
"type": "int64",
"description": "The identifier of the generation process"
},
{
"name": "error",
"type": "error",
"description": "If passed, the file generation has failed and must be terminated; pass null if the file generation succeeded"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "readFilePart",
"description": "Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct read from the file",
"class": "FilePart",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file. The file must be located in the TDLib file cache"
},
{
"name": "offset",
"type": "int53",
"description": "The offset from which to read the file"
},
{
"name": "count",
"type": "int53",
"description": "Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "deleteFile",
"description": "Deletes a file from the TDLib file cache",
"class": "Ok",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file to delete"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "addFileToDownloads",
"description": "Adds a file from a message to the list of file downloads. Download progress and completion of the download will be notified through updateFile updates. If message database is used, the list of file downloads is persistent across application restarts. The downloading is independent from download using downloadFile, i.e. it continues if downloadFile is canceled or is used to download a part of the file",
"class": "File",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the file to download"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message with the file"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "priority",
"type": "int32",
"description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleDownloadIsPaused",
"description": "Changes pause state of a file in the file download list",
"class": "Ok",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the downloaded file"
},
{
"name": "is_paused",
"type": "Bool",
"description": "Pass true if the download is paused"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleAllDownloadsArePaused",
"description": "Changes pause state of all files in the file download list",
"class": "Ok",
"properties": [
{
"name": "are_paused",
"type": "Bool",
"description": "Pass true to pause all downloads; pass false to unpause them"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "removeFileFromDownloads",
"description": "Removes a file from the file download list",
"class": "Ok",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the downloaded file"
},
{
"name": "delete_from_cache",
"type": "Bool",
"description": "Pass true to delete the file from the TDLib file cache"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "removeAllFilesFromDownloads",
"description": "Removes all files from the file download list",
"class": "Ok",
"properties": [
{
"name": "only_active",
"type": "Bool",
"description": "Pass true to remove only active downloads, including paused"
},
{
"name": "only_completed",
"type": "Bool",
"description": "Pass true to remove only completed downloads"
},
{
"name": "delete_from_cache",
"type": "Bool",
"description": "Pass true to delete the file from the TDLib file cache"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchFileDownloads",
"description": "Searches for files in the file download list or recently downloaded files from the list",
"class": "FoundFileDownloads",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for; may be empty to return all downloaded files"
},
{
"name": "only_active",
"type": "Bool",
"description": "Pass true to search only for active downloads, including paused"
},
{
"name": "only_completed",
"type": "Bool",
"description": "Pass true to search only for completed downloads"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of files to be returned"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getMessageFileType",
"description": "Returns information about a file with messages exported from another application",
"class": "MessageFileType",
"properties": [
{
"name": "message_file_head",
"type": "string",
"description": "Beginning of the message file; up to 100 first lines"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageImportConfirmationText",
"description": "Returns a confirmation text to be shown to the user before starting message import",
"class": "Text",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info member right"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "importMessages",
"description": "Imports messages exported from another app",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info member right"
},
{
"name": "message_file",
"type": "InputFile",
"description": "File with messages to import. Only inputFileLocal and inputFileGenerated are supported. The file must not be previously uploaded"
},
{
"name": "attached_files",
"type": "vector\u003cInputFile\u003e",
"description": "Files used in the imported messages. Only inputFileLocal and inputFileGenerated are supported. The files must not be previously uploaded"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "replacePrimaryChatInviteLink",
"description": "Replaces current primary invite link for a chat with a new primary invite link. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right",
"class": "ChatInviteLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createChatInviteLink",
"description": "Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat",
"class": "ChatInviteLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "name",
"type": "string",
"description": "Invite link name; 0-32 characters"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never"
},
{
"name": "member_limit",
"type": "int32",
"description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited"
},
{
"name": "creates_join_request",
"type": "Bool",
"description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editChatInviteLink",
"description": "Edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links",
"class": "ChatInviteLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be edited"
},
{
"name": "name",
"type": "string",
"description": "Invite link name; 0-32 characters"
},
{
"name": "expiration_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never"
},
{
"name": "member_limit",
"type": "int32",
"description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited"
},
{
"name": "creates_join_request",
"type": "Bool",
"description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatInviteLink",
"description": "Returns information about an invite link. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links",
"class": "ChatInviteLink",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to get"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatInviteLinkCounts",
"description": "Returns list of chat administrators with number of their invite links. Requires owner privileges in the chat",
"class": "ChatInviteLinkCounts",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatInviteLinks",
"description": "Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links",
"class": "ChatInviteLinks",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "creator_user_id",
"type": "int53",
"description": "User identifier of a chat administrator. Must be an identifier of the current user for non-owner"
},
{
"name": "is_revoked",
"type": "Bool",
"description": "Pass true if revoked links needs to be returned instead of active or expired"
},
{
"name": "offset_date",
"type": "int32",
"description": "Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning"
},
{
"name": "offset_invite_link",
"type": "string",
"description": "Invite link starting after which to return invite links; use empty string to get results from the beginning"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of invite links to return; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatInviteLinkMembers",
"description": "Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links",
"class": "ChatInviteLinkMembers",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link for which to return chat members"
},
{
"name": "offset_member",
"type": "chatInviteLinkMember",
"description": "A chat member from which to return next chat members; pass null to get results from the beginning"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of chat members to return; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "revokeChatInviteLink",
"description": "Revokes invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. If a primary link is revoked, then additionally to the revoked link returns new primary link",
"class": "ChatInviteLinks",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be revoked"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "deleteRevokedChatInviteLink",
"description": "Deletes revoked chat invite links. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link to revoke"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteAllRevokedChatInviteLinks",
"description": "Deletes all revoked chat invite links created by a given chat administrator. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "creator_user_id",
"type": "int53",
"description": "User identifier of a chat administrator, which links will be deleted. Must be an identifier of the current user for non-owner"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkChatInviteLink",
"description": "Checks the validity of an invite link for a chat and returns information about the corresponding chat",
"class": "ChatInviteLinkInfo",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Invite link to be checked"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "joinChatByInviteLink",
"description": "Uses an invite link to add the current user to the chat if possible. May return an error with a message \"INVITE_REQUEST_SENT\" if only a join request was created",
"class": "Chat",
"properties": [
{
"name": "invite_link",
"type": "string",
"description": "Invite link to use"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatJoinRequests",
"description": "Returns pending join requests in a chat",
"class": "ChatJoinRequests",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links"
},
{
"name": "query",
"type": "string",
"description": "A query to search for in the first names, last names and usernames of the users to return"
},
{
"name": "offset_request",
"type": "chatJoinRequest",
"description": "A chat join request from which to return next requests; pass null to get results from the beginning"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of requests to join the chat to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "processChatJoinRequest",
"description": "Handles a pending join request in a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user that sent the request"
},
{
"name": "approve",
"type": "Bool",
"description": "Pass true to approve the request; pass false to decline it"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "processChatJoinRequests",
"description": "Handles all pending join requests for a given link in a chat",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "invite_link",
"type": "string",
"description": "Invite link for which to process join requests. If empty, all join requests will be processed. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links"
},
{
"name": "approve",
"type": "Bool",
"description": "Pass true to approve all requests; pass false to decline them"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createCall",
"description": "Creates a new call",
"class": "CallId",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user to be called"
},
{
"name": "protocol",
"type": "callProtocol",
"description": "The call protocols supported by the application"
},
{
"name": "is_video",
"type": "Bool",
"description": "Pass true to create a video call"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "acceptCall",
"description": "Accepts an incoming call",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "protocol",
"type": "callProtocol",
"description": "The call protocols supported by the application"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendCallSignalingData",
"description": "Sends call signaling data",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "data",
"type": "bytes",
"description": "The data"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "discardCall",
"description": "Discards a call",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "is_disconnected",
"type": "Bool",
"description": "Pass true if the user was disconnected"
},
{
"name": "duration",
"type": "int32",
"description": "The call duration, in seconds"
},
{
"name": "is_video",
"type": "Bool",
"description": "Pass true if the call was a video call"
},
{
"name": "connection_id",
"type": "int64",
"description": "Identifier of the connection used during the call"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendCallRating",
"description": "Sends a call rating",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "rating",
"type": "int32",
"description": "Call rating; 1-5"
},
{
"name": "comment",
"type": "string",
"description": "An optional user comment if the rating is less than 5"
},
{
"name": "problems",
"type": "vector\u003cCallProblem\u003e",
"description": "List of the exact types of problems with the call, specified by the user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendCallDebugInformation",
"description": "Sends debug information for a call to Telegram servers",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "debug_information",
"type": "string",
"description": "Debug information in application-specific format"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendCallLog",
"description": "Sends log file for a call to Telegram servers",
"class": "Ok",
"properties": [
{
"name": "call_id",
"type": "int32",
"description": "Call identifier"
},
{
"name": "log_file",
"type": "InputFile",
"description": "Call log file. Only inputFileLocal and inputFileGenerated are supported"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getVideoChatAvailableParticipants",
"description": "Returns list of participant identifiers, on whose behalf a video chat in the chat can be joined",
"class": "MessageSenders",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setVideoChatDefaultParticipant",
"description": "Changes default participant identifier, on whose behalf a video chat in the chat will be joined",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "default_participant_id",
"type": "MessageSender",
"description": "Default group call participant identifier to join the video chats"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "createVideoChat",
"description": "Creates a video chat (a group call bound to a chat). Available only for basic groups, supergroups and channels; requires can_manage_video_chats administrator right",
"class": "GroupCallId",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat in which the video chat will be created"
},
{
"name": "title",
"type": "string",
"description": "Group call title; if empty, chat title will be used"
},
{
"name": "start_date",
"type": "int32",
"description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 to start the video chat immediately. The date must be at least 10 seconds and at most 8 days in the future"
},
{
"name": "is_rtmp_stream",
"type": "Bool",
"description": "Pass true to create an RTMP stream instead of an ordinary video chat; requires owner privileges"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getVideoChatRtmpUrl",
"description": "Returns RTMP URL for streaming to the chat; requires owner privileges",
"class": "RtmpUrl",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "replaceVideoChatRtmpUrl",
"description": "Replaces the current RTMP URL for streaming to the chat; requires owner privileges",
"class": "RtmpUrl",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getGroupCall",
"description": "Returns information about a group call",
"class": "GroupCall",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "startScheduledGroupCall",
"description": "Starts a scheduled group call",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallEnabledStartNotification",
"description": "Toggles whether the current user will receive a notification when the group call starts; scheduled group calls only",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "enabled_start_notification",
"type": "Bool",
"description": "New value of the enabled_start_notification setting"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "joinGroupCall",
"description": "Joins an active group call. Returns join response payload for tgcalls",
"class": "Text",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "participant_id",
"type": "MessageSender",
"description": "Identifier of a group call participant, which will be used to join the call; pass null to join as self; video chats only"
},
{
"name": "audio_source_id",
"type": "int32",
"description": "Caller audio channel synchronization source identifier; received from tgcalls"
},
{
"name": "payload",
"type": "string",
"description": "Group call join payload; received from tgcalls"
},
{
"name": "is_muted",
"type": "Bool",
"description": "Pass true to join the call with muted microphone"
},
{
"name": "is_my_video_enabled",
"type": "Bool",
"description": "Pass true if the user's video is enabled"
},
{
"name": "invite_hash",
"type": "string",
"description": "If non-empty, invite hash to be used to join the group call without being muted by administrators"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "startGroupCallScreenSharing",
"description": "Starts screen sharing in a joined group call. Returns join response payload for tgcalls",
"class": "Text",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "audio_source_id",
"type": "int32",
"description": "Screen sharing audio channel synchronization source identifier; received from tgcalls"
},
{
"name": "payload",
"type": "string",
"description": "Group call join payload; received from tgcalls"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallScreenSharingIsPaused",
"description": "Pauses or unpauses screen sharing in a joined group call",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "is_paused",
"type": "Bool",
"description": "Pass true to pause screen sharing; pass false to unpause it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "endGroupCallScreenSharing",
"description": "Ends screen sharing in a joined group call",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setGroupCallTitle",
"description": "Sets group call title. Requires groupCall.can_be_managed group call flag",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "title",
"type": "string",
"description": "New group call title; 1-64 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallMuteNewParticipants",
"description": "Toggles whether new participants of a group call can be unmuted only by administrators of the group call. Requires groupCall.can_toggle_mute_new_participants group call flag",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "mute_new_participants",
"type": "Bool",
"description": "New value of the mute_new_participants setting"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "inviteGroupCallParticipants",
"description": "Invites users to an active group call. Sends a service message of type messageInviteVideoChatParticipants for video chats",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers. At most 10 users can be invited simultaneously"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getGroupCallInviteLink",
"description": "Returns invite link to a video chat in a public chat",
"class": "HttpUrl",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "can_self_unmute",
"type": "Bool",
"description": "Pass true if the invite link needs to contain an invite hash, passing which to joinGroupCall would allow the invited user to unmute themselves. Requires groupCall.can_be_managed group call flag"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "revokeGroupCallInviteLink",
"description": "Revokes invite link for a group call. Requires groupCall.can_be_managed group call flag",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "startGroupCallRecording",
"description": "Starts recording of an active group call. Requires groupCall.can_be_managed group call flag",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "title",
"type": "string",
"description": "Group call recording title; 0-64 characters"
},
{
"name": "record_video",
"type": "Bool",
"description": "Pass true to record a video file instead of an audio file"
},
{
"name": "use_portrait_orientation",
"type": "Bool",
"description": "Pass true to use portrait orientation for video instead of landscape one"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "endGroupCallRecording",
"description": "Ends recording of an active group call. Requires groupCall.can_be_managed group call flag",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallIsMyVideoPaused",
"description": "Toggles whether current user's video is paused",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "is_my_video_paused",
"type": "Bool",
"description": "Pass true if the current user's video is paused"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallIsMyVideoEnabled",
"description": "Toggles whether current user's video is enabled",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "is_my_video_enabled",
"type": "Bool",
"description": "Pass true if the current user's video is enabled"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setGroupCallParticipantIsSpeaking",
"description": "Informs TDLib that speaking state of a participant of an active group has changed",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "audio_source",
"type": "int32",
"description": "Group call participant's synchronization audio source identifier, or 0 for the current user"
},
{
"name": "is_speaking",
"type": "Bool",
"description": "Pass true if the user is speaking"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallParticipantIsMuted",
"description": "Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "participant_id",
"type": "MessageSender",
"description": "Participant identifier"
},
{
"name": "is_muted",
"type": "Bool",
"description": "Pass true to mute the user; pass false to unmute them"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setGroupCallParticipantVolumeLevel",
"description": "Changes volume level of a participant of an active group call. If the current user can manage the group call, then the participant's volume level will be changed for all users with the default volume level",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "participant_id",
"type": "MessageSender",
"description": "Participant identifier"
},
{
"name": "volume_level",
"type": "int32",
"description": "New participant's volume level; 1-20000 in hundreds of percents"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleGroupCallParticipantIsHandRaised",
"description": "Toggles whether a group call participant hand is rased",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "participant_id",
"type": "MessageSender",
"description": "Participant identifier"
},
{
"name": "is_hand_raised",
"type": "Bool",
"description": "Pass true if the user's hand needs to be raised. Only self hand can be raised. Requires groupCall.can_be_managed group call flag to lower other's hand"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "loadGroupCallParticipants",
"description": "Loads more participants of a group call. The loaded participants will be received through updates. Use the field groupCall.loaded_all_participants to check whether all participants have already been loaded",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier. The group call must be previously received through getGroupCall and must be joined or being joined"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of participants to load; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "leaveGroupCall",
"description": "Leaves a group call",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "endGroupCall",
"description": "Ends a group call. Requires groupCall.can_be_managed",
"class": "Ok",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getGroupCallStreams",
"description": "Returns information about available group call streams",
"class": "GroupCallStreams",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getGroupCallStreamSegment",
"description": "Returns a file with a segment of a group call stream in a modified OGG format for audio or MPEG-4 format for video",
"class": "FilePart",
"properties": [
{
"name": "group_call_id",
"type": "int32",
"description": "Group call identifier"
},
{
"name": "time_offset",
"type": "int53",
"description": "Point in time when the stream segment begins; Unix timestamp in milliseconds"
},
{
"name": "scale",
"type": "int32",
"description": "Segment duration scale; 0-1. Segment's duration is 1000/(2**scale) milliseconds"
},
{
"name": "channel_id",
"type": "int32",
"description": "Identifier of an audio/video channel to get as received from tgcalls"
},
{
"name": "video_quality",
"type": "GroupCallVideoQuality",
"description": "Video quality as received from tgcalls; pass null to get the worst available quality"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setMessageSenderBlockList",
"description": "Changes the block list of a message sender. Currently, only users and supergroup chats can be blocked",
"class": "Ok",
"properties": [
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of a message sender to block/unblock"
},
{
"name": "block_list",
"type": "BlockList",
"description": "New block list for the message sender; pass null to unblock the message sender"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "blockMessageSenderFromReplies",
"description": "Blocks an original sender of a message in the Replies chat",
"class": "Ok",
"properties": [
{
"name": "message_id",
"type": "int53",
"description": "The identifier of an incoming message in the Replies chat"
},
{
"name": "delete_message",
"type": "Bool",
"description": "Pass true to delete the message"
},
{
"name": "delete_all_messages",
"type": "Bool",
"description": "Pass true to delete all messages from the same sender"
},
{
"name": "report_spam",
"type": "Bool",
"description": "Pass true to report the sender to the Telegram moderators"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getBlockedMessageSenders",
"description": "Returns users and chats that were blocked by the current user",
"class": "MessageSenders",
"properties": [
{
"name": "block_list",
"type": "BlockList",
"description": "Block list from which to return users"
},
{
"name": "offset",
"type": "int32",
"description": "Number of users and chats to skip in the result; must be non-negative"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of users and chats to return; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addContact",
"description": "Adds a user to the contact list or edits an existing contact by their user identifier",
"class": "Ok",
"properties": [
{
"name": "contact",
"type": "contact",
"description": "The contact to add or edit; phone number may be empty and needs to be specified only if known, vCard is ignored"
},
{
"name": "share_phone_number",
"type": "Bool",
"description": "Pass true to share the current user's phone number with the new contact. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed. Use the field userFullInfo.need_phone_number_privacy_exception to check whether the current user needs to be asked to share their phone number"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "importContacts",
"description": "Adds new contacts or edits existing contacts by their phone numbers; contacts' user identifiers are ignored",
"class": "ImportedContacts",
"properties": [
{
"name": "contacts",
"type": "vector\u003ccontact\u003e",
"description": "The list of contacts to import or edit; contacts' vCard are ignored and are not imported"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getContacts",
"description": "Returns all contacts of the user",
"class": "Users",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "searchContacts",
"description": "Searches for the specified query in the first names, last names and usernames of the known user contacts",
"class": "Users",
"properties": [
{
"name": "query",
"type": "string",
"description": "Query to search for; may be empty to return all contacts"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of users to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeContacts",
"description": "Removes users from the contact list",
"class": "Ok",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of users to be deleted"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getImportedContactCount",
"description": "Returns the total number of imported contacts",
"class": "Count",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "changeImportedContacts",
"description": "Changes imported contacts using the list of contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time",
"class": "ImportedContacts",
"properties": [
{
"name": "contacts",
"type": "vector\u003ccontact\u003e",
"description": "The new list of contacts, contact's vCard are ignored and are not imported"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clearImportedContacts",
"description": "Clears all imported contacts, contact list remains unchanged",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setCloseFriends",
"description": "Changes the list of close friends of the current user",
"class": "Ok",
"properties": [
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers of close friends; the users must be contacts of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getCloseFriends",
"description": "Returns all close friends of the current user",
"class": "Users",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setUserPersonalProfilePhoto",
"description": "Changes a personal profile photo of a contact user",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "photo",
"type": "InputChatPhoto",
"description": "Profile photo to set; pass null to delete the photo; inputChatPhotoPrevious isn't supported in this function"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "suggestUserProfilePhoto",
"description": "Suggests a profile photo to another regular user with common messages",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "photo",
"type": "InputChatPhoto",
"description": "Profile photo to suggest; inputChatPhotoPrevious isn't supported in this function"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchUserByPhoneNumber",
"description": "Searches a user by their phone number. Returns a 404 error if the user can't be found",
"class": "User",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "Phone number to search for"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sharePhoneNumber",
"description": "Shares the phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user with whom to share the phone number. The user must be a mutual contact"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getUserProfilePhotos",
"description": "Returns the profile photos of a user. Personal and public photo aren't returned",
"class": "ChatPhotos",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "offset",
"type": "int32",
"description": "The number of photos to skip; must be non-negative"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of photos to be returned; up to 100"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getStickers",
"description": "Returns stickers from the installed sticker sets that correspond to any of the given emoji or can be found by sticker-specific keywords. If the query is non-empty, then favorite, recently used or trending stickers may also be returned",
"class": "Stickers",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers to return"
},
{
"name": "query",
"type": "string",
"description": "Search query; a space-separated list of emoji or a keyword prefix. If empty, returns all known installed stickers"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of stickers to be returned"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier for which to return stickers. Available custom emoji stickers may be different for different chats"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAllStickerEmojis",
"description": "Returns unique emoji that correspond to stickers to be found by the getStickers(sticker_type, query, 1000000, chat_id)",
"class": "Emojis",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers to search for"
},
{
"name": "query",
"type": "string",
"description": "Search query"
},
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier for which to find stickers"
},
{
"name": "return_only_main_emoji",
"type": "Bool",
"description": "Pass true if only main emoji for each found sticker must be included in the result"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchStickers",
"description": "Searches for stickers from public sticker sets that correspond to any of the given emoji",
"class": "Stickers",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers to return"
},
{
"name": "emojis",
"type": "string",
"description": "Space-separated list of emoji to search for; must be non-empty"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of stickers to be returned; 0-100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumStickers",
"description": "Returns premium stickers from regular sticker sets",
"class": "Stickers",
"properties": [
{
"name": "limit",
"type": "int32",
"description": "The maximum number of stickers to be returned; 0-100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getInstalledStickerSets",
"description": "Returns a list of installed sticker sets",
"class": "StickerSets",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to return"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getArchivedStickerSets",
"description": "Returns a list of archived sticker sets",
"class": "StickerSets",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to return"
},
{
"name": "offset_sticker_set_id",
"type": "int64",
"description": "Identifier of the sticker set from which to return the result; use 0 to get results from the beginning"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of sticker sets to return; up to 100"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getTrendingStickerSets",
"description": "Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib",
"class": "TrendingStickerSets",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to return"
},
{
"name": "offset",
"type": "int32",
"description": "The offset from which to return the sticker sets; must be non-negative"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of sticker sets to be returned; up to 100. For optimal performance, the number of returned sticker sets is chosen by TDLib and can be smaller than the specified limit, even if the end of the list has not been reached"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAttachedStickerSets",
"description": "Returns a list of sticker sets attached to a file, including regular, mask, and emoji sticker sets. Currently, only animations, photos, and videos can have attached sticker sets",
"class": "StickerSets",
"properties": [
{
"name": "file_id",
"type": "int32",
"description": "File identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStickerSet",
"description": "Returns information about a sticker set by its identifier",
"class": "StickerSet",
"properties": [
{
"name": "set_id",
"type": "int64",
"description": "Identifier of the sticker set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchStickerSet",
"description": "Searches for a sticker set by its name",
"class": "StickerSet",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name of the sticker set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchInstalledStickerSets",
"description": "Searches for installed sticker sets by looking for specified query in their title and name",
"class": "StickerSets",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to search for"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of sticker sets to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "searchStickerSets",
"description": "Searches for sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results",
"class": "StickerSets",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to return"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "changeStickerSet",
"description": "Installs/uninstalls or activates/archives a sticker set",
"class": "Ok",
"properties": [
{
"name": "set_id",
"type": "int64",
"description": "Identifier of the sticker set"
},
{
"name": "is_installed",
"type": "Bool",
"description": "The new value of is_installed"
},
{
"name": "is_archived",
"type": "Bool",
"description": "The new value of is_archived. A sticker set can't be installed and archived simultaneously"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "viewTrendingStickerSets",
"description": "Informs the server that some trending sticker sets have been viewed by the user",
"class": "Ok",
"properties": [
{
"name": "sticker_set_ids",
"type": "vector\u003cint64\u003e",
"description": "Identifiers of viewed trending sticker sets"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderInstalledStickerSets",
"description": "Changes the order of installed sticker sets",
"class": "Ok",
"properties": [
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the sticker sets to reorder"
},
{
"name": "sticker_set_ids",
"type": "vector\u003cint64\u003e",
"description": "Identifiers of installed sticker sets in the new correct order"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecentStickers",
"description": "Returns a list of recently used stickers",
"class": "Stickers",
"properties": [
{
"name": "is_attached",
"type": "Bool",
"description": "Pass true to return stickers and masks that were recently attached to photos or video files; pass false to return recently sent stickers"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addRecentSticker",
"description": "Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set or in WEBP or WEBM format can be added to this list. Emoji stickers can't be added to recent stickers",
"class": "Stickers",
"properties": [
{
"name": "is_attached",
"type": "Bool",
"description": "Pass true to add the sticker to the list of stickers recently attached to photo or video files; pass false to add the sticker to the list of recently sent stickers"
},
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker file to add"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeRecentSticker",
"description": "Removes a sticker from the list of recently used stickers",
"class": "Ok",
"properties": [
{
"name": "is_attached",
"type": "Bool",
"description": "Pass true to remove the sticker from the list of stickers recently attached to photo or video files; pass false to remove the sticker from the list of recently sent stickers"
},
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker file to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clearRecentStickers",
"description": "Clears the list of recently used stickers",
"class": "Ok",
"properties": [
{
"name": "is_attached",
"type": "Bool",
"description": "Pass true to clear the list of stickers recently attached to photo or video files; pass false to clear the list of recently sent stickers"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getFavoriteStickers",
"description": "Returns favorite stickers",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "addFavoriteSticker",
"description": "Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set or in WEBP or WEBM format can be added to this list. Emoji stickers can't be added to favorite stickers",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker file to add"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeFavoriteSticker",
"description": "Removes a sticker from the list of favorite stickers",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker file to delete from the list"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStickerEmojis",
"description": "Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object",
"class": "Emojis",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker file identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchEmojis",
"description": "Searches for emojis by keywords. Supported only if the file database is enabled. Order of results is unspecified",
"class": "EmojiKeywords",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text to search for"
},
{
"name": "input_language_codes",
"type": "vector\u003cstring\u003e",
"description": "List of possible IETF language tags of the user's input language; may be empty if unknown"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getKeywordEmojis",
"description": "Return emojis matching the keyword. Supported only if the file database is enabled. Order of results is unspecified",
"class": "Emojis",
"properties": [
{
"name": "text",
"type": "string",
"description": "Text to search for"
},
{
"name": "input_language_codes",
"type": "vector\u003cstring\u003e",
"description": "List of possible IETF language tags of the user's input language; may be empty if unknown"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getEmojiCategories",
"description": "Returns available emojis categories",
"class": "EmojiCategories",
"properties": [
{
"name": "type",
"type": "EmojiCategoryType",
"description": "Type of emoji categories to return; pass null to get default emoji categories"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAnimatedEmoji",
"description": "Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji",
"class": "AnimatedEmoji",
"properties": [
{
"name": "emoji",
"type": "string",
"description": "The emoji"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getEmojiSuggestionsUrl",
"description": "Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation",
"class": "HttpUrl",
"properties": [
{
"name": "language_code",
"type": "string",
"description": "Language code for which the emoji replacements will be suggested"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getCustomEmojiStickers",
"description": "Returns list of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found stickers are returned",
"class": "Stickers",
"properties": [
{
"name": "custom_emoji_ids",
"type": "vector\u003cint64\u003e",
"description": "Identifiers of custom emoji stickers. At most 200 custom emoji stickers can be received simultaneously"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getDefaultChatPhotoCustomEmojiStickers",
"description": "Returns default list of custom emoji stickers for placing on a chat photo",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDefaultProfilePhotoCustomEmojiStickers",
"description": "Returns default list of custom emoji stickers for placing on a profile photo",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDefaultBackgroundCustomEmojiStickers",
"description": "Returns default list of custom emoji stickers for reply background",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedAnimations",
"description": "Returns saved animations",
"class": "Animations",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "addSavedAnimation",
"description": "Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the list. If the animation was already in the list, it is removed first. Only non-secret video animations with MIME type \"video/mp4\" can be added to the list",
"class": "Ok",
"properties": [
{
"name": "animation",
"type": "InputFile",
"description": "The animation file to be added. Only animations known to the server (i.e., successfully sent via a message) can be added to the list"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeSavedAnimation",
"description": "Removes an animation from the list of saved animations",
"class": "Ok",
"properties": [
{
"name": "animation",
"type": "InputFile",
"description": "Animation file to be removed"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getRecentInlineBots",
"description": "Returns up to 20 recently used inline bots in the order of their last usage",
"class": "Users",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "searchHashtags",
"description": "Searches for recently used hashtags by their prefix",
"class": "Hashtags",
"properties": [
{
"name": "prefix",
"type": "string",
"description": "Hashtag prefix to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of hashtags to be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeRecentHashtag",
"description": "Removes a hashtag from the list of recently used hashtags",
"class": "Ok",
"properties": [
{
"name": "hashtag",
"type": "string",
"description": "Hashtag to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getWebPagePreview",
"description": "Returns a link preview by the text of a message. Do not call this function too often. Returns a 404 error if the text has no link preview",
"class": "WebPage",
"properties": [
{
"name": "text",
"type": "formattedText",
"description": "Message text with formatting"
},
{
"name": "link_preview_options",
"type": "linkPreviewOptions",
"description": "Options to be used for generation of the link preview; pass null to use default link preview options"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getWebPageInstantView",
"description": "Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page",
"class": "WebPageInstantView",
"properties": [
{
"name": "url",
"type": "string",
"description": "The web page URL"
},
{
"name": "force_full",
"type": "Bool",
"description": "Pass true to get full instant view for the web page"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setProfilePhoto",
"description": "Changes a profile photo for the current user",
"class": "Ok",
"properties": [
{
"name": "photo",
"type": "InputChatPhoto",
"description": "Profile photo to set"
},
{
"name": "is_public",
"type": "Bool",
"description": "Pass true to set a public photo, which will be visible even the main photo is hidden by privacy settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteProfilePhoto",
"description": "Deletes a profile photo",
"class": "Ok",
"properties": [
{
"name": "profile_photo_id",
"type": "int64",
"description": "Identifier of the profile photo to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setAccentColor",
"description": "Changes accent color and background custom emoji for the current user; for Telegram Premium users only",
"class": "Ok",
"properties": [
{
"name": "accent_color_id",
"type": "int32",
"description": "Identifier of the accent color to use"
},
{
"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"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setProfileAccentColor",
"description": "Changes accent color and background custom emoji for profile of the current user; for Telegram Premium users only",
"class": "Ok",
"properties": [
{
"name": "profile_accent_color_id",
"type": "int32",
"description": "Identifier of the accent color to use for profile; pass -1 if none"
},
{
"name": "profile_background_custom_emoji_id",
"type": "int64",
"description": "Identifier of a custom emoji to be shown on the user's profile photo background; 0 if none"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setName",
"description": "Changes the first and last name of the current user",
"class": "Ok",
"properties": [
{
"name": "first_name",
"type": "string",
"description": "The new value of the first name for the current user; 1-64 characters"
},
{
"name": "last_name",
"type": "string",
"description": "The new value of the optional last name for the current user; 0-64 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBio",
"description": "Changes the bio of the current user",
"class": "Ok",
"properties": [
{
"name": "bio",
"type": "string",
"description": "The new value of the user bio; 0-getOption(\"bio_length_max\") characters without line feeds"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setUsername",
"description": "Changes the editable username of the current user",
"class": "Ok",
"properties": [
{
"name": "username",
"type": "string",
"description": "The new value of the username. Use an empty string to remove the username. The username can't be completely removed if there is another active or disabled username"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleUsernameIsActive",
"description": "Changes active state for a username of the current user. The editable username can't be disabled. May return an error with a message \"USERNAMES_ACTIVE_TOO_MUCH\" if the maximum number of active usernames has been reached",
"class": "Ok",
"properties": [
{
"name": "username",
"type": "string",
"description": "The username to change"
},
{
"name": "is_active",
"type": "Bool",
"description": "Pass true to activate the username; pass false to disable it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderActiveUsernames",
"description": "Changes order of active usernames of the current user",
"class": "Ok",
"properties": [
{
"name": "usernames",
"type": "vector\u003cstring\u003e",
"description": "The new order of active usernames. All currently active usernames must be specified"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBirthdate",
"description": "Changes the birthdate of the current user",
"class": "Ok",
"properties": [
{
"name": "birthdate",
"type": "birthdate",
"description": "The new value of the current user's birthdate; pass null to remove the birthdate"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPersonalChat",
"description": "Changes the personal chat of the current user",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the new personal chat; pass 0 to remove the chat. Use getSuitablePersonalChats to get suitable chats"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setEmojiStatus",
"description": "Changes the emoji status of the current user; for Telegram Premium users only",
"class": "Ok",
"properties": [
{
"name": "emoji_status",
"type": "emojiStatus",
"description": "New emoji status; pass null to switch to the default badge"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setLocation",
"description": "Changes the location of the current user. Needs to be called if getOption(\"is_location_visible\") is true and location changes for more than 1 kilometer. Must not be called if the user has a business location",
"class": "Ok",
"properties": [
{
"name": "location",
"type": "location",
"description": "The new location of the user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessLocation",
"description": "Changes the business location of the current user. Requires Telegram Business subscription",
"class": "Ok",
"properties": [
{
"name": "location",
"type": "businessLocation",
"description": "The new location of the business; pass null to remove the location"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessOpeningHours",
"description": "Changes the business opening hours of the current user. Requires Telegram Business subscription",
"class": "Ok",
"properties": [
{
"name": "opening_hours",
"type": "businessOpeningHours",
"description": "The new opening hours of the business; pass null to remove the opening hours; up to 28 time intervals can be specified"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessGreetingMessageSettings",
"description": "Changes the business greeting message settings of the current user. Requires Telegram Business subscription",
"class": "Ok",
"properties": [
{
"name": "greeting_message_settings",
"type": "businessGreetingMessageSettings",
"description": "The new settings for the greeting message of the business; pass null to disable the greeting message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessAwayMessageSettings",
"description": "Changes the business away message settings of the current user. Requires Telegram Business subscription",
"class": "Ok",
"properties": [
{
"name": "away_message_settings",
"type": "businessAwayMessageSettings",
"description": "The new settings for the away message of the business; pass null to disable the away message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessIntro",
"description": "Changes the business intro of the current user. Requires Telegram Business subscription",
"class": "Ok",
"properties": [
{
"name": "intro",
"type": "inputBusinessIntro",
"description": "The new intro of the business; pass null to remove the intro"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "changePhoneNumber",
"description": "Changes the phone number of the user and sends an authentication code to the user's new phone number; for official Android and iOS applications only. On success, returns information about the sent code",
"class": "AuthenticationCodeInfo",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "The new phone number of the user in international format"
},
{
"name": "settings",
"type": "phoneNumberAuthenticationSettings",
"description": "Settings for the authentication of the user's phone number; pass null to use default settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendChangePhoneNumberCode",
"description": "Resends the authentication code sent to confirm a new phone number for the current user. Works only if the previously received authenticationCodeInfo next_code_type was not null and the server-specified timeout has passed",
"class": "AuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkChangePhoneNumberCode",
"description": "Checks the authentication code sent to confirm a new phone number of the user",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "Authentication code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getBusinessConnectedBot",
"description": "Returns the business bot that is connected to the current user account. Returns a 404 error if there is no connected bot",
"class": "BusinessConnectedBot",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setBusinessConnectedBot",
"description": "Adds or changes business bot that is connected to the current user account",
"class": "Ok",
"properties": [
{
"name": "bot",
"type": "businessConnectedBot",
"description": "Connection settings for the bot"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteBusinessConnectedBot",
"description": "Deletes the business bot that is connected to the current user account",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Unique user identifier for the bot"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getUserLink",
"description": "Returns an HTTPS link, which can be used to get information about the current user",
"class": "UserLink",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "searchUserByToken",
"description": "Searches a user by a token from the user's link",
"class": "User",
"properties": [
{
"name": "token",
"type": "string",
"description": "Token to search for"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setCommands",
"description": "Sets the list of commands supported by the bot for the given user scope and language; for bots only",
"class": "Ok",
"properties": [
{
"name": "scope",
"type": "BotCommandScope",
"description": "The scope to which the commands are relevant; pass null to change commands in the default bot command scope"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code. If empty, the commands will be applied to all users from the given scope, for which language there are no dedicated commands"
},
{
"name": "commands",
"type": "vector\u003cbotCommand\u003e",
"description": "List of the bot's commands"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "deleteCommands",
"description": "Deletes commands supported by the bot for the given user scope and language; for bots only",
"class": "Ok",
"properties": [
{
"name": "scope",
"type": "BotCommandScope",
"description": "The scope to which the commands are relevant; pass null to delete commands in the default bot command scope"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code or an empty string"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getCommands",
"description": "Returns list of commands supported by the bot for the given user scope and language; for bots only",
"class": "BotCommands",
"properties": [
{
"name": "scope",
"type": "BotCommandScope",
"description": "The scope to which the commands are relevant; pass null to get commands in the default bot command scope"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code or an empty string"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setMenuButton",
"description": "Sets menu button for the given user or for all users; for bots only",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user or 0 to set menu button for all users"
},
{
"name": "menu_button",
"type": "botMenuButton",
"description": "New menu button"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getMenuButton",
"description": "Returns menu button set by the bot for the given user; for bots only",
"class": "BotMenuButton",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the user or 0 to get the default menu button"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setDefaultGroupAdministratorRights",
"description": "Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only",
"class": "Ok",
"properties": [
{
"name": "default_group_administrator_rights",
"type": "chatAdministratorRights",
"description": "Default administrator rights for adding the bot to basic group and supergroup chats; pass null to remove default rights"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setDefaultChannelAdministratorRights",
"description": "Sets default administrator rights for adding the bot to channel chats; for bots only",
"class": "Ok",
"properties": [
{
"name": "default_channel_administrator_rights",
"type": "chatAdministratorRights",
"description": "Default administrator rights for adding the bot to channels; pass null to remove default rights"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "canBotSendMessages",
"description": "Checks whether the specified bot can send messages to the user. Returns a 404 error if can't and the access can be granted by call to allowBotToSendMessages",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "allowBotToSendMessages",
"description": "Allows the specified bot to send messages to the user",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendWebAppCustomRequest",
"description": "Sends a custom request from a Web App",
"class": "CustomRequestResult",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the bot"
},
{
"name": "method",
"type": "string",
"description": "The method name"
},
{
"name": "parameters",
"type": "string",
"description": "JSON-serialized method parameters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBotName",
"description": "Sets the name of a bot. Can be called only if userTypeBot.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose languages there is no dedicated name"
},
{
"name": "name",
"type": "string",
"description": "New bot's name on the specified language; 0-64 characters; must be non-empty if language code is empty"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getBotName",
"description": "Returns the name of a bot in the given language. Can be called only if userTypeBot.can_be_edited == true",
"class": "Text",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code or an empty string"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setBotProfilePhoto",
"description": "Changes a profile photo for a bot",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "photo",
"type": "InputChatPhoto",
"description": "Profile photo to set; pass null to delete the chat photo"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleBotUsernameIsActive",
"description": "Changes active state for a username of a bot. The editable username can't be disabled. May return an error with a message \"USERNAMES_ACTIVE_TOO_MUCH\" if the maximum number of active usernames has been reached. Can be called only if userTypeBot.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "username",
"type": "string",
"description": "The username to change"
},
{
"name": "is_active",
"type": "Bool",
"description": "Pass true to activate the username; pass false to disable it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderBotActiveUsernames",
"description": "Changes order of active usernames of a bot. Can be called only if userTypeBot.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "usernames",
"type": "vector\u003cstring\u003e",
"description": "The new order of active usernames. All currently active usernames must be specified"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBotInfoDescription",
"description": "Sets the text shown in the chat with a bot if the chat is empty. Can be called only if userTypeBot.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code. If empty, the description will be shown to all users for whose languages there is no dedicated description"
},
{
"name": "description",
"type": "string",
"description": "New bot's description on the specified language"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getBotInfoDescription",
"description": "Returns the text shown in the chat with a bot if the chat is empty in the given language. Can be called only if userTypeBot.can_be_edited == true",
"class": "Text",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code or an empty string"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setBotInfoShortDescription",
"description": "Sets the text shown on a bot's profile page and sent together with the link when users share the bot. Can be called only if userTypeBot.can_be_edited == true",
"class": "Ok",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code. If empty, the short description will be shown to all users for whose languages there is no dedicated description"
},
{
"name": "short_description",
"type": "string",
"description": "New bot's short description on the specified language"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getBotInfoShortDescription",
"description": "Returns the text shown on a bot's profile page and sent together with the link when users share the bot in the given language. Can be called only if userTypeBot.can_be_edited == true",
"class": "Text",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "Identifier of the target bot"
},
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code or an empty string"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getActiveSessions",
"description": "Returns all active sessions of the current user",
"class": "Sessions",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "terminateSession",
"description": "Terminates a session of the current user",
"class": "Ok",
"properties": [
{
"name": "session_id",
"type": "int64",
"description": "Session identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "terminateAllOtherSessions",
"description": "Terminates all other sessions of the current user",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "confirmSession",
"description": "Confirms an unconfirmed session of the current user from another device",
"class": "Ok",
"properties": [
{
"name": "session_id",
"type": "int64",
"description": "Session identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSessionCanAcceptCalls",
"description": "Toggles whether a session can accept incoming calls",
"class": "Ok",
"properties": [
{
"name": "session_id",
"type": "int64",
"description": "Session identifier"
},
{
"name": "can_accept_calls",
"type": "Bool",
"description": "Pass true to allow accepting incoming calls by the session; pass false otherwise"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSessionCanAcceptSecretChats",
"description": "Toggles whether a session can accept incoming secret chats",
"class": "Ok",
"properties": [
{
"name": "session_id",
"type": "int64",
"description": "Session identifier"
},
{
"name": "can_accept_secret_chats",
"type": "Bool",
"description": "Pass true to allow accepting secret chats by the session; pass false otherwise"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setInactiveSessionTtl",
"description": "Changes the period of inactivity after which sessions will automatically be terminated",
"class": "Ok",
"properties": [
{
"name": "inactive_session_ttl_days",
"type": "int32",
"description": "New number of days of inactivity before sessions will be automatically terminated; 1-366 days"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getConnectedWebsites",
"description": "Returns all website where the current user used Telegram to log in",
"class": "ConnectedWebsites",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "disconnectWebsite",
"description": "Disconnects website from the current user's Telegram account",
"class": "Ok",
"properties": [
{
"name": "website_id",
"type": "int64",
"description": "Website identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "disconnectAllWebsites",
"description": "Disconnects all websites from the current user's Telegram account",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setSupergroupUsername",
"description": "Changes the editable username of a supergroup or channel, requires owner privileges in the supergroup or channel",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
},
{
"name": "username",
"type": "string",
"description": "New value of the username. Use an empty string to remove the username. The username can't be completely removed if there is another active or disabled username"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupUsernameIsActive",
"description": "Changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channel. The editable username can't be disabled. May return an error with a message \"USERNAMES_ACTIVE_TOO_MUCH\" if the maximum number of active usernames has been reached",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
},
{
"name": "username",
"type": "string",
"description": "The username to change"
},
{
"name": "is_active",
"type": "Bool",
"description": "Pass true to activate the username; pass false to disable it"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "disableAllSupergroupUsernames",
"description": "Disables all active non-editable usernames of a supergroup or channel, requires owner privileges in the supergroup or channel",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reorderSupergroupActiveUsernames",
"description": "Changes order of active usernames of a supergroup or channel, requires owner privileges in the supergroup or channel",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
},
{
"name": "usernames",
"type": "vector\u003cstring\u003e",
"description": "The new order of active usernames. All currently active usernames must be specified"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setSupergroupStickerSet",
"description": "Changes the sticker set of a supergroup; requires can_change_info administrator right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "sticker_set_id",
"type": "int64",
"description": "New value of the supergroup sticker set identifier. Use 0 to remove the supergroup sticker set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setSupergroupCustomEmojiStickerSet",
"description": "Changes the custom emoji sticker set of a supergroup; requires can_change_info administrator right. The chat must have at least chatBoostFeatures.min_custom_emoji_sticker_set_boost_level boost level to pass the corresponding color",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "custom_emoji_sticker_set_id",
"type": "int64",
"description": "New value of the custom emoji sticker set identifier for the supergroup. Use 0 to remove the custom emoji sticker set in the supergroup"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setSupergroupUnrestrictBoostCount",
"description": "Changes the number of times the supergroup must be boosted by a user to ignore slow mode and chat permission restrictions; requires can_restrict_members administrator right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "unrestrict_boost_count",
"type": "int32",
"description": "New value of the unrestrict_boost_count supergroup setting; 0-8. Use 0 to remove the setting"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "toggleSupergroupSignMessages",
"description": "Toggles whether sender signature is added to sent messages in a channel; requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the channel"
},
{
"name": "sign_messages",
"type": "Bool",
"description": "New value of sign_messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupJoinToSendMessages",
"description": "Toggles whether joining is mandatory to send messages to a discussion supergroup; requires can_restrict_members administrator right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "join_to_send_messages",
"type": "Bool",
"description": "New value of join_to_send_messages"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupJoinByRequest",
"description": "Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the channel"
},
{
"name": "join_by_request",
"type": "Bool",
"description": "New value of join_by_request"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupIsAllHistoryAvailable",
"description": "Toggles whether the message history of a supergroup is available to new members; requires can_change_info member right",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "The identifier of the supergroup"
},
{
"name": "is_all_history_available",
"type": "Bool",
"description": "The new value of is_all_history_available"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupHasHiddenMembers",
"description": "Toggles whether non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatMembers. Can be called only if supergroupFullInfo.can_hide_members == true",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "has_hidden_members",
"type": "Bool",
"description": "New value of has_hidden_members"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupHasAggressiveAntiSpamEnabled",
"description": "Toggles whether aggressive anti-spam checks are enabled in the supergroup. Can be called only if supergroupFullInfo.can_toggle_aggressive_anti_spam == true",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "The identifier of the supergroup, which isn't a broadcast group"
},
{
"name": "has_aggressive_anti_spam_enabled",
"type": "Bool",
"description": "The new value of has_aggressive_anti_spam_enabled"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupIsForum",
"description": "Toggles whether the supergroup is a forum; requires owner privileges in the supergroup. Discussion supergroups can't be converted to forums",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
},
{
"name": "is_forum",
"type": "Bool",
"description": "New value of is_forum"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "toggleSupergroupIsBroadcastGroup",
"description": "Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportSupergroupSpam",
"description": "Reports messages in a supergroup as spam; requires administrator rights in the supergroup",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup identifier"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of messages to report"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportSupergroupAntiSpamFalsePositive",
"description": "Reports a false deletion of a message by aggressive anti-spam checks; requires administrator rights in the supergroup. Can be called only for messages from chatEventMessageDeleted with can_report_anti_spam_false_positive == true",
"class": "Ok",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Supergroup identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the erroneously deleted message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSupergroupMembers",
"description": "Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters",
"class": "ChatMembers",
"properties": [
{
"name": "supergroup_id",
"type": "int53",
"description": "Identifier of the supergroup or channel"
},
{
"name": "filter",
"type": "SupergroupMembersFilter",
"description": "The type of users to return; pass null to use supergroupMembersFilterRecent"
},
{
"name": "offset",
"type": "int32",
"description": "Number of users to skip"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of users be returned; up to 200"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "closeSecretChat",
"description": "Closes a secret chat, effectively transferring its state to secretChatStateClosed",
"class": "Ok",
"properties": [
{
"name": "secret_chat_id",
"type": "int32",
"description": "Secret chat identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getChatEventLog",
"description": "Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only for supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i.e., in order of decreasing event_id)",
"class": "ChatEvents",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "query",
"type": "string",
"description": "Search query by which to filter events"
},
{
"name": "from_event_id",
"type": "int64",
"description": "Identifier of an event from which to return results. Use 0 to get results from the latest events"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of events to return; up to 100"
},
{
"name": "filters",
"type": "chatEventLogFilters",
"description": "The types of events to return; pass null to get chat events of all types"
},
{
"name": "user_ids",
"type": "vector\u003cint53\u003e",
"description": "User identifiers by which to filter events. By default, events relating to all users will be returned"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getTimeZones",
"description": "Returns the list of supported time zones",
"class": "TimeZones",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getPaymentForm",
"description": "Returns an invoice payment form. This method must be called when the user presses inline button of the type inlineKeyboardButtonTypeBuy",
"class": "PaymentForm",
"properties": [
{
"name": "input_invoice",
"type": "InputInvoice",
"description": "The invoice"
},
{
"name": "theme",
"type": "themeParameters",
"description": "Preferred payment form theme; pass null to use the default theme"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "validateOrderInfo",
"description": "Validates the order information provided by a user and returns the available shipping options for a flexible invoice",
"class": "ValidatedOrderInfo",
"properties": [
{
"name": "input_invoice",
"type": "InputInvoice",
"description": "The invoice"
},
{
"name": "order_info",
"type": "orderInfo",
"description": "The order information, provided by the user; pass null if empty"
},
{
"name": "allow_save",
"type": "Bool",
"description": "Pass true to save the order information"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendPaymentForm",
"description": "Sends a filled-out payment form to the bot for final verification",
"class": "PaymentResult",
"properties": [
{
"name": "input_invoice",
"type": "InputInvoice",
"description": "The invoice"
},
{
"name": "payment_form_id",
"type": "int64",
"description": "Payment form identifier returned by getPaymentForm"
},
{
"name": "order_info_id",
"type": "string",
"description": "Identifier returned by validateOrderInfo, or an empty string"
},
{
"name": "shipping_option_id",
"type": "string",
"description": "Identifier of a chosen shipping option, if applicable"
},
{
"name": "credentials",
"type": "InputCredentials",
"description": "The credentials chosen by user for payment"
},
{
"name": "tip_amount",
"type": "int53",
"description": "Chosen by the user amount of tip in the smallest units of the currency"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPaymentReceipt",
"description": "Returns information about a successful payment",
"class": "PaymentReceipt",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the messagePaymentSuccessful message"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSavedOrderInfo",
"description": "Returns saved order information. Returns a 404 error if there is no saved order information",
"class": "OrderInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteSavedOrderInfo",
"description": "Deletes saved order information",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteSavedCredentials",
"description": "Deletes saved credentials for all payment provider bots",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "createInvoiceLink",
"description": "Creates a link for the given invoice; for bots only",
"class": "HttpUrl",
"properties": [
{
"name": "invoice",
"type": "InputMessageContent",
"description": "Information about the invoice of the type inputMessageInvoice"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getSupportUser",
"description": "Returns a user that can be contacted to get support",
"class": "User",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getBackgroundUrl",
"description": "Constructs a persistent HTTP URL for a background",
"class": "HttpUrl",
"properties": [
{
"name": "name",
"type": "string",
"description": "Background name"
},
{
"name": "type",
"type": "BackgroundType",
"description": "Background type; backgroundTypeChatTheme isn't supported"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchBackground",
"description": "Searches for a background by its name",
"class": "Background",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the background"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setDefaultBackground",
"description": "Sets default background for chats; adds the background to the list of installed backgrounds",
"class": "Background",
"properties": [
{
"name": "background",
"type": "InputBackground",
"description": "The input background to use; pass null to create a new filled background"
},
{
"name": "type",
"type": "BackgroundType",
"description": "Background type; pass null to use the default type of the remote background; backgroundTypeChatTheme isn't supported"
},
{
"name": "for_dark_theme",
"type": "Bool",
"description": "Pass true if the background is set for a dark theme"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteDefaultBackground",
"description": "Deletes default background for chats",
"class": "Ok",
"properties": [
{
"name": "for_dark_theme",
"type": "Bool",
"description": "Pass true if the background is deleted for a dark theme"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getInstalledBackgrounds",
"description": "Returns backgrounds installed by the user",
"class": "Backgrounds",
"properties": [
{
"name": "for_dark_theme",
"type": "Bool",
"description": "Pass true to order returned backgrounds for a dark theme"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "removeInstalledBackground",
"description": "Removes background from the list of installed backgrounds",
"class": "Ok",
"properties": [
{
"name": "background_id",
"type": "int64",
"description": "The background identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resetInstalledBackgrounds",
"description": "Resets list of installed backgrounds to its default value",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getLocalizationTargetInfo",
"description": "Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization",
"class": "LocalizationTargetInfo",
"properties": [
{
"name": "only_local",
"type": "Bool",
"description": "Pass true to get only locally available information without sending network requests"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getLanguagePackInfo",
"description": "Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization",
"class": "LanguagePackInfo",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Language pack identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getLanguagePackStrings",
"description": "Returns strings from a language pack in the current localization target by their keys. Can be called before authorization",
"class": "LanguagePackStrings",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Language pack identifier of the strings to be returned"
},
{
"name": "keys",
"type": "vector\u003cstring\u003e",
"description": "Language pack keys of the strings to be returned; leave empty to request all available strings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "synchronizeLanguagePack",
"description": "Fetches the latest versions of all strings from a language pack in the current localization target from the server. This method doesn't need to be called explicitly for the current used/base language packs. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Language pack identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "addCustomServerLanguagePack",
"description": "Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Identifier of a language pack to be added"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setCustomLanguagePack",
"description": "Adds or changes a custom local language pack to the current localization target",
"class": "Ok",
"properties": [
{
"name": "info",
"type": "languagePackInfo",
"description": "Information about the language pack. Language pack identifier must start with 'X', consist only of English letters, digits and hyphens, and must not exceed 64 characters. Can be called before authorization"
},
{
"name": "strings",
"type": "vector\u003clanguagePackString\u003e",
"description": "Strings of the new language pack"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "editCustomLanguagePackInfo",
"description": "Edits information about a custom local language pack in the current localization target. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "info",
"type": "languagePackInfo",
"description": "New information about the custom local language pack"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setCustomLanguagePackString",
"description": "Adds, edits or deletes a string in a custom local language pack. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Identifier of a previously added custom local language pack in the current localization target"
},
{
"name": "new_string",
"type": "languagePackString",
"description": "New language pack string"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteLanguagePack",
"description": "Deletes all information about a language pack in the current localization target. The language pack which is currently in use (including base language pack) or is being synchronized can't be deleted. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "language_pack_id",
"type": "string",
"description": "Identifier of the language pack to delete"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "registerDevice",
"description": "Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription",
"class": "PushReceiverId",
"properties": [
{
"name": "device_token",
"type": "DeviceToken",
"description": "Device token"
},
{
"name": "other_user_ids",
"type": "vector\u003cint53\u003e",
"description": "List of user identifiers of other users currently using the application"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "processPushNotification",
"description": "Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to the server is required to fetch new data. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "payload",
"type": "string",
"description": "JSON-encoded push notification payload with all fields sent by the server, and \"google.sent_time\" and \"google.notification.sound\" fields added"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPushReceiverId",
"description": "Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. Can be called synchronously",
"class": "PushReceiverId",
"properties": [
{
"name": "payload",
"type": "string",
"description": "JSON-encoded push notification payload"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getRecentlyVisitedTMeUrls",
"description": "Returns t.me URLs recently visited by a newly registered user",
"class": "TMeUrls",
"properties": [
{
"name": "referrer",
"type": "string",
"description": "Google Play referrer to identify the user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setUserPrivacySettingRules",
"description": "Changes user privacy settings",
"class": "Ok",
"properties": [
{
"name": "setting",
"type": "UserPrivacySetting",
"description": "The privacy setting"
},
{
"name": "rules",
"type": "userPrivacySettingRules",
"description": "The new privacy rules"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getUserPrivacySettingRules",
"description": "Returns the current privacy settings",
"class": "UserPrivacySettingRules",
"properties": [
{
"name": "setting",
"type": "UserPrivacySetting",
"description": "The privacy setting"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setReadDatePrivacySettings",
"description": "Changes privacy settings for message read date",
"class": "Ok",
"properties": [
{
"name": "settings",
"type": "readDatePrivacySettings",
"description": "New settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getReadDatePrivacySettings",
"description": "Returns privacy settings for message read date",
"class": "ReadDatePrivacySettings",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setNewChatPrivacySettings",
"description": "Changes privacy settings for new chat creation; can be used only if getOption(\"can_set_new_chat_privacy_settings\")",
"class": "Ok",
"properties": [
{
"name": "settings",
"type": "newChatPrivacySettings",
"description": "New settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getNewChatPrivacySettings",
"description": "Returns privacy settings for new chat creation",
"class": "NewChatPrivacySettings",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "canSendMessageToUser",
"description": "Check whether the current user can message another user or try to create a chat with them",
"class": "CanSendMessageToUserResult",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Identifier of the other user"
},
{
"name": "only_local",
"type": "Bool",
"description": "Pass true to get only locally available information without sending network requests"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getOption",
"description": "Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options \"version\" and \"commit_hash\"",
"class": "OptionValue",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the option"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "setOption",
"description": "Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only writable options can be set. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "name",
"type": "string",
"description": "The name of the option"
},
{
"name": "value",
"type": "OptionValue",
"description": "The new value of the option; pass null to reset option value to a default value"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setAccountTtl",
"description": "Changes the period of inactivity after which the account of the current user will automatically be deleted",
"class": "Ok",
"properties": [
{
"name": "ttl",
"type": "accountTtl",
"description": "New account TTL"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAccountTtl",
"description": "Returns the period of inactivity after which the account of the current user will automatically be deleted",
"class": "AccountTtl",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "deleteAccount",
"description": "Deletes the account of the current user, deleting all information associated with the user from the server. The phone number of the account can be used to create a new account. Can be called before authorization when the current authorization state is authorizationStateWaitPassword",
"class": "Ok",
"properties": [
{
"name": "reason",
"type": "string",
"description": "The reason why the account was deleted; optional"
},
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user. If not specified, account deletion can be canceled within one week"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setDefaultMessageAutoDeleteTime",
"description": "Changes the default message auto-delete time for new chats",
"class": "Ok",
"properties": [
{
"name": "message_auto_delete_time",
"type": "messageAutoDeleteTime",
"description": "New default message auto-delete time; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getDefaultMessageAutoDeleteTime",
"description": "Returns default message auto-delete time setting for new chats",
"class": "MessageAutoDeleteTime",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "removeChatActionBar",
"description": "Removes a chat action bar without any other action",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportChat",
"description": "Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if chat.can_be_reported",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_ids",
"type": "vector\u003cint53\u003e",
"description": "Identifiers of reported messages; may be empty to report the whole chat"
},
{
"name": "reason",
"type": "ReportReason",
"description": "The reason for reporting the chat"
},
{
"name": "text",
"type": "string",
"description": "Additional report details; 0-1024 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportChatPhoto",
"description": "Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "file_id",
"type": "int32",
"description": "Identifier of the photo to report. Only full photos from chatPhoto can be reported"
},
{
"name": "reason",
"type": "ReportReason",
"description": "The reason for reporting the chat photo"
},
{
"name": "text",
"type": "string",
"description": "Additional report details; 0-1024 characters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "reportMessageReactions",
"description": "Reports reactions set on a message to the Telegram moderators. Reactions on a message can be reported only if message.can_report_reactions",
"class": "Ok",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "sender_id",
"type": "MessageSender",
"description": "Identifier of the sender, which added the reaction"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getChatStatistics",
"description": "Returns detailed statistics about a chat. Currently, this method can be used only for supergroups and channels. Can be used only if supergroupFullInfo.can_get_statistics == true",
"class": "ChatStatistics",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "is_dark",
"type": "Bool",
"description": "Pass true if a dark theme is used by the application"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessageStatistics",
"description": "Returns detailed statistics about a message. Can be used only if message.can_get_statistics == true",
"class": "MessageStatistics",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "is_dark",
"type": "Bool",
"description": "Pass true if a dark theme is used by the application"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMessagePublicForwards",
"description": "Returns forwarded copies of a channel message to different public channels and public reposts as a story. Can be used only if message.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib",
"class": "PublicForwards",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier of the message"
},
{
"name": "message_id",
"type": "int53",
"description": "Message identifier"
},
{
"name": "offset",
"type": "string",
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStoryStatistics",
"description": "Returns detailed statistics about a story. Can be used only if story.can_get_statistics == true",
"class": "StoryStatistics",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "story_id",
"type": "int32",
"description": "Story identifier"
},
{
"name": "is_dark",
"type": "Bool",
"description": "Pass true if a dark theme is used by the application"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStatisticalGraph",
"description": "Loads an asynchronous or a zoomed in statistical graph",
"class": "StatisticalGraph",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Chat identifier"
},
{
"name": "token",
"type": "string",
"description": "The token for graph loading"
},
{
"name": "x",
"type": "int53",
"description": "X-value for zoomed in graph or 0 otherwise"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getStorageStatistics",
"description": "Returns storage usage statistics. Can be called before authorization",
"class": "StorageStatistics",
"properties": [
{
"name": "chat_limit",
"type": "int32",
"description": "The maximum number of chats with the largest storage usage for which separate statistics need to be returned. All other chats will be grouped in entries with chat_id == 0. If the chat info database is not used, the chat_limit is ignored and is always set to 0"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getStorageStatisticsFast",
"description": "Quickly returns approximate storage usage statistics. Can be called before authorization",
"class": "StorageStatisticsFast",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getDatabaseStatistics",
"description": "Returns database statistics",
"class": "DatabaseStatistics",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "optimizeStorage",
"description": "Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted",
"class": "StorageStatistics",
"properties": [
{
"name": "size",
"type": "int53",
"description": "Limit on the total size of files after deletion, in bytes. Pass -1 to use the default limit"
},
{
"name": "ttl",
"type": "int32",
"description": "Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems). Pass -1 to use the default limit"
},
{
"name": "count",
"type": "int32",
"description": "Limit on the total number of files after deletion. Pass -1 to use the default limit"
},
{
"name": "immunity_delay",
"type": "int32",
"description": "The amount of time after the creation of a file during which it can't be deleted, in seconds. Pass -1 to use the default value"
},
{
"name": "file_types",
"type": "vector\u003cFileType\u003e",
"description": "If non-empty, only files with the given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted"
},
{
"name": "chat_ids",
"type": "vector\u003cint53\u003e",
"description": "If non-empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos)"
},
{
"name": "exclude_chat_ids",
"type": "vector\u003cint53\u003e",
"description": "If non-empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos)"
},
{
"name": "return_deleted_file_statistics",
"type": "Bool",
"description": "Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics. Affects only returned statistics"
},
{
"name": "chat_limit",
"type": "int32",
"description": "Same as in getStorageStatistics. Affects only returned statistics"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setNetworkType",
"description": "Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics",
"class": "Ok",
"properties": [
{
"name": "type",
"type": "NetworkType",
"description": "The new network type; pass null to set network type to networkTypeOther"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getNetworkStatistics",
"description": "Returns network data usage statistics. Can be called before authorization",
"class": "NetworkStatistics",
"properties": [
{
"name": "only_current",
"type": "Bool",
"description": "Pass true to get statistics only for the current library launch"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "addNetworkStatistics",
"description": "Adds the specified data to data usage statistics. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "entry",
"type": "NetworkStatisticsEntry",
"description": "The network statistics entry with the data to be added to statistics"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "resetNetworkStatistics",
"description": "Resets all network data usage statistics to zero. Can be called before authorization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getAutoDownloadSettingsPresets",
"description": "Returns auto-download settings presets for the current user",
"class": "AutoDownloadSettingsPresets",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setAutoDownloadSettings",
"description": "Sets auto-download settings",
"class": "Ok",
"properties": [
{
"name": "settings",
"type": "autoDownloadSettings",
"description": "New user auto-download settings"
},
{
"name": "type",
"type": "NetworkType",
"description": "Type of the network for which the new settings are relevant"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAutosaveSettings",
"description": "Returns autosave settings for the current user",
"class": "AutosaveSettings",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "setAutosaveSettings",
"description": "Sets autosave settings for the given scope. The method is guaranteed to work only after at least one call to getAutosaveSettings",
"class": "Ok",
"properties": [
{
"name": "scope",
"type": "AutosaveSettingsScope",
"description": "Autosave settings scope"
},
{
"name": "settings",
"type": "scopeAutosaveSettings",
"description": "New autosave settings for the scope; pass null to set autosave settings to default"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clearAutosaveSettingsExceptions",
"description": "Clears the list of all autosave settings exceptions. The method is guaranteed to work only after at least one call to getAutosaveSettings",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getBankCardInfo",
"description": "Returns information about a bank card",
"class": "BankCardInfo",
"properties": [
{
"name": "bank_card_number",
"type": "string",
"description": "The bank card number"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPassportElement",
"description": "Returns one of the available Telegram Passport elements",
"class": "PassportElement",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Telegram Passport element type"
},
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getAllPassportElements",
"description": "Returns all available Telegram Passport elements",
"class": "PassportElements",
"properties": [
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPassportElement",
"description": "Adds an element to the user's Telegram Passport. May return an error with a message \"PHONE_VERIFICATION_NEEDED\" or \"EMAIL_VERIFICATION_NEEDED\" if the chosen phone number or the chosen email address must be verified first",
"class": "PassportElement",
"properties": [
{
"name": "element",
"type": "InputPassportElement",
"description": "Input Telegram Passport element"
},
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "deletePassportElement",
"description": "Deletes a Telegram Passport element",
"class": "Ok",
"properties": [
{
"name": "type",
"type": "PassportElementType",
"description": "Element type"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setPassportElementErrors",
"description": "Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will not be able to resend the elements, until the errors are fixed",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "errors",
"type": "vector\u003cinputPassportElementError\u003e",
"description": "The errors"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "getPreferredCountryLanguage",
"description": "Returns an IETF language tag of the language preferred in the country, which must be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown",
"class": "Text",
"properties": [
{
"name": "country_code",
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendPhoneNumberVerificationCode",
"description": "Sends a code to verify a phone number to be added to a user's Telegram Passport",
"class": "AuthenticationCodeInfo",
"properties": [
{
"name": "phone_number",
"type": "string",
"description": "The phone number of the user, in international format"
},
{
"name": "settings",
"type": "phoneNumberAuthenticationSettings",
"description": "Settings for the authentication of the user's phone number; pass null to use default settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendPhoneNumberVerificationCode",
"description": "Resends the code to verify a phone number to be added to a user's Telegram Passport",
"class": "AuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkPhoneNumberVerificationCode",
"description": "Checks the phone number verification code for Telegram Passport",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "Verification code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendEmailAddressVerificationCode",
"description": "Sends a code to verify an email address to be added to a user's Telegram Passport",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [
{
"name": "email_address",
"type": "string",
"description": "Email address"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendEmailAddressVerificationCode",
"description": "Resends the code to verify an email address to be added to a user's Telegram Passport",
"class": "EmailAddressAuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkEmailAddressVerificationCode",
"description": "Checks the email address verification code for Telegram Passport",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "Verification code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPassportAuthorizationForm",
"description": "Returns a Telegram Passport authorization form for sharing data with a service",
"class": "PassportAuthorizationForm",
"properties": [
{
"name": "bot_user_id",
"type": "int53",
"description": "User identifier of the service's bot"
},
{
"name": "scope",
"type": "string",
"description": "Telegram Passport element types requested by the service"
},
{
"name": "public_key",
"type": "string",
"description": "Service's public key"
},
{
"name": "nonce",
"type": "string",
"description": "Unique request identifier provided by the service"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPassportAuthorizationFormAvailableElements",
"description": "Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form",
"class": "PassportElementsWithErrors",
"properties": [
{
"name": "authorization_form_id",
"type": "int32",
"description": "Authorization form identifier"
},
{
"name": "password",
"type": "string",
"description": "The 2-step verification password of the current user"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendPassportAuthorizationForm",
"description": "Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements are going to be reused",
"class": "Ok",
"properties": [
{
"name": "authorization_form_id",
"type": "int32",
"description": "Authorization form identifier"
},
{
"name": "types",
"type": "vector\u003cPassportElementType\u003e",
"description": "Types of Telegram Passport elements chosen by user to complete the authorization form"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "sendPhoneNumberConfirmationCode",
"description": "Sends phone number confirmation code to handle links of the type internalLinkTypePhoneNumberConfirmation",
"class": "AuthenticationCodeInfo",
"properties": [
{
"name": "hash",
"type": "string",
"description": "Hash value from the link"
},
{
"name": "phone_number",
"type": "string",
"description": "Phone number value from the link"
},
{
"name": "settings",
"type": "phoneNumberAuthenticationSettings",
"description": "Settings for the authentication of the user's phone number; pass null to use default settings"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "resendPhoneNumberConfirmationCode",
"description": "Resends phone number confirmation code",
"class": "AuthenticationCodeInfo",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "checkPhoneNumberConfirmationCode",
"description": "Checks phone number confirmation code",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "Confirmation code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setBotUpdatesStatus",
"description": "Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only",
"class": "Ok",
"properties": [
{
"name": "pending_update_count",
"type": "int32",
"description": "The number of pending updates"
},
{
"name": "error_message",
"type": "string",
"description": "The last error message"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "uploadStickerFile",
"description": "Uploads a file with a sticker; returns the uploaded file",
"class": "File",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Sticker file owner; ignored for regular users"
},
{
"name": "sticker_format",
"type": "StickerFormat",
"description": "Sticker format"
},
{
"name": "sticker",
"type": "InputFile",
"description": "File file to upload; must fit in a 512x512 square. For WEBP stickers the file must be in WEBP or PNG format, which will be converted to WEBP server-side. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getSuggestedStickerSetName",
"description": "Returns a suggested name for a new sticker set with a given title",
"class": "Text",
"properties": [
{
"name": "title",
"type": "string",
"description": "Sticker set title; 1-64 characters"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "checkStickerSetName",
"description": "Checks whether a name can be used for a new sticker set",
"class": "CheckStickerSetNameResult",
"properties": [
{
"name": "name",
"type": "string",
"description": "Name to be checked"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "createNewStickerSet",
"description": "Creates a new sticker set. Returns the newly created sticker set",
"class": "StickerSet",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Sticker set owner; ignored for regular users"
},
{
"name": "title",
"type": "string",
"description": "Sticker set title; 1-64 characters"
},
{
"name": "name",
"type": "string",
"description": "Sticker set name. Can contain only English letters, digits and underscores. Must end with *\"_by_\u003cbot username\u003e\"* (*\u003cbot_username\u003e* is case insensitive) for bots; 0-64 characters. If empty, then the name returned by getSuggestedStickerSetName will be used automatically"
},
{
"name": "sticker_type",
"type": "StickerType",
"description": "Type of the stickers in the set"
},
{
"name": "needs_repainting",
"type": "Bool",
"description": "Pass true if stickers in the sticker set must be repainted; for custom emoji sticker sets only"
},
{
"name": "stickers",
"type": "vector\u003cinputSticker\u003e",
"description": "List of stickers to be added to the set; 1-200 stickers for custom emoji sticker sets, and 1-120 stickers otherwise. For TGS stickers, uploadStickerFile must be used before the sticker is shown"
},
{
"name": "source",
"type": "string",
"description": "Source of the sticker set; may be empty if unknown"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "addStickerToSet",
"description": "Adds a new sticker to a set",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Sticker set owner; ignored for regular users"
},
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user, and contain less than 200 stickers for custom emoji sticker sets and less than 120 otherwise"
},
{
"name": "sticker",
"type": "inputSticker",
"description": "Sticker to add to the set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "replaceStickerInSet",
"description": "Replaces existing sticker in a set. The function is equivalent to removeStickerFromSet, then addStickerToSet, then setStickerPositionInSet",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Sticker set owner; ignored for regular users"
},
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user"
},
{
"name": "old_sticker",
"type": "InputFile",
"description": "Sticker to remove from the set"
},
{
"name": "new_sticker",
"type": "inputSticker",
"description": "Sticker to add to the set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerSetThumbnail",
"description": "Sets a sticker set thumbnail",
"class": "Ok",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "Sticker set owner; ignored for regular users"
},
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user"
},
{
"name": "thumbnail",
"type": "InputFile",
"description": "Thumbnail to set; pass null to remove the sticker set thumbnail"
},
{
"name": "format",
"type": "StickerFormat",
"description": "Format of the thumbnail; pass null if thumbnail is removed"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setCustomEmojiStickerSetThumbnail",
"description": "Sets a custom emoji sticker set thumbnail",
"class": "Ok",
"properties": [
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user"
},
{
"name": "custom_emoji_id",
"type": "int64",
"description": "Identifier of the custom emoji from the sticker set, which will be set as sticker set thumbnail; pass 0 to remove the sticker set thumbnail"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerSetTitle",
"description": "Sets a sticker set title",
"class": "Ok",
"properties": [
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user"
},
{
"name": "title",
"type": "string",
"description": "New sticker set title"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "deleteStickerSet",
"description": "Completely deletes a sticker set",
"class": "Ok",
"properties": [
{
"name": "name",
"type": "string",
"description": "Sticker set name. The sticker set must be owned by the current user"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerPositionInSet",
"description": "Changes the position of a sticker in the set to which it belongs. The sticker set must be owned by the current user",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker"
},
{
"name": "position",
"type": "int32",
"description": "New position of the sticker in the set, 0-based"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "removeStickerFromSet",
"description": "Removes a sticker from the set to which it belongs. The sticker set must be owned by the current user",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker to remove from the set"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerEmojis",
"description": "Changes the list of emoji corresponding to a sticker. The sticker must belong to a regular or custom emoji sticker set that is owned by the current user",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker"
},
{
"name": "emojis",
"type": "string",
"description": "New string with 1-20 emoji corresponding to the sticker"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerKeywords",
"description": "Changes the list of keywords of a sticker. The sticker must belong to a regular or custom emoji sticker set that is owned by the current user",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker"
},
{
"name": "keywords",
"type": "vector\u003cstring\u003e",
"description": "List of up to 20 keywords with total length up to 64 characters, which can be used to find the sticker"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setStickerMaskPosition",
"description": "Changes the mask position of a mask sticker. The sticker must belong to a mask sticker set that is owned by the current user",
"class": "Ok",
"properties": [
{
"name": "sticker",
"type": "InputFile",
"description": "Sticker"
},
{
"name": "mask_position",
"type": "maskPosition",
"description": "Position where the mask is placed; pass null to remove mask position"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getOwnedStickerSets",
"description": "Returns sticker sets owned by the current user",
"class": "StickerSets",
"properties": [
{
"name": "offset_sticker_set_id",
"type": "int64",
"description": "Identifier of the sticker set from which to return owned sticker sets; use 0 to get results from the beginning"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of sticker sets to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getMapThumbnailFile",
"description": "Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded",
"class": "File",
"properties": [
{
"name": "location",
"type": "location",
"description": "Location of the map center"
},
{
"name": "zoom",
"type": "int32",
"description": "Map zoom level; 13-20"
},
{
"name": "width",
"type": "int32",
"description": "Map width in pixels before applying scale; 16-1024"
},
{
"name": "height",
"type": "int32",
"description": "Map height in pixels before applying scale; 16-1024"
},
{
"name": "scale",
"type": "int32",
"description": "Map scale; 1-3"
},
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of a chat in which the thumbnail will be shown. Use 0 if unknown"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getPremiumLimit",
"description": "Returns information about a limit, increased for Premium users. Returns a 404 error if the limit is unknown",
"class": "PremiumLimit",
"properties": [
{
"name": "limit_type",
"type": "PremiumLimitType",
"description": "Type of the limit"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumFeatures",
"description": "Returns information about features, available to Premium users",
"class": "PremiumFeatures",
"properties": [
{
"name": "source",
"type": "PremiumSource",
"description": "Source of the request; pass null if the method is called from some non-standard source"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumStickerExamples",
"description": "Returns examples of premium stickers for demonstration purposes",
"class": "Stickers",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "viewPremiumFeature",
"description": "Informs TDLib that the user viewed detailed information about a Premium feature on the Premium features screen",
"class": "Ok",
"properties": [
{
"name": "feature",
"type": "PremiumFeature",
"description": "The viewed premium feature"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "clickPremiumSubscriptionButton",
"description": "Informs TDLib that the user clicked Premium subscription button on the Premium features screen",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumState",
"description": "Returns state of Telegram Premium subscription and promotion videos for Premium features",
"class": "PremiumState",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumGiftCodePaymentOptions",
"description": "Returns available options for Telegram Premium gift code or giveaway creation",
"class": "PremiumGiftCodePaymentOptions",
"properties": [
{
"name": "boosted_chat_id",
"type": "int53",
"description": "Identifier of the supergroup or channel chat, which will be automatically boosted by receivers of the gift codes and which is administered by the user; 0 if none"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "checkPremiumGiftCode",
"description": "Return information about a Telegram Premium gift code",
"class": "PremiumGiftCodeInfo",
"properties": [
{
"name": "code",
"type": "string",
"description": "The code to check"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "applyPremiumGiftCode",
"description": "Applies a Telegram Premium gift code",
"class": "Ok",
"properties": [
{
"name": "code",
"type": "string",
"description": "The code to apply"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "launchPrepaidPremiumGiveaway",
"description": "Launches a prepaid Telegram Premium giveaway",
"class": "Ok",
"properties": [
{
"name": "giveaway_id",
"type": "int64",
"description": "Unique identifier of the prepaid giveaway"
},
{
"name": "parameters",
"type": "premiumGiveawayParameters",
"description": "Giveaway parameters"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getPremiumGiveawayInfo",
"description": "Returns information about a Telegram Premium giveaway",
"class": "PremiumGiveawayInfo",
"properties": [
{
"name": "chat_id",
"type": "int53",
"description": "Identifier of the channel chat which started the giveaway"
},
{
"name": "message_id",
"type": "int53",
"description": "Identifier of the giveaway or a giveaway winners message in the chat"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "canPurchasePremium",
"description": "Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase",
"class": "Ok",
"properties": [
{
"name": "purpose",
"type": "StorePaymentPurpose",
"description": "Transaction purpose"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "assignAppStoreTransaction",
"description": "Informs server about a purchase through App Store. For official applications only",
"class": "Ok",
"properties": [
{
"name": "receipt",
"type": "bytes",
"description": "App Store receipt"
},
{
"name": "purpose",
"type": "StorePaymentPurpose",
"description": "Transaction purpose"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "assignGooglePlayTransaction",
"description": "Informs server about a purchase through Google Play. For official applications only",
"class": "Ok",
"properties": [
{
"name": "package_name",
"type": "string",
"description": "Application package name"
},
{
"name": "store_product_id",
"type": "string",
"description": "Identifier of the purchased store product"
},
{
"name": "purchase_token",
"type": "string",
"description": "Google Play purchase token"
},
{
"name": "purpose",
"type": "StorePaymentPurpose",
"description": "Transaction purpose"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getBusinessFeatures",
"description": "Returns information about features, available to Business users",
"class": "BusinessFeatures",
"properties": [
{
"name": "source",
"type": "BusinessFeature",
"description": "Source of the request; pass null if the method is called from settings or some non-standard source"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "acceptTermsOfService",
"description": "Accepts Telegram terms of services",
"class": "Ok",
"properties": [
{
"name": "terms_of_service_id",
"type": "string",
"description": "Terms of service identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "searchStringsByPrefix",
"description": "Searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously",
"class": "FoundPositions",
"properties": [
{
"name": "strings",
"type": "vector\u003cstring\u003e",
"description": "The strings to search in for the query"
},
{
"name": "query",
"type": "string",
"description": "Query to search for"
},
{
"name": "limit",
"type": "int32",
"description": "The maximum number of objects to return"
},
{
"name": "return_none_for_empty_query",
"type": "Bool",
"description": "Pass true to receive no results for an empty query"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "sendCustomRequest",
"description": "Sends a custom request; for bots only",
"class": "CustomRequestResult",
"properties": [
{
"name": "method",
"type": "string",
"description": "The method name"
},
{
"name": "parameters",
"type": "string",
"description": "JSON-serialized method parameters"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "answerCustomQuery",
"description": "Answers a custom query; for bots only",
"class": "Ok",
"properties": [
{
"name": "custom_query_id",
"type": "int64",
"description": "Identifier of a custom query"
},
{
"name": "data",
"type": "string",
"description": "JSON-serialized answer to the query"
}
],
"is_synchronous": false,
"type": 3
},
{
"name": "setAlarm",
"description": "Succeeds after a specified amount of time has passed. Can be called before initialization",
"class": "Ok",
"properties": [
{
"name": "seconds",
"type": "double",
"description": "Number of seconds before the function returns"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getCountries",
"description": "Returns information about existing countries. Can be called before authorization",
"class": "Countries",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getCountryCode",
"description": "Uses the current IP address to find the current country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization",
"class": "Text",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getPhoneNumberInfo",
"description": "Returns information about a phone number by its prefix. Can be called before authorization",
"class": "PhoneNumberInfo",
"properties": [
{
"name": "phone_number_prefix",
"type": "string",
"description": "The phone number prefix"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getPhoneNumberInfoSync",
"description": "Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after changing localization to the specified language if properly localized country information is expected. Can be called synchronously",
"class": "PhoneNumberInfo",
"properties": [
{
"name": "language_code",
"type": "string",
"description": "A two-letter ISO 639-1 language code for country information localization"
},
{
"name": "phone_number_prefix",
"type": "string",
"description": "The phone number prefix"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getCollectibleItemInfo",
"description": "Returns information about a given collectible item that was purchased at https://fragment.com",
"class": "CollectibleItemInfo",
"properties": [
{
"name": "type",
"type": "CollectibleItemType",
"description": "Type of the collectible item. The item must be used by a user and must be visible to the current user"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getDeepLinkInfo",
"description": "Returns information about a tg:// deep link. Use \"tg://need_update_for_some_feature\" or \"tg:some_unsupported_feature\" for testing. Returns a 404 error for unknown links. Can be called before authorization",
"class": "DeepLinkInfo",
"properties": [
{
"name": "link",
"type": "string",
"description": "The link"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getApplicationConfig",
"description": "Returns application config, provided by the server. Can be called before authorization",
"class": "JsonValue",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "saveApplicationLogEvent",
"description": "Saves application log event on the server. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "type",
"type": "string",
"description": "Event type"
},
{
"name": "chat_id",
"type": "int53",
"description": "Optional chat identifier, associated with the event"
},
{
"name": "data",
"type": "JsonValue",
"description": "The log event data"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getApplicationDownloadLink",
"description": "Returns the link for downloading official Telegram application to be used when the current user invites friends to Telegram",
"class": "HttpUrl",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "addProxy",
"description": "Adds a proxy server for network requests. Can be called before authorization",
"class": "Proxy",
"properties": [
{
"name": "server",
"type": "string",
"description": "Proxy server domain or IP address"
},
{
"name": "port",
"type": "int32",
"description": "Proxy server port"
},
{
"name": "enable",
"type": "Bool",
"description": "Pass true to immediately enable the proxy"
},
{
"name": "type",
"type": "ProxyType",
"description": "Proxy type"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "editProxy",
"description": "Edits an existing proxy server for network requests. Can be called before authorization",
"class": "Proxy",
"properties": [
{
"name": "proxy_id",
"type": "int32",
"description": "Proxy identifier"
},
{
"name": "server",
"type": "string",
"description": "Proxy server domain or IP address"
},
{
"name": "port",
"type": "int32",
"description": "Proxy server port"
},
{
"name": "enable",
"type": "Bool",
"description": "Pass true to immediately enable the proxy"
},
{
"name": "type",
"type": "ProxyType",
"description": "Proxy type"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "enableProxy",
"description": "Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "proxy_id",
"type": "int32",
"description": "Proxy identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "disableProxy",
"description": "Disables the currently enabled proxy. Can be called before authorization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "removeProxy",
"description": "Removes a proxy server. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "proxy_id",
"type": "int32",
"description": "Proxy identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "getProxies",
"description": "Returns list of proxies that are currently set up. Can be called before authorization",
"class": "Proxies",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "getProxyLink",
"description": "Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization",
"class": "HttpUrl",
"properties": [
{
"name": "proxy_id",
"type": "int32",
"description": "Proxy identifier"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "pingProxy",
"description": "Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization",
"class": "Seconds",
"properties": [
{
"name": "proxy_id",
"type": "int32",
"description": "Proxy identifier. Use 0 to ping a Telegram server without a proxy"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "setLogStream",
"description": "Sets new log stream for internal logging of TDLib. Can be called synchronously",
"class": "Ok",
"properties": [
{
"name": "log_stream",
"type": "LogStream",
"description": "New log stream"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getLogStream",
"description": "Returns information about currently used log stream for internal logging of TDLib. Can be called synchronously",
"class": "LogStream",
"properties": [],
"is_synchronous": true,
"type": 1
},
{
"name": "setLogVerbosityLevel",
"description": "Sets the verbosity level of the internal logging of TDLib. Can be called synchronously",
"class": "Ok",
"properties": [
{
"name": "new_verbosity_level",
"type": "int32",
"description": "New value of the verbosity level for logging. Value 0 corresponds to fatal errors, value 1 corresponds to errors, value 2 corresponds to warnings and debug warnings, value 3 corresponds to informational, value 4 corresponds to debug, value 5 corresponds to verbose debug, value greater than 5 and up to 1023 can be used to enable even more logging"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getLogVerbosityLevel",
"description": "Returns current verbosity level of the internal logging of TDLib. Can be called synchronously",
"class": "LogVerbosityLevel",
"properties": [],
"is_synchronous": true,
"type": 1
},
{
"name": "getLogTags",
"description": "Returns list of available TDLib internal log tags, for example, [\"actor\", \"binlog\", \"connections\", \"notifications\", \"proxy\"]. Can be called synchronously",
"class": "LogTags",
"properties": [],
"is_synchronous": true,
"type": 1
},
{
"name": "setLogTagVerbosityLevel",
"description": "Sets the verbosity level for a specified TDLib internal log tag. Can be called synchronously",
"class": "Ok",
"properties": [
{
"name": "tag",
"type": "string",
"description": "Logging tag to change verbosity level"
},
{
"name": "new_verbosity_level",
"type": "int32",
"description": "New verbosity level; 1-1024"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getLogTagVerbosityLevel",
"description": "Returns current verbosity level for a specified TDLib internal log tag. Can be called synchronously",
"class": "LogVerbosityLevel",
"properties": [
{
"name": "tag",
"type": "string",
"description": "Logging tag to change verbosity level"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "addLogMessage",
"description": "Adds a message to TDLib internal log. Can be called synchronously",
"class": "Ok",
"properties": [
{
"name": "verbosity_level",
"type": "int32",
"description": "The minimum verbosity level needed for the message to be logged; 0-1023"
},
{
"name": "text",
"type": "string",
"description": "Text of a message to log"
}
],
"is_synchronous": true,
"type": 1
},
{
"name": "getUserSupportInfo",
"description": "Returns support information for the given user; for Telegram support only",
"class": "UserSupportInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "setUserSupportInfo",
"description": "Sets support information for the given user; for Telegram support only",
"class": "UserSupportInfo",
"properties": [
{
"name": "user_id",
"type": "int53",
"description": "User identifier"
},
{
"name": "message",
"type": "formattedText",
"description": "New information message"
}
],
"is_synchronous": false,
"type": 2
},
{
"name": "getSupportName",
"description": "Returns localized name of the Telegram support user; for Telegram support only",
"class": "Text",
"properties": [],
"is_synchronous": false,
"type": 2
},
{
"name": "testCallEmpty",
"description": "Does nothing; for testing only. This is an offline method. Can be called before authorization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallString",
"description": "Returns the received string; for testing only. This is an offline method. Can be called before authorization",
"class": "TestString",
"properties": [
{
"name": "x",
"type": "string",
"description": "String to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallBytes",
"description": "Returns the received bytes; for testing only. This is an offline method. Can be called before authorization",
"class": "TestBytes",
"properties": [
{
"name": "x",
"type": "bytes",
"description": "Bytes to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallVectorInt",
"description": "Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization",
"class": "TestVectorInt",
"properties": [
{
"name": "x",
"type": "vector\u003cint32\u003e",
"description": "Vector of numbers to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallVectorIntObject",
"description": "Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization",
"class": "TestVectorIntObject",
"properties": [
{
"name": "x",
"type": "vector\u003ctestInt\u003e",
"description": "Vector of objects to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallVectorString",
"description": "Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization",
"class": "TestVectorString",
"properties": [
{
"name": "x",
"type": "vector\u003cstring\u003e",
"description": "Vector of strings to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testCallVectorStringObject",
"description": "Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization",
"class": "TestVectorStringObject",
"properties": [
{
"name": "x",
"type": "vector\u003ctestString\u003e",
"description": "Vector of objects to return"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testSquareInt",
"description": "Returns the squared received number; for testing only. This is an offline method. Can be called before authorization",
"class": "TestInt",
"properties": [
{
"name": "x",
"type": "int32",
"description": "Number to square"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testNetwork",
"description": "Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "testProxy",
"description": "Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization",
"class": "Ok",
"properties": [
{
"name": "server",
"type": "string",
"description": "Proxy server domain or IP address"
},
{
"name": "port",
"type": "int32",
"description": "Proxy server port"
},
{
"name": "type",
"type": "ProxyType",
"description": "Proxy type"
},
{
"name": "dc_id",
"type": "int32",
"description": "Identifier of a datacenter with which to test connection"
},
{
"name": "timeout",
"type": "double",
"description": "The maximum overall timeout for the request"
}
],
"is_synchronous": false,
"type": 1
},
{
"name": "testGetDifference",
"description": "Forces an updates.getDifference call to the Telegram servers; for testing only",
"class": "Ok",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "testUseUpdate",
"description": "Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called before authorization",
"class": "Update",
"properties": [],
"is_synchronous": false,
"type": 1
},
{
"name": "testReturnError",
"description": "Returns the specified error and ensures that the Error object is used; for testing only. Can be called synchronously",
"class": "Error",
"properties": [
{
"name": "error",
"type": "error",
"description": "The error to be returned"
}
],
"is_synchronous": true,
"type": 1
}
]
}
Reference in New Issue View Git Blame Copy Permalink