Structs
Accepts an incoming call
Accepts Telegram terms of services
Contains information about the period of inactivity after which the current user’s account will automatically be deleted
Adds a new member to a chat. Members can’t be added to private or secret chats
Adds multiple new members to a chat. Currently, this method is only available for supergroups and channels. This method can’t be used to join a chat. Members can’t be added to a channel if it has more than 200 members
Adds a chat to a chat list. A chat can’t be simultaneously in Main and Archive chat lists, so it is automatically removed from another one if needed
Adds a user to the contact list or edits an existing contact by their user identifier
Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization
Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list
Adds a local message to a chat. The message is persistent across application restarts only if the message database is used. Returns the added message
Adds a message to TDLib internal log. Can be called synchronously
Adds the specified data to data usage statistics. Can be called before authorization
Adds a proxy server for network requests. Can be called before authorization
Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list
Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, it will be removed from the list first
Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the list. If the animation was already in the list, it is removed first. Only non-secret video animations with MIME type “video/mp4” can be added to the list
Adds a new sticker to a set; for bots only. Returns the sticker set
Describes an address
Animated variant of a chat photo in MPEG4 format
Describes an animated representation of an emoji
Describes an animation file. The animation must be encoded in GIF or MPEG4 format
Represents a list of animations
Sets the result of a callback query; for bots only
Answers a custom query; for bots only
Sets the result of an inline query; for bots only
Sets the result of a pre-checkout query; for bots only
Sets the result of a shipping query; for bots only
Describes an audio file. Audio is usually in MP3 or M4A 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 canceled call to the specified phone number. The phone number that calls is the code that must be entered automatically
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
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 from another active session
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
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 authorize
TDLib needs an encryption key to decrypt the local database
The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link
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. Call setAuthenticationPhoneNumber to provide the phone number, or use requestQrCodeAuthentication, or checkAuthenticationBotToken for other authentication options
The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration
TDLib needs TdlibParameters for initialization
Contains auto-download settings
Contains auto-download settings presets for the current user
Describes a chat background
Describes a freeform gradient fill of a background
Describes a gradient fill of a background
Describes a solid fill of a background
A filled background
A PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user
A wallpaper in JPEG format
Contains a list of backgrounds
Bans a member in a chat. Members can’t be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first
Describes an action associated with a bank card number
Information about a bank card
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
Blocks an original sender of a message in the Replies chat
Represents a command supported by a bot
A scope covering all group and supergroup chat administrators
A scope covering all group and supergroup chats
A scope covering all private chats
A scope covering all members of a chat
A scope covering all administrators of a chat
A scope covering a member of a chat
A scope covering all users
Contains a list of bot commands
Describes a call
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 canceled by the caller or missed by the other party
Contains the call identifier
The speech was distorted
The video was distorted
The call ended unexpectedly
The user heard their own voice
The other side kept disappearing
The user heard background noise
The video was pixelated
The user couldn’t hear the other side
The other side couldn’t hear the user
Specifies the supported call protocols
Describes a server for relaying call data
A Telegram call reflector
A WebRTC server
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 for a general callback button
The payload for a callback button requiring password
The payload for a game callback button
Checks whether the current session can be used to transfer a chat ownership to another user
The session can be used
The 2-step verification needs to be enabled first
The 2-step verification was enabled recently, user needs to wait
The session was created recently, user needs to wait
Stops the downloading of a file. If a file has already been downloaded, does nothing
Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date > 0
Stops the uploading of a file. Supported only for files uploaded by using uploadFile. For other files the behavior is undefined
Changes imported contacts using the list of contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time
Changes the phone number of the user and sends an authentication code to the user’s new phone number. On success, returns information about the sent code
Installs/uninstalls or activates/archives a sticker set
A chat. (Can be a private chat, basic group, supergroup, or secret chat)
The chat is a private or secret chat and the other user can be added to the contact list using the method addContact
The chat is a recently created group chat to which new members can be invited
The chat is a private chat with an administrator of a chat to which the user sent join request
The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method toggleMessageSenderIsBlocked, or the other user can be added to the contact list using the method addContact
The chat can be reported as spam using the method reportChat with the reason chatReportReasonSpam
The chat is a location-based supergroup, which can be reported as having unrelated location using the method reportChat with the reason chatReportReasonUnrelatedLocation
The chat is a private or secret chat with a mutual contact and the user’s phone number can be shared with the other user using the method sharePhoneNumber
The user has canceled the previous action
The user is picking a contact to send
The user is picking a location or venue to send
The user is picking a sticker 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
The user is watching animations sent by the other party by clicking on an animated emoji
Contains information about a chat administrator
Represents a list of chat administrators
Represents a chat event
The chat description was changed
The has_protected_content setting of a channel was toggled
A revoked chat invite link was deleted
A chat invite link was edited
A chat invite link was revoked
The can_invite_users permission of a supergroup chat was toggled
The is_all_history_available setting of a supergroup was toggled
The linked chat of a supergroup was changed
The supergroup location was changed
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 new member joined the chat via an invite link
A new member was accepted to the chat by an administrator
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
The message TTL was changed
A message was unpinned
The chat permissions was changed
The chat photo was changed
A poll in a message was stopped
The sign_messages setting of a channel was toggled
The slow_mode_delay setting of a supergroup was changed
The supergroup sticker set was changed
The chat title was changed
The chat username was changed
A video chat was created
A video chat was ended
The mute_new_participants setting of a video chat was toggled
A video chat participant was muted or unmuted
A video chat participant volume level was changed
Contains a list of chat events
Represents a filter of user chats
Contains basic information about a chat filter
Contains a chat invite link
Describes a chat administrator with a number of active and revoked chat invite links
Contains a list of chat invite link counts
Contains information about a chat invite link
Describes a chat member joined a chat via an invite link
Contains a list of chat members joined a chat via an invite link
Contains a list of chat invite links
Describes a user that sent a join request and waits for administrator approval
Contains a list of requests to join a chat
Contains information about pending join requests for a chat
A list of chats usually located at the top of the main chat list. Unmuted chats are automatically moved from the Archive to the Main chat list when a new message arrives
A list of chats belonging to a chat filter
A main list of chats
Contains a list of chat lists
Represents a location to which a chat is connected
Describes a user or a chat as a member of another chat
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
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
The user is the owner of the chat and has all the administrator privileges
The user or the chat is not a chat member
The user is a member of the 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 owner 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 contacts of the user
Returns all chat members, including restricted chat members
Returns users which can be mentioned in the chat
Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup
Describes a chat located nearby
Contains information about notification settings for a chat
Describes actions that a user is allowed to take in a chat
Describes a chat or user profile photo
Contains basic information about the photo of a chat
Contains a list of chat or user profile photos
Describes a position of a chat in a chat list
The chat has child abuse related content
The chat contains copyrighted content
A custom reason provided by the user
The chat represents a fake account
The chat contains pornographic messages
The chat contains spam messages
The location-based chat is unrelated to its stated location
The chat promotes violence
The chat is sponsored by the user’s MTProxy server
The chat contains a public service announcement
Contains statistics about administrator actions done by a user
A detailed statistics about a channel chat
Contains statistics about number of new members invited by a user
Contains statistics about interactions with a message
Contains statistics about messages sent by a user
A detailed statistics about a supergroup chat
Describes a chat theme
A basic group (a chat with 0-200 other users)
An ordinary chat with a user
A secret chat with a user
A supergroup or channel (with unlimited members)
Represents a list of chats
Represents a list of chats located nearby
Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in
Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode
Checks the authentication password for correctness. Works only when the current authorization state is authorizationStateWaitPassword
Checks whether a password recovery code sent to an email address is valid. Works only when the current authorization state is authorizationStateWaitPassword
Checks the authentication code sent to confirm a new phone number of the user
Checks the validity of an invite link for a chat and returns information about the corresponding chat
Checks whether a username can be set for a chat
The username can be set
The user has too much chats with username, one of them must be made private first
The user can’t be a member of a public supergroup
The username is invalid
The username is occupied
Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached
Checks the database encryption key for correctness. Works only when the current authorization state is authorizationStateWaitEncryptionKey
Checks the email address verification code for Telegram Passport
Checks whether a 2-step verification password recovery code sent to an email address is valid
Checks phone number confirmation code
Checks the phone number verification code for Telegram Passport
Checks the 2-step verification recovery email address verification code
Checks whether a name can be used for a new sticker set
The name is invalid
The name is occupied
The name can be set
Removes potentially dangerous characters from the name of a file. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. Can be called synchronously
Clears draft messages in all chats
Clears all imported contacts, contact list remains unchanged
Clears the list of recently used stickers
Clears the list of recently found chats
Informs TDLib that a message with an animated emoji was clicked by the user. Returns a big animated sticker to be played or a 404 error if usual animation needs to be played
Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent. Can be called before initialization
Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed
Closes a secret chat, effectively transferring its state to secretChatStateClosed
Represents a closed vector path. The path begins at the end point of the last command
Confirms QR code authentication on another device. Returns created session on success
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 application 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 information about countries
Contains information about a country
Returns an existing chat corresponding to a known basic group
Creates a new call
Creates new chat filter. Returns information about the created chat filter
Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat
Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns the newly created chat
Creates a new secret chat. Returns the newly created chat
Creates a new sticker set. Returns the newly created sticker set
Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat
Returns an existing chat corresponding to a given user
Returns an existing chat corresponding to a known secret chat
Returns an existing chat corresponding to a known supergroup or channel
Creates a new temporary password for processing payments
Creates a video chat (a group call bound to a chat). Available only for basic groups, supergroups and channels; requires can_manage_video_chats rights
Contains the result of a custom request
Contains database statistics
Represents a date according to the Gregorian calendar
Represents a date range
File with the date it was uploaded
Contains information about a tg: deep link
Deletes the account of the current user, deleting all information associated with the user from the server. The phone number of the account can be used to create a new account. Can be called before authorization when the current authorization state is authorizationStateWaitPassword
Deletes all call messages
Deletes all revoked chat invite links created by a given chat administrator. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links
Deletes a chat along with all messages in the corresponding chat for all chat members; requires owner privileges. For group chats this will release the username and remove all members. Chats with more than 1000 members can’t be deleted using this method
Deletes existing chat filter
Deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat
Deletes all messages between the specified dates in a chat. Supported only for private chats and basic groups. Messages sent in the last 30 seconds will not be deleted
Deletes all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator privileges
Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a ForceReply reply markup has been used. UpdateChatReplyMarkup will be sent if the reply markup is changed
Deletes commands supported by the bot for the given user scope and language; for bots only
Deletes a file from the TDLib file cache
Deletes all information about a language pack in the current localization target. The language pack which is currently in use (including base language pack) or is being synchronized can’t be deleted. Can be called before authorization
Deletes messages
Deletes a Telegram Passport element
Deletes a profile photo
Deletes revoked chat invite links. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links
Deletes saved credentials for all payment provider bots
Deletes saved order info
Closes the TDLib instance, destroying all local data without a proper logout. The current user session will remain in the list of all active sessions. All local data will be destroyed. After the destruction completes updateAuthorizationState with authorizationStateClosed will be sent. Can be called before authorization
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 Firebase 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
A regular animated sticker
Animated stickers to be combined into a slot machine
Disables the currently enabled proxy. Can be called before authorization
Discards a call
Disconnects all websites from the current user’s Telegram account
Disconnects website from the current user’s Telegram account
Describes a document of any type
Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates
Contains information about a message draft
Edits existing chat filter. Returns information about the edited chat filter
Edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links
Edits information about a custom local language pack in the current localization target. Can be called before authorization
Edits the caption of an inline message sent via a bot; for bots only
Edits the content of a live location in an inline message sent via a bot; for bots only
Edits the content of a message with an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots only
Edits the reply markup of an inline message sent via a bot; for bots only
Edits the text of an inline text or game message sent via a bot; for bots only
Edits the message content caption. Returns the edited message after the edit is completed on the server side
Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side
Edits the content of a message with an animation, an audio, a document, a photo or a video, including message caption. If only the caption needs to be edited, use editMessageCaption instead. The media can’t be edited if the message was set to self-destruct or to a self-destructing media. The type of message content in an album can’t be changed with exception of replacing a photo with a video or vice versa. Returns the edited message after the edit is completed on the server side
Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side
Edits the time when a scheduled message will be sent. Scheduling state of all messages in the same album or forwarded together with the message will be also changed
Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on the server side
Edits an existing proxy server for network requests. Can be called before authorization
Information about the email address authentication code that was sent
Represents a list of emoji
Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization
Contains encrypted Telegram Passport data credentials
Contains information about an encrypted Telegram Passport element; for bots only
Ends a group call. Requires groupCall.can_be_managed
Ends recording of an active group call. Requires groupCall.can_be_managed group call flag
Ends screen sharing in a joined group call
An object of this type can be returned on every function call, in case of an error
Represents a file
Contains a part of 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 or a background pattern
Finishes the file generation
A text with some entities
Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can’t be forwarded, null will be returned instead of the message
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
Returns the period of inactivity after which the account of the current user will automatically be deleted
Returns all active live locations that need to be updated by the application. The list is persistent across application restarts only if the message database is used
Returns all active sessions of the current user
Returns all available Telegram Passport elements
Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji
Returns application config, provided by the server. Can be called before authorization
Returns the link for downloading official Telegram application to be used when the current user invites friends to Telegram
Returns a list of archived sticker sets
Returns a list of sticker sets attached to a file. Currently, only photos and videos can have attached sticker sets
Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state. Can be called before initialization
Returns auto-download settings presets for the current user
Constructs a persistent HTTP URL for a background
Returns backgrounds installed by the user
Returns information about a bank card
Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot
Returns full information about a basic group by its identifier
Returns users and chats that were blocked by the current user
Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires
Returns information about a message with the callback button that originated a callback query; for bots only
Returns information about a chat by its identifier, this is an offline request if the current user is not a bot
Returns a list of administrators of the chat with their custom titles
Returns list of message sender identifiers, which can be used to send messages in a chat
Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only for supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i. e., in order of decreasing event_id)
Returns information about a chat filter by its identifier
Returns default icon name for a filter. Can be called synchronously
Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. This is an offline request if only_local is true
Returns information about an invite link. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links
Returns list of chat administrators with number of their invite links. Requires owner privileges in the chat
Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links
Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links
Returns pending join requests in a chat
Returns chat lists to which the chat can be added. This is an offline request
Returns information about a single member of a chat
Returns the last message sent in a chat no later than the specified date
Returns information about the next messages of the specified type in the chat split by days. Returns the results in reverse chronological order. Can return partial result for the last returned day. Behavior of this method depends on the value of the option “utc_time_offset”
Returns approximate number of messages of the specified type in the chat
Returns list of chats with non-default notification settings
Returns information about a newest pinned message in the chat
Returns all scheduled messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id)
Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database
Returns sponsored message to be shown in a chat; for channel chats only. Returns a 404 error if there is no sponsored message in the chat
Returns detailed statistics about a chat. Currently, this method can be used only for supergroups and channels. Can be used only if supergroupFullInfo.can_get_statistics == true
Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats and updates processing instead to maintain chat lists in a consistent state
Returns the list of commands supported by the bot for the given user scope and language; for bots only
Returns all website where the current user used Telegram to log in
Returns all user contacts
Returns information about existing countries. Can be called before authorization
Uses the current IP address to find the current country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization
Returns a list of public chats of the specified type, owned by the user
Returns all updates needed to restore current TDLib state, i.e. all actual UpdateAuthorizationState/UpdateUser/UpdateNewChat and others. This is especially useful if TDLib is run in a separate process. Can be called before initialization
Returns database statistics
Returns information about a tg:// deep link. Use “tg://need_update_for_some_feature” or “tg:some_unsupported_feature” for testing. Returns a 404 error for unknown links. Can be called before authorization
Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation
Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed
Returns information about an action to be done when the current user clicks an external link. Don’t use this method for links from secret chats if web page preview is disabled in secret chats
Returns favorite stickers
Returns information about a file; this is an offline request
Returns file downloaded prefix size from a given offset, in bytes
Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. Can be called synchronously
Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. Can be called synchronously
Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots only
Returns information about a group call
Returns invite link to a video chat in a public chat
Returns a file with a segment of a group call stream in a modified OGG format for audio or MPEG-4 format for video
Returns a list of common group chats with a given user. Chats are sorted by their type and creation date
Returns the total number of imported contacts
Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error
Returns game high scores and some part of the high score table in the range of the specified user; for bots only
Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires
Returns a list of installed sticker sets
Returns information about the type of an internal link. Returns a 404 error if the link is not internal. Can be called before authorization
Converts a JsonValue object to corresponding JSON-serialized string. Can be called synchronously
Converts a JSON-serialized string to corresponding JsonValue object. Can be called synchronously
Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization
Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously
Returns strings from a language pack in the current localization target by their keys. Can be called before authorization
Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization
Returns information about currently used log stream for internal logging of TDLib. Can be called synchronously
Returns current verbosity level for a specified TDLib internal log tag. Can be called synchronously
Returns list of available TDLib internal log tags, for example, [“actor”, “binlog”, “connections”, “notifications”, “proxy”]. Can be called synchronously
Returns current verbosity level of the internal logging of TDLib. Can be called synchronously
Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button
Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button
Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded
Replaces text entities with Markdown formatting in a human-friendly format. Entities that can’t be represented in Markdown unambiguously are kept as is. Can be called synchronously
Returns the current user
Returns information about a message
Returns an HTML code for embedding the message. Available only for messages in supergroups and channels with a username
Returns information about a file with messages exported from another app
Returns a confirmation text to be shown to the user before starting message import
Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request
Returns information about a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage
Returns information about a message, if it is available locally without sending network request. This is an offline request
Returns forwarded copies of a channel message to different public channels. For optimal performance, the number of returned messages is chosen by TDLib
Returns detailed statistics about a message. Can be used only if message.can_get_statistics == true
Returns information about a message thread. Can be used only if message.can_get_message_thread == true
Returns messages in a message thread of a message. Can be used only if message.can_get_message_thread == true. Message thread of a channel message is in the channel’s linked supergroup. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib
Returns viewers of a recent outgoing message in a basic group or a supergroup chat. For video notes and voice notes only users, opened content of the message, are returned. The method can be called if message.can_get_viewers == true
Returns information about messages. If a message is not found, returns null on the corresponding position of the result
Returns network data usage statistics. Can be called before authorization
Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization
Returns a Telegram Passport authorization form for sharing data with a service
Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form
Returns one of the available Telegram Passport elements
Returns the current state of 2-step verification
Returns an invoice payment form. This method must be called when the user presses inlineKeyboardButtonBuy
Returns information about a successful payment
Returns information about a phone number by its prefix. Can be called before authorization
Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after changing localization to the specified language if properly localized country information is expected. Can be called synchronously
Returns users voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib
Returns an IETF language tag of the language preferred in the country, which must be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown
Returns list of proxies that are currently set up. Can be called before authorization
Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization
Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. Can be called synchronously
Returns up to 20 recently used inline bots in the order of their last usage
Returns a list of recently used stickers
Returns recently opened chats, this is an offline request. Returns chats in the order of last opening
Returns t.me URLs recently visited by a newly registered user
Returns recommended chat filters for the current user
Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a password provided by the user
Returns information about a file by its remote ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application
Returns information about a message that is replied by a given message. Also returns the pinned message, the game message, and the invoice message for messages of the types messagePinMessage, messageGameScore, and messagePaymentSuccessful respectively
Returns saved animations
Returns saved order info, if any
Returns the notification settings for chats of a given type
Returns information about a secret chat by its identifier. This is an offline request
Loads an asynchronous or a zoomed in statistical graph
Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object
Returns information about a sticker set by its identifier
Returns stickers from the installed sticker sets that correspond to a given emoji. If the emoji is non-empty, favorite and recently used stickers may also be returned
Returns storage usage statistics. Can be called before authorization
Quickly returns approximate storage usage statistics. Can be called before authorization
Returns suggested name for saving a file in a given directory
Returns a suggested name for a new sticker set with a given title
Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Returned basic group chats must be first upgraded to supergroups before they can be set as a discussion group. To set a returned supergroup as a discussion group, access to its old messages must be enabled using toggleSupergroupIsAllHistoryAvailable first
Returns information about a supergroup or a channel by its identifier. This is an offline request if the current user is not a bot
Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute
Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters
Returns a user that can be contacted to get support
Returns information about the current temporary password
Returns all entities (mentions, hashtags, cashtags, bot commands, bank card numbers, URLs, and email addresses) contained in the text. Can be called synchronously
Returns a list of frequently used chats. Supported only if the chat info database is enabled
Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib
Returns information about a user by their identifier. This is an offline request if the current user is not a bot
Returns full information about a user by their identifier
Returns the current privacy settings
Returns the profile photos of a user. The result of this query may be outdated: some photos might have been deleted already
Returns list of participant identifiers, on whose behalf a video chat in the chat can be joined
Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page
Returns a web page preview by the text of the message. Do not call this function too often. Returns a 404 error if the web page has no preview
Describes a group call
Contains the group call identifier
Represents a group call participant
Contains information about a group call participant’s video channel
Describes a recently speaking participant in a group call
The best available video quality
The medium video quality
The worst available video quality
Describes a group of video synchronization source identifiers
Contains a list of hashtags
Hides a suggested action
Contains an HTTP URL
An identity document
Adds new contacts or edits existing contacts by their phone numbers; contacts’ user identifiers are ignored
Imports messages exported from another app
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 callback query to a bot
A button with a game that sends a callback query to a bot. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageGame
A button that asks for password of the current user and then sends a callback query to a bot
A button that opens a specified URL and automatically authorize the current user if allowed to do so
A button that forces an inline query to the bot to be inserted in the input field
A button that opens a specified URL
A button with a user reference to be handled in the same way as textEntityTypeMentionName entities
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
A background from a local file
A background from the server
An animation in MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 800 and be at most 2MB in size
A previously used profile photo of the current user
A static photo in JPEG format
Applies if a user enters new credentials using Apple Pay
Applies if a user enters new credentials using Google 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 application
A file defined by its unique ID
A file defined by a local path
A file defined by its remote ID. The remote ID 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
An identity document to be saved to Telegram Passport
Represents a link to an animated GIF or 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 or TGS 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 dice message
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
A message with a location
A photo message
A message with a poll. Polls can’t be sent to secret chats. Polls can be sent only to a private chat with a bot
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
An animated sticker in TGS format
A static sticker in PNG format, which will be converted to WEBP server-side
A thumbnail to be sent along with a file; must be in JPEG or WEBP format for stickers, and less than 200 KB in size
The link is a link to the active sessions section of the app. Use getActiveSessions to handle the link
The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization state is authorizationStateWaitCode
The link is a link to a background. Call searchBackground with the given background name to process the link
The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the user is a bot, show START button in the chat with the bot, and then call sendBotStartMessage with the given start parameter after the button is pressed
The link is a link to a Telegram bot, which is supposed to be added to a group chat. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to groups, ask the current user to select a group to add the bot to, and then call sendBotStartMessage with the given start parameter and the chosen group chat. Bots can be added to a public group only by administrators of the group
The link is a link to the change phone number section of the app
The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link
The link is a link to the filter settings section of the app
The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot, ask the current user to select a chat to send the game, and then call sendMessage with inputMessageGame
The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process the link
The link is a link to a Telegram message. Call getMessageLinkInfo with the given URL to process the link
The link contains a message draft text. A share screen needs to be shown to the user, then the chosen chat must be opened and the text is added to the input field
The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to process the link if the link was received from outside of the app, otherwise ignore it
The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberConfirmationCode with the given hash and phone number to process the link
The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxy
The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link
The link can be used to login the current user on another device, but it must be scanned from QR-code using in-app camera. An alert similar to “This code can be used to allow someone to log in to your Telegram account. To confirm Telegram login, please go to Settings > Devices > Scan QR and scan the code” needs to be shown
The link is a link to app settings
The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and show the sticker set
The link is a link to a theme. TDLib has no theme support yet
The link is a link to the theme settings section of the app
The link is an unknown tg: link. Call getDeepLinkInfo to process the link
The link is a link to an unsupported proxy. An alert can be shown to the user
The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinGoupCall with the given invite hash to process the link
Invites users to an active group call. Sends a service message of type messageInviteToGroupCall for video chats
Product invoice
Adds the current user as a new member to a chat. Private and secret chats can’t be joined using this method
Uses an invite link to add the current user to the chat if possible
Joins an active group call. Returns join response payload for tgcalls
Represents one member of a JSON object
Represents a JSON array
Represents a boolean JSON value
Represents a null JSON value
Represents a numeric JSON value
Represents a JSON object
Represents a string JSON value
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 button that allows the user to create and send a poll when pressed; available only in private chats
A simple button, with text that must 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 must 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. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info
Contains a list of language pack strings
Removes the current user from chat members. Private and secret chats can’t be left using this method
Leaves a group call
Loads more chats from a chat list. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded
Loads more participants of a group call. The loaded participants will be received through updates. Use the field groupCall.loaded_all_participants to check whether all participants have already been loaded
Represents a local file
Contains information about the current localization target
Describes a location on planet Earth
Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes, updateAuthorizationState with authorizationStateClosed will be sent
The log is written to stderr or an OS specific log
The log is written nowhere
The log is written to a file
Contains a list of available TDLib internal log tags
Contains a TDLib internal log verbosity level
An HTTP url needs to be open
An authorization confirmation dialog needs to be shown to the user
The mask is placed relatively to the chin
The mask is placed relatively to the eyes
The mask is placed relatively to the forehead
The mask is placed relatively to the mouth
Position on a photo where a mask is placed
Describes a message
A message with an animated emoji
An animation message (GIF-style).
An audio message
A newly created basic group
Contains information about found messages, split by days according to the option “utc_time_offset”
Contains information about found messages sent on a specific day
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 via an invite link
A new member was accepted to the chat by an administrator
A theme in the chat has been changed
The TTL (Time To Live) setting for messages in the 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
Options to be used when a message content is copied without reference to the original sender. Service messages and messageInvoice can’t be copied
A non-standard action has happened in the chat
A dice message. The dice value is randomly generated by the server
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 messages was exported from a group chat
The messages was exported from a private chat
The messages was exported from a chat of unknown type
Contains information about a forwarded message
The message was originally a post in a channel
The message was originally sent on behalf of a chat
The message was originally sent by a user, which is hidden by their privacy settings
The message was imported from an exported message history
The message was originally sent by a known user
A message with a game
A new high score was achieved in a game
Contains information about interactions with a message
A message with information about an invite to a video chat
A message with an invoice from a bot
Contains an HTTPS link to a message in a supergroup or channel
Contains information about a link to a message in a chat
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 message with a poll
Contains information about a message in a specific position
Contains a list of message positions
A user in the chat came within proximity alert range
Contains information about replies to a message
The message will be sent at the specified date
The message will be sent when the peer will be online. Applicable to private chats only and when the exact online status of the peer is known
A screenshot of a message in the chat has been taken
Options to be used when a message is sent
The message was sent on behalf of a chat
The message was sent by a known user
Represents a list of message senders
The message failed to be sent
The message is being sent now, but has not yet been delivered to the server
A detailed statistics about a message
A sticker message
A newly created supergroup or channel
A text message
Contains information about a message thread
Message content that is not supported in the current TDLib version
A message with information about a venue
A video message
A message with information about an ended video chat
A new video chat was scheduled
A newly created video chat
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
Thumbnail image of a very poor quality and low resolution
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
Contains information about a notification
Describes a group of notifications
A group containing notifications of type notificationTypeNewCall
A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current user, replies to their messages, or a pinned message
A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages
A group containing a notification of type notificationTypeNewSecretChat
Notification settings applied to all channels when the corresponding chat setting has a default value
Notification settings applied to all basic groups and supergroups 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
New call was received
New message was received
New message was received through a push notification
New secret chat was created
An object of this type is returned on a successful function call for certain functions
Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (e.g., in supergroups and channels all updates are received only for opened chats)
Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location or venue, or has listened to an audio file or voice note message). An updateMessageContentOpened update will be generated if something has changed
Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can’t be deleted
Represents a boolean option
Represents an unknown option or an option which has a default value
Represents an integer option
Represents 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
Contains a caption of an instant view web page block, consisting of a text and a trailing credit
A link to a chat
A collage
A page cover
A collapsible block
An empty block separating a page
An embedded web page
An embedded post
The footer of a page
A header
The content must be center-aligned
The content must be left-aligned
The content must be right-aligned
A kicker
A list of data blocks
Describes an item of a list page block
A map
A text paragraph
A photo
A preformatted text paragraph
A pull quote
Contains information about a related article
Related articles
A slideshow
A subheader
The subtitle of a page
A table
Represents a cell of a table
The title of a page
The content must be bottom-aligned
The content must be middle-aligned
The content must be top-aligned
A video
A voice note
Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously
Parses Bold, Italic, Underline, Strikethrough, Code, Pre, PreCode, TextUrl and MentionName entities contained in the text. Can be called synchronously
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 information about a Telegram Passport elements and corresponding errors
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
Theme colors for a 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
Contains settings for the authentication of the user’s phone number
Contains information about a phone number
Describes a photo
Describes an image in JPEG format
Pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel
Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization
A point on a Cartesian plane
Describes a poll
Describes one answer option of a poll
A poll in quiz mode, which has exactly one correct answer option and can be answered only once
A regular poll
Handles a pending join request in a chat
Handles all pending join requests for a given link in a chat
Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to the server is required to fetch new data. Can be called before authorization
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
The chat is public, because it has username
The chat is public, because it is a location-based supergroup
An animation message (GIF-style).
An audio message
A newly created basic group
New chat members were invited to a group
A chat photo was edited
A chat title was edited
A chat member was deleted
A new member joined the chat via an invite link
A new member was accepted to the chat by an administrator
A chat theme was edited
A message with a user contact
A contact has registered with Telegram
A document message (a general file)
A message with a game
A new high score was achieved in a game
A general message with hidden content
A message with an invoice from a bot
A message with a location
A media album
A forwarded messages
A photo message
A message with a poll
A screenshot of a message in the chat has been taken
A message with a sticker
A text message
A video message
A video note message
A voice note message
Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification
Marks all mentions in a chat as read
Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib’s file system, because it is usually slower than a direct read from the file
Describes a recommended chat filter
Contains a list of recommended chat filters
Recovers the password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword
Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up
Contains information about the current recovery email address
Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription
Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration
Represents a remote file
Removes background from the list of installed backgrounds
Removes a chat action bar without any other action
Removes users from the contact list
Removes a sticker from the list of favorite stickers
Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user
Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user
Removes a proxy server. Can be called before authorization
Removes a hashtag from the list of recently used hashtags
Removes a sticker from the list of recently used stickers
Removes a chat from the list of recently found chats
Removes an animation from the list of saved animations
Removes a sticker from the set to which it belongs; for bots only. The sticker set must have been created by the bot
Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled
Changes the order of chat filters
Changes the order of installed sticker sets
Replaces current primary invite link for a chat with a new primary invite link. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right
Instructs application to force a reply to this message
Contains an inline keyboard layout
Instructs application to remove the keyboard once this message has been received. This kind of keyboard can’t be received in an incoming message; instead, UpdateChatReplyMarkup with message_id == 0 will be sent
Contains a custom keyboard layout to quickly reply to bots
Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if chat.can_be_reported
Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported
Reports messages in a supergroup as spam; requires administrator rights in the supergroup
Requests to send a password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword
Requests to send a 2-step verification password recovery code to an email address that was previously set up
Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword
Re-sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode, the next_code_type of the result is not null and the server-specified timeout has passed
Re-sends the authentication code sent to confirm a new phone number for the current user. Works only if the previously received authenticationCodeInfo next_code_type was not null and the server-specified timeout has passed
Re-sends the code to verify an email address to be added to a user’s Telegram Passport
Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry is true and after specified in messageSendingStateFailed.retry_after time passed. If a message is re-sent, the corresponding failed to send message is deleted. Returns the sent messages in the same order as the message identifiers passed in message_ids. If a message can’t be re-sent, null will be returned instead of the message
Resends phone number confirmation code
Re-sends the code to verify a phone number to be added to a user’s Telegram Passport
Resends the 2-step verification recovery email address verification code
Resets all notification settings to their default values. By default, all chats are unmuted, the sound is set to “default” and message previews are shown
Resets list of installed backgrounds to its default value
Resets all network data usage statistics to zero. Can be called before authorization
Removes 2-step verification password without previous password and access to recovery email address. The password can’t be reset immediately and the request needs to be repeated after the specified time
The password reset request was declined
The password was reset
The password reset request is pending
Revokes invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. If a primary link is revoked, then additionally to the revoked link returns new primary link
Revokes invite link for a group call. Requires groupCall.can_be_managed group call flag
An anchor
A link to an anchor on the same web page
A bold rich text
A rich text email link
A fixed-width rich text
A small image inside the text
An italicized rich text
A marked rich text
A rich text phone number
A plain text
A reference to a richTexts object on the same web page
A strikethrough rich text
A subscript rich text
A superscript rich text
An underlined rich text
A rich text URL link
A concatenation of rich texts
Saves application log event on the server. Can be called before authorization
Contains information about saved card credentials
Contains information about notification settings for several chats
Searches for a background by its name
Searches for call messages. Returns the results in reverse chronological order (i. e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib
Searches for a specified query in the first name, last name and username of the members of a specified chat. Requires administrator rights in channels
Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user
Searches for the specified query in the title and username of already known chats, this is an offline request. Returns chats in the order seen in the main chat list
Returns a list of users and location-based supergroups nearby. The list of users nearby will be updated for 60 seconds after the request by the updates updateUsersNearby. The request must be sent again every 25 seconds with adjusted location to not miss new chats
Searches for the specified query in the title and username of already known chats via request to the server. Returns chats in the order seen in the main chat list
Searches for the specified query in the first names, last names and usernames of the known user contacts
Searches for emojis by keywords. Supported only if the file database is enabled
Searches for recently used hashtags by their prefix
Searches for installed sticker sets by looking for specified query in their title and name
Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
Returns only animation messages
Returns only audio messages
Returns only messages containing chat photos
Returns only document messages
Returns all found messages, no filter is applied
Returns only failed to send messages. This filter can be used only if the message database is used
Returns only messages with mentions of the current user, or messages that are replies to their messages
Returns only photo messages
Returns only photo and video messages
Returns only pinned 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, a message thread 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
Searches a public chat by its username. Currently, only private chats, supergroups and channels can be public. Returns the chat if found; otherwise an error is returned
Searches public chats by looking for specified query in their username and title. Currently, only private chats, supergroups and channels can be public. Returns a meaningful number of results. Excludes private chats with contacts and chats from the chat list from the results
Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib
Searches for a sticker set by its name
Searches for ordinary sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results
Searches for stickers from public sticker sets that correspond to a given emoji
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
Invites a bot to a chat (if it is not yet a member) and sends it the /start command. Bots can’t be invited to a private chat other than the chat with the bot. Bots can’t be invited to channels (although they can be added as admins) and secret chats. Returns the sent message
Sends debug information for a call
Sends a call rating
Sends call signaling data
Sends a notification about user activity in a chat
Sends a notification about a screenshot taken in a chat. Supported only in private and secret chats
Sends a custom request; for bots only
Sends a code to verify an email address to be added to a user’s Telegram Passport
Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message
Sends a message. Returns the sent message
Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be grouped into an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns sent messages
Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements are going to be reused
Sends a filled-out payment form to the bot for final verification
Sends phone number confirmation code to handle links of the type internalLinkTypePhoneNumberConfirmation
Sends a code to verify a phone number to be added to a user’s Telegram Passport
Contains information about one session in a Telegram application used by the current user. Sessions must be shown to the user in the returned order
Contains a list of sessions
Changes the period of inactivity after which the account of the current user will automatically be deleted
Succeeds after a specified amount of time has passed. Can be called before initialization
Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword
Sets auto-download settings
Changes the background selected by the user; adds background to the list of installed backgrounds
Changes the bio of the current user
Informs the server about the number of pending bot updates if they haven’t been processed for a long time; for bots only
Changes application-specific data associated with a chat
Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info administrator right
Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified
Changes the draft message in a chat
Changes the location of a chat. Available only for some location-based supergroups, use supergroupFullInfo.can_set_location to check whether the method is allowed to use
Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters needs to be passed
Selects a message sender to send messages in a chat
Changes the message TTL in a chat. Requires can_delete_messages administrator right in basic groups, supergroups and channels Message TTL can’t be changed in a chat with the current user (Saved Messages) and the chat 777000 (Telegram)
Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can’t be changed
Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right
Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right
Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members rights
Changes the chat theme. Supported only in private and secret chats
Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right
Sets the list of commands supported by the bot for the given user scope and language; for bots only
Adds or changes a custom local language pack to the current localization target
Adds, edits or deletes a string in a custom local language pack. Can be called before authorization
Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain
Informs TDLib on a file generation progress
Updates the game score of the specified user in the game; for bots only
Informs TDLib that speaking state of a participant of an active group has changed
Changes volume level of a participant of an active group call. If the current user can manage the group call, then the participant’s volume level will be changed for all users with the default volume level
Sets group call title. Requires groupCall.can_be_managed group call flag
Changes the period of inactivity after which sessions will automatically be terminated
Updates the game score of the specified user in a game; for bots only
Changes the location of the current user. Needs to be called if GetOption(“is_location_visible”) is true and location changes for more than 1 kilometer
Sets new log stream for internal logging of TDLib. Can be called synchronously
Sets the verbosity level for a specified TDLib internal log tag. Can be called synchronously
Sets the verbosity level of the internal logging of TDLib. Can be called synchronously
Changes the first and last name of the current user
Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics
Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only writable options can be set. Can be called before authorization
Adds an element to the user’s Telegram Passport. May return an error with a message “PHONE_VERIFICATION_NEEDED” or “EMAIL_VERIFICATION_NEEDED” if the chosen phone number or the chosen email address must be verified first
Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will not be able to resend the elements, until the errors are fixed
Changes the password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed
Changes the order of pinned chats
Changes the user answer to a poll. A poll in quiz mode can be answered only once
Changes a profile photo for the current user
Changes the 2-step verification recovery email address of the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed. If new_recovery_email_address is the same as the email address that is currently set up, this call succeeds immediately and aborts all other requests waiting for an email confirmation
Changes notification settings for chats of a given type
Changes the position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot
Sets a sticker set thumbnail; for bots only. Returns the sticker set
Changes the sticker set of a supergroup; requires can_change_info administrator right
Changes the username of a supergroup or channel, requires owner privileges in the supergroup or channel
Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters
Changes user privacy settings
Changes the username of the current user
Changes default participant identifier, on whose behalf a video chat in the chat will be joined
Shares the phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber
One shipping option
Describes a sponsored message
Starts recording of an active group call. Requires groupCall.can_be_managed group call flag
Starts screen sharing in a joined group call. Returns join response payload for tgcalls
Starts a scheduled group call
The graph data to be asynchronously loaded through getStatisticalGraph
A graph data
An error message to be shown to the user instead of the graph
A value with information about its recent changes
Describes a sticker
Represents a sticker set
Represents short information about a sticker set
Represents a list of sticker sets
Represents a list of stickers
Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag set
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
Suggests the user to check whether they still remember their 2-step verification password
Suggests the user to check whether authorization phone number is correct and change the phone number if it is inaccessible
Suggests the user to convert specified supergroup to a broadcast group
Suggests the user to enable “archive_and_mute_new_chats_from_unknown_users” option
Suggests the user to set a 2-step verification password to be able to log in again
Suggests the user to view a hint about the meaning of one and two check marks on sent messages
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 owner 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 contacts of the user, which are members of the supergroup or channel
Returns users which can be mentioned in the supergroup
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
Fetches the latest versions of all strings from a language pack in the current localization target from the server. This method doesn’t need to be called explicitly for the current used/base language packs. Can be called before authorization
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
Terminates all other sessions of the current user
Terminates a session of the current user
Contains Telegram terms of service
A simple object containing a sequence of bytes; for testing only
Returns the received bytes; for testing only. This is an offline method. Can be called before authorization
Does nothing; for testing only. This is an offline method. Can be called before authorization
Returns the received string; for testing only. This is an offline method. Can be called before authorization
Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization
Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization
Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization
Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization
Forces an updates.getDifference call to the Telegram servers; for testing only
A simple object containing a number; for testing only
Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization
Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization
Returns the specified error and ensures that the Error object is used; for testing only. Can be called synchronously
Returns the squared received number; for testing only. This is an offline method. Can be called before authorization
A simple object containing a string; for testing only
Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called before authorization
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 bank card number. The getBankCardInfo method can be used to get information about the bank card
A bold text
A bot command, beginning with “/”
A cashtag text, beginning with “$” and consisting of capital English letters (e.g., “$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 media timestamp
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 strikethrough text
A text description shown instead of a raw URL
An underlined text
An HTTP URL
The text uses HTML-style formatting. The same as Telegram Bot API “HTML” parse mode
The text uses Markdown-style formatting
Describes theme settings
Represents a thumbnail
The thumbnail is in static GIF format. It will be used only for some bot inline results
The thumbnail is in JPEG format
The thumbnail is in MPEG4 format. It will be used only for some animations and videos
The thumbnail is in PNG format. It will be used only for background patterns
The thumbnail is in TGS format. It will be used only for animated sticker sets
The thumbnail is in WEBP format. It will be used only for some stickers
Changes the value of the default disable_notification parameter, used when a message is sent to a chat
Changes the ability of users to save, forward, or copy chat content. Supported only for basic groups, supergroups and channels. Requires owner privileges
Changes the marked as unread state of a chat
Changes the pinned state of a chat. There can be up to GetOption(“pinned_chat_count_max”)/GetOption(“pinned_archived_chat_count_max”) pinned non-secret chats and the same number of secret chats in the main/arhive chat list
Toggles whether the current user will receive a notification when the group call will start; scheduled group calls only
Toggles whether current user’s video is enabled
Toggles whether current user’s video is paused
Toggles whether new participants of a group call can be unmuted only by administrators of the group call. Requires groupCall.can_toggle_mute_new_participants group call flag
Toggles whether a group call participant hand is rased
Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves
Pauses or unpauses screen sharing in a joined group call
Changes the block state of a message sender. Currently, only users and supergroup chats can be blocked
Toggles whether a session can accept incoming calls
Toggles whether a session can accept incoming secret chats
Toggles whether the message history of a supergroup is available to new members; requires can_change_info administrator right
Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup
Toggles whether sender signature is added to sent messages in a channel; requires can_change_info administrator right
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 chats used to forward messages
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
Changes the owner of a chat. The current user must be a current owner of the chat. Use the method canTransferOwnership to check whether the ownership can be transferred from the current session. Available only for supergroups and channel chats
Removes all pinned messages from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel
Removes a pinned message from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel
Contains active notifications that was shown on previous application launches. This update is sent only if the message database is used. In that case it comes once before any updateNotification and updateNotificationGroup update
Some animated emoji message was clicked and a big animated sticker must be played if the message is visible on the screen. chatActionWatchingAnimations with the text of the message needs to be sent if the sticker is played
The parameters of animation search through GetOption(“animation_search_bot_username”) bot has changed
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 application
Some data in basicGroupFullInfo has been changed
New call was created or information about a call was updated
A message sender activity in the chat has changed
The chat action bar was changed
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 mustn’t be applied
The list of chat filters or a chat filter has changed
A chat content was allowed or restricted for saving
A chat’s has_scheduled_messages field has changed
A chat was blocked or unblocked
A chat was marked as unread or was read
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
User rights changed in a chat; for bots only
The message sender that is selected to send messages in a chat has changed
The message Time To Live setting for a chat was changed
Notification settings for a chat were changed
The number of online group members has changed. This update with non-zero count is sent only for currently opened chats. There is no guarantee that it will be sent just after the count has changed
The chat pending join requests were changed
Chat permissions was changed
A chat photo was changed
The position of a chat in a chat list has changed. Instead of this update updateChatLastMessage or updateChatDraftMessage might be sent
Incoming messages were read or the 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 chat theme was changed
The list of available chat themes has changed
The title of a chat was changed
The chat unread_mention_count has changed
A chat video chat state has changed
The connection state has changed. This update must be used only to show a human-readable description of the connection state
Some messages were deleted
The list of supported dice emojis has changed
The list of favorite stickers was updated
Information about a file was updated
The file generation process needs to be started by the application
File generation is no longer needed
Information about a group call was updated
Information about a group call participant was changed. The updates are sent only after the group call is received through getGroupCall and only if the call is joined or being joined
Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some pending notifications
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
The information about interactions with a message has changed
The message pinned state was changed
A message with a live location was viewed. When the update is received, the application is supposed to update the live location
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
New call signaling data arrived
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 application. The chat field changes will be reported through separate updates
A user sent a join request to a chat; for bots only
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
A notification was changed
A list of active notifications in a notification group has changed
An option changed its value
A poll was updated; for bots only
A user changed the answer to a poll; for bots only
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 application
The selected background has changed
A service notification from the server was received. Upon receiving this the application must show a popup with the content of the notification
A sticker set has changed
The list of suggested to the user actions has changed
Some data of a supergroup or a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the application
Some data in 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 must 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 the message database is used
Number of unread messages in a chat list has changed. This update is sent only if the 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 application
Some data in userFullInfo has been changed
Some privacy setting rules have been changed
The user went online or offline
The list of users nearby has changed. The update is guaranteed to be sent only 60 seconds after a successful searchChatsNearby request
Contains a list of updates
Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires creator privileges. Deactivates the original basic group
Asynchronously uploads a file to the cloud without sending it in a message. updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it will be sent in a message
Uploads a file with a sticker; returns the uploaded file
Represents a user
Contains full information about a user
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 privacy setting for managing whether the user can be found by their phone number. Checked only if the phone number is not known to the other user. Can be set only to “Allow contacts” or “Allow all”
A privacy setting for managing whether peer-to-peer connections can be used for calls
A rule to allow all users to do something
A rule to allow all members of certain specified basic groups and supergroups to doing 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 members of specified basic groups and supergroups 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 a link to the user’s account is included in forwarded messages
A privacy setting for managing whether the user’s phone number is visible
A privacy setting for managing whether the user’s profile photo is visible
A privacy setting for managing whether the user’s online status is visible
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 identifier 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 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
Represents a list of users
Validates the order information provided by a user and returns the available shipping options for a flexible invoice
Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options
A cubic Bézier curve to a given point
A straight line to a given point
Describes a venue
Describes a video file
Describes a video chat
Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format
Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels)
Informs the server that some trending sticker sets have been viewed by the user
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
Describes a web page preview
Describes an instant view page for a web page
Writes a part of a generated file. This method is intended to be used only if the application has no direct access to TDLib’s file system, because it is usually slower than a direct write to the destination file
Enums
Provides information about the method by which an authentication code is delivered to the user
Represents the current authorization state of the TDLib client
Describes a fill of a background
Describes the type of a background
Represents the scope to which bot commands are relevant
Describes the reason why a call was discarded
Describes the exact type of a problem with a call
Describes the type of a call server
Describes the current call state
Represents a payload of a callback query
Represents result of checking whether the current session can be used to transfer a chat ownership to another user
Describes the different types of activity in a chat
Describes actions which must be possible to do through a chat action bar
Represents a chat event
Describes a list of chats
Provides information about the status of a member in a chat
Specifies the kind of chat members to return in searchChatMembers
Describes the reason why a chat is reported
Describes a reason why an external chat is shown in a chat list
Contains a detailed statistics about a chat
Describes the type of a chat
Represents result of checking whether a username can be set for a chat
Represents result of checking whether a name can be used for a new sticker set
Describes the current state of the connection to Telegram servers
Represents a data needed to subscribe for push notifications through registerDevice method. To use specific push notification service, the correct application platform must be specified and a valid server authentication data must be uploaded at https://my.telegram.org
Contains animated stickers which must be used for dice animation rendering
Represents the type of a file
Describes the quality of a group call video
Describes the type of an inline keyboard button
Represents a single result of an inline query
Contains information about background to set
Describes a photo to be set as a user profile or chat photo
Contains information about the payment method chosen by the user
Points to a file
Represents a single result of an inline query; for bots only
The content of a message to send
Contains information about a Telegram Passport element to be saved
Contains the description of an error in a Telegram Passport element; for bots only
Describes a sticker that needs to be added to a sticker set
Describes an internal https://t.me or tg: link, which must be processed by the app in a special way
Represents a JSON value
Describes a keyboard button type
Represents the value of a string in a language pack
Describes a stream to which TDLib internal log is written
Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl
Part of the face, relative to which a mask is placed
Contains the content of a message
Contains information about a file with messages exported from another app
Contains information about the origin of a forwarded message
Contains information about the time when a scheduled message will be sent
Contains information about the sender of a message
Contains information about the sending state of the message
Contains statistics about network usage
Represents the type of a network
Describes the type of notifications in a notification group
Describes the types of chats to which notification settings are relevant
Contains detailed information about a notification
Represents the value of an option
Describes a block of an instant view web page
Describes a horizontal alignment of a table cell content
Describes a Vertical alignment of a table cell content
Contains information about a Telegram Passport element
Contains the description of an error in a Telegram Passport element
Contains the type of a Telegram Passport element
Describes the type of a poll
Describes the type of a proxy server
Describes a type of public chats
Contains content of a push message notification
Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots
Represents result of 2-step verification password reset
Describes a text object inside an instant-view web page
Represents a filter for message search results
Describes the current secret chat state
Describes a statistical graph
Describes an action suggested to the current user
Specifies the kind of chat members to return in getSupergroupMembers
Describes the type of a URL linking to an internal Telegram entity
Represents a part of the text which must be formatted differently
Describes the way the text needs to be parsed for TextEntities
Describes format of the thumbnail
Represents the categories of chats for which a list of frequently used chats can be retrieved
Contains notifications about data changes
Describes available user privacy settings
Represents a single rule for managing privacy settings
Describes the last time the user was online
Represents the type of a user. The following types are possible: regular users, deleted users and bots
Represents a vector path command
Traits
All tdlib type abstract class defined the same behavior
TRAIT | Provides information about the method by which an authentication code is delivered to the user
TRAIT | Represents the current authorization state of the TDLib client
TRAIT | Describes a fill of a background
TRAIT | Describes the type of a background
TRAIT | Represents the scope to which bot commands are relevant
TRAIT | Describes the reason why a call was discarded
TRAIT | Describes the exact type of a problem with a call
TRAIT | Describes the type of a call server
TRAIT | Describes the current call state
TRAIT | Represents a payload of a callback query
TRAIT | Represents result of checking whether the current session can be used to transfer a chat ownership to another user
TRAIT | Describes the different types of activity in a chat
TRAIT | Describes actions which must be possible to do through a chat action bar
TRAIT | Represents a chat event
TRAIT | Describes a list of chats
TRAIT | Provides information about the status of a member in a chat
TRAIT | Specifies the kind of chat members to return in searchChatMembers
TRAIT | Describes the reason why a chat is reported
TRAIT | Describes a reason why an external chat is shown in a chat list
TRAIT | Contains a detailed statistics about a chat
TRAIT | Describes the type of a chat
TRAIT | Represents result of checking whether a username can be set for a chat
TRAIT | Represents result of checking whether a name can be used for a new sticker set
TRAIT | Describes the current state of the connection to Telegram servers
TRAIT | Represents a data needed to subscribe for push notifications through registerDevice method. To use specific push notification service, the correct application platform must be specified and a valid server authentication data must be uploaded at https://my.telegram.org
TRAIT | Contains animated stickers which must be used for dice animation rendering
TRAIT | Represents the type of a file
TRAIT | Describes the quality of a group call video
TRAIT | Describes the type of an inline keyboard button
TRAIT | Represents a single result of an inline query
TRAIT | Contains information about background to set
TRAIT | Describes a photo to be set as a user profile or chat photo
TRAIT | Contains information about the payment method chosen by the user
TRAIT | Points to a file
TRAIT | Represents a single result of an inline query; for bots only
TRAIT | The content of a message to send
TRAIT | Contains information about a Telegram Passport element to be saved
TRAIT | Contains the description of an error in a Telegram Passport element; for bots only
TRAIT | Describes a sticker that needs to be added to a sticker set
TRAIT | Describes an internal https://t.me or tg: link, which must be processed by the app in a special way
TRAIT | Represents a JSON value
TRAIT | Describes a keyboard button type
TRAIT | Represents the value of a string in a language pack
TRAIT | Describes a stream to which TDLib internal log is written
TRAIT | Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl
TRAIT | Part of the face, relative to which a mask is placed
TRAIT | Contains the content of a message
TRAIT | Contains information about a file with messages exported from another app
TRAIT | Contains information about the origin of a forwarded message
TRAIT | Contains information about the time when a scheduled message will be sent
TRAIT | Contains information about the sender of a message
TRAIT | Contains information about the sending state of the message
TRAIT | Contains statistics about network usage
TRAIT | Represents the type of a network
TRAIT | Describes the type of notifications in a notification group
TRAIT | Describes the types of chats to which notification settings are relevant
TRAIT | Contains detailed information about a notification
TRAIT | Represents the value of an option
TRAIT | Describes a block of an instant view web page
TRAIT | Describes a horizontal alignment of a table cell content
TRAIT | Describes a Vertical alignment of a table cell content
TRAIT | Contains information about a Telegram Passport element
TRAIT | Contains the description of an error in a Telegram Passport element
TRAIT | Contains the type of a Telegram Passport element
TRAIT | Describes the type of a poll
TRAIT | Describes the type of a proxy server
TRAIT | Describes a type of public chats
TRAIT | Contains content of a push message notification
TRAIT | Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots
TRAIT | Represents result of 2-step verification password reset
TRAIT | Describes a text object inside an instant-view web page
TRAIT | Represents a filter for message search results
TRAIT | Describes the current secret chat state
TRAIT | Describes a statistical graph
TRAIT | Describes an action suggested to the current user
TRAIT | Specifies the kind of chat members to return in getSupergroupMembers
TRAIT | Describes the type of a URL linking to an internal Telegram entity
TRAIT | Represents a part of the text which must be formatted differently
TRAIT | Describes the way the text needs to be parsed for TextEntities
TRAIT | Describes format of the thumbnail
TRAIT | Represents the categories of chats for which a list of frequently used chats can be retrieved
TRAIT | Contains notifications about data changes
TRAIT | Describes available user privacy settings
TRAIT | Represents a single rule for managing privacy settings
TRAIT | Describes the last time the user was online
TRAIT | Represents the type of a user. The following types are possible: regular users, deleted users and bots
TRAIT | Represents a vector path command