Structures

An object of this type can be returned on every function call, in case of an error

An object of this type is returned on a successful function call for certain functions

Contains parameters for TDLib initialization

Information about the authentication code that was sent

Information about the email address authentication code that was sent

Represents a part of the text that needs to be formatted in some unusual way

Contains a list of text entities

A text with some entities

Contains Telegram terms of service

Represents the current state of 2-step verification

Contains information about the current recovery email address

Returns information about the availability of a temporary password, which can be used for payments

Represents a local file

Represents a remote file

Represents a file

Photo description

Thumbnail image of a very poor quality and low resolution

Position on a photo where a mask should be placed

Describes one answer option of a poll

Describes an animation file. The animation must be encoded in GIF or MPEG4 format

Describes an audio file. Audio is usually in MP3 or M4A format

Describes a document of any type

Describes a photo

Describes a sticker

Describes a video file

Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format

Describes a voice note. The voice note must be encoded with the Opus codec, and stored inside an OGG container. Voice notes can have only a single audio channel

Describes a user contact

Describes a location on planet Earth

Describes a venue

Describes a game

Describes a poll

Describes a user profile photo

Describes the photo of a chat

Represents commands supported by a bot

Provides information about a bot and its supported commands

Represents a location to which a chat is connected

Represents a user

Contains full information about a user (except the full list of profile photos)

Contains full information about a user profile photo

Contains part of the list of user photos

Represents a list of users

Contains information about a chat administrator

Represents a list of chat administrators

Describes actions that a user is allowed to take in a chat

A user with information about joining/leaving a chat

Contains a list of chat members

Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)

Contains full information about a basic group

Represents 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

Represents a secret chat

Contains information about a forwarded message

Describes a message

Contains a list of messages

Contains a list of messages found by a search

Contains information about notification settings for a chat

Contains information about notification settings for several chats

Contains information about a message draft

A chat. (Can be a private chat, basic group, supergroup, or secret chat)

Represents a list of chats

Describes a chat located nearby

Represents a list of chats located nearby

Contains a chat invite link

Contains information about a chat invite link

Represents a single button in a bot keyboard

Represents a single button in an inline keyboard

Contains a caption of an instant view web page block, consisting of a text and a trailing credit

Describes an item of a list page block

Represents a cell of a table

Contains information about a related article

Describes an instant view page for a web page

Describes a web page preview

Describes an address

Portion of the price of a product (e.g., “delivery cost”, “tax amount”)

Product invoice

Order information

One shipping option

Contains information about saved card credentials

Stripe payment provider

Contains information about an invoice payment form

Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options

Contains the result of a payment request

Contains information about a successful payment

File with the date it was uploaded

Represents a date according to the Gregorian calendar

Contains the user’s personal details

An identity document

An identity document to be saved to Telegram Passport

A personal document, containing some information about a user

A personal document to be saved to Telegram Passport

Contains information about saved Telegram Passport elements

Contains the description of an error in a Telegram Passport element

Contains information about a Telegram Passport element that was requested by a service

Contains a description of the required Telegram Passport element that was requested by a service

Contains information about a Telegram Passport authorization form that was requested

Contains information about a Telegram Passport elements and corresponding errors

Contains encrypted Telegram Passport data credentials

Contains information about an encrypted Telegram Passport element; for bots only

Contains the description of an error in a Telegram Passport element; for bots only

A thumbnail to be sent along with a file; should be in JPEG or WEBP format for stickers, and less than 200 kB in size

Options to be used when a message is send

Represents a list of stickers

Represents a list of emoji

Represents a sticker set

Represents short information about a sticker set

Represents a list of sticker sets

Specifies the supported call protocols

Describes the address of UDP reflectors

Contains the call identifier

Describes a call

Contains settings for the authentication of the user’s phone number

Represents a list of animations

Represents the result of an ImportContacts request

Contains an HTTP URL

Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query

Contains a bot’s answer to a callback query

Contains the result of a custom request

Contains one row of the game high score table

Contains a list of game high scores

Represents a chat event

Contains a list of chat events

Represents a set of filters used to obtain a chat event log

Represents one language pack string

Contains a list of language pack strings

Contains information about a language pack

Contains information about the current localization target

Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification

Describes a chat background

Contains a list of backgrounds

Contains a list of hashtags

Contains information about a notification

Describes a group of notifications

Represents one member of a JSON object

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

Contains information about the period of inactivity after which the current user’s account will automatically be deleted

