Module tdlib_types::types
source · Structs
Contains information about the period of inactivity after which the current user’s account will automatically be deleted
Describes an address
Describes an animation file. The animation must be encoded in GIF or MPEG4 format
Represents a list of animations
Describes an audio file. Audio is usually in MP3 format
Information about the authentication code that was sent
An authentication code is delivered via a phone call to the specified phone number
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
An authentication code is delivered via an SMS message to the specified phone number
An authentication code is delivered via a private Telegram message, which can be viewed in another client
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
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
The user is currently logging out
The user has been successfully authorized. TDLib is now ready to answer queries
TDLib needs the user’s authentication code to finalize authorization
TDLib needs an encryption key to decrypt the local database
The user has been authorized, but needs to enter a password to start using the application
TDLib needs the user’s phone number to authorize
TDLib needs TdlibParameters for initialization
Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)
Contains full information about a basic group
Represents commands supported by a bot
Provides information about a bot and its supported commands
Describes a call
Describes the address of UDP reflectors
The call was ended before the conversation started. It was declined by the other party
The call was ended during the conversation because the users were disconnected
The call wasn’t discarded, or the reason is unknown
The call was ended because one of the parties hung up
The call was ended before the conversation started. It was cancelled by the caller or missed by the other party
Contains the call identifier
Specifies the supported call protocols
The call has ended successfully
The call has ended with an error
The call has been answered and encryption keys are being exchanged
The call is hanging up after discardCall has been called
The call is pending, waiting to be accepted by a user
The call is ready to use
Contains a bot’s answer to a callback query
The payload from a general callback button
The payload from a game callback button
A chat. (Can be a private chat, basic group, supergroup, or secret chat)
The user has cancelled the previous action
The user is picking a contact to send
The user is picking a location or venue to send
The user is recording a video
The user is recording a video note
The user is recording a voice note
The user has started to play a game
The user is typing a message
The user is uploading a document
The user is uploading a photo
The user is uploading a video
The user is uploading a video note
The user is uploading a voice note
Represents a chat event
The chat description was changed
The anyone_can_invite setting of a supergroup chat was toggled
The is_all_history_available setting of a supergroup was toggled
Represents a set of filters used to obtain a chat event log
A new chat member was invited
A new member joined the chat
A member left the chat
A chat member has gained/lost administrator status, or the list of their administrator privileges has changed
A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed
A message was deleted
A message was edited
A message was pinned
A message was unpinned
The chat photo was changed
The sign_messages setting of a channel was toggled
The supergroup sticker set was changed
The chat title was changed
The chat username was changed
Contains a list of chat events
Contains a chat invite link
Contains information about a chat invite link
A user with information about joining/leaving a chat
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
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
The user is the creator of a chat and has all the administrator privileges
The user is not a chat member
The user is a member of a chat, without any additional privileges or restrictions
The user is under certain restrictions in the chat. Not supported in basic groups and channels
Contains a list of chat members
Returns the creator and administrators
Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel
Returns bot members of the chat
Returns all chat members, including restricted chat members
Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup
Contains information about notification settings for a chat
Describes the photo of a chat
The chat contains copyrighted content
A custom reason provided by the user
The chat contains pornographic messages
The chat contains spam messages
The chat promotes violence
Contains information about the availability of the “Report spam” action for a chat
A basic group (i.e., a chat with 0-200 other users)
An ordinary chat with a user
A secret chat with a user
A supergroup (i.e. a chat with up to GetOption(“supergroup_max_size”) other users), or channel (with unlimited members)
Represents a list of chats
The username can be set
The user has too much public chats, one of them should be made private first
The user can’t be a member of a public supergroup
The username is invalid
The username is occupied
Contains information about one website the current user is logged in with Telegram
Contains a list of websites the current user is logged in with Telegram
Currently establishing a connection to the Telegram servers
Currently establishing a connection with a proxy server
There is a working connection to the Telegram servers
Downloading data received while the client was offline
Currently waiting for the network to become available. Use SetNetworkType to change the available network type
Describes a user contact
Contains a counter
Contains the result of a custom request
Represents a date according to the Gregorian calendar
File with the date it was uploaded
Contains information about a tg:// deep link
A token for Apple Push Notification service
A token for Apple Push Notification service VoIP notifications
A token for BlackBerry Push Service
A token for Google Cloud Messaging
A token for Microsoft Push Notification Service
A token for Microsoft Push Notification Service VoIP channel
A token for Simple Push API for Firefox OS
A token for Tizen Push Service
A token for Ubuntu Push Client service
A token for web Push API
A token for Windows Push Notification Services
Describes a document of any type
Contains information about a message draft
Information about the email address authentication code that was sent
Contains encrypted Telegram Passport data credentials
Contains information about an encrypted Telegram Passport element; for bots only
An object of this type can be returned on every function call, in case of an error
Represents a file
The file is an animation
The file is an audio file
The file is a document
The data is not a file
The file is a photo
The file is a profile photo
The file was sent to a secret chat (the file type is not known to the server)
The file is a thumbnail of a file from a secret chat
The file is a file from Secure storage used for storing Telegram Passport files
The file is a sticker
The file is a thumbnail of another file
The file type is not yet known
The file is a video
The file is a video note
The file is a voice note
The file is a wallpaper
A text with some entities
Contains a list of messages found by a search
Describes a game
Contains one row of the game high score table
Contains a list of game high scores
Contains a list of hashtags
An identity document
Represents the result of an ImportContacts request
Represents a single button in an inline keyboard
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
A button that sends a special callback query to a bot
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
A button that forces an inline query to the bot to be inserted in the input field
A button that opens a specified URL
Represents an animation file
Represents a link to an article or web page
Represents an audio file
Represents a user contact
Represents a document
Represents information about a game
Represents a point on the map
Represents a photo
Represents a sticker
Represents information about a venue
Represents a video
Represents a voice note
Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query
Applies if a user enters new credentials using Android Pay
Applies if a user enters new credentials using Apple Pay
Applies if a user enters new credentials on a payment provider website
Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password
A file generated by the client
A file defined by its unique ID
A file defined by a local path
A file defined by its remote ID
An identity document to be saved to Telegram Passport
Represents a link to an animated GIF
Represents a link to an animated (i.e. without sound) H.264/MPEG-4 AVC video
Represents a link to an article or web page
Represents a link to an MP3 audio file
Represents a user contact
Represents a link to a file
Represents a game
Represents a point on the map
Represents link to a JPEG image
Represents a link to a WEBP sticker
Represents information about a venue
Represents a link to a page containing an embedded video player or a video file
Represents a link to an opus-encoded audio file within an OGG container, single channel audio
An animation message (GIF-style).
An audio message
A message containing a user contact
A document message (general file)
A forwarded message
A message with a game; not supported for channels or secret chats
A message with an invoice; can be used only by bots and only in private chats
A message with a location
A photo message
A sticker message
A text message
A message with information about a venue
A video message
A video note message
A voice note message
A Telegram Passport element to be saved containing the user’s address
A Telegram Passport element to be saved containing the user’s bank statement
A Telegram Passport element to be saved containing the user’s driver license
A Telegram Passport element to be saved containing the user’s email address
Contains the description of an error in a Telegram Passport element; for bots only
A data field contains an error. The error is considered resolved when the field’s value changes
The file contains an error. The error is considered resolved when the file changes
The list of attached files contains an error. The error is considered resolved when the file list changes
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
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
The selfie contains an error. The error is considered resolved when the file with the selfie changes
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
The translation of the document contains an error. The error is considered resolved when the list of files changes
The element contains an error in an unspecified place. The error will be considered resolved when new data is added
A Telegram Passport element to be saved containing the user’s identity card
A Telegram Passport element to be saved containing the user’s internal passport
A Telegram Passport element to be saved containing the user’s passport
A Telegram Passport element to be saved containing the user’s passport registration
A Telegram Passport element to be saved containing the user’s personal details
A Telegram Passport element to be saved containing the user’s phone number
A Telegram Passport element to be saved containing the user’s rental agreement
A Telegram Passport element to be saved containing the user’s temporary registration
A Telegram Passport element to be saved containing the user’s utility bill
A personal document to be saved to Telegram Passport
Describes a sticker that should be added to a sticker set
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
Product invoice
Represents a single button in a bot keyboard
A button that sends the user’s location when pressed; available only in private chats
A button that sends the user’s phone number when pressed; available only in private chats
A simple button, with text that should be sent when the button is pressed
Portion of the price of a product (e.g., “delivery cost”, “tax amount”)
Contains information about a language pack
Represents one language pack string
A deleted language pack string, the value should be taken from the built-in english language pack
An ordinary language pack string
A language pack string which has different forms based on the number of some object it mentions
Contains a list of language pack strings
The phone number of user A has been saved to the contacts list of user B
The phone number of user A is known but that number has not been saved to the contacts list of user B
The phone number of user A is not known to user B
Represents a local file
Contains information about the current localization target
Describes a location on planet Earth
A mask should be placed relatively to the chin
A mask should be placed relatively to the eyes
A mask should be placed relatively to the forehead
A mask should be placed relatively to the mouth
Position on a photo where a mask should be placed
Describes a message
An animation message (GIF-style).
An audio message
A newly created basic group
A message with information about an ended call
New chat members were added
An updated chat photo
An updated chat title
A chat member was deleted
A deleted chat photo
A new member joined the chat by invite link
The TTL (Time To Live) setting messages in a secret chat has been changed
A supergroup has been created from a basic group
A basic group was upgraded to a supergroup and was deactivated as the result
A message with a user contact
A contact has registered with Telegram
A non-standard action has happened in the chat
A document message (general file)
An expired photo message (self-destructed after TTL has elapsed)
An expired video message (self-destructed after TTL has elapsed)
The message was originally written by a known user
The message was originally a post in a channel
A message with a game
A new high score was achieved in a game
A message with an invoice from a bot
A message with a location
Telegram Passport data has been received; for bots only
Telegram Passport data has been sent
A payment has been completed
A payment has been completed; for bots only
A photo message
A message has been pinned
A screenshot of a message in the chat has been taken
The message failed to be sent
The message is being sent now, but has not yet been delivered to the server
A sticker message
A newly created supergroup or channel
A text message
Message content that is not supported by the client
A message with information about a venue
A video message
A video note message
A voice note message
The current user has connected a website by logging in using Telegram Login Widget on it
Contains a list of messages
A full list of available network statistic entries
Contains information about the total amount of data that was used for calls
Contains information about the total amount of data that was used to send and receive files
A mobile network
A mobile roaming network
The network is not available
A different network type (e.g., Ethernet network)
A Wi-Fi network
Notification settings applied to all basic groups, supergroups and channels when the corresponding chat setting has a default value
Notification settings applied to all private and secret chats when the corresponding chat setting has a default value
An object of this type is returned on a successful function call for certain functions
Boolean option
An unknown option or an option which has a default value
An integer option
A string option
Order information
An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor
An animation
An audio file
The author and publishing date of a page
A block quote
A link to a chat
A collage
A page cover
An empty block separating a page
An embedded web page
An embedded post
The footer of a page
A header
A list of texts
A text paragraph
A photo
A preformatted text paragraph
A pull quote
A slideshow
A subheader
The subtitle of a page
The title of a page
A video
Contains information about a Telegram Passport authorization form that was requested
A Telegram Passport element containing the user’s address
A Telegram Passport element containing the user’s bank statement
A Telegram Passport element containing the user’s driver license
A Telegram Passport element containing the user’s email address
Contains the description of an error in a Telegram Passport element
One of the data fields contains an error. The error will be considered resolved when the value of the field changes
The file contains an error. The error will be considered resolved when the file changes
The list of attached files contains an error. The error will be considered resolved when the list of files changes
The front side of the document contains an error. The error will be considered resolved when the file with the front side changes
The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes
The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes
One of files with the translation of the document contains an error. The error will be considered resolved when the file changes
The translation of the document contains an error. The error will be considered resolved when the list of translation files changes
The element contains an error in an unspecified place. The error will be considered resolved when new data is added
A Telegram Passport element containing the user’s identity card
A Telegram Passport element containing the user’s internal passport
A Telegram Passport element containing the user’s passport
A Telegram Passport element containing the user’s passport registration pages
A Telegram Passport element containing the user’s personal details
A Telegram Passport element containing the user’s phone number
A Telegram Passport element containing the user’s rental agreement
A Telegram Passport element containing the user’s temporary registration
A Telegram Passport element containing the user’s address
A Telegram Passport element containing the user’s bank statement
A Telegram Passport element containing the user’s driver license
A Telegram Passport element containing the user’s email address
A Telegram Passport element containing the user’s identity card
A Telegram Passport element containing the user’s internal passport
A Telegram Passport element containing the user’s passport
A Telegram Passport element containing the registration page of the user’s passport
A Telegram Passport element containing the user’s personal details
A Telegram Passport element containing the user’s phone number
A Telegram Passport element containing the user’s rental agreement
A Telegram Passport element containing the user’s temporary registration
A Telegram Passport element containing the user’s utility bill
A Telegram Passport element containing the user’s utility bill
Contains information about saved Telegram Passport elements
Contains a description of the required Telegram Passport element that was requested by a service
Contains information about a Telegram Passport element that was requested by a service
Represents the current state of 2-step verification
Contains information about an invoice payment form
Contains information about a successful payment
Contains the result of a payment request
Stripe payment provider
Contains the user’s personal details
A personal document, containing some information about a user
Describes a photo
Photo description
Describes a user profile photo
Represents a list of proxy servers
Contains information about a proxy server
A HTTP transparent proxy server
An MTProto proxy server
A SOCKS5 proxy server
Contains a public HTTPS link to a message in a public supergroup or channel
Contains information about the current recovery email address
Represents a remote file
Instructs clients to force a reply to this message
Contains an inline keyboard layout
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
Contains a custom keyboard layout to quickly reply to bots
A bold rich text
A rich text email link
A fixed-width rich text
An italicized rich text
A plain text
A strike-through rich text
An underlined rich text
A rich text URL link
A concatenation of rich texts
Contains information about saved card credentials
Contains information about notification settings for several chats
Returns only animation messages
Returns only audio messages
Returns only call messages
Returns only messages containing chat photos
Returns only document messages
Returns all found messages, no filter is applied
Returns only messages with mentions of the current user, or messages that are replies to their messages
Returns only incoming call messages with missed/declined discard reasons
Returns only photo messages
Returns only photo and video messages
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
Returns only messages containing URLs
Returns only video messages
Returns only video note messages
Returns only voice and video note messages
Returns only voice note messages
Contains a value representing a number of seconds
Represents a secret chat
The secret chat is closed
The secret chat is not yet created; waiting for the other user to get online
The secret chat is ready to use
Contains information about one session in a Telegram application used by the current user
Contains a list of sessions
One shipping option
Describes a sticker
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
Represents a sticker set
Represents short information about a sticker set
Represents a list of sticker sets
Represents a list of stickers
Contains the exact storage usage statistics split by chats and file type
Contains the storage usage statistics for a specific chat
Contains the storage usage statistics for a specific file type
Contains approximate storage usage statistics, excluding files of unknown file type
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
Contains full information about a supergroup or channel
Returns the creator and administrators
Returns users banned from the supergroup or channel; can be used only by administrators
Returns bot members of the supergroup or channel
Returns recently active users in reverse chronological order
Returns restricted supergroup members; can be used only by administrators
Used to search for supergroup or channel members via a (string) query
Represents a URL linking to an internal Telegram entity
A chat invite link
A URL linking to a sticker set
A URL linking to a public supergroup or channel
A URL linking to a user
Contains a list of t.me URLs
Contains parameters for TDLib initialization
Returns information about the availability of a temporary password, which can be used for payments
Contains Telegram terms of service
A simple object containing a sequence of bytes; for testing only
A simple object containing a number; for testing only
A simple object containing a string; for testing only
A simple object containing a vector of numbers; for testing only
A simple object containing a vector of objects that hold a number; for testing only
A simple object containing a vector of strings; for testing only
A simple object containing a vector of objects that hold a string; for testing only
Contains some text
Contains a list of text entities
Represents a part of the text that needs to be formatted in some unusual way
A bold text
A bot command, beginning with “/”. This shouldn’t be highlighted if there are no bots in the chat
A cashtag text, beginning with “$” and consisting of capital english letters (i.e. “$USD”)
Text that must be formatted as if inside a code HTML tag
An email address
A hashtag text, beginning with “#”
An italic text
A mention of a user by their username
A text shows instead of a raw mention of the user (e.g., when the user has no username)
A phone number
Text that must be formatted as if inside a pre HTML tag
Text that must be formatted as if inside pre, and code HTML tags
A text description shown instead of a raw URL
An HTTP URL
The text should be parsed in HTML-style
The text should be parsed in markdown-style
A category containing frequently used private chats with bot users
A category containing frequently used chats used for calls
A category containing frequently used channels
A category containing frequently used basic groups and supergroups
A category containing frequently used chats with inline bots sorted by their usage in inline mode
A category containing frequently used private chats with non-bot users
The user authorization state has changed
Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the client
Some data from basicGroupFullInfo has been changed
New call was created or information about a call was updated
The value of the default disable_notification parameter, used when a message is sent to the chat, was changed
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
A chat was marked as unread or was read
A chat was pinned or unpinned
A chat’s is_sponsored field has changed
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
Notification settings for a chat were changed
The order of the chat in the chats list has changed. Instead of this update updateChatLastMessage, updateChatIsPinned or updateChatDraftMessage might be sent
A chat photo was changed
Incoming messages were read or number of unread messages has been changed
Outgoing messages were read
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
The title of a chat was changed
The chat unread_mention_count has changed
The connection state has changed
Some messages were deleted
The list of favorite stickers was updated
Information about a file was updated
The file generation process needs to be started by the client
File generation is no longer needed
The list of installed sticker sets was updated
Some language pack strings have been updated
The message content has changed
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
A message was edited. Changes in the message content will come in a separate updateMessageContent
A message with an unread mention was read
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
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
A message has been successfully sent
The view count of the message has changed
A new incoming callback query; for bots only
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
The user has chosen a result of an inline query; for bots only
A new incoming event; for bots only
A new incoming query; for bots only
A new incoming callback query from a message sent via a bot; for bots only
A new incoming inline query; for bots only
A new message was received; can also be an outgoing message
A new incoming pre-checkout query; for bots only. Contains full information about a checkout
A new incoming shipping query; for bots only. Only for invoices with flexible price
An option changed its value
The list of recently used stickers was updated
The list of saved animations was updated
Notification settings for some type of chats were updated
Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the client
Service notification from the server. Upon receiving this the client must show a popup with the content of the notification
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
Some data from supergroupFullInfo has been changed
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”
The list of trending sticker sets was updated or some of them were viewed
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
Number of unread messages has changed. This update is sent only if a message database is used
Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the client
User activity in the chat has changed
Some data from userFullInfo has been changed
Some privacy setting rules have been changed
The user went online or offline
Represents a user
Contains full information about a user (except the full list of profile photos)
A privacy setting for managing whether the user can be called
A privacy setting for managing whether the user can be invited to chats
A rule to allow all users to do something
A rule to allow all of a user’s contacts to do something
A rule to allow certain specified users to do something
A rule to restrict all users from doing something
A rule to restrict all contacts of a user from doing something
A rule to restrict all specified users from doing something
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
A privacy setting for managing whether the user’s online status is visible
Contains part of the list of user photos
The user status was never changed
The user is offline, but was online last month
The user is offline, but was online last week
The user is offline
The user is online
The user was online recently
A bot (see https://core.telegram.org/bots)
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
A regular user
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
Represents a list of users
Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options
Describes a venue
Describes a video file
Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format
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
Contains information about a wallpaper
Contains a list of wallpapers
Describes a web page preview
Describes an instant view page for a web page