39603 lines
1.5 MiB
Executable File
39603 lines
1.5 MiB
Executable File
{
|
|
"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 admin |