Contains information about one session in a Telegram application used by the current user. Sessions should be shown to the user in the returned order

Contains a list of sessions

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

Contains a public HTTPS link to a message in a supergroup or channel with a username

Contains information about a link to a message in a chat

Contains a part of a file

Contains the storage usage statistics for a specific file type

Contains the storage usage statistics for a specific chat

Contains the exact storage usage statistics split by chats and file type

Contains approximate storage usage statistics, excluding files of unknown file type

Contains database statistics

A full list of available network statistic entries

Contains auto-download settings

Contains auto-download settings presets for the user

Represents a URL linking to an internal Telegram entity

Contains a list of t.me URLs

Contains a counter

Contains some text

Contains a value representing a number of seconds

Contains information about a tg:// deep link

Contains information about a proxy server

Represents a list of proxy servers

Describes a sticker that should be added to a sticker set

Contains a list of updates

Contains a TDLib internal log verbosity level

Contains a list of available TDLib internal log tags

A simple object containing a number; for testing only

A simple object containing a string; for testing only

A simple object containing a sequence of bytes; for testing only

A simple object containing a vector of numbers; for testing only

A simple object containing a vector of objects that hold a number; for testing only

A simple object containing a vector of strings; for testing only

A simple object containing a vector of objects that hold a string; for testing only

Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state

Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters

Checks the database encryption key for correctness. Works only when the current authorization state is authorizationStateWaitEncryptionKey

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

Re-sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode and the next_code_type of the result is not null

Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode

Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber

Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration

Checks the authentication password for correctness. Works only when the current authorization state is authorizationStateWaitPassword

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

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

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

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

Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent

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

Confirms QR code authentication on another device. Returns created session on success

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. This is an offline method. Can be called before authorization

Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain

Returns the current state of 2-step verification

Changes the password for 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

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

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

Checks the 2-step verification recovery email address verification code

Resends the 2-step verification recovery email address verification code

Requests to send a password recovery code to an email address that was previously set up

Recovers the password using a recovery code sent to an email address that was previously set up

Creates a new temporary password for processing payments

Returns information about the current temporary password

Returns the current user

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 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 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 a secret chat by its identifier. This is an offline request

Returns information about a chat by its identifier, this is an offline request if the current user is not a bot

Returns information about a message

Returns information about a message, if it is available locally without sending network request. This is an offline request

Returns information about a message that is replied by given message

Returns information about a pinned chat message

Returns information about messages. If a message is not found, returns null on the corresponding position of the result

Returns information about a file; this is an offline request

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 client

Returns an ordered list of chats in a chat list. Chats are sorted by the pair (order, chat_id) in decreasing order. (For example, to get a list of chats from the beginning, the offset_order should be equal to a biggest signed 64-bit number 9223372036854775807 == 2^63 - 1). -For optimal performance the number of returned chats is chosen by the library

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. Returns nothing if the length of the searched username prefix is less than 5. Excludes private chats with contacts and chats from the chat list from the results

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 chat list

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 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 should be sent again every 25 seconds with adjusted location to not miss new chats

Returns a list of frequently used chats. Supported only if the chat info database is enabled

Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled

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

Removes a chat from the list of recently found chats

Clears the list of recently found chats

Checks whether a username can be set for a chat

Returns a list of public chats of the specified type, owned by the user

Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached

Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Basic group chats need to be first upgraded to supergroups before they can be set as a discussion group

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 a list of common group chats with a given user. Chats are sorted by their type and creation date

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 the library. This is an offline request if only_local is true

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

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 should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library

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 the library

Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance the number of returned messages is chosen by the library

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 the library

Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user

Returns all active live locations that should be updated by the client. The list is persistent across application restarts only if the message database is used

Returns the last message sent in a chat no later than the specified date

Returns approximate number of messages of the specified type 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)

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

Returns a public HTTPS link to a message. Available only for messages in supergroups and channels with a username

Returns a private HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels. The link will work only for members of the chat

Returns information about a public or private message link

Sends a message. Returns the sent message

Sends messages grouped together into an album. Currently only photo and video messages can be grouped into an album. Returns sent messages

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 the result of an inline query as a message. Returns the sent message. Always clears a chat draft message

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

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

Changes the current TTL setting (sets a new self-destruct timer) in a secret chat and sends the corresponding message

Sends a notification about a screenshot taken in a chat. Supported only in private and secret chats

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

Deletes messages

Deletes all messages sent by the specified user to a chat. Supported only for supergroups; requires can_delete_messages administrator privileges