Module types

Module types 

Source

Structs§

AccountTtl
Contains information about the period of inactivity after which the current user’s account will automatically be deleted
Address
Describes an address
Animation
Describes an animation file. The animation must be encoded in GIF or MPEG4 format
Animations
Represents a list of animations
Audio
Describes an audio file. Audio is usually in MP3 format
AuthenticationCodeInfo
Information about the authentication code that was sent
AuthenticationCodeTypeCall
An authentication code is delivered via a phone call to the specified phone number
AuthenticationCodeTypeFlashCall
An authentication code is delivered by an immediately cancelled call to the specified phone number. The number from which the call was made is the code
AuthenticationCodeTypeSms
An authentication code is delivered via an SMS message to the specified phone number
AuthenticationCodeTypeTelegramMessage
An authentication code is delivered via a private Telegram message, which can be viewed in another client
AuthorizationStateClosed
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 should create a new instance of the TDLib client
AuthorizationStateClosing
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
AuthorizationStateLoggingOut
The user is currently logging out
AuthorizationStateReady
The user has been successfully authorized. TDLib is now ready to answer queries
AuthorizationStateWaitCode
TDLib needs the user’s authentication code to finalize authorization
AuthorizationStateWaitEncryptionKey
TDLib needs an encryption key to decrypt the local database
AuthorizationStateWaitPassword
The user has been authorized, but needs to enter a password to start using the application
AuthorizationStateWaitPhoneNumber
TDLib needs the user’s phone number to authorize
AuthorizationStateWaitTdlibParameters
TDLib needs TdlibParameters for initialization
BasicGroup
Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)
BasicGroupFullInfo
Contains full information about a basic group
BotCommand
Represents commands supported by a bot
BotInfo
Provides information about a bot and its supported commands
Call
Describes a call
CallConnection
Describes the address of UDP reflectors
CallDiscardReasonDeclined
The call was ended before the conversation started. It was declined by the other party
CallDiscardReasonDisconnected
The call was ended during the conversation because the users were disconnected
CallDiscardReasonEmpty
The call wasn’t discarded, or the reason is unknown
CallDiscardReasonHungUp
The call was ended because one of the parties hung up
CallDiscardReasonMissed
The call was ended before the conversation started. It was cancelled by the caller or missed by the other party
CallId
Contains the call identifier
CallProtocol
Specifies the supported call protocols
CallStateDiscarded
The call has ended successfully
CallStateError
The call has ended with an error
CallStateExchangingKeys
The call has been answered and encryption keys are being exchanged
CallStateHangingUp
The call is hanging up after discardCall has been called
CallStatePending
The call is pending, waiting to be accepted by a user
CallStateReady
The call is ready to use
CallbackQueryAnswer
Contains a bot’s answer to a callback query
CallbackQueryPayloadData
The payload from a general callback button
CallbackQueryPayloadGame
The payload from a game callback button
Chat
A chat. (Can be a private chat, basic group, supergroup, or secret chat)
ChatActionCancel
The user has cancelled the previous action
ChatActionChoosingContact
The user is picking a contact to send
ChatActionChoosingLocation
The user is picking a location or venue to send
ChatActionRecordingVideo
The user is recording a video
ChatActionRecordingVideoNote
The user is recording a video note
ChatActionRecordingVoiceNote
The user is recording a voice note
ChatActionStartPlayingGame
The user has started to play a game
ChatActionTyping
The user is typing a message
ChatActionUploadingDocument
The user is uploading a document
ChatActionUploadingPhoto
The user is uploading a photo
ChatActionUploadingVideo
The user is uploading a video
ChatActionUploadingVideoNote
The user is uploading a video note
ChatActionUploadingVoiceNote
The user is uploading a voice note
ChatEvent
Represents a chat event
ChatEventDescriptionChanged
The chat description was changed
ChatEventInvitesToggled
The anyone_can_invite setting of a supergroup chat was toggled
ChatEventIsAllHistoryAvailableToggled
The is_all_history_available setting of a supergroup was toggled
ChatEventLogFilters
Represents a set of filters used to obtain a chat event log
ChatEventMemberInvited
A new chat member was invited
ChatEventMemberJoined
A new member joined the chat
ChatEventMemberLeft
A member left the chat
ChatEventMemberPromoted
A chat member has gained/lost administrator status, or the list of their administrator privileges has changed
ChatEventMemberRestricted
A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed
ChatEventMessageDeleted
A message was deleted
ChatEventMessageEdited
A message was edited
ChatEventMessagePinned
A message was pinned
ChatEventMessageUnpinned
A message was unpinned
ChatEventPhotoChanged
The chat photo was changed
ChatEventSignMessagesToggled
The sign_messages setting of a channel was toggled
ChatEventStickerSetChanged
The supergroup sticker set was changed
ChatEventTitleChanged
The chat title was changed
ChatEventUsernameChanged
The chat username was changed
ChatEvents
Contains a list of chat events
ChatInviteLink
Contains a chat invite link
ChatInviteLinkInfo
Contains information about a chat invite link
ChatMember
A user with information about joining/leaving a chat
ChatMemberStatusAdministrator
The user is a member of a chat and has some additional privileges. In basic groups, administrators can edit and delete messages sent by others, add new members, and ban unprivileged members. In supergroups and channels, there are more detailed options for administrator privileges
ChatMemberStatusBanned
The user was banned (and hence is not a member of the chat). Implies the user can’t return to the chat or view messages
ChatMemberStatusCreator
The user is the creator of a chat and has all the administrator privileges
ChatMemberStatusLeft
The user is not a chat member
ChatMemberStatusMember
The user is a member of a chat, without any additional privileges or restrictions
ChatMemberStatusRestricted
The user is under certain restrictions in the chat. Not supported in basic groups and channels
ChatMembers
Contains a list of chat members
ChatMembersFilterAdministrators
Returns the creator and administrators
ChatMembersFilterBanned
Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel
ChatMembersFilterBots
Returns bot members of the chat
ChatMembersFilterMembers
Returns all chat members, including restricted chat members
ChatMembersFilterRestricted
Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup
ChatNotificationSettings
Contains information about notification settings for a chat
ChatPhoto
Describes the photo of a chat
ChatReportReasonCopyright
The chat contains copyrighted content
ChatReportReasonCustom
A custom reason provided by the user
ChatReportReasonPornography
The chat contains pornographic messages
ChatReportReasonSpam
The chat contains spam messages
ChatReportReasonViolence
The chat promotes violence
ChatReportSpamState
Contains information about the availability of the “Report spam” action for a chat
ChatTypeBasicGroup
A basic group (i.e., a chat with 0-200 other users)
ChatTypePrivate
An ordinary chat with a user
ChatTypeSecret
A secret chat with a user
ChatTypeSupergroup
A supergroup (i.e. a chat with up to GetOption(“supergroup_max_size”) other users), or channel (with unlimited members)
Chats
Represents a list of chats
CheckChatUsernameResultOk
The username can be set
CheckChatUsernameResultPublicChatsTooMuch
The user has too much public chats, one of them should be made private first
CheckChatUsernameResultPublicGroupsUnavailable
The user can’t be a member of a public supergroup
CheckChatUsernameResultUsernameInvalid
The username is invalid
CheckChatUsernameResultUsernameOccupied
The username is occupied
ConnectedWebsite
Contains information about one website the current user is logged in with Telegram
ConnectedWebsites
Contains a list of websites the current user is logged in with Telegram
ConnectionStateConnecting
Currently establishing a connection to the Telegram servers
ConnectionStateConnectingToProxy
Currently establishing a connection with a proxy server
ConnectionStateReady
There is a working connection to the Telegram servers
ConnectionStateUpdating
Downloading data received while the client was offline
ConnectionStateWaitingForNetwork
Currently waiting for the network to become available. Use SetNetworkType to change the available network type
Contact
Describes a user contact
Count
Contains a counter
CustomRequestResult
Contains the result of a custom request
Date
Represents a date according to the Gregorian calendar
DatedFile
File with the date it was uploaded
DeepLinkInfo
Contains information about a tg:// deep link
DeviceTokenApplePush
A token for Apple Push Notification service
DeviceTokenApplePushVoIP
A token for Apple Push Notification service VoIP notifications
DeviceTokenBlackBerryPush
A token for BlackBerry Push Service
DeviceTokenGoogleCloudMessaging
A token for Google Cloud Messaging
DeviceTokenMicrosoftPush
A token for Microsoft Push Notification Service
DeviceTokenMicrosoftPushVoIP
A token for Microsoft Push Notification Service VoIP channel
DeviceTokenSimplePush
A token for Simple Push API for Firefox OS
DeviceTokenTizenPush
A token for Tizen Push Service
DeviceTokenUbuntuPush
A token for Ubuntu Push Client service
DeviceTokenWebPush
A token for web Push API
DeviceTokenWindowsPush
A token for Windows Push Notification Services
Document
Describes a document of any type
DraftMessage
Contains information about a message draft
EmailAddressAuthenticationCodeInfo
Information about the email address authentication code that was sent
EncryptedCredentials
Contains encrypted Telegram Passport data credentials
EncryptedPassportElement
Contains information about an encrypted Telegram Passport element; for bots only
Error
An object of this type can be returned on every function call, in case of an error
File
Represents a file
FileTypeAnimation
The file is an animation
FileTypeAudio
The file is an audio file
FileTypeDocument
The file is a document
FileTypeNone
The data is not a file
FileTypePhoto
The file is a photo
FileTypeProfilePhoto
The file is a profile photo
FileTypeSecret
The file was sent to a secret chat (the file type is not known to the server)
FileTypeSecretThumbnail
The file is a thumbnail of a file from a secret chat
FileTypeSecure
The file is a file from Secure storage used for storing Telegram Passport files
FileTypeSticker
The file is a sticker
FileTypeThumbnail
The file is a thumbnail of another file
FileTypeUnknown
The file type is not yet known
FileTypeVideo
The file is a video
FileTypeVideoNote
The file is a video note
FileTypeVoiceNote
The file is a voice note
FileTypeWallpaper
The file is a wallpaper
FormattedText
A text with some entities
FoundMessages
Contains a list of messages found by a search
Game
Describes a game
GameHighScore
Contains one row of the game high score table
GameHighScores
Contains a list of game high scores
Hashtags
Contains a list of hashtags
IdentityDocument
An identity document
ImportedContacts
Represents the result of an ImportContacts request
InlineKeyboardButton
Represents a single button in an inline keyboard
InlineKeyboardButtonTypeBuy
A button to buy something. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageInvoice
InlineKeyboardButtonTypeCallback
A button that sends a special callback query to a bot
InlineKeyboardButtonTypeCallbackGame
A button with a game that sends a special callback query to a bot. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageGame
InlineKeyboardButtonTypeSwitchInline
A button that forces an inline query to the bot to be inserted in the input field
InlineKeyboardButtonTypeUrl
A button that opens a specified URL
InlineQueryResultAnimation
Represents an animation file
InlineQueryResultArticle
Represents a link to an article or web page
InlineQueryResultAudio
Represents an audio file
InlineQueryResultContact
Represents a user contact
InlineQueryResultDocument
Represents a document
InlineQueryResultGame
Represents information about a game
InlineQueryResultLocation
Represents a point on the map
InlineQueryResultPhoto
Represents a photo
InlineQueryResultSticker
Represents a sticker
InlineQueryResultVenue
Represents information about a venue
InlineQueryResultVideo
Represents a video
InlineQueryResultVoiceNote
Represents a voice note
InlineQueryResults
Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query
InputCredentialsAndroidPay
Applies if a user enters new credentials using Android Pay
InputCredentialsApplePay
Applies if a user enters new credentials using Apple Pay
InputCredentialsNew
Applies if a user enters new credentials on a payment provider website
InputCredentialsSaved
Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password
InputFileGenerated
A file generated by the client
InputFileId
A file defined by its unique ID
InputFileLocal
A file defined by a local path
InputFileRemote
A file defined by its remote ID
InputIdentityDocument
An identity document to be saved to Telegram Passport
InputInlineQueryResultAnimatedGif
Represents a link to an animated GIF
InputInlineQueryResultAnimatedMpeg4
Represents a link to an animated (i.e. without sound) H.264/MPEG-4 AVC video
InputInlineQueryResultArticle
Represents a link to an article or web page
InputInlineQueryResultAudio
Represents a link to an MP3 audio file
InputInlineQueryResultContact
Represents a user contact
InputInlineQueryResultDocument
Represents a link to a file
InputInlineQueryResultGame
Represents a game
InputInlineQueryResultLocation
Represents a point on the map
InputInlineQueryResultPhoto
Represents link to a JPEG image
InputInlineQueryResultSticker
Represents a link to a WEBP sticker
InputInlineQueryResultVenue
Represents information about a venue
InputInlineQueryResultVideo
Represents a link to a page containing an embedded video player or a video file
InputInlineQueryResultVoiceNote
Represents a link to an opus-encoded audio file within an OGG container, single channel audio
InputMessageAnimation
An animation message (GIF-style).
InputMessageAudio
An audio message
InputMessageContact
A message containing a user contact
InputMessageDocument
A document message (general file)
InputMessageForwarded
A forwarded message
InputMessageGame
A message with a game; not supported for channels or secret chats
InputMessageInvoice
A message with an invoice; can be used only by bots and only in private chats
InputMessageLocation
A message with a location
InputMessagePhoto
A photo message
InputMessageSticker
A sticker message
InputMessageText
A text message
InputMessageVenue
A message with information about a venue
InputMessageVideo
A video message
InputMessageVideoNote
A video note message
InputMessageVoiceNote
A voice note message
InputPassportElementAddress
A Telegram Passport element to be saved containing the user’s address
InputPassportElementBankStatement
A Telegram Passport element to be saved containing the user’s bank statement
InputPassportElementDriverLicense
A Telegram Passport element to be saved containing the user’s driver license
InputPassportElementEmailAddress
A Telegram Passport element to be saved containing the user’s email address
InputPassportElementError
Contains the description of an error in a Telegram Passport element; for bots only
InputPassportElementErrorSourceDataField
A data field contains an error. The error is considered resolved when the field’s value changes
InputPassportElementErrorSourceFile
The file contains an error. The error is considered resolved when the file changes
InputPassportElementErrorSourceFiles
The list of attached files contains an error. The error is considered resolved when the file list changes
InputPassportElementErrorSourceFrontSide
The front side of the document contains an error. The error is considered resolved when the file with the front side of the document changes
InputPassportElementErrorSourceReverseSide
The reverse side of the document contains an error. The error is considered resolved when the file with the reverse side of the document changes
InputPassportElementErrorSourceSelfie
The selfie contains an error. The error is considered resolved when the file with the selfie changes
InputPassportElementErrorSourceTranslationFile
One of the files containing the translation of the document contains an error. The error is considered resolved when the file with the translation changes
InputPassportElementErrorSourceTranslationFiles
The translation of the document contains an error. The error is considered resolved when the list of files changes
InputPassportElementErrorSourceUnspecified
The element contains an error in an unspecified place. The error will be considered resolved when new data is added
InputPassportElementIdentityCard
A Telegram Passport element to be saved containing the user’s identity card
InputPassportElementInternalPassport
A Telegram Passport element to be saved containing the user’s internal passport
InputPassportElementPassport
A Telegram Passport element to be saved containing the user’s passport
InputPassportElementPassportRegistration
A Telegram Passport element to be saved containing the user’s passport registration
InputPassportElementPersonalDetails
A Telegram Passport element to be saved containing the user’s personal details
InputPassportElementPhoneNumber
A Telegram Passport element to be saved containing the user’s phone number
InputPassportElementRentalAgreement
A Telegram Passport element to be saved containing the user’s rental agreement
InputPassportElementTemporaryRegistration
A Telegram Passport element to be saved containing the user’s temporary registration
InputPassportElementUtilityBill
A Telegram Passport element to be saved containing the user’s utility bill
InputPersonalDocument
A personal document to be saved to Telegram Passport
InputSticker
Describes a sticker that should be added to a sticker set
InputThumbnail
A thumbnail to be sent along with a file; should be in JPEG or WEBP format for stickers, and less than 200 kB in size
Invoice
Product invoice
KeyboardButton
Represents a single button in a bot keyboard
KeyboardButtonTypeRequestLocation
A button that sends the user’s location when pressed; available only in private chats
KeyboardButtonTypeRequestPhoneNumber
A button that sends the user’s phone number when pressed; available only in private chats
KeyboardButtonTypeText
A simple button, with text that should be sent when the button is pressed
LabeledPricePart
Portion of the price of a product (e.g., “delivery cost”, “tax amount”)
LanguagePackInfo
Contains information about a language pack
LanguagePackString
Represents one language pack string
LanguagePackStringValueDeleted
A deleted language pack string, the value should be taken from the built-in english language pack
LanguagePackStringValueOrdinary
An ordinary language pack string
LanguagePackStringValuePluralized
A language pack string which has different forms based on the number of some object it mentions
LanguagePackStrings
Contains a list of language pack strings
LinkStateIsContact
The phone number of user A has been saved to the contacts list of user B
LinkStateKnowsPhoneNumber
The phone number of user A is known but that number has not been saved to the contacts list of user B
LinkStateNone
The phone number of user A is not known to user B
LocalFile
Represents a local file
LocalizationTargetInfo
Contains information about the current localization target
Location
Describes a location on planet Earth
MaskPointChin
A mask should be placed relatively to the chin
MaskPointEyes
A mask should be placed relatively to the eyes
MaskPointForehead
A mask should be placed relatively to the forehead
MaskPointMouth
A mask should be placed relatively to the mouth
MaskPosition
Position on a photo where a mask should be placed
Message
Describes a message
MessageAnimation
An animation message (GIF-style).
MessageAudio
An audio message
MessageBasicGroupChatCreate
A newly created basic group
MessageCall
A message with information about an ended call
MessageChatAddMembers
New chat members were added
MessageChatChangePhoto
An updated chat photo
MessageChatChangeTitle
An updated chat title
MessageChatDeleteMember
A chat member was deleted
MessageChatDeletePhoto
A deleted chat photo
MessageChatJoinByLink
A new member joined the chat by invite link
MessageChatSetTtl
The TTL (Time To Live) setting messages in a secret chat has been changed
MessageChatUpgradeFrom
A supergroup has been created from a basic group
MessageChatUpgradeTo
A basic group was upgraded to a supergroup and was deactivated as the result
MessageContact
A message with a user contact
MessageContactRegistered
A contact has registered with Telegram
MessageCustomServiceAction
A non-standard action has happened in the chat
MessageDocument
A document message (general file)
MessageExpiredPhoto
An expired photo message (self-destructed after TTL has elapsed)
MessageExpiredVideo
An expired video message (self-destructed after TTL has elapsed)
MessageForwardedFromUser
The message was originally written by a known user
MessageForwardedPost
The message was originally a post in a channel
MessageGame
A message with a game
MessageGameScore
A new high score was achieved in a game
MessageInvoice
A message with an invoice from a bot
MessageLocation
A message with a location
MessagePassportDataReceived
Telegram Passport data has been received; for bots only
MessagePassportDataSent
Telegram Passport data has been sent
MessagePaymentSuccessful
A payment has been completed
MessagePaymentSuccessfulBot
A payment has been completed; for bots only
MessagePhoto
A photo message
MessagePinMessage
A message has been pinned
MessageScreenshotTaken
A screenshot of a message in the chat has been taken
MessageSendingStateFailed
The message failed to be sent
MessageSendingStatePending
The message is being sent now, but has not yet been delivered to the server
MessageSticker
A sticker message
MessageSupergroupChatCreate
A newly created supergroup or channel
MessageText
A text message
MessageUnsupported
Message content that is not supported by the client
MessageVenue
A message with information about a venue
MessageVideo
A video message
MessageVideoNote
A video note message
MessageVoiceNote
A voice note message
MessageWebsiteConnected
The current user has connected a website by logging in using Telegram Login Widget on it
Messages
Contains a list of messages
NetworkStatistics
A full list of available network statistic entries
NetworkStatisticsEntryCall
Contains information about the total amount of data that was used for calls
NetworkStatisticsEntryFile
Contains information about the total amount of data that was used to send and receive files
NetworkTypeMobile
A mobile network
NetworkTypeMobileRoaming
A mobile roaming network
NetworkTypeNone
The network is not available
NetworkTypeOther
A different network type (e.g., Ethernet network)
NetworkTypeWiFi
A Wi-Fi network
NotificationSettingsScopeGroupChats
Notification settings applied to all basic groups, supergroups and channels when the corresponding chat setting has a default value
NotificationSettingsScopePrivateChats
Notification settings applied to all private and secret chats when the corresponding chat setting has a default value
Ok
An object of this type is returned on a successful function call for certain functions
OptionValueBoolean
Boolean option
OptionValueEmpty
An unknown option or an option which has a default value
OptionValueInteger
An integer option
OptionValueString
A string option
OrderInfo
Order information
PageBlockAnchor
An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor
PageBlockAnimation
An animation
PageBlockAudio
An audio file
PageBlockAuthorDate
The author and publishing date of a page
PageBlockBlockQuote
A block quote
PageBlockChatLink
A link to a chat
PageBlockCollage
A collage
PageBlockCover
A page cover
PageBlockDivider
An empty block separating a page
PageBlockEmbedded
An embedded web page
PageBlockEmbeddedPost
An embedded post
PageBlockFooter
The footer of a page
PageBlockHeader
A header
PageBlockList
A list of texts
PageBlockParagraph
A text paragraph
PageBlockPhoto
A photo
PageBlockPreformatted
A preformatted text paragraph
PageBlockPullQuote
A pull quote
PageBlockSlideshow
A slideshow
PageBlockSubheader
A subheader
PageBlockSubtitle
The subtitle of a page
PageBlockTitle
The title of a page
PageBlockVideo
A video
PassportAuthorizationForm
Contains information about a Telegram Passport authorization form that was requested
PassportElementAddress
A Telegram Passport element containing the user’s address
PassportElementBankStatement
A Telegram Passport element containing the user’s bank statement
PassportElementDriverLicense
A Telegram Passport element containing the user’s driver license
PassportElementEmailAddress
A Telegram Passport element containing the user’s email address
PassportElementError
Contains the description of an error in a Telegram Passport element
PassportElementErrorSourceDataField
One of the data fields contains an error. The error will be considered resolved when the value of the field changes
PassportElementErrorSourceFile
The file contains an error. The error will be considered resolved when the file changes
PassportElementErrorSourceFiles
The list of attached files contains an error. The error will be considered resolved when the list of files changes
PassportElementErrorSourceFrontSide
The front side of the document contains an error. The error will be considered resolved when the file with the front side changes
PassportElementErrorSourceReverseSide
The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes
PassportElementErrorSourceSelfie
The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes
PassportElementErrorSourceTranslationFile
One of files with the translation of the document contains an error. The error will be considered resolved when the file changes
PassportElementErrorSourceTranslationFiles
The translation of the document contains an error. The error will be considered resolved when the list of translation files changes
PassportElementErrorSourceUnspecified
The element contains an error in an unspecified place. The error will be considered resolved when new data is added
PassportElementIdentityCard
A Telegram Passport element containing the user’s identity card
PassportElementInternalPassport
A Telegram Passport element containing the user’s internal passport
PassportElementPassport
A Telegram Passport element containing the user’s passport
PassportElementPassportRegistration
A Telegram Passport element containing the user’s passport registration pages
PassportElementPersonalDetails
A Telegram Passport element containing the user’s personal details
PassportElementPhoneNumber
A Telegram Passport element containing the user’s phone number
PassportElementRentalAgreement
A Telegram Passport element containing the user’s rental agreement
PassportElementTemporaryRegistration
A Telegram Passport element containing the user’s temporary registration
PassportElementTypeAddress
A Telegram Passport element containing the user’s address
PassportElementTypeBankStatement
A Telegram Passport element containing the user’s bank statement
PassportElementTypeDriverLicense
A Telegram Passport element containing the user’s driver license
PassportElementTypeEmailAddress
A Telegram Passport element containing the user’s email address
PassportElementTypeIdentityCard
A Telegram Passport element containing the user’s identity card
PassportElementTypeInternalPassport
A Telegram Passport element containing the user’s internal passport
PassportElementTypePassport
A Telegram Passport element containing the user’s passport
PassportElementTypePassportRegistration
A Telegram Passport element containing the registration page of the user’s passport
PassportElementTypePersonalDetails
A Telegram Passport element containing the user’s personal details
PassportElementTypePhoneNumber
A Telegram Passport element containing the user’s phone number
PassportElementTypeRentalAgreement
A Telegram Passport element containing the user’s rental agreement
PassportElementTypeTemporaryRegistration
A Telegram Passport element containing the user’s temporary registration
PassportElementTypeUtilityBill
A Telegram Passport element containing the user’s utility bill
PassportElementUtilityBill
A Telegram Passport element containing the user’s utility bill
PassportElements
Contains information about saved Telegram Passport elements
PassportRequiredElement
Contains a description of the required Telegram Passport element that was requested by a service
PassportSuitableElement
Contains information about a Telegram Passport element that was requested by a service
PasswordState
Represents the current state of 2-step verification
PaymentForm
Contains information about an invoice payment form
PaymentReceipt
Contains information about a successful payment
PaymentResult
Contains the result of a payment request
PaymentsProviderStripe
Stripe payment provider
PersonalDetails
Contains the user’s personal details
PersonalDocument
A personal document, containing some information about a user
Photo
Describes a photo
PhotoSize
Photo description
ProfilePhoto
Describes a user profile photo
Proxies
Represents a list of proxy servers
Proxy
Contains information about a proxy server
ProxyTypeHttp
A HTTP transparent proxy server
ProxyTypeMtproto
An MTProto proxy server
ProxyTypeSocks5
A SOCKS5 proxy server
PublicMessageLink
Contains a public HTTPS link to a message in a public supergroup or channel
RecoveryEmailAddress
Contains information about the current recovery email address
RemoteFile
Represents a remote file
ReplyMarkupForceReply
Instructs clients to force a reply to this message
ReplyMarkupInlineKeyboard
Contains an inline keyboard layout
ReplyMarkupRemoveKeyboard
Instructs clients to remove the keyboard once this message has been received. This kind of keyboard can’t be received in an incoming message; instead, UpdateChatReplyMarkup with message_id == 0 will be sent
ReplyMarkupShowKeyboard
Contains a custom keyboard layout to quickly reply to bots
RichTextBold
A bold rich text
RichTextEmailAddress
A rich text email link
RichTextFixed
A fixed-width rich text
RichTextItalic
An italicized rich text
RichTextPlain
A plain text
RichTextStrikethrough
A strike-through rich text
RichTextUnderline
An underlined rich text
RichTextUrl
A rich text URL link
RichTexts
A concatenation of rich texts
SavedCredentials
Contains information about saved card credentials
ScopeNotificationSettings
Contains information about notification settings for several chats
SearchMessagesFilterAnimation
Returns only animation messages
SearchMessagesFilterAudio
Returns only audio messages
SearchMessagesFilterCall
Returns only call messages
SearchMessagesFilterChatPhoto
Returns only messages containing chat photos
SearchMessagesFilterDocument
Returns only document messages
SearchMessagesFilterEmpty
Returns all found messages, no filter is applied
SearchMessagesFilterMention
Returns only messages with mentions of the current user, or messages that are replies to their messages
SearchMessagesFilterMissedCall
Returns only incoming call messages with missed/declined discard reasons
SearchMessagesFilterPhoto
Returns only photo messages
SearchMessagesFilterPhotoAndVideo
Returns only photo and video messages
SearchMessagesFilterUnreadMention
Returns only messages with unread mentions of the current user or messages that are replies to their messages. When using this filter the results can’t be additionally filtered by a query or by the sending user
SearchMessagesFilterUrl
Returns only messages containing URLs
SearchMessagesFilterVideo
Returns only video messages
SearchMessagesFilterVideoNote
Returns only video note messages
SearchMessagesFilterVoiceAndVideoNote
Returns only voice and video note messages
SearchMessagesFilterVoiceNote
Returns only voice note messages
Seconds
Contains a value representing a number of seconds
SecretChat
Represents a secret chat
SecretChatStateClosed
The secret chat is closed
SecretChatStatePending
The secret chat is not yet created; waiting for the other user to get online
SecretChatStateReady
The secret chat is ready to use
Session
Contains information about one session in a Telegram application used by the current user
Sessions
Contains a list of sessions
ShippingOption
One shipping option
Sticker
Describes a sticker
StickerEmojis
Represents a list of all emoji corresponding to a sticker in a sticker set. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object
StickerSet
Represents a sticker set
StickerSetInfo
Represents short information about a sticker set
StickerSets
Represents a list of sticker sets
Stickers
Represents a list of stickers
StorageStatistics
Contains the exact storage usage statistics split by chats and file type
StorageStatisticsByChat
Contains the storage usage statistics for a specific chat
StorageStatisticsByFileType
Contains the storage usage statistics for a specific file type
StorageStatisticsFast
Contains approximate storage usage statistics, excluding files of unknown file type
Supergroup
Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers
SupergroupFullInfo
Contains full information about a supergroup or channel
SupergroupMembersFilterAdministrators
Returns the creator and administrators
SupergroupMembersFilterBanned
Returns users banned from the supergroup or channel; can be used only by administrators
SupergroupMembersFilterBots
Returns bot members of the supergroup or channel
SupergroupMembersFilterRecent
Returns recently active users in reverse chronological order
SupergroupMembersFilterRestricted
Returns restricted supergroup members; can be used only by administrators
SupergroupMembersFilterSearch
Used to search for supergroup or channel members via a (string) query
TMeUrl
Represents a URL linking to an internal Telegram entity
TMeUrlTypeChatInvite
A chat invite link
TMeUrlTypeStickerSet
A URL linking to a sticker set
TMeUrlTypeSupergroup
A URL linking to a public supergroup or channel
TMeUrlTypeUser
A URL linking to a user
TMeUrls
Contains a list of t.me URLs
TdlibParameters
Contains parameters for TDLib initialization
TemporaryPasswordState
Returns information about the availability of a temporary password, which can be used for payments
TermsOfService
Contains Telegram terms of service
TestBytes
A simple object containing a sequence of bytes; for testing only
TestInt
A simple object containing a number; for testing only
TestString
A simple object containing a string; for testing only
TestVectorInt
A simple object containing a vector of numbers; for testing only
TestVectorIntObject
A simple object containing a vector of objects that hold a number; for testing only
TestVectorString
A simple object containing a vector of strings; for testing only
TestVectorStringObject
A simple object containing a vector of objects that hold a string; for testing only
Text
Contains some text
TextEntities
Contains a list of text entities
TextEntity
Represents a part of the text that needs to be formatted in some unusual way
TextEntityTypeBold
A bold text
TextEntityTypeBotCommand
A bot command, beginning with “/”. This shouldn’t be highlighted if there are no bots in the chat
TextEntityTypeCashtag
A cashtag text, beginning with “$” and consisting of capital english letters (i.e. “$USD”)
TextEntityTypeCode
Text that must be formatted as if inside a code HTML tag
TextEntityTypeEmailAddress
An email address
TextEntityTypeHashtag
A hashtag text, beginning with “#”
TextEntityTypeItalic
An italic text
TextEntityTypeMention
A mention of a user by their username
TextEntityTypeMentionName
A text shows instead of a raw mention of the user (e.g., when the user has no username)
TextEntityTypePhoneNumber
A phone number
TextEntityTypePre
Text that must be formatted as if inside a pre HTML tag
TextEntityTypePreCode
Text that must be formatted as if inside pre, and code HTML tags
TextEntityTypeTextUrl
A text description shown instead of a raw URL
TextEntityTypeUrl
An HTTP URL
TextParseModeHTML
The text should be parsed in HTML-style
TextParseModeMarkdown
The text should be parsed in markdown-style
TopChatCategoryBots
A category containing frequently used private chats with bot users
TopChatCategoryCalls
A category containing frequently used chats used for calls
TopChatCategoryChannels
A category containing frequently used channels
TopChatCategoryGroups
A category containing frequently used basic groups and supergroups
TopChatCategoryInlineBots
A category containing frequently used chats with inline bots sorted by their usage in inline mode
TopChatCategoryUsers
A category containing frequently used private chats with non-bot users
UpdateAuthorizationState
The user authorization state has changed
UpdateBasicGroup
Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the client
UpdateBasicGroupFullInfo
Some data from basicGroupFullInfo has been changed
UpdateCall
New call was created or information about a call was updated
UpdateChatDefaultDisableNotification
The value of the default disable_notification parameter, used when a message is sent to the chat, was changed
UpdateChatDraftMessage
A chat draft has changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the content of the draft, this update shouldn’t be applied
UpdateChatIsMarkedAsUnread
A chat was marked as unread or was read
UpdateChatIsPinned
A chat was pinned or unpinned
UpdateChatIsSponsored
A chat’s is_sponsored field has changed
UpdateChatLastMessage
The last message of a chat was changed. If last_message is null then the last message in the chat became unknown. Some new unknown messages might be added to the chat in this case
UpdateChatNotificationSettings
Notification settings for a chat were changed
UpdateChatOrder
The order of the chat in the chats list has changed. Instead of this update updateChatLastMessage, updateChatIsPinned or updateChatDraftMessage might be sent
UpdateChatPhoto
A chat photo was changed
UpdateChatReadInbox
Incoming messages were read or number of unread messages has been changed
UpdateChatReadOutbox
Outgoing messages were read
UpdateChatReplyMarkup
The default chat reply markup was changed. Can occur because new messages with reply markup were received or because an old reply markup was hidden by the user
UpdateChatTitle
The title of a chat was changed
UpdateChatUnreadMentionCount
The chat unread_mention_count has changed
UpdateConnectionState
The connection state has changed
UpdateDeleteMessages
Some messages were deleted
UpdateFavoriteStickers
The list of favorite stickers was updated
UpdateFile
Information about a file was updated
UpdateFileGenerationStart
The file generation process needs to be started by the client
UpdateFileGenerationStop
File generation is no longer needed
UpdateInstalledStickerSets
The list of installed sticker sets was updated
UpdateLanguagePackStrings
Some language pack strings have been updated
UpdateMessageContent
The message content has changed
UpdateMessageContentOpened
The message content was opened. Updates voice note messages to “listened”, video note messages to “viewed” and starts the TTL timer for self-destructing messages
UpdateMessageEdited
A message was edited. Changes in the message content will come in a separate updateMessageContent
UpdateMessageMentionRead
A message with an unread mention was read
UpdateMessageSendAcknowledged
A request to send a message has reached the Telegram server. This doesn’t mean that the message will be sent successfully or even that the send message request will be processed. This update will be sent only if the option “use_quick_ack” is set to true. This update may be sent multiple times for the same message
UpdateMessageSendFailed
A message failed to send. Be aware that some messages being sent can be irrecoverably deleted, in which case updateDeleteMessages will be received instead of this update
UpdateMessageSendSucceeded
A message has been successfully sent
UpdateMessageViews
The view count of the message has changed
UpdateNewCallbackQuery
A new incoming callback query; for bots only
UpdateNewChat
A new chat has been loaded/created. This update is guaranteed to come before the chat identifier is returned to the client. The chat field changes will be reported through separate updates
UpdateNewChosenInlineResult
The user has chosen a result of an inline query; for bots only
UpdateNewCustomEvent
A new incoming event; for bots only
UpdateNewCustomQuery
A new incoming query; for bots only
UpdateNewInlineCallbackQuery
A new incoming callback query from a message sent via a bot; for bots only
UpdateNewInlineQuery
A new incoming inline query; for bots only
UpdateNewMessage
A new message was received; can also be an outgoing message
UpdateNewPreCheckoutQuery
A new incoming pre-checkout query; for bots only. Contains full information about a checkout
UpdateNewShippingQuery
A new incoming shipping query; for bots only. Only for invoices with flexible price
UpdateOption
An option changed its value
UpdateRecentStickers
The list of recently used stickers was updated
UpdateSavedAnimations
The list of saved animations was updated
UpdateScopeNotificationSettings
Notification settings for some type of chats were updated
UpdateSecretChat
Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the client
UpdateServiceNotification
Service notification from the server. Upon receiving this the client must show a popup with the content of the notification
UpdateSupergroup
Some data of a supergroup or a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the client
UpdateSupergroupFullInfo
Some data from supergroupFullInfo has been changed
UpdateTermsOfService
New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method should be called with the reason “Decline ToS update”
UpdateTrendingStickerSets
The list of trending sticker sets was updated or some of them were viewed
UpdateUnreadChatCount
Number of unread chats, i.e. with unread messages or marked as unread, has changed. This update is sent only if a message database is used
UpdateUnreadMessageCount
Number of unread messages has changed. This update is sent only if a message database is used
UpdateUser
Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the client
UpdateUserChatAction
User activity in the chat has changed
UpdateUserFullInfo
Some data from userFullInfo has been changed
UpdateUserPrivacySettingRules
Some privacy setting rules have been changed
UpdateUserStatus
The user went online or offline
User
Represents a user
UserFullInfo
Contains full information about a user (except the full list of profile photos)
UserPrivacySettingAllowCalls
A privacy setting for managing whether the user can be called
UserPrivacySettingAllowChatInvites
A privacy setting for managing whether the user can be invited to chats
UserPrivacySettingRuleAllowAll
A rule to allow all users to do something
UserPrivacySettingRuleAllowContacts
A rule to allow all of a user’s contacts to do something
UserPrivacySettingRuleAllowUsers
A rule to allow certain specified users to do something
UserPrivacySettingRuleRestrictAll
A rule to restrict all users from doing something
UserPrivacySettingRuleRestrictContacts
A rule to restrict all contacts of a user from doing something
UserPrivacySettingRuleRestrictUsers
A rule to restrict all specified users from doing something
UserPrivacySettingRules
A list of privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting for a given user. If no rule matches, the action is not allowed
UserPrivacySettingShowStatus
A privacy setting for managing whether the user’s online status is visible
UserProfilePhotos
Contains part of the list of user photos
UserStatusEmpty
The user status was never changed
UserStatusLastMonth
The user is offline, but was online last month
UserStatusLastWeek
The user is offline, but was online last week
UserStatusOffline
The user is offline
UserStatusOnline
The user is online
UserStatusRecently
The user was online recently
UserTypeBot
A bot (see https://core.telegram.org/bots)
UserTypeDeleted
A deleted user or deleted bot. No information on the user besides the user_id is available. It is not possible to perform any active actions on this type of user
UserTypeRegular
A regular user
UserTypeUnknown
No information on the user besides the user_id 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
Users
Represents a list of users
ValidatedOrderInfo
Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options
Venue
Describes a venue
Video
Describes a video file
VideoNote
Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format
VoiceNote
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
Wallpaper
Contains information about a wallpaper
Wallpapers
Contains a list of wallpapers
WebPage
Describes a web page preview
WebPageInstantView
Describes an instant view page for a web page

Enums§

AuthenticationCodeType
AuthorizationState
CallDiscardReason
CallState
CallbackQueryPayload
ChatAction
ChatEventAction
ChatMemberStatus
ChatMembersFilter
ChatReportReason
ChatType
CheckChatUsernameResult
ConnectionState
DeviceToken
FileType
InlineKeyboardButtonType
InlineQueryResult
InputCredentials
InputFile
InputInlineQueryResult
InputMessageContent
InputPassportElement
InputPassportElementErrorSource
KeyboardButtonType
LanguagePackStringValue
LinkState
MaskPoint
MessageContent
MessageForwardInfo
MessageSendingState
NetworkStatisticsEntry
NetworkType
NotificationSettingsScope
OptionValue
PageBlock
PassportElement
PassportElementErrorSource
PassportElementType
ProxyType
ReplyMarkup
RichText
SearchMessagesFilter
SecretChatState
SupergroupMembersFilter
TMeUrlType
TextEntityType
TextParseMode
TopChatCategory
Update
UserPrivacySetting
UserPrivacySettingRule
UserStatus
UserType