TDLib
Description:
Content:
Classes:
- AccentColor - Contains information about supported
accent color for user/chat name, background of empty chat photo, replies to messages and link previews
- AcceptCall - Accepts an incoming call
- AcceptTermsOfService - Accepts Telegram
terms of services
- AcceptedGiftTypes - Describes gift types that
are accepted by a user
- AccountInfo - Contains basic information about
another user that started a chat with the current user
- AccountTtl - Contains information about the period of
inactivity after which the current user's account will automatically be deleted
- ActivateStoryStealthMode - Activates
stealth mode for stories, which hides all views of stories from the current user in the last "story_stealth_mode_past_period" seconds
and for the next "story_stealth_mode_future_period" seconds; for Telegram Premium users only
- AddBotMediaPreview - Adds a new media preview
to the beginning of the list of media previews of a bot. Returns the added preview after addition is completed server-side. The total
number of previews must not exceed getOption("bot_media_preview_count_max") for the given language
- AddChatFolderByInviteLink - Adds a chat
folder by an invite link
- AddChatMember - Adds a new member to a chat;
requires can_invite_users member right. Members can't be added to private or secret chats. Returns information about members that
weren't added
- AddChatMembers - Adds multiple new members to a
chat; requires can_invite_users member right. 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. Returns information about members that
weren't added
- AddChatToList - 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
- AddContact - Adds a user to the contact list or edits
an existing contact by their user identifier
- AddCustomServerLanguagePack - Adds a
custom server language pack to the list of installed language packs in current localization target. Can be called before authorization
- AddFavoriteSticker - 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 or in WEBP or WEBM format can be added to this list. Emoji stickers can't be
added to favorite stickers
- AddFileToDownloads - Adds a file from a
message to the list of file downloads. Download progress and completion of the download will be notified through updateFile updates. If
message database is used, the list of file downloads is persistent across application restarts. The downloading is independent of
download using Client.download_file i.e. it continues if
Client.download_file is canceled or is used to download a part of the file
- AddLocalMessage - 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
- AddLogMessage - Adds a message to TDLib internal
log. Can be called synchronously
- AddMessageReaction - Adds a reaction or a tag
to a message. Use Client.get_message_available_reactions
to receive the list of available reactions for the message
- AddNetworkStatistics - Adds the specified
data to data usage statistics. Can be called before authorization
- AddPendingPaidMessageReaction -
Adds the paid message reaction to a message. Use
Client.get_message_available_reactions to check whether the reaction is available for the message
- AddProxy - Adds a proxy server for network requests. Can
be called before authorization
- AddQuickReplyShortcutInlineQueryResultMessage -
Adds a message to a quick reply shortcut via inline bot. If shortcut doesn't exist and there are less than
getOption("quick_reply_shortcut_count_max") shortcuts, then a new shortcut is created. The shortcut must not contain more than
getOption("quick_reply_shortcut_message_count_max") messages after adding the new message. Returns the added message
- AddQuickReplyShortcutMessage - Adds
a message to a quick reply shortcut. If shortcut doesn't exist and there are less than getOption("quick_reply_shortcut_count_max")
shortcuts, then a new shortcut is created. The shortcut must not contain more than getOption("quick_reply_shortcut_message_count_max")
messages after adding the new message. Returns the added message
- AddQuickReplyShortcutMessageAlbum -
Adds 2-10 messages grouped together into an album to a quick reply shortcut. 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
- AddRecentSticker - 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 or in WEBP or WEBM format can be added to this list. Emoji
stickers can't be added to recent stickers
- AddRecentlyFoundChat - 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
- AddSavedAnimation - 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
- AddSavedNotificationSound - Adds a new
notification sound to the list of saved notification sounds. The new notification sound is added to the top of the list. If it is
already in the list, its position isn't changed
- AddStickerToSet - Adds a new sticker to a set
- AddedReaction - Represents a reaction applied to a
message
- AddedReactions - Represents a list of reactions
added to a message
- Address - Describes an address
- AffiliateInfo - Contains information about an
affiliate that received commission from a Telegram Star transaction
- AffiliateProgramInfo - Contains information
about an active affiliate program
- AffiliateProgramParameters - Describes
parameters of an affiliate program
- AffiliateProgramSortOrder -
Describes the order of the found affiliate programs
- AffiliateProgramSortOrderCreationDate -
The affiliate programs must be sorted by creation date
- AffiliateProgramSortOrderProfitability -
The affiliate programs must be sorted by the profitability
- AffiliateProgramSortOrderRevenue -
The affiliate programs must be sorted by the expected revenue
- AffiliateType - Describes type of
affiliate for an affiliate program
- AffiliateTypeBot - The affiliate is a bot owned
by the current user
- AffiliateTypeChannel - The affiliate is a
channel chat where the current user has can_post_messages administrator right
- AffiliateTypeCurrentUser - The affiliate
is the current user
- AllowBotToSendMessages - Allows the
specified bot to send messages to the user
- AllowUnpaidMessagesFromUser - Allows
the specified user to send unpaid private messages to the current user by adding a rule to userPrivacySettingAllowUnpaidMessages
- AlternativeVideo - Describes an alternative re-
encoded quality of a video file
- AnimatedChatPhoto - Animated variant of a chat
photo in MPEG4 format
- AnimatedEmoji - Describes an animated or custom
representation of an emoji
- Animation - Describes an animation file. The animation
must be encoded in GIF or MPEG4 format
- Animations - Represents a list of animations
- AnswerCallbackQuery - Sets the result of a
callback query; for bots only
- AnswerCustomQuery - Answers a custom query; for
bots only
- AnswerInlineQuery - Sets the result of an
inline query; for bots only
- AnswerPreCheckoutQuery - Sets the result
of a pre-checkout query; for bots only
- AnswerShippingQuery - Sets the result of a
shipping query; for bots only
- AnswerWebAppQuery - Sets the result of
interaction with a Web App and sends corresponding message on behalf of the user to the chat from which the query originated; for bots
only
- ApplyPremiumGiftCode - Applies a Telegram
Premium gift code
- ArchiveChatListSettings - Contains
settings for automatic moving of chats to and from the Archive chat lists
- AssignStoreTransaction - Informs server
about an in-store purchase. For official applications only
- AttachmentMenuBot - Represents a bot, which can
be added to attachment or side menu
- AttachmentMenuBotColor - Describes a color
to highlight a bot added to attachment menu
- Audio - Describes an audio file. Audio is usually in MP3 or
M4A format
- AuthenticationCodeInfo - Information about
the authentication code that was sent
- AuthenticationCodeType - Provides
information about the method by which an authentication code is delivered to the user
- AuthenticationCodeTypeCall - A digit-
only authentication code is delivered via a phone call to the specified phone number
- AuthenticationCodeTypeFirebaseAndroid -
A digit-only authentication code is delivered via Firebase Authentication to the official Android
application
- AuthenticationCodeTypeFirebaseIos -
A digit-only authentication code is delivered via Firebase Authentication to the official iOS application
- AuthenticationCodeTypeFlashCall -
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
- AuthenticationCodeTypeFragment - A
digit-only authentication code is delivered to https://fragment.com. The user must be
logged in there via a wallet owning the phone number's NFT
- AuthenticationCodeTypeMissedCall -
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
- AuthenticationCodeTypeSms - A digit-
only authentication code is delivered via an SMS message to the specified phone number; non-official applications may not receive this
type of code
- AuthenticationCodeTypeSmsPhrase -
An authentication code is a phrase from multiple words delivered via an SMS message to the specified phone
number; non-official applications may not receive this type of code
- AuthenticationCodeTypeSmsWord - An
authentication code is a word delivered via an SMS message to the specified phone number; non-official applications may not receive this
type of code
- AuthenticationCodeTypeTelegramMessage -
A digit-only authentication code is delivered via a private Telegram message, which can be viewed from
another active session
- AuthorizationState - Represents the
current authorization state of the TDLib client
- AuthorizationStateClosed - TDLib client
is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All
queries will be responded to with error code 500. To continue working, one must create a new instance of the TDLib client
- AuthorizationStateClosing - TDLib is
closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a while. All resources will be
freed only after authorizationStateClosed has been received
- AuthorizationStateLoggingOut - The
user is currently logging out
- AuthorizationStateReady - The user has
been successfully authorized. TDLib is now ready to answer general requests
- AuthorizationStateWaitCode - TDLib
needs the user's authentication code to authorize. Call
Client.check_authentication_code to check the code
- AuthorizationStateWaitEmailAddress -
TDLib needs the user's email address to authorize. Call
Client.set_authentication_email_address to provide the
email address, or directly call
Client.check_authentication_email_code with Apple ID/Google ID token if allowed
- AuthorizationStateWaitEmailCode -
TDLib needs the user's authentication code sent to an email address to authorize. Call
Client.check_authentication_email_code to provide the
code
- AuthorizationStateWaitOtherDeviceConfirmation -
The user needs to confirm authorization on another logged in device by scanning a QR code with the
provided link
- AuthorizationStateWaitPassword -
The user has been authorized, but needs to enter a 2-step verification password to start using the application. Call
Client.check_authentication_password to provide the
password, or
Client.request_authentication_password_recovery to recover the password, or
Client.delete_account to delete the account after a week
- AuthorizationStateWaitPhoneNumber -
TDLib needs the user's phone number to authorize. Call
Client.set_authentication_phone_number to provide the
phone number, or use Client.request_qr_code_authentication
or Client.check_authentication_bot_token for other
authentication options
- AuthorizationStateWaitPremiumPurchase -
The user must buy Telegram Premium as an in-store purchase to log in. Call
Client.check_authentication_premium_purchase and
then
Client.set_authentication_premium_purchase_transaction
- AuthorizationStateWaitRegistration -
The user is unregistered and need to accept terms of service and enter their first name and last name to
finish registration. Call Client.register_user to accept the terms of
service and provide the data
- AuthorizationStateWaitTdlibParameters -
Initialization parameters are needed. Call
Client.set_tdlib_parameters to provide them
- AutoDownloadSettings - Contains auto-
download settings
- AutoDownloadSettingsPresets -
Contains auto-download settings presets for the current user
- AutosaveSettings - Describes autosave settings
- AutosaveSettingsException - Contains
autosave settings for a chat, which overrides default settings for the corresponding scope
- AutosaveSettingsScope - Describes
scope of autosave settings
- AutosaveSettingsScopeChannelChats -
Autosave settings applied to all channel chats without chat-specific settings
- AutosaveSettingsScopeChat - Autosave
settings applied to a chat
- AutosaveSettingsScopeGroupChats -
Autosave settings applied to all basic group and supergroup chats without chat-specific settings
- AutosaveSettingsScopePrivateChats -
Autosave settings applied to all private chats without chat-specific settings
- AvailableGift - Describes a gift that is available
for purchase
- AvailableGifts - Contains a list of gifts that can
be sent to another user or channel chat
- AvailableReaction - Represents an available
reaction
- AvailableReactions - Represents a list of
reactions that can be added to a message
- Background - Describes a chat background
- BackgroundFill - Describes a fill of a
background
- BackgroundFillFreeformGradient -
Describes a freeform gradient fill of a background
- BackgroundFillGradient - Describes a
gradient fill of a background
- BackgroundFillSolid - Describes a solid fill
of a background
- BackgroundType - Describes the type of
background
- BackgroundTypeChatTheme - A background
from a chat theme; can be used only as a chat background in channels
- BackgroundTypeFill - A filled background
- BackgroundTypePattern - 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
- BackgroundTypeWallpaper - A wallpaper in
JPEG format
- Backgrounds - Contains a list of backgrounds
- BanChatMember - Bans a member in a chat; requires
can_restrict_members administrator right. 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
- BanGroupCallParticipants - Bans users
from a group call not bound to a chat; requires groupCall.is_owned. Only the owner of the group call can invite the banned users back
- BankCardActionOpenUrl - Describes an action
associated with a bank card number
- BankCardInfo - Information about a bank card
- BasicGroup - Represents a basic group of 0-200 users
(must be upgraded to a supergroup to accommodate more than 200 users)
- BasicGroupFullInfo - Contains full information
about a basic group
- Birthdate - Represents a birthdate of a user
- BlockList - Describes type of block list
- BlockListMain - The main block list that disallows
writing messages to the current user, receiving their status and photo, viewing of stories, and some other actions
- BlockListStories - The block list that disallows
viewing of stories of the current user
- BlockMessageSenderFromReplies -
Blocks an original sender of a message in the Replies chat
- BoostChat - Boosts a chat and returns the list of
available chat boost slots for the current user after the boost
- BotCommand - Represents a command supported by a bot
- BotCommandScope - Represents the scope
to which bot commands are relevant
- BotCommandScopeAllChatAdministrators -
A scope covering all group and supergroup chat administrators
- BotCommandScopeAllGroupChats - A
scope covering all group and supergroup chats
- BotCommandScopeAllPrivateChats - A
scope covering all private chats
- BotCommandScopeChat - A scope covering all
members of a chat
- BotCommandScopeChatAdministrators -
A scope covering all administrators of a chat
- BotCommandScopeChatMember - A scope
covering a member of a chat
- BotCommandScopeDefault - A scope covering
all users
- BotCommands - Contains a list of bot commands
- BotInfo - Contains information about a bot
- BotMediaPreview - Describes media previews of a
bot
- BotMediaPreviewInfo - Contains a list of
media previews of a bot for the given language and the list of languages for which the bot has dedicated previews
- BotMediaPreviews - Contains a list of media
previews of a bot
- BotMenuButton - Describes a button to be shown
instead of bot commands menu button
- BotVerification - Describes verification status
provided by a bot
- BotVerificationParameters - Describes
parameters of verification that is provided by a bot
- BotWriteAccessAllowReason -
Describes a reason why a bot was allowed to write messages to the current user
- BotWriteAccessAllowReasonAcceptedRequest -
The user accepted bot's request to send messages with
Client.allow_bot_to_send_messages
- BotWriteAccessAllowReasonAddedToAttachmentMenu -
The user added the bot to attachment or side menu using
Client.toggle_bot_is_added_to_attachment_menu
- BotWriteAccessAllowReasonConnectedWebsite -
The user connected a website by logging in using Telegram Login Widget on it
- BotWriteAccessAllowReasonLaunchedWebApp -
The user launched a Web App using
Client.get_web_app_link_url
- BusinessAwayMessageSchedule -
Describes conditions for sending of away messages by a Telegram Business account
- BusinessAwayMessageScheduleAlways -
Send away messages always
- BusinessAwayMessageScheduleCustom -
Send away messages only in the specified time span
- BusinessAwayMessageScheduleOutsideOfOpeningHours
- Send away messages outside of the business opening hours
- BusinessAwayMessageSettings -
Describes settings for messages that are automatically sent by a Telegram Business account when it is away
- BusinessBotManageBar - Contains information
about a business bot that manages the chat
- BusinessBotRights - Describes rights of a
business bot
- BusinessChatLink - Contains information about a
business chat link
- BusinessChatLinkInfo - Contains information
about a business chat link
- BusinessChatLinks - Contains a list of business
chat links created by the user
- BusinessConnectedBot - Describes a bot
connected to a business account
- BusinessConnection - Describes a connection of
the bot with a business account
- BusinessFeature - Describes a feature
available to Business user accounts
- BusinessFeatureAccountLinks - The
ability to create links to the business account with predefined message text
- BusinessFeatureAwayMessage - The
ability to set up an away message
- BusinessFeatureBots - The ability to connect
a bot to the account
- BusinessFeatureChatFolderTags - The
ability to display folder names for each chat in the chat list
- BusinessFeatureEmojiStatus - The
ability to show an emoji status along with the business name
- BusinessFeatureGreetingMessage -
The ability to set up a greeting message
- BusinessFeatureLocation - The ability to
set location
- BusinessFeatureOpeningHours - The
ability to set opening hours
- BusinessFeaturePromotionAnimation -
Describes a promotion animation for a Business feature
- BusinessFeatureQuickReplies - The
ability to use quick replies
- BusinessFeatureStartPage - The ability
to customize start page
- BusinessFeatureUpgradedStories -
Allowed to use many additional features for stories
- BusinessFeatures - Contains information about
features, available to Business user accounts
- BusinessGreetingMessageSettings -
Describes settings for greeting messages that are automatically sent by a Telegram Business account as
response to incoming messages in an inactive private chat
- BusinessInfo - Contains information about a Telegram
Business account
- BusinessLocation - Represents a location of a
business
- BusinessMessage - Describes a message from a
business account as received by a bot
- BusinessMessages - Contains a list of messages
from a business account as received by a bot
- BusinessOpeningHours - Describes opening
hours of a business
- BusinessOpeningHoursInterval -
Describes an interval of time when the business is open
- BusinessRecipients - Describes private chats
chosen for automatic interaction with a business
- BusinessStartPage - Describes settings for a
business account start page
- Call - Describes a call
- CallDiscardReason - Describes the
reason why a call was discarded
- CallDiscardReasonDeclined - The call
was ended before the conversation started. It was declined by the other party
- CallDiscardReasonDisconnected - The
call was ended during the conversation because the users were disconnected
- CallDiscardReasonEmpty - The call wasn't
discarded, or the reason is unknown
- CallDiscardReasonHungUp - The call was
ended because one of the parties hung up
- CallDiscardReasonMissed - The call was
ended before the conversation started. It was canceled by the caller or missed by the other party
- CallDiscardReasonUpgradeToGroupCall -
The call was ended because it has been upgraded to a group call
- CallId - Contains the call identifier
- CallProblem - Describes the exact type of
problem with a call
- CallProblemDistortedSpeech - The
speech was distorted
- CallProblemDistortedVideo - The video
was distorted
- CallProblemDropped - The call ended
unexpectedly
- CallProblemEcho - The user heard their own voice
- CallProblemInterruptions - The other
side kept disappearing
- CallProblemNoise - The user heard background
noise
- CallProblemPixelatedVideo - The video
was pixelated
- CallProblemSilentLocal - The user couldn't
hear the other side
- CallProblemSilentRemote - The other side
couldn't hear the user
- CallProtocol - Specifies the supported call
protocols
- CallServer - Describes a server for relaying call data
- CallServerType - Describes the type of
call server
- CallServerTypeTelegramReflector -
A Telegram call reflector
- CallServerTypeWebrtc - A WebRTC server
- CallState - Describes the current call state
- CallStateDiscarded - The call has ended
successfully
- CallStateError - The call has ended with an error
- CallStateExchangingKeys - The call has
been answered and encryption keys are being exchanged
- CallStateHangingUp - The call is hanging up
after Client.discard_call has been called
- CallStatePending - The call is pending, waiting
to be accepted by a user
- CallStateReady - The call is ready to use
- CallbackQueryAnswer - Contains a bot's answer
to a callback query
- CallbackQueryPayload - Represents a
payload of a callback query
- CallbackQueryPayloadData - The payload
for a general callback button
- CallbackQueryPayloadDataWithPassword -
The payload for a callback button requiring password
- CallbackQueryPayloadGame - The payload
for a game callback button
- CanBotSendMessages - Checks whether the
specified bot can send messages to the user. Returns a 404 error if can't and the access can be granted by call to
Client.allow_bot_to_send_messages
- CanPostStory - Checks whether the current user can
post a story on behalf of a chat; requires can_post_stories right for supergroup and channel chats
- CanPostStoryResult - Represents
result of checking whether the current user can post a story on behalf of the specific chat
- CanPostStoryResultActiveStoryLimitExceeded -
The limit for the number of active stories exceeded. The user can buy Telegram Premium, delete an active
story, or wait for the oldest story to expire
- CanPostStoryResultBoostNeeded - The
chat must be boosted first by Telegram Premium subscribers to post more stories. Call
Client.get_chat_boost_status to get current boost status of the
chat
- CanPostStoryResultMonthlyLimitExceeded -
The monthly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or
wait specified time
- CanPostStoryResultOk - A story can be sent
- CanPostStoryResultPremiumNeeded -
The user must subscribe to Telegram Premium to be able to post stories
- CanPostStoryResultWeeklyLimitExceeded -
The weekly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait
specified time
- CanPurchaseFromStore - Checks whether an in-
store purchase is possible. Must be called before any in-store purchase. For official applications only
- CanSendMessageToUser - Check whether the
current user can message another user or try to create a chat with them
- CanSendMessageToUserResult -
Describes result of Client.can_send_message_to_user
- CanSendMessageToUserResultOk - The
user can be messaged
- CanSendMessageToUserResultUserHasPaidMessages -
The user can be messaged, but the messages are paid
- CanSendMessageToUserResultUserIsDeleted -
The user can't be messaged, because they are deleted or unknown
- CanSendMessageToUserResultUserRestrictsNewChats -
The user can't be messaged, because they restrict new chats with non-contacts
- CanTransferOwnership - Checks whether the
current session can be used to transfer a chat ownership to another user
- CanTransferOwnershipResult -
Represents result of checking whether the current session can be used to transfer a chat ownership to another user
- CanTransferOwnershipResultOk - The
session can be used
- CanTransferOwnershipResultPasswordNeeded -
The 2-step verification needs to be enabled first
- CanTransferOwnershipResultPasswordTooFresh -
The 2-step verification was enabled recently, user needs to wait
- CanTransferOwnershipResultSessionTooFresh -
The session was created recently, user needs to wait
- CancelDownloadFile - Stops the downloading of
a file. If a file has already been downloaded, does nothing
- CancelPasswordReset - Cancels reset of 2-step
verification password. The method can be called if passwordState.pending_reset_date > 0
- CancelPreliminaryUploadFile - Stops
the preliminary uploading of a file. Supported only for files uploaded by using
Client.preliminary_upload_file
- CancelRecoveryEmailAddressVerification -
Cancels verification of the 2-step verification recovery email address
- ChangeImportedContacts - 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
- ChangeStickerSet - Installs/uninstalls or
activates/archives a sticker set
- Chat - A chat. (Can be a private chat, basic group,
supergroup, or secret chat)
- ChatAction - Describes the different types of
activity in a chat
- ChatActionBar - Describes actions which
must be possible to do through a chat action bar
- ChatActionBarAddContact - The chat is a
private or secret chat and the other user can be added to the contact list using the method
Client.add_contact
- ChatActionBarInviteMembers - The chat
is a recently created group chat to which new members can be invited
- ChatActionBarJoinRequest - The chat is a
private chat with an administrator of a chat to which the user sent join request
- ChatActionBarReportAddBlock - The
chat is a private or secret chat, which can be reported using the method
Client.report_chat or the other user can be blocked using the method
Client.set_message_sender_block_list or the other user can
be added to the contact list using the method Client.add_contact If the chat
is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown
- ChatActionBarReportSpam - The chat can be
reported as spam using the method Client.report_chat with an empty option_id
and message_ids. If the chat is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown
- ChatActionBarSharePhoneNumber - 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
Client.share_phone_number
- ChatActionCancel - The user has canceled the
previous action
- ChatActionChoosingContact - The user is
picking a contact to send
- ChatActionChoosingLocation - The user
is picking a location or venue to send
- ChatActionChoosingSticker - The user is
picking a sticker to send
- ChatActionRecordingVideo - The user is
recording a video
- ChatActionRecordingVideoNote - The
user is recording a video note
- ChatActionRecordingVoiceNote - The
user is recording a voice note
- ChatActionStartPlayingGame - The user
has started to play a game
- ChatActionTyping - The user is typing a message
- ChatActionUploadingDocument - The
user is uploading a document
- ChatActionUploadingPhoto - The user is
uploading a photo
- ChatActionUploadingVideo - The user is
uploading a video
- ChatActionUploadingVideoNote - The
user is uploading a video note
- ChatActionUploadingVoiceNote - The
user is uploading a voice note
- ChatActionWatchingAnimations - The
user is watching animations sent by the other party by clicking on an animated emoji
- ChatActiveStories - Describes active stories
posted by a chat
- ChatAdministrator - Contains information about
a chat administrator
- ChatAdministratorRights - Describes
rights of the administrator
- ChatAdministrators - Represents a list of chat
administrators
- ChatAvailableReactions -
Describes reactions available in the chat
- ChatAvailableReactionsAll - All
reactions are available in the chat, excluding the paid reaction and custom reactions in channel chats
- ChatAvailableReactionsSome - Only
specific reactions are available in the chat
- ChatBackground - Describes a background set for a
specific chat
- ChatBoost - Describes a boost applied to a chat
- ChatBoostFeatures - Contains a list of features
available on the first chat boost levels
- ChatBoostLevelFeatures - Contains a list
of features available on a specific chat boost level
- ChatBoostLink - Contains an HTTPS link to boost a
chat
- ChatBoostLinkInfo - Contains information about
a link to boost a chat
- ChatBoostSlot - Describes a slot for chat boost
- ChatBoostSlots - Contains a list of chat boost
slots
- ChatBoostSource - Describes source of a
chat boost
- ChatBoostSourceGiftCode - The chat
created a Telegram Premium gift code for a user
- ChatBoostSourceGiveaway - The chat
created a giveaway
- ChatBoostSourcePremium - A user with
Telegram Premium subscription or gifted Telegram Premium boosted the chat
- ChatBoostStatus - Describes current boost status
of a chat
- ChatEvent - Represents a chat event
- ChatEventAccentColorChanged - The
chat accent color or background custom emoji were changed
- ChatEventAction - Represents a chat
event
- ChatEventActiveUsernamesChanged -
The chat active usernames were changed
- ChatEventAutomaticTranslationToggled -
The has_automatic_translation setting of a channel was toggled
- ChatEventAvailableReactionsChanged -
The chat available reactions were changed
- ChatEventBackgroundChanged - The chat
background was changed
- ChatEventCustomEmojiStickerSetChanged -
The supergroup sticker set with allowed custom emoji was changed
- ChatEventDescriptionChanged - The
chat was changed
- ChatEventEmojiStatusChanged - The
chat emoji status was changed
- ChatEventForumTopicCreated - A new
forum topic was created
- ChatEventForumTopicDeleted - A forum
topic was deleted
- ChatEventForumTopicEdited - A forum
topic was edited
- ChatEventForumTopicPinned - A pinned
forum topic was changed
- ChatEventForumTopicToggleIsClosed -
A forum topic was closed or reopened
- ChatEventForumTopicToggleIsHidden -
The General forum topic was hidden or unhidden
- ChatEventHasAggressiveAntiSpamEnabledToggled -
The has_aggressive_anti_spam_enabled setting of a supergroup was toggled
- ChatEventHasProtectedContentToggled -
The has_protected_content setting of a channel was toggled
- ChatEventInviteLinkDeleted - A revoked
chat invite link was deleted
- ChatEventInviteLinkEdited - A chat
invite link was edited
- ChatEventInviteLinkRevoked - A chat
invite link was revoked
- ChatEventInvitesToggled - The
can_invite_users permission of a supergroup chat was toggled
- ChatEventIsAllHistoryAvailableToggled -
The is_all_history_available setting of a supergroup was toggled
- ChatEventIsForumToggled - The is_forum
setting of a channel was toggled
- ChatEventLinkedChatChanged - The
linked chat of a supergroup was changed
- ChatEventLocationChanged - The
supergroup location was changed
- ChatEventLogFilters - Represents a set of
filters used to obtain a chat event log
- ChatEventMemberInvited - A new chat member
was invited
- ChatEventMemberJoined - A new member joined
the chat
- ChatEventMemberJoinedByInviteLink -
A new member joined the chat via an invite link
- ChatEventMemberJoinedByRequest - A
new member was accepted to the chat by an administrator
- ChatEventMemberLeft - A member left the chat
- ChatEventMemberPromoted - A chat member
has gained/lost administrator status, or the list of their administrator privileges has changed
- ChatEventMemberRestricted - A chat
member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed
- ChatEventMemberSubscriptionExtended -
A chat member extended their subscription to the chat
- ChatEventMessageAutoDeleteTimeChanged -
The message auto-delete timer was changed
- ChatEventMessageDeleted - A message was
deleted
- ChatEventMessageEdited - A message was
edited
- ChatEventMessagePinned - A message was
pinned
- ChatEventMessageUnpinned - A message was
unpinned
- ChatEventPermissionsChanged - The
chat permissions were changed
- ChatEventPhotoChanged - The chat photo was
changed
- ChatEventPollStopped - A poll in a message
was stopped
- ChatEventProfileAccentColorChanged -
The chat's profile accent color or profile background custom emoji were changed
- ChatEventShowMessageSenderToggled -
The show_message_sender setting of a channel was toggled
- ChatEventSignMessagesToggled - The
sign_messages setting of a channel was toggled
- ChatEventSlowModeDelayChanged - The
slow_mode_delay setting of a supergroup was changed
- ChatEventStickerSetChanged - The
supergroup sticker set was changed
- ChatEventTitleChanged - The chat title was
changed
- ChatEventUsernameChanged - The chat
editable username was changed
- ChatEventVideoChatCreated - A video
chat was created
- ChatEventVideoChatEnded - A video chat
was ended
- ChatEventVideoChatMuteNewParticipantsToggled -
The mute_new_participants setting of a video chat was toggled
- ChatEventVideoChatParticipantIsMutedToggled -
A video chat participant was muted or unmuted
- ChatEventVideoChatParticipantVolumeLevelChanged -
A video chat participant volume level was changed
- ChatEvents - Contains a list of chat events
- ChatFolder - Represents a folder for user chats
- ChatFolderIcon - Represents an icon for a chat
folder
- ChatFolderInfo - Contains basic information about
a chat folder
- ChatFolderInviteLink - Contains a chat
folder invite link
- ChatFolderInviteLinkInfo - Contains
information about an invite link to a chat folder
- ChatFolderInviteLinks - Represents a list
of chat folder invite links
- ChatFolderName - Describes name of a chat folder
- ChatInviteLink - Contains a chat invite link
- ChatInviteLinkCount - Describes a chat
administrator with a number of active and revoked chat invite links
- ChatInviteLinkCounts - Contains a list of
chat invite link counts
- ChatInviteLinkInfo - Contains information
about a chat invite link
- ChatInviteLinkMember - Describes a chat
member joined a chat via an invite link
- ChatInviteLinkMembers - Contains a list of
chat members joined a chat via an invite link
- ChatInviteLinkSubscriptionInfo -
Contains information about subscription plan that must be paid by the user to use a chat invite link
- ChatInviteLinks - Contains a list of chat invite
links
- ChatJoinRequest - Describes a user that sent a
join request and waits for administrator approval
- ChatJoinRequests - Contains a list of requests
to join a chat
- ChatJoinRequestsInfo - Contains information
about pending join requests for a chat
- ChatList - Describes a list of chats
- ChatListArchive - 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
- ChatListFolder - A list of chats added to a chat
folder
- ChatListMain - A main list of chats
- ChatLists - Contains a list of chat lists
- ChatLocation - Represents a location to which a chat
is connected
- ChatMember - Describes a user or a chat as a member of
another chat
- ChatMemberStatus - Provides information
about the status of a member in a chat
- ChatMemberStatusAdministrator - 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
- ChatMemberStatusBanned - 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
- ChatMemberStatusCreator - The user is the
owner of the chat and has all the administrator privileges
- ChatMemberStatusLeft - The user or the chat
is not a chat member
- ChatMemberStatusMember - The user is a
member of the chat, without any additional privileges or restrictions
- ChatMemberStatusRestricted - The user
is under certain restrictions in the chat. Not supported in basic groups and channels
- ChatMembers - Contains a list of chat members
- ChatMembersFilter - Specifies the kind
of chat members to return in Client.search_chat_members
- ChatMembersFilterAdministrators -
Returns the owner and administrators
- ChatMembersFilterBanned - Returns users
banned from the chat; can be used only by administrators in a supergroup or in a channel
- ChatMembersFilterBots - Returns bot members
of the chat
- ChatMembersFilterContacts - Returns
contacts of the user
- ChatMembersFilterMembers - Returns all
chat members, including restricted chat members
- ChatMembersFilterMention - Returns users
which can be mentioned in the chat
- ChatMembersFilterRestricted - Returns
users under certain restrictions in the chat; can be used only by administrators in a supergroup
- ChatMessageSender - Represents a message
sender, which can be used to send messages in a chat
- ChatMessageSenders - Represents a list of
message senders, which can be used to send messages in a chat
- ChatNotificationSettings - Contains
information about notification settings for a chat or a forum topic
- ChatPermissions - Describes actions that a user
is allowed to take in a chat
- ChatPhoto - Describes a chat or user profile photo
- ChatPhotoInfo - Contains basic information about
the photo of a chat
- ChatPhotoSticker - Information about the
sticker, which was used to create the chat photo. The sticker is shown at the center of the photo and occupies at most 67% of it
- ChatPhotoStickerType - Describes
type of sticker, which was used to create a chat photo
- ChatPhotoStickerTypeCustomEmoji -
Information about the custom emoji, which was used to create the chat photo
- ChatPhotoStickerTypeRegularOrMask -
Information about the sticker, which was used to create the chat photo
- ChatPhotos - Contains a list of chat or user profile
photos
- ChatPosition - Describes a position of a chat in a
chat list
- ChatRevenueAmount - Contains information about
revenue earned from sponsored messages in a chat
- ChatRevenueStatistics - A detailed
statistics about revenue earned from sponsored messages in a chat
- ChatRevenueTransaction - Contains a chat
revenue transactions
- ChatRevenueTransactionType -
Describes type of transaction for revenue earned from sponsored messages in a chat
- ChatRevenueTransactionTypeEarnings -
Describes earnings from sponsored messages in a chat in some time frame
- ChatRevenueTransactionTypeRefund -
Describes a refund for failed withdrawal of earnings
- ChatRevenueTransactionTypeWithdrawal -
Describes a withdrawal of earnings
- ChatRevenueTransactions - Contains a list
of chat revenue transactions
- ChatSource - Describes a reason why an
external chat is shown in a chat list
- ChatSourceMtprotoProxy - The chat is
sponsored by the user's MTProxy server
- ChatSourcePublicServiceAnnouncement -
The chat contains a public service announcement
- ChatStatistics - Contains a detailed
statistics about a chat
- ChatStatisticsAdministratorActionsInfo -
Contains statistics about administrator actions done by a user
- ChatStatisticsChannel - A detailed
statistics about a channel chat
- ChatStatisticsInteractionInfo -
Contains statistics about interactions with a message sent in the chat or a story posted on behalf of the chat
- ChatStatisticsInviterInfo - Contains
statistics about number of new members invited by a user
- ChatStatisticsMessageSenderInfo -
Contains statistics about messages sent by a user
- ChatStatisticsObjectType -
Describes type of object, for which statistics are provided
- ChatStatisticsObjectTypeMessage -
Describes a message sent in the chat
- ChatStatisticsObjectTypeStory -
Describes a story posted on behalf of the chat
- ChatStatisticsSupergroup - A detailed
statistics about a supergroup chat
- ChatTheme - Describes a chat theme
- ChatType - Describes the type of chat
- ChatTypeBasicGroup - A basic group (a chat
with 0-200 other users)
- ChatTypePrivate - An ordinary chat with a user
- ChatTypeSecret - A secret chat with a user
- ChatTypeSupergroup - A supergroup or channel
(with unlimited members)
- Chats - Represents a list of chats
- CheckAuthenticationBotToken - 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
Client.set_authentication_phone_number and
Client.check_authentication_code to log in
- CheckAuthenticationCode - Checks the
authentication code. Works only when the current authorization state is authorizationStateWaitCode
- CheckAuthenticationEmailCode -
Checks the authentication of an email address. Works only when the current authorization state is authorizationStateWaitEmailCode
- CheckAuthenticationPassword - Checks
the 2-step verification password for correctness. Works only when the current authorization state is authorizationStateWaitPassword
- CheckAuthenticationPasswordRecoveryCode -
Checks whether a 2-step verification password recovery code sent to an email address is valid. Works only
when the current authorization state is authorizationStateWaitPassword
- CheckAuthenticationPremiumPurchase -
Checks whether an in-store purchase of Telegram Premium is possible before authorization. Works only when
the current authorization state is authorizationStateWaitPremiumPurchase
- CheckChatFolderInviteLink - Checks the
validity of an invite link for a chat folder and returns information about the corresponding chat folder
- CheckChatInviteLink - Checks the validity of
an invite link for a chat and returns information about the corresponding chat
- CheckChatUsername - Checks whether a username
can be set for a chat
- CheckChatUsernameResult -
Represents result of checking whether a username can be set for a chat
- CheckChatUsernameResultOk - The
username can be set
- CheckChatUsernameResultPublicChatsTooMany -
The user has too many chats with username, one of them must be made private first
- CheckChatUsernameResultPublicGroupsUnavailable -
The user can't be a member of a public supergroup
- CheckChatUsernameResultUsernameInvalid -
The username is invalid
- CheckChatUsernameResultUsernameOccupied -
The username is occupied
- CheckChatUsernameResultUsernamePurchasable -
The username can be purchased at https://fragment.com.
Information about the username can be received using
Client.get_collectible_item_info
- CheckCreatedPublicChatsLimit -
Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached. The
limit can be increased with Telegram Premium
- CheckEmailAddressVerificationCode -
Checks the email address verification code for Telegram Passport
- CheckLoginEmailAddressCode - Checks
the login email address authentication
- CheckPasswordRecoveryCode - Checks
whether a 2-step verification password recovery code sent to an email address is valid
- CheckPhoneNumberCode - Check the
authentication code and completes the request for which the code was sent if appropriate
- CheckPremiumGiftCode - Return information
about a Telegram Premium gift code
- CheckQuickReplyShortcutName - Checks
validness of a name for a quick reply shortcut. Can be called synchronously
- CheckRecoveryEmailAddressCode -
Checks the 2-step verification recovery email address verification code
- CheckStickerSetName - Checks whether a name
can be used for a new sticker set
- CheckStickerSetNameResult -
Represents result of checking whether a name can be used for a new sticker set
- CheckStickerSetNameResultNameInvalid -
The name is invalid
- CheckStickerSetNameResultNameOccupied -
The name is occupied
- CheckStickerSetNameResultOk - The
name can be set
- CheckWebAppFileDownload - Checks whether
a file can be downloaded and saved locally by Web App request
- CleanFileName - Removes potentially dangerous
characters from the name of a file. Returns an empty string on failure. Can be called synchronously
- ClearAllDraftMessages - Clears message
drafts in all chats
- ClearAutosaveSettingsExceptions -
Clears the list of all autosave settings exceptions. The method is guaranteed to work only after at least
one call to Client.get_autosave_settings
- ClearImportedContacts - Clears all imported
contacts, contact list remains unchanged
- ClearRecentEmojiStatuses - Clears the
list of recently used emoji statuses for self status
- ClearRecentReactions - Clears the list of
recently used reactions
- ClearRecentStickers - Clears the list of
recently used stickers
- ClearRecentlyFoundChats - Clears the list
of recently found chats
- ClearSearchedForTags - Clears the list of
recently searched for hashtags or cashtags
- ClickAnimatedEmojiMessage - 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
- ClickChatSponsoredMessage - Informs
TDLib that the user opened the sponsored chat via the button, the name, the chat photo, a mention in the sponsored message text, or the
media in the sponsored message
- ClickPremiumSubscriptionButton -
Informs TDLib that the user clicked Premium subscription button on the Premium features screen
- Client
- Close - Closes the TDLib instance. All databases will be
flushed to disk and properly closed. After the Client.close completes,
updateAuthorizationState with authorizationStateClosed will be sent. Can be called before initialization
- CloseBirthdayUser - Describes a user that had
or will have a birthday soon
- CloseChat - Informs TDLib that the chat is closed by
the user. Many useful activities depend on the chat being opened or closed
- CloseSecretChat - Closes a secret chat,
effectively transferring its state to secretChatStateClosed
- CloseStory - Informs TDLib that a story is closed by
the user
- CloseWebApp - Informs TDLib that a previously opened
Web App was closed
- ClosedVectorPath - Represents a closed vector
path. The path begins at the end point of the last command. The coordinate system origin is in the upper-left corner
- CollectibleItemInfo - Contains information
about a collectible item and its last purchase
- CollectibleItemType - Describes a
collectible item that can be purchased at https://fragment.com
- CollectibleItemTypePhoneNumber - A
phone number
- CollectibleItemTypeUsername - A
username
- CommitPendingPaidMessageReactions -
Applies all pending paid reactions on a message
- ConfirmQrCodeAuthentication -
Confirms QR code authentication on another device. Returns created session on success
- ConfirmSession - Confirms an unconfirmed session
of the current user from another device
- ConnectAffiliateProgram - Connects an
affiliate program to the given affiliate. Returns information about the connected affiliate program
- ConnectedAffiliateProgram - Describes
an affiliate program that was connected to an affiliate
- ConnectedAffiliatePrograms -
Represents a list of affiliate programs that were connected to an affiliate
- ConnectedWebsite - Contains information about
one website the current user is logged in with Telegram
- ConnectedWebsites - Contains a list of websites
the current user is logged in with Telegram
- ConnectionState - Describes the current
state of the connection to Telegram servers
- ConnectionStateConnecting -
Establishing a connection to the Telegram servers
- ConnectionStateConnectingToProxy -
Establishing a connection with a proxy server
- ConnectionStateReady - There is a working
connection to the Telegram servers
- ConnectionStateUpdating - Downloading
data expected to be received while the application was offline
- ConnectionStateWaitingForNetwork -
Waiting for the network to become available. Use
Client.set_network_type to change the available network type
- Contact - Describes a user contact
- Count - Contains a counter
- Countries - Contains information about countries
- CountryInfo - Contains information about a country
- CreateBasicGroupChat - Returns an existing
chat corresponding to a known basic group
- CreateBusinessChatLink - Creates a
business chat link for the current account. Requires Telegram Business subscription. There can be up to
getOption("business_chat_link_count_max") links created. Returns the created link
- CreateCall - Creates a new call
- CreateChatFolder - Creates new chat folder.
Returns information about the created chat folder. There can be up to getOption("chat_folder_count_max") chat folders, but the limit can
be increased with Telegram Premium
- CreateChatFolderInviteLink - Creates a
new invite link for a chat folder. A link can be created for a chat folder if it has only pinned and included chats
- CreateChatInviteLink - 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
- CreateChatSubscriptionInviteLink -
Creates a new subscription invite link for a channel chat. Requires can_invite_users right in the chat
- CreateForumTopic - Creates a topic in a forum
supergroup chat; requires can_manage_topics administrator or can_create_topics member right in the supergroup
- CreateGroupCall - Creates a new group call that
isn't bound to a chat
- CreateInvoiceLink - Creates a link for the
given invoice; for bots only
- CreateNewBasicGroupChat - Creates a new
basic group and sends a corresponding messageBasicGroupChatCreate. Returns information about the newly created chat
- CreateNewSecretChat - Creates a new secret
chat. Returns the newly created chat
- CreateNewStickerSet - Creates a new sticker
set. Returns the newly created sticker set
- CreateNewSupergroupChat - Creates a new
supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat
- CreatePrivateChat - Returns an existing chat
corresponding to a given user
- CreateSecretChat - Returns an existing chat
corresponding to a known secret chat
- CreateSupergroupChat - Returns an existing
chat corresponding to a known supergroup or channel
- CreateTemporaryPassword - Creates a new
temporary password for processing payments
- CreateVideoChat - Creates a video chat (a group
call bound to a chat). Available only for basic groups, supergroups and channels; requires can_manage_video_chats administrator right
- CreatedBasicGroupChat - Contains
information about a newly created basic group chat
- CurrentWeather - Describes the current weather
- CustomRequestResult - Contains the result of
a custom request
- Data - Contains some binary data
- DatabaseStatistics - Contains database
statistics
- Date - Represents a date according to the Gregorian calendar
- DateRange - Represents a date range
- DatedFile - File with the date it was uploaded
- DeclineGroupCallInvitation - Declines
an invitation to an active group call via messageGroupCall. Can be called both by the sender and the receiver of the invitation
- DecryptGroupCallData - Decrypts group call
data received by tgcalls
- DeepLinkInfo - Contains information about a tg: deep
link
- DeleteAccount - 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
- DeleteAllCallMessages - Deletes all call
messages
- DeleteAllRevokedChatInviteLinks -
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
- DeleteBotMediaPreviews - Delete media
previews from the list of media previews of a bot
- DeleteBusinessChatLink - Deletes a
business chat link of the current account
- DeleteBusinessConnectedBot - Deletes
the business bot that is connected to the current user account
- DeleteBusinessMessages - Deletes messages
on behalf of a business account; for bots only
- DeleteBusinessStory - Deletes a story posted
by the bot on behalf of a business account; for bots only
- DeleteChat - Deletes a chat along with all messages in
the corresponding chat for all chat members. For group chats this will release the usernames and remove all members. Use the field
chat.can_be_deleted_for_all_users to find whether the method can be applied to the chat
- DeleteChatBackground - Deletes background in
a specific chat
- DeleteChatFolder - Deletes existing chat folder
- DeleteChatFolderInviteLink - Deletes
an invite link for a chat folder
- DeleteChatHistory - 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
- DeleteChatMessagesByDate - 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
- DeleteChatMessagesBySender - Deletes
all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator
right
- DeleteChatReplyMarkup - Deletes the default
reply markup from a chat. Must be called after a one-time keyboard or a replyMarkupForceReply reply markup has been used. An
updateChatReplyMarkup update will be sent if the reply markup is changed
- DeleteCommands - Deletes commands supported by the
bot for the given user scope and language; for bots only
- DeleteDefaultBackground - Deletes default
background for chats
- DeleteFile - Deletes a file from the TDLib file cache
- DeleteForumTopic - Deletes all messages in a
forum topic; requires can_delete_messages administrator right in the supergroup unless the user is creator of the topic, the topic has
no messages from other users and has at most 11 messages
- DeleteLanguagePack - 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
- DeleteMessages - Deletes messages
- DeletePassportElement - Deletes a Telegram
Passport element
- DeleteProfilePhoto - Deletes a profile photo
- DeleteQuickReplyShortcut - Deletes a
quick reply shortcut
- DeleteQuickReplyShortcutMessages -
Deletes specified quick reply messages
- DeleteRevokedChatInviteLink - 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
- DeleteSavedCredentials - Deletes saved
credentials for all payment provider bots
- DeleteSavedMessagesTopicHistory -
Deletes all messages in a Saved Messages topic
- DeleteSavedMessagesTopicMessagesByDate -
Deletes all messages between the specified dates in a Saved Messages topic. Messages sent in the last 30
seconds will not be deleted
- DeleteSavedOrderInfo - Deletes saved order
information
- DeleteStickerSet - Completely deletes a sticker
set
- DeleteStory - Deletes a previously posted story. Can
be called only if story.can_be_deleted == true
- Destroy - 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
- DeviceToken - Represents a data needed to
subscribe for push notifications through Client.register_device 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
- DeviceTokenApplePush - A token for Apple
Push Notification service
- DeviceTokenApplePushVoIP - A token for
Apple Push Notification service VoIP notifications
- DeviceTokenBlackBerryPush - A token for
BlackBerry Push Service
- DeviceTokenFirebaseCloudMessaging -
A token for Firebase Cloud Messaging
- DeviceTokenHuaweiPush - A token for HUAWEI
Push Service
- DeviceTokenMicrosoftPush - A token for
Microsoft Push Notification Service
- DeviceTokenMicrosoftPushVoIP - A
token for Microsoft Push Notification Service VoIP channel
- DeviceTokenSimplePush - A token for Simple
Push API for Firefox OS
- DeviceTokenTizenPush - A token for Tizen
Push Service
- DeviceTokenUbuntuPush - A token for Ubuntu
Push Client service
- DeviceTokenWebPush - A token for web Push API
- DeviceTokenWindowsPush - A token for
Windows Push Notification Services
- DiceStickers - Contains animated stickers
which must be used for dice animation rendering
- DiceStickersRegular - A regular animated
sticker
- DiceStickersSlotMachine - Animated
stickers to be combined into a slot machine
- DisableAllSupergroupUsernames -
Disables all active non-editable usernames of a supergroup or channel, requires owner privileges in the supergroup or channel
- DisableProxy - Disables the currently enabled proxy.
Can be called before authorization
- DiscardCall - Discards a call
- DisconnectAffiliateProgram -
Disconnects an affiliate program from the given affiliate and immediately deactivates its referral link. Returns updated information
about the disconnected affiliate program
- DisconnectAllWebsites - Disconnects all
websites from the current user's Telegram account
- DisconnectWebsite - Disconnects website from
the current user's Telegram account
- Document - Describes a document of any type
- DownloadFile - Downloads a file from the cloud.
Download progress and completion of the download will be notified through updateFile updates
- DownloadedFileCounts - Contains number of
being downloaded and recently downloaded files found
- DraftMessage - Contains information about a message
draft
- EditBotMediaPreview - Replaces media preview
in the list of media previews of a bot. Returns the new preview after edit is completed server-side
- EditBusinessChatLink - Edits a business chat
link of the current account. Requires Telegram Business subscription. Returns the edited link
- EditBusinessMessageCaption - Edits the
caption of a message sent on behalf of a business account; for bots only
- EditBusinessMessageLiveLocation -
Edits the content of a live location in a message sent on behalf of a business account; for bots only
- EditBusinessMessageMedia - Edits the
media content of a message with a text, an animation, an audio, a document, a photo or a video in a message sent on behalf of a business
account; for bots only
- EditBusinessMessageReplyMarkup -
Edits the reply markup of a message sent on behalf of a business account; for bots only
- EditBusinessMessageText - Edits the text
of a text or game message sent on behalf of a business account; for bots only
- EditBusinessStory - Changes a story posted by
the bot on behalf of a business account; for bots only
- EditChatFolder - Edits existing chat folder.
Returns information about the edited chat folder
- EditChatFolderInviteLink - Edits an
invite link for a chat folder
- EditChatInviteLink - Edits a non-primary
invite link for a chat. Available for basic groups, supergroups, and channels. If the link creates a subscription, then expiration_date,
member_limit and creates_join_request must not be used. Requires administrator privileges and can_invite_users right in the chat for own
links and owner privileges for other links
- EditChatSubscriptionInviteLink -
Edits a subscription invite link for a channel chat. Requires can_invite_users right in the chat for own links and owner privileges for
other links
- EditCustomLanguagePackInfo - Edits
information about a custom local language pack in the current localization target. Can be called before authorization
- EditForumTopic - Edits title and icon of a topic
in a forum supergroup chat; requires can_manage_topics right in the supergroup unless the user is creator of the topic
- EditInlineMessageCaption - Edits the
caption of an inline message sent via a bot; for bots only
- EditInlineMessageLiveLocation -
Edits the content of a live location in an inline message sent via a bot; for bots only
- EditInlineMessageMedia - Edits the media
content of a message with a text, an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots
only
- EditInlineMessageReplyMarkup - Edits
the reply markup of an inline message sent via a bot; for bots only
- EditInlineMessageText - Edits the text of
an inline text or game message sent via a bot; for bots only
- EditMessageCaption - Edits the message content
caption. Returns the edited message after the edit is completed on the server side
- EditMessageLiveLocation - 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
- EditMessageMedia - Edits the media content of a
message, including message caption. If only the caption needs to be edited, use
Client.edit_message_caption instead. 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
- EditMessageReplyMarkup - Edits the message
reply markup; for bots only. Returns the edited message after the edit is completed on the server side
- EditMessageSchedulingState - 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
- EditMessageText - 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
- EditProxy - Edits an existing proxy server for network
requests. Can be called before authorization
- EditQuickReplyMessage - Asynchronously
edits the text, media or caption of a quick reply message. Use quickReplyMessage.can_be_edited to check whether a message can be edited.
Media message can be edited only to a media message. The type of message content in an album can't be changed with exception of
replacing a photo with a video or vice versa
- EditStarSubscription - Cancels or re-enables
Telegram Star subscription
- EditStory - Changes content and caption of a story. Can
be called only if story.can_be_edited == true
- EditStoryCover - Changes cover of a video story.
Can be called only if story.can_be_edited == true and the story isn't being edited now
- EditUserStarSubscription - Cancels or re
-enables Telegram Star subscription for a user; for bots only
- EmailAddressAuthentication -
Contains authentication data for an email address
- EmailAddressAuthenticationAppleId -
An authentication token received through Apple ID
- EmailAddressAuthenticationCode -
An authentication code delivered to a user's email address
- EmailAddressAuthenticationCodeInfo -
Information about the email address authentication code that was sent
- EmailAddressAuthenticationGoogleId -
An authentication token received through Google ID
- EmailAddressResetState -
Describes reset state of an email address
- EmailAddressResetStateAvailable -
Email address can be reset after the given period. Call
Client.reset_authentication_email_address to reset it
and allow the user to authorize with a code sent to the user's phone number
- EmailAddressResetStatePending -
Email address reset has already been requested. Call
Client.reset_authentication_email_address to check whether immediate reset is possible
- EmojiCategories - Represents a list of emoji
categories
- EmojiCategory - Describes an emoji category
- EmojiCategorySource - Describes
source of stickers for an emoji category
- EmojiCategorySourcePremium - The
category contains premium stickers that must be found by
Client.get_premium_stickers
- EmojiCategorySourceSearch - The
category contains a list of similar emoji to search for in Client.get_stickers
and Client.search_stickers for stickers, or
Client.get_inline_query_results with the bot
getOption("animation_search_bot_username") for animations
- EmojiCategoryType - Describes type of
emoji category
- EmojiCategoryTypeChatPhoto - The
category must be used for chat photo emoji selection
- EmojiCategoryTypeDefault - The category
must be used by default (e.g., for custom emoji or animation search)
- EmojiCategoryTypeEmojiStatus - The
category must be used for emoji status selection
- EmojiCategoryTypeRegularStickers -
The category must be used by default for regular sticker selection. It may contain greeting emoji category
and premium stickers
- EmojiKeyword - Represents an emoji with its keyword
- EmojiKeywords - Represents a list of emojis with
their keywords
- EmojiReaction - Contains information about an emoji
reaction
- EmojiStatus - Describes an emoji to be shown instead
of the Telegram Premium badge
- EmojiStatusCustomEmojis - Contains a list
of custom emoji identifiers for emoji statuses
- EmojiStatusType - Describes type of
emoji status
- EmojiStatusTypeCustomEmoji - A custom
emoji set as emoji status
- EmojiStatusTypeUpgradedGift - An
upgraded gift set as emoji status
- EmojiStatuses - Contains a list of emoji statuses
- Emojis - Represents a list of emojis
- EnableProxy - Enables a proxy. Only one proxy can be
enabled at a time. Can be called before authorization
- EncryptGroupCallData - Encrypts group call
data before sending them over network using tgcalls
- EncryptedCredentials - Contains encrypted
Telegram Passport data credentials
- EncryptedPassportElement - Contains
information about an encrypted Telegram Passport element; for bots only
- EndGroupCall - Ends a group call. Requires
groupCall.can_be_managed right for video chats or groupCall.is_owned otherwise
- EndGroupCallRecording - Ends recording of
an active group call; for video chats only. Requires groupCall.can_be_managed right
- EndGroupCallScreenSharing - Ends screen
sharing in a joined group call
- Error - An object of this type can be returned on every
function call, in case of an error
- FactCheck - Describes a fact-check added to the message
by an independent checker
- FailedToAddMember - Contains information about
a user that has failed to be added to a chat
- FailedToAddMembers - Represents a list of
users that has failed to be added to a chat
- File - Represents a file
- FileDownload - Describes a file added to file
download list
- FileDownloadedPrefixSize - Contains size
of downloaded prefix of a file
- FileType - Represents the type of file
- FileTypeAnimation - The file is an animation
- FileTypeAudio - The file is an audio file
- FileTypeDocument - The file is a document
- FileTypeNone - The data is not a file
- FileTypeNotificationSound - The file is
a notification sound
- FileTypePhoto - The file is a photo
- FileTypePhotoStory - The file is a photo
published as a story
- FileTypeProfilePhoto - The file is a profile
photo
- FileTypeSecret - The file was sent to a secret
chat (the file type is not known to the server)
- FileTypeSecretThumbnail - The file is a
thumbnail of a file from a secret chat
- FileTypeSecure - The file is a file from Secure
storage used for storing Telegram Passport files
- FileTypeSelfDestructingPhoto - The
file is a self-destructing photo in a private chat
- FileTypeSelfDestructingVideo - The
file is a self-destructing video in a private chat
- FileTypeSelfDestructingVideoNote -
The file is a self-destructing video note in a private chat
- FileTypeSelfDestructingVoiceNote -
The file is a self-destructing voice note in a private chat
- FileTypeSticker - The file is a sticker
- FileTypeThumbnail - The file is a thumbnail of
another file
- FileTypeUnknown - The file type is not yet known
- FileTypeVideo - The file is a video
- FileTypeVideoNote - The file is a video note
- FileTypeVideoStory - The file is a video
published as a story
- FileTypeVoiceNote - The file is a voice note
- FileTypeWallpaper - The file is a wallpaper or
a background pattern
- FinishFileGeneration - Finishes the file
generation
- FirebaseAuthenticationSettings -
Contains settings for Firebase Authentication in the official applications
- FirebaseAuthenticationSettingsAndroid -
Settings for Firebase Authentication in the official Android application
- FirebaseAuthenticationSettingsIos -
Settings for Firebase Authentication in the official iOS application
- FirebaseDeviceVerificationParameters -
Describes parameters to be used for device verification
- FirebaseDeviceVerificationParametersPlayIntegrity
- Device verification must be performed with the classic Play Integrity verification (
https://developer.android.com/google/play/integrity/classic)
- FirebaseDeviceVerificationParametersSafetyNet -
Device verification must be performed with the SafetyNet Attestation API
- FormattedText - A text with some entities
- ForumTopic - Describes a forum topic
- ForumTopicIcon - Describes a forum topic icon
- ForumTopicInfo - Contains basic information about
a forum topic
- ForumTopics - Describes a list of forum topics
- ForwardMessages - 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
- ForwardSource - Contains information about the last
message from which a new message was forwarded last time
- FoundAffiliateProgram - Describes a found
affiliate program
- FoundAffiliatePrograms - Represents a list
of found affiliate programs
- FoundChatBoosts - Contains a list of boosts
applied to a chat
- FoundChatMessages - Contains a list of messages
found by a search in a given chat
- FoundFileDownloads - Contains a list of
downloaded files, found by a search
- FoundMessages - Contains a list of messages found
by a search
- FoundPosition - Contains 0-based match position
- FoundPositions - Contains 0-based positions of
matched objects
- FoundStories - Contains a list of stories found by a
search
- FoundUsers - Represents a list of found users
- FoundWebApp - Contains information about a Web App
found by its short name
- Game - Describes a game. Use
Client.get_internal_link with internalLinkTypeGame to share the game
- GameHighScore - Contains one row of the game high
score table
- GameHighScores - Contains a list of game high
scores
- GetAccountTtl - Returns the period of inactivity
after which the account of the current user will automatically be deleted
- GetActiveSessions - Returns all active sessions
of the current user
- GetAllPassportElements - Returns all
available Telegram Passport elements
- GetAllStickerEmojis - Returns unique emoji
that correspond to stickers to be found by the getStickers(sticker_type, query, 1000000, chat_id)
- GetAnimatedEmoji - Returns an animated emoji
corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji
- GetApplicationConfig - Returns application
config, provided by the server. Can be called before authorization
- GetApplicationDownloadLink - Returns
the link for downloading official Telegram application to be used when the current user invites friends to Telegram
- GetArchiveChatListSettings - Returns
settings for automatic moving of chats to and from the Archive chat lists
- GetArchivedStickerSets - Returns a list of
archived sticker sets
- GetAttachedStickerSets - Returns a list of
sticker sets attached to a file, including regular, mask, and emoji sticker sets. Currently, only animations, photos, and videos can
have attached sticker sets
- GetAttachmentMenuBot - Returns information
about a bot that can be added to attachment or side menu
- GetAuthorizationState - Returns the current
authorization state. This is an offline method. For informational purposes only. Use updateAuthorizationState instead to maintain the
current authorization state. Can be called before initialization
- GetAutoDownloadSettingsPresets -
Returns auto-download settings presets for the current user
- GetAutosaveSettings - Returns autosave
settings for the current user
- GetAvailableChatBoostSlots - Returns
the list of available chat boost slots for the current user
- GetAvailableGifts - Returns gifts that can be
sent to other users and channel chats
- GetBackgroundUrl - Constructs a persistent HTTP
URL for a background
- GetBankCardInfo - Returns information about a
bank card
- GetBasicGroup - Returns information about a basic
group by its identifier. This is an offline method if the current user is not a bot
- GetBasicGroupFullInfo - Returns full
information about a basic group by its identifier
- GetBlockedMessageSenders - Returns users
and chats that were blocked by the current user
- GetBotInfoDescription - Returns the text
shown in the chat with a bot if the chat is empty in the given language. Can be called only if userTypeBot.can_be_edited == true
- GetBotInfoShortDescription - Returns
the text shown on a bot's profile page and sent together with the link when users share the bot in the given language. Can be called
only if userTypeBot.can_be_edited == true
- GetBotMediaPreviewInfo - Returns the list
of media previews for the given language and the list of languages for which the bot has dedicated previews
- GetBotMediaPreviews - Returns the list of
media previews of a bot
- GetBotName - Returns the name of a bot in the given
language. Can be called only if userTypeBot.can_be_edited == true
- GetBotSimilarBotCount - Returns approximate
number of bots similar to the given bot
- GetBotSimilarBots - Returns a list of bots
similar to the given bot
- GetBusinessAccountStarAmount -
Returns the amount of Telegram Stars owned by a business account; for bots only
- GetBusinessChatLinkInfo - Returns
information about a business chat link
- GetBusinessChatLinks - Returns business chat
links created for the current account
- GetBusinessConnectedBot - Returns the
business bot that is connected to the current user account. Returns a 404 error if there is no connected bot
- GetBusinessConnection - Returns information
about a business connection by its identifier; for bots only
- GetBusinessFeatures - Returns information
about features, available to Business users
- GetCallbackQueryAnswer - 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
- GetCallbackQueryMessage - Returns
information about a message with the callback button that originated a callback query; for bots only
- GetChat - Returns information about a chat by its
identifier. This is an offline method if the current user is not a bot
- GetChatActiveStories - Returns the list of
active stories posted by the given chat
- GetChatAdministrators - Returns a list of
administrators of the chat with their custom titles
- GetChatArchivedStories - Returns the list
of all stories posted by the given chat; requires can_edit_stories right in the chat. The stories are returned in reverse chronological
order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib
- GetChatAvailableMessageSenders -
Returns the list of message sender identifiers, which can be used to send messages in a chat
- GetChatAvailablePaidMessageReactionSenders -
Returns the list of message sender identifiers, which can be used to send a paid reaction in a chat
- GetChatBoostFeatures - Returns the list of
features available for different chat boost levels. This is an offline method
- GetChatBoostLevelFeatures - Returns the
list of features available on the specific chat boost level. This is an offline method
- GetChatBoostLink - Returns an HTTPS link to
boost the specified supergroup or channel chat
- GetChatBoostLinkInfo - Returns information
about a link to boost a chat. Can be called for any internal link of the type internalLinkTypeChatBoost
- GetChatBoostStatus - Returns the current boost
status for a supergroup or a channel chat
- GetChatBoosts - Returns the list of boosts applied
to a chat; requires administrator rights in the chat
- GetChatEventLog - 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)
- GetChatFolder - Returns information about a chat
folder by its identifier
- GetChatFolderChatCount - Returns
approximate number of chats in a being created chat folder. Main and archive chat lists must be fully preloaded for this function to
work correctly
- GetChatFolderChatsToLeave - Returns
identifiers of pinned or always included chats from a chat folder, which are suggested to be left when the chat folder is deleted
- GetChatFolderDefaultIconName -
Returns default icon name for a folder. Can be called synchronously
- GetChatFolderInviteLinks - Returns
invite links created by the current user for a shareable chat folder
- GetChatFolderNewChats - Returns new chats
added to a shareable chat folder by its owner. The method must be called at most once in
getOption("chat_folder_new_chats_update_period") for the given chat folder
- GetChatHistory - Returns messages in a chat. The
messages are returned in 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 method if only_local is true
- GetChatInviteLink - 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
- GetChatInviteLinkCounts - Returns the
list of chat administrators with number of their invite links. Requires owner privileges in the chat
- GetChatInviteLinkMembers - 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
- GetChatInviteLinks - 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
- GetChatJoinRequests - Returns pending join
requests in a chat
- GetChatListsToAddChat - Returns chat lists
to which the chat can be added. This is an offline method
- GetChatMember - Returns information about a single
member of a chat
- GetChatMessageByDate - Returns the last
message sent in a chat no later than the specified date. Returns a 404 error if such message doesn't exist
- GetChatMessageCalendar - 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"
- GetChatMessageCount - Returns approximate
number of messages of the specified type in the chat
- GetChatMessagePosition - Returns
approximate 1-based position of a message among messages, which can be found by the specified filter in the chat. Cannot be used in
secret chats
- GetChatNotificationSettingsExceptions -
Returns the list of chats with non-default notification settings for new messages
- GetChatPinnedMessage - Returns information
about a newest pinned message in the chat. Returns a 404 error if the message doesn't exist
- GetChatPostedToChatPageStories -
Returns the list of stories that posted by the given chat to its chat page. If from_story_id == 0, then pinned stories are returned
first. Then, stories are returned in reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the
number of returned stories is chosen by TDLib
- GetChatRevenueStatistics - Returns
detailed revenue statistics about a chat. Currently, this method can be used only for channels if
supergroupFullInfo.can_get_revenue_statistics == true or bots if userFullInfo.bot_info.can_get_revenue_statistics == true
- GetChatRevenueTransactions - Returns
the list of revenue transactions for a chat. Currently, this method can be used only for channels if
supergroupFullInfo.can_get_revenue_statistics == true or bots if userFullInfo.bot_info.can_get_revenue_statistics == true
- GetChatRevenueWithdrawalUrl - Returns
a URL for chat revenue withdrawal; requires owner privileges in the channel chat or the bot. Currently, this method can be used only if
getOption("can_withdraw_chat_revenue") for channels with supergroupFullInfo.can_get_revenue_statistics == true or bots with
userFullInfo.bot_info.can_get_revenue_statistics == true
- GetChatScheduledMessages - Returns all
scheduled messages in a chat. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id)
- GetChatSimilarChatCount - Returns
approximate number of chats similar to the given chat
- GetChatSimilarChats - Returns a list of chats
similar to the given chat
- GetChatSparseMessagePositions -
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
- GetChatSponsoredMessages - Returns
sponsored messages to be shown in a chat; for channel chats and chats with bots only
- GetChatStatistics - 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
- GetChatStoryInteractions - Returns
interactions with a story posted in a chat. Can be used only if story is posted on behalf of a chat and the user is an administrator in
the chat
- GetChats - Returns an ordered list of chats from the
beginning of a chat list. For informational purposes only. Use Client.load_chats
and updates processing instead to maintain chat lists in a consistent state
- GetChatsForChatFolderInviteLink -
Returns identifiers of chats from a chat folder, suitable for adding to a chat folder invite link
- GetChatsToPostStories - Returns supergroup
and channel chats in which the current user has the right to post stories. The chats must be rechecked with
Client.can_post_story before actually trying to post a story there
- GetCloseFriends - Returns all
Client.close friends of the current user
- GetCollectibleItemInfo - Returns
information about a given collectible item that was purchased at https://fragment.com
- GetCommands - Returns the list of commands supported
by the bot for the given user scope and language; for bots only
- GetConnectedAffiliateProgram -
Returns an affiliate program that were connected to the given affiliate by identifier of the bot that created the program
- GetConnectedAffiliatePrograms -
Returns affiliate programs that were connected to the given affiliate
- GetConnectedWebsites - Returns all website
where the current user used Telegram to log in
- GetContacts - Returns all contacts of the user
- GetCountries - Returns information about existing
countries. Can be called before authorization
- GetCountryCode - 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
- GetCountryFlagEmoji - Returns an emoji for
the given country. Returns an empty string on failure. Can be called synchronously
- GetCreatedPublicChats - Returns a list of
public chats of the specified type, owned by the user
- GetCurrentState - 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
- GetCurrentWeather - Returns the current weather
in the given location
- GetCustomEmojiReactionAnimations -
Returns TGS stickers with generic animations for custom emoji reactions
- GetCustomEmojiStickers - Returns the list
of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found stickers are returned
- GetDatabaseStatistics - Returns database
statistics
- GetDeepLinkInfo - 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
- GetDefaultBackgroundCustomEmojiStickers -
Returns default list of custom emoji stickers for reply background
- GetDefaultChatEmojiStatuses - Returns
default emoji statuses for chats
- GetDefaultChatPhotoCustomEmojiStickers -
Returns default list of custom emoji stickers for placing on a chat photo
- GetDefaultEmojiStatuses - Returns default
emoji statuses for self status
- GetDefaultMessageAutoDeleteTime -
Returns default message auto-delete time setting for new chats
- GetDefaultProfilePhotoCustomEmojiStickers -
Returns default list of custom emoji stickers for placing on a profile photo
- GetDisallowedChatEmojiStatuses -
Returns the list of emoji statuses, which can't be used as chat emoji status, even they are from a sticker set with
is_allowed_as_chat_emoji_status == true
- GetEmojiCategories - Returns available emoji
categories
- GetEmojiReaction - Returns information about an
emoji reaction. Returns a 404 error if the reaction is not found
- GetEmojiSuggestionsUrl - 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
- GetExternalLink - 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
Client.get_external_link_info to find whether a prior user
confirmation is needed
- GetExternalLinkInfo - 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 link
preview is disabled in secret chats
- GetFavoriteStickers - Returns favorite
stickers
- GetFile - Returns information about a file. This is an
offline method
- GetFileDownloadedPrefixSize - Returns
file downloaded prefix size from a given offset, in bytes
- GetFileExtension - Returns the extension of a
file, guessed by its MIME type. Returns an empty string on failure. Can be called synchronously
- GetFileMimeType - Returns the MIME type of a
file, guessed by its extension. Returns an empty string on failure. Can be called synchronously
- GetForumTopic - Returns information about a forum
topic
- GetForumTopicDefaultIcons - Returns the
list of custom emoji, which can be used as forum topic icon by all users
- GetForumTopicLink - Returns an HTTPS link to a
topic in a forum chat. This is an offline method
- GetForumTopics - Returns found forum topics in a
forum chat. This is a temporary method for getting information about topic list from the server
- GetGameHighScores - 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
- GetGiftUpgradePreview - Returns examples of
possible upgraded gifts for a regular gift
- GetGiveawayInfo - Returns information about a
giveaway
- GetGreetingStickers - Returns greeting
stickers from regular sticker sets that can be used for the start page of other users
- GetGrossingWebAppBots - Returns the most
grossing Web App bots
- GetGroupCall - Returns information about a group
call
- GetGroupCallParticipants - Returns
information about participants of a non-joined group call that is not bound to a chat
- GetGroupsInCommon - Returns a list of common
group chats with a given user. Chats are sorted by their type and creation date
- GetImportedContactCount - Returns the
total number of imported contacts
- GetInactiveSupergroupChats - 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. Also, the limit can be increased with Telegram Premium
- GetInlineGameHighScores - Returns game
high scores and some part of the high score table in the range of the specified user; for bots only
- GetInlineQueryResults - 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
- GetInstalledBackgrounds - Returns
backgrounds installed by the user
- GetInstalledStickerSets - Returns a list
of installed sticker sets
- GetInternalLink - Returns an HTTPS or a tg: link
with the given type. Can be called before authorization
- GetInternalLinkType - Returns information
about the type of internal link. Returns a 404 error if the link is not internal. Can be called before authorization
- GetJsonString - Converts a JsonValue object to
corresponding JSON-serialized string. Can be called synchronously
- GetJsonValue - Converts a JSON-serialized string to
corresponding JsonValue object. Can be called synchronously
- GetKeywordEmojis - Return emojis matching the
keyword. Supported only if the file database is enabled. Order of results is unspecified
- GetLanguagePackInfo - Returns information
about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization
- GetLanguagePackString - 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
- GetLanguagePackStrings - Returns strings
from a language pack in the current localization target by their keys. Can be called before authorization
- GetLinkPreview - Returns a link preview by the
text of a message. Do not call this function too often. Returns a 404 error if the text has no link preview
- GetLocalizationTargetInfo - Returns
information about the current localization target. This is an offline method if only_local is true. Can be called before authorization
- GetLogStream - Returns information about currently
used log stream for internal logging of TDLib. Can be called synchronously
- GetLogTagVerbosityLevel - Returns current
verbosity level for a specified TDLib internal log tag. Can be called synchronously
- GetLogTags - Returns the list of available TDLib
internal log tags, for example, ["actor", "binlog", "connections", "notifications", "proxy"]. Can be called synchronously
- GetLogVerbosityLevel - Returns current
verbosity level of the internal logging of TDLib. Can be called synchronously
- GetLoginUrl - 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 Client.get_login_url_info 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
- GetLoginUrlInfo - Returns information about a
button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button
- GetMainWebApp - Returns information needed to open
the main Web App of a bot
- GetMapThumbnailFile - Returns information
about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded
- GetMarkdownText - 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
- GetMe - Returns the current user
- GetMenuButton - Returns menu button set by the bot
for the given user; for bots only
- GetMessage - Returns information about a message.
Returns a 404 error if the message doesn't exist
- GetMessageAddedReactions - Returns
reactions added for a message, along with their sender
- GetMessageAvailableReactions -
Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatAvailableReactions
for the chat, or updateMessageInteractionInfo for the message
- GetMessageEffect - Returns information about a
message effect. Returns a 404 error if the effect is not found
- GetMessageEmbeddingCode - Returns an HTML
code for embedding the message. Available only if messageProperties.can_get_embedding_code
- GetMessageFileType - Returns information about
a file with messages exported from another application
- GetMessageImportConfirmationText -
Returns a confirmation text to be shown to the user before starting message import
- GetMessageLink - Returns an HTTPS link to a
message in a chat. Available only if messageProperties.can_get_link, or if messageProperties.can_get_media_timestamp_links and a media
timestamp link is generated. This is an offline method
- GetMessageLinkInfo - Returns information about
a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage
- GetMessageLocally - Returns information about a
message, if it is available without sending network request. Returns a 404 error if message isn't available locally. This is an offline
method
- GetMessageProperties - Returns properties of
a message. This is an offline method
- GetMessagePublicForwards - Returns
forwarded copies of a channel message to different public channels and public reposts as a story. Can be used only if
messageProperties.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib
- GetMessageReadDate - Returns read date of a
recent outgoing message in a private chat. The method can be called if messageProperties.can_get_read_date == true
- GetMessageStatistics - Returns detailed
statistics about a message. Can be used only if messageProperties.can_get_statistics == true
- GetMessageThread - Returns information about a
message thread. Can be used only if messageProperties.can_get_message_thread == true
- GetMessageThreadHistory - Returns
messages in a message thread of a message. Can be used only if messageProperties.can_get_message_thread == true. Message thread of a
channel message is in the channel's linked supergroup. The messages are returned in reverse chronological order (i.e., in order of
decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib
- GetMessageViewers - 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 messageProperties.can_get_viewers == true
- GetMessages - Returns information about messages. If
a message is not found, returns null on the corresponding position of the result
- GetNetworkStatistics - Returns network data
usage statistics. Can be called before authorization
- GetNewChatPrivacySettings - Returns
privacy settings for new chat creation
- GetOption - 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. Can be called synchronously for options "version"
and "commit_hash"
- GetOwnedBots - Returns the list of bots owned by the
current user
- GetOwnedStickerSets - Returns sticker sets
owned by the current user
- GetPaidMessageRevenue - Returns the total
number of Telegram Stars received by the current user for paid messages from the given user
- GetPassportAuthorizationForm -
Returns a Telegram Passport authorization form for sharing data with a service
- GetPassportAuthorizationFormAvailableElements -
Returns already available Telegram Passport elements suitable for completing a Telegram Passport
authorization form. Result can be received only once for each authorization form
- GetPassportElement - Returns one of the
available Telegram Passport elements
- GetPasswordState - Returns the current state of
2-step verification
- GetPaymentForm - Returns an invoice payment form.
This method must be called when the user presses inline button of the type inlineKeyboardButtonTypeBuy, or wants to buy access to media
in a messagePaidMedia message
- GetPaymentReceipt - Returns information about a
successful payment
- GetPhoneNumberInfo - Returns information about
a phone number by its prefix. Can be called before authorization
- GetPhoneNumberInfoSync - Returns
information about a phone number by its prefix synchronously.
Client.get_countries must be called at least once after changing localization to the specified language if properly localized
country information is expected. Can be called synchronously
- GetPollVoters - Returns message senders voted for
the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib
- GetPreferredCountryLanguage - 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
- GetPremiumFeatures - Returns information about
features, available to Premium users
- GetPremiumGiftPaymentOptions -
Returns available options for gifting Telegram Premium to a user
- GetPremiumGiveawayPaymentOptions -
Returns available options for creating of Telegram Premium giveaway or manual distribution of Telegram
Premium among chat members
- GetPremiumInfoSticker - Returns the sticker
to be used as representation of the Telegram Premium subscription
- GetPremiumLimit - Returns information about a
limit, increased for Premium users. Returns a 404 error if the limit is unknown
- GetPremiumState - Returns state of Telegram
Premium subscription and promotion videos for Premium features
- GetPremiumStickerExamples - Returns
examples of premium stickers for demonstration purposes
- GetPremiumStickers - Returns premium stickers
from regular sticker sets
- GetPreparedInlineMessage - Saves an
inline message to be sent by the given user
- GetProxies - Returns the list of proxies that are
currently set up. Can be called before authorization
- GetProxyLink - Returns an HTTPS link, which can be
used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization
- GetPushReceiverId - Returns a globally unique
push notification subscription identifier for identification of an account, which has received a push notification. Can be called
synchronously
- GetReadDatePrivacySettings - Returns
privacy settings for message read date
- GetReceivedGift - Returns information about a
received gift
- GetReceivedGifts - Returns gifts received by the
given user or chat
- GetRecentEmojiStatuses - Returns recent
emoji statuses for self status
- GetRecentInlineBots - Returns up to 20
recently used inline bots in the order of their last usage
- GetRecentStickers - Returns a list of recently
used stickers
- GetRecentlyOpenedChats - Returns recently
opened chats. This is an offline method. Returns chats in the order of last opening
- GetRecentlyVisitedTMeUrls - Returns
t.me URLs recently visited by a newly registered user
- GetRecommendedChatFolders - Returns
recommended chat folders for the current user
- GetRecommendedChats - Returns a list of
channel chats recommended to the current user
- GetRecoveryEmailAddress - 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
- GetRemoteFile - Returns information about a file by
its remote identifier. This is an offline method. 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
- GetRepliedMessage - Returns information about a
non-bundled message that is replied by a given message. Also, returns the pinned message, the game message, the invoice message, the
message with a previously set same background, the giveaway message, and the topic creation message for messages of the types
messagePinMessage, messageGameScore, messagePaymentSuccessful, messageChatSetBackground, messageGiveawayCompleted and topic messages
without non-bundled replied message respectively. Returns a 404 error if the message doesn't exist
- GetSavedAnimations - Returns saved animations
- GetSavedMessagesTags - Returns tags used in
Saved Messages or a Saved Messages topic
- GetSavedMessagesTopicHistory -
Returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order of decreasing
message_id)
- GetSavedMessagesTopicMessageByDate -
Returns the last message sent in a Saved Messages topic no later than the specified date
- GetSavedNotificationSound - Returns
saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with the specified identifier
- GetSavedNotificationSounds - Returns
the list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used
- GetSavedOrderInfo - Returns saved order
information. Returns a 404 error if there is no saved order information
- GetScopeNotificationSettings -
Returns the notification settings for chats of a given type
- GetSearchSponsoredChats - Returns
sponsored chats to be shown in the search results
- GetSearchedForTags - Returns recently searched
for hashtags or cashtags by their prefix
- GetSecretChat - Returns information about a secret
chat by its identifier. This is an offline method
- GetStarAdAccountUrl - Returns a URL for a
Telegram Ad platform account that can be used to set up advertisements for the chat paid in the owned Telegram Stars
- GetStarGiftPaymentOptions - Returns
available options for Telegram Stars gifting
- GetStarGiveawayPaymentOptions -
Returns available options for Telegram Star giveaway creation
- GetStarPaymentOptions - Returns available
options for Telegram Stars purchase
- GetStarRevenueStatistics - Returns
detailed Telegram Star revenue statistics
- GetStarSubscriptions - Returns the list of
Telegram Star subscriptions for the current user
- GetStarTransactions - Returns the list of
Telegram Star transactions for the specified owner
- GetStarWithdrawalUrl - Returns a URL for
Telegram Star withdrawal
- GetStatisticalGraph - Loads an asynchronous
or a zoomed in statistical graph
- GetStickerEmojis - 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
- GetStickerOutline - Returns outline of a
sticker. This is an offline method. Returns a 404 error if the outline isn't known
- GetStickerSet - Returns information about a sticker
set by its identifier
- GetStickerSetName - Returns name of a sticker
set by its identifier
- GetStickers - Returns stickers from the installed
sticker sets that correspond to any of the given emoji or can be found by sticker-specific keywords. If the query is non-empty, then
favorite, recently used or trending stickers may also be returned
- GetStorageStatistics - Returns storage usage
statistics. Can be called before authorization
- GetStorageStatisticsFast - Quickly
returns approximate storage usage statistics. Can be called before authorization
- GetStory - Returns a story
- GetStoryAvailableReactions - Returns
reactions, which can be chosen for a story
- GetStoryInteractions - Returns interactions
with a story. The method can be called only for stories posted on behalf of the current user
- GetStoryNotificationSettingsExceptions -
Returns the list of chats with non-default notification settings for stories
- GetStoryPublicForwards - Returns forwards
of a story as a message to public chats and reposts by public channels. Can be used only if the story is posted on behalf of the current
user or story.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib
- GetStoryStatistics - Returns detailed
statistics about a story. Can be used only if story.can_get_statistics == true
- GetSuggestedFileName - Returns suggested
name for saving a file in a given directory
- GetSuggestedStickerSetName - Returns a
suggested name for a new sticker set with a given title
- GetSuitableDiscussionChats - 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
Client.toggle_supergroup_is_all_history_available first
- GetSuitablePersonalChats - Returns a
list of channel chats, which can be used as a personal chat
- GetSupergroup - Returns information about a
supergroup or a channel by its identifier. This is an offline method if the current user is not a bot
- GetSupergroupFullInfo - Returns full
information about a supergroup or a channel by its identifier, cached for up to 1 minute
- GetSupergroupMembers - 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
- GetSupportName - Returns localized name of the
Telegram support user; for Telegram support only
- GetSupportUser - Returns a user that can be
contacted to get support
- GetTemporaryPasswordState - Returns
information about the current temporary password
- GetTextEntities - Returns all entities (mentions,
hashtags, cashtags, bot commands, bank card numbers, URLs, and email addresses) found in the text. Can be called synchronously
- GetThemeParametersJsonString -
Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously
- GetThemedChatEmojiStatuses - Returns
up to 8 emoji statuses, which must be shown in the emoji status list for chats
- GetThemedEmojiStatuses - Returns up to 8
emoji statuses, which must be shown right after the default Premium Badge in the emoji status list for self status
- GetTimeZones - Returns the list of supported time
zones
- GetTopChats - Returns a list of frequently used chats
- GetTrendingStickerSets - Returns a list of
trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib
- GetUpgradedGift - Returns information about an
upgraded gift by its name
- GetUpgradedGiftEmojiStatuses -
Returns available upgraded gift emoji statuses for self status
- GetUpgradedGiftWithdrawalUrl -
Returns a URL for upgraded gift withdrawal in the TON blockchain as an NFT; requires owner privileges for gifts owned by a chat
- GetUser - Returns information about a user by their
identifier. This is an offline method if the current user is not a bot
- GetUserChatBoosts - Returns the list of boosts
applied to a chat by a given user; requires administrator rights in the chat; for bots only
- GetUserFullInfo - Returns full information about
a user by their identifier
- GetUserLink - Returns an HTTPS link, which can be
used to get information about the current user
- GetUserPrivacySettingRules - Returns
the current privacy settings
- GetUserProfilePhotos - Returns the profile
photos of a user. Personal and public photo aren't returned
- GetUserSupportInfo - Returns support
information for the given user; for Telegram support only
- GetVideoChatAvailableParticipants -
Returns the list of participant identifiers, on whose behalf a video chat in the chat can be joined
- GetVideoChatInviteLink - Returns invite
link to a video chat in a public chat
- GetVideoChatRtmpUrl - Returns RTMP URL for
streaming to the video chat of a chat; requires can_manage_video_chats administrator right
- GetVideoChatStreamSegment - Returns a
file with a segment of a video chat stream in a modified OGG format for audio or MPEG-4 format for video
- GetVideoChatStreams - Returns information
about available video chat streams
- GetWebAppLinkUrl - Returns an HTTPS URL of a Web
App to open after a link of the type internalLinkTypeWebApp is clicked
- GetWebAppPlaceholder - Returns a default
placeholder for Web Apps of a bot. This is an offline method. Returns a 404 error if the placeholder isn't known
- GetWebAppUrl - Returns an HTTPS URL of a Web App to
open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryResultsButtonTypeWebApp button
- GetWebPageInstantView - Returns an instant
view version of a web page if available. This is an offline method if only_local is true. Returns a 404 error if the web page has no
instant view page
- Gift - Describes a gift that can be sent to another user or
channel chat
- GiftForResale - Describes a gift available for
resale
- GiftForResaleOrder - Describes order
in which upgraded gifts for resale will be sorted
- GiftForResaleOrderNumber - The gifts
will be sorted by their number from the smallest to the largest
- GiftForResaleOrderPrice - The gifts will
be sorted by their price from the lowest to the highest
- GiftForResaleOrderPriceChangeDate -
The gifts will be sorted by the last date when their price was changed from the newest to the oldest
- GiftPremiumWithStars - Allows to buy a
Telegram Premium subscription for another user with payment in Telegram Stars; for bots only
- GiftSettings - Contains settings for gift receiving
for a user
- GiftUpgradePreview - Contains examples of
possible upgraded gifts for the given regular gift
- GiftsForResale - Describes gifts available for
resale
- GiveawayInfo - Contains information about a
giveaway
- GiveawayInfoCompleted - Describes a
completed giveaway
- GiveawayInfoOngoing - Describes an ongoing
giveaway
- GiveawayParameters - Describes parameters of a
giveaway
- GiveawayParticipantStatus -
Contains information about status of a user in a giveaway
- GiveawayParticipantStatusAdministrator -
The user can't participate in the giveaway, because they are an administrator in one of the chats that
created the giveaway
- GiveawayParticipantStatusAlreadyWasMember -
The user can't participate in the giveaway, because they have already been member of the chat
- GiveawayParticipantStatusDisallowedCountry -
The user can't participate in the giveaway, because they phone number is from a disallowed country
- GiveawayParticipantStatusEligible -
The user is eligible for the giveaway
- GiveawayParticipantStatusParticipating -
The user participates in the giveaway
- GiveawayPrize - Contains information about
a giveaway prize
- GiveawayPrizePremium - The giveaway sends
Telegram Premium subscriptions to the winners
- GiveawayPrizeStars - The giveaway sends
Telegram Stars to the winners
- GroupCall - Describes a group call
- GroupCallDataChannel - Describes
data channel for a group call
- GroupCallDataChannelMain - The main data
channel for audio and video data
- GroupCallDataChannelScreenSharing -
The data channel for screen sharing
- GroupCallId - Contains the group call identifier
- GroupCallInfo - Contains information about a just
created or just joined group call
- GroupCallJoinParameters - Describes
parameters used to join a group call
- GroupCallParticipant - Represents a group
call participant
- GroupCallParticipantVideoInfo -
Contains information about a group call participant's video channel
- GroupCallParticipants - Contains
identifiers of group call participants
- GroupCallRecentSpeaker - Describes a
recently speaking participant in a group call
- GroupCallVideoQuality - Describes
the quality of a group call video
- GroupCallVideoQualityFull - The best
available video quality
- GroupCallVideoQualityMedium - The
medium video quality
- GroupCallVideoQualityThumbnail -
The worst available video quality
- GroupCallVideoSourceGroup - Describes a
group of video synchronization source identifiers
- Hashtags - Contains a list of hashtags
- HideContactCloseBirthdays - Hides the
list of contacts that have Client.close birthdays for 24 hours
- HideSuggestedAction - Hides a suggested
action
- HttpUrl - Contains an HTTP URL
- IdentityDocument - An identity document
- ImportContacts - Adds new contacts or edits
existing contacts by their phone numbers; contacts' user identifiers are ignored
- ImportMessages - Imports messages exported from
another app
- ImportedContacts - Represents the result of an
Client.import_contacts request
- InlineKeyboardButton - Represents a single
button in an inline keyboard
- InlineKeyboardButtonType -
Describes the type of inline keyboard button
- InlineKeyboardButtonTypeBuy - A
button to buy something. This button must be in the first column and row of the keyboard and can be attached only to a message with
content of the type messageInvoice
- InlineKeyboardButtonTypeCallback -
A button that sends a callback query to a bot
- InlineKeyboardButtonTypeCallbackGame -
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
- InlineKeyboardButtonTypeCallbackWithPassword -
A button that asks for the 2-step verification password of the current user and then sends a callback
query to a bot
- InlineKeyboardButtonTypeCopyText -
A button that copies specified text to clipboard
- InlineKeyboardButtonTypeLoginUrl -
A button that opens a specified URL and automatically authorize the current user by calling
Client.get_login_url_info
- InlineKeyboardButtonTypeSwitchInline -
A button that forces an inline query to the bot to be inserted in the input field
- InlineKeyboardButtonTypeUrl - A
button that opens a specified URL
- InlineKeyboardButtonTypeUser - A
button with a user reference to be handled in the same way as textEntityTypeMentionName entities
- InlineKeyboardButtonTypeWebApp - A
button that opens a Web App by calling Client.open_web_app
- InlineQueryResult - Represents a
single result of an inline query
- InlineQueryResultAnimation -
Represents an animation file
- InlineQueryResultArticle - Represents a
link to an article or web page
- InlineQueryResultAudio - Represents an
audio file
- InlineQueryResultContact - Represents a
user contact
- InlineQueryResultDocument - Represents
a document
- InlineQueryResultGame - Represents
information about a game
- InlineQueryResultLocation - Represents
a point on the map
- InlineQueryResultPhoto - Represents a
photo
- InlineQueryResultSticker - Represents a
sticker
- InlineQueryResultVenue - Represents
information about a venue
- InlineQueryResultVideo - Represents a
video
- InlineQueryResultVoiceNote -
Represents a voice note
- InlineQueryResults - Represents the results of
the inline query. Use
Client.send_inline_query_result_message to send the result of the query
- InlineQueryResultsButton - Represents a
button to be shown above inline query results
- InlineQueryResultsButtonType -
Represents type of button in results of inline query
- InlineQueryResultsButtonTypeStartBot -
Describes the button that opens a private chat with the bot and sends a start message to the bot with the
given parameter
- InlineQueryResultsButtonTypeWebApp -
Describes the button that opens a Web App by calling
Client.get_web_app_url
- InputBackground - Contains information
about background to set
- InputBackgroundLocal - A background from a
local file
- InputBackgroundPrevious - A background
previously set in the chat; for chat backgrounds only
- InputBackgroundRemote - A background from
the server
- InputBusinessChatLink - Describes a
business chat link to create or edit
- InputBusinessStartPage - Describes
settings for a business account start page to set
- InputChatPhoto - Describes a photo to be
set as a user profile or chat photo
- InputChatPhotoAnimation - An animation in
MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 1280 and be at most 2MB in size
- InputChatPhotoPrevious - A previously used
profile photo of the current user
- InputChatPhotoStatic - A static photo in
JPEG format
- InputChatPhotoSticker - A sticker on a
custom background
- InputCredentials - Contains information
about the payment method chosen by the user
- InputCredentialsApplePay - Applies if a
user enters new credentials using Apple Pay
- InputCredentialsGooglePay - Applies if
a user enters new credentials using Google Pay
- InputCredentialsNew - Applies if a user
enters new credentials on a payment provider website
- InputCredentialsSaved - Applies if a user
chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary
password
- InputFile - Points to a file
- InputFileGenerated - A file generated by the
application. The application must handle updates updateFileGenerationStart and updateFileGenerationStop to generate the file when asked
by TDLib
- InputFileId - A file defined by its unique identifier
- InputFileLocal - A file defined by a local path
- InputFileRemote - A file defined by its remote
identifier. The remote identifier is guaranteed to be usable only if the corresponding file is still accessible to the user and known to
TDLib. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database
is disabled, then the corresponding object with the file must be preloaded by the application
- InputGroupCall - Describes a non-joined
group call that isn't bound to a chat
- InputGroupCallLink - The group call is
accessible through a link
- InputGroupCallMessage - The group call is
accessible through a message of the type messageGroupCall
- InputIdentityDocument - An identity
document to be saved to Telegram Passport
- InputInlineQueryResult -
Represents a single result of an inline query; for bots only
- InputInlineQueryResultAnimation -
Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC video
- InputInlineQueryResultArticle -
Represents a link to an article or web page
- InputInlineQueryResultAudio -
Represents a link to an MP3 audio file
- InputInlineQueryResultContact -
Represents a user contact
- InputInlineQueryResultDocument -
Represents a link to a file
- InputInlineQueryResultGame -
Represents a game
- InputInlineQueryResultLocation -
Represents a point on the map
- InputInlineQueryResultPhoto -
Represents link to a JPEG image
- InputInlineQueryResultSticker -
Represents a link to a WEBP, TGS, or WEBM sticker
- InputInlineQueryResultVenue -
Represents information about a venue
- InputInlineQueryResultVideo -
Represents a link to a page containing an embedded video player or a video file
- InputInlineQueryResultVoiceNote -
Represents a link to an opus-encoded audio file within an OGG container, single channel audio
- InputInvoice - Describes an invoice to
process
- InputInvoiceMessage - An invoice from a
message of the type messageInvoice or paid media purchase from messagePaidMedia
- InputInvoiceName - An invoice from a link of the
type internalLinkTypeInvoice
- InputInvoiceTelegram - An invoice for a
payment toward Telegram; must not be used in the in-store apps
- InputMessageAnimation - An animation
message (GIF-style).
- InputMessageAudio - An audio message
- InputMessageContact - A message containing a
user contact
- InputMessageContent - The content of
a message to send
- InputMessageDice - A dice message
- InputMessageDocument - A document message
(general file)
- InputMessageForwarded - A forwarded message
- InputMessageGame - A message with a game; not
supported for channels or secret chats
- InputMessageInvoice - A message with an
invoice; can be used only by bots
- InputMessageLocation - A message with a
location
- InputMessagePaidMedia - A message with paid
media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed
- InputMessagePhoto - A photo message
- InputMessagePoll - 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
- InputMessageReplyTo - Contains
information about the message or the story to be replied
- InputMessageReplyToExternalMessage -
Describes a message to be replied that is from a different chat or a forum topic; not supported in secret
chats
- InputMessageReplyToMessage - Describes
a message to be replied in the same chat and forum topic
- InputMessageReplyToStory - Describes a
story to be replied
- InputMessageSticker - A sticker message
- InputMessageStory - A message with a forwarded
story. Stories can't be forwarded to secret chats. A story can be forwarded only if story.can_be_forwarded
- InputMessageText - A text message
- InputMessageVenue - A message with information
about a venue
- InputMessageVideo - A video message
- InputMessageVideoNote - A video note
message
- InputMessageVoiceNote - A voice note
message
- InputPaidMedia - Describes a paid media to be sent
- InputPaidMediaType - Describes type
of paid media to sent
- InputPaidMediaTypePhoto - The media is a
photo. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must
be at most 20
- InputPaidMediaTypeVideo - The media is a
video
- InputPassportElement - Contains
information about a Telegram Passport element to be saved
- InputPassportElementAddress - A
Telegram Passport element to be saved containing the user's address
- InputPassportElementBankStatement -
A Telegram Passport element to be saved containing the user's bank statement
- InputPassportElementDriverLicense -
A Telegram Passport element to be saved containing the user's driver license
- InputPassportElementEmailAddress -
A Telegram Passport element to be saved containing the user's email address
- InputPassportElementError - Contains
the of an error in a Telegram Passport element; for bots only
- InputPassportElementErrorSource -
Contains the description of an error in a Telegram Passport element; for bots only
- InputPassportElementErrorSourceDataField -
A data field contains an error. The error is considered resolved when the field's value changes
- InputPassportElementErrorSourceFile -
The file contains an error. The error is considered resolved when the file changes
- InputPassportElementErrorSourceFiles -
The list of attached files contains an error. The error is considered resolved when the file list changes
- InputPassportElementErrorSourceFrontSide -
The front side of the document contains an error. The error is considered resolved when the file with the
front side of the document changes
- InputPassportElementErrorSourceReverseSide -
The reverse side of the document contains an error. The error is considered resolved when the file with
the reverse side of the document changes
- InputPassportElementErrorSourceSelfie -
The selfie contains an error. The error is considered resolved when the file with the selfie changes
- InputPassportElementErrorSourceTranslationFile -
One of the files containing the translation of the document contains an error. The error is considered
resolved when the file with the translation changes
- InputPassportElementErrorSourceTranslationFiles -
The translation of the document contains an error. The error is considered resolved when the list of files
changes
- InputPassportElementErrorSourceUnspecified -
The element contains an error in an unspecified place. The error will be considered resolved when new data
is added
- InputPassportElementIdentityCard -
A Telegram Passport element to be saved containing the user's identity card
- InputPassportElementInternalPassport -
A Telegram Passport element to be saved containing the user's internal passport
- InputPassportElementPassport - A
Telegram Passport element to be saved containing the user's passport
- InputPassportElementPassportRegistration -
A Telegram Passport element to be saved containing the user's passport registration
- InputPassportElementPersonalDetails -
A Telegram Passport element to be saved containing the user's personal details
- InputPassportElementPhoneNumber -
A Telegram Passport element to be saved containing the user's phone number
- InputPassportElementRentalAgreement -
A Telegram Passport element to be saved containing the user's rental agreement
- InputPassportElementTemporaryRegistration -
A Telegram Passport element to be saved containing the user's temporary registration
- InputPassportElementUtilityBill -
A Telegram Passport element to be saved containing the user's utility bill
- InputPersonalDocument - A personal document
to be saved to Telegram Passport
- InputSticker - A sticker to be added to a sticker
set
- InputStoryArea - Describes a clickable rectangle
area on a story media to be added
- InputStoryAreaType - Describes type
of clickable area on a story media to be added
- InputStoryAreaTypeFoundVenue - An
area pointing to a venue found by the bot getOption("venue_search_bot_username")
- InputStoryAreaTypeLink - An area pointing
to a HTTP or tg:// link
- InputStoryAreaTypeLocation - An area
pointing to a location
- InputStoryAreaTypeMessage - An area
pointing to a message
- InputStoryAreaTypePreviousVenue -
An area pointing to a venue already added to the story
- InputStoryAreaTypeSuggestedReaction -
An area pointing to a suggested reaction
- InputStoryAreaTypeUpgradedGift -
An area with an upgraded gift
- InputStoryAreaTypeWeather - An area
with information about weather
- InputStoryAreas - Contains a list of story areas
to be added
- InputStoryContent - The content of a
story to post
- InputStoryContentPhoto - A photo story
- InputStoryContentVideo - A video story
- InputTextQuote - Describes manually chosen quote
from another message
- InputThumbnail - 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
- InternalLinkType - Describes an
internal https://t.me or tg: link, which must be processed by the application in a special
way
- InternalLinkTypeActiveSessions -
The link is a link to the Devices section of the application. Use
Client.get_active_sessions to get the list of active sessions and show them to the user
- InternalLinkTypeAttachmentMenuBot -
The link is a link to an attachment menu bot to be opened in the specified or a chosen chat. Process given
target_chat to open the chat. Then, call Client.search_public_chat
with the given bot username, check that the user is a bot and can be added to attachment menu. Then, use
Client.get_attachment_menu_bot to receive information about the
bot. If the bot isn't added to attachment menu, then show a disclaimer about Mini Apps being third-party applications, ask the user to
accept their Terms of service and confirm adding the bot to side and attachment menu. If the user accept the terms and confirms adding,
then use Client.toggle_bot_is_added_to_attachment_menu
to add the bot. If the attachment menu bot can't be used in the opened chat, show an error to the user. If the bot is added to
attachment menu and can be used in the chat, then use Client.open_web_app
with the given URL
- InternalLinkTypeAuthenticationCode -
The link contains an authentication code. Call
Client.check_authentication_code with the code if the current
authorization state is authorizationStateWaitCode
- InternalLinkTypeBackground - The link
is a link to a background. Call Client.search_background with the given
background name to process the link. If background is found and the user wants to apply it, then call
Client.set_default_background
- InternalLinkTypeBotAddToChannel -
The link is a link to a Telegram bot, which is expected to be added to a channel chat as an administrator.
Call Client.search_public_chat with the given bot username and check
that the user is a bot, ask the current user to select a channel chat to add the bot to as an administrator. Then, call
Client.get_chat_member to receive the current bot rights in the chat and
if the bot already is an administrator, check that the current user can edit its administrator rights and combine received rights with
the requested administrator rights. Then, show confirmation box to the user, and call
Client.set_chat_member_status with the chosen chat and confirmed
rights
- InternalLinkTypeBotStart - The link is a
link to a chat with a Telegram bot. Call Client.search_public_chat
with the given bot username, check that the user is a bot, show START button in the chat with the bot, and then call
Client.send_bot_start_message with the given start parameter after
the button is pressed
- InternalLinkTypeBotStartInGroup -
The link is a link to a Telegram bot, which is expected to be added to a group chat. Call
Client.search_public_chat 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 basic group or a supergroup chat to add the bot to, taking
into account that bots can be added to a public supergroup only by administrators of the supergroup. If administrator rights are
provided by the link, call Client.get_chat_member to receive the current
bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights,
combine received rights with the requested administrator rights, show confirmation box to the user, and call
Client.set_chat_member_status with the chosen chat and confirmed
administrator rights. Before call to Client.set_chat_member_status
it may be required to upgrade the chosen basic group chat to a supergroup chat. Then, if start_parameter isn't empty, call
Client.send_bot_start_message with the given start parameter and
the chosen chat; otherwise, just send /start message with bot's username added to the chat
- InternalLinkTypeBusinessChat - The
link is a link to a business chat. Use
Client.get_business_chat_link_info with the provided link name to get information about the link, then open received private chat
and replace chat draft with the provided text
- InternalLinkTypeBuyStars - The link is a
link to the Telegram Star purchase section of the application
- InternalLinkTypeChangePhoneNumber -
The link is a link to the change phone number section of the application
- InternalLinkTypeChatAffiliateProgram -
The link is an affiliate program link. Call
Client.search_chat_affiliate_program with the given
username and referrer to process the link
- InternalLinkTypeChatBoost - The link is
a link to boost a Telegram chat. Call
Client.get_chat_boost_link_info with the given URL to process the link. If the chat is found, then call
Client.get_chat_boost_status and
Client.get_available_chat_boost_slots to get the current
boost status and check whether the chat can be boosted. If the user wants to boost the chat and the chat can be boosted, then call
Client.boost_chat
- InternalLinkTypeChatFolderInvite -
The link is an invite link to a chat folder. Call
Client.check_chat_folder_invite_link with the given invite
link to process the link. If the link is valid and the user wants to join the chat folder, then call
Client.add_chat_folder_by_invite_link
- InternalLinkTypeChatFolderSettings -
The link is a link to the folder section of the application settings
- InternalLinkTypeChatInvite - The link
is a chat invite link. Call Client.check_chat_invite_link with the
given invite link to process the link. If the link is valid and the user wants to join the chat, then call
Client.join_chat_by_invite_link
-
InternalLinkTypeDefaultMessageAutoDeleteTimerSettings - The link is a link to the default message
auto-delete timer settings section of the application settings
- InternalLinkTypeEditProfileSettings -
The link is a link to the edit profile section of the application settings
- InternalLinkTypeGame - The link is a link to
a game. Call Client.search_public_chat 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
Client.send_message with inputMessageGame
- InternalLinkTypeGroupCall - The link is
a link to a group call that isn't bound to a chat. Call
Client.join_group_call with the given invite_link
- InternalLinkTypeInstantView - The
link must be opened in an Instant View. Call
Client.get_web_page_instant_view with the given URL to process the link. If Instant View is found, then show it, otherwise, open
the fallback URL in an external browser
- InternalLinkTypeInvoice - The link is a
link to an invoice. Call Client.get_payment_form with the given invoice
name to process the link
- InternalLinkTypeLanguagePack - The
link is a link to a language pack. Call Client.get_language_pack_info
with the given language pack identifier to process the link. If the language pack is found and the user wants to apply it, then
call Client.set_option for the option "language_pack_id"
- InternalLinkTypeLanguageSettings -
The link is a link to the language section of the application settings
- InternalLinkTypeMainWebApp - The link
is a link to the main Web App of a bot. Call Client.search_public_chat
with the given bot username, check that the user is a bot and has the main Web App. If the bot can be added to attachment menu, then
use Client.get_attachment_menu_bot to receive information about
the bot, then if the bot isn't added to side menu, show a disclaimer about Mini Apps being third-party applications, ask the user to
accept their Terms of service and confirm adding the bot to side and attachment menu, then if the user accepts the terms and confirms
adding, use
Client.toggle_bot_is_added_to_attachment_menu to add the bot. Then, use
Client.get_main_web_app with the given start parameter and mode and open
the returned URL as a Web App
- InternalLinkTypeMessage - The link is a
link to a Telegram message or a forum topic. Call
Client.get_message_link_info with the given URL to process the link, and then open received forum topic or chat and show the
message there
- InternalLinkTypeMessageDraft - 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
- InternalLinkTypeMyStars - The link is a
link to the screen with information about Telegram Star balance and transactions of the current user
- InternalLinkTypePassportDataRequest -
The link contains a request of Telegram passport data. Call
Client.get_passport_authorization_form with the given
parameters to process the link if the link was received from outside of the application; otherwise, ignore it
- InternalLinkTypePhoneNumberConfirmation -
The link can be used to confirm ownership of a phone number to prevent account deletion. Call
Client.send_phone_number_code with the given phone number and with
phoneNumberCodeTypeConfirmOwnership with the given hash to process the link. If succeeded, call
Client.check_phone_number_code to check entered by the user code,
or Client.resend_phone_number_code to resend it
- InternalLinkTypePremiumFeatures -
The link is a link to the Premium features screen of the application from which the user can subscribe to
Telegram Premium. Call Client.get_premium_features with the given
referrer to process the link
- InternalLinkTypePremiumGift - The
link is a link to the screen for gifting Telegram Premium subscriptions to friends via inputInvoiceTelegram with
telegramPaymentPurposePremiumGift payments or in-store purchases
- InternalLinkTypePremiumGiftCode -
The link is a link with a Telegram Premium gift code. Call
Client.check_premium_gift_code with the given code to process the
link. If the code is valid and the user wants to apply it, then call
Client.apply_premium_gift_code
- InternalLinkTypePrivacyAndSecuritySettings -
The link is a link to the privacy and security section of the application settings
- InternalLinkTypeProxy - The link is a link
to a proxy. Call Client.add_proxy with the given parameters to process the link
and add the proxy
- InternalLinkTypePublicChat - The link
is a link to a chat by its username. Call Client.search_public_chat
with the given chat username to process the link. If the chat is found, open its profile information screen or the chat itself. If draft
text isn't empty and the chat is a private chat with a regular user, then put the draft text in the input field
- InternalLinkTypeQrCodeAuthentication -
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
- InternalLinkTypeRestorePurchases -
The link forces restore of App Store purchases when opened. For official iOS application only
- InternalLinkTypeSettings - The link is a
link to application settings
- InternalLinkTypeStickerSet - The link
is a link to a sticker set. Call Client.search_sticker_set with the
given sticker set name to process the link and show the sticker set. If the sticker set is found and the user wants to add it, then call
Client.change_sticker_set
- InternalLinkTypeStory - The link is a link
to a story. Call Client.search_public_chat with the given poster
username, then call Client.get_story with the received chat identifier and the
given story identifier, then show the story if received
- InternalLinkTypeTheme - The link is a link
to a cloud theme. TDLib has no theme support yet
- InternalLinkTypeThemeSettings - The
link is a link to the theme section of the application settings
- InternalLinkTypeUnknownDeepLink -
The link is an unknown tg: link. Call
Client.get_deep_link_info to process the link
- InternalLinkTypeUnsupportedProxy -
The link is a link to an unsupported proxy. An alert can be shown to the user
- InternalLinkTypeUpgradedGift - The
link is a link to an upgraded gift. Call Client.get_upgraded_gift with
the given name to process the link
- InternalLinkTypeUserPhoneNumber -
The link is a link to a user by its phone number. Call
Client.search_user_by_phone_number with the given phone
number to process the link. If the user is found, then call
Client.create_private_chat and open user's profile information screen or the chat itself. If draft text isn't empty, then put the
draft text in the input field
- InternalLinkTypeUserToken - The link is
a link to a user by a temporary token. Call Client.search_user_by_token
with the given token to process the link. If the user is found, then call
Client.create_private_chat and open the chat
- InternalLinkTypeVideoChat - The link is
a link to a video chat. Call Client.search_public_chat with the given
chat username, and then Client.join_video_chat with the given invite hash
to process the link
- InternalLinkTypeWebApp - The link is a
link to a Web App. Call Client.search_public_chat with the given bot
username, check that the user is a bot. If the bot is restricted for the current user, then show an error message. Otherwise, call
Client.search_web_app with the received bot and the given
web_app_short_name. Process received foundWebApp by showing a confirmation dialog if needed. If the bot can be added to attachment or
side menu, but isn't added yet, then show a disclaimer about Mini Apps being third-party applications instead of the dialog and ask the
user to accept their Terms of service. If the user accept the terms and confirms adding, then use
Client.toggle_bot_is_added_to_attachment_menu to
add the bot. Then, call Client.get_web_app_link_url and open the
returned URL as a Web App
- InviteGroupCallParticipant - Invites a
user to an active group call; for group calls not bound to a chat only. Sends a service message of the type messageGroupCall. The group
call can have at most getOption("group_call_participant_count_max") participants
- InviteGroupCallParticipantResult -
Describes result of group call participant invitation
- InviteGroupCallParticipantResultSuccess -
The user was invited and a service message of the type messageGroupCall was sent which can be used in
Client.decline_group_call_invitation to cancel the
invitation
-
InviteGroupCallParticipantResultUserAlreadyParticipant - The user can't be invited because they are
already a participant of the call
-
InviteGroupCallParticipantResultUserPrivacyRestricted - The user can't be invited due to their
privacy settings
- InviteGroupCallParticipantResultUserWasBanned -
The user can't be invited because they were banned by the owner of the call and can be invited back only
by the owner of the group call
- InviteLinkChatType - Describes the
type of chat to which points an invite link
- InviteLinkChatTypeBasicGroup - The
link is an invite link for a basic group
- InviteLinkChatTypeChannel - The link is
an invite link for a channel
- InviteLinkChatTypeSupergroup - The
link is an invite link for a supergroup
- InviteVideoChatParticipants - Invites
users to an active video chat. Sends a service message of the type messageInviteVideoChatParticipants to the chat bound to the group
call
- Invoice - Product invoice
- JoinChat - Adds the current user as a new member to a
chat. Private and secret chats can't be joined using this method. May return an error with a message "INVITE_REQUEST_SENT" if only a
join request was created
- JoinChatByInviteLink - Uses an invite link
to add the current user to the chat if possible. May return an error with a message "INVITE_REQUEST_SENT" if only a join request was
created
- JoinGroupCall - Joins a group call that is not
bound to a chat
- JoinVideoChat - Joins an active video chat. Returns
join response payload for tgcalls
- JsonObjectMember - Represents one member of a
JSON object
- JsonValue - Represents a JSON value
- JsonValueArray - Represents a JSON array
- JsonValueBoolean - Represents a boolean JSON
value
- JsonValueNull - Represents a null JSON value
- JsonValueNumber - Represents a numeric JSON value
- JsonValueObject - Represents a JSON object
- JsonValueString - Represents a string JSON value
- KeyboardButton - Represents a single button in a
bot keyboard
- KeyboardButtonType - Describes a
keyboard button type
- KeyboardButtonTypeRequestChat - A
button that requests a chat to be shared by the current user; available only in private chats. Use the method
Client.share_chat_with_bot to complete the request
- KeyboardButtonTypeRequestLocation -
A button that sends the user's location when pressed; available only in private chats
- KeyboardButtonTypeRequestPhoneNumber -
A button that sends the user's phone number when pressed; available only in private chats
- KeyboardButtonTypeRequestPoll - A
button that allows the user to create and send a poll when pressed; available only in private chats
- KeyboardButtonTypeRequestUsers - A
button that requests users to be shared by the current user; available only in private chats. Use the method
Client.share_users_with_bot to complete the request
- KeyboardButtonTypeText - A simple button,
with text that must be sent when the button is pressed
- KeyboardButtonTypeWebApp - A button that
opens a Web App by calling Client.get_web_app_url
- LabeledPricePart - Portion of the price of a
product (e.g., "delivery cost", "tax amount")
- LanguagePackInfo - Contains information about a
language pack
- LanguagePackString - Represents one language
pack string
- LanguagePackStringValue -
Represents the value of a string in a language pack
- LanguagePackStringValueDeleted - A
deleted language pack string, the value must be taken from the built-in English language pack
- LanguagePackStringValueOrdinary -
An ordinary language pack string
- LanguagePackStringValuePluralized -
A language pack string which has different forms based on the number of some object it mentions. See
https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information
- LanguagePackStrings - Contains a list of
language pack strings
- LaunchPrepaidGiveaway - Launches a prepaid
giveaway
- LeaveChat - Removes the current user from chat members.
Private and secret chats can't be left using this method
- LeaveGroupCall - Leaves a group call
- LinkPreview - Describes a link preview
- LinkPreviewAlbumMedia - Describes
a media from a link preview album
- LinkPreviewAlbumMediaPhoto - The media
is a photo
- LinkPreviewAlbumMediaVideo - The media
is a video
- LinkPreviewOptions - Options to be used for
generation of a link preview
- LinkPreviewType - Describes type of link
preview
- LinkPreviewTypeAlbum - The link is a link to
a media album consisting of photos and videos
- LinkPreviewTypeAnimation - The link is a
link to an animation
- LinkPreviewTypeApp - The link is a link to an
app at App Store or Google Play
- LinkPreviewTypeArticle - The link is a
link to a web site
- LinkPreviewTypeAudio - The link is a link to
an audio
- LinkPreviewTypeBackground - The link is
a link to a background. Link preview title and are available only for filled backgrounds
- LinkPreviewTypeChannelBoost - The
link is a link to boost a channel chat
- LinkPreviewTypeChat - The link is a link to a
chat
- LinkPreviewTypeDocument - The link is a
link to a general file
- LinkPreviewTypeEmbeddedAnimationPlayer -
The link is a link to an animation player
- LinkPreviewTypeEmbeddedAudioPlayer -
The link is a link to an audio player
- LinkPreviewTypeEmbeddedVideoPlayer -
The link is a link to a video player
- LinkPreviewTypeExternalAudio - The
link is a link to an audio file
- LinkPreviewTypeExternalVideo - The
link is a link to a video file
- LinkPreviewTypeGroupCall - The link is a
link to a group call that isn't bound to a chat
- LinkPreviewTypeInvoice - The link is a
link to an invoice
- LinkPreviewTypeMessage - The link is a
link to a text or a poll Telegram message
- LinkPreviewTypePhoto - The link is a link to
a photo
- LinkPreviewTypePremiumGiftCode -
The link is a link to a Telegram Premium gift code
- LinkPreviewTypeShareableChatFolder -
The link is a link to a shareable chat folder
- LinkPreviewTypeSticker - The link is a
link to a sticker
- LinkPreviewTypeStickerSet - The link is
a link to a sticker set
- LinkPreviewTypeStory - The link is a link to
a story. Link preview is unavailable
- LinkPreviewTypeSupergroupBoost -
The link is a link to boost a supergroup chat
- LinkPreviewTypeTheme - The link is a link to
a cloud theme. TDLib has no theme support yet
- LinkPreviewTypeUnsupported - The link
preview type is unsupported yet
- LinkPreviewTypeUpgradedGift - The
link is a link to an upgraded gift
- LinkPreviewTypeUser - The link is a link to a
user
- LinkPreviewTypeVideo - The link is a link to
a video
- LinkPreviewTypeVideoChat - The link is a
link to a video chat
- LinkPreviewTypeVideoNote - The link is a
link to a video note message
- LinkPreviewTypeVoiceNote - The link is a
link to a voice note message
- LinkPreviewTypeWebApp - The link is a link
to a Web App
- LoadActiveStories - Loads more active stories
from a story list. The loaded stories will be sent through updates. Active stories are sorted by the pair (active_stories.order,
active_stories.story_poster_chat_id) in descending order. Returns a 404 error if all active stories have been loaded
- LoadChats - 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
- LoadGroupCallParticipants - 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
- LoadQuickReplyShortcutMessages -
Loads quick reply messages that can be sent by a given quick reply shortcut. The loaded messages will be sent through
updateQuickReplyShortcutMessages
- LoadQuickReplyShortcuts - Loads quick
reply shortcuts created by the current user. The loaded data will be sent through updateQuickReplyShortcut and updateQuickReplyShortcuts
- LoadSavedMessagesTopics - Loads more
Saved Messages topics. The loaded topics will be sent through updateSavedMessagesTopic. Topics are sorted by their topic.order in
descending order. Returns a 404 error if all topics have been loaded
- LocalFile - Represents a local file
- LocalizationTargetInfo - Contains
information about the current localization target
- Location - Describes a location on planet Earth
- LocationAddress - Describes an address of a
location
- LogOut - 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
- LogStream - Describes a stream to which TDLib
internal log is written
- LogStreamDefault - The log is written to stderr
or an OS specific log
- LogStreamEmpty - The log is written nowhere
- LogStreamFile - The log is written to a file
- LogTags - Contains a list of available TDLib internal log
tags
- LogVerbosityLevel - Contains a TDLib internal
log verbosity level
- LoginUrlInfo - Contains information about
an inline button of type inlineKeyboardButtonTypeLoginUrl
- LoginUrlInfoOpen - An HTTP URL needs to be open
- LoginUrlInfoRequestConfirmation -
An authorization confirmation dialog needs to be shown to the user
- MainWebApp - Contains information about the main Web
App of a bot
- MaskPoint - Part of the face, relative to
which a mask is placed
- MaskPointChin - The mask is placed relatively to
the chin
- MaskPointEyes - The mask is placed relatively to
the eyes
- MaskPointForehead - The mask is placed
relatively to the forehead
- MaskPointMouth - The mask is placed relatively to
the mouth
- MaskPosition - Position on a photo where a mask is
placed
- Message - Describes a message
- MessageAnimatedEmoji - A message with an
animated emoji
- MessageAnimation - An animation message (GIF-
style).
- MessageAudio - An audio message
- MessageAutoDeleteTime - Contains default
auto-delete timer setting for new chats
- MessageBasicGroupChatCreate - A newly
created basic group
- MessageBotWriteAccessAllowed - The
user allowed the bot to send messages
- MessageCalendar - Contains information about
found messages, split by days according to the option "utc_time_offset"
- MessageCalendarDay - Contains information
about found messages sent on a specific day
- MessageCall - A message with information about an
ended call
- MessageChatAddMembers - New chat members
were added
- MessageChatBoost - The chat was boosted by the
sender of the message
- MessageChatChangePhoto - An updated chat
photo
- MessageChatChangeTitle - An updated chat
title
- MessageChatDeleteMember - A chat member
was deleted
- MessageChatDeletePhoto - A deleted chat
photo
- MessageChatJoinByLink - A new member joined
the chat via an invite link
- MessageChatJoinByRequest - A new member
was accepted to the chat by an administrator
- MessageChatSetBackground - A new
background was set in the chat
- MessageChatSetMessageAutoDeleteTime -
The auto-delete or self-destruct timer for messages in the chat has been changed
- MessageChatSetTheme - A theme in the chat has
been changed
- MessageChatShared - The current user shared a
chat, which was requested by the bot
- MessageChatUpgradeFrom - A supergroup has
been created from a basic group
- MessageChatUpgradeTo - A basic group was
upgraded to a supergroup and was deactivated as the result
- MessageContact - A message with a user contact
- MessageContactRegistered - A contact has
registered with Telegram
- MessageContent - Contains the content of
a message
- MessageCopyOptions - Options to be used when a
message content is copied without reference to the original sender. Service messages, messages with messageInvoice, messagePaidMedia,
messageGiveaway, or messageGiveawayWinners content can't be copied
- MessageCustomServiceAction - A non-
standard action has happened in the chat
- MessageDice - A dice message. The dice value is
randomly generated by the server
- MessageDocument - A document message (general
file)
- MessageEffect - Contains information about an
effect added to a message
- MessageEffectType - Describes type of
emoji effect
- MessageEffectTypeEmojiReaction -
An effect from an emoji reaction
- MessageEffectTypePremiumSticker -
An effect from a premium sticker
- MessageExpiredPhoto - A self-destructed photo
message
- MessageExpiredVideo - A self-destructed video
message
- MessageExpiredVideoNote - A self-
destructed video note message
- MessageExpiredVoiceNote - A self-
destructed voice note message
- MessageFileType - Contains information
about a file with messages exported from another app
- MessageFileTypeGroup - The messages were
exported from a group chat
- MessageFileTypePrivate - The messages were
exported from a private chat
- MessageFileTypeUnknown - The messages were
exported from a chat of unknown type
- MessageForumTopicCreated - A forum topic
has been created
- MessageForumTopicEdited - A forum topic
has been edited
- MessageForumTopicIsClosedToggled -
A forum topic has been closed or opened
- MessageForumTopicIsHiddenToggled -
A General forum topic has been hidden or unhidden
- MessageForwardInfo - Contains information
about a forwarded message
- MessageGame - A message with a game
- MessageGameScore - A new high score was achieved
in a game
- MessageGift - A regular gift was received or sent by
the current user, or the current user was notified about a channel gift
- MessageGiftedPremium - Telegram Premium was
gifted to a user
- MessageGiftedStars - Telegram Stars were
gifted to a user
- MessageGiveaway - A giveaway
- MessageGiveawayCompleted - A giveaway
without public winners has been completed for the chat
- MessageGiveawayCreated - A giveaway was
created for the chat. Use telegramPaymentPurposePremiumGiveaway, storePaymentPurposePremiumGiveaway, telegramPaymentPurposeStarGiveaway,
or storePaymentPurposeStarGiveaway to create a giveaway
- MessageGiveawayPrizeStars - A Telegram
Stars were received by the current user from a giveaway
- MessageGiveawayWinners - A giveaway with
public winners has been completed for the chat
- MessageGroupCall - A message with information
about a group call not bound to a chat. If the message is incoming, the call isn't active, isn't missed, and has no duration, and
getOption("can_accept_calls") is true, then incoming call screen must be shown to the user. Use
Client.join_group_call to accept the call or
Client.decline_group_call_invitation to decline it. If the
call become active or missed, then the call screen must be hidden
- MessageImportInfo - Contains information about
a message created with Client.import_messages
- MessageInteractionInfo - Contains
information about interactions with a message
- MessageInviteVideoChatParticipants -
A message with information about an invitation to a video chat
- MessageInvoice - A message with an invoice from a
bot. Use Client.get_internal_link with internalLinkTypeBotStart to
share the invoice
- MessageLink - Contains an HTTPS link to a message in
a supergroup or channel, or a forum topic
- MessageLinkInfo - Contains information about a
link to a message or a forum topic in a chat
- MessageLocation - A message with a location
- MessageOrigin - Contains information about
the origin of a message
- MessageOriginChannel - The message was
originally a post in a channel
- MessageOriginChat - The message was originally
sent on behalf of a chat
- MessageOriginHiddenUser - The message was
originally sent by a user, which is hidden by their privacy settings
- MessageOriginUser - The message was originally
sent by a known user
- MessagePaidMedia - A message with paid media
- MessagePaidMessagePriceChanged - A
price for paid messages was changed in the supergroup chat
- MessagePaidMessagesRefunded - Paid
messages were refunded
- MessagePassportDataReceived -
Telegram Passport data has been received; for bots only
- MessagePassportDataSent - Telegram
Passport data has been sent to a bot
- MessagePaymentRefunded - A payment has
been refunded
- MessagePaymentSuccessful - A payment has
been sent to a bot or a business account
- MessagePaymentSuccessfulBot - A
payment has been received by the bot or the business account
- MessagePhoto - A photo message
- MessagePinMessage - A message has been pinned
- MessagePoll - A message with a poll
- MessagePosition - Contains information about a
message in a specific position
- MessagePositions - Contains a list of message
positions
- MessagePremiumGiftCode - A Telegram
Premium gift code was created for the user
- MessageProperties - Contains properties of a
message and describes actions that can be done with the message right now
- MessageProximityAlertTriggered - A
user in the chat came within proximity alert range
- MessageReaction - Contains information about a
reaction to a message
- MessageReactions - Contains a list of reactions
added to a message
- MessageReadDate - Describes read date of
a recent outgoing message in a private chat
- MessageReadDateMyPrivacyRestricted -
The read date is unknown due to privacy settings of the current user, but will be known if the user
subscribes to Telegram Premium
- MessageReadDateRead - Contains read date of
the message
- MessageReadDateTooOld - The message is too
old to get read date
- MessageReadDateUnread - The message is
unread yet
- MessageReadDateUserPrivacyRestricted -
The read date is unknown due to privacy settings of the other user
- MessageRefundedUpgradedGift - A gift
which purchase, upgrade or transfer were refunded
- MessageReplyInfo - Contains information about
replies to a message
- MessageReplyTo - Contains information
about the message or the story a message is replying to
- MessageReplyToMessage - Describes a message
replied by a given message
- MessageReplyToStory - Describes a story
replied by a given message
- MessageSchedulingState - Contains
information about the time when a scheduled message will be sent
- MessageSchedulingStateSendAtDate -
The message will be sent at the specified date
- MessageSchedulingStateSendWhenOnline -
The message will be sent when the other user is online. Applicable to private chats only and when the
exact online status of the other user is known
- MessageSchedulingStateSendWhenVideoProcessed -
The message will be sent when the video in the message is converted and optimized; can be used only by the
server
- MessageScreenshotTaken - A screenshot of a
message in the chat has been taken
- MessageSelfDestructType -
Describes when a message will be self-destructed
- MessageSelfDestructTypeImmediately -
The message can be opened only once and will be self-destructed once closed
- MessageSelfDestructTypeTimer - The
message will be self-destructed in the specified time after its content was opened
- MessageSendOptions - Options to be used when a
message is sent
- MessageSender - Contains information about
the sender of a message
- MessageSenderChat - The message was sent on
behalf of a chat
- MessageSenderUser - The message was sent by a
known user
- MessageSenders - Represents a list of message
senders
- MessageSendingState - Contains
information about the sending state of the message
- MessageSendingStateFailed - The message
failed to be sent
- MessageSendingStatePending - The
message is being sent now, but has not yet been delivered to the server
- MessageSource - Describes source of a
message
- MessageSourceChatEventLog - The message
is from a chat event log
- MessageSourceChatHistory - The message
is from a chat history
- MessageSourceChatList - The message is from
a chat list or a forum topic list
- MessageSourceForumTopicHistory -
The message is from a forum topic history
- MessageSourceHistoryPreview - The
message is from chat, message thread or forum topic history preview
- MessageSourceMessageThreadHistory -
The message is from a message thread history
- MessageSourceNotification - The message
is from a notification
- MessageSourceOther - The message is from some
other source
- MessageSourceScreenshot - The message was
screenshotted; the source must be used only if the message content was visible during the screenshot
- MessageSourceSearch - The message is from
search results, including file downloads, local file list, outgoing document messages, calendar
- MessageSponsor - Information about the sponsor of
a message
- MessageStatistics - A detailed statistics about
a message
- MessageSticker - A sticker message
- MessageStory - A message with a forwarded story
- MessageSuggestProfilePhoto - A profile
photo was suggested to a user in a private chat
- MessageSupergroupChatCreate - A newly
created supergroup or channel
- MessageText - A text message
- MessageThreadInfo - Contains information about
a message thread
- MessageUnsupported - A message content that is
not supported in the current TDLib version
- MessageUpgradedGift - An upgraded gift was
received or sent by the current user, or the current user was notified about a channel gift
- MessageUsersShared - The current user shared
users, which were requested by the bot
- MessageVenue - A message with information about a
venue
- MessageVideo - A video message
- MessageVideoChatEnded - A message with
information about an ended video chat
- MessageVideoChatScheduled - A new video
chat was scheduled
- MessageVideoChatStarted - A newly created
video chat
- MessageVideoNote - A video note message
- MessageViewer - Represents a viewer of a message
- MessageViewers - Represents a list of message
viewers
- MessageVoiceNote - A voice note message
- MessageWebAppDataReceived - Data from a
Web App has been received; for bots only
- MessageWebAppDataSent - Data from a Web App
has been sent to a bot
- Messages - Contains a list of messages
- Minithumbnail - Thumbnail image of a very poor
quality and low resolution
- NetworkStatistics - A full list of available
network statistic entries
- NetworkStatisticsEntry - Contains
statistics about network usage
- NetworkStatisticsEntryCall - Contains
information about the total amount of data that was used for calls
- NetworkStatisticsEntryFile - Contains
information about the total amount of data that was used to send and receive files
- NetworkType - Represents the type of network
- NetworkTypeMobile - A mobile network
- NetworkTypeMobileRoaming - A mobile
roaming network
- NetworkTypeNone - The network is not available
- NetworkTypeOther - A different network type
(e.g., Ethernet network)
- NetworkTypeWiFi - A Wi-Fi network
- NewChatPrivacySettings - Contains privacy
settings for chats with non-contacts
- Notification - Contains information about a
notification
- NotificationGroup - Describes a group of
notifications
- NotificationGroupType - Describes
the type of notifications in a notification group
- NotificationGroupTypeCalls - A group
containing notifications of type notificationTypeNewCall
- NotificationGroupTypeMentions - A
group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current
user, replies to their messages, or a pinned message
- NotificationGroupTypeMessages - A
group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages
- NotificationGroupTypeSecretChat -
A group containing a notification of type notificationTypeNewSecretChat
- NotificationSettingsScope -
Describes the types of chats to which notification settings are relevant
- NotificationSettingsScopeChannelChats -
Notification settings applied to all channel chats when the corresponding chat setting has a default value
- NotificationSettingsScopeGroupChats -
Notification settings applied to all basic group and supergroup chats when the corresponding chat setting
has a default value
- NotificationSettingsScopePrivateChats -
Notification settings applied to all private and secret chats when the corresponding chat setting has a
default value
- NotificationSound - Describes a notification
sound in MP3 format
- NotificationSounds - Contains a list of
notification sounds
- NotificationType - Contains detailed
information about a notification
- NotificationTypeNewCall - New call was
received
- NotificationTypeNewMessage - New
message was received
- NotificationTypeNewPushMessage -
New message was received through a push notification
- NotificationTypeNewSecretChat - New
secret chat was created
- Ok - An object of this type is returned on a successful
function call for certain functions
- OpenBotSimilarBot - Informs TDLib that a bot
was opened from the list of similar bots
- OpenChat - 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)
- OpenChatSimilarChat - Informs TDLib that a
chat was opened from the list of similar chats. The method is independent of
Client.open_chat and Client.close_chat methods
- OpenMessageContent - 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
- OpenSponsoredChat - Informs TDLib that the user
opened a sponsored chat
- OpenStory - Informs TDLib that a story is opened and is
being viewed by the user
- OpenWebApp - Informs TDLib that a Web App is being
opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp
button. For each bot, a confirmation alert about data sent to the bot must be shown once
- OptimizeStorage - Optimizes storage usage, i.e.
deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted
- OptionValue - Represents the value of an
option
- OptionValueBoolean - Represents a boolean
option
- OptionValueEmpty - Represents an unknown option
or an option which has a default value
- OptionValueInteger - Represents an integer
option
- OptionValueString - Represents a string option
- OrderInfo - Order information
- Outline - Represents outline of an image
- PageBlock - Describes a block of an instant
view for a web page
- PageBlockAnchor - An invisible anchor on a page,
which can be used in a URL to open the page from the specified anchor
- PageBlockAnimation - An animation
- PageBlockAudio - An audio file
- PageBlockAuthorDate - The author and
publishing date of a page
- PageBlockBlockQuote - A block quote
- PageBlockCaption - Contains a caption of another
block
- PageBlockChatLink - A link to a chat
- PageBlockCollage - A collage
- PageBlockCover - A page cover
- PageBlockDetails - A collapsible block
- PageBlockDivider - An empty block separating a
page
- PageBlockEmbedded - An embedded web page
- PageBlockEmbeddedPost - An embedded post
- PageBlockFooter - The footer of a page
- PageBlockHeader - A header
- PageBlockHorizontalAlignment -
Describes a horizontal alignment of a table cell content
- PageBlockHorizontalAlignmentCenter -
The content must be center-aligned
- PageBlockHorizontalAlignmentLeft -
The content must be left-aligned
- PageBlockHorizontalAlignmentRight -
The content must be right-aligned
- PageBlockKicker - A kicker
- PageBlockList - A list of data blocks
- PageBlockListItem - Describes an item of a list
page block
- PageBlockMap - A map
- PageBlockParagraph - A text paragraph
- PageBlockPhoto - A photo
- PageBlockPreformatted - A preformatted text
paragraph
- PageBlockPullQuote - A pull quote
- PageBlockRelatedArticle - Contains
information about a related article
- PageBlockRelatedArticles - Related
articles
- PageBlockSlideshow - A slideshow
- PageBlockSubheader - A subheader
- PageBlockSubtitle - The subtitle of a page
- PageBlockTable - A table
- PageBlockTableCell - Represents a cell of a
table
- PageBlockTitle - The title of a page
- PageBlockVerticalAlignment -
Describes a Vertical alignment of a table cell content
- PageBlockVerticalAlignmentBottom -
The content must be bottom-aligned
- PageBlockVerticalAlignmentMiddle -
The content must be middle-aligned
- PageBlockVerticalAlignmentTop - The
content must be top-aligned
- PageBlockVideo - A video
- PageBlockVoiceNote - A voice note
- PaidMedia - Describes a paid media
- PaidMediaPhoto - The media is a photo
- PaidMediaPreview - The media is hidden until the
invoice is paid
- PaidMediaUnsupported - The media is
unsupported
- PaidMediaVideo - The media is a video
- PaidReactionType - Describes type of
paid message reaction
- PaidReactionTypeAnonymous - An
anonymous paid reaction
- PaidReactionTypeChat - A paid reaction on
behalf of an owned chat
- PaidReactionTypeRegular - A paid reaction
on behalf of the current user
- PaidReactor - Contains information about a user that
added paid reactions
- ParseMarkdown - Parses Markdown entities in a human
-friendly format, ignoring markup errors. Can be called synchronously
- ParseTextEntities - Parses Bold, Italic,
Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, ExpandableBlockQuote, Code, Pre, PreCode, TextUrl and MentionName entities
from a marked-up text. Can be called synchronously
- PassportAuthorizationForm - Contains
information about a Telegram Passport authorization form that was requested
- PassportElement - Contains information
about a Telegram Passport element
- PassportElementAddress - A Telegram
Passport element containing the user's address
- PassportElementBankStatement - A
Telegram Passport element containing the user's bank statement
- PassportElementDriverLicense - A
Telegram Passport element containing the user's driver license
- PassportElementEmailAddress - A
Telegram Passport element containing the user's email address
- PassportElementError - Contains the of an
error in a Telegram Passport element
- PassportElementErrorSource -
Contains the description of an error in a Telegram Passport element
- PassportElementErrorSourceDataField -
One of the data fields contains an error. The error will be considered resolved when the value of the
field changes
- PassportElementErrorSourceFile -
The file contains an error. The error will be considered resolved when the file changes
- PassportElementErrorSourceFiles -
The list of attached files contains an error. The error will be considered resolved when the list of files
changes
- PassportElementErrorSourceFrontSide -
The front side of the document contains an error. The error will be considered resolved when the file with
the front side changes
- PassportElementErrorSourceReverseSide -
The reverse side of the document contains an error. The error will be considered resolved when the file
with the reverse side changes
- PassportElementErrorSourceSelfie -
The selfie with the document contains an error. The error will be considered resolved when the file with
the selfie changes
- PassportElementErrorSourceTranslationFile -
One of files with the translation of the document contains an error. The error will be considered resolved
when the file changes
- PassportElementErrorSourceTranslationFiles -
The translation of the document contains an error. The error will be considered resolved when the list of
translation files changes
- PassportElementErrorSourceUnspecified -
The element contains an error in an unspecified place. The error will be considered resolved when new data
is added
- PassportElementIdentityCard - A
Telegram Passport element containing the user's identity card
- PassportElementInternalPassport -
A Telegram Passport element containing the user's internal passport
- PassportElementPassport - A Telegram
Passport element containing the user's passport
- PassportElementPassportRegistration -
A Telegram Passport element containing the user's passport registration pages
- PassportElementPersonalDetails - A
Telegram Passport element containing the user's personal details
- PassportElementPhoneNumber - A
Telegram Passport element containing the user's phone number
- PassportElementRentalAgreement - A
Telegram Passport element containing the user's rental agreement
- PassportElementTemporaryRegistration -
A Telegram Passport element containing the user's temporary registration
- PassportElementType - Contains the
type of Telegram Passport element
- PassportElementTypeAddress - A
Telegram Passport element containing the user's address
- PassportElementTypeBankStatement -
A Telegram Passport element containing the user's bank statement
- PassportElementTypeDriverLicense -
A Telegram Passport element containing the user's driver license
- PassportElementTypeEmailAddress -
A Telegram Passport element containing the user's email address
- PassportElementTypeIdentityCard -
A Telegram Passport element containing the user's identity card
- PassportElementTypeInternalPassport -
A Telegram Passport element containing the user's internal passport
- PassportElementTypePassport - A
Telegram Passport element containing the user's passport
- PassportElementTypePassportRegistration -
A Telegram Passport element containing the registration page of the user's passport
- PassportElementTypePersonalDetails -
A Telegram Passport element containing the user's personal details
- PassportElementTypePhoneNumber - A
Telegram Passport element containing the user's phone number
- PassportElementTypeRentalAgreement -
A Telegram Passport element containing the user's rental agreement
- PassportElementTypeTemporaryRegistration -
A Telegram Passport element containing the user's temporary registration
- PassportElementTypeUtilityBill - A
Telegram Passport element containing the user's utility bill
- PassportElementUtilityBill - A
Telegram Passport element containing the user's utility bill
- PassportElements - Contains information about
saved Telegram Passport elements
- PassportElementsWithErrors - Contains
information about a Telegram Passport elements and corresponding errors
- PassportRequiredElement - Contains a of
the required Telegram Passport element that was requested by a service
- PassportSuitableElement - Contains
information about a Telegram Passport element that was requested by a service
- PasswordState - Represents the current state of 2-
step verification
- PaymentForm - Contains information about an invoice
payment form
- PaymentFormType - Describes type of
payment form
- PaymentFormTypeRegular - The payment form
is for a regular payment
- PaymentFormTypeStarSubscription -
The payment form is for a payment in Telegram Stars for subscription
- PaymentFormTypeStars - The payment form is
for a payment in Telegram Stars
- PaymentOption - Describes an additional payment
option
- PaymentProvider - Contains information
about a payment provider
- PaymentProviderOther - Some other payment
provider, for which a web payment form must be shown
- PaymentProviderSmartGlocal - Smart
Glocal payment provider
- PaymentProviderStripe - Stripe payment
provider
- PaymentReceipt - Contains information about a
successful payment
- PaymentReceiptType - Describes type
of successful payment
- PaymentReceiptTypeRegular - The payment
was done using a third-party payment provider
- PaymentReceiptTypeStars - The payment was
done using Telegram Stars
- PaymentResult - Contains the result of a payment
request
- PersonalDetails - Contains the user's personal
details
- PersonalDocument - A personal document,
containing some information about a user
- PhoneNumberAuthenticationSettings -
Contains settings for the authentication of the user's phone number
- PhoneNumberCodeType - Describes type
of the request for which a code is sent to a phone number
- PhoneNumberCodeTypeChange - Checks
ownership of a new phone number to change the user's authentication phone number; for official Android and iOS applications only
- PhoneNumberCodeTypeConfirmOwnership -
Confirms ownership of a phone number to prevent account deletion while handling links of the type
internalLinkTypePhoneNumberConfirmation
- PhoneNumberCodeTypeVerify - Verifies
ownership of a phone number to be added to the user's Telegram Passport
- PhoneNumberInfo - Contains information about a
phone number
- Photo - Describes a photo
- PhotoSize - Describes an image in JPEG format
- PinChatMessage - Pins a message in a chat. A
message can be pinned only if messageProperties.can_be_pinned
- PingProxy - Computes time needed to receive a response
from a Telegram server through a proxy. Can be called before authorization
- Point - A point on a Cartesian plane
- Poll - Describes a poll
- PollOption - Describes one answer option of a poll
- PollType - Describes the type of poll
- PollTypeQuiz - A poll in quiz mode, which has
exactly one correct answer option and can be answered only once
- PollTypeRegular - A regular poll
- PostStory - Posts a new story on behalf of a chat;
requires can_post_stories right for supergroup and channel chats. Returns a temporary story
- PreliminaryUploadFile - Preliminary uploads
a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. In all
other cases there is no need to preliminary upload a file. Updates updateFile will be used to notify about upload progress. The upload
will not be completed until the file is sent in a message
- PremiumFeature - Describes a feature
available to Premium users
- PremiumFeatureAccentColor - The ability
to choose accent color for replies and user profile
- PremiumFeatureAdvancedChatManagement -
Ability to change position of the main chat list, archive and mute all new chats from non-contacts, and
completely disable notifications about the user's contacts joined Telegram
- PremiumFeatureAnimatedProfilePhoto -
Profile photo animation on message and chat screens
- PremiumFeatureAppIcons - Allowed to set a
premium application icons
- PremiumFeatureBackgroundForBoth -
The ability to set private chat background for both users
- PremiumFeatureBusiness - The ability to
use Business features
- PremiumFeatureChatBoost - The ability to
boost chats
- PremiumFeatureCustomEmoji - Allowed to
use custom emoji stickers in message texts and captions
- PremiumFeatureDisabledAds - Disabled
ads
- PremiumFeatureEmojiStatus - The ability
to show an emoji status along with the user's name
- PremiumFeatureForumTopicIcon - The
ability to set a custom emoji as a forum topic icon
- PremiumFeatureImprovedDownloadSpeed -
Improved download speed
- PremiumFeatureIncreasedLimits -
Increased limits
- PremiumFeatureIncreasedUploadFileSize -
Increased maximum upload file size
- PremiumFeatureLastSeenTimes - The
ability to view last seen and read times of other users even they can't view last seen or read time for the current user
- PremiumFeatureMessageEffects - The
ability to use all available message effects
- PremiumFeatureMessagePrivacy - The
ability to disallow incoming voice and video note messages in private chats using
Client.set_user_privacy_setting_rules with
userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages and to restrict incoming messages from non-contacts using
Client.set_new_chat_privacy_settings
- PremiumFeatureProfileBadge - A badge
in the user's profile
- PremiumFeaturePromotionAnimation -
Describes a promotion animation for a Premium feature
- PremiumFeatureRealTimeChatTranslation -
Allowed to translate chat messages real-time
- PremiumFeatureSavedMessagesTags -
The ability to use tags in Saved Messages
- PremiumFeatureUniqueReactions -
Allowed to use more reactions
- PremiumFeatureUniqueStickers -
Allowed to use premium stickers with unique effects
- PremiumFeatureUpgradedStories -
Allowed to use many additional features for stories
- PremiumFeatureVoiceRecognition -
The ability to convert voice notes to text
- PremiumFeatures - Contains information about
features, available to Premium users
- PremiumGiftCodeInfo - Contains information
about a Telegram Premium gift code
- PremiumGiftPaymentOption - Describes an
option for gifting Telegram Premium to a user. Use telegramPaymentPurposePremiumGift for out-of-store payments or payments in Telegram
Stars
- PremiumGiftPaymentOptions - Contains a
list of options for gifting Telegram Premium to a user
- PremiumGiveawayPaymentOption -
Describes an option for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among chat members. Use
telegramPaymentPurposePremiumGiftCodes or telegramPaymentPurposePremiumGiveaway for out-of-store payments
- PremiumGiveawayPaymentOptions -
Contains a list of options for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among chat members
- PremiumLimit - Contains information about a limit,
increased for Premium users
- PremiumLimitType - Describes type of
limit, increased for Premium users
- PremiumLimitTypeActiveStoryCount -
The maximum number of active stories
- PremiumLimitTypeBioLength - The maximum
length of the user's bio
- PremiumLimitTypeCaptionLength - The
maximum length of sent media caption
- PremiumLimitTypeChatFolderChosenChatCount -
The maximum number of pinned and always included, or always excluded chats in a chat folder
- PremiumLimitTypeChatFolderCount -
The maximum number of chat folders
- PremiumLimitTypeChatFolderInviteLinkCount -
The maximum number of invite links for a chat folder
- PremiumLimitTypeCreatedPublicChatCount -
The maximum number of created public chats
- PremiumLimitTypeFavoriteStickerCount -
The maximum number of favorite stickers
- PremiumLimitTypeMonthlyPostedStoryCount -
The maximum number of stories posted per month
- PremiumLimitTypePinnedArchivedChatCount -
The maximum number of pinned chats in the archive chat list
- PremiumLimitTypePinnedChatCount -
The maximum number of pinned chats in the main chat list
- PremiumLimitTypePinnedSavedMessagesTopicCount -
The maximum number of pinned Saved Messages topics
- PremiumLimitTypeSavedAnimationCount -
The maximum number of saved animations
- PremiumLimitTypeShareableChatFolderCount -
The maximum number of added shareable chat folders
- PremiumLimitTypeSimilarChatCount -
The maximum number of received similar chats
- PremiumLimitTypeStoryCaptionLength -
The maximum length of captions of posted stories
- PremiumLimitTypeStorySuggestedReactionAreaCount -
The maximum number of suggested reaction areas on a story
- PremiumLimitTypeSupergroupCount -
The maximum number of joined supergroups and channels
- PremiumLimitTypeWeeklyPostedStoryCount -
The maximum number of stories posted per week
- PremiumPaymentOption - Describes an option
for buying Telegram Premium to a user
- PremiumSource - Describes a source from
which the Premium features screen is opened
- PremiumSourceBusinessFeature - A
user tried to use a Business feature
- PremiumSourceFeature - A user tried to use a
Premium feature
- PremiumSourceLimitExceeded - A limit
was exceeded
- PremiumSourceLink - A user opened an internal
link of the type internalLinkTypePremiumFeatures
- PremiumSourceSettings - A user opened the
Premium features screen from settings
- PremiumSourceStoryFeature - A user
tried to use a Premium story feature
- PremiumState - Contains state of Telegram Premium
subscription and promotion videos for Premium features
- PremiumStatePaymentOption - Describes
an option for buying or upgrading Telegram Premium for self
- PremiumStoryFeature - Describes a
story feature available to Premium users
- PremiumStoryFeatureCustomExpirationDuration -
The ability to set custom expiration duration for stories
- PremiumStoryFeatureLinksAndFormatting -
The ability to use links and formatting in story caption, and use inputStoryAreaTypeLink areas
- PremiumStoryFeaturePermanentViewsHistory -
The ability to check who opened the current user's stories after they expire
- PremiumStoryFeaturePriorityOrder -
Stories of the current user are displayed before stories of non-Premium contacts, supergroups, and
channels
- PremiumStoryFeatureSaveStories -
The ability to save other's unprotected stories
- PremiumStoryFeatureStealthMode -
The ability to hide the fact that the user viewed other's stories
- PremiumStoryFeatureVideoQuality -
The ability to choose better quality for viewed stories
- PrepaidGiveaway - Describes a prepaid giveaway
- PreparedInlineMessage - Represents a ready
to send inline message. Use
Client.send_inline_query_result_message to send the message
- PreparedInlineMessageId - Represents an
inline message that can be sent via the bot
- ProcessChatFolderNewChats - Process new
chats added to a shareable chat folder by its owner
- ProcessChatJoinRequest - Handles a pending
join request in a chat
- ProcessChatJoinRequests - Handles all
pending join requests for a given link in a chat
- ProcessPushNotification - 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
- ProductInfo - Contains information about a product
that can be paid with invoice
- ProfileAccentColor - Contains information
about supported accent color for user profile photo background
- ProfileAccentColors - Contains information
about supported accent colors for user profile photo background in RGB format
- ProfilePhoto - Describes a user profile photo
- Proxies - Represents a list of proxy servers
- Proxy - Contains information about a proxy server
- ProxyType - Describes the type of proxy server
- ProxyTypeHttp - A HTTP transparent proxy server
- ProxyTypeMtproto - An MTProto proxy server
- ProxyTypeSocks5 - A SOCKS5 proxy server
- PublicChatType - Describes type of public
chat
- PublicChatTypeHasUsername - The chat is
public, because it has an active username
- PublicChatTypeIsLocationBased - The
chat is public, because it is a location-based supergroup
- PublicForward - Describes a public forward
or repost of a story
- PublicForwardMessage - Contains a public
forward as a message
- PublicForwardStory - Contains a public repost
to a story
- PublicForwards - Represents a list of public
forwards and reposts as a story of a message or a story
- PushMessageContent - Contains content
of a push message notification
- PushMessageContentAnimation - An
animation message (GIF-style).
- PushMessageContentAudio - An audio
message
- PushMessageContentBasicGroupChatCreate -
A newly created basic group
- PushMessageContentChatAddMembers -
New chat members were invited to a group
- PushMessageContentChatChangePhoto -
A chat photo was edited
- PushMessageContentChatChangeTitle -
A chat title was edited
- PushMessageContentChatDeleteMember -
A chat member was deleted
- PushMessageContentChatJoinByLink -
A new member joined the chat via an invite link
- PushMessageContentChatJoinByRequest -
A new member was accepted to the chat by an administrator
- PushMessageContentChatSetBackground -
A chat background was edited
- PushMessageContentChatSetTheme - A
chat theme was edited
- PushMessageContentContact - A message
with a user contact
- PushMessageContentContactRegistered -
A contact has registered with Telegram
- PushMessageContentDocument - A
document message (a general file)
- PushMessageContentGame - A message with a
game
- PushMessageContentGameScore - A new
high score was achieved in a game
- PushMessageContentGift - A message with a
gift
- PushMessageContentGiveaway - A message
with a giveaway
- PushMessageContentHidden - A general
message with hidden content
- PushMessageContentInviteVideoChatParticipants -
An invitation of participants to a video chat or live stream
- PushMessageContentInvoice - A message
with an invoice from a bot
- PushMessageContentLocation - A message
with a location
- PushMessageContentMediaAlbum - A
media album
- PushMessageContentMessageForwards -
A forwarded messages
- PushMessageContentPaidMedia - A
message with paid media
- PushMessageContentPhoto - A photo message
- PushMessageContentPoll - A message with a
poll
- PushMessageContentPremiumGiftCode -
A message with a Telegram Premium gift code created for the user
- PushMessageContentProximityAlertTriggered -
A user in the chat came within proximity alert range from the current user
- PushMessageContentRecurringPayment -
A new recurring payment was made by the current user
- PushMessageContentScreenshotTaken -
A screenshot of a message in the chat has been taken
- PushMessageContentSticker - A message
with a sticker
- PushMessageContentStory - A message with
a story
- PushMessageContentSuggestProfilePhoto -
A profile photo was suggested to the user
- PushMessageContentText - A text message
- PushMessageContentUpgradedGift - A
message with an upgraded gift
- PushMessageContentVideo - A video message
- PushMessageContentVideoChatEnded -
A video chat or live stream has ended
- PushMessageContentVideoChatStarted -
A video chat or live stream was started
- PushMessageContentVideoNote - A video
note message
- PushMessageContentVoiceNote - A voice
note message
- PushReceiverId - Contains a globally unique push
receiver identifier, which can be used to identify which account has received a push notification
- QuickReplyMessage - Describes a message that
can be used for quick reply
- QuickReplyMessages - Contains a list of quick
reply messages
- QuickReplyShortcut - Describes a shortcut that
can be used for a quick reply
- RateSpeechRecognition - Rates recognized
speech in a video note or a voice note message
- ReactionNotificationSettings -
Contains information about notification settings for reactions
- ReactionNotificationSource -
Describes sources of reactions for which notifications will be shown
- ReactionNotificationSourceAll -
Notifications for reactions are shown for all reactions
- ReactionNotificationSourceContacts -
Notifications for reactions are shown only for reactions from contacts
- ReactionNotificationSourceNone -
Notifications for reactions are disabled
- ReactionType - Describes type of message
reaction
- ReactionTypeCustomEmoji - A reaction with
a custom emoji
- ReactionTypeEmoji - A reaction with an emoji
- ReactionTypePaid - The paid reaction in a
channel chat
- ReactionUnavailabilityReason -
Describes why the current user can't add reactions to the message, despite some other users can
- ReactionUnavailabilityReasonAnonymousAdministrator
- The user is an anonymous administrator in the supergroup, but isn't a creator of it, so they can't
vote on behalf of the supergroup
- ReactionUnavailabilityReasonGuest -
The user isn't a member of the supergroup and can't send messages and reactions there without joining
- ReadAllChatMentions - Marks all mentions in a
chat as read
- ReadAllChatReactions - Marks all reactions
in a chat or a forum topic as read
- ReadAllMessageThreadMentions - Marks
all mentions in a forum topic as read
- ReadAllMessageThreadReactions -
Marks all reactions in a forum topic as read
- ReadBusinessMessage - Reads a message on
behalf of a business account; for bots only
- ReadChatList - Traverse all chats in a chat list and
marks all messages in the chats as read
- ReadDatePrivacySettings - Contains
privacy settings for message read date in private chats. Read dates are always shown to the users that can see online status of the
current user regardless of this setting
- ReadFilePart - 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
- ReaddQuickReplyShortcutMessages -
Readds quick reply messages which failed to add. 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
readded, 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 readded, null will be returned instead of the message
- ReceivedGift - Represents a gift received by a user
or a chat
- ReceivedGifts - Represents a list of gifts received
by a user or a chat
- RecognizeSpeech - Recognizes speech in a video
note or a voice note message
- RecommendedChatFolder - Describes a
recommended chat folder
- RecommendedChatFolders - Contains a list
of recommended chat folders
- RecoverAuthenticationPassword -
Recovers the 2-step verification 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
- RecoverPassword - Recovers the 2-step
verification password using a recovery code sent to an email address that was previously set up
- RecoveryEmailAddress - Contains information
about the current recovery email address
- RefundStarPayment - Refunds a previously done
payment in Telegram Stars; for bots only
- RegisterDevice - Registers the currently used
device for receiving push notifications. Returns a globally unique identifier of the push notification subscription
- RegisterUser - Finishes user registration. Works
only when the current authorization state is authorizationStateWaitRegistration
- RemoteFile - Represents a remote file
- RemoveAllFilesFromDownloads - Removes
all files from the file download list
- RemoveBusinessConnectedBotFromChat -
Removes the connected business bot from a specific chat by adding the chat to
businessRecipients.excluded_chat_ids
- RemoveChatActionBar - Removes a chat action
bar without any other action
- RemoveContacts - Removes users from the contact
list
- RemoveFavoriteSticker - Removes a sticker
from the list of favorite stickers
- RemoveFileFromDownloads - Removes a file
from the file download list
- RemoveInstalledBackground - Removes
background from the list of installed backgrounds
- RemoveMessageReaction - Removes a reaction
from a message. A chosen reaction can always be removed
- RemoveMessageSenderBotVerification -
Removes the verification status of a user or a chat by an owned bot
- RemoveNotification - Removes an active
notification from notification list. Needs to be called only if the notification is removed by the current user
- RemoveNotificationGroup - Removes a group
of active notifications. Needs to be called only if the notification group is removed by the current user
- RemovePendingPaidMessageReactions -
Removes all pending paid reactions on a message
- RemoveProxy - Removes a proxy server. Can be called
before authorization
- RemoveRecentHashtag - Removes a hashtag from
the list of recently used hashtags
- RemoveRecentSticker - Removes a sticker from
the list of recently used stickers
- RemoveRecentlyFoundChat - Removes a chat
from the list of recently found chats
- RemoveSavedAnimation - Removes an animation
from the list of saved animations
- RemoveSavedNotificationSound -
Removes a notification sound from the list of saved notification sounds
- RemoveSearchedForTag - Removes a hashtag or
a cashtag from the list of recently searched for hashtags or cashtags
- RemoveStickerFromSet - Removes a sticker
from the set to which it belongs. The sticker set must be owned by the current user
- RemoveTopChat - Removes a chat from the list of
frequently used chats. Supported only if the chat info database is enabled
- ReorderActiveUsernames - Changes order of
active usernames of the current user
- ReorderBotActiveUsernames - Changes
order of active usernames of a bot. Can be called only if userTypeBot.can_be_edited == true
- ReorderBotMediaPreviews - Changes order
of media previews in the list of media previews of a bot
- ReorderChatFolders - Changes the order of chat
folders
- ReorderInstalledStickerSets - Changes
the order of installed sticker sets
- ReorderQuickReplyShortcuts - Changes
the order of quick reply shortcuts
- ReorderSupergroupActiveUsernames -
Changes order of active usernames of a supergroup or channel, requires owner privileges in the supergroup
or channel
- ReplacePrimaryChatInviteLink -
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
- ReplaceStickerInSet - Replaces existing
sticker in a set. The function is equivalent to
Client.remove_sticker_from_set then Client.add_sticker_to_set
then Client.set_sticker_position_in_set
- ReplaceVideoChatRtmpUrl - Replaces the
current RTMP URL for streaming to the video chat of a chat; requires owner privileges in the chat
- ReplyMarkup - Contains a description of a
custom keyboard and actions that can be done with it to quickly reply to bots
- ReplyMarkupForceReply - Instructs
application to force a reply to this message
- ReplyMarkupInlineKeyboard - Contains an
inline keyboard layout
- ReplyMarkupRemoveKeyboard - 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
- ReplyMarkupShowKeyboard - Contains a
custom keyboard layout to quickly reply to bots
- ReportAuthenticationCodeMissing -
Reports that authentication code wasn't delivered via SMS; for official mobile applications only. Works
only when the current authorization state is authorizationStateWaitCode
- ReportChat - Reports a chat to the Telegram
moderators. A chat can be reported only from the chat action bar, or if chat.can_be_reported
- ReportChatPhoto - Reports a chat photo to the
Telegram moderators. A chat photo can be reported only if chat.can_be_reported
- ReportChatResult - Describes result of
chat report
- ReportChatResultMessagesRequired -
The user must choose messages to report and repeat the
Client.report_chat request with the chosen messages
- ReportChatResultOk - The chat was reported
successfully
- ReportChatResultOptionRequired -
The user must choose an option to report the chat and repeat request with the chosen option
- ReportChatResultTextRequired - The
user must add additional text details to the report
- ReportChatSponsoredMessage - Reports a
sponsored message to Telegram moderators
- ReportMessageReactions - Reports reactions
set on a message to the Telegram moderators. Reactions on a message can be reported only if messageProperties.can_report_reactions
- ReportOption - Describes an option to report an
entity to Telegram
- ReportPhoneNumberCodeMissing -
Reports that authentication code wasn't delivered via SMS to the specified phone number; for official mobile applications only
- ReportReason - Describes the reason why a
chat is reported
- ReportReasonChildAbuse - The chat has
child abuse related content
- ReportReasonCopyright - The chat contains
copyrighted content
- ReportReasonCustom - A custom reason provided
by the user
- ReportReasonFake - The chat represents a fake
account
- ReportReasonIllegalDrugs - The chat has
illegal drugs related content
- ReportReasonPersonalDetails - The
chat contains messages with personal details
- ReportReasonPornography - The chat
contains pornographic messages
- ReportReasonSpam - The chat contains spam
messages
- ReportReasonUnrelatedLocation - The
location-based chat is unrelated to its stated location
- ReportReasonViolence - The chat promotes
violence
- ReportSponsoredChat - Reports a sponsored
chat to Telegram moderators
- ReportSponsoredResult - Describes
result of sponsored message or chat report
- ReportSponsoredResultAdsHidden -
Sponsored messages were hidden for the user in all chats
- ReportSponsoredResultFailed - The
sponsored message is too old or not found
- ReportSponsoredResultOk - The message was
reported successfully
- ReportSponsoredResultOptionRequired -
The user must choose an option to report the message and repeat request with the chosen option
- ReportSponsoredResultPremiumRequired -
The user asked to hide sponsored messages, but Telegram Premium is required for this
- ReportStory - Reports a story to the Telegram
moderators
- ReportStoryResult - Describes result
of story report
- ReportStoryResultOk - The story was reported
successfully
- ReportStoryResultOptionRequired -
The user must choose an option to report the story and repeat request with the chosen option
- ReportStoryResultTextRequired - The
user must add additional text details to the report
- ReportSupergroupAntiSpamFalsePositive -
Reports a false deletion of a message by aggressive anti-spam checks; requires administrator rights in the
supergroup. Can be called only for messages from chatEventMessageDeleted with can_report_anti_spam_false_positive == true
- ReportSupergroupSpam - Reports messages in a
supergroup as spam; requires administrator rights in the supergroup
- RequestAuthenticationPasswordRecovery -
Requests to send a 2-step verification password recovery code to an email address that was previously set
up. Works only when the current authorization state is authorizationStateWaitPassword
- RequestPasswordRecovery - Requests to
send a 2-step verification password recovery code to an email address that was previously set up
- RequestQrCodeAuthentication -
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
authorizationStateWaitPremiumPurchase, authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode,
authorizationStateWaitRegistration, or authorizationStateWaitPassword
- ResendAuthenticationCode - Resends 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, or when the current authorization state is
authorizationStateWaitEmailCode
- ResendCodeReason - Describes the reason
why a code needs to be re-sent
- ResendCodeReasonUserRequest - The
user requested to resend the code
- ResendCodeReasonVerificationFailed -
The code is re-sent, because device verification has failed
- ResendEmailAddressVerificationCode -
Resends the code to verify an email address to be added to a user's Telegram Passport
- ResendLoginEmailAddressCode - Resends
the login email address verification code
- ResendMessages - 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
- ResendPhoneNumberCode - Resends the
authentication code sent to a phone number. Works only if the previously received authenticationCodeInfo next_code_type was not null and
the server-specified timeout has passed
- ResendRecoveryEmailAddressCode -
Resends the 2-step verification recovery email address verification code
- ResetAllNotificationSettings -
Resets all chat and scope notification settings to their default values. By default, all chats are unmuted and message previews are
shown
- ResetAuthenticationEmailAddress -
Resets the login email address. May return an error with a message "TASK_ALREADY_EXISTS" if reset is still
pending. Works only when the current authorization state is authorizationStateWaitEmailCode and
authorization_state.can_reset_email_address == true
- ResetInstalledBackgrounds - Resets list
of installed backgrounds to its default value
- ResetNetworkStatistics - Resets all
network data usage statistics to zero. Can be called before authorization
- ResetPassword - 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
- ResetPasswordResult - Represents
result of 2-step verification password reset
- ResetPasswordResultDeclined - The
password reset request was declined
- ResetPasswordResultOk - The password was
reset
- ResetPasswordResultPending - The
password reset request is pending
- ReuseStarSubscription - Reuses an active
Telegram Star subscription to a channel chat and joins the chat again
- RevenueWithdrawalState -
Describes state of a revenue withdrawal
- RevenueWithdrawalStateFailed -
Withdrawal failed
- RevenueWithdrawalStatePending -
Withdrawal is pending
- RevenueWithdrawalStateSucceeded -
Withdrawal succeeded
- RevokeChatInviteLink - 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
- RevokeGroupCallInviteLink - Revokes
invite link for a group call. Requires groupCall.can_be_managed right for video chats or groupCall.is_owned otherwise
- RichText - Describes a formatted text object
- RichTextAnchor - An anchor
- RichTextAnchorLink - A link to an anchor on
the same page
- RichTextBold - A bold rich text
- RichTextEmailAddress - A rich text email
link
- RichTextFixed - A fixed-width rich text
- RichTextIcon - A small image inside the text
- RichTextItalic - An italicized rich text
- RichTextMarked - A marked rich text
- RichTextPhoneNumber - A rich text phone
number
- RichTextPlain - A plain text
- RichTextReference - A reference to a richTexts
object on the same page
- RichTextStrikethrough - A strikethrough
rich text
- RichTextSubscript - A subscript rich text
- RichTextSuperscript - A superscript rich text
- RichTextUnderline - An underlined rich text
- RichTextUrl - A rich text URL link
- RichTexts - A concatenation of rich texts
- RtmpUrl - Represents an RTMP URL
- SaveApplicationLogEvent - Saves
application log event on the server. Can be called before authorization
- SavePreparedInlineMessage - Saves an
inline message to be sent by the given user; for bots only
- SavedCredentials - Contains information about
saved payment credentials
- SavedMessagesTag - Represents a tag used in
Saved Messages or a Saved Messages topic
- SavedMessagesTags - Contains a list of tags
used in Saved Messages
- SavedMessagesTopic - Contains information
about a Saved Messages topic
- SavedMessagesTopicType -
Describes type of Saved Messages topic
- SavedMessagesTopicTypeAuthorHidden -
Topic containing messages forwarded from a user with hidden privacy
- SavedMessagesTopicTypeMyNotes -
Topic containing messages sent by the current user of forwarded from an unknown chat
- SavedMessagesTopicTypeSavedFromChat -
Topic containing messages forwarded from a specific chat
- ScopeAutosaveSettings - Contains autosave
settings for an autosave settings scope
- ScopeNotificationSettings - Contains
information about notification settings for several chats
- SearchAffiliatePrograms - Searches
affiliate programs that can be connected to the given affiliate
- SearchBackground - Searches for a background by
its name
- SearchCallMessages - Searches for call and
group 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
- SearchChatAffiliateProgram - Searches
a chat with an affiliate program. Returns the chat if found and the program is active
- SearchChatMembers - Searches for a specified
query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights if the chat is a
channel
- SearchChatMessages - 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 Client.search_secret_messages
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. A combination of query, sender_id, filter and message_thread_id search criteria is
expected to be supported, only if it is required for Telegram official application implementation
- SearchChatRecentLocationMessages -
Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1
location message per user
- SearchChats - Searches for the specified query in the
title and username of already known chats. This is an offline method. Returns chats in the order seen in the main chat list
- SearchChatsOnServer - 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
- SearchContacts - Searches for the specified query
in the first names, last names and usernames of the known user contacts
- SearchEmojis - Searches for emojis by keywords.
Supported only if the file database is enabled. Order of results is unspecified
- SearchFileDownloads - Searches for files in
the file download list or recently downloaded files from the list
- SearchGiftsForResale - Returns upgraded
gifts that can be bought from other owners
- SearchHashtags - Searches for recently used
hashtags by their prefix
- SearchInstalledStickerSets - Searches
for installed sticker sets by looking for specified query in their title and name
- SearchMessages - 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
- SearchMessagesChatTypeFilter -
Represents a filter for type of the chats in which to search messages
- SearchMessagesChatTypeFilterChannel -
Returns only messages in channel chats
- SearchMessagesChatTypeFilterGroup -
Returns only messages in basic group and supergroup chats
- SearchMessagesChatTypeFilterPrivate -
Returns only messages in private chats
- SearchMessagesFilter - Represents a
filter for message search results
- SearchMessagesFilterAnimation -
Returns only animation messages
- SearchMessagesFilterAudio - Returns
only audio messages
- SearchMessagesFilterChatPhoto -
Returns only messages containing chat photos
- SearchMessagesFilterDocument -
Returns only document messages
- SearchMessagesFilterEmpty - Returns all
found messages, no filter is applied
- SearchMessagesFilterFailedToSend -
Returns only failed to send messages. This filter can be used only if the message database is used
- SearchMessagesFilterMention - Returns
only messages with mentions of the current user, or messages that are replies to their messages
- SearchMessagesFilterPhoto - Returns
only photo messages
- SearchMessagesFilterPhotoAndVideo -
Returns only photo and video messages
- SearchMessagesFilterPinned - Returns
only pinned messages
- SearchMessagesFilterUnreadMention -
Returns only messages with unread mentions of the current user, or messages that are replies to their
messages. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user
- SearchMessagesFilterUnreadReaction -
Returns only messages with unread reactions for the current user. When using this filter the results can't
be additionally filtered by a query, a message thread or by the sending user
- SearchMessagesFilterUrl - Returns only
messages containing URLs
- SearchMessagesFilterVideo - Returns
only video messages
- SearchMessagesFilterVideoNote -
Returns only video note messages
- SearchMessagesFilterVoiceAndVideoNote -
Returns only voice and video note messages
- SearchMessagesFilterVoiceNote -
Returns only voice note messages
- SearchOutgoingDocumentMessages -
Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the results in reverse
chronological order
- SearchPublicChat - 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
- SearchPublicChats - 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
- SearchPublicMessagesByTag - Searches
for public channel posts containing the given hashtag or cashtag. For optimal performance, the number of returned messages is chosen by
TDLib and can be smaller than the specified limit
- SearchPublicStoriesByLocation -
Searches for public stories by the given address location. For optimal performance, the number of returned stories is chosen by TDLib
and can be smaller than the specified limit
- SearchPublicStoriesByTag - Searches for
public stories containing the given hashtag or cashtag. For optimal performance, the number of returned stories is chosen by TDLib and
can be smaller than the specified limit
- SearchPublicStoriesByVenue - Searches
for public stories from the given venue. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller
than the specified limit
- SearchQuote - Searches for a given quote in a text.
Returns found quote start position in UTF-16 code units. Returns a 404 error if the quote is not found. Can be called synchronously
- SearchRecentlyFoundChats - Searches for
the specified query in the title and username of up to 50 recently found chats. This is an offline method
- SearchSavedMessages - Searches for messages
tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. 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 and can be smaller than the specified limit
- SearchSecretMessages - 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
- SearchStickerSet - Searches for a sticker set by
its name
- SearchStickerSets - Searches for sticker sets
by looking for specified query in their title and name. Excludes installed sticker sets from the results
- SearchStickers - Searches for stickers from public
sticker sets that correspond to any of the given emoji
- SearchStringsByPrefix - Searches specified
query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously
- SearchUserByPhoneNumber - Searches a user
by their phone number. Returns a 404 error if the user can't be found
- SearchUserByToken - Searches a user by a token
from the user's link
- SearchWebApp - Returns information about a Web App
by its short name. Returns a 404 error if the Web App is not found
- Seconds - Contains a value representing a number of
seconds
- SecretChat - Represents a secret chat
- SecretChatState - Describes the current
secret chat state
- SecretChatStateClosed - The secret chat is
closed
- SecretChatStatePending - The secret chat
is not yet created; waiting for the other user to get online
- SecretChatStateReady - The secret chat is
ready to use
- SellGift - Sells a gift for Telegram Stars
- SendAuthenticationFirebaseSms -
Sends Firebase Authentication SMS to the phone number of the user. Works only when the current authorization state is
authorizationStateWaitCode and the server returned code of the type authenticationCodeTypeFirebaseAndroid or
authenticationCodeTypeFirebaseIos
- SendBotStartMessage - Invites a bot to a chat
(if it is not yet a member) and sends it the /start command; requires can_invite_users member right. 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
- SendBusinessMessage - Sends a message on
behalf of a business account; for bots only. Returns the message after it was sent
- SendBusinessMessageAlbum - Sends 2-10
messages grouped together into an album on behalf of a business account; for bots only. 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
- SendCallDebugInformation - Sends debug
information for a call to Telegram servers
- SendCallLog - Sends log file for a call to Telegram
servers
- SendCallRating - Sends a call rating
- SendCallSignalingData - Sends call
signaling data
- SendChatAction - Sends a notification about user
activity in a chat
- SendCustomRequest - Sends a custom request; for
bots only
- SendEmailAddressVerificationCode -
Sends a code to verify an email address to be added to a user's Telegram Passport
- SendGift - Sends a gift to another user or channel chat.
May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out
- SendInlineQueryResultMessage - Sends
the result of an inline query as a message. Returns the sent message. Always clears a chat draft message
- SendMessage - Sends a message. Returns the sent
message
- SendMessageAlbum - 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
- SendPassportAuthorizationForm -
Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after
Client.get_passport_authorization_form_available_elements if some previously available elements are going to be reused
- SendPaymentForm - Sends a filled-out payment form
to the bot for final verification
- SendPhoneNumberCode - Sends a code to the
specified phone number. Aborts previous phone number verification if there was one. On success, returns information about the sent code
- SendPhoneNumberFirebaseSms - Sends
Firebase Authentication SMS to the specified phone number. Works only when received a code of the type
authenticationCodeTypeFirebaseAndroid or authenticationCodeTypeFirebaseIos
- SendQuickReplyShortcutMessages -
Sends messages from a quick reply shortcut. Requires Telegram Business subscription. Can't be used to send paid messages
- SendResoldGift - Sends an upgraded gift that is
available for resale to another user or channel chat; gifts already owned by the current user must be transferred using
Client.transfer_gift and can't be passed to the method
- SendWebAppCustomRequest - Sends a custom
request from a Web App
- SendWebAppData - Sends data received from a
keyboardButtonTypeWebApp Web App to a bot
- SentGift - Represents content of a gift
received by a user or a channel chat
- SentGiftRegular - Regular gift
- SentGiftUpgraded - Upgraded gift
- SentWebAppMessage - Information about the
message sent by Client.answer_web_app_query
- Session - 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
- SessionType - Represents the type of session
- SessionTypeAndroid - The session is running on
an Android device
- SessionTypeApple - The session is running on a
generic Apple device
- SessionTypeBrave - The session is running on the
Brave browser
- SessionTypeChrome - The session is running on
the Chrome browser
- SessionTypeEdge - The session is running on the
Edge browser
- SessionTypeFirefox - The session is running on
the Firefox browser
- SessionTypeIpad - The session is running on an
iPad device
- SessionTypeIphone - The session is running on
an iPhone device
- SessionTypeLinux - The session is running on a
Linux device
- SessionTypeMac - The session is running on a Mac
device
- SessionTypeOpera - The session is running on the
Opera browser
- SessionTypeSafari - The session is running on
the Safari browser
- SessionTypeUbuntu - The session is running on
an Ubuntu device
- SessionTypeUnknown - The session is running on
an unknown type of device
- SessionTypeVivaldi - The session is running on
the Vivaldi browser
- SessionTypeWindows - The session is running on
a Windows device
- SessionTypeXbox - The session is running on an
Xbox console
- Sessions - Contains a list of sessions
- SetAccentColor - Changes accent color and
background custom emoji for the current user; for Telegram Premium users only
- SetAccountTtl - Changes the period of inactivity
after which the account of the current user will automatically be deleted
- SetAlarm - Succeeds after a specified amount of time has
passed. Can be called before initialization
- SetApplicationVerificationToken -
Application or reCAPTCHA verification has been completed. Can be called before authorization
- SetArchiveChatListSettings - Changes
settings for automatic moving of chats to and from the Archive chat lists
- SetAuthenticationEmailAddress -
Sets the email address of the user and sends an authentication code to the email address. Works only when the current authorization
state is authorizationStateWaitEmailAddress
- SetAuthenticationPhoneNumber - 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
authorizationStateWaitPremiumPurchase, authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode,
authorizationStateWaitRegistration, or authorizationStateWaitPassword
- SetAuthenticationPremiumPurchaseTransaction -
Informs server about an in-store purchase of Telegram Premium before authorization. Works only when the
current authorization state is authorizationStateWaitPremiumPurchase
- SetAutoDownloadSettings - Sets auto-
download settings
- SetAutosaveSettings - Sets autosave settings
for the given scope. The method is guaranteed to work only after at least one call to
Client.get_autosave_settings
- SetBio - Changes the bio of the current user
- SetBirthdate - Changes the birthdate of the current
user
- SetBotInfoDescription - Sets the text shown
in the chat with a bot if the chat is empty. Can be called only if userTypeBot.can_be_edited == true
- SetBotInfoShortDescription - Sets the
text shown on a bot's profile page and sent together with the link when users share the bot. Can be called only if
userTypeBot.can_be_edited == true
- SetBotName - Sets the name of a bot. Can be called
only if userTypeBot.can_be_edited == true
- SetBotProfilePhoto - Changes a profile photo
for a bot
- SetBotUpdatesStatus - Informs the server
about the number of pending bot updates if they haven't been processed for a long time; for bots only
- SetBusinessAccountBio - Changes the bio of
a business account; for bots only
- SetBusinessAccountGiftSettings -
Changes settings for gift receiving of a business account; for bots only
- SetBusinessAccountName - Changes the first
and last name of a business account; for bots only
- SetBusinessAccountProfilePhoto -
Changes a profile photo of a business account; for bots only
- SetBusinessAccountUsername - Changes
the editable username of a business account; for bots only
- SetBusinessAwayMessageSettings -
Changes the business away message settings of the current user. Requires Telegram Business subscription
- SetBusinessConnectedBot - Adds or changes
business bot that is connected to the current user account
- SetBusinessGreetingMessageSettings -
Changes the business greeting message settings of the current user. Requires Telegram Business
subscription
- SetBusinessLocation - Changes the business
location of the current user. Requires Telegram Business subscription
- SetBusinessMessageIsPinned - Pins or
unpins a message sent on behalf of a business account; for bots only
- SetBusinessOpeningHours - Changes the
business opening hours of the current user. Requires Telegram Business subscription
- SetBusinessStartPage - Changes the business
start page of the current user. Requires Telegram Business subscription
- SetChatAccentColor - Changes accent color and
background custom emoji of a channel chat. Requires can_change_info administrator right
- SetChatActiveStoriesList - Changes story
list in which stories from the chat are shown
- SetChatAffiliateProgram - Changes
affiliate program for a bot
- SetChatAvailableReactions - Changes
reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right
- SetChatBackground - Sets the background in a
specific chat. Supported only in private and secret chats with non-deleted users, and in chats with sufficient boost level and
can_change_info administrator right
- SetChatClientData - Changes application-
specific data associated with a chat
- SetChatDescription - Changes information about
a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right
- SetChatDiscussionGroup - Changes the
discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified
- SetChatDraftMessage - Changes the draft
message in a chat
- SetChatEmojiStatus - Changes the emoji status
of a chat. Use chatBoostLevelFeatures.can_set_emoji_status to check whether an emoji status can be set. Requires can_change_info
administrator right
- SetChatLocation - 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
- SetChatMemberStatus - Changes the status of a
chat member; requires can_invite_users member right to add a chat member, can_promote_members administrator right to change
administrator rights of the member, and can_restrict_members administrator right to change restrictions of a user. This function is
currently not suitable for transferring chat ownership; use
Client.transfer_chat_ownership instead. Use Client.add_chat_member
or Client.ban_chat_member if some additional parameters needs to be
passed
- SetChatMessageAutoDeleteTime -
Changes the message auto-delete or self-destruct (for secret chats) time in a chat. Requires change_info administrator right in basic
groups, supergroups and channels. Message auto-delete time can't be changed in a chat with the current user (Saved Messages) and the
chat 777000 (Telegram).
- SetChatMessageSender - Selects a message
sender to send messages in a chat
- SetChatNotificationSettings - Changes
the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed
- SetChatPaidMessageStarCount - Changes
the amount of Telegram Stars that must be paid to send a message to a supergroup chat; requires can_restrict_members administrator right
and supergroupFullInfo.can_enable_paid_messages
- SetChatPermissions - Changes the chat members
permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right
- SetChatPhoto - Changes the photo of a chat.
Supported only for basic groups, supergroups and channels. Requires can_change_info member right
- SetChatPinnedStories - Changes the list of
pinned stories on a chat page; requires can_edit_stories right in the chat
- SetChatProfileAccentColor - Changes
accent color and background custom emoji for profile of a supergroup or channel chat. Requires can_change_info administrator right
- SetChatSlowModeDelay - Changes the slow mode
delay of a chat. Available only for supergroups; requires can_restrict_members right
- SetChatTheme - Changes the chat theme. Supported
only in private and secret chats
- SetChatTitle - Changes the chat title. Supported
only for basic groups, supergroups and channels. Requires can_change_info member right
- SetCloseFriends - Changes the list of
Client.close friends of the current user
- SetCommands - Sets the list of commands supported by
the bot for the given user scope and language; for bots only
- SetCustomEmojiStickerSetThumbnail -
Sets a custom emoji sticker set thumbnail
- SetCustomLanguagePack - Adds or changes a
custom local language pack to the current localization target
- SetCustomLanguagePackString - Adds,
edits or deletes a string in a custom local language pack. Can be called before authorization
- SetDatabaseEncryptionKey - Changes the
database encryption key. Usually the encryption key is never changed and is stored in some OS keychain
- SetDefaultBackground - Sets default
background for chats; adds the background to the list of installed backgrounds
- SetDefaultChannelAdministratorRights -
Sets default administrator rights for adding the bot to channel chats; for bots only
- SetDefaultGroupAdministratorRights -
Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only
- SetDefaultMessageAutoDeleteTime -
Changes the default message auto-delete time for new chats
- SetDefaultReactionType - Changes type of
default reaction for the current user
- SetEmojiStatus - Changes the emoji status of the
current user; for Telegram Premium users only
- SetFileGenerationProgress - Informs
TDLib on a file generation progress
- SetForumTopicNotificationSettings -
Changes the notification settings of a forum topic
- SetGameScore - Updates the game score of the
specified user in the game; for bots only
- SetGiftResalePrice - Changes resale price of a
unique gift owned by the current user
- SetGiftSettings - Changes settings for gift
receiving for the current user
- SetGroupCallParticipantIsSpeaking -
Informs TDLib that speaking state of a participant of an active group call has changed
- SetGroupCallParticipantVolumeLevel -
Changes volume level of a participant of an active group call. If the current user can manage the group
call or is the owner of the group call, then the participant's volume level will be changed for all users with the default volume level
- SetInactiveSessionTtl - Changes the period
of inactivity after which sessions will automatically be terminated
- SetInlineGameScore - Updates the game score of
the specified user in a game; for bots only
- SetLogStream - Sets new log stream for internal
logging of TDLib. Can be called synchronously
- SetLogTagVerbosityLevel - Sets the
verbosity level for a specified TDLib internal log tag. Can be called synchronously
- SetLogVerbosityLevel - Sets the verbosity
level of the internal logging of TDLib. Can be called synchronously
- SetLoginEmailAddress - Changes the login
email address of the user. The email address can be changed only if the current user already has login email and
passwordState.login_email_address_pattern is non-empty. The change will not be applied until the new login email address is confirmed
with Client.check_login_email_address_code To use Apple
ID/Google ID instead of an email address, call
Client.check_login_email_address_code directly
- SetMenuButton - Sets menu button for the given user
or for all users; for bots only
- SetMessageFactCheck - Changes the fact-check
of a message. Can be only used if messageProperties.can_set_fact_check == true
- SetMessageReactions - Sets reactions on a
message; for bots only
- SetMessageSenderBlockList - Changes the
block list of a message sender. Currently, only users and supergroup chats can be blocked
- SetMessageSenderBotVerification -
Changes the verification status of a user or a chat by an owned bot
- SetName - Changes the first and last name of the current
user
- SetNetworkType - 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
- SetNewChatPrivacySettings - Changes
privacy settings for new chat creation; can be used only if getOption("can_set_new_chat_privacy_settings")
- SetOption - 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
- SetPaidMessageReactionType - Changes
type of paid message reaction of the current user on a message. The message must have paid reaction added by the current user
- SetPassportElement - 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
- SetPassportElementErrors - 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
- SetPassword - Changes the 2-step verification
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
- SetPersonalChat - Changes the personal chat of
the current user
- SetPinnedChats - Changes the order of pinned chats
- SetPinnedForumTopics - Changes the order of
pinned forum topics; requires can_manage_topics right in the supergroup
- SetPinnedGifts - Changes the list of pinned gifts
on the current user's or the channel's profile page; requires can_post_messages administrator right in the channel chat
- SetPinnedSavedMessagesTopics -
Changes the order of pinned Saved Messages topics
- SetPollAnswer - Changes the user answer to a poll.
A poll in quiz mode can be answered only once
- SetProfileAccentColor - Changes accent
color and background custom emoji for profile of the current user; for Telegram Premium users only
- SetProfilePhoto - Changes a profile photo for the
current user
- SetQuickReplyShortcutName - Changes
name of a quick reply shortcut
- SetReactionNotificationSettings -
Changes notification settings for reactions
- SetReadDatePrivacySettings - Changes
privacy settings for message read date
- SetRecoveryEmailAddress - 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
- SetSavedMessagesTagLabel - Changes label
of a Saved Messages tag; for Telegram Premium users only
- SetScopeNotificationSettings -
Changes notification settings for chats of a given type
- SetStickerEmojis - Changes the list of emojis
corresponding to a sticker. The sticker must belong to a regular or custom emoji sticker set that is owned by the current user
- SetStickerKeywords - Changes the list of
keywords of a sticker. The sticker must belong to a regular or custom emoji sticker set that is owned by the current user
- SetStickerMaskPosition - Changes the mask
position of a mask sticker. The sticker must belong to a mask sticker set that is owned by the current user
- SetStickerPositionInSet - Changes the
position of a sticker in the set to which it belongs. The sticker set must be owned by the current user
- SetStickerSetThumbnail - Sets a sticker
set thumbnail
- SetStickerSetTitle - Sets a sticker set title
- SetStoryPrivacySettings - Changes privacy
settings of a story. The method can be called only for stories posted on behalf of the current user and if story.can_be_edited == true
- SetStoryReaction - Changes chosen reaction on a
story that has already been sent
- SetSupergroupCustomEmojiStickerSet -
Changes the custom emoji sticker set of a supergroup; requires can_change_info administrator right. The
chat must have at least chatBoostFeatures.min_custom_emoji_sticker_set_boost_level boost level to pass the corresponding color
- SetSupergroupStickerSet - Changes the
sticker set of a supergroup; requires can_change_info administrator right
- SetSupergroupUnrestrictBoostCount -
Changes the number of times the supergroup must be boosted by a user to ignore slow mode and chat
permission restrictions; requires can_restrict_members administrator right
- SetSupergroupUsername - Changes the
editable username of a supergroup or channel, requires owner privileges in the supergroup or channel
- SetTdlibParameters - Sets the parameters for
TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters
- SetUserEmojiStatus - Changes the emoji status
of a user; for bots only
- SetUserPersonalProfilePhoto - Changes
a personal profile photo of a contact user
- SetUserPrivacySettingRules - Changes
user privacy settings
- SetUserSupportInfo - Sets support information
for the given user; for Telegram support only
- SetUsername - Changes the editable username of the
current user
- SetVideoChatDefaultParticipant -
Changes default participant identifier, on whose behalf a video chat in the chat will be joined
- SetVideoChatTitle - Sets title of a video chat;
requires groupCall.can_be_managed right
- ShareChatWithBot - Shares a chat after pressing
a keyboardButtonTypeRequestChat button with the bot
- SharePhoneNumber - Shares the phone number of
the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber
- ShareUsersWithBot - Shares users after pressing
a keyboardButtonTypeRequestUsers button with the bot
- SharedChat - Contains information about a chat shared
with a bot
- SharedUser - Contains information about a user shared
with a bot
- ShippingOption - One shipping option
- SpeechRecognitionResult -
Describes result of speech recognition in a voice note
- SpeechRecognitionResultError - The
speech recognition failed
- SpeechRecognitionResultPending -
The speech recognition is ongoing
- SpeechRecognitionResultText - The
speech recognition successfully finished
- SponsoredChat - Describes a sponsored chat
- SponsoredChats - Contains a list of sponsored
chats
- SponsoredMessage - Describes a sponsored message
- SponsoredMessages - Contains a list of
sponsored messages
- StarAmount - Describes a possibly non-integer amount
of Telegram Stars
- StarCount - Contains a number of Telegram Stars
- StarGiveawayPaymentOption - Describes
an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments
- StarGiveawayPaymentOptions - Contains
a list of options for creating of Telegram Star giveaway
- StarGiveawayWinnerOption - Describes an
option for the number of winners of a Telegram Star giveaway
- StarPaymentOption - Describes an option for
buying Telegram Stars. Use telegramPaymentPurposeStars for out-of-store payments
- StarPaymentOptions - Contains a list of
options for buying Telegram Stars
- StarRevenueStatistics - A detailed
statistics about Telegram Stars earned by a bot or a chat
- StarRevenueStatus - Contains information about
Telegram Stars earned by a bot or a chat
- StarSubscription - Contains information about
subscription to a channel chat, a bot, or a business account that was paid in Telegram Stars
- StarSubscriptionPricing - Describes
subscription plan paid in Telegram Stars
- StarSubscriptionType - Describes
type of subscription paid in Telegram Stars
- StarSubscriptionTypeBot - Describes a
subscription in a bot or a business account
- StarSubscriptionTypeChannel -
Describes a subscription to a channel chat
- StarSubscriptions - Represents a list of
Telegram Star subscriptions
- StarTransaction - Represents a transaction
changing the amount of owned Telegram Stars
- StarTransactionDirection -
Describes direction of a transaction with Telegram Stars
- StarTransactionDirectionIncoming -
The transaction is incoming and increases the number of owned Telegram Stars
- StarTransactionDirectionOutgoing -
The transaction is outgoing and decreases the number of owned Telegram Stars
- StarTransactionType - Describes type
of transaction with Telegram Stars
- StarTransactionTypeAffiliateProgramCommission -
The transaction is a receiving of a commission from an affiliate program; for regular users, bots and
channel chats only
- StarTransactionTypeAppStoreDeposit -
The transaction is a deposit of Telegram Stars from App Store; for regular users only
- StarTransactionTypeBotInvoicePurchase -
The transaction is a purchase of a product from a bot or a business account by the current user; for
regular users only
- StarTransactionTypeBotInvoiceSale -
The transaction is a sale of a product by the bot; for bots only
- StarTransactionTypeBotPaidMediaPurchase -
The transaction is a purchase of paid media from a bot or a business account by the current user; for
regular users only
- StarTransactionTypeBotPaidMediaSale -
The transaction is a sale of paid media by the bot or a business account managed by the bot; for bots only
- StarTransactionTypeBotSubscriptionPurchase -
The transaction is a purchase of a subscription from a bot or a business account by the current user; for
regular users only
- StarTransactionTypeBotSubscriptionSale -
The transaction is a sale of a subscription by the bot; for bots only
- StarTransactionTypeBusinessBotTransferReceive -
The transaction is a transfer of Telegram Stars from a business account; for bots only
- StarTransactionTypeBusinessBotTransferSend -
The transaction is a transfer of Telegram Stars to a business bot; for regular users only
- StarTransactionTypeChannelPaidMediaPurchase -
The transaction is a purchase of paid media from a channel by the current user; for regular users only
- StarTransactionTypeChannelPaidMediaSale -
The transaction is a sale of paid media by the channel chat; for channel chats only
- StarTransactionTypeChannelPaidReactionReceive -
The transaction is a receiving of a paid reaction to a message by the channel chat; for channel chats only
- StarTransactionTypeChannelPaidReactionSend -
The transaction is a sending of a paid reaction to a message in a channel chat by the current user; for
regular users only
- StarTransactionTypeChannelSubscriptionPurchase -
The transaction is a purchase of a subscription to a channel chat by the current user; for regular users
only
- StarTransactionTypeChannelSubscriptionSale -
The transaction is a sale of a subscription by the channel chat; for channel chats only
- StarTransactionTypeFragmentDeposit -
The transaction is a deposit of Telegram Stars from Fragment; for regular users and bots only
- StarTransactionTypeFragmentWithdrawal -
The transaction is a withdrawal of earned Telegram Stars to Fragment; for regular users, bots, supergroup
and channel chats only
- StarTransactionTypeGiftPurchase -
The transaction is a purchase of a regular gift; for regular users and bots only
- StarTransactionTypeGiftSale - The
transaction is a sale of a received gift; for regular users and channel chats only
- StarTransactionTypeGiftTransfer -
The transaction is a transfer of an upgraded gift; for regular users only
- StarTransactionTypeGiftUpgrade -
The transaction is an upgrade of a gift; for regular users only
- StarTransactionTypeGiveawayDeposit -
The transaction is a deposit of Telegram Stars from a giveaway; for regular users only
- StarTransactionTypeGooglePlayDeposit -
The transaction is a deposit of Telegram Stars from Google Play; for regular users only
- StarTransactionTypePaidMessageReceive -
The transaction is a receiving of a paid message; for regular users and supergroup chats only
- StarTransactionTypePaidMessageSend -
The transaction is a sending of a paid message; for regular users only
- StarTransactionTypePremiumBotDeposit -
The transaction is a deposit of Telegram Stars from the Premium bot; for regular users only
- StarTransactionTypePremiumPurchase -
The transaction is a purchase of Telegram Premium subscription; for regular users and bots only
- StarTransactionTypeTelegramAdsWithdrawal -
The transaction is a withdrawal of earned Telegram Stars to Telegram Ad platform; for bots and channel
chats only
- StarTransactionTypeTelegramApiUsage -
The transaction is a payment for Telegram API usage; for bots only
- StarTransactionTypeUnsupported -
The transaction is a transaction of an unsupported type
- StarTransactionTypeUpgradedGiftPurchase -
The transaction is a purchase of an upgraded gift for some user or channel; for regular users only
- StarTransactionTypeUpgradedGiftSale -
The transaction is a sale of an upgraded gift; for regular users only
- StarTransactionTypeUserDeposit -
The transaction is a deposit of Telegram Stars by another user; for regular users only
- StarTransactions - Represents a list of Telegram
Star transactions
- StartGroupCallRecording - Starts
recording of an active group call; for video chats only. Requires groupCall.can_be_managed right
- StartGroupCallScreenSharing - Starts
screen sharing in a joined group call. Returns join response payload for tgcalls
- StartScheduledVideoChat - Starts a
scheduled video chat
- StatisticalGraph - Describes a
statistical graph
- StatisticalGraphAsync - The graph data to
be asynchronously loaded through Client.get_statistical_graph
- StatisticalGraphData - A graph data
- StatisticalGraphError - An error message to
be shown to the user instead of the graph
- StatisticalValue - A value with information
about its recent changes
- Sticker - Describes a sticker
- StickerFormat - Describes format of a
sticker
- StickerFormatTgs - The sticker is an animation
in TGS format
- StickerFormatWebm - The sticker is a video in
WEBM format
- StickerFormatWebp - The sticker is an image in
WEBP format
- StickerFullType - Contains full
information about sticker type
- StickerFullTypeCustomEmoji - The
sticker is a custom emoji to be used inside message text and caption. Currently, only Telegram Premium users can use custom emoji
- StickerFullTypeMask - The sticker is a mask
in WEBP format to be placed on photos or videos
- StickerFullTypeRegular - The sticker is a
regular sticker
- StickerSet - Represents a sticker set
- StickerSetInfo - Represents short information
about a sticker set
- StickerSets - Represents a list of sticker sets
- StickerType - Describes type of sticker
- StickerTypeCustomEmoji - The sticker is a
custom emoji to be used inside message text and caption
- StickerTypeMask - The sticker is a mask in WEBP
format to be placed on photos or videos
- StickerTypeRegular - The sticker is a regular
sticker
- Stickers - Represents a list of stickers
- StopBusinessPoll - Stops a poll sent on behalf
of a business account; for bots only
- StopPoll - Stops a poll
- StorageStatistics - Contains the exact storage
usage statistics split by chats and file type
- StorageStatisticsByChat - Contains the
storage usage statistics for a specific chat
- StorageStatisticsByFileType -
Contains the storage usage statistics for a specific file type
- StorageStatisticsFast - Contains
approximate storage usage statistics, excluding files of unknown file type
- StorePaymentPurpose - Describes a
purpose of an in-store payment
- StorePaymentPurposeGiftedStars -
The user buying Telegram Stars for other users
- StorePaymentPurposePremiumGift -
The user gifting Telegram Premium to another user
- StorePaymentPurposePremiumGiftCodes -
The user boosting a chat by creating Telegram Premium gift codes for other users
- StorePaymentPurposePremiumGiveaway -
The user creating a Telegram Premium giveaway
- StorePaymentPurposePremiumSubscription -
The user subscribing to Telegram Premium
- StorePaymentPurposeStarGiveaway -
The user creating a Telegram Star giveaway
- StorePaymentPurposeStars - The user
buying Telegram Stars
- StoreTransaction - Describes an in-
store transaction
- StoreTransactionAppStore - A purchase
through App Store
- StoreTransactionGooglePlay - A
purchase through Google Play
- Stories - Represents a list of stories
- Story - Represents a story
- StoryArea - Describes a clickable rectangle area on a
story media
- StoryAreaPosition - Describes position of a
clickable rectangle area on a story media
- StoryAreaType - Describes type of
clickable area on a story media
- StoryAreaTypeLink - An area pointing to a HTTP
or tg:// link
- StoryAreaTypeLocation - An area pointing to
a location
- StoryAreaTypeMessage - An area pointing to a
message
- StoryAreaTypeSuggestedReaction -
An area pointing to a suggested reaction. App needs to show a clickable reaction on the area and call
Client.set_story_reaction when the are is clicked
- StoryAreaTypeUpgradedGift - An area
with an upgraded gift
- StoryAreaTypeVenue - An area pointing to a
venue
- StoryAreaTypeWeather - An area with
information about weather
- StoryContent - Contains the content of a
story
- StoryContentPhoto - A photo story
- StoryContentUnsupported - A story content
that is not supported in the current TDLib version
- StoryContentVideo - A video story
- StoryFullId - Contains identifier of a story along
with identifier of the chat that posted it
- StoryInfo - Contains basic information about a story
- StoryInteraction - Represents interaction with a
story
- StoryInteractionInfo - Contains information
about interactions with a story
- StoryInteractionType - Describes
type of interaction with a story
- StoryInteractionTypeForward - A
forward of the story as a message
- StoryInteractionTypeRepost - A repost
of the story as a story
- StoryInteractionTypeView - A view of the
story
- StoryInteractions - Represents a list of
interactions with a story
- StoryList - Describes a list of stories
- StoryListArchive - The list of stories, shown in
the Arvhive chat list
- StoryListMain - The list of stories, shown in the
main chat list and folder chat lists
- StoryOrigin - Contains information about the
origin of a story that was reposted
- StoryOriginHiddenUser - The original story
was posted by an unknown user
- StoryOriginPublicStory - The original
story was a public story that was posted by a known chat
- StoryPrivacySettings - Describes
privacy settings of a story
- StoryPrivacySettingsCloseFriends -
The story can be viewed by all Client.close friends
- StoryPrivacySettingsContacts - The
story can be viewed by all contacts except chosen users
- StoryPrivacySettingsEveryone - The
story can be viewed by everyone
- StoryPrivacySettingsSelectedUsers -
The story can be viewed by certain specified users
- StoryRepostInfo - Contains information about
original story that was reposted
- StoryStatistics - A detailed statistics about a
story
- StoryVideo - Describes a video file posted as a story
- SuggestUserProfilePhoto - Suggests a
profile photo to another regular user with common messages and allowing non-paid messages
- SuggestedAction - Describes an action
suggested to the current user
- SuggestedActionCheckPassword -
Suggests the user to check whether they still remember their 2-step verification password
- SuggestedActionCheckPhoneNumber -
Suggests the user to check whether authorization phone number is correct and change the phone number if it
is inaccessible
- SuggestedActionConvertToBroadcastGroup -
Suggests the user to convert specified supergroup to a broadcast group
- SuggestedActionCustom - A custom suggestion
to be shown at the top of the chat list
- SuggestedActionEnableArchiveAndMuteNewChats -
Suggests the user to enable archive_and_mute_new_chats_from_unknown_users setting in
archiveChatListSettings
- SuggestedActionExtendPremium -
Suggests the user to extend their expiring Telegram Premium subscription
- SuggestedActionExtendStarSubscriptions -
Suggests the user to extend their expiring Telegram Star subscriptions. Call
Client.get_star_subscriptions with only_expiring == true to get
the number of expiring subscriptions and the number of required to buy Telegram Stars
- SuggestedActionGiftPremiumForChristmas -
Suggests the user to gift Telegram Premium to friends for Christmas
- SuggestedActionRestorePremium -
Suggests the user to restore a recently expired Premium subscription
- SuggestedActionSetBirthdate -
Suggests the user to set birthdate
- SuggestedActionSetPassword - Suggests
the user to set a 2-step verification password to be able to log in again
- SuggestedActionSetProfilePhoto -
Suggests the user to set profile photo
- SuggestedActionSubscribeToAnnualPremium -
Suggests the user to subscribe to the Premium subscription with annual payments
- SuggestedActionUpgradePremium -
Suggests the user to upgrade the Premium subscription from monthly payments to annual payments
- SuggestedActionViewChecksHint -
Suggests the user to view a hint about the meaning of one and two check marks on sent messages
- Supergroup - Represents a supergroup or channel with
zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a
supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the
channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers
- SupergroupFullInfo - Contains full information
about a supergroup or channel
- SupergroupMembersFilter -
Specifies the kind of chat members to return in
Client.get_supergroup_members
- SupergroupMembersFilterAdministrators -
Returns the owner and administrators
- SupergroupMembersFilterBanned -
Returns users banned from the supergroup or channel; can be used only by administrators
- SupergroupMembersFilterBots - Returns
bot members of the supergroup or channel
- SupergroupMembersFilterContacts -
Returns contacts of the user, which are members of the supergroup or channel
- SupergroupMembersFilterMention -
Returns users which can be mentioned in the supergroup
- SupergroupMembersFilterRecent -
Returns recently active users in reverse chronological order
- SupergroupMembersFilterRestricted -
Returns restricted supergroup members; can be used only by administrators
- SupergroupMembersFilterSearch -
Used to search for supergroup or channel members via a (string) query
- SynchronizeLanguagePack - 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
- TDObject - Base TDLib object
- TMeUrl - Represents a URL linking to an internal Telegram
entity
- TMeUrlType - Describes the type of URL
linking to an internal Telegram entity
- TMeUrlTypeChatInvite - A chat invite link
- TMeUrlTypeStickerSet - A URL linking to a
sticker set
- TMeUrlTypeSupergroup - A URL linking to a
public supergroup or channel
- TMeUrlTypeUser - A URL linking to a user
- TMeUrls - Contains a list of t.me URLs
- TargetChat - Describes the target chat to be
opened
- TargetChatChosen - The chat needs to be chosen
by the user among chats of the specified types
- TargetChatCurrent - The currently opened chat
and forum topic must be kept
- TargetChatInternalLink - The chat needs to
be open with the provided internal link
- TargetChatTypes - Describes allowed types for the
target chat
- TelegramPaymentPurpose -
Describes a purpose of a payment toward Telegram
- TelegramPaymentPurposeGiftedStars -
The user buying Telegram Stars for other users
- TelegramPaymentPurposeJoinChat -
The user joins a chat and subscribes to regular payments in Telegram Stars
- TelegramPaymentPurposePremiumGift -
The user gifting Telegram Premium to another user
- TelegramPaymentPurposePremiumGiftCodes -
The user boosting a chat by creating Telegram Premium gift codes for other users
- TelegramPaymentPurposePremiumGiveaway -
The user creating a Telegram Premium giveaway
- TelegramPaymentPurposeStarGiveaway -
The user creating a Telegram Star giveaway
- TelegramPaymentPurposeStars - The
user buying Telegram Stars
- TemporaryPasswordState - Returns
information about the availability of a temporary password, which can be used for payments
- TerminateAllOtherSessions - Terminates
all other sessions of the current user
- TerminateSession - Terminates a session of the
current user
- TermsOfService - Contains Telegram terms of
service
- TestBytes - A simple object containing a sequence of
bytes; for testing only
- TestCallBytes - Returns the received bytes; for
testing only. This is an offline method. Can be called before authorization
- TestCallEmpty - Does nothing; for testing only.
This is an offline method. Can be called before authorization
- TestCallString - Returns the received string; for
testing only. This is an offline method. Can be called before authorization
- TestCallVectorInt - Returns the received vector
of numbers; for testing only. This is an offline method. Can be called before authorization
- TestCallVectorIntObject - Returns the
received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization
- TestCallVectorString - Returns the received
vector of strings; for testing only. This is an offline method. Can be called before authorization
- TestCallVectorStringObject - Returns
the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization
- TestGetDifference - Forces an
updates.getDifference call to the Telegram servers; for testing only
- TestInt - A simple object containing a number; for
testing only
- TestNetwork - Sends a simple network request to the
Telegram servers; for testing only. Can be called before authorization
- TestProxy - Sends a simple network request to the
Telegram servers via proxy; for testing only. Can be called before authorization
- TestReturnError - Returns the specified error and
ensures that the Error object is used; for testing only. Can be called synchronously
- TestSquareInt - Returns the squared received
number; for testing only. This is an offline method. Can be called before authorization
- TestString - A simple object containing a string; for
testing only
- TestUseUpdate - Does nothing and ensures that the
Update object is used; for testing only. This is an offline method. Can be called before authorization
- TestVectorInt - A simple object containing a vector
of numbers; for testing only
- TestVectorIntObject - A simple object
containing a vector of objects that hold a number; for testing only
- TestVectorString - A simple object containing a
vector of strings; for testing only
- TestVectorStringObject - A simple object
containing a vector of objects that hold a string; for testing only
- Text - Contains some text
- TextEntities - Contains a list of text entities
- TextEntity - Represents a part of the text that needs
to be formatted in some unusual way
- TextEntityType - Represents a part of the
text which must be formatted differently
- TextEntityTypeBankCardNumber - A
bank card number. The Client.get_bank_card_info method can be used to
get information about the bank card
- TextEntityTypeBlockQuote - Text that
must be formatted as if inside a blockquote HTML tag; not supported in secret chats
- TextEntityTypeBold - A bold text
- TextEntityTypeBotCommand - A bot
command, beginning with "/"
- TextEntityTypeCashtag - A cashtag text,
beginning with "$", consisting of capital English letters (e.g., "$USD"), and optionally containing a chat username at the end
- TextEntityTypeCode - Text that must be
formatted as if inside a code HTML tag
- TextEntityTypeCustomEmoji - A custom
emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emoji
- TextEntityTypeEmailAddress - An email
address
- TextEntityTypeExpandableBlockQuote -
Text that must be formatted as if inside a blockquote HTML tag and collapsed by default to 3 lines with
the ability to show full text; not supported in secret chats
- TextEntityTypeHashtag - A hashtag text,
beginning with "#" and optionally containing a chat username at the end
- TextEntityTypeItalic - An italic text
- TextEntityTypeMediaTimestamp - A
media timestamp
- TextEntityTypeMention - A mention of a
user, a supergroup, or a channel by their username
- TextEntityTypeMentionName - A text
shows instead of a raw mention of the user (e.g., when the user has no username)
- TextEntityTypePhoneNumber - A phone
number
- TextEntityTypePre - Text that must be formatted
as if inside a pre HTML tag
- TextEntityTypePreCode - Text that must be
formatted as if inside pre, and code HTML tags
- TextEntityTypeSpoiler - A spoiler text
- TextEntityTypeStrikethrough - A
strikethrough text
- TextEntityTypeTextUrl - A text shown
instead of a raw URL
- TextEntityTypeUnderline - An underlined
text
- TextEntityTypeUrl - An HTTP URL
- TextParseMode - Describes the way the text
needs to be parsed for text entities
- TextParseModeHTML - The text uses HTML-style
formatting. The same as Telegram Bot API "HTML" parse mode
- TextParseModeMarkdown - The text uses
Markdown-style formatting
- TextQuote - Describes manually or automatically chosen
quote from another message
- ThemeParameters - Contains parameters of the
application theme
- ThemeSettings - Describes theme settings
- Thumbnail - Represents a thumbnail
- ThumbnailFormat - Describes format of a
thumbnail
- ThumbnailFormatGif - The thumbnail is in
static GIF format. It will be used only for some bot inline query results
- ThumbnailFormatJpeg - The thumbnail is in
JPEG format
- ThumbnailFormatMpeg4 - The thumbnail is in
MPEG4 format. It will be used only for some animations and videos
- ThumbnailFormatPng - The thumbnail is in PNG
format. It will be used only for background patterns
- ThumbnailFormatTgs - The thumbnail is in TGS
format. It will be used only for sticker sets
- ThumbnailFormatWebm - The thumbnail is in
WEBM format. It will be used only for sticker sets
- ThumbnailFormatWebp - The thumbnail is in
WEBP format. It will be used only for some stickers and sticker sets
- TimeZone - Describes a time zone
- TimeZones - Contains a list of time zones
- ToggleAllDownloadsArePaused - Changes
pause state of all files in the file download list
- ToggleBotCanManageEmojiStatus -
Toggles whether the bot can manage emoji status of the current user
- ToggleBotIsAddedToAttachmentMenu -
Adds or removes a bot to attachment and side menu. Bot can be added to the menu, only if
userTypeBot.can_be_added_to_attachment_menu == true
- ToggleBotUsernameIsActive - Changes
active state for a username of a bot. The editable username can't be disabled. May return an error with a message
"USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached. Can be called only if userTypeBot.can_be_edited
== true
- ToggleBusinessConnectedBotChatIsPaused -
Pauses or resumes the connected business bot in a specific chat
- ToggleChatDefaultDisableNotification -
Changes the value of the default disable_notification parameter, used when a message is sent to a chat
- ToggleChatFolderTags - Toggles whether chat
folder tags are enabled
- ToggleChatGiftNotifications - Toggles
whether notifications for new gifts received by a channel chat are sent to the current user; requires can_post_messages administrator
right in the chat
- ToggleChatHasProtectedContent -
Changes the ability of users to save, forward, or copy chat content. Supported only for basic groups, supergroups and channels. Requires
owner privileges
- ToggleChatIsMarkedAsUnread - Changes
the marked as unread state of a chat
- ToggleChatIsPinned - 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/archive chat list. The limit can be increased with Telegram Premium
- ToggleChatIsTranslatable - Changes the
translatable state of a chat
- ToggleChatViewAsTopics - Changes the
view_as_topics setting of a forum chat or Saved Messages
- ToggleDownloadIsPaused - Changes pause
state of a file in the file download list
- ToggleForumTopicIsClosed - Toggles
whether a topic is closed in a forum supergroup chat; requires can_manage_topics right in the supergroup unless the user is creator of
the topic
- ToggleForumTopicIsPinned - Changes the
pinned state of a forum topic; requires can_manage_topics right in the supergroup. There can be up to
getOption("pinned_forum_topic_count_max") pinned forum topics
- ToggleGeneralForumTopicIsHidden -
Toggles whether a General topic is hidden in a forum supergroup chat; requires can_manage_topics right in
the supergroup
- ToggleGiftIsSaved - Toggles whether a gift is
shown on the current user's or the channel's profile page; requires can_post_messages administrator right in the channel chat
- ToggleGroupCallIsMyVideoEnabled -
Toggles whether current user's video is enabled
- ToggleGroupCallIsMyVideoPaused -
Toggles whether current user's video is paused
- ToggleGroupCallParticipantIsHandRaised -
Toggles whether a group call participant hand is rased; for video chats only
- ToggleGroupCallParticipantIsMuted -
Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves
- ToggleGroupCallScreenSharingIsPaused -
Pauses or unpauses screen sharing in a joined group call
- ToggleHasSponsoredMessagesEnabled -
Toggles whether the current user has sponsored messages enabled. The setting has no effect for users
without Telegram Premium for which sponsored messages are always enabled
- ToggleSavedMessagesTopicIsPinned -
Changes the pinned state of a Saved Messages topic. There can be up to
getOption("pinned_saved_messages_topic_count_max") pinned topics. The limit can be increased with Telegram Premium
- ToggleSessionCanAcceptCalls - Toggles
whether a session can accept incoming calls
- ToggleSessionCanAcceptSecretChats -
Toggles whether a session can accept incoming secret chats
- ToggleStoryIsPostedToChatPage -
Toggles whether a story is accessible after expiration. Can be called only if story.can_toggle_is_posted_to_chat_page == true
- ToggleSupergroupCanHaveSponsoredMessages -
Toggles whether sponsored messages are shown in the channel chat; requires owner privileges in the
channel. The chat must have at least chatBoostFeatures.min_sponsored_message_disable_boost_level boost level to disable sponsored
messages
- ToggleSupergroupHasAggressiveAntiSpamEnabled -
Toggles whether aggressive anti-spam checks are enabled in the supergroup. Can be called only if
supergroupFullInfo.can_toggle_aggressive_anti_spam == true
- ToggleSupergroupHasAutomaticTranslation -
Toggles whether messages are automatically translated in the channel chat; requires can_change_info
administrator right in the channel. The chat must have at least chatBoostFeatures.min_automatic_translation_boost_level boost level to
enable automatic translation
- ToggleSupergroupHasHiddenMembers -
Toggles whether non-administrators can receive only administrators and bots using
Client.get_supergroup_members or
Client.search_chat_members Can be called only if
supergroupFullInfo.can_hide_members == true
- ToggleSupergroupIsAllHistoryAvailable -
Toggles whether the message history of a supergroup is available to new members; requires can_change_info
member right
- ToggleSupergroupIsBroadcastGroup -
Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup
- ToggleSupergroupIsForum - Toggles whether
the supergroup is a forum; requires owner privileges in the supergroup. Discussion supergroups can't be converted to forums
- ToggleSupergroupJoinByRequest -
Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires
can_restrict_members administrator right
- ToggleSupergroupJoinToSendMessages -
Toggles whether joining is mandatory to send messages to a discussion supergroup; requires
can_restrict_members administrator right
- ToggleSupergroupSignMessages -
Toggles whether sender signature or link to the account is added to sent messages in a channel; requires can_change_info member right
- ToggleSupergroupUsernameIsActive -
Changes active state for a username of a supergroup or channel, requires owner privileges in the
supergroup or channel. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the
maximum number of active usernames has been reached
- ToggleUsernameIsActive - Changes active
state for a username of the current user. The editable username can't be disabled. May return an error with a message
"USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached
- ToggleVideoChatEnabledStartNotification -
Toggles whether the current user will receive a notification when the video chat starts; for scheduled
video chats only
- ToggleVideoChatMuteNewParticipants -
Toggles whether new participants of a video chat can be unmuted only by administrators of the video chat.
Requires groupCall.can_toggle_mute_new_participants right
- TopChatCategory - Represents the
categories of chats for which a list of frequently used chats can be retrieved
- TopChatCategoryBots - A category containing
frequently used private chats with bot users
- TopChatCategoryCalls - A category containing
frequently used chats used for calls
- TopChatCategoryChannels - A category
containing frequently used channels
- TopChatCategoryForwardChats - A
category containing frequently used chats used to forward messages
- TopChatCategoryGroups - A category
containing frequently used basic groups and supergroups
- TopChatCategoryInlineBots - A category
containing frequently used chats with inline bots sorted by their usage in inline mode
- TopChatCategoryUsers - A category containing
frequently used private chats with non-bot users
- TopChatCategoryWebAppBots - A category
containing frequently used chats with bots, which Web Apps were opened
- TransferBusinessAccountStars -
Transfer Telegram Stars from the business account to the business bot; for bots only
- TransferChatOwnership - Changes the owner
of a chat; requires owner privileges in the chat. Use the method
Client.can_transfer_ownership to check whether the ownership can be transferred from the current session. Available only for
supergroups and channel chats
- TransferGift - Sends an upgraded gift to another
user or a channel chat
- TranslateMessageText - Extracts text or
caption of the given message and translates it to the given language. If the current user is a Telegram Premium user, then text
formatting is preserved
- TranslateText - Translates a text to the given
language. If the current user is a Telegram Premium user, then text formatting is preserved
- TrendingStickerSets - Represents a list of
trending sticker sets
- UnconfirmedSession - Contains information
about an unconfirmed session
- UnpinAllChatMessages - Removes all pinned
messages from a chat; requires can_pin_messages member right if the chat is a basic group or supergroup, or can_edit_messages
administrator right if the chat is a channel
- UnpinAllMessageThreadMessages -
Removes all pinned messages from a forum topic; requires can_pin_messages member right in the supergroup
- UnpinChatMessage - Removes a pinned message from
a chat; requires can_pin_messages member right if the chat is a basic group or supergroup, or can_edit_messages administrator right if
the chat is a channel
- UnreadReaction - Contains information about an
unread reaction to a message
- Update - Contains notifications about data
changes
- UpdateAccentColors - The list of supported
accent colors has changed
- UpdateActiveEmojiReactions - The list
of active emoji reactions has changed
- UpdateActiveLiveLocationMessages -
The list of messages with active live location that need to be updated by the application has changed. The
list is persistent across application restarts only if the message database is used
- UpdateActiveNotifications - Contains
active notifications that were 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
- UpdateAnimatedEmojiMessageClicked -
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
- UpdateAnimationSearchParameters -
The parameters of animation search through getOption("animation_search_bot_username") bot has changed
- UpdateApplicationRecaptchaVerificationRequired -
A request can't be completed unless reCAPTCHA verification is performed; for official mobile applications
only. The method Client.set_application_verification_token
must be called once the verification is completed or failed
- UpdateApplicationVerificationRequired -
A request can't be completed unless application verification is performed; for official mobile
applications only. The method
Client.set_application_verification_token must be called once the verification is completed or failed
- UpdateAttachmentMenuBots - The list of
bots added to attachment or side menu has changed
- UpdateAuthorizationState - The user
authorization state has changed
- UpdateAutosaveSettings - Autosave settings
for some type of chats were updated
- UpdateAvailableMessageEffects - The
list of available message effects has changed
- UpdateBasicGroup - Some data of a basic group
has changed. This update is guaranteed to come before the basic group identifier is returned to the application
- UpdateBasicGroupFullInfo - Some data in
basicGroupFullInfo has been changed
- UpdateBusinessConnection - A business
connection has changed; for bots only
- UpdateBusinessMessageEdited - A
message in a business account was edited; for bots only
- UpdateBusinessMessagesDeleted -
Messages in a business account were deleted; for bots only
- UpdateCall - New call was created or information about
a call was updated
- UpdateChatAccentColors - Chat accent
colors have changed
- UpdateChatAction - A message sender activity in
the chat has changed
- UpdateChatActionBar - The chat action bar was
changed
- UpdateChatActiveStories - The list of
active stories posted by a specific chat has changed
- UpdateChatAddedToList - A chat was added to
a chat list
- UpdateChatAvailableReactions - The
chat available reactions were changed
- UpdateChatBackground - The chat background
was changed
- UpdateChatBlockList - A chat was blocked or
unblocked
- UpdateChatBoost - A chat boost has changed; for
bots only
- UpdateChatBusinessBotManageBar -
The bar for managing business bot was changed in a chat
- UpdateChatDefaultDisableNotification -
The value of the default disable_notification parameter, used when a message is sent to the chat, was
changed
- UpdateChatDraftMessage - A chat draft has
changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the
content of the draft, this update mustn't be applied
- UpdateChatEmojiStatus - Chat emoji status
has changed
- UpdateChatFolders - The list of chat folders or
a chat folder has changed
- UpdateChatHasProtectedContent - A
chat content was allowed or restricted for saving
- UpdateChatHasScheduledMessages - A
chat's has_scheduled_messages field has changed
- UpdateChatIsMarkedAsUnread - A chat
was marked as unread or was read
- UpdateChatIsTranslatable - Translation
of chat messages was enabled or disabled
- UpdateChatLastMessage - The last message of
a chat was changed
- UpdateChatMember - User rights changed in a
chat; for bots only
- UpdateChatMessageAutoDeleteTime -
The message auto-delete or self-destruct timer setting for a chat was changed
- UpdateChatMessageSender - The message
sender that is selected to send messages in a chat has changed
- UpdateChatNotificationSettings -
Notification settings for a chat were changed
- UpdateChatOnlineMemberCount - The
number of online group members has changed. This update with non-zero number of online group members is sent only for currently opened
chats. There is no guarantee that it is sent just after the number of online users has changed
- UpdateChatPendingJoinRequests - The
chat pending join requests were changed
- UpdateChatPermissions - Chat permissions
were changed
- UpdateChatPhoto - A chat photo was changed
- UpdateChatPosition - The position of a chat in
a chat list has changed. An updateChatLastMessage or updateChatDraftMessage update might be sent instead of the update
- UpdateChatReadInbox - Incoming messages were
read or the number of unread messages has been changed
- UpdateChatReadOutbox - Outgoing messages
were read
- UpdateChatRemovedFromList - A chat was
removed from a chat list
- UpdateChatReplyMarkup - The default chat
reply markup was changed. Can occur because new messages with reply markup were received or because an old reply markup was hidden by
the user
- UpdateChatRevenueAmount - The revenue
earned from sponsored messages in a chat has changed. If chat revenue screen is opened, then
Client.get_chat_revenue_transactions may be called to fetch
new transactions
- UpdateChatTheme - The chat theme was changed
- UpdateChatThemes - The list of available chat
themes has changed
- UpdateChatTitle - The title of a chat was changed
- UpdateChatUnreadMentionCount - The
chat unread_mention_count has changed
- UpdateChatUnreadReactionCount - The
chat unread_reaction_count has changed
- UpdateChatVideoChat - A chat video chat state
has changed
- UpdateChatViewAsTopics - A chat default
appearance has changed
- UpdateConnectionState - The connection
state has changed. This update must be used only to show a human-readable of the connection state
- UpdateContactCloseBirthdays - The
list of contacts that had birthdays recently or will have birthday soon has changed
- UpdateDefaultBackground - The default
background has changed
- UpdateDefaultPaidReactionType - The
type of default paid reaction has changed
- UpdateDefaultReactionType - The type of
default reaction has changed
- UpdateDeleteMessages - Some messages were
deleted
- UpdateDiceEmojis - The list of supported dice
emojis has changed
- UpdateFavoriteStickers - The list of
favorite stickers was updated
- UpdateFile - Information about a file was updated
- UpdateFileAddedToDownloads - A file
was added to the file download list. This update is sent only after file download list is loaded for the first time
- UpdateFileDownload - A file download was
changed. This update is sent only after file download list is loaded for the first time
- UpdateFileDownloads - The state of the file
download list has changed
- UpdateFileGenerationStart - The file
generation process needs to be started by the application. Use
Client.set_file_generation_progress and
Client.finish_file_generation to generate the file
- UpdateFileGenerationStop - File
generation is no longer needed
- UpdateFileRemovedFromDownloads - A
file was removed from the file download list. This update is sent only after file download list is loaded for the first time
- UpdateForumTopic - Information about a topic in
a forum chat was changed
- UpdateForumTopicInfo - Basic information
about a topic in a forum chat was changed
- UpdateFreezeState - The freeze state of the
current user's account has changed
- UpdateGroupCall - Information about a group call
was updated
- UpdateGroupCallParticipant -
Information about a group call participant was changed. The updates are sent only after the group call is received through
Client.get_group_call and only if the call is joined or being joined
- UpdateGroupCallParticipants - The
list of group call participants that can send and receive encrypted call data has changed; for group calls not bound to a chat only
- UpdateGroupCallVerificationState -
The verification state of an encrypted group call has changed; for group calls not bound to a chat only
- UpdateHavePendingNotifications -
Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some
pending notifications
- UpdateInstalledStickerSets - The list
of installed sticker sets was updated
- UpdateLanguagePackStrings - Some
language pack strings have been updated
- UpdateMessageContent - The message content
has changed
- UpdateMessageContentOpened - The
message content was opened. Updates voice note messages to "listened", video note messages to "viewed" and starts the self-destruct
timer
- UpdateMessageEdited - A message was edited.
Changes in the message content will come in a separate updateMessageContent
- UpdateMessageFactCheck - A fact-check
added to a message was changed
- UpdateMessageInteractionInfo - The
information about interactions with a message has changed
- UpdateMessageIsPinned - The message pinned
state was changed
- UpdateMessageLiveLocationViewed -
A message with a live location was viewed. When the update is received, the application is expected to
update the live location
- UpdateMessageMentionRead - A message
with an unread mention was read
- UpdateMessageReaction - User changed its
reactions on a message with public reactions; for bots only
- UpdateMessageReactions - Reactions added
to a message with anonymous reactions have changed; for bots only
- UpdateMessageSendAcknowledged - A
request to send a message has reached the Telegram server. This doesn't mean that the message will be sent successfully. This update is
sent only if the option "use_quick_ack" is set to true. This update may be sent multiple times for the same message
- UpdateMessageSendFailed - A message
failed to send. Be aware that some messages being sent can be irrecoverably deleted, in which case updateDeleteMessages will be received
instead of this update
- UpdateMessageSendSucceeded - A message
has been successfully sent
- UpdateMessageUnreadReactions - The
list of unread reactions added to a message was changed
- UpdateNewBusinessCallbackQuery - A
new incoming callback query from a business message; for bots only
- UpdateNewBusinessMessage - A new message
was added to a business account; for bots only
- UpdateNewCallSignalingData - New call
signaling data arrived
- UpdateNewCallbackQuery - A new incoming
callback query; for bots only
- UpdateNewChat - A new chat has been loaded/created.
This update is guaranteed to come before the chat identifier is returned to the application. The chat field changes will be reported
through separate updates
- UpdateNewChatJoinRequest - A user sent a
join request to a chat; for bots only
- UpdateNewChosenInlineResult - The
user has chosen a result of an inline query; for bots only
- UpdateNewCustomEvent - A new incoming event;
for bots only
- UpdateNewCustomQuery - A new incoming query;
for bots only
- UpdateNewInlineCallbackQuery - A new
incoming callback query from a message sent via a bot; for bots only
- UpdateNewInlineQuery - A new incoming inline
query; for bots only
- UpdateNewMessage - A new message was received;
can also be an outgoing message
- UpdateNewPreCheckoutQuery - A new
incoming pre-checkout query; for bots only. Contains full information about a checkout
- UpdateNewShippingQuery - A new incoming
shipping query; for bots only. Only for invoices with flexible price
- UpdateNotification - A notification was
changed
- UpdateNotificationGroup - A list of
active notifications in a notification group has changed
- UpdateOption - An option changed its value
- UpdateOwnedStarCount - The number of
Telegram Stars owned by the current user has changed
- UpdatePaidMediaPurchased - Paid media
were purchased by a user; for bots only
- UpdatePoll - A poll was updated; for bots only
- UpdatePollAnswer - A user changed the answer to
a poll; for bots only
- UpdateProfileAccentColors - The list of
supported accent colors for user profiles has changed
- UpdateQuickReplyShortcut - Basic
information about a quick reply shortcut has changed. This update is guaranteed to come before the quick shortcut name is returned to
the application
- UpdateQuickReplyShortcutDeleted -
A quick reply shortcut and all its messages were deleted
- UpdateQuickReplyShortcutMessages -
The list of quick reply shortcut messages has changed
- UpdateQuickReplyShortcuts - The list of
quick reply shortcuts has changed
- UpdateReactionNotificationSettings -
Notification settings for reactions were updated
- UpdateRecentStickers - The list of recently
used stickers was updated
- UpdateSavedAnimations - The list of saved
animations was updated
- UpdateSavedMessagesTags - Tags used in
Saved Messages or a Saved Messages topic have changed
- UpdateSavedMessagesTopic - Basic
information about a Saved Messages topic has changed. This update is guaranteed to come before the topic identifier is returned to the
application
- UpdateSavedMessagesTopicCount -
Number of Saved Messages topics has changed
- UpdateSavedNotificationSounds - The
list of saved notification sounds was updated. This update may not be sent until information about a notification sound was requested
for the first time
- UpdateScopeNotificationSettings -
Notification settings for some type of chats were updated
- UpdateSecretChat - Some data of a secret chat
has changed. This update is guaranteed to come before the secret chat identifier is returned to the application
- UpdateServiceNotification - A service
notification from the server was received. Upon receiving this the application must show a popup with the content of the notification
- UpdateSpeechRecognitionTrial - The
parameters of speech recognition without Telegram Premium subscription has changed
- UpdateSpeedLimitNotification -
Download or upload file speed for the user was limited, but it can be restored by subscription to Telegram Premium. The notification can
be postponed until a being downloaded or uploaded file is visible to the user. Use getOption("premium_download_speedup") or
getOption("premium_upload_speedup") to get expected speedup after subscription to Telegram Premium
- UpdateStarRevenueStatus - The Telegram
Star revenue earned by a bot or a chat has changed. If Telegram Star transaction screen of the chat is opened, then
Client.get_star_transactions may be called to fetch new
transactions
- UpdateStickerSet - A sticker set has changed
- UpdateStory - A story was changed
- UpdateStoryDeleted - A story became
inaccessible
- UpdateStoryListChatCount - Number of
chats in a story list has changed
- UpdateStoryPostFailed - A story failed to
post. If the story posting is canceled, then updateStoryDeleted will be received instead of this update
- UpdateStoryPostSucceeded - A story has
been successfully posted
- UpdateStoryStealthMode - Story stealth
mode settings have changed
- UpdateSuggestedActions - The list of
suggested to the user actions has changed
- UpdateSupergroup - Some data of a supergroup or
a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the application
- UpdateSupergroupFullInfo - Some data in
supergroupFullInfo has been changed
- UpdateTermsOfService - New terms of service
must be accepted by the user. If the terms of service are declined, then the
Client.delete_account method must be called with the reason "Decline ToS update"
- UpdateTrendingStickerSets - The list of
trending sticker sets was updated or some of them were viewed
- UpdateUnconfirmedSession - The first
unconfirmed session has changed
- UpdateUnreadChatCount - 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
- UpdateUnreadMessageCount - Number of
unread messages in a chat list has changed. This update is sent only if the message database is used
- UpdateUser - Some data of a user has changed. This
update is guaranteed to come before the user identifier is returned to the application
- UpdateUserFullInfo - Some data in userFullInfo
has been changed
- UpdateUserPrivacySettingRules -
Some privacy setting rules have been changed
- UpdateUserStatus - The user went online or
offline
- UpdateVideoPublished - An automatically
scheduled message with video has been successfully sent after conversion
- UpdateWebAppMessageSent - A message was
sent by an opened Web App, so the Web App needs to be closed
- Updates - Contains a list of updates
- UpgradeBasicGroupChatToSupergroupChat -
Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and
messageChatUpgradeFrom; requires owner privileges. Deactivates the original basic group
- UpgradeGift - Upgrades a regular gift
- UpgradeGiftResult - Contains result of gift
upgrading
- UpgradedGift - Describes an upgraded gift that can
be transferred to another owner or transferred to the TON blockchain as an NFT
- UpgradedGiftAttributeId -
Contains identifier of an upgraded gift attribute to search for
- UpgradedGiftAttributeIdBackdrop -
Identifier of a gift backdrop
- UpgradedGiftAttributeIdModel -
Identifier of a gift model
- UpgradedGiftAttributeIdSymbol -
Identifier of a gift symbol
- UpgradedGiftBackdrop - Describes a backdrop
of an upgraded gift
- UpgradedGiftBackdropColors - Describes
colors of a backdrop of an upgraded gift
- UpgradedGiftBackdropCount - Describes a
backdrop of an upgraded gift
- UpgradedGiftModel - Describes a model of an
upgraded gift
- UpgradedGiftModelCount - Describes a model
of an upgraded gift with the number of gifts found
- UpgradedGiftOriginalDetails -
Describes the original details about the gift
- UpgradedGiftSymbol - Describes a symbol shown
on the pattern of an upgraded gift
- UpgradedGiftSymbolCount - Describes a
symbol shown on the pattern of an upgraded gift
- UploadStickerFile - Uploads a file with a
sticker; returns the uploaded file
- User - Represents a user
- UserFullInfo - Contains full information about a
user
- UserLink - Contains an HTTPS URL, which can be used to
get information about a user
- UserPrivacySetting - Describes
available user privacy settings
- UserPrivacySettingAllowCalls - A
privacy setting for managing whether the user can be called
- UserPrivacySettingAllowChatInvites -
A privacy setting for managing whether the user can be invited to chats
- UserPrivacySettingAllowFindingByPhoneNumber -
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"
- UserPrivacySettingAllowPeerToPeerCalls -
A privacy setting for managing whether peer-to-peer connections can be used for calls
-
UserPrivacySettingAllowPrivateVoiceAndVideoNoteMessages - A privacy setting for managing whether the
user can receive voice and video messages in private chats; for Telegram Premium users only
- UserPrivacySettingAllowUnpaidMessages -
A privacy setting for managing whether the user can receive messages without additional payment
- UserPrivacySettingAutosaveGifts -
A privacy setting for managing whether received gifts are automatically shown on the user's profile page
- UserPrivacySettingRule -
Represents a single rule for managing user privacy settings
- UserPrivacySettingRuleAllowAll - A
rule to allow all users to do something
- UserPrivacySettingRuleAllowBots -
A rule to allow all bots to do something
- UserPrivacySettingRuleAllowChatMembers -
A rule to allow all members of certain specified basic groups and supergroups to doing something
- UserPrivacySettingRuleAllowContacts -
A rule to allow all contacts of the user to do something
- UserPrivacySettingRuleAllowPremiumUsers -
A rule to allow all Premium Users to do something; currently, allowed only for
userPrivacySettingAllowChatInvites
- UserPrivacySettingRuleAllowUsers -
A rule to allow certain specified users to do something
- UserPrivacySettingRuleRestrictAll -
A rule to restrict all users from doing something
- UserPrivacySettingRuleRestrictBots -
A rule to restrict all bots from doing something
- UserPrivacySettingRuleRestrictChatMembers -
A rule to restrict all members of specified basic groups and supergroups from doing something
- UserPrivacySettingRuleRestrictContacts -
A rule to restrict all contacts of the user from doing something
- UserPrivacySettingRuleRestrictUsers -
A rule to restrict all specified users from doing something
- UserPrivacySettingRules - A list of
privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting for a given user. If no rule
matches, the action is not allowed
- UserPrivacySettingShowBio - A privacy
setting for managing whether the user's bio is visible
- UserPrivacySettingShowBirthdate -
A privacy setting for managing whether the user's birthdate is visible
- UserPrivacySettingShowLinkInForwardedMessages -
A privacy setting for managing whether a link to the user's account is included in forwarded messages
- UserPrivacySettingShowPhoneNumber -
A privacy setting for managing whether the user's phone number is visible
- UserPrivacySettingShowProfilePhoto -
A privacy setting for managing whether the user's profile photo is visible
- UserPrivacySettingShowStatus - A
privacy setting for managing whether the user's online status is visible
- UserStatus - Describes the last time the user
was online
- UserStatusEmpty - The user's status has never
been changed
- UserStatusLastMonth - The user is offline,
but was online last month
- UserStatusLastWeek - The user is offline, but
was online last week
- UserStatusOffline - The user is offline
- UserStatusOnline - The user is online
- UserStatusRecently - The user was online
recently
- UserSupportInfo - Contains custom information
about the user
- UserType - Represents the type of user. The
following types are possible: regular users, deleted users and bots
- UserTypeBot - A bot (see
https://core.telegram.org/bots)
- UserTypeDeleted - 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
- UserTypeRegular - A regular user
- UserTypeUnknown - 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
- Usernames - Describes usernames assigned to a user, a
supergroup, or a channel
- Users - Represents a list of users
- ValidateOrderInfo - Validates the order
information provided by a user and returns the available shipping options for a flexible invoice
- ValidatedOrderInfo - Contains a temporary
identifier of validated order information, which is stored for one hour, and the available shipping options
- VectorPathCommand - Represents a
vector path command
- VectorPathCommandCubicBezierCurve -
A cubic Bézier curve to a given point
- VectorPathCommandLine - A straight line to
a given point
- Venue - Describes a venue
- VerificationStatus - Contains information
about verification status of a chat or a user
- Video - Describes a video file
- VideoChat - Describes a video chat, i.e. a group call
bound to a chat
- VideoChatStream - Describes an available stream
in a video chat
- VideoChatStreams - Represents a list of video
chat streams
- VideoNote - Describes a video note. The video must be
equal in width and height, cropped to a circle, and stored in MPEG4 format
- ViewMessages - 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)
- ViewPremiumFeature - Informs TDLib that the
user viewed detailed information about a Premium feature on the Premium features screen
- ViewSponsoredChat - Informs TDLib that the user
fully viewed a sponsored chat
- ViewTrendingStickerSets - Informs the
server that some trending sticker sets have been viewed by the user
- VoiceNote - Describes a voice note
- WebApp - Describes a Web App. Use
Client.get_internal_link with internalLinkTypeWebApp to share the Web
App
- WebAppInfo - Contains information about a Web App
- WebAppOpenMode - Describes mode in which
a Web App is opened
- WebAppOpenModeCompact - The Web App is
opened in the compact mode
- WebAppOpenModeFullScreen - The Web App
is opened in the full-screen mode
- WebAppOpenModeFullSize - The Web App is
opened in the full-size mode
- WebAppOpenParameters - Options to be used
when a Web App is opened
- WebPageInstantView - Describes an instant view
page for a web page
- WriteGeneratedFilePart - 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:
Error domains:
Delegates: