{ "name": "Auto-generated JSON TDLib API", "version": "1.8.68", "commit": "26766da73c9208519e1e1185a117e6e2b453d619", "classes": { "ActiveStoryState": { "description": "Describes state of active stories posted by a chat", "types": [ "activeStoryStateLive", "activeStoryStateUnread", "activeStoryStateRead" ], "functions": [] }, "AffiliateProgramSortOrder": { "description": "Describes the order of the found affiliate programs", "types": [ "affiliateProgramSortOrderProfitability", "affiliateProgramSortOrderCreationDate", "affiliateProgramSortOrderRevenue" ], "functions": [] }, "AffiliateType": { "description": "Describes type of affiliate for an affiliate program", "types": [ "affiliateTypeCurrentUser", "affiliateTypeBot", "affiliateTypeChannel" ], "functions": [] }, "AuctionState": { "description": "Describes state of an auction", "types": [ "auctionStateActive", "auctionStateFinished" ], "functions": [] }, "AuthenticationCodeType": { "description": "Provides information about the method by which an authentication code is delivered to the user", "types": [ "authenticationCodeTypeTelegramMessage", "authenticationCodeTypeSms", "authenticationCodeTypeSmsWord", "authenticationCodeTypeSmsPhrase", "authenticationCodeTypeCall", "authenticationCodeTypeFlashCall", "authenticationCodeTypeMissedCall", "authenticationCodeTypeFragment", "authenticationCodeTypeFirebaseAndroid", "authenticationCodeTypeFirebaseIos" ], "functions": [] }, "AuthorizationState": { "description": "Represents the current authorization state of the TDLib client", "types": [ "authorizationStateWaitTdlibParameters", "authorizationStateWaitPhoneNumber", "authorizationStateWaitPremiumPurchase", "authorizationStateWaitEmailAddress", "authorizationStateWaitEmailCode", "authorizationStateWaitCode", "authorizationStateWaitOtherDeviceConfirmation", "authorizationStateWaitRegistration", "authorizationStateWaitPassword", "authorizationStateReady", "authorizationStateLoggingOut", "authorizationStateClosing", "authorizationStateClosed" ], "functions": [ "getAuthorizationState" ] }, "AutosaveSettingsScope": { "description": "Describes scope of autosave settings", "types": [ "autosaveSettingsScopePrivateChats", "autosaveSettingsScopeGroupChats", "autosaveSettingsScopeChannelChats", "autosaveSettingsScopeChat" ], "functions": [] }, "BackgroundFill": { "description": "Describes a fill of a background", "types": [ "backgroundFillSolid", "backgroundFillGradient", "backgroundFillFreeformGradient" ], "functions": [] }, "BackgroundType": { "description": "Describes the type of background", "types": [ "backgroundTypeWallpaper", "backgroundTypePattern", "backgroundTypeFill", "backgroundTypeChatTheme" ], "functions": [] }, "BlockList": { "description": "Describes type of block list", "types": [ "blockListMain", "blockListStories" ], "functions": [] }, "BotCommandScope": { "description": "Represents the scope to which bot commands are relevant", "types": [ "botCommandScopeDefault", "botCommandScopeAllPrivateChats", "botCommandScopeAllGroupChats", "botCommandScopeAllChatAdministrators", "botCommandScopeChat", "botCommandScopeChatAdministrators", "botCommandScopeChatMember" ], "functions": [] }, "BotWriteAccessAllowReason": { "description": "Describes a reason why a bot was allowed to write messages to the current user", "types": [ "botWriteAccessAllowReasonConnectedWebsite", "botWriteAccessAllowReasonAddedToAttachmentMenu", "botWriteAccessAllowReasonLaunchedWebApp", "botWriteAccessAllowReasonAcceptedRequest" ], "functions": [] }, "BuiltInTheme": { "description": "Describes a built-in theme of an official application", "types": [ "builtInThemeClassic", "builtInThemeDay", "builtInThemeNight", "builtInThemeTinted", "builtInThemeArctic" ], "functions": [] }, "BusinessAwayMessageSchedule": { "description": "Describes conditions for sending of away messages by a Telegram Business account", "types": [ "businessAwayMessageScheduleAlways", "businessAwayMessageScheduleOutsideOfOpeningHours", "businessAwayMessageScheduleCustom" ], "functions": [] }, "BusinessFeature": { "description": "Describes a feature available to Business user accounts", "types": [ "businessFeatureLocation", "businessFeatureOpeningHours", "businessFeatureQuickReplies", "businessFeatureGreetingMessage", "businessFeatureAwayMessage", "businessFeatureAccountLinks", "businessFeatureStartPage", "businessFeatureBots", "businessFeatureEmojiStatus", "businessFeatureChatFolderTags", "businessFeatureUpgradedStories" ], "functions": [] }, "ButtonStyle": { "description": "Describes style of a button", "types": [ "buttonStyleDefault", "buttonStylePrimary", "buttonStyleDanger", "buttonStyleSuccess", "buttonStyleLink" ], "functions": [] }, "CallDiscardReason": { "description": "Describes the reason why a call was discarded", "types": [ "callDiscardReasonEmpty", "callDiscardReasonMissed", "callDiscardReasonDeclined", "callDiscardReasonDisconnected", "callDiscardReasonHungUp", "callDiscardReasonUpgradeToGroupCall" ], "functions": [] }, "CallProblem": { "description": "Describes the exact type of problem with a call", "types": [ "callProblemEcho", "callProblemNoise", "callProblemInterruptions", "callProblemDistortedSpeech", "callProblemSilentLocal", "callProblemSilentRemote", "callProblemDropped", "callProblemDistortedVideo", "callProblemPixelatedVideo" ], "functions": [] }, "CallServerType": { "description": "Describes the type of call server", "types": [ "callServerTypeTelegramReflector", "callServerTypeWebrtc" ], "functions": [] }, "CallState": { "description": "Describes the current call state", "types": [ "callStatePending", "callStateExchangingKeys", "callStateReady", "callStateHangingUp", "callStateDiscarded", "callStateError" ], "functions": [] }, "CallbackQueryPayload": { "description": "Represents a payload of a callback query", "types": [ "callbackQueryPayloadData", "callbackQueryPayloadDataWithPassword", "callbackQueryPayloadGame" ], "functions": [] }, "CanPostStoryResult": { "description": "Represents result of checking whether the current user can post a story on behalf of the specific chat", "types": [ "canPostStoryResultOk", "canPostStoryResultPremiumNeeded", "canPostStoryResultBoostNeeded", "canPostStoryResultActiveStoryLimitExceeded", "canPostStoryResultWeeklyLimitExceeded", "canPostStoryResultMonthlyLimitExceeded", "canPostStoryResultLiveStoryIsActive" ], "functions": [ "canPostStory" ] }, "CanSendGiftResult": { "description": "Describes whether a gift can be sent now by the current user", "types": [ "canSendGiftResultOk", "canSendGiftResultFail" ], "functions": [ "canSendGift" ] }, "CanSendMessageToUserResult": { "description": "Describes result of canSendMessageToUser", "types": [ "canSendMessageToUserResultOk", "canSendMessageToUserResultUserHasPaidMessages", "canSendMessageToUserResultUserIsDeleted", "canSendMessageToUserResultUserRestrictsNewChats" ], "functions": [ "canSendMessageToUser" ] }, "CanTransferOwnershipResult": { "description": "Represents result of checking whether the current session can be used to transfer a chat ownership to another user", "types": [ "canTransferOwnershipResultOk", "canTransferOwnershipResultPasswordNeeded", "canTransferOwnershipResultPasswordTooFresh", "canTransferOwnershipResultSessionTooFresh" ], "functions": [ "canTransferOwnership" ] }, "ChatAction": { "description": "Describes the different types of activity in a chat", "types": [ "chatActionTyping", "chatActionRecordingVideo", "chatActionUploadingVideo", "chatActionRecordingVoiceNote", "chatActionUploadingVoiceNote", "chatActionUploadingPhoto", "chatActionUploadingDocument", "chatActionChoosingSticker", "chatActionChoosingLocation", "chatActionChoosingContact", "chatActionStartPlayingGame", "chatActionRecordingVideoNote", "chatActionUploadingVideoNote", "chatActionWatchingAnimations", "chatActionCancel" ], "functions": [] }, "ChatActionBar": { "description": "Describes actions which must be possible to do through a chat action bar", "types": [ "chatActionBarReportSpam", "chatActionBarInviteMembers", "chatActionBarReportAddBlock", "chatActionBarAddContact", "chatActionBarSharePhoneNumber", "chatActionBarJoinRequest" ], "functions": [] }, "ChatAvailableReactions": { "description": "Describes reactions available in the chat", "types": [ "chatAvailableReactionsAll", "chatAvailableReactionsSome" ], "functions": [] }, "ChatBoostSource": { "description": "Describes source of a chat boost", "types": [ "chatBoostSourceGiftCode", "chatBoostSourceGiveaway", "chatBoostSourcePremium" ], "functions": [] }, "ChatEventAction": { "description": "Represents a chat event", "types": [ "chatEventMessageEdited", "chatEventMessageDeleted", "chatEventMessagePinned", "chatEventMessageUnpinned", "chatEventPollStopped", "chatEventMemberJoined", "chatEventMemberJoinedByInviteLink", "chatEventMemberJoinedByRequest", "chatEventMemberInvited", "chatEventMemberLeft", "chatEventMemberPromoted", "chatEventMemberRestricted", "chatEventMemberTagChanged", "chatEventMemberSubscriptionExtended", "chatEventAvailableReactionsChanged", "chatEventBackgroundChanged", "chatEventDescriptionChanged", "chatEventEmojiStatusChanged", "chatEventLinkedChatChanged", "chatEventLocationChanged", "chatEventMessageAutoDeleteTimeChanged", "chatEventPermissionsChanged", "chatEventPhotoChanged", "chatEventSlowModeDelayChanged", "chatEventStickerSetChanged", "chatEventCustomEmojiStickerSetChanged", "chatEventTitleChanged", "chatEventUsernameChanged", "chatEventActiveUsernamesChanged", "chatEventAccentColorChanged", "chatEventProfileAccentColorChanged", "chatEventHasProtectedContentToggled", "chatEventInvitesToggled", "chatEventIsAllHistoryAvailableToggled", "chatEventHasAggressiveAntiSpamEnabledToggled", "chatEventSignMessagesToggled", "chatEventShowMessageSenderToggled", "chatEventAutomaticTranslationToggled", "chatEventInviteLinkEdited", "chatEventInviteLinkRevoked", "chatEventInviteLinkDeleted", "chatEventVideoChatCreated", "chatEventVideoChatEnded", "chatEventVideoChatMuteNewParticipantsToggled", "chatEventVideoChatParticipantIsMutedToggled", "chatEventVideoChatParticipantVolumeLevelChanged", "chatEventIsForumToggled", "chatEventForumTopicCreated", "chatEventForumTopicEdited", "chatEventForumTopicToggleIsClosed", "chatEventForumTopicToggleIsHidden", "chatEventForumTopicDeleted", "chatEventForumTopicPinned" ], "functions": [] }, "ChatJoinRequestResult": { "description": "Describes result of a chat join request", "types": [ "chatJoinRequestResultApproved", "chatJoinRequestResultDeclined", "chatJoinRequestResultQueued" ], "functions": [] }, "ChatJoinResult": { "description": "Describes result of join of a chat by the current user", "types": [ "chatJoinResultSuccess", "chatJoinResultRequestSent", "chatJoinResultGuardBotApprovalRequired", "chatJoinResultDeclined" ], "functions": [ "joinChat", "joinChatByInviteLink" ] }, "ChatList": { "description": "Describes a list of chats", "types": [ "chatListMain", "chatListArchive", "chatListFolder" ], "functions": [] }, "ChatMemberStatus": { "description": "Provides information about the status of a member in a chat", "types": [ "chatMemberStatusCreator", "chatMemberStatusAdministrator", "chatMemberStatusMember", "chatMemberStatusRestricted", "chatMemberStatusLeft", "chatMemberStatusBanned" ], "functions": [] }, "ChatMembersFilter": { "description": "Specifies the kind of chat members to return in searchChatMembers", "types": [ "chatMembersFilterContacts", "chatMembersFilterAdministrators", "chatMembersFilterMembers", "chatMembersFilterMention", "chatMembersFilterRestricted", "chatMembersFilterBanned", "chatMembersFilterBots" ], "functions": [] }, "ChatPhotoStickerType": { "description": "Describes type of sticker, which was used to create a chat photo", "types": [ "chatPhotoStickerTypeRegularOrMask", "chatPhotoStickerTypeCustomEmoji" ], "functions": [] }, "ChatRevenueTransactionType": { "description": "Describes type of transaction for revenue earned from sponsored messages in a chat", "types": [ "chatRevenueTransactionTypeUnsupported", "chatRevenueTransactionTypeSponsoredMessageEarnings", "chatRevenueTransactionTypeSuggestedPostEarnings", "chatRevenueTransactionTypeFragmentWithdrawal", "chatRevenueTransactionTypeFragmentRefund" ], "functions": [] }, "ChatSource": { "description": "Describes a reason why an external chat is shown in a chat list", "types": [ "chatSourceMtprotoProxy", "chatSourcePublicServiceAnnouncement" ], "functions": [] }, "ChatStatistics": { "description": "Contains a detailed statistics about a chat", "types": [ "chatStatisticsSupergroup", "chatStatisticsChannel" ], "functions": [ "getChatStatistics" ] }, "ChatStatisticsObjectType": { "description": "Describes type of object, for which statistics are provided", "types": [ "chatStatisticsObjectTypeMessage", "chatStatisticsObjectTypeStory" ], "functions": [] }, "ChatTheme": { "description": "Describes a chat theme", "types": [ "chatThemeEmoji", "chatThemeGift" ], "functions": [] }, "ChatType": { "description": "Describes the type of chat", "types": [ "chatTypePrivate", "chatTypeBasicGroup", "chatTypeSupergroup", "chatTypeSecret" ], "functions": [] }, "CheckChatUsernameResult": { "description": "Represents result of checking whether a username can be set for a chat", "types": [ "checkChatUsernameResultOk", "checkChatUsernameResultUsernameInvalid", "checkChatUsernameResultUsernameOccupied", "checkChatUsernameResultUsernamePurchasable", "checkChatUsernameResultPublicChatsTooMany", "checkChatUsernameResultPublicGroupsUnavailable" ], "functions": [ "checkChatUsername", "checkBotUsername" ] }, "CheckStickerSetNameResult": { "description": "Represents result of checking whether a name can be used for a new sticker set", "types": [ "checkStickerSetNameResultOk", "checkStickerSetNameResultNameInvalid", "checkStickerSetNameResultNameOccupied" ], "functions": [ "checkStickerSetName" ] }, "CollectibleItemType": { "description": "Describes a collectible item that can be purchased at https://fragment.com", "types": [ "collectibleItemTypeUsername", "collectibleItemTypePhoneNumber" ], "functions": [] }, "CommunityMemberStatus": { "description": "Provides information about the status of a member in a community", "types": [ "communityMemberStatusCreator", "communityMemberStatusAdministrator", "communityMemberStatusMember", "communityMemberStatusLeft", "communityMemberStatusBanned" ], "functions": [] }, "ConnectionState": { "description": "Describes the current state of the connection to Telegram servers", "types": [ "connectionStateWaitingForNetwork", "connectionStateConnectingToProxy", "connectionStateConnecting", "connectionStateUpdating", "connectionStateReady" ], "functions": [] }, "CraftGiftResult": { "description": "Contains result of gift crafting", "types": [ "craftGiftResultSuccess", "craftGiftResultTooEarly", "craftGiftResultInvalidGift", "craftGiftResultFail" ], "functions": [ "craftGift" ] }, "DateTimeFormattingType": { "description": "Describes date and time formatting", "types": [ "dateTimeFormattingTypeRelative", "dateTimeFormattingTypeAbsolute" ], "functions": [] }, "DateTimePartPrecision": { "description": "Describes precision with which to show a date or a time", "types": [ "dateTimePartPrecisionNone", "dateTimePartPrecisionShort", "dateTimePartPrecisionLong" ], "functions": [] }, "DeviceToken": { "description": "Represents a data needed to subscribe for push notifications through registerDevice method.", "types": [ "deviceTokenFirebaseCloudMessaging", "deviceTokenApplePush", "deviceTokenApplePushVoIP", "deviceTokenWindowsPush", "deviceTokenMicrosoftPush", "deviceTokenMicrosoftPushVoIP", "deviceTokenWebPush", "deviceTokenSimplePush", "deviceTokenUbuntuPush", "deviceTokenBlackBerryPush", "deviceTokenTizenPush", "deviceTokenHuaweiPush" ], "functions": [] }, "DiceStickers": { "description": "Contains animated stickers which must be used for dice animation rendering", "types": [ "diceStickersRegular", "diceStickersSlotMachine" ], "functions": [] }, "DiffEntityType": { "description": "Represents a change of a text", "types": [ "diffEntityTypeInsert", "diffEntityTypeReplace", "diffEntityTypeDelete" ], "functions": [] }, "DraftMessageContent": { "description": "Content of the message draft", "types": [ "draftMessageContentText", "draftMessageContentRichMessage", "draftMessageContentInputRichMessage", "draftMessageContentVideoNote", "draftMessageContentVoiceNote" ], "functions": [] }, "EmailAddressAuthentication": { "description": "Contains authentication data for an email address", "types": [ "emailAddressAuthenticationCode", "emailAddressAuthenticationAppleId", "emailAddressAuthenticationGoogleId" ], "functions": [] }, "EmailAddressResetState": { "description": "Describes reset state of an email address", "types": [ "emailAddressResetStateAvailable", "emailAddressResetStatePending" ], "functions": [] }, "EmojiCategorySource": { "description": "Describes source of stickers for an emoji category", "types": [ "emojiCategorySourceSearch", "emojiCategorySourcePremium" ], "functions": [] }, "EmojiCategoryType": { "description": "Describes type of emoji category", "types": [ "emojiCategoryTypeDefault", "emojiCategoryTypeRegularStickers", "emojiCategoryTypeEmojiStatus", "emojiCategoryTypeChatPhoto" ], "functions": [] }, "EmojiStatusType": { "description": "Describes type of emoji status", "types": [ "emojiStatusTypeCustomEmoji", "emojiStatusTypeUpgradedGift" ], "functions": [] }, "FileType": { "description": "Represents the type of file", "types": [ "fileTypeNone", "fileTypeAnimation", "fileTypeAudio", "fileTypeDocument", "fileTypeLivePhotoVideo", "fileTypeNotificationSound", "fileTypePhoto", "fileTypePhotoStory", "fileTypeProfilePhoto", "fileTypeSecret", "fileTypeSecretThumbnail", "fileTypeSecure", "fileTypeSelfDestructingLivePhotoVideo", "fileTypeSelfDestructingPhoto", "fileTypeSelfDestructingVideo", "fileTypeSelfDestructingVideoNote", "fileTypeSelfDestructingVoiceNote", "fileTypeSticker", "fileTypeThumbnail", "fileTypeUnknown", "fileTypeVideo", "fileTypeVideoNote", "fileTypeVideoStory", "fileTypeVoiceNote", "fileTypeWallpaper" ], "functions": [] }, "FirebaseAuthenticationSettings": { "description": "Contains settings for Firebase Authentication in the official applications", "types": [ "firebaseAuthenticationSettingsAndroid", "firebaseAuthenticationSettingsIos" ], "functions": [] }, "FirebaseDeviceVerificationParameters": { "description": "Describes parameters to be used for device verification", "types": [ "firebaseDeviceVerificationParametersSafetyNet", "firebaseDeviceVerificationParametersPlayIntegrity" ], "functions": [] }, "GiftForResaleOrder": { "description": "Describes order in which upgraded gifts for resale will be sorted", "types": [ "giftForResaleOrderPrice", "giftForResaleOrderPriceChangeDate", "giftForResaleOrderNumber" ], "functions": [] }, "GiftPurchaseOfferState": { "description": "Describes state of a gift purchase offer", "types": [ "giftPurchaseOfferStatePending", "giftPurchaseOfferStateAccepted", "giftPurchaseOfferStateRejected" ], "functions": [] }, "GiftResalePrice": { "description": "Describes price of a resold gift", "types": [ "giftResalePriceStar", "giftResalePriceGram" ], "functions": [] }, "GiftResaleResult": { "description": "Describes result of sending a resold gift", "types": [ "giftResaleResultOk", "giftResaleResultPriceIncreased" ], "functions": [ "sendResoldGift" ] }, "GiveawayInfo": { "description": "Contains information about a giveaway", "types": [ "giveawayInfoOngoing", "giveawayInfoCompleted" ], "functions": [ "getGiveawayInfo" ] }, "GiveawayParticipantStatus": { "description": "Contains information about status of a user in a giveaway", "types": [ "giveawayParticipantStatusEligible", "giveawayParticipantStatusParticipating", "giveawayParticipantStatusAlreadyWasMember", "giveawayParticipantStatusAdministrator", "giveawayParticipantStatusDisallowedCountry" ], "functions": [] }, "GiveawayPrize": { "description": "Contains information about a giveaway prize", "types": [ "giveawayPrizePremium", "giveawayPrizeStars" ], "functions": [] }, "GroupCallDataChannel": { "description": "Describes data channel for a group call", "types": [ "groupCallDataChannelMain", "groupCallDataChannelScreenSharing" ], "functions": [] }, "GroupCallVideoQuality": { "description": "Describes the quality of a group call video", "types": [ "groupCallVideoQualityThumbnail", "groupCallVideoQualityMedium", "groupCallVideoQualityFull" ], "functions": [] }, "InlineKeyboardButtonType": { "description": "Describes the type of inline keyboard button", "types": [ "inlineKeyboardButtonTypeUrl", "inlineKeyboardButtonTypeLoginUrl", "inlineKeyboardButtonTypeWebApp", "inlineKeyboardButtonTypeCallback", "inlineKeyboardButtonTypeCallbackWithPassword", "inlineKeyboardButtonTypeCallbackGame", "inlineKeyboardButtonTypeSwitchInline", "inlineKeyboardButtonTypeBuy", "inlineKeyboardButtonTypeUser", "inlineKeyboardButtonTypeCopyText", "inlineKeyboardButtonTypeDisabled" ], "functions": [] }, "InlineQueryResult": { "description": "Represents a single result of an inline query", "types": [ "inlineQueryResultArticle", "inlineQueryResultContact", "inlineQueryResultLocation", "inlineQueryResultVenue", "inlineQueryResultGame", "inlineQueryResultAnimation", "inlineQueryResultAudio", "inlineQueryResultDocument", "inlineQueryResultPhoto", "inlineQueryResultSticker", "inlineQueryResultVideo", "inlineQueryResultVoiceNote" ], "functions": [] }, "InlineQueryResultsButtonType": { "description": "Represents type of button in results of inline query", "types": [ "inlineQueryResultsButtonTypeStartBot", "inlineQueryResultsButtonTypeWebApp" ], "functions": [] }, "InputBackground": { "description": "Contains information about background to set", "types": [ "inputBackgroundLocal", "inputBackgroundRemote", "inputBackgroundPrevious" ], "functions": [] }, "InputCall": { "description": "Describes a call", "types": [ "inputCallDiscarded", "inputCallFromMessage" ], "functions": [] }, "InputChatPhoto": { "description": "Describes a photo to be set as a user profile or chat photo", "types": [ "inputChatPhotoPrevious", "inputChatPhotoStatic", "inputChatPhotoAnimation", "inputChatPhotoSticker" ], "functions": [] }, "InputChatTheme": { "description": "Describes a chat theme to set", "types": [ "inputChatThemeEmoji", "inputChatThemeGift" ], "functions": [] }, "InputCredentials": { "description": "Contains information about the payment method chosen by the user", "types": [ "inputCredentialsSaved", "inputCredentialsNew", "inputCredentialsApplePay", "inputCredentialsGooglePay" ], "functions": [] }, "InputFile": { "description": "Points to a file", "types": [ "inputFileId", "inputFileRemote", "inputFileLocal", "inputFileGenerated" ], "functions": [] }, "InputGroupCall": { "description": "Describes a non-joined group call that isn't bound to a chat", "types": [ "inputGroupCallLink", "inputGroupCallMessage" ], "functions": [] }, "InputInlineQueryResult": { "description": "Represents a single result of an inline query; for bots only", "types": [ "inputInlineQueryResultAnimation", "inputInlineQueryResultArticle", "inputInlineQueryResultAudio", "inputInlineQueryResultContact", "inputInlineQueryResultDocument", "inputInlineQueryResultGame", "inputInlineQueryResultLocation", "inputInlineQueryResultPhoto", "inputInlineQueryResultSticker", "inputInlineQueryResultVenue", "inputInlineQueryResultVideo", "inputInlineQueryResultVoiceNote" ], "functions": [] }, "InputInvoice": { "description": "Describes an invoice to process", "types": [ "inputInvoiceMessage", "inputInvoiceName", "inputInvoiceTelegram" ], "functions": [] }, "InputMessageContent": { "description": "The content of a message to send", "types": [ "inputMessageText", "inputMessageRichMessage", "inputMessageAnimation", "inputMessageAudio", "inputMessageDocument", "inputMessagePaidMedia", "inputMessagePhoto", "inputMessageSticker", "inputMessageVideo", "inputMessageVideoNote", "inputMessageVoiceNote", "inputMessageLiveLocation", "inputMessageLocation", "inputMessageVenue", "inputMessageContact", "inputMessageDice", "inputMessageGame", "inputMessageInvoice", "inputMessagePoll", "inputMessageStakeDice", "inputMessageStory", "inputMessageChecklist", "inputMessageForwarded" ], "functions": [] }, "InputMessageReplyTo": { "description": "Contains information about the message or the story to be replied", "types": [ "inputMessageReplyToMessage", "inputMessageReplyToExternalMessage", "inputMessageReplyToStory", "inputMessageReplyToEphemeralMessage" ], "functions": [] }, "InputPageBlock": { "description": "Describes a block of a rich message to send", "types": [ "inputPageBlockSectionHeading", "inputPageBlockParagraph", "inputPageBlockPreformatted", "inputPageBlockFooter", "inputPageBlockThinking", "inputPageBlockDivider", "inputPageBlockMathematicalExpression", "inputPageBlockAnchor", "inputPageBlockList", "inputPageBlockBlockQuote", "inputPageBlockExpandableBlockQuote", "inputPageBlockPullQuote", "inputPageBlockAnimation", "inputPageBlockAudio", "inputPageBlockDocument", "inputPageBlockPhoto", "inputPageBlockVideo", "inputPageBlockVoiceNote", "inputPageBlockCollage", "inputPageBlockSlideshow", "inputPageBlockTable", "inputPageBlockDetails", "inputPageBlockMap", "inputPageBlockButtonRow" ], "functions": [] }, "InputPaidMediaType": { "description": "Describes type of paid media to send", "types": [ "inputPaidMediaTypePhoto", "inputPaidMediaTypeVideo" ], "functions": [] }, "InputPassportElement": { "description": "Contains information about a Telegram Passport element to be saved", "types": [ "inputPassportElementPersonalDetails", "inputPassportElementPassport", "inputPassportElementDriverLicense", "inputPassportElementIdentityCard", "inputPassportElementInternalPassport", "inputPassportElementAddress", "inputPassportElementUtilityBill", "inputPassportElementBankStatement", "inputPassportElementRentalAgreement", "inputPassportElementPassportRegistration", "inputPassportElementTemporaryRegistration", "inputPassportElementPhoneNumber", "inputPassportElementEmailAddress" ], "functions": [] }, "InputPassportElementErrorSource": { "description": "Contains the description of an error in a Telegram Passport element; for bots only", "types": [ "inputPassportElementErrorSourceUnspecified", "inputPassportElementErrorSourceDataField", "inputPassportElementErrorSourceFrontSide", "inputPassportElementErrorSourceReverseSide", "inputPassportElementErrorSourceSelfie", "inputPassportElementErrorSourceTranslationFile", "inputPassportElementErrorSourceTranslationFiles", "inputPassportElementErrorSourceFile", "inputPassportElementErrorSourceFiles" ], "functions": [] }, "InputPollMedia": { "description": "The content of a poll media to send", "types": [ "inputPollMediaAnimation", "inputPollMediaAudio", "inputPollMediaDocument", "inputPollMediaLink", "inputPollMediaLocation", "inputPollMediaPhoto", "inputPollMediaSticker", "inputPollMediaVenue", "inputPollMediaVideo" ], "functions": [] }, "InputPollType": { "description": "Describes the type of poll to send", "types": [ "inputPollTypeRegular", "inputPollTypeQuiz" ], "functions": [] }, "InputStoryAreaType": { "description": "Describes type of clickable area on a story media to be added", "types": [ "inputStoryAreaTypeLocation", "inputStoryAreaTypeFoundVenue", "inputStoryAreaTypePreviousVenue", "inputStoryAreaTypeSuggestedReaction", "inputStoryAreaTypeMessage", "inputStoryAreaTypeLink", "inputStoryAreaTypeWeather", "inputStoryAreaTypeUpgradedGift" ], "functions": [] }, "InputStoryContent": { "description": "The content of a story to post", "types": [ "inputStoryContentPhoto", "inputStoryContentVideo" ], "functions": [] }, "InternalLinkType": { "description": "Describes an internal https://t.me or tg: link, which must be processed by the application in a special way", "types": [ "internalLinkTypeAttachmentMenuBot", "internalLinkTypeAuthenticationCode", "internalLinkTypeBackground", "internalLinkTypeBotAddToChannel", "internalLinkTypeBotStart", "internalLinkTypeBotStartInGroup", "internalLinkTypeBusinessChat", "internalLinkTypeCallsPage", "internalLinkTypeChatAffiliateProgram", "internalLinkTypeChatBoost", "internalLinkTypeChatFolderInvite", "internalLinkTypeChatInvite", "internalLinkTypeChatSelection", "internalLinkTypeContactsPage", "internalLinkTypeDirectMessagesChat", "internalLinkTypeGame", "internalLinkTypeGiftAuction", "internalLinkTypeGiftCollection", "internalLinkTypeGroupCall", "internalLinkTypeInstantView", "internalLinkTypeInvoice", "internalLinkTypeLanguagePack", "internalLinkTypeLiveStory", "internalLinkTypeMainWebApp", "internalLinkTypeMessage", "internalLinkTypeMessageDraft", "internalLinkTypeMyProfilePage", "internalLinkTypeNewChannelChat", "internalLinkTypeNewGroupChat", "internalLinkTypeNewPrivateChat", "internalLinkTypeNewStory", "internalLinkTypeOauth", "internalLinkTypePassportDataRequest", "internalLinkTypePhoneNumberConfirmation", "internalLinkTypePremiumFeaturesPage", "internalLinkTypePremiumGiftCode", "internalLinkTypePremiumGiftPurchase", "internalLinkTypeProxy", "internalLinkTypePublicChat", "internalLinkTypeQrCodeAuthentication", "internalLinkTypeRequestManagedBot", "internalLinkTypeRestorePurchases", "internalLinkTypeSavedMessages", "internalLinkTypeSearch", "internalLinkTypeSettings", "internalLinkTypeStarPurchase", "internalLinkTypeStickerSet", "internalLinkTypeStory", "internalLinkTypeStoryAlbum", "internalLinkTypeTextCompositionStyle", "internalLinkTypeTheme", "internalLinkTypeTonConnect", "internalLinkTypeTonWalletTransfer", "internalLinkTypeUnknownDeepLink", "internalLinkTypeUpgradedGift", "internalLinkTypeUserPhoneNumber", "internalLinkTypeUserToken", "internalLinkTypeVideoChat", "internalLinkTypeWebApp" ], "functions": [ "getInternalLinkType" ] }, "InviteGroupCallParticipantResult": { "description": "Describes result of group call participant invitation", "types": [ "inviteGroupCallParticipantResultUserPrivacyRestricted", "inviteGroupCallParticipantResultUserAlreadyParticipant", "inviteGroupCallParticipantResultUserWasBanned", "inviteGroupCallParticipantResultSuccess" ], "functions": [ "inviteGroupCallParticipant" ] }, "InviteLinkChatType": { "description": "Describes the type of chat to which points an invite link", "types": [ "inviteLinkChatTypeBasicGroup", "inviteLinkChatTypeSupergroup", "inviteLinkChatTypeChannel" ], "functions": [] }, "JsonValue": { "description": "Represents a JSON value", "types": [ "jsonValueNull", "jsonValueBoolean", "jsonValueNumber", "jsonValueString", "jsonValueArray", "jsonValueObject" ], "functions": [ "getJsonValue", "getApplicationConfig" ] }, "KeyboardButtonSource": { "description": "Describes source of a keyboard button", "types": [ "keyboardButtonSourceMessage", "keyboardButtonSourceWebApp" ], "functions": [] }, "KeyboardButtonType": { "description": "Describes a keyboard button type", "types": [ "keyboardButtonTypeText", "keyboardButtonTypeRequestPhoneNumber", "keyboardButtonTypeRequestLocation", "keyboardButtonTypeRequestPoll", "keyboardButtonTypeRequestUsers", "keyboardButtonTypeRequestChat", "keyboardButtonTypeRequestManagedBot", "keyboardButtonTypeWebApp" ], "functions": [] }, "LanguagePackStringValue": { "description": "Represents the value of a string in a language pack", "types": [ "languagePackStringValueOrdinary", "languagePackStringValuePluralized", "languagePackStringValueDeleted" ], "functions": [ "getLanguagePackString" ] }, "LinkPreviewAlbumMedia": { "description": "Describes a media from a link preview album", "types": [ "linkPreviewAlbumMediaPhoto", "linkPreviewAlbumMediaVideo" ], "functions": [] }, "LinkPreviewType": { "description": "Describes type of link preview", "types": [ "linkPreviewTypeAlbum", "linkPreviewTypeAnimation", "linkPreviewTypeApp", "linkPreviewTypeArticle", "linkPreviewTypeAudio", "linkPreviewTypeBackground", "linkPreviewTypeChannelBoost", "linkPreviewTypeChat", "linkPreviewTypeDirectMessagesChat", "linkPreviewTypeDocument", "linkPreviewTypeEmbeddedAnimationPlayer", "linkPreviewTypeEmbeddedAudioPlayer", "linkPreviewTypeEmbeddedVideoPlayer", "linkPreviewTypeExternalAudio", "linkPreviewTypeExternalVideo", "linkPreviewTypeGiftAuction", "linkPreviewTypeGiftCollection", "linkPreviewTypeGroupCall", "linkPreviewTypeInvoice", "linkPreviewTypeLiveStory", "linkPreviewTypeMessage", "linkPreviewTypePhoto", "linkPreviewTypePremiumGiftCode", "linkPreviewTypeRequestManagedBot", "linkPreviewTypeShareableChatFolder", "linkPreviewTypeSticker", "linkPreviewTypeStickerSet", "linkPreviewTypeStory", "linkPreviewTypeStoryAlbum", "linkPreviewTypeSupergroupBoost", "linkPreviewTypeTextCompositionStyle", "linkPreviewTypeTheme", "linkPreviewTypeUnsupported", "linkPreviewTypeUpgradedGift", "linkPreviewTypeUser", "linkPreviewTypeVideo", "linkPreviewTypeVideoChat", "linkPreviewTypeVideoNote", "linkPreviewTypeVoiceNote", "linkPreviewTypeWebApp" ], "functions": [] }, "LogStream": { "description": "Describes a stream to which TDLib internal log is written", "types": [ "logStreamDefault", "logStreamFile", "logStreamEmpty" ], "functions": [ "getLogStream" ] }, "LoginUrlInfo": { "description": "Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl or an external link", "types": [ "loginUrlInfoOpen", "loginUrlInfoRequestConfirmation" ], "functions": [ "getLoginUrlInfo", "getExternalLinkInfo" ] }, "MaskPoint": { "description": "Part of the face, relative to which a mask is placed", "types": [ "maskPointForehead", "maskPointEyes", "maskPointMouth", "maskPointChin" ], "functions": [] }, "MessageContent": { "description": "Contains the content of a message", "types": [ "messageText", "messageRichMessage", "messageAnimation", "messageAudio", "messageDocument", "messagePaidMedia", "messagePhoto", "messageSticker", "messageVideo", "messageVideoNote", "messageVoiceNote", "messageExpiredPhoto", "messageExpiredVideo", "messageExpiredVideoNote", "messageExpiredVoiceNote", "messageLiveLocation", "messageLocation", "messageVenue", "messageContact", "messageAnimatedEmoji", "messageDice", "messageGame", "messagePoll", "messageStakeDice", "messageStory", "messageChecklist", "messageInvoice", "messageCall", "messageGroupCall", "messageVideoChatScheduled", "messageVideoChatStarted", "messageVideoChatEnded", "messageInviteVideoChatParticipants", "messagePollOptionAdded", "messagePollOptionDeleted", "messageBasicGroupChatCreate", "messageSupergroupChatCreate", "messageChatChangeTitle", "messageChatChangePhoto", "messageChatDeletePhoto", "messageChatOwnerLeft", "messageChatOwnerChanged", "messageChatHasProtectedContentToggled", "messageChatHasProtectedContentDisableRequested", "messageChatAddMembers", "messageChatJoinByLink", "messageChatJoinByRequest", "messageChatJoinFromCommunity", "messageChatDeleteMember", "messageChatAddedToCommunity", "messageChatRemovedFromCommunity", "messageChatUpgradeTo", "messageChatUpgradeFrom", "messagePinMessage", "messageScreenshotTaken", "messageChatSetBackground", "messageChatSetTheme", "messageChatSetMessageAutoDeleteTime", "messageChatBoost", "messageForumTopicCreated", "messageForumTopicEdited", "messageForumTopicIsClosedToggled", "messageForumTopicIsHiddenToggled", "messageSuggestProfilePhoto", "messageSuggestBirthdate", "messageCustomServiceAction", "messageGameScore", "messageManagedBotCreated", "messagePaymentSuccessful", "messagePaymentSuccessfulBot", "messagePaymentRefunded", "messageGiftedPremium", "messagePremiumGiftCode", "messageGiveawayCreated", "messageGiveaway", "messageGiveawayCompleted", "messageGiveawayWinners", "messageGiftedStars", "messageGiftedGrams", "messageGiveawayPrizeStars", "messageTonWalletTransfer", "messageTonConnectRequest", "messageGift", "messageUpgradedGift", "messageRefundedUpgradedGift", "messageUpgradedGiftPurchaseOffer", "messageUpgradedGiftPurchaseOfferRejected", "messagePaidMessagesRefunded", "messagePaidMessagePriceChanged", "messageDirectMessagePriceChanged", "messageChecklistTasksDone", "messageChecklistTasksAdded", "messageSuggestedPostApprovalFailed", "messageSuggestedPostApproved", "messageSuggestedPostDeclined", "messageSuggestedPostPaid", "messageSuggestedPostRefunded", "messageContactRegistered", "messageUsersShared", "messageChatShared", "messageBotWriteAccessAllowed", "messageWebAppDataSent", "messageWebAppDataReceived", "messagePassportDataSent", "messagePassportDataReceived", "messageProximityAlertTriggered", "messageUnsupported" ], "functions": [] }, "MessageEffectType": { "description": "Describes type of emoji effect", "types": [ "messageEffectTypeEmojiReaction", "messageEffectTypePremiumSticker" ], "functions": [] }, "MessageFileType": { "description": "Contains information about a file with messages exported from another app", "types": [ "messageFileTypePrivate", "messageFileTypeGroup", "messageFileTypeUnknown" ], "functions": [ "getMessageFileType" ] }, "MessageOrigin": { "description": "Contains information about the origin of a message", "types": [ "messageOriginUser", "messageOriginHiddenUser", "messageOriginChat", "messageOriginChannel" ], "functions": [] }, "MessageReadDate": { "description": "Describes read date of a recent outgoing message in a private chat", "types": [ "messageReadDateRead", "messageReadDateUnread", "messageReadDateTooOld", "messageReadDateUserPrivacyRestricted", "messageReadDateMyPrivacyRestricted" ], "functions": [ "getMessageReadDate" ] }, "MessageReplyTo": { "description": "Contains information about the message or the story a message is replying to", "types": [ "messageReplyToMessage", "messageReplyToStory" ], "functions": [] }, "MessageSchedulingState": { "description": "Contains information about the time when a scheduled message will be sent", "types": [ "messageSchedulingStateSendAtDate", "messageSchedulingStateSendWhenOnline", "messageSchedulingStateSendWhenVideoProcessed" ], "functions": [] }, "MessageSelfDestructType": { "description": "Describes when a message will be self-destructed", "types": [ "messageSelfDestructTypeTimer", "messageSelfDestructTypeImmediately" ], "functions": [] }, "MessageSender": { "description": "Contains information about the sender of a message", "types": [ "messageSenderUser", "messageSenderChat" ], "functions": [ "setGroupCallParticipantIsSpeaking" ] }, "MessageSendingState": { "description": "Contains information about the sending state of the message", "types": [ "messageSendingStatePending", "messageSendingStateFailed" ], "functions": [] }, "MessageSource": { "description": "Describes source of a message", "types": [ "messageSourceChatHistory", "messageSourceMessageThreadHistory", "messageSourceForumTopicHistory", "messageSourceDirectMessagesChatTopicHistory", "messageSourceHistoryPreview", "messageSourceChatList", "messageSourceSearch", "messageSourceChatEventLog", "messageSourceNotification", "messageSourceScreenshot", "messageSourceOther" ], "functions": [] }, "MessageTopic": { "description": "Describes a topic of messages in a chat", "types": [ "messageTopicThread", "messageTopicForum", "messageTopicDirectMessages", "messageTopicSavedMessages" ], "functions": [] }, "NetworkStatisticsEntry": { "description": "Contains statistics about network usage", "types": [ "networkStatisticsEntryFile", "networkStatisticsEntryCall" ], "functions": [] }, "NetworkType": { "description": "Represents the type of network", "types": [ "networkTypeNone", "networkTypeMobile", "networkTypeMobileRoaming", "networkTypeWiFi", "networkTypeOther" ], "functions": [] }, "NotificationGroupType": { "description": "Describes the type of notifications in a notification group", "types": [ "notificationGroupTypeMessages", "notificationGroupTypeMentions", "notificationGroupTypeSecretChat", "notificationGroupTypeCalls" ], "functions": [] }, "NotificationSettingsScope": { "description": "Describes the types of chats to which notification settings are relevant", "types": [ "notificationSettingsScopePrivateChats", "notificationSettingsScopeGroupChats", "notificationSettingsScopeChannelChats" ], "functions": [] }, "NotificationType": { "description": "Contains detailed information about a notification", "types": [ "notificationTypeNewMessage", "notificationTypeNewSecretChat", "notificationTypeNewCall", "notificationTypeNewPushMessage" ], "functions": [] }, "OptionValue": { "description": "Represents the value of an option", "types": [ "optionValueBoolean", "optionValueEmpty", "optionValueInteger", "optionValueString" ], "functions": [ "getOption" ] }, "PageBlock": { "description": "Describes a block of an instant view for a web page or a block of a rich message", "types": [ "pageBlockTitle", "pageBlockSubtitle", "pageBlockAuthorDate", "pageBlockHeader", "pageBlockSubheader", "pageBlockSectionHeading", "pageBlockKicker", "pageBlockParagraph", "pageBlockPreformatted", "pageBlockFooter", "pageBlockThinking", "pageBlockDivider", "pageBlockMathematicalExpression", "pageBlockAnchor", "pageBlockList", "pageBlockBlockQuote", "pageBlockExpandableBlockQuote", "pageBlockPullQuote", "pageBlockAnimation", "pageBlockAudio", "pageBlockDocument", "pageBlockPhoto", "pageBlockVideo", "pageBlockVoiceNote", "pageBlockCover", "pageBlockEmbedded", "pageBlockEmbeddedPost", "pageBlockCollage", "pageBlockSlideshow", "pageBlockChatLink", "pageBlockTable", "pageBlockDetails", "pageBlockRelatedArticles", "pageBlockMap", "pageBlockButtonRow", "pageBlockUnsupported" ], "functions": [] }, "PageBlockHorizontalAlignment": { "description": "Describes a horizontal alignment of a table cell content", "types": [ "pageBlockHorizontalAlignmentLeft", "pageBlockHorizontalAlignmentCenter", "pageBlockHorizontalAlignmentRight" ], "functions": [] }, "PageBlockVerticalAlignment": { "description": "Describes a Vertical alignment of a table cell content", "types": [ "pageBlockVerticalAlignmentTop", "pageBlockVerticalAlignmentMiddle", "pageBlockVerticalAlignmentBottom" ], "functions": [] }, "PaidMedia": { "description": "Describes a paid media", "types": [ "paidMediaPreview", "paidMediaPhoto", "paidMediaVideo", "paidMediaUnsupported" ], "functions": [] }, "PaidReactionType": { "description": "Describes type of paid message reaction", "types": [ "paidReactionTypeRegular", "paidReactionTypeAnonymous", "paidReactionTypeChat" ], "functions": [] }, "PassportElement": { "description": "Contains information about a Telegram Passport element", "types": [ "passportElementPersonalDetails", "passportElementPassport", "passportElementDriverLicense", "passportElementIdentityCard", "passportElementInternalPassport", "passportElementAddress", "passportElementUtilityBill", "passportElementBankStatement", "passportElementRentalAgreement", "passportElementPassportRegistration", "passportElementTemporaryRegistration", "passportElementPhoneNumber", "passportElementEmailAddress" ], "functions": [ "getPassportElement", "setPassportElement" ] }, "PassportElementErrorSource": { "description": "Contains the description of an error in a Telegram Passport element", "types": [ "passportElementErrorSourceUnspecified", "passportElementErrorSourceDataField", "passportElementErrorSourceFrontSide", "passportElementErrorSourceReverseSide", "passportElementErrorSourceSelfie", "passportElementErrorSourceTranslationFile", "passportElementErrorSourceTranslationFiles", "passportElementErrorSourceFile", "passportElementErrorSourceFiles" ], "functions": [] }, "PassportElementType": { "description": "Contains the type of Telegram Passport element", "types": [ "passportElementTypePersonalDetails", "passportElementTypePassport", "passportElementTypeDriverLicense", "passportElementTypeIdentityCard", "passportElementTypeInternalPassport", "passportElementTypeAddress", "passportElementTypeUtilityBill", "passportElementTypeBankStatement", "passportElementTypeRentalAgreement", "passportElementTypePassportRegistration", "passportElementTypeTemporaryRegistration", "passportElementTypePhoneNumber", "passportElementTypeEmailAddress" ], "functions": [] }, "PaymentFormType": { "description": "Describes type of payment form", "types": [ "paymentFormTypeRegular", "paymentFormTypeStars", "paymentFormTypeStarSubscription" ], "functions": [] }, "PaymentProvider": { "description": "Contains information about a payment provider", "types": [ "paymentProviderSmartGlocal", "paymentProviderStripe", "paymentProviderOther" ], "functions": [] }, "PaymentReceiptType": { "description": "Describes type of successful payment", "types": [ "paymentReceiptTypeRegular", "paymentReceiptTypeStars" ], "functions": [] }, "PhoneNumberCodeType": { "description": "Describes type of the request for which a code is sent to a phone number", "types": [ "phoneNumberCodeTypeChange", "phoneNumberCodeTypeVerify", "phoneNumberCodeTypeConfirmOwnership" ], "functions": [] }, "PollMedia": { "description": "Contains the media in a poll", "types": [ "pollMediaAnimation", "pollMediaAudio", "pollMediaDocument", "pollMediaLink", "pollMediaLocation", "pollMediaPhoto", "pollMediaSticker", "pollMediaVenue", "pollMediaVideo" ], "functions": [] }, "PollType": { "description": "Describes the type of poll", "types": [ "pollTypeRegular", "pollTypeQuiz" ], "functions": [] }, "PollVoteRestrictionReason": { "description": "Reason of vote restriction in the poll for the current user", "types": [ "pollVoteRestrictionReasonClosed", "pollVoteRestrictionReasonYetUnsent", "pollVoteRestrictionReasonScheduled", "pollVoteRestrictionReasonCountryRestricted", "pollVoteRestrictionReasonMembershipRequired", "pollVoteRestrictionReasonOther" ], "functions": [] }, "PremiumFeature": { "description": "Describes a feature available to Premium users", "types": [ "premiumFeatureIncreasedLimits", "premiumFeatureIncreasedUploadFileSize", "premiumFeatureImprovedDownloadSpeed", "premiumFeatureVoiceRecognition", "premiumFeatureDisabledAds", "premiumFeatureUniqueReactions", "premiumFeatureUniqueStickers", "premiumFeatureCustomEmoji", "premiumFeatureAdvancedChatManagement", "premiumFeatureProfileBadge", "premiumFeatureEmojiStatus", "premiumFeatureAnimatedProfilePhoto", "premiumFeatureForumTopicIcon", "premiumFeatureAppIcons", "premiumFeatureRealTimeChatTranslation", "premiumFeatureUpgradedStories", "premiumFeatureChatBoost", "premiumFeatureAccentColor", "premiumFeatureBackgroundForBoth", "premiumFeatureSavedMessagesTags", "premiumFeatureMessagePrivacy", "premiumFeatureLastSeenTimes", "premiumFeatureBusiness", "premiumFeatureMessageEffects", "premiumFeatureChecklists", "premiumFeaturePaidMessages", "premiumFeatureProtectPrivateChatContent", "premiumFeatureTextComposition", "premiumFeatureRichMessages" ], "functions": [] }, "PremiumLimitType": { "description": "Describes type of limit, increased for Premium users", "types": [ "premiumLimitTypeSupergroupCount", "premiumLimitTypePinnedChatCount", "premiumLimitTypeCreatedPublicChatCount", "premiumLimitTypeSavedAnimationCount", "premiumLimitTypeFavoriteStickerCount", "premiumLimitTypeChatFolderCount", "premiumLimitTypeChatFolderChosenChatCount", "premiumLimitTypePinnedArchivedChatCount", "premiumLimitTypePinnedSavedMessagesTopicCount", "premiumLimitTypeMessageTextLength", "premiumLimitTypeCaptionLength", "premiumLimitTypeBioLength", "premiumLimitTypeChatFolderInviteLinkCount", "premiumLimitTypeShareableChatFolderCount", "premiumLimitTypeActiveStoryCount", "premiumLimitTypeWeeklyPostedStoryCount", "premiumLimitTypeMonthlyPostedStoryCount", "premiumLimitTypeStoryCaptionLength", "premiumLimitTypeStorySuggestedReactionAreaCount", "premiumLimitTypeSimilarChatCount", "premiumLimitTypeOwnedBotCount", "premiumLimitTypeCustomTextCompositionStyleCount" ], "functions": [] }, "PremiumSource": { "description": "Describes a source from which the Premium features screen is opened", "types": [ "premiumSourceLimitExceeded", "premiumSourceFeature", "premiumSourceBusinessFeature", "premiumSourceStoryFeature", "premiumSourceLink", "premiumSourceSettings" ], "functions": [] }, "PremiumStoryFeature": { "description": "Describes a story feature available to Premium users", "types": [ "premiumStoryFeaturePriorityOrder", "premiumStoryFeatureStealthMode", "premiumStoryFeaturePermanentViewsHistory", "premiumStoryFeatureCustomExpirationDuration", "premiumStoryFeatureSaveStories", "premiumStoryFeatureLinksAndFormatting", "premiumStoryFeatureVideoQuality" ], "functions": [] }, "ProfileTab": { "description": "Describes a tab shown in a user or a chat profile", "types": [ "profileTabPosts", "profileTabGifts", "profileTabMedia", "profileTabFiles", "profileTabLinks", "profileTabMusic", "profileTabVoice", "profileTabGifs" ], "functions": [] }, "ProxyType": { "description": "Describes the type of proxy server", "types": [ "proxyTypeSocks5", "proxyTypeHttp", "proxyTypeMtproto" ], "functions": [] }, "PublicChatType": { "description": "Describes type of public chat", "types": [ "publicChatTypeHasUsername", "publicChatTypeIsLocationBased" ], "functions": [] }, "PublicForward": { "description": "Describes a public forward or repost of a story", "types": [ "publicForwardMessage", "publicForwardStory" ], "functions": [] }, "PushMessageContent": { "description": "Contains content of a push message notification", "types": [ "pushMessageContentHidden", "pushMessageContentAnimation", "pushMessageContentAudio", "pushMessageContentContact", "pushMessageContentContactRegistered", "pushMessageContentDocument", "pushMessageContentGame", "pushMessageContentGameScore", "pushMessageContentInvoice", "pushMessageContentLocation", "pushMessageContentPaidMedia", "pushMessageContentPhoto", "pushMessageContentPoll", "pushMessageContentPremiumGiftCode", "pushMessageContentGiveaway", "pushMessageContentTonWalletTransfer", "pushMessageContentTonConnectRequest", "pushMessageContentGift", "pushMessageContentUpgradedGift", "pushMessageContentScreenshotTaken", "pushMessageContentSticker", "pushMessageContentStory", "pushMessageContentText", "pushMessageContentChecklist", "pushMessageContentVideo", "pushMessageContentVideoNote", "pushMessageContentVoiceNote", "pushMessageContentBasicGroupChatCreate", "pushMessageContentVideoChatStarted", "pushMessageContentVideoChatEnded", "pushMessageContentInviteVideoChatParticipants", "pushMessageContentChatAddMembers", "pushMessageContentChatChangePhoto", "pushMessageContentChatChangeTitle", "pushMessageContentChatSetBackground", "pushMessageContentChatSetTheme", "pushMessageContentChatDeleteMember", "pushMessageContentChatJoinByLink", "pushMessageContentChatJoinByRequest", "pushMessageContentRecurringPayment", "pushMessageContentSuggestProfilePhoto", "pushMessageContentSuggestBirthdate", "pushMessageContentProximityAlertTriggered", "pushMessageContentChecklistTasksAdded", "pushMessageContentChecklistTasksDone", "pushMessageContentPollOptionAdded", "pushMessageContentMessageForwards", "pushMessageContentMediaAlbum" ], "functions": [] }, "ReactionNotificationSource": { "description": "Describes sources of reactions for which notifications will be shown", "types": [ "reactionNotificationSourceNone", "reactionNotificationSourceContacts", "reactionNotificationSourceAll" ], "functions": [] }, "ReactionType": { "description": "Describes type of message reaction", "types": [ "reactionTypeEmoji", "reactionTypeCustomEmoji", "reactionTypePaid" ], "functions": [] }, "ReactionUnavailabilityReason": { "description": "Describes why the current user can't add reactions to the message, despite some other users can", "types": [ "reactionUnavailabilityReasonAnonymousAdministrator", "reactionUnavailabilityReasonGuest", "reactionUnavailabilityReasonRestricted" ], "functions": [] }, "ReplyMarkup": { "description": "Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots", "types": [ "replyMarkupRemoveKeyboard", "replyMarkupForceReply", "replyMarkupShowKeyboard", "replyMarkupInlineKeyboard" ], "functions": [] }, "ReportChatResult": { "description": "Describes result of chat report", "types": [ "reportChatResultOk", "reportChatResultOptionRequired", "reportChatResultTextRequired", "reportChatResultMessagesRequired" ], "functions": [ "reportChat" ] }, "ReportReason": { "description": "Describes the reason why a chat is reported", "types": [ "reportReasonSpam", "reportReasonViolence", "reportReasonPornography", "reportReasonChildAbuse", "reportReasonCopyright", "reportReasonUnrelatedLocation", "reportReasonFake", "reportReasonIllegalDrugs", "reportReasonPersonalDetails", "reportReasonCustom" ], "functions": [] }, "ReportSponsoredResult": { "description": "Describes result of sponsored message or chat report", "types": [ "reportSponsoredResultOk", "reportSponsoredResultFailed", "reportSponsoredResultOptionRequired", "reportSponsoredResultAdsHidden", "reportSponsoredResultPremiumRequired" ], "functions": [ "reportChatSponsoredMessage", "reportSponsoredChat", "reportVideoMessageAdvertisement" ] }, "ReportStoryResult": { "description": "Describes result of story report", "types": [ "reportStoryResultOk", "reportStoryResultOptionRequired", "reportStoryResultTextRequired" ], "functions": [ "reportStory" ] }, "ResendCodeReason": { "description": "Describes the reason why a code needs to be re-sent", "types": [ "resendCodeReasonUserRequest", "resendCodeReasonVerificationFailed" ], "functions": [] }, "ResetPasswordResult": { "description": "Represents result of 2-step verification password reset", "types": [ "resetPasswordResultOk", "resetPasswordResultPending", "resetPasswordResultDeclined" ], "functions": [ "resetPassword" ] }, "RevenueWithdrawalState": { "description": "Describes state of a revenue withdrawal", "types": [ "revenueWithdrawalStatePending", "revenueWithdrawalStateSucceeded", "revenueWithdrawalStateFailed" ], "functions": [] }, "RichMessageSource": { "description": "Describes source of a rich message", "types": [ "richMessageSourceBlocks", "richMessageSourceMarkdown", "richMessageSourceHtml" ], "functions": [] }, "RichText": { "description": "Describes a formatted text object", "types": [ "richTextPlain", "richTextBold", "richTextItalic", "richTextUnderline", "richTextStrikethrough", "richTextSpoiler", "richTextSubscript", "richTextSuperscript", "richTextMarked", "richTextDateTime", "richTextMention", "richTextHashtag", "richTextCashtag", "richTextBankCardNumber", "richTextTonAddress", "richTextBotCommand", "richTextFixed", "richTextMentionName", "richTextUrl", "richTextEmailAddress", "richTextPhoneNumber", "richTextCustomEmoji", "richTextIcon", "richTextMathematicalExpression", "richTextButton", "richTextDiff", "richTextReference", "richTextReferenceLink", "richTextAnchor", "richTextAnchorLink", "richTexts" ], "functions": [] }, "SavedMessagesTopicType": { "description": "Describes type of Saved Messages topic", "types": [ "savedMessagesTopicTypeMyNotes", "savedMessagesTopicTypeAuthorHidden", "savedMessagesTopicTypeSavedFromChat" ], "functions": [] }, "SearchChatTypeFilter": { "description": "Represents a filter for type of the chats to search for", "types": [ "searchChatTypeFilterBot", "searchChatTypeFilterChannel" ], "functions": [] }, "SearchMessagesChatTypeFilter": { "description": "Represents a filter for type of the chats in which to search for messages", "types": [ "searchMessagesChatTypeFilterPrivate", "searchMessagesChatTypeFilterGroup", "searchMessagesChatTypeFilterChannel", "searchMessagesChatTypeFilterCommunity" ], "functions": [] }, "SearchMessagesFilter": { "description": "Represents a filter for message search results", "types": [ "searchMessagesFilterEmpty", "searchMessagesFilterAnimation", "searchMessagesFilterAudio", "searchMessagesFilterDocument", "searchMessagesFilterPhoto", "searchMessagesFilterPoll", "searchMessagesFilterVideo", "searchMessagesFilterVoiceNote", "searchMessagesFilterPhotoAndVideo", "searchMessagesFilterUrl", "searchMessagesFilterChatPhoto", "searchMessagesFilterVideoNote", "searchMessagesFilterVoiceAndVideoNote", "searchMessagesFilterMention", "searchMessagesFilterUnreadMention", "searchMessagesFilterUnreadReaction", "searchMessagesFilterUnreadPollVote", "searchMessagesFilterFailedToSend", "searchMessagesFilterPinned" ], "functions": [] }, "SecretChatState": { "description": "Describes the current secret chat state", "types": [ "secretChatStatePending", "secretChatStateReady", "secretChatStateClosed" ], "functions": [] }, "SentGift": { "description": "Represents content of a gift received by a user or a channel chat", "types": [ "sentGiftRegular", "sentGiftUpgraded" ], "functions": [] }, "SessionDeviceType": { "description": "Represents the type of device from which session was created", "types": [ "sessionDeviceTypeAndroid", "sessionDeviceTypeApple", "sessionDeviceTypeBrave", "sessionDeviceTypeChrome", "sessionDeviceTypeEdge", "sessionDeviceTypeFirefox", "sessionDeviceTypeIpad", "sessionDeviceTypeIphone", "sessionDeviceTypeLinux", "sessionDeviceTypeMac", "sessionDeviceTypeOpera", "sessionDeviceTypeSafari", "sessionDeviceTypeUbuntu", "sessionDeviceTypeUnknown", "sessionDeviceTypeVivaldi", "sessionDeviceTypeWindows", "sessionDeviceTypeXbox" ], "functions": [] }, "SessionType": { "description": "Describes type of user session", "types": [ "sessionTypeDevice", "sessionTypeConnectedBot" ], "functions": [] }, "SettingsSection": { "description": "Describes a section of the application settings", "types": [ "settingsSectionAppearance", "settingsSectionAskQuestion", "settingsSectionBusiness", "settingsSectionChatFolders", "settingsSectionDataAndStorage", "settingsSectionDevices", "settingsSectionEditProfile", "settingsSectionFaq", "settingsSectionFeatures", "settingsSectionInAppBrowser", "settingsSectionLanguage", "settingsSectionMyStars", "settingsSectionMyGrams", "settingsSectionNotifications", "settingsSectionPowerSaving", "settingsSectionPremium", "settingsSectionPrivacyAndSecurity", "settingsSectionPrivacyPolicy", "settingsSectionQrCode", "settingsSectionSearch", "settingsSectionSendGift" ], "functions": [] }, "SpeechRecognitionResult": { "description": "Describes result of speech recognition in a voice note", "types": [ "speechRecognitionResultPending", "speechRecognitionResultText", "speechRecognitionResultError" ], "functions": [] }, "StarSubscriptionType": { "description": "Describes type of subscription paid in Telegram Stars", "types": [ "starSubscriptionTypeChannel", "starSubscriptionTypeBot" ], "functions": [] }, "StarTransactionType": { "description": "Describes type of transaction with Telegram Stars", "types": [ "starTransactionTypePremiumBotDeposit", "starTransactionTypeAppStoreDeposit", "starTransactionTypeGooglePlayDeposit", "starTransactionTypeFragmentDeposit", "starTransactionTypeUserDeposit", "starTransactionTypeGiveawayDeposit", "starTransactionTypeFragmentWithdrawal", "starTransactionTypeTelegramAdsWithdrawal", "starTransactionTypeTelegramApiUsage", "starTransactionTypeBotPaidMediaPurchase", "starTransactionTypeBotPaidMediaSale", "starTransactionTypeChannelPaidMediaPurchase", "starTransactionTypeChannelPaidMediaSale", "starTransactionTypeBotInvoicePurchase", "starTransactionTypeBotInvoiceSale", "starTransactionTypeBotSubscriptionPurchase", "starTransactionTypeBotSubscriptionSale", "starTransactionTypeChannelSubscriptionPurchase", "starTransactionTypeChannelSubscriptionSale", "starTransactionTypeGiftAuctionBid", "starTransactionTypeGiftPurchase", "starTransactionTypeGiftPurchaseOffer", "starTransactionTypeGiftTransfer", "starTransactionTypeGiftOriginalDetailsDrop", "starTransactionTypeGiftSale", "starTransactionTypeGiftUpgrade", "starTransactionTypeGiftUpgradePurchase", "starTransactionTypeUpgradedGiftPurchase", "starTransactionTypeUpgradedGiftSale", "starTransactionTypeChannelPaidReactionSend", "starTransactionTypeChannelPaidReactionReceive", "starTransactionTypeAffiliateProgramCommission", "starTransactionTypePaidMessageSend", "starTransactionTypePaidMessageReceive", "starTransactionTypePaidGroupCallMessageSend", "starTransactionTypePaidGroupCallMessageReceive", "starTransactionTypePaidGroupCallReactionSend", "starTransactionTypePaidGroupCallReactionReceive", "starTransactionTypeSuggestedPostPaymentSend", "starTransactionTypeSuggestedPostPaymentReceive", "starTransactionTypePremiumPurchase", "starTransactionTypeBusinessBotTransferSend", "starTransactionTypeBusinessBotTransferReceive", "starTransactionTypePublicPostSearch", "starTransactionTypeUnsupported" ], "functions": [] }, "StartLiveStoryResult": { "description": "Represents result of starting a live story", "types": [ "startLiveStoryResultOk", "startLiveStoryResultFail" ], "functions": [ "startLiveStory" ] }, "StatisticalGraph": { "description": "Describes a statistical graph", "types": [ "statisticalGraphData", "statisticalGraphAsync", "statisticalGraphError" ], "functions": [ "getStatisticalGraph" ] }, "StickerFormat": { "description": "Describes format of a sticker", "types": [ "stickerFormatWebp", "stickerFormatTgs", "stickerFormatWebm" ], "functions": [] }, "StickerFullType": { "description": "Contains full information about sticker type", "types": [ "stickerFullTypeRegular", "stickerFullTypeMask", "stickerFullTypeCustomEmoji" ], "functions": [] }, "StickerType": { "description": "Describes type of sticker", "types": [ "stickerTypeRegular", "stickerTypeMask", "stickerTypeCustomEmoji" ], "functions": [] }, "StorePaymentPurpose": { "description": "Describes a purpose of an in-store payment", "types": [ "storePaymentPurposePremiumSubscription", "storePaymentPurposePremiumGift", "storePaymentPurposePremiumGiftCodes", "storePaymentPurposePremiumGiveaway", "storePaymentPurposeStarGiveaway", "storePaymentPurposeStars", "storePaymentPurposeGiftedStars" ], "functions": [] }, "StoreTransaction": { "description": "Describes an in-store transaction", "types": [ "storeTransactionAppStore", "storeTransactionGooglePlay" ], "functions": [] }, "StoryAreaType": { "description": "Describes type of clickable area on a story media", "types": [ "storyAreaTypeLocation", "storyAreaTypeVenue", "storyAreaTypeSuggestedReaction", "storyAreaTypeMessage", "storyAreaTypeLink", "storyAreaTypeWeather", "storyAreaTypeUpgradedGift" ], "functions": [] }, "StoryContent": { "description": "Contains the content of a story", "types": [ "storyContentPhoto", "storyContentVideo", "storyContentLive", "storyContentUnsupported" ], "functions": [] }, "StoryContentType": { "description": "Contains the type of the content of a story", "types": [ "storyContentTypePhoto", "storyContentTypeVideo", "storyContentTypeLive", "storyContentTypeUnsupported" ], "functions": [] }, "StoryInteractionType": { "description": "Describes type of interaction with a story", "types": [ "storyInteractionTypeView", "storyInteractionTypeForward", "storyInteractionTypeRepost" ], "functions": [] }, "StoryList": { "description": "Describes a list of stories", "types": [ "storyListMain", "storyListArchive" ], "functions": [] }, "StoryOrigin": { "description": "Contains information about the origin of a story that was reposted", "types": [ "storyOriginPublicStory", "storyOriginHiddenUser" ], "functions": [] }, "StoryPrivacySettings": { "description": "Describes privacy settings of a story", "types": [ "storyPrivacySettingsEveryone", "storyPrivacySettingsContacts", "storyPrivacySettingsCloseFriends", "storyPrivacySettingsSelectedUsers" ], "functions": [] }, "SuggestedAction": { "description": "Describes an action suggested to the current user", "types": [ "suggestedActionEnableArchiveAndMuteNewChats", "suggestedActionCheckPassword", "suggestedActionCheckPhoneNumber", "suggestedActionViewChecksHint", "suggestedActionViewFirstTonWalletTransferHint", "suggestedActionConvertToBroadcastGroup", "suggestedActionSetPassword", "suggestedActionUpgradePremium", "suggestedActionRestorePremium", "suggestedActionSubscribeToAnnualPremium", "suggestedActionGiftPremiumForChristmas", "suggestedActionSetBirthdate", "suggestedActionSetProfilePhoto", "suggestedActionExtendPremium", "suggestedActionExtendStarSubscriptions", "suggestedActionCustom", "suggestedActionSetLoginEmailAddress", "suggestedActionAddLoginPasskey" ], "functions": [] }, "SuggestedPostPrice": { "description": "Describes price of a suggested post", "types": [ "suggestedPostPriceStar", "suggestedPostPriceGram" ], "functions": [] }, "SuggestedPostRefundReason": { "description": "Describes reason for refund of the payment for a suggested post", "types": [ "suggestedPostRefundReasonPostDeleted", "suggestedPostRefundReasonPaymentRefunded" ], "functions": [] }, "SuggestedPostState": { "description": "Describes state of a suggested post", "types": [ "suggestedPostStatePending", "suggestedPostStateApproved", "suggestedPostStateDeclined" ], "functions": [] }, "SupergroupMembersFilter": { "description": "Specifies the kind of chat members to return in getSupergroupMembers", "types": [ "supergroupMembersFilterRecent", "supergroupMembersFilterContacts", "supergroupMembersFilterAdministrators", "supergroupMembersFilterSearch", "supergroupMembersFilterRestricted", "supergroupMembersFilterBanned", "supergroupMembersFilterMention", "supergroupMembersFilterBots" ], "functions": [] }, "TMeUrlType": { "description": "Describes the type of URL linking to an internal Telegram entity", "types": [ "tMeUrlTypeUser", "tMeUrlTypeSupergroup", "tMeUrlTypeChatInvite", "tMeUrlTypeStickerSet" ], "functions": [] }, "TargetChat": { "description": "Describes the target chat to be opened", "types": [ "targetChatCurrent", "targetChatChosen", "targetChatInternalLink" ], "functions": [] }, "TelegramPaymentPurpose": { "description": "Describes a purpose of a payment toward Telegram", "types": [ "telegramPaymentPurposePremiumGift", "telegramPaymentPurposePremiumGiftCodes", "telegramPaymentPurposePremiumGiveaway", "telegramPaymentPurposeStars", "telegramPaymentPurposeGiftedStars", "telegramPaymentPurposeStarGiveaway", "telegramPaymentPurposeJoinChat" ], "functions": [] }, "TextEntityType": { "description": "Represents a part of the text which must be formatted differently", "types": [ "textEntityTypeMention", "textEntityTypeHashtag", "textEntityTypeCashtag", "textEntityTypeBotCommand", "textEntityTypeUrl", "textEntityTypeEmailAddress", "textEntityTypePhoneNumber", "textEntityTypeBankCardNumber", "textEntityTypeTonAddress", "textEntityTypeBold", "textEntityTypeItalic", "textEntityTypeUnderline", "textEntityTypeStrikethrough", "textEntityTypeSpoiler", "textEntityTypeCode", "textEntityTypePre", "textEntityTypePreCode", "textEntityTypeBlockQuote", "textEntityTypeExpandableBlockQuote", "textEntityTypeTextUrl", "textEntityTypeMentionName", "textEntityTypeCustomEmoji", "textEntityTypeMediaTimestamp", "textEntityTypeDateTime" ], "functions": [] }, "TextParseMode": { "description": "Describes the way the text needs to be parsed for text entities", "types": [ "textParseModeMarkdown", "textParseModeHTML" ], "functions": [] }, "ThumbnailFormat": { "description": "Describes format of a thumbnail", "types": [ "thumbnailFormatJpeg", "thumbnailFormatGif", "thumbnailFormatMpeg4", "thumbnailFormatPng", "thumbnailFormatTgs", "thumbnailFormatWebm", "thumbnailFormatWebp" ], "functions": [] }, "TonCenterApiRequestType": { "description": "Describes state of active stories posted by a chat", "types": [ "tonCenterApiRequestTypeGet", "tonCenterApiRequestTypePost" ], "functions": [] }, "TonConnectConnectItem": { "description": "Represents a data item to share with a dApp", "types": [ "tonConnectConnectItemAddress", "tonConnectConnectItemProof" ], "functions": [] }, "TonConnectManifest": { "description": "Describes manifest of the dApp that is being connected using TON Connect", "types": [ "tonConnectManifestPending", "tonConnectManifestInfo", "tonConnectManifestFailed", "tonConnectManifestInvalid" ], "functions": [] }, "TonConnectRequestState": { "description": "Describes state of a request received from a dApp through TON Connect", "types": [ "tonConnectRequestStatePending", "tonConnectRequestStateAccepted", "tonConnectRequestStateRejected" ], "functions": [] }, "TonConnectSessionState": { "description": "Describes state of a TON Connect session", "types": [ "tonConnectSessionStatePending", "tonConnectSessionStateReady", "tonConnectSessionStateClosing", "tonConnectSessionStateClosed" ], "functions": [] }, "TonTransactionType": { "description": "Describes type of transaction with TON Grams", "types": [ "tonTransactionTypeFragmentDeposit", "tonTransactionTypeFragmentWithdrawal", "tonTransactionTypeSuggestedPostPayment", "tonTransactionTypeGiftPurchaseOffer", "tonTransactionTypeUpgradedGiftPurchase", "tonTransactionTypeUpgradedGiftSale", "tonTransactionTypeStakeDiceStake", "tonTransactionTypeStakeDicePayout", "tonTransactionTypeUnsupported" ], "functions": [] }, "TonWalletTransactionState": { "description": "Describes state of a transaction with a TON wallet", "types": [ "tonWalletTransactionStateSucceeded", "tonWalletTransactionStateFailed" ], "functions": [] }, "TonWalletTransactionType": { "description": "Describes type of transaction with a TON wallet", "types": [ "tonWalletTransactionTypeOnRampDeposit", "tonWalletTransactionTypeTransfer", "tonWalletTransactionTypeNftTransfer", "tonWalletTransactionTypeKeyChange" ], "functions": [] }, "TonWalletTransferReceiver": { "description": "Represents expected receiver of a TON wallet transfer", "types": [ "tonWalletTransferReceiverUser", "tonWalletTransferReceiverAddress" ], "functions": [] }, "TopChatCategory": { "description": "Represents the categories of chats for which a list of frequently used chats can be retrieved", "types": [ "topChatCategoryUsers", "topChatCategoryBots", "topChatCategoryGroups", "topChatCategoryChannels", "topChatCategoryInlineBots", "topChatCategoryGuestBots", "topChatCategoryWebAppBots", "topChatCategoryCalls", "topChatCategoryForwardChats" ], "functions": [] }, "TransactionDirection": { "description": "Describes direction of transactions in a transaction list", "types": [ "transactionDirectionIncoming", "transactionDirectionOutgoing" ], "functions": [] }, "Update": { "description": "Contains notifications about data changes", "types": [ "updateAuthorizationState", "updateNewMessage", "updateMessageSendAcknowledged", "updateMessageSendSucceeded", "updateMessageSendFailed", "updateMessageContent", "updateMessageEphemeralContent", "updateMessageEdited", "updateMessageIsPinned", "updateMessageInteractionInfo", "updateMessageContentOpened", "updateMessageMentionRead", "updateMessageUnreadReactions", "updateMessageContainsUnreadPollVotes", "updateMessageFactCheck", "updateMessageSuggestedPostInfo", "updateMessageLiveLocationViewed", "updateVideoPublished", "updateNewChat", "updateChatTitle", "updateChatPhoto", "updateChatAccentColors", "updateChatPermissions", "updateChatLastMessage", "updateChatPosition", "updateChatAddedToList", "updateChatRemovedFromList", "updateChatReadInbox", "updateChatReadOutbox", "updateChatActionBar", "updateChatBusinessBotManageBar", "updateChatAvailableReactions", "updateChatDraftMessage", "updateChatEmojiStatus", "updateChatMessageSender", "updateChatMessageAutoDeleteTime", "updateChatNotificationSettings", "updateChatPendingJoinRequests", "updateChatReplyMarkup", "updateChatBackground", "updateChatTheme", "updateChatUnreadMentionCount", "updateChatUnreadReactionCount", "updateChatUnreadPollVoteCount", "updateChatVideoChat", "updateChatDefaultDisableNotification", "updateChatHasProtectedContent", "updateChatIsTranslatable", "updateChatIsMarkedAsUnread", "updateChatViewAsTopics", "updateChatBlockList", "updateChatHasScheduledMessages", "updateChatHasWelcomeMessages", "updateChatFolders", "updateChatOnlineMemberCount", "updateSavedMessagesTopic", "updateSavedMessagesTopicCount", "updateDirectMessagesChatTopic", "updateTopicMessageCount", "updateQuickReplyShortcut", "updateQuickReplyShortcutDeleted", "updateQuickReplyShortcuts", "updateQuickReplyShortcutMessages", "updateChatWelcomeMessages", "updateForumTopicInfo", "updateForumTopic", "updateScopeNotificationSettings", "updateReactionNotificationSettings", "updateNotification", "updateNotificationGroup", "updateActiveNotifications", "updateHavePendingNotifications", "updateDeleteMessages", "updateChatAction", "updatePendingMessage", "updateStopMessageDraft", "updateCommunity", "updateUserStatus", "updateUser", "updateBasicGroup", "updateSupergroup", "updateSecretChat", "updateUserFullInfo", "updateBasicGroupFullInfo", "updateSupergroupFullInfo", "updateCommunityFullInfo", "updateServiceNotification", "updateNewOauthRequest", "updateFile", "updateFileGenerationStart", "updateFileGenerationStop", "updateFileDownloads", "updateFileAddedToDownloads", "updateFileDownload", "updateFileRemovedFromDownloads", "updateApplicationVerificationRequired", "updateApplicationRecaptchaVerificationRequired", "updateCall", "updateGroupCall", "updateGroupCallParticipant", "updateGroupCallParticipants", "updateGroupCallVerificationState", "updateNewGroupCallMessage", "updateNewGroupCallPaidReaction", "updateGroupCallMessageSendFailed", "updateGroupCallMessagesDeleted", "updateLiveStoryTopDonors", "updateNewCallSignalingData", "updateGiftAuctionState", "updateActiveGiftAuctions", "updateUserPrivacySettingRules", "updateUnreadMessageCount", "updateUnreadChatCount", "updateChatJoinResult", "updateStory", "updateStoryDeleted", "updateStoryPostSucceeded", "updateStoryPostFailed", "updateChatActiveStories", "updateStoryListChatCount", "updateStoryStealthMode", "updateAllowedBotUsernamePremiumSuffixes", "updateTrustedMiniAppBots", "updateOption", "updateStickerSet", "updateInstalledStickerSets", "updateTrendingStickerSets", "updateRecentStickers", "updateFavoriteStickers", "updateSavedAnimations", "updateSavedNotificationSounds", "updateDefaultBackground", "updateEmojiChatThemes", "updateAccentColors", "updateProfileAccentColors", "updateWebBrowserSettings", "updateLanguagePackStrings", "updateConnectionState", "updateFreezeState", "updateAgeVerificationParameters", "updateTermsOfService", "updateUnconfirmedSession", "updateAttachmentMenuBots", "updateWebAppMessageSent", "updateActiveEmojiReactions", "updateAvailableMessageEffects", "updateDefaultReactionType", "updateDefaultPaidReactionType", "updateSavedMessagesTags", "updateActiveLiveLocationMessages", "updateOwnedStarCount", "updateOwnedGramCount", "updateTonWalletState", "updateTonWalletGaslessTransfersInfo", "updateTonWalletTonConnectSession", "updateTonWalletTonConnectSessionDisconnectRequired", "updateChatRevenueAmount", "updateStarRevenueStatus", "updateGramRevenueStatus", "updateSpeechRecognitionTrial", "updateGroupCallMessageLevels", "updateDiceEmojis", "updateStakeDiceState", "updateAnimatedEmojiMessageClicked", "updateAnimationSearchParameters", "updateTextCompositionStyles", "updateSuggestedActions", "updateSpeedLimitNotification", "updateContactCloseBirthdays", "updateAutosaveSettings", "updateBusinessConnection", "updateNewBusinessMessage", "updateBusinessMessageEdited", "updateBusinessMessagesDeleted", "updateNewInlineQuery", "updateNewChosenInlineResult", "updateNewGuestQuery", "updateNewCallbackQuery", "updateNewInlineCallbackQuery", "updateNewBusinessCallbackQuery", "updateNewShippingQuery", "updateNewPreCheckoutQuery", "updateNewCustomEvent", "updateNewCustomQuery", "updateUserSubscription", "updatePoll", "updatePollAnswer", "updateManagedBot", "updateChatMember", "updateNewChatJoinRequest", "updateChatBoost", "updateMessageReaction", "updateMessageReactions", "updatePaidMediaPurchased" ], "functions": [ "testUseUpdate" ] }, "UpgradedGiftAttributeId": { "description": "Contains identifier of an upgraded gift attribute to search for", "types": [ "upgradedGiftAttributeIdModel", "upgradedGiftAttributeIdSymbol", "upgradedGiftAttributeIdBackdrop" ], "functions": [] }, "UpgradedGiftAttributeRarity": { "description": "Describes rarity of an upgraded gift attribute", "types": [ "upgradedGiftAttributeRarityPerMille", "upgradedGiftAttributeRarityUncommon", "upgradedGiftAttributeRarityRare", "upgradedGiftAttributeRarityEpic", "upgradedGiftAttributeRarityLegendary" ], "functions": [] }, "UpgradedGiftOrigin": { "description": "Describes origin from which the upgraded gift was obtained", "types": [ "upgradedGiftOriginUpgrade", "upgradedGiftOriginTransfer", "upgradedGiftOriginResale", "upgradedGiftOriginBlockchain", "upgradedGiftOriginPrepaidUpgrade", "upgradedGiftOriginOffer", "upgradedGiftOriginCraft" ], "functions": [] }, "UserPrivacySetting": { "description": "Describes available user privacy settings", "types": [ "userPrivacySettingShowStatus", "userPrivacySettingShowProfilePhoto", "userPrivacySettingShowLinkInForwardedMessages", "userPrivacySettingShowPhoneNumber", "userPrivacySettingShowBio", "userPrivacySettingShowBirthdate", "userPrivacySettingShowProfileAudio", "userPrivacySettingAllowChatInvites", "userPrivacySettingAllowCalls", "userPrivacySettingAllowPeerToPeerCalls", "userPrivacySettingAllowFindingByPhoneNumber", "userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages", "userPrivacySettingAutosaveGifts", "userPrivacySettingAllowUnpaidMessages" ], "functions": [] }, "UserPrivacySettingRule": { "description": "Represents a single rule for managing user privacy settings", "types": [ "userPrivacySettingRuleAllowAll", "userPrivacySettingRuleAllowContacts", "userPrivacySettingRuleAllowBots", "userPrivacySettingRuleAllowPremiumUsers", "userPrivacySettingRuleAllowUsers", "userPrivacySettingRuleAllowChatMembers", "userPrivacySettingRuleRestrictAll", "userPrivacySettingRuleRestrictContacts", "userPrivacySettingRuleRestrictBots", "userPrivacySettingRuleRestrictUsers", "userPrivacySettingRuleRestrictChatMembers" ], "functions": [] }, "UserStatus": { "description": "Describes the last time the user was online", "types": [ "userStatusEmpty", "userStatusOnline", "userStatusOffline", "userStatusRecently", "userStatusLastWeek", "userStatusLastMonth" ], "functions": [] }, "UserType": { "description": "Represents the type of user. The following types are possible: regular users, deleted users and bots", "types": [ "userTypeRegular", "userTypeDeleted", "userTypeBot", "userTypeUnknown" ], "functions": [] }, "VectorPathCommand": { "description": "Represents a vector path command", "types": [ "vectorPathCommandLine", "vectorPathCommandCubicBezierCurve" ], "functions": [] }, "WebAppOpenMode": { "description": "Describes mode in which a Web App is opened", "types": [ "webAppOpenModeCompact", "webAppOpenModeFullSize", "webAppOpenModeFullScreen" ], "functions": [] }, "WebBrowserType": { "description": "Describes the type of web browser", "types": [ "webBrowserTypeExternal", "webBrowserTypeInApp" ], "functions": [ "getLinkWebBrowserType" ] } }, "types": { "accentColor": { "description": "Contains information about supported accent color for user/chat name, background of empty chat photo, replies to messages and link previews", "args": { "built_in_accent_color_id": { "description": "Identifier of a built-in color to use in places, where only one color is needed; 0-6", "is_optional": false, "type": "int32" }, "dark_theme_colors": { "description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in dark themes", "is_optional": false, "type": "vector\u003cint32\u003e" }, "id": { "description": "Accent color identifier", "is_optional": false, "type": "int32" }, "light_theme_colors": { "description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in light themes", "is_optional": false, "type": "vector\u003cint32\u003e" }, "min_channel_chat_boost_level": { "description": "The minimum chat boost level required to use the color in a channel chat", "is_optional": false, "type": "int32" } }, "type": "AccentColor" }, "acceptedGiftTypes": { "description": "Describes gift types that are accepted by a user", "args": { "gifts_from_channels": { "description": "True, if gifts from channels are accepted subject to other restrictions", "is_optional": false, "type": "Bool" }, "limited_gifts": { "description": "True, if limited regular gifts are accepted", "is_optional": false, "type": "Bool" }, "premium_subscription": { "description": "True, if Telegram Premium subscription is accepted", "is_optional": false, "type": "Bool" }, "unlimited_gifts": { "description": "True, if unlimited regular gifts are accepted", "is_optional": false, "type": "Bool" }, "upgraded_gifts": { "description": "True, if upgraded gifts and regular gifts that can be upgraded for free are accepted", "is_optional": false, "type": "Bool" } }, "type": "AcceptedGiftTypes" }, "accountInfo": { "description": "Contains basic information about another user who started a chat with the current user", "args": { "last_name_change_date": { "description": "Point in time (Unix timestamp) when the user changed name last time; 0 if unknown", "is_optional": false, "type": "int32" }, "last_photo_change_date": { "description": "Point in time (Unix timestamp) when the user changed photo last time; 0 if unknown", "is_optional": false, "type": "int32" }, "phone_number_country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code based on the phone number of the user; may be empty if unknown", "is_optional": true, "type": "string" }, "registration_month": { "description": "Month when the user was registered in Telegram; 0-12; may be 0 if unknown", "is_optional": false, "type": "int32" }, "registration_year": { "description": "Year when the user was registered in Telegram; 0-9999; may be 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "AccountInfo" }, "accountTtl": { "description": "Contains information about the period of inactivity after which the current user's account will automatically be deleted", "args": { "days": { "description": "Number of days of inactivity before the account will be flagged for deletion; 30-730 days", "is_optional": false, "type": "int32" } }, "type": "AccountTtl" }, "activeStoryStateLive": { "description": "The chat has an active live story", "args": { "story_id": { "description": "Identifier of the active live story", "is_optional": false, "type": "int32" } }, "type": "ActiveStoryState" }, "activeStoryStateRead": { "description": "The chat has active stories, all of which were read", "args": {}, "type": "ActiveStoryState" }, "activeStoryStateUnread": { "description": "The chat has some unread active stories", "args": {}, "type": "ActiveStoryState" }, "addedProxies": { "description": "Represents a list of added proxy servers", "args": { "proxies": { "description": "List of proxy servers", "is_optional": false, "type": "vector\u003caddedProxy\u003e" } }, "type": "AddedProxies" }, "addedProxy": { "description": "Contains information about a proxy server added to the list of proxies", "args": { "comment": { "description": "Comment for the proxy added by the user", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the proxy", "is_optional": false, "type": "int32" }, "is_enabled": { "description": "True, if the proxy is enabled now", "is_optional": false, "type": "Bool" }, "last_used_date": { "description": "Point in time (Unix timestamp) when the proxy was last used; 0 if never", "is_optional": false, "type": "int32" }, "proxy": { "description": "The proxy", "is_optional": false, "type": "proxy" } }, "type": "AddedProxy" }, "addedReaction": { "description": "Represents a reaction applied to a message", "args": { "date": { "description": "Point in time (Unix timestamp) when the reaction was added", "is_optional": false, "type": "int32" }, "is_outgoing": { "description": "True, if the reaction was added by the current user", "is_optional": false, "type": "Bool" }, "sender_id": { "description": "Identifier of the chat member, applied the reaction", "is_optional": false, "type": "MessageSender" }, "type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" } }, "type": "AddedReaction" }, "addedReactions": { "description": "Represents a list of reactions added to a message", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "reactions": { "description": "The list of added reactions", "is_optional": false, "type": "vector\u003caddedReaction\u003e" }, "total_count": { "description": "The total number of found reactions", "is_optional": false, "type": "int32" } }, "type": "AddedReactions" }, "address": { "description": "Describes an address", "args": { "city": { "description": "City", "is_optional": false, "type": "string" }, "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code", "is_optional": false, "type": "string" }, "postal_code": { "description": "Address postal code", "is_optional": false, "type": "string" }, "state": { "description": "State, if applicable", "is_optional": false, "type": "string" }, "street_line1": { "description": "First line of the address", "is_optional": false, "type": "string" }, "street_line2": { "description": "Second line of the address", "is_optional": false, "type": "string" } }, "type": "Address" }, "advertisementSponsor": { "description": "Information about the sponsor of an advertisement", "args": { "info": { "description": "Additional optional information about the sponsor to be shown along with the advertisement", "is_optional": false, "type": "string" }, "photo": { "description": "Photo of the sponsor; may be null if must not be shown", "is_optional": true, "type": "photo" }, "url": { "description": "URL of the sponsor to be opened when the advertisement is clicked", "is_optional": false, "type": "string" } }, "type": "AdvertisementSponsor" }, "affiliateInfo": { "description": "Contains information about an affiliate that received commission from a Telegram Star transaction", "args": { "affiliate_chat_id": { "description": "Identifier of the chat which received the commission", "is_optional": false, "type": "int53" }, "commission_per_mille": { "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the program owner", "is_optional": false, "type": "int32" }, "star_amount": { "description": "The Telegram Star amount that was received by the affiliate; can be negative for refunds", "is_optional": false, "type": "starAmount" } }, "type": "AffiliateInfo" }, "affiliateProgramInfo": { "description": "Contains information about an active affiliate program", "args": { "daily_revenue_per_user_amount": { "description": "The amount of daily revenue per user in Telegram Stars of the bot that created the affiliate program", "is_optional": false, "type": "starAmount" }, "end_date": { "description": "Point in time (Unix timestamp) when the affiliate program will be closed; 0 if the affiliate program isn't scheduled to be closed.", "is_optional": false, "type": "int32" }, "parameters": { "description": "Parameters of the affiliate program", "is_optional": false, "type": "affiliateProgramParameters" } }, "type": "AffiliateProgramInfo" }, "affiliateProgramParameters": { "description": "Describes parameters of an affiliate program", "args": { "commission_per_mille": { "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the program owner;", "is_optional": false, "type": "int32" }, "month_count": { "description": "Number of months the program will be active; 0-36. If 0, then the program is eternal", "is_optional": false, "type": "int32" } }, "type": "AffiliateProgramParameters" }, "affiliateProgramSortOrderCreationDate": { "description": "The affiliate programs must be sorted by creation date", "args": {}, "type": "AffiliateProgramSortOrder" }, "affiliateProgramSortOrderProfitability": { "description": "The affiliate programs must be sorted by the profitability", "args": {}, "type": "AffiliateProgramSortOrder" }, "affiliateProgramSortOrderRevenue": { "description": "The affiliate programs must be sorted by the expected revenue", "args": {}, "type": "AffiliateProgramSortOrder" }, "affiliateTypeBot": { "description": "The affiliate is a bot owned by the current user", "args": { "user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" } }, "type": "AffiliateType" }, "affiliateTypeChannel": { "description": "The affiliate is a channel chat where the current user has can_post_messages administrator right", "args": { "chat_id": { "description": "Identifier of the channel chat", "is_optional": false, "type": "int53" } }, "type": "AffiliateType" }, "affiliateTypeCurrentUser": { "description": "The affiliate is the current user", "args": {}, "type": "AffiliateType" }, "ageVerificationParameters": { "description": "Describes parameters for age verification of the current user", "args": { "country": { "description": "Unique name for the country or region, which legislation required age verification. May be used to get the corresponding localization key", "is_optional": false, "type": "string" }, "min_age": { "description": "The minimum age required to view restricted content", "is_optional": false, "type": "int32" }, "verification_bot_username": { "description": "Username of the bot which main Web App may be used to verify age of the user", "is_optional": false, "type": "string" } }, "type": "AgeVerificationParameters" }, "alternativeVideo": { "description": "Describes an alternative re-encoded quality of a video file", "args": { "codec": { "description": "Codec used for video file encoding, for example, \"h264\", \"h265\", \"av1\", or \"av01\"", "is_optional": false, "type": "string" }, "height": { "description": "Video height", "is_optional": false, "type": "int32" }, "hls_file": { "description": "HLS file describing the video", "is_optional": false, "type": "file" }, "id": { "description": "Unique identifier of the alternative video, which is used in the HLS file", "is_optional": false, "type": "int64" }, "video": { "description": "File containing the video", "is_optional": false, "type": "file" }, "width": { "description": "Video width", "is_optional": false, "type": "int32" } }, "type": "AlternativeVideo" }, "animatedChatPhoto": { "description": "Animated variant of a chat photo in MPEG4 format", "args": { "file": { "description": "Information about the animation file", "is_optional": false, "type": "file" }, "length": { "description": "Animation width and height", "is_optional": false, "type": "int32" }, "main_frame_timestamp": { "description": "Timestamp of the frame, used as a static chat photo", "is_optional": false, "type": "double" } }, "type": "AnimatedChatPhoto" }, "animatedEmoji": { "description": "Describes an animated or custom representation of an emoji", "args": { "fitzpatrick_type": { "description": "Emoji modifier fitzpatrick type; 0-6; 0 if none", "is_optional": false, "type": "int32" }, "is_regular_emoji": { "description": "True, if the emoji is a regular emoji", "is_optional": false, "type": "Bool" }, "sound": { "description": "File containing the sound to be played when the sticker is clicked; may be null. The sound is encoded with the Opus codec, and stored inside an OGG container", "is_optional": true, "type": "file" }, "sticker": { "description": "Sticker for the emoji; may be null if yet unknown for a custom emoji. If the sticker is a custom emoji, then it can have arbitrary format", "is_optional": true, "type": "sticker" }, "sticker_height": { "description": "Expected height of the sticker, which can be used if the sticker is null", "is_optional": false, "type": "int32" }, "sticker_width": { "description": "Expected width of the sticker, which can be used if the sticker is null", "is_optional": false, "type": "int32" } }, "type": "AnimatedEmoji" }, "animation": { "description": "Describes an animation file. The animation must be encoded in GIF or MPEG4 format", "args": { "animation": { "description": "File containing the animation", "is_optional": false, "type": "file" }, "duration": { "description": "Duration of the animation, in seconds; as defined by the sender", "is_optional": false, "type": "int32" }, "file_name": { "description": "Original name of the file; as defined by the sender", "is_optional": false, "type": "string" }, "has_stickers": { "description": "True, if stickers were added to the animation. The list of corresponding sticker sets can be received using getAttachedStickerSets", "is_optional": false, "type": "Bool" }, "height": { "description": "Height of the animation", "is_optional": false, "type": "int32" }, "mime_type": { "description": "MIME type of the file, usually \"image/gif\" or \"video/mp4\"", "is_optional": false, "type": "string" }, "minithumbnail": { "description": "Animation minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "thumbnail": { "description": "Animation thumbnail in JPEG or MPEG4 format; may be null", "is_optional": true, "type": "thumbnail" }, "width": { "description": "Width of the animation", "is_optional": false, "type": "int32" } }, "type": "Animation" }, "animations": { "description": "Represents a list of animations", "args": { "animations": { "description": "List of animations", "is_optional": false, "type": "vector\u003canimation\u003e" } }, "type": "Animations" }, "archiveChatListSettings": { "description": "Contains settings for automatic moving of chats to and from the Archive chat lists", "args": { "archive_and_mute_new_chats_from_unknown_users": { "description": "True, if new chats from non-contacts will be automatically archived and muted. Can be set to true only if the option \"can_archive_and_mute_new_chats_from_unknown_users\" is true", "is_optional": false, "type": "Bool" }, "keep_chats_from_folders_archived": { "description": "True, if unmuted chats, that are always included or pinned in a folder, will be kept in the Archive chat list when they get a new message. Ignored if keep_unmuted_chats_archived == true", "is_optional": false, "type": "Bool" }, "keep_unmuted_chats_archived": { "description": "True, if unmuted chats will be kept in the Archive chat list when they get a new message", "is_optional": false, "type": "Bool" } }, "type": "ArchiveChatListSettings" }, "attachmentMenuBot": { "description": "Represents a bot, which can be added to attachment or side menu", "args": { "android_icon": { "description": "Icon for the bot in TGS format for the official Android app; may be null", "is_optional": true, "type": "file" }, "android_side_menu_icon": { "description": "Icon for the bot in SVG format for the official Android app side menu; may be null", "is_optional": true, "type": "file" }, "bot_user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" }, "default_icon": { "description": "Default icon for the bot in SVG format; may be null", "is_optional": true, "type": "file" }, "icon_color": { "description": "Color to highlight selected icon of the bot if appropriate; may be null", "is_optional": true, "type": "attachmentMenuBotColor" }, "ios_animated_icon": { "description": "Icon for the bot in TGS format for the official iOS app; may be null", "is_optional": true, "type": "file" }, "ios_side_menu_icon": { "description": "Icon for the bot in PNG format for the official iOS app side menu; may be null", "is_optional": true, "type": "file" }, "ios_static_icon": { "description": "Icon for the bot in SVG format for the official iOS app; may be null", "is_optional": true, "type": "file" }, "is_added": { "description": "True, if the bot was explicitly added by the user. If the bot isn't added, then on the first bot launch toggleBotIsAddedToAttachmentMenu must be called and the bot must be added or removed", "is_optional": false, "type": "Bool" }, "macos_icon": { "description": "Icon for the bot in TGS format for the official native macOS app; may be null", "is_optional": true, "type": "file" }, "macos_side_menu_icon": { "description": "Icon for the bot in PNG format for the official macOS app side menu; may be null", "is_optional": true, "type": "file" }, "name": { "description": "Name for the bot in attachment menu", "is_optional": false, "type": "string" }, "name_color": { "description": "Color to highlight selected name of the bot if appropriate; may be null", "is_optional": true, "type": "attachmentMenuBotColor" }, "request_write_access": { "description": "True, if the user must be asked for the permission to send messages to the bot", "is_optional": false, "type": "Bool" }, "show_disclaimer_in_side_menu": { "description": "True, if a disclaimer, why the bot is shown in the side menu, is needed", "is_optional": false, "type": "Bool" }, "show_in_attachment_menu": { "description": "True, if the bot must be shown in the attachment menu", "is_optional": false, "type": "Bool" }, "show_in_side_menu": { "description": "True, if the bot must be shown in the side menu", "is_optional": false, "type": "Bool" }, "supports_bot_chats": { "description": "True, if the bot supports opening from attachment menu in private chats with other bots", "is_optional": false, "type": "Bool" }, "supports_channel_chats": { "description": "True, if the bot supports opening from attachment menu in channel chats", "is_optional": false, "type": "Bool" }, "supports_group_chats": { "description": "True, if the bot supports opening from attachment menu in basic group and supergroup chats", "is_optional": false, "type": "Bool" }, "supports_self_chat": { "description": "True, if the bot supports opening from attachment menu in the chat with the bot", "is_optional": false, "type": "Bool" }, "supports_user_chats": { "description": "True, if the bot supports opening from attachment menu in private chats with ordinary users", "is_optional": false, "type": "Bool" }, "web_app_placeholder": { "description": "Default placeholder for opened Web Apps in SVG format; may be null", "is_optional": true, "type": "file" } }, "type": "AttachmentMenuBot" }, "attachmentMenuBotColor": { "description": "Describes a color to highlight a bot added to attachment menu", "args": { "dark_color": { "description": "Color in the RGB format for dark themes", "is_optional": false, "type": "int32" }, "light_color": { "description": "Color in the RGB format for light themes", "is_optional": false, "type": "int32" } }, "type": "AttachmentMenuBotColor" }, "attributeCraftPersistenceProbability": { "description": "Describes chance of the crafted gift to have the backdrop or symbol of one of the original gifts", "args": { "persistence_chance_per_mille": { "description": "The 4 numbers that describe probability of the craft result to have the same attribute as one of the original gifts", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "AttributeCraftPersistenceProbability" }, "auctionBid": { "description": "Describes a bid in an auction", "args": { "bid_date": { "description": "Point in time (Unix timestamp) when the bid was made", "is_optional": false, "type": "int32" }, "position": { "description": "Position of the bid in the list of all bids", "is_optional": false, "type": "int32" }, "star_count": { "description": "The number of Telegram Stars that were put in the bid", "is_optional": false, "type": "int53" } }, "type": "AuctionBid" }, "auctionRound": { "description": "Describes a round of an auction", "args": { "duration": { "description": "Duration of the round, in seconds", "is_optional": false, "type": "int32" }, "extend_time": { "description": "The number of seconds for which the round will be extended if there are changes in the top winners", "is_optional": false, "type": "int32" }, "number": { "description": "1-based number of the round", "is_optional": false, "type": "int32" }, "top_winner_count": { "description": "The number of top winners who trigger round extension if changed", "is_optional": false, "type": "int32" } }, "type": "AuctionRound" }, "auctionStateActive": { "description": "Contains information about an ongoing or scheduled auction", "args": { "acquired_item_count": { "description": "The number of items that were purchased by the current user on the auction", "is_optional": false, "type": "int32" }, "bid_levels": { "description": "A sparse list of bids that were made in the auction", "is_optional": false, "type": "vector\u003cauctionBid\u003e" }, "current_round_end_date": { "description": "Point in time (Unix timestamp) when the current round will end", "is_optional": false, "type": "int32" }, "current_round_number": { "description": "1-based number of the current round", "is_optional": false, "type": "int32" }, "distributed_item_count": { "description": "The number of items that were purchased on the auction by all users", "is_optional": false, "type": "int32" }, "end_date": { "description": "Point in time (Unix timestamp) when the auction will be ended", "is_optional": false, "type": "int32" }, "left_item_count": { "description": "The number of items that have to be distributed on the auction", "is_optional": false, "type": "int32" }, "min_bid": { "description": "The minimum possible bid in the auction in Telegram Stars", "is_optional": false, "type": "int53" }, "rounds": { "description": "Rounds of the auction in which their duration or extension rules are changed", "is_optional": false, "type": "vector\u003cauctionRound\u003e" }, "start_date": { "description": "Point in time (Unix timestamp) when the auction started or will start", "is_optional": false, "type": "int32" }, "top_bidder_user_ids": { "description": "User identifiers of at most 3 users with the biggest bids", "is_optional": false, "type": "vector\u003cint53\u003e" }, "total_round_count": { "description": "The total number of rounds", "is_optional": false, "type": "int32" }, "user_bid": { "description": "Bid of the current user in the auction; may be null if none", "is_optional": true, "type": "userAuctionBid" } }, "type": "AuctionState" }, "auctionStateFinished": { "description": "Contains information about a finished auction", "args": { "acquired_item_count": { "description": "The number of items that were purchased by the current user on the auction", "is_optional": false, "type": "int32" }, "average_price": { "description": "Average price of bought items in Telegram Stars", "is_optional": false, "type": "int53" }, "end_date": { "description": "Point in time (Unix timestamp) when the auction will be ended", "is_optional": false, "type": "int32" }, "fragment_listed_item_count": { "description": "Number of items from the auction being resold on Fragment", "is_optional": false, "type": "int32" }, "fragment_url": { "description": "The HTTPS link to the Fragment for the resold items; may be empty if there are no such items being sold on Fragment", "is_optional": true, "type": "string" }, "start_date": { "description": "Point in time (Unix timestamp) when the auction started", "is_optional": false, "type": "int32" }, "telegram_listed_item_count": { "description": "Number of items from the auction being resold on Telegram", "is_optional": false, "type": "int32" } }, "type": "AuctionState" }, "audio": { "description": "Describes an audio file. Audio is usually in MP3 or M4A format", "args": { "album_cover_minithumbnail": { "description": "The minithumbnail of the album cover; may be null", "is_optional": true, "type": "minithumbnail" }, "album_cover_thumbnail": { "description": "The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail is expected to be extracted from the downloaded audio file; may be null", "is_optional": true, "type": "thumbnail" }, "audio": { "description": "File containing the audio", "is_optional": false, "type": "file" }, "duration": { "description": "Duration of the audio, in seconds; as defined by the sender", "is_optional": false, "type": "int32" }, "external_album_covers": { "description": "Album cover variants to use if the downloaded audio file contains no album cover. Provided thumbnail dimensions are approximate", "is_optional": false, "type": "vector\u003cthumbnail\u003e" }, "file_name": { "description": "Original name of the file; as defined by the sender", "is_optional": false, "type": "string" }, "mime_type": { "description": "The MIME type of the file; as defined by the sender", "is_optional": false, "type": "string" }, "performer": { "description": "Performer of the audio; as defined by the sender", "is_optional": false, "type": "string" }, "title": { "description": "Title of the audio; as defined by the sender", "is_optional": false, "type": "string" } }, "type": "Audio" }, "audios": { "description": "Contains a list of audio files", "args": { "audios": { "description": "List of audio files", "is_optional": false, "type": "vector\u003caudio\u003e" }, "total_count": { "description": "Approximate total number of audio files found", "is_optional": false, "type": "int32" } }, "type": "Audios" }, "authenticationCodeInfo": { "description": "Information about the authentication code that was sent", "args": { "next_type": { "description": "The way the next code will be sent to the user; may be null", "is_optional": true, "type": "AuthenticationCodeType" }, "phone_number": { "description": "A phone number that is being authenticated", "is_optional": false, "type": "string" }, "timeout": { "description": "Timeout before the code can be re-sent, in seconds", "is_optional": false, "type": "int32" }, "type": { "description": "The way the code was sent to the user", "is_optional": false, "type": "AuthenticationCodeType" } }, "type": "AuthenticationCodeInfo" }, "authenticationCodeTypeCall": { "description": "A digit-only authentication code is delivered via a phone call to the specified phone number", "args": { "length": { "description": "Length of the code", "is_optional": false, "type": "int32" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeFirebaseAndroid": { "description": "A digit-only authentication code is delivered via Firebase Authentication to the official Android application", "args": { "device_verification_parameters": { "description": "Parameters to be used for device verification", "is_optional": false, "type": "FirebaseDeviceVerificationParameters" }, "length": { "description": "Length of the code", "is_optional": false, "type": "int32" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeFirebaseIos": { "description": "A digit-only authentication code is delivered via Firebase Authentication to the official iOS application", "args": { "length": { "description": "Length of the code", "is_optional": false, "type": "int32" }, "push_timeout": { "description": "Time after the next authentication method is expected to be used if verification push notification isn't received, in seconds", "is_optional": false, "type": "int32" }, "receipt": { "description": "Receipt of successful application token validation to compare with receipt from push notification", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeFlashCall": { "description": "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", "args": { "pattern": { "description": "Pattern of the phone number from which the call will be made", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeFragment": { "description": "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", "args": { "length": { "description": "Length of the code", "is_optional": false, "type": "int32" }, "url": { "description": "URL to open to receive the code", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeMissedCall": { "description": "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", "args": { "length": { "description": "Number of digits in the code, excluding the prefix", "is_optional": false, "type": "int32" }, "phone_number_prefix": { "description": "Prefix of the phone number from which the call will be made", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeSms": { "description": "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", "args": { "length": { "description": "Length of the code", "is_optional": false, "type": "int32" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeSmsPhrase": { "description": "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", "args": { "first_word": { "description": "The first word of the phrase if known", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeSmsWord": { "description": "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", "args": { "first_letter": { "description": "The first letters of the word if known", "is_optional": false, "type": "string" } }, "type": "AuthenticationCodeType" }, "authenticationCodeTypeTelegramMessage": { "description": "A digit-only authentication code is delivered via a private Telegram message, which can be viewed from another active session", "args": { "length": { "description": "Length of the code", "is_optional": false, "type": "int32" } }, "type": "AuthenticationCodeType" }, "authorizationStateClosed": { "description": "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", "args": {}, "type": "AuthorizationState" }, "authorizationStateClosing": { "description": "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", "args": {}, "type": "AuthorizationState" }, "authorizationStateLoggingOut": { "description": "The user is currently logging out", "args": {}, "type": "AuthorizationState" }, "authorizationStateReady": { "description": "The user has been successfully authorized. TDLib is now ready to answer general requests", "args": {}, "type": "AuthorizationState" }, "authorizationStateWaitCode": { "description": "TDLib needs the user's authentication code to authorize. Call checkAuthenticationCode to check the code", "args": { "code_info": { "description": "Information about the authorization code that was sent", "is_optional": false, "type": "authenticationCodeInfo" } }, "type": "AuthorizationState" }, "authorizationStateWaitEmailAddress": { "description": "TDLib needs the user's email address to authorize. Call setAuthenticationEmailAddress to provide the email address, or directly call checkAuthenticationEmailCode with Apple ID/Google ID token if allowed", "args": { "allow_apple_id": { "description": "True, if authorization through Apple ID is allowed", "is_optional": false, "type": "Bool" }, "allow_google_id": { "description": "True, if authorization through Google ID is allowed", "is_optional": false, "type": "Bool" } }, "type": "AuthorizationState" }, "authorizationStateWaitEmailCode": { "description": "TDLib needs the user's authentication code sent to an email address to authorize. Call checkAuthenticationEmailCode to provide the code", "args": { "allow_apple_id": { "description": "True, if authorization through Apple ID is allowed", "is_optional": false, "type": "Bool" }, "allow_google_id": { "description": "True, if authorization through Google ID is allowed", "is_optional": false, "type": "Bool" }, "code_info": { "description": "Information about the sent authentication code", "is_optional": false, "type": "emailAddressAuthenticationCodeInfo" }, "email_address_reset_state": { "description": "Reset state of the email address; may be null if the email address can't be reset", "is_optional": true, "type": "EmailAddressResetState" } }, "type": "AuthorizationState" }, "authorizationStateWaitOtherDeviceConfirmation": { "description": "The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link", "args": { "link": { "description": "A tg:// URL for the QR code. The link will be updated frequently", "is_optional": false, "type": "string" } }, "type": "AuthorizationState" }, "authorizationStateWaitPassword": { "description": "The user has been authorized, but needs to enter a 2-step verification password to start using the application.", "args": { "has_passport_data": { "description": "True, if some Telegram Passport elements were saved", "is_optional": false, "type": "Bool" }, "has_recovery_email_address": { "description": "True, if a recovery email address has been set up", "is_optional": false, "type": "Bool" }, "password_hint": { "description": "Hint for the password; may be empty", "is_optional": true, "type": "string" }, "recovery_email_address_pattern": { "description": "Pattern of the email address to which the recovery email was sent; empty until a recovery email has been sent", "is_optional": false, "type": "string" } }, "type": "AuthorizationState" }, "authorizationStateWaitPhoneNumber": { "description": "TDLib needs the user's phone number to authorize. Call setAuthenticationPhoneNumber to provide the phone number,", "args": {}, "type": "AuthorizationState" }, "authorizationStateWaitPremiumPurchase": { "description": "The user must buy Telegram Premium as an in-store purchase to log in. Call checkAuthenticationPremiumPurchase and then setAuthenticationPremiumPurchaseTransaction", "args": { "premium_day_count": { "description": "Duration of the Telegram Premium subscription after the purchase; may be 0 if Telegram Premium subscription will not be granted", "is_optional": false, "type": "int32" }, "store_product_id": { "description": "Identifier of the store product that must be bought", "is_optional": false, "type": "string" }, "support_email_address": { "description": "Email address to use for support if the user has issues with Telegram Premium purchase", "is_optional": false, "type": "string" }, "support_email_subject": { "description": "Subject for the email sent to the support email address", "is_optional": false, "type": "string" } }, "type": "AuthorizationState" }, "authorizationStateWaitRegistration": { "description": "The user is unregistered and needs to accept terms of service and enter their first name and last name to finish registration. Call registerUser to accept the terms of service and provide the data", "args": { "terms_of_service": { "description": "Telegram terms of service", "is_optional": false, "type": "termsOfService" } }, "type": "AuthorizationState" }, "authorizationStateWaitTdlibParameters": { "description": "Initialization parameters are needed. Call setTdlibParameters to provide them", "args": {}, "type": "AuthorizationState" }, "autoDownloadSettings": { "description": "Contains auto-download settings", "args": { "is_auto_download_enabled": { "description": "True, if the auto-download is enabled", "is_optional": false, "type": "Bool" }, "max_other_file_size": { "description": "The maximum size of other file types to be auto-downloaded, in bytes", "is_optional": false, "type": "int53" }, "max_photo_file_size": { "description": "The maximum size of a photo file to be auto-downloaded, in bytes", "is_optional": false, "type": "int32" }, "max_video_file_size": { "description": "The maximum size of a video file to be auto-downloaded, in bytes", "is_optional": false, "type": "int53" }, "preload_large_videos": { "description": "True, if the beginning of video files needs to be preloaded for instant playback", "is_optional": false, "type": "Bool" }, "preload_next_audio": { "description": "True, if the next audio track needs to be preloaded while the user is listening to an audio file", "is_optional": false, "type": "Bool" }, "preload_stories": { "description": "True, if stories need to be preloaded", "is_optional": false, "type": "Bool" }, "use_less_data_for_calls": { "description": "True, if \"use less data for calls\" option needs to be enabled", "is_optional": false, "type": "Bool" }, "video_upload_bitrate": { "description": "The maximum suggested bitrate for uploaded videos, in kbit/s", "is_optional": false, "type": "int32" } }, "type": "AutoDownloadSettings" }, "autoDownloadSettingsPresets": { "description": "Contains auto-download settings presets for the current user", "args": { "high": { "description": "Preset with highest settings; expected to be used by default when connected on Wi-Fi", "is_optional": false, "type": "autoDownloadSettings" }, "low": { "description": "Preset with lowest settings; expected to be used by default when roaming", "is_optional": false, "type": "autoDownloadSettings" }, "medium": { "description": "Preset with medium settings; expected to be used by default when using mobile data", "is_optional": false, "type": "autoDownloadSettings" } }, "type": "AutoDownloadSettingsPresets" }, "autosaveSettings": { "description": "Describes autosave settings", "args": { "channel_settings": { "description": "Default autosave settings for channel chats", "is_optional": false, "type": "scopeAutosaveSettings" }, "exceptions": { "description": "Autosave settings for specific chats", "is_optional": false, "type": "vector\u003cautosaveSettingsException\u003e" }, "group_settings": { "description": "Default autosave settings for basic group and supergroup chats", "is_optional": false, "type": "scopeAutosaveSettings" }, "private_chat_settings": { "description": "Default autosave settings for private chats", "is_optional": false, "type": "scopeAutosaveSettings" } }, "type": "AutosaveSettings" }, "autosaveSettingsException": { "description": "Contains autosave settings for a chat, which overrides default settings for the corresponding scope", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "settings": { "description": "Autosave settings for the chat", "is_optional": false, "type": "scopeAutosaveSettings" } }, "type": "AutosaveSettingsException" }, "autosaveSettingsScopeChannelChats": { "description": "Autosave settings applied to all channel chats without chat-specific settings", "args": {}, "type": "AutosaveSettingsScope" }, "autosaveSettingsScopeChat": { "description": "Autosave settings applied to a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "AutosaveSettingsScope" }, "autosaveSettingsScopeGroupChats": { "description": "Autosave settings applied to all basic group and supergroup chats without chat-specific settings", "args": {}, "type": "AutosaveSettingsScope" }, "autosaveSettingsScopePrivateChats": { "description": "Autosave settings applied to all private chats without chat-specific settings", "args": {}, "type": "AutosaveSettingsScope" }, "availableGift": { "description": "Describes a gift that is available for purchase", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "min_resale_star_count": { "description": "The minimum price for the gifts available for resale in Telegram Star equivalent; 0 if there are no such gifts", "is_optional": false, "type": "int53" }, "resale_count": { "description": "Number of gifts that are available for resale", "is_optional": false, "type": "int32" }, "title": { "description": "The title of the upgraded gift; empty if the gift isn't available for resale", "is_optional": false, "type": "string" } }, "type": "AvailableGift" }, "availableGifts": { "description": "Contains a list of gifts that can be sent to another user or channel chat", "args": { "gifts": { "description": "The list of gifts", "is_optional": false, "type": "vector\u003cavailableGift\u003e" } }, "type": "AvailableGifts" }, "availableReaction": { "description": "Represents an available reaction", "args": { "needs_premium": { "description": "True, if Telegram Premium is needed to send the reaction", "is_optional": false, "type": "Bool" }, "type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" } }, "type": "AvailableReaction" }, "availableReactions": { "description": "Represents a list of reactions that can be added to a message", "args": { "allow_custom_emoji": { "description": "True, if any custom emoji reaction can be added by Telegram Premium subscribers", "is_optional": false, "type": "Bool" }, "are_tags": { "description": "True, if the reactions will be tags and the message can be found by them", "is_optional": false, "type": "Bool" }, "popular_reactions": { "description": "List of popular reactions", "is_optional": false, "type": "vector\u003cavailableReaction\u003e" }, "recent_reactions": { "description": "List of recently used reactions", "is_optional": false, "type": "vector\u003cavailableReaction\u003e" }, "top_reactions": { "description": "List of reactions to be shown at the top", "is_optional": false, "type": "vector\u003cavailableReaction\u003e" }, "unavailability_reason": { "description": "The reason why the current user can't add reactions to the message, despite some other users can; may be null if none", "is_optional": true, "type": "ReactionUnavailabilityReason" } }, "type": "AvailableReactions" }, "background": { "description": "Describes a chat background", "args": { "document": { "description": "Document with the background; may be null. Null only for filled and chat theme backgrounds", "is_optional": true, "type": "document" }, "id": { "description": "Unique background identifier", "is_optional": false, "type": "int64" }, "is_dark": { "description": "True, if the background is dark and is recommended to be used with dark theme", "is_optional": false, "type": "Bool" }, "is_default": { "description": "True, if this is one of default backgrounds", "is_optional": false, "type": "Bool" }, "name": { "description": "Unique background name", "is_optional": false, "type": "string" }, "type": { "description": "Type of the background", "is_optional": false, "type": "BackgroundType" } }, "type": "Background" }, "backgroundFillFreeformGradient": { "description": "Describes a freeform gradient fill of a background", "args": { "colors": { "description": "A list of 3 or 4 colors of the freeform gradient in the RGB format", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "BackgroundFill" }, "backgroundFillGradient": { "description": "Describes a gradient fill of a background", "args": { "bottom_color": { "description": "A bottom color of the background in the RGB format", "is_optional": false, "type": "int32" }, "rotation_angle": { "description": "Clockwise rotation angle of the gradient, in degrees; 0-359. Must always be divisible by 45", "is_optional": false, "type": "int32" }, "top_color": { "description": "A top color of the background in the RGB format", "is_optional": false, "type": "int32" } }, "type": "BackgroundFill" }, "backgroundFillSolid": { "description": "Describes a solid fill of a background", "args": { "color": { "description": "A color of the background in the RGB format", "is_optional": false, "type": "int32" } }, "type": "BackgroundFill" }, "backgroundTypeChatTheme": { "description": "A background from a chat theme based on an emoji; can be used only as a chat background in channels", "args": { "theme_name": { "description": "Name of the emoji chat theme", "is_optional": false, "type": "string" } }, "type": "BackgroundType" }, "backgroundTypeFill": { "description": "A filled background", "args": { "fill": { "description": "The background fill", "is_optional": false, "type": "BackgroundFill" } }, "type": "BackgroundType" }, "backgroundTypePattern": { "description": "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", "args": { "fill": { "description": "Fill of the background", "is_optional": false, "type": "BackgroundFill" }, "intensity": { "description": "Intensity of the pattern when it is shown above the filled background; 0-100", "is_optional": false, "type": "int32" }, "is_inverted": { "description": "True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only", "is_optional": false, "type": "Bool" }, "is_moving": { "description": "True, if the background needs to be slightly moved when device is tilted", "is_optional": false, "type": "Bool" } }, "type": "BackgroundType" }, "backgroundTypeWallpaper": { "description": "A wallpaper in JPEG format", "args": { "is_blurred": { "description": "True, if the wallpaper must be downscaled to fit in 450x450 square and then box-blurred with radius 12", "is_optional": false, "type": "Bool" }, "is_moving": { "description": "True, if the background needs to be slightly moved when device is tilted", "is_optional": false, "type": "Bool" } }, "type": "BackgroundType" }, "backgrounds": { "description": "Contains a list of backgrounds", "args": { "backgrounds": { "description": "A list of backgrounds", "is_optional": false, "type": "vector\u003cbackground\u003e" } }, "type": "Backgrounds" }, "bankCardActionOpenUrl": { "description": "Describes an action associated with a bank card number", "args": { "text": { "description": "Action text", "is_optional": false, "type": "string" }, "url": { "description": "The URL to be opened", "is_optional": false, "type": "string" } }, "type": "BankCardActionOpenUrl" }, "bankCardInfo": { "description": "Information about a bank card", "args": { "actions": { "description": "Actions that can be done with the bank card number", "is_optional": false, "type": "vector\u003cbankCardActionOpenUrl\u003e" }, "title": { "description": "Title of the bank card description", "is_optional": false, "type": "string" } }, "type": "BankCardInfo" }, "basicGroup": { "description": "Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)", "args": { "id": { "description": "Group identifier", "is_optional": false, "type": "int53" }, "is_active": { "description": "True, if the group is active", "is_optional": false, "type": "Bool" }, "member_count": { "description": "Number of members in the group", "is_optional": false, "type": "int32" }, "status": { "description": "Status of the current user in the group", "is_optional": false, "type": "ChatMemberStatus" }, "upgraded_to_supergroup_id": { "description": "Identifier of the supergroup to which this group was upgraded; 0 if none", "is_optional": false, "type": "int53" } }, "type": "BasicGroup" }, "basicGroupFullInfo": { "description": "Contains full information about a basic group", "args": { "bot_commands": { "description": "List of commands of bots in the group", "is_optional": false, "type": "vector\u003cbotCommands\u003e" }, "can_hide_members": { "description": "True, if non-administrators and non-bots can be hidden in responses to getSupergroupMembers and searchChatMembers for non-administrators after upgrading the basic group to a supergroup", "is_optional": false, "type": "Bool" }, "can_toggle_aggressive_anti_spam": { "description": "True, if aggressive anti-spam checks can be enabled or disabled in the supergroup after upgrading the basic group to a supergroup", "is_optional": false, "type": "Bool" }, "creator_user_id": { "description": "User identifier of the creator of the group; 0 if unknown", "is_optional": false, "type": "int53" }, "description": { "description": "Group description. Updated only after the basic group is opened", "is_optional": false, "type": "string" }, "invite_link": { "description": "Primary invite link for this group; may be null. For chat administrators with can_invite_users right only. Updated only after the basic group is opened", "is_optional": true, "type": "chatInviteLink" }, "members": { "description": "Group members", "is_optional": false, "type": "vector\u003cchatMember\u003e" }, "photo": { "description": "Chat photo; may be null if empty or unknown. If non-null, then it is the same photo as in chat.photo", "is_optional": true, "type": "chatPhoto" } }, "type": "BasicGroupFullInfo" }, "birthdate": { "description": "Represents a birthdate of a user", "args": { "day": { "description": "Day of the month; 1-31", "is_optional": false, "type": "int32" }, "month": { "description": "Month of the year; 1-12", "is_optional": false, "type": "int32" }, "year": { "description": "Birth year; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "Birthdate" }, "blockListMain": { "description": "The main block list that disallows writing messages to the current user, receiving their status and photo, viewing of stories, and some other actions", "args": {}, "type": "BlockList" }, "blockListStories": { "description": "The block list that disallows viewing of stories of the current user", "args": {}, "type": "BlockList" }, "botAccessSettings": { "description": "Describes users that have access to a bot", "args": { "added_user_ids": { "description": "Identifiers of the users who can use the bot additionally to the owner of the bot", "is_optional": false, "type": "vector\u003cint53\u003e" }, "is_restricted": { "description": "True, if access to the bot is restricted to its owner and selected users", "is_optional": false, "type": "Bool" } }, "type": "BotAccessSettings" }, "botCommand": { "description": "Represents a command supported by a bot", "args": { "command": { "description": "Text of the bot command", "is_optional": false, "type": "string" }, "description": { "description": "Description of the bot command", "is_optional": false, "type": "string" }, "is_ephemeral": { "description": "True, if the command must send an ephemeral message instead of a regular one", "is_optional": false, "type": "Bool" } }, "type": "BotCommand" }, "botCommandScopeAllChatAdministrators": { "description": "A scope covering all group and supergroup chat administrators", "args": {}, "type": "BotCommandScope" }, "botCommandScopeAllGroupChats": { "description": "A scope covering all group and supergroup chats", "args": {}, "type": "BotCommandScope" }, "botCommandScopeAllPrivateChats": { "description": "A scope covering all private chats", "args": {}, "type": "BotCommandScope" }, "botCommandScopeChat": { "description": "A scope covering all members of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "BotCommandScope" }, "botCommandScopeChatAdministrators": { "description": "A scope covering all administrators of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "BotCommandScope" }, "botCommandScopeChatMember": { "description": "A scope covering a member of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "BotCommandScope" }, "botCommandScopeDefault": { "description": "A scope covering all users", "args": {}, "type": "BotCommandScope" }, "botCommands": { "description": "Contains a list of bot commands", "args": { "bot_user_id": { "description": "Bot's user identifier", "is_optional": false, "type": "int53" }, "commands": { "description": "List of bot commands", "is_optional": false, "type": "vector\u003cbotCommand\u003e" } }, "type": "BotCommands" }, "botInfo": { "description": "Contains information about a bot", "args": { "affiliate_program": { "description": "Information about the affiliate program of the bot; may be null if none", "is_optional": true, "type": "affiliateProgramInfo" }, "animation": { "description": "Animation shown in the chat with the bot if the chat is empty; may be null", "is_optional": true, "type": "animation" }, "can_get_revenue_statistics": { "description": "True, if the bot's revenue statistics are available to the current user", "is_optional": false, "type": "Bool" }, "can_manage_emoji_status": { "description": "True, if the bot can manage emoji status of the current user", "is_optional": false, "type": "Bool" }, "commands": { "description": "List of the bot commands", "is_optional": false, "type": "vector\u003cbotCommand\u003e" }, "default_channel_administrator_rights": { "description": "Default administrator rights for adding the bot to channels; may be null", "is_optional": true, "type": "chatAdministratorRights" }, "default_group_administrator_rights": { "description": "Default administrator rights for adding the bot to basic group and supergroup chats; may be null", "is_optional": true, "type": "chatAdministratorRights" }, "description": { "description": "The text shown in the chat with the bot if the chat is empty", "is_optional": false, "type": "string" }, "edit_commands_link": { "description": "The internal link, which can be used to edit bot commands; may be null", "is_optional": true, "type": "InternalLinkType" }, "edit_description_link": { "description": "The internal link, which can be used to edit bot description; may be null", "is_optional": true, "type": "InternalLinkType" }, "edit_description_media_link": { "description": "The internal link, which can be used to edit the photo or animation shown in the chat with the bot if the chat is empty; may be null", "is_optional": true, "type": "InternalLinkType" }, "edit_settings_link": { "description": "The internal link, which can be used to edit bot settings; may be null", "is_optional": true, "type": "InternalLinkType" }, "has_media_previews": { "description": "True, if the bot has media previews", "is_optional": false, "type": "Bool" }, "manager_bot_user_id": { "description": "Identifier of the bot, which manages the bot; 0 if none or unknown; for owner of the bot only", "is_optional": false, "type": "int53" }, "menu_button": { "description": "Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown", "is_optional": true, "type": "botMenuButton" }, "photo": { "description": "Photo shown in the chat with the bot if the chat is empty; may be null", "is_optional": true, "type": "photo" }, "privacy_policy_url": { "description": "The HTTP link to the privacy policy of the bot. If empty, then /privacy command must be used if supported by the bot. If the command isn't supported, then https://telegram.org/privacy-tpa must be opened", "is_optional": false, "type": "string" }, "short_description": { "description": "The text that is shown on the bot's profile page and is sent together with the link when users share the bot", "is_optional": false, "type": "string" }, "verification_parameters": { "description": "Parameters of the verification that can be provided by the bot; may be null if none or the current user isn't the owner of the bot", "is_optional": true, "type": "botVerificationParameters" }, "web_app_background_dark_color": { "description": "Default dark background color for bot Web Apps; -1 if not specified", "is_optional": false, "type": "int32" }, "web_app_background_light_color": { "description": "Default light background color for bot Web Apps; -1 if not specified", "is_optional": false, "type": "int32" }, "web_app_header_dark_color": { "description": "Default dark header color for bot Web Apps; -1 if not specified", "is_optional": false, "type": "int32" }, "web_app_header_light_color": { "description": "Default light header color for bot Web Apps; -1 if not specified", "is_optional": false, "type": "int32" } }, "type": "BotInfo" }, "botMediaPreview": { "description": "Describes media previews of a bot", "args": { "content": { "description": "Content of the preview; may only be of the types storyContentPhoto, storyContentVideo, or storyContentUnsupported", "is_optional": false, "type": "StoryContent" }, "date": { "description": "Point in time (Unix timestamp) when the preview was added or changed last time", "is_optional": false, "type": "int32" } }, "type": "BotMediaPreview" }, "botMediaPreviewInfo": { "description": "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", "args": { "language_codes": { "description": "List of language codes for which the bot has dedicated previews", "is_optional": false, "type": "vector\u003cstring\u003e" }, "previews": { "description": "List of media previews", "is_optional": false, "type": "vector\u003cbotMediaPreview\u003e" } }, "type": "BotMediaPreviewInfo" }, "botMediaPreviews": { "description": "Contains a list of media previews of a bot", "args": { "previews": { "description": "List of media previews", "is_optional": false, "type": "vector\u003cbotMediaPreview\u003e" } }, "type": "BotMediaPreviews" }, "botMenuButton": { "description": "Describes a button to be shown instead of bot commands menu button", "args": { "text": { "description": "Text of the button", "is_optional": false, "type": "string" }, "url": { "description": "URL of a Web App to open when the button is pressed. If the link is of the type internalLinkTypeWebApp, then it must be processed accordingly. Otherwise, the link must be passed to openWebApp", "is_optional": false, "type": "string" } }, "type": "BotMenuButton" }, "botVerification": { "description": "Describes verification status provided by a bot", "args": { "bot_user_id": { "description": "Identifier of the bot that provided the verification", "is_optional": false, "type": "int53" }, "custom_description": { "description": "Custom description of verification reason set by the bot. Can contain only Mention, Hashtag, Cashtag, PhoneNumber, BankCardNumber, TonAddress, Url, and EmailAddress entities", "is_optional": false, "type": "formattedText" }, "icon_custom_emoji_id": { "description": "Identifier of the custom emoji that is used as the verification sign", "is_optional": false, "type": "int64" } }, "type": "BotVerification" }, "botVerificationParameters": { "description": "Describes parameters of verification that is provided by a bot", "args": { "can_set_custom_description": { "description": "True, if the bot is allowed to provide custom description for verified entities", "is_optional": false, "type": "Bool" }, "default_custom_description": { "description": "Default custom description of verification reason to be used as placeholder in setMessageSenderBotVerification; may be null if none", "is_optional": true, "type": "formattedText" }, "icon_custom_emoji_id": { "description": "Identifier of the custom emoji that is used as the verification sign", "is_optional": false, "type": "int64" }, "organization_name": { "description": "Name of the organization that provides verification", "is_optional": false, "type": "string" } }, "type": "BotVerificationParameters" }, "botWriteAccessAllowReasonAcceptedRequest": { "description": "The user accepted bot's request to send messages with allowBotToSendMessages", "args": {}, "type": "BotWriteAccessAllowReason" }, "botWriteAccessAllowReasonAddedToAttachmentMenu": { "description": "The user added the bot to attachment or side menu using toggleBotIsAddedToAttachmentMenu", "args": {}, "type": "BotWriteAccessAllowReason" }, "botWriteAccessAllowReasonConnectedWebsite": { "description": "The user connected a website by logging in using Telegram Login Widget on it", "args": { "domain_name": { "description": "Domain name of the connected website", "is_optional": false, "type": "string" } }, "type": "BotWriteAccessAllowReason" }, "botWriteAccessAllowReasonLaunchedWebApp": { "description": "The user launched a Web App using getWebAppLinkUrl", "args": { "web_app": { "description": "Information about the Web App", "is_optional": false, "type": "webApp" } }, "type": "BotWriteAccessAllowReason" }, "builtInThemeArctic": { "description": "Arctic light theme", "args": {}, "type": "BuiltInTheme" }, "builtInThemeClassic": { "description": "Classic light theme", "args": {}, "type": "BuiltInTheme" }, "builtInThemeDay": { "description": "Regular light theme", "args": {}, "type": "BuiltInTheme" }, "builtInThemeNight": { "description": "Regular dark theme", "args": {}, "type": "BuiltInTheme" }, "builtInThemeTinted": { "description": "Tinted dark theme", "args": {}, "type": "BuiltInTheme" }, "businessAwayMessageScheduleAlways": { "description": "Send away messages always", "args": {}, "type": "BusinessAwayMessageSchedule" }, "businessAwayMessageScheduleCustom": { "description": "Send away messages only in the specified time span", "args": { "end_date": { "description": "Point in time (Unix timestamp) when the away messages will stop to be sent", "is_optional": false, "type": "int32" }, "start_date": { "description": "Point in time (Unix timestamp) when the away messages will start to be sent", "is_optional": false, "type": "int32" } }, "type": "BusinessAwayMessageSchedule" }, "businessAwayMessageScheduleOutsideOfOpeningHours": { "description": "Send away messages outside of the business opening hours", "args": {}, "type": "BusinessAwayMessageSchedule" }, "businessAwayMessageSettings": { "description": "Describes settings for messages that are automatically sent by a Telegram Business account when it is away", "args": { "offline_only": { "description": "True, if the messages must not be sent if the account was online in the last 10 minutes", "is_optional": false, "type": "Bool" }, "recipients": { "description": "Chosen recipients of the away messages", "is_optional": false, "type": "businessRecipients" }, "schedule": { "description": "Settings used to check whether the current user is away", "is_optional": false, "type": "BusinessAwayMessageSchedule" }, "shortcut_id": { "description": "Unique quick reply shortcut identifier for the away messages", "is_optional": false, "type": "int32" } }, "type": "BusinessAwayMessageSettings" }, "businessBotManageBar": { "description": "Contains information about a business bot that manages the chat", "args": { "bot_user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" }, "can_bot_reply": { "description": "True, if the bot can reply", "is_optional": false, "type": "Bool" }, "is_bot_paused": { "description": "True, if the bot is paused. Use toggleBusinessConnectedBotChatIsPaused to change the value of the field", "is_optional": false, "type": "Bool" }, "manage_url": { "description": "URL to be opened to manage the bot", "is_optional": false, "type": "string" } }, "type": "BusinessBotManageBar" }, "businessBotRights": { "description": "Describes rights of a business bot", "args": { "can_change_gift_settings": { "description": "True, if the bot can change gift receiving settings of the business account", "is_optional": false, "type": "Bool" }, "can_delete_all_messages": { "description": "True, if the bot can delete any message", "is_optional": false, "type": "Bool" }, "can_delete_sent_messages": { "description": "True, if the bot can delete sent messages", "is_optional": false, "type": "Bool" }, "can_edit_bio": { "description": "True, if the bot can edit bio of the business account", "is_optional": false, "type": "Bool" }, "can_edit_name": { "description": "True, if the bot can edit name of the business account", "is_optional": false, "type": "Bool" }, "can_edit_profile_photo": { "description": "True, if the bot can edit profile photo of the business account", "is_optional": false, "type": "Bool" }, "can_edit_username": { "description": "True, if the bot can edit username of the business account", "is_optional": false, "type": "Bool" }, "can_manage_stories": { "description": "True, if the bot can post, edit and delete stories", "is_optional": false, "type": "Bool" }, "can_read_messages": { "description": "True, if the bot can mark incoming private messages as read", "is_optional": false, "type": "Bool" }, "can_reply": { "description": "True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours", "is_optional": false, "type": "Bool" }, "can_sell_gifts": { "description": "True, if the bot can sell regular gifts received by the business account", "is_optional": false, "type": "Bool" }, "can_transfer_and_upgrade_gifts": { "description": "True, if the bot can transfer and upgrade gifts received by the business account", "is_optional": false, "type": "Bool" }, "can_transfer_stars": { "description": "True, if the bot can transfer Telegram Stars received by the business account to account of the bot, or use them to upgrade and transfer gifts", "is_optional": false, "type": "Bool" }, "can_view_gifts_and_stars": { "description": "True, if the bot can view gifts and Telegram Star amount owned by the business account", "is_optional": false, "type": "Bool" } }, "type": "BusinessBotRights" }, "businessChatLink": { "description": "Contains information about a business chat link", "args": { "link": { "description": "The HTTPS link", "is_optional": false, "type": "string" }, "text": { "description": "Message draft text that will be added to the input field", "is_optional": false, "type": "formattedText" }, "title": { "description": "Link title", "is_optional": false, "type": "string" }, "view_count": { "description": "Number of times the link was used", "is_optional": false, "type": "int32" } }, "type": "BusinessChatLink" }, "businessChatLinkInfo": { "description": "Contains information about a business chat link", "args": { "chat_id": { "description": "Identifier of the private chat that created the link", "is_optional": false, "type": "int53" }, "text": { "description": "Message draft text that must be added to the input field", "is_optional": false, "type": "formattedText" } }, "type": "BusinessChatLinkInfo" }, "businessChatLinks": { "description": "Contains a list of business chat links created by the user", "args": { "links": { "description": "List of links", "is_optional": false, "type": "vector\u003cbusinessChatLink\u003e" } }, "type": "BusinessChatLinks" }, "businessConnectedBot": { "description": "Describes a business bot connected to an account", "args": { "bot_user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" }, "recipients": { "description": "Private chats that will be accessible to the bot", "is_optional": false, "type": "businessRecipients" }, "rights": { "description": "Rights of the bot", "is_optional": false, "type": "businessBotRights" } }, "type": "BusinessConnectedBot" }, "businessConnectedBotInfo": { "description": "Describes a connection of a bot to an account", "args": { "bot": { "description": "Information about the bot", "is_optional": false, "type": "businessConnectedBot" }, "connection_date": { "description": "Point in time (Unix timestamp) when the bot was added; may be 0 if unknown", "is_optional": false, "type": "int32" }, "device_model": { "description": "Model of the device that was used for the bot connection, as provided by the application; may be empty if unknown", "is_optional": true, "type": "string" }, "location": { "description": "A human-readable description of the location from which the bot was connected, based on the IP address; may be empty if unknown", "is_optional": true, "type": "string" } }, "type": "BusinessConnectedBotInfo" }, "businessConnection": { "description": "Describes a connection of the bot with a business account", "args": { "date": { "description": "Point in time (Unix timestamp) when the connection was established", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the connection", "is_optional": false, "type": "string" }, "is_enabled": { "description": "True, if the connection is enabled; false otherwise", "is_optional": false, "type": "Bool" }, "rights": { "description": "Rights of the bot; may be null if the connection was disabled", "is_optional": true, "type": "businessBotRights" }, "user_chat_id": { "description": "Chat identifier of the private chat with the user", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the business user who created the connection", "is_optional": false, "type": "int53" } }, "type": "BusinessConnection" }, "businessFeatureAccountLinks": { "description": "The ability to create links to the business account with predefined message text", "args": {}, "type": "BusinessFeature" }, "businessFeatureAwayMessage": { "description": "The ability to set up an away message", "args": {}, "type": "BusinessFeature" }, "businessFeatureBots": { "description": "The ability to connect a bot to the account", "args": {}, "type": "BusinessFeature" }, "businessFeatureChatFolderTags": { "description": "The ability to display folder names for each chat in the chat list", "args": {}, "type": "BusinessFeature" }, "businessFeatureEmojiStatus": { "description": "The ability to show an emoji status along with the business name", "args": {}, "type": "BusinessFeature" }, "businessFeatureGreetingMessage": { "description": "The ability to set up a greeting message", "args": {}, "type": "BusinessFeature" }, "businessFeatureLocation": { "description": "The ability to set location", "args": {}, "type": "BusinessFeature" }, "businessFeatureOpeningHours": { "description": "The ability to set opening hours", "args": {}, "type": "BusinessFeature" }, "businessFeaturePromotionAnimation": { "description": "Describes a promotion animation for a Business feature", "args": { "animation": { "description": "Promotion animation for the feature", "is_optional": false, "type": "animation" }, "feature": { "description": "Business feature", "is_optional": false, "type": "BusinessFeature" } }, "type": "BusinessFeaturePromotionAnimation" }, "businessFeatureQuickReplies": { "description": "The ability to use quick replies", "args": {}, "type": "BusinessFeature" }, "businessFeatureStartPage": { "description": "The ability to customize start page", "args": {}, "type": "BusinessFeature" }, "businessFeatureUpgradedStories": { "description": "Allowed to use many additional features for stories", "args": {}, "type": "BusinessFeature" }, "businessFeatures": { "description": "Contains information about features, available to Business user accounts", "args": { "features": { "description": "The list of available business features", "is_optional": false, "type": "vector\u003cBusinessFeature\u003e" } }, "type": "BusinessFeatures" }, "businessGreetingMessageSettings": { "description": "Describes settings for greeting messages that are automatically sent by a Telegram Business account as response to incoming messages in an inactive private chat", "args": { "inactivity_days": { "description": "The number of days after which a chat will be considered as inactive; currently, must be one of 7, 14, 21, or 28", "is_optional": false, "type": "int32" }, "recipients": { "description": "Chosen recipients of the greeting messages", "is_optional": false, "type": "businessRecipients" }, "shortcut_id": { "description": "Unique quick reply shortcut identifier for the greeting messages", "is_optional": false, "type": "int32" } }, "type": "BusinessGreetingMessageSettings" }, "businessInfo": { "description": "Contains information about a Telegram Business account", "args": { "away_message_settings": { "description": "The away message; may be null if none or the Business account is not of the current user", "is_optional": true, "type": "businessAwayMessageSettings" }, "greeting_message_settings": { "description": "The greeting message; may be null if none or the Business account is not of the current user", "is_optional": true, "type": "businessGreetingMessageSettings" }, "local_opening_hours": { "description": "Opening hours of the business in the local time; may be null if none. The hours are guaranteed to be valid and have already been split by week days.", "is_optional": true, "type": "businessOpeningHours" }, "location": { "description": "Location of the business; may be null if none", "is_optional": true, "type": "businessLocation" }, "next_close_in": { "description": "Time left before the business will close the next time, in seconds; 0 if unknown. An updateUserFullInfo update is not triggered when value of this field changes", "is_optional": false, "type": "int32" }, "next_open_in": { "description": "Time left before the business will open the next time, in seconds; 0 if unknown. An updateUserFullInfo update is not triggered when value of this field changes", "is_optional": false, "type": "int32" }, "opening_hours": { "description": "Opening hours of the business; may be null if none. The hours are guaranteed to be valid and have already been split by week days", "is_optional": true, "type": "businessOpeningHours" }, "start_page": { "description": "Information about start page of the account; may be null if none", "is_optional": true, "type": "businessStartPage" } }, "type": "BusinessInfo" }, "businessLocation": { "description": "Represents a location of a business", "args": { "address": { "description": "Location address; 1-96 characters", "is_optional": false, "type": "string" }, "location": { "description": "The location; may be null if not specified", "is_optional": true, "type": "location" } }, "type": "BusinessLocation" }, "businessMessage": { "description": "Describes a message from a business account as received by a bot", "args": { "message": { "description": "The message", "is_optional": false, "type": "message" }, "reply_to_message": { "description": "Message that is replied by the message in the same chat; may be null if none", "is_optional": true, "type": "message" } }, "type": "BusinessMessage" }, "businessMessages": { "description": "Contains a list of messages from a business account as received by a bot", "args": { "messages": { "description": "List of business messages", "is_optional": false, "type": "vector\u003cbusinessMessage\u003e" } }, "type": "BusinessMessages" }, "businessOpeningHours": { "description": "Describes opening hours of a business", "args": { "opening_hours": { "description": "Intervals of the time when the business is open", "is_optional": false, "type": "vector\u003cbusinessOpeningHoursInterval\u003e" }, "time_zone_id": { "description": "Unique time zone identifier", "is_optional": false, "type": "string" } }, "type": "BusinessOpeningHours" }, "businessOpeningHoursInterval": { "description": "Describes an interval of time when the business is open", "args": { "end_minute": { "description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 1-8*24*60", "is_optional": false, "type": "int32" }, "start_minute": { "description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0-7*24*60", "is_optional": false, "type": "int32" } }, "type": "BusinessOpeningHoursInterval" }, "businessRecipients": { "description": "Describes private chats chosen for automatic interaction with a business", "args": { "chat_ids": { "description": "Identifiers of selected private chats", "is_optional": false, "type": "vector\u003cint53\u003e" }, "exclude_selected": { "description": "If true, then all private chats except the selected are chosen. Otherwise, only the selected chats are chosen", "is_optional": false, "type": "Bool" }, "excluded_chat_ids": { "description": "Identifiers of private chats that are always excluded; for businessConnectedBot only", "is_optional": false, "type": "vector\u003cint53\u003e" }, "select_contacts": { "description": "True, if all private chats with contacts are selected", "is_optional": false, "type": "Bool" }, "select_existing_chats": { "description": "True, if all existing private chats are selected", "is_optional": false, "type": "Bool" }, "select_new_chats": { "description": "True, if all new private chats are selected", "is_optional": false, "type": "Bool" }, "select_non_contacts": { "description": "True, if all private chats with non-contacts are selected", "is_optional": false, "type": "Bool" } }, "type": "BusinessRecipients" }, "businessStartPage": { "description": "Describes settings for a business account start page", "args": { "message": { "description": "Message text of the start page", "is_optional": false, "type": "string" }, "sticker": { "description": "Greeting sticker of the start page; may be null if none", "is_optional": true, "type": "sticker" }, "title": { "description": "Title text of the start page", "is_optional": false, "type": "string" } }, "type": "BusinessStartPage" }, "buttonStyleDanger": { "description": "The button has red color", "args": {}, "type": "ButtonStyle" }, "buttonStyleDefault": { "description": "The button has default style", "args": {}, "type": "ButtonStyle" }, "buttonStyleLink": { "description": "The button must be shown as a link. The style is allowed only for callback buttons in inlineButton", "args": {}, "type": "ButtonStyle" }, "buttonStylePrimary": { "description": "The button has dark blue color", "args": {}, "type": "ButtonStyle" }, "buttonStyleSuccess": { "description": "The button has green color", "args": {}, "type": "ButtonStyle" }, "call": { "description": "Describes a call", "args": { "id": { "description": "Call identifier, not persistent", "is_optional": false, "type": "int32" }, "is_outgoing": { "description": "True, if the call is outgoing", "is_optional": false, "type": "Bool" }, "is_video": { "description": "True, if the call is a video call", "is_optional": false, "type": "Bool" }, "state": { "description": "Call state", "is_optional": false, "type": "CallState" }, "unique_id": { "description": "Persistent unique call identifier; 0 if isn't assigned yet by the server", "is_optional": false, "type": "int64" }, "user_id": { "description": "User identifier of the other call participant", "is_optional": false, "type": "int53" } }, "type": "Call" }, "callDiscardReasonDeclined": { "description": "The call was ended before the conversation started. It was declined by the other party", "args": {}, "type": "CallDiscardReason" }, "callDiscardReasonDisconnected": { "description": "The call was ended during the conversation because the users were disconnected", "args": {}, "type": "CallDiscardReason" }, "callDiscardReasonEmpty": { "description": "The call wasn't discarded, or the reason is unknown", "args": {}, "type": "CallDiscardReason" }, "callDiscardReasonHungUp": { "description": "The call was ended because one of the parties hung up", "args": {}, "type": "CallDiscardReason" }, "callDiscardReasonMissed": { "description": "The call was ended before the conversation started. It was canceled by the caller or missed by the other party", "args": {}, "type": "CallDiscardReason" }, "callDiscardReasonUpgradeToGroupCall": { "description": "The call was ended because it has been upgraded to a group call", "args": { "invite_link": { "description": "Invite link for the group call", "is_optional": false, "type": "string" } }, "type": "CallDiscardReason" }, "callId": { "description": "Contains the call identifier", "args": { "id": { "description": "Call identifier", "is_optional": false, "type": "int32" } }, "type": "CallId" }, "callProblemDistortedSpeech": { "description": "The speech was distorted", "args": {}, "type": "CallProblem" }, "callProblemDistortedVideo": { "description": "The video was distorted", "args": {}, "type": "CallProblem" }, "callProblemDropped": { "description": "The call ended unexpectedly", "args": {}, "type": "CallProblem" }, "callProblemEcho": { "description": "The user heard their own voice", "args": {}, "type": "CallProblem" }, "callProblemInterruptions": { "description": "The other side kept disappearing", "args": {}, "type": "CallProblem" }, "callProblemNoise": { "description": "The user heard background noise", "args": {}, "type": "CallProblem" }, "callProblemPixelatedVideo": { "description": "The video was pixelated", "args": {}, "type": "CallProblem" }, "callProblemSilentLocal": { "description": "The user couldn't hear the other side", "args": {}, "type": "CallProblem" }, "callProblemSilentRemote": { "description": "The other side couldn't hear the user", "args": {}, "type": "CallProblem" }, "callProtocol": { "description": "Specifies the supported call protocols", "args": { "library_versions": { "description": "List of supported tgcalls versions", "is_optional": false, "type": "vector\u003cstring\u003e" }, "max_layer": { "description": "The maximum supported API layer; use 92", "is_optional": false, "type": "int32" }, "min_layer": { "description": "The minimum supported API layer; use 65", "is_optional": false, "type": "int32" }, "udp_p2p": { "description": "True, if UDP peer-to-peer connections are supported", "is_optional": false, "type": "Bool" }, "udp_reflector": { "description": "True, if connection through UDP reflectors is supported", "is_optional": false, "type": "Bool" } }, "type": "CallProtocol" }, "callServer": { "description": "Describes a server for relaying call data", "args": { "id": { "description": "Server identifier", "is_optional": false, "type": "int64" }, "ip_address": { "description": "Server IPv4 address", "is_optional": false, "type": "string" }, "ipv6_address": { "description": "Server IPv6 address", "is_optional": false, "type": "string" }, "port": { "description": "Server port number", "is_optional": false, "type": "int32" }, "type": { "description": "Server type", "is_optional": false, "type": "CallServerType" } }, "type": "CallServer" }, "callServerTypeTelegramReflector": { "description": "A Telegram call reflector", "args": { "is_tcp": { "description": "True, if the server uses TCP instead of UDP", "is_optional": false, "type": "Bool" }, "peer_tag": { "description": "A peer tag to be used with the reflector", "is_optional": false, "type": "bytes" } }, "type": "CallServerType" }, "callServerTypeWebrtc": { "description": "A WebRTC server", "args": { "password": { "description": "Authentication password", "is_optional": false, "type": "string" }, "supports_stun": { "description": "True, if the server supports STUN", "is_optional": false, "type": "Bool" }, "supports_turn": { "description": "True, if the server supports TURN", "is_optional": false, "type": "Bool" }, "username": { "description": "Username to be used for authentication", "is_optional": false, "type": "string" } }, "type": "CallServerType" }, "callStateDiscarded": { "description": "The call has ended successfully", "args": { "need_debug_information": { "description": "True, if the call debug information must be sent to the server", "is_optional": false, "type": "Bool" }, "need_log": { "description": "True, if the call log must be sent to the server", "is_optional": false, "type": "Bool" }, "need_rating": { "description": "True, if the call rating must be sent to the server", "is_optional": false, "type": "Bool" }, "reason": { "description": "The reason why the call has ended", "is_optional": false, "type": "CallDiscardReason" } }, "type": "CallState" }, "callStateError": { "description": "The call has ended with an error", "args": { "error": { "description": "Error. An error with the code 4005000 will be returned if an outgoing call is missed because of an expired timeout", "is_optional": false, "type": "error" } }, "type": "CallState" }, "callStateExchangingKeys": { "description": "The call has been answered and encryption keys are being exchanged", "args": {}, "type": "CallState" }, "callStateHangingUp": { "description": "The call is hanging up after discardCall has been called", "args": {}, "type": "CallState" }, "callStatePending": { "description": "The call is pending, waiting to be accepted by a user", "args": { "is_created": { "description": "True, if the call has already been created by the server", "is_optional": false, "type": "Bool" }, "is_received": { "description": "True, if the call has already been received by the other party", "is_optional": false, "type": "Bool" } }, "type": "CallState" }, "callStateReady": { "description": "The call is ready to use", "args": { "allow_p2p": { "description": "True, if peer-to-peer connection is allowed by users privacy settings", "is_optional": false, "type": "Bool" }, "config": { "description": "A JSON-encoded call config", "is_optional": false, "type": "string" }, "custom_parameters": { "description": "Custom JSON-encoded call parameters to be passed to tgcalls", "is_optional": false, "type": "string" }, "emojis": { "description": "Encryption key fingerprint represented as 4 emoji", "is_optional": false, "type": "vector\u003cstring\u003e" }, "encryption_key": { "description": "Call encryption key", "is_optional": false, "type": "bytes" }, "is_group_call_supported": { "description": "True, if the other party supports upgrading of the call to a group call", "is_optional": false, "type": "Bool" }, "protocol": { "description": "Call protocols supported by the other call participant", "is_optional": false, "type": "callProtocol" }, "servers": { "description": "List of available call servers", "is_optional": false, "type": "vector\u003ccallServer\u003e" } }, "type": "CallState" }, "callbackQueryAnswer": { "description": "Contains a bot's answer to a callback query", "args": { "show_alert": { "description": "True, if an alert must be shown to the user instead of a toast notification", "is_optional": false, "type": "Bool" }, "text": { "description": "Text of the answer", "is_optional": false, "type": "string" }, "url": { "description": "URL to be opened", "is_optional": false, "type": "string" } }, "type": "CallbackQueryAnswer" }, "callbackQueryPayloadData": { "description": "The payload for a general callback button", "args": { "data": { "description": "Data that was attached to the callback button", "is_optional": false, "type": "bytes" } }, "type": "CallbackQueryPayload" }, "callbackQueryPayloadDataWithPassword": { "description": "The payload for a callback button requiring password", "args": { "data": { "description": "Data that was attached to the callback button", "is_optional": false, "type": "bytes" }, "password": { "description": "The 2-step verification password for the current user", "is_optional": false, "type": "string" } }, "type": "CallbackQueryPayload" }, "callbackQueryPayloadGame": { "description": "The payload for a game callback button", "args": { "game_short_name": { "description": "A short name of the game that was attached to the callback button", "is_optional": false, "type": "string" } }, "type": "CallbackQueryPayload" }, "canPostStoryResultActiveStoryLimitExceeded": { "description": "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", "args": {}, "type": "CanPostStoryResult" }, "canPostStoryResultBoostNeeded": { "description": "The chat must be boosted first by Telegram Premium subscribers to post more stories. Call getChatBoostStatus to get current boost status of the chat", "args": {}, "type": "CanPostStoryResult" }, "canPostStoryResultLiveStoryIsActive": { "description": "The user or the chat has an active live story. The live story must be deleted first", "args": { "story_id": { "description": "Identifier of the active live story", "is_optional": false, "type": "int32" } }, "type": "CanPostStoryResult" }, "canPostStoryResultMonthlyLimitExceeded": { "description": "The monthly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time", "args": { "retry_after": { "description": "Time left before the user can post the next story, in seconds", "is_optional": false, "type": "int32" } }, "type": "CanPostStoryResult" }, "canPostStoryResultOk": { "description": "A story can be sent", "args": { "story_count": { "description": "Number of stories that can be posted by the user", "is_optional": false, "type": "int32" } }, "type": "CanPostStoryResult" }, "canPostStoryResultPremiumNeeded": { "description": "The user must subscribe to Telegram Premium to be able to post stories", "args": {}, "type": "CanPostStoryResult" }, "canPostStoryResultWeeklyLimitExceeded": { "description": "The weekly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time", "args": { "retry_after": { "description": "Time left before the user can post the next story, in seconds", "is_optional": false, "type": "int32" } }, "type": "CanPostStoryResult" }, "canSendGiftResultFail": { "description": "The gift can't be sent now by the current user", "args": { "reason": { "description": "Reason to be shown to the user", "is_optional": false, "type": "formattedText" } }, "type": "CanSendGiftResult" }, "canSendGiftResultOk": { "description": "The gift can be sent now by the current user", "args": {}, "type": "CanSendGiftResult" }, "canSendMessageToUserResultOk": { "description": "The user can be messaged", "args": {}, "type": "CanSendMessageToUserResult" }, "canSendMessageToUserResultUserHasPaidMessages": { "description": "The user can be messaged, but the messages are paid", "args": { "outgoing_paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by the current user for each sent message to the user", "is_optional": false, "type": "int53" } }, "type": "CanSendMessageToUserResult" }, "canSendMessageToUserResultUserIsDeleted": { "description": "The user can't be messaged, because they are deleted or unknown", "args": {}, "type": "CanSendMessageToUserResult" }, "canSendMessageToUserResultUserRestrictsNewChats": { "description": "The user can't be messaged, because they restrict new chats with non-contacts", "args": {}, "type": "CanSendMessageToUserResult" }, "canTransferOwnershipResultOk": { "description": "The session can be used", "args": {}, "type": "CanTransferOwnershipResult" }, "canTransferOwnershipResultPasswordNeeded": { "description": "The 2-step verification needs to be enabled first", "args": {}, "type": "CanTransferOwnershipResult" }, "canTransferOwnershipResultPasswordTooFresh": { "description": "The 2-step verification was enabled recently, user needs to wait", "args": { "retry_after": { "description": "Time left before the session can be used to transfer ownership of a chat, in seconds", "is_optional": false, "type": "int32" } }, "type": "CanTransferOwnershipResult" }, "canTransferOwnershipResultSessionTooFresh": { "description": "The session was created recently, user needs to wait", "args": { "retry_after": { "description": "Time left before the session can be used to transfer ownership of a chat, in seconds", "is_optional": false, "type": "int32" } }, "type": "CanTransferOwnershipResult" }, "chat": { "description": "A chat. (Can be a private chat, basic group, supergroup, or secret chat)", "args": { "accent_color_id": { "description": "Identifier of the accent color for message sender name, and backgrounds of chat photo, reply header, and link preview", "is_optional": false, "type": "int32" }, "action_bar": { "description": "Information about actions which must be possible to do through the chat action bar; may be null if none", "is_optional": true, "type": "ChatActionBar" }, "available_reactions": { "description": "Types of reaction, available in the chat", "is_optional": false, "type": "ChatAvailableReactions" }, "background": { "description": "Background set for the chat; may be null if none", "is_optional": true, "type": "chatBackground" }, "background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the reply header and link preview background for messages sent by the chat; 0 if none", "is_optional": false, "type": "int64" }, "block_list": { "description": "Block list to which the chat is added; may be null if none", "is_optional": true, "type": "BlockList" }, "business_bot_manage_bar": { "description": "Information about bar for managing a business bot in the chat; may be null if none", "is_optional": true, "type": "businessBotManageBar" }, "can_be_deleted_for_all_users": { "description": "True, if the chat messages can be deleted for all users", "is_optional": false, "type": "Bool" }, "can_be_deleted_only_for_self": { "description": "True, if the chat messages can be deleted only for the current user while other users will continue to see the messages", "is_optional": false, "type": "Bool" }, "can_be_reported": { "description": "True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto", "is_optional": false, "type": "Bool" }, "chat_lists": { "description": "Chat lists to which the chat belongs. A chat can have a non-zero position in a chat list even if it doesn't belong to the chat list and have no position in a chat list even if it belongs to the chat list", "is_optional": false, "type": "vector\u003cChatList\u003e" }, "client_data": { "description": "Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used", "is_optional": false, "type": "string" }, "default_disable_notification": { "description": "Default value of the disable_notification parameter, used when a message is sent to the chat", "is_optional": false, "type": "Bool" }, "draft_message": { "description": "A draft of a message in the chat; may be null if none", "is_optional": true, "type": "draftMessage" }, "emoji_status": { "description": "Emoji status to be shown along with chat title; may be null", "is_optional": true, "type": "emojiStatus" }, "has_protected_content": { "description": "True, if chat content can't be saved locally, forwarded, or copied", "is_optional": false, "type": "Bool" }, "has_scheduled_messages": { "description": "True, if the chat has scheduled messages", "is_optional": false, "type": "Bool" }, "has_welcome_messages": { "description": "True, if the chat has welcome messages; for chat administrators with can_change_info administrator right only", "is_optional": false, "type": "Bool" }, "id": { "description": "Chat unique identifier", "is_optional": false, "type": "int53" }, "is_marked_as_unread": { "description": "True, if the chat is marked as unread", "is_optional": false, "type": "Bool" }, "is_translatable": { "description": "True, if translation of all messages in the chat must be suggested to the user", "is_optional": false, "type": "Bool" }, "last_message": { "description": "Last message in the chat; may be null if none or unknown", "is_optional": true, "type": "message" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming message", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of the last read outgoing message", "is_optional": false, "type": "int53" }, "message_auto_delete_time": { "description": "Current message auto-delete or self-destruct timer setting for the chat, in seconds; 0 if disabled. Self-destruct timer in secret chats starts after the message or its content is viewed. Auto-delete timer in other chats starts from the send date", "is_optional": false, "type": "int32" }, "message_sender_id": { "description": "Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can't change message sender", "is_optional": true, "type": "MessageSender" }, "notification_settings": { "description": "Notification settings for the chat", "is_optional": false, "type": "chatNotificationSettings" }, "pending_join_requests": { "description": "Information about pending join requests; may be null if none", "is_optional": true, "type": "chatJoinRequestsInfo" }, "permissions": { "description": "Actions that non-administrator chat members are allowed to take in the chat", "is_optional": false, "type": "chatPermissions" }, "photo": { "description": "Chat photo; may be null", "is_optional": true, "type": "chatPhotoInfo" }, "positions": { "description": "Positions of the chat in chat lists", "is_optional": false, "type": "vector\u003cchatPosition\u003e" }, "profile_accent_color_id": { "description": "Identifier of the profile accent color for the chat's profile; -1 if none", "is_optional": false, "type": "int32" }, "profile_background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the background of the chat's profile; 0 if none", "is_optional": false, "type": "int64" }, "reply_markup_message_id": { "description": "Identifier of the message from which reply markup needs to be used; 0 if there is no reply markup in the chat", "is_optional": false, "type": "int53" }, "theme": { "description": "Theme set for the chat; may be null if none", "is_optional": true, "type": "ChatTheme" }, "title": { "description": "Chat title", "is_optional": false, "type": "string" }, "type": { "description": "Type of the chat", "is_optional": false, "type": "ChatType" }, "unread_count": { "description": "Number of unread messages in the chat", "is_optional": false, "type": "int32" }, "unread_mention_count": { "description": "Number of unread messages with a mention/reply in the chat", "is_optional": false, "type": "int32" }, "unread_poll_vote_count": { "description": "Number of messages with unread poll votes in the chat", "is_optional": false, "type": "int32" }, "unread_reaction_count": { "description": "Number of messages with unread reactions in the chat", "is_optional": false, "type": "int32" }, "upgraded_gift_colors": { "description": "Color scheme based on an upgraded gift to be used for the chat instead of accent_color_id and background_custom_emoji_id; may be null if none", "is_optional": true, "type": "upgradedGiftColors" }, "video_chat": { "description": "Information about video chat of the chat", "is_optional": false, "type": "videoChat" }, "view_as_topics": { "description": "True, if the chat is a forum supergroup that must be shown in the \"View as topics\" mode, or Saved Messages chat that must be shown in the \"View as chats\"", "is_optional": false, "type": "Bool" } }, "type": "Chat" }, "chatActionBarAddContact": { "description": "The chat is a private or secret chat and the other user can be added to the contact list using the method addContact", "args": {}, "type": "ChatActionBar" }, "chatActionBarInviteMembers": { "description": "The chat is a recently created group chat to which new members can be invited", "args": {}, "type": "ChatActionBar" }, "chatActionBarJoinRequest": { "description": "The chat is a private chat with an administrator of a chat to which the user sent join request", "args": { "is_channel": { "description": "True, if the join request was sent to a channel chat", "is_optional": false, "type": "Bool" }, "request_date": { "description": "Point in time (Unix timestamp) when the join request was sent", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the chat to which the join request was sent", "is_optional": false, "type": "string" } }, "type": "ChatActionBar" }, "chatActionBarReportAddBlock": { "description": "The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method setMessageSenderBlockList,", "args": { "account_info": { "description": "Basic information about the other user in the chat; may be null if unknown", "is_optional": true, "type": "accountInfo" }, "can_unarchive": { "description": "If true, the chat was automatically archived and can be moved back to the main chat list using addChatToList simultaneously with setting chat notification settings to default using setChatNotificationSettings", "is_optional": false, "type": "Bool" } }, "type": "ChatActionBar" }, "chatActionBarReportSpam": { "description": "The chat can be reported as spam using the method reportChat 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", "args": { "can_unarchive": { "description": "If true, the chat was automatically archived and can be moved back to the main chat list using addChatToList simultaneously with setting chat notification settings to default using setChatNotificationSettings", "is_optional": false, "type": "Bool" } }, "type": "ChatActionBar" }, "chatActionBarSharePhoneNumber": { "description": "The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other user using the method sharePhoneNumber", "args": {}, "type": "ChatActionBar" }, "chatActionCancel": { "description": "The user has canceled the previous action", "args": {}, "type": "ChatAction" }, "chatActionChoosingContact": { "description": "The user is picking a contact to send", "args": {}, "type": "ChatAction" }, "chatActionChoosingLocation": { "description": "The user is picking a location or venue to send", "args": {}, "type": "ChatAction" }, "chatActionChoosingSticker": { "description": "The user is picking a sticker to send", "args": {}, "type": "ChatAction" }, "chatActionRecordingVideo": { "description": "The user is recording a video", "args": {}, "type": "ChatAction" }, "chatActionRecordingVideoNote": { "description": "The user is recording a video note", "args": {}, "type": "ChatAction" }, "chatActionRecordingVoiceNote": { "description": "The user is recording a voice note", "args": {}, "type": "ChatAction" }, "chatActionStartPlayingGame": { "description": "The user has started to play a game", "args": {}, "type": "ChatAction" }, "chatActionTyping": { "description": "The user is typing a message", "args": {}, "type": "ChatAction" }, "chatActionUploadingDocument": { "description": "The user is uploading a document", "args": { "progress": { "description": "Upload progress, as a percentage", "is_optional": false, "type": "int32" } }, "type": "ChatAction" }, "chatActionUploadingPhoto": { "description": "The user is uploading a photo", "args": { "progress": { "description": "Upload progress, as a percentage", "is_optional": false, "type": "int32" } }, "type": "ChatAction" }, "chatActionUploadingVideo": { "description": "The user is uploading a video", "args": { "progress": { "description": "Upload progress, as a percentage", "is_optional": false, "type": "int32" } }, "type": "ChatAction" }, "chatActionUploadingVideoNote": { "description": "The user is uploading a video note", "args": { "progress": { "description": "Upload progress, as a percentage", "is_optional": false, "type": "int32" } }, "type": "ChatAction" }, "chatActionUploadingVoiceNote": { "description": "The user is uploading a voice note", "args": { "progress": { "description": "Upload progress, as a percentage", "is_optional": false, "type": "int32" } }, "type": "ChatAction" }, "chatActionWatchingAnimations": { "description": "The user is watching animations sent by the other party by clicking on an animated emoji", "args": { "emoji": { "description": "The animated emoji", "is_optional": false, "type": "string" } }, "type": "ChatAction" }, "chatActiveStories": { "description": "Describes active stories posted by a chat", "args": { "can_be_archived": { "description": "True, if the stories are shown in the main story list and can be archived; otherwise, the stories can be hidden from the main story list", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Identifier of the chat that posted the stories", "is_optional": false, "type": "int53" }, "list": { "description": "Identifier of the story list in which the stories are shown; may be null if the stories aren't shown in a story list", "is_optional": true, "type": "StoryList" }, "max_read_story_id": { "description": "Identifier of the last read active story", "is_optional": false, "type": "int32" }, "order": { "description": "A parameter used to determine order of the stories in the story list; 0 if the stories don't need to be shown in the story list. Stories must be sorted by the pair (order, story_poster_chat_id) in descending order", "is_optional": false, "type": "int53" }, "stories": { "description": "Basic information about the stories; use getStory to get full information about the stories. The stories are in chronological order (i.e., in order of increasing story identifiers)", "is_optional": false, "type": "vector\u003cstoryInfo\u003e" } }, "type": "ChatActiveStories" }, "chatAdministrator": { "description": "Contains information about a chat administrator", "args": { "can_be_edited": { "description": "True, if the current user can edit the administrator privileges for the administrator", "is_optional": false, "type": "Bool" }, "custom_title": { "description": "Custom title of the administrator", "is_optional": false, "type": "string" }, "is_owner": { "description": "True, if the user is the owner of the chat", "is_optional": false, "type": "Bool" }, "user_id": { "description": "User identifier of the administrator", "is_optional": false, "type": "int53" } }, "type": "ChatAdministrator" }, "chatAdministratorRights": { "description": "Describes rights of the administrator", "args": { "can_change_info": { "description": "True, if the administrator can change the chat title, photo, and other settings", "is_optional": false, "type": "Bool" }, "can_delete_messages": { "description": "True, if the administrator can delete messages of other users", "is_optional": false, "type": "Bool" }, "can_delete_stories": { "description": "True, if the administrator can delete stories posted by other users; applicable to supergroups and channels only", "is_optional": false, "type": "Bool" }, "can_edit_messages": { "description": "True, if the administrator can edit messages of other users and pin messages; applicable to channels only", "is_optional": false, "type": "Bool" }, "can_edit_stories": { "description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access story archive; applicable to supergroups and channels only", "is_optional": false, "type": "Bool" }, "can_invite_users": { "description": "True, if the administrator can invite new users to the chat", "is_optional": false, "type": "Bool" }, "can_manage_chat": { "description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report supergroup spam messages,", "is_optional": false, "type": "Bool" }, "can_manage_direct_messages": { "description": "True, if the administrator can answer to channel direct messages; applicable to channels only", "is_optional": false, "type": "Bool" }, "can_manage_tags": { "description": "True, if the administrator can change tags of other users; applicable to basic groups and supergroups only", "is_optional": false, "type": "Bool" }, "can_manage_topics": { "description": "True, if the administrator can create, rename, close, reopen, hide, and unhide forum topics; applicable to forum supergroups only", "is_optional": false, "type": "Bool" }, "can_manage_video_chats": { "description": "True, if the administrator can manage video chats", "is_optional": false, "type": "Bool" }, "can_pin_messages": { "description": "True, if the administrator can pin messages; applicable to basic groups and supergroups only", "is_optional": false, "type": "Bool" }, "can_post_messages": { "description": "True, if the administrator can create channel posts, approve suggested channel posts, or view channel statistics; applicable to channels only", "is_optional": false, "type": "Bool" }, "can_post_stories": { "description": "True, if the administrator can create new chat stories, or edit and delete posted stories; applicable to supergroups and channels only", "is_optional": false, "type": "Bool" }, "can_promote_members": { "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that were directly or indirectly promoted by them; applicable to supergroups and channels only", "is_optional": false, "type": "Bool" }, "can_restrict_members": { "description": "True, if the administrator can restrict, ban, or unban chat members or view supergroup statistics", "is_optional": false, "type": "Bool" }, "can_send_welcome_messages": { "description": "True, if the administrator can manage and send welcome messages", "is_optional": false, "type": "Bool" }, "is_anonymous": { "description": "True, if the administrator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only", "is_optional": false, "type": "Bool" } }, "type": "ChatAdministratorRights" }, "chatAdministrators": { "description": "Represents a list of chat administrators", "args": { "administrators": { "description": "A list of chat administrators", "is_optional": false, "type": "vector\u003cchatAdministrator\u003e" } }, "type": "ChatAdministrators" }, "chatAvailableReactionsAll": { "description": "All reactions are available in the chat, excluding the paid reaction and custom reactions in channel chats", "args": { "max_reaction_count": { "description": "The maximum allowed number of reactions per message; 1-11", "is_optional": false, "type": "int32" } }, "type": "ChatAvailableReactions" }, "chatAvailableReactionsSome": { "description": "Only specific reactions are available in the chat", "args": { "max_reaction_count": { "description": "The maximum allowed number of reactions per message; 1-11", "is_optional": false, "type": "int32" }, "reactions": { "description": "The list of reactions", "is_optional": false, "type": "vector\u003cReactionType\u003e" } }, "type": "ChatAvailableReactions" }, "chatBackground": { "description": "Describes a background set for a specific chat", "args": { "background": { "description": "The background", "is_optional": false, "type": "background" }, "dark_theme_dimming": { "description": "Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background", "is_optional": false, "type": "int32" } }, "type": "ChatBackground" }, "chatBoost": { "description": "Describes a boost applied to a chat", "args": { "count": { "description": "The number of identical boosts applied", "is_optional": false, "type": "int32" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the boost will expire", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the boost", "is_optional": false, "type": "string" }, "source": { "description": "Source of the boost", "is_optional": false, "type": "ChatBoostSource" }, "start_date": { "description": "Point in time (Unix timestamp) when the chat was boosted", "is_optional": false, "type": "int32" } }, "type": "ChatBoost" }, "chatBoostFeatures": { "description": "Contains a list of features available on the first chat boost levels", "args": { "features": { "description": "The list of features", "is_optional": false, "type": "vector\u003cchatBoostLevelFeatures\u003e" }, "min_automatic_translation_boost_level": { "description": "The minimum boost level allowing to enable automatic translation of messages for non-Premium users; for channel chats only", "is_optional": false, "type": "int32" }, "min_background_custom_emoji_boost_level": { "description": "The minimum boost level required to set custom emoji for reply header and link preview background; for channel chats only", "is_optional": false, "type": "int32" }, "min_chat_theme_background_boost_level": { "description": "The minimum boost level required to set a chat theme background as chat background", "is_optional": false, "type": "int32" }, "min_custom_background_boost_level": { "description": "The minimum boost level required to set custom chat background", "is_optional": false, "type": "int32" }, "min_custom_emoji_sticker_set_boost_level": { "description": "The minimum boost level required to set custom emoji sticker set for the chat; for supergroup chats only", "is_optional": false, "type": "int32" }, "min_emoji_status_boost_level": { "description": "The minimum boost level required to set emoji status", "is_optional": false, "type": "int32" }, "min_profile_background_custom_emoji_boost_level": { "description": "The minimum boost level required to set custom emoji for profile background", "is_optional": false, "type": "int32" }, "min_speech_recognition_boost_level": { "description": "The minimum boost level allowing to recognize speech in video note and voice note messages for non-Premium users; for supergroup chats only", "is_optional": false, "type": "int32" }, "min_sponsored_message_disable_boost_level": { "description": "The minimum boost level allowing to disable sponsored messages in the chat; for channel chats only", "is_optional": false, "type": "int32" } }, "type": "ChatBoostFeatures" }, "chatBoostLevelFeatures": { "description": "Contains a list of features available on a specific chat boost level", "args": { "accent_color_count": { "description": "Number of custom colors for background of empty chat photo, replies to messages and link previews", "is_optional": false, "type": "int32" }, "can_disable_sponsored_messages": { "description": "True, if sponsored messages can be disabled in the chat", "is_optional": false, "type": "Bool" }, "can_enable_automatic_translation": { "description": "True, if automatic translation of messages can be enabled in the chat", "is_optional": false, "type": "Bool" }, "can_recognize_speech": { "description": "True, if speech recognition can be used for video note and voice note messages by all users", "is_optional": false, "type": "Bool" }, "can_set_background_custom_emoji": { "description": "True, if custom emoji for reply header and link preview background can be set", "is_optional": false, "type": "Bool" }, "can_set_custom_background": { "description": "True, if custom background can be set in the chat for all users", "is_optional": false, "type": "Bool" }, "can_set_custom_emoji_sticker_set": { "description": "True, if custom emoji sticker set can be set for the chat", "is_optional": false, "type": "Bool" }, "can_set_emoji_status": { "description": "True, if emoji status can be set", "is_optional": false, "type": "Bool" }, "can_set_profile_background_custom_emoji": { "description": "True, if custom emoji for profile background can be set", "is_optional": false, "type": "Bool" }, "chat_theme_background_count": { "description": "Number of chat theme backgrounds that can be set as chat background", "is_optional": false, "type": "int32" }, "custom_emoji_reaction_count": { "description": "Number of custom emoji reactions that can be added to the list of available reactions", "is_optional": false, "type": "int32" }, "level": { "description": "Target chat boost level", "is_optional": false, "type": "int32" }, "profile_accent_color_count": { "description": "Number of custom colors for profile photo background", "is_optional": false, "type": "int32" }, "story_per_day_count": { "description": "Number of stories that the chat can publish daily", "is_optional": false, "type": "int32" }, "title_color_count": { "description": "Number of custom colors for chat title", "is_optional": false, "type": "int32" } }, "type": "ChatBoostLevelFeatures" }, "chatBoostLink": { "description": "Contains an HTTPS link to boost a chat", "args": { "is_public": { "description": "True, if the link will work for non-members of the chat", "is_optional": false, "type": "Bool" }, "link": { "description": "The link", "is_optional": false, "type": "string" } }, "type": "ChatBoostLink" }, "chatBoostLinkInfo": { "description": "Contains information about a link to boost a chat", "args": { "chat_id": { "description": "Identifier of the chat to which the link points; 0 if the chat isn't found", "is_optional": false, "type": "int53" }, "is_public": { "description": "True, if the link will work for non-members of the chat", "is_optional": false, "type": "Bool" } }, "type": "ChatBoostLinkInfo" }, "chatBoostSlot": { "description": "Describes a slot for chat boost", "args": { "cooldown_until_date": { "description": "Point in time (Unix timestamp) after which the boost can be used for another chat", "is_optional": false, "type": "int32" }, "currently_boosted_chat_id": { "description": "Identifier of the currently boosted chat; 0 if none", "is_optional": false, "type": "int53" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the boost will expire", "is_optional": false, "type": "int32" }, "slot_id": { "description": "Unique identifier of the slot", "is_optional": false, "type": "int32" }, "start_date": { "description": "Point in time (Unix timestamp) when the chat was boosted; 0 if none", "is_optional": false, "type": "int32" } }, "type": "ChatBoostSlot" }, "chatBoostSlots": { "description": "Contains a list of chat boost slots", "args": { "slots": { "description": "List of boost slots", "is_optional": false, "type": "vector\u003cchatBoostSlot\u003e" } }, "type": "ChatBoostSlots" }, "chatBoostSourceGiftCode": { "description": "The chat created a Telegram Premium gift code for a user", "args": { "gift_code": { "description": "The created Telegram Premium gift code, which is known only if this is a gift code for the current user, or it has already been claimed", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of a user, for which the gift code was created", "is_optional": false, "type": "int53" } }, "type": "ChatBoostSource" }, "chatBoostSourceGiveaway": { "description": "The chat created a giveaway", "args": { "gift_code": { "description": "The created Telegram Premium gift code if it was used by the user or can be claimed by the current user; an empty string otherwise; for Telegram Premium giveways only", "is_optional": false, "type": "string" }, "giveaway_message_id": { "description": "Identifier of the corresponding giveaway message; can be an identifier of a deleted message", "is_optional": false, "type": "int53" }, "is_unclaimed": { "description": "True, if the winner for the corresponding giveaway prize wasn't chosen, because there were not enough participants", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars distributed among winners of the giveaway", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of a user who won in the giveaway; 0 if none", "is_optional": false, "type": "int53" } }, "type": "ChatBoostSource" }, "chatBoostSourcePremium": { "description": "A user with Telegram Premium subscription or gifted Telegram Premium boosted the chat", "args": { "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "ChatBoostSource" }, "chatBoostStatus": { "description": "Describes current boost status of a chat", "args": { "applied_slot_ids": { "description": "Identifiers of boost slots of the current user applied to the chat", "is_optional": false, "type": "vector\u003cint32\u003e" }, "boost_count": { "description": "The number of boosts received by the chat", "is_optional": false, "type": "int32" }, "boost_url": { "description": "An HTTP URL, which can be used to boost the chat", "is_optional": false, "type": "string" }, "current_level_boost_count": { "description": "The number of boosts added to reach the current level", "is_optional": false, "type": "int32" }, "gift_code_boost_count": { "description": "The number of boosts received by the chat from created Telegram Premium gift codes and giveaways; always 0 if the current user isn't an administrator in the chat", "is_optional": false, "type": "int32" }, "level": { "description": "Current boost level of the chat", "is_optional": false, "type": "int32" }, "next_level_boost_count": { "description": "The number of boosts needed to reach the next level; 0 if the next level isn't available", "is_optional": false, "type": "int32" }, "premium_member_count": { "description": "Approximate number of Telegram Premium subscribers joined the chat; always 0 if the current user isn't an administrator in the chat", "is_optional": false, "type": "int32" }, "premium_member_percentage": { "description": "A percentage of Telegram Premium subscribers joined the chat; always 0 if the current user isn't an administrator in the chat", "is_optional": false, "type": "double" }, "prepaid_giveaways": { "description": "The list of prepaid giveaways available for the chat; only for chat administrators", "is_optional": false, "type": "vector\u003cprepaidGiveaway\u003e" } }, "type": "ChatBoostStatus" }, "chatEvent": { "description": "Represents a chat event", "args": { "action": { "description": "The action", "is_optional": false, "type": "ChatEventAction" }, "date": { "description": "Point in time (Unix timestamp) when the event happened", "is_optional": false, "type": "int32" }, "id": { "description": "Chat event identifier", "is_optional": false, "type": "int64" }, "member_id": { "description": "Identifier of the user or chat who performed the action", "is_optional": false, "type": "MessageSender" } }, "type": "ChatEvent" }, "chatEventAccentColorChanged": { "description": "The chat accent color or background custom emoji were changed", "args": { "new_accent_color_id": { "description": "New identifier of chat accent color", "is_optional": false, "type": "int32" }, "new_background_custom_emoji_id": { "description": "New identifier of the custom emoji; 0 if none", "is_optional": false, "type": "int64" }, "old_accent_color_id": { "description": "Previous identifier of chat accent color", "is_optional": false, "type": "int32" }, "old_background_custom_emoji_id": { "description": "Previous identifier of the custom emoji; 0 if none", "is_optional": false, "type": "int64" } }, "type": "ChatEventAction" }, "chatEventActiveUsernamesChanged": { "description": "The chat active usernames were changed", "args": { "new_usernames": { "description": "New list of active usernames", "is_optional": false, "type": "vector\u003cstring\u003e" }, "old_usernames": { "description": "Previous list of active usernames", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "ChatEventAction" }, "chatEventAutomaticTranslationToggled": { "description": "The has_automatic_translation setting of a channel was toggled", "args": { "has_automatic_translation": { "description": "New value of has_automatic_translation", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventAvailableReactionsChanged": { "description": "The chat available reactions were changed", "args": { "new_available_reactions": { "description": "New chat available reactions", "is_optional": false, "type": "ChatAvailableReactions" }, "old_available_reactions": { "description": "Previous chat available reactions", "is_optional": false, "type": "ChatAvailableReactions" } }, "type": "ChatEventAction" }, "chatEventBackgroundChanged": { "description": "The chat background was changed", "args": { "new_background": { "description": "New background; may be null if none", "is_optional": true, "type": "chatBackground" }, "old_background": { "description": "Previous background; may be null if none", "is_optional": true, "type": "chatBackground" } }, "type": "ChatEventAction" }, "chatEventCustomEmojiStickerSetChanged": { "description": "The supergroup sticker set with allowed custom emoji was changed", "args": { "new_sticker_set_id": { "description": "New identifier of the chat sticker set; 0 if none", "is_optional": false, "type": "int64" }, "old_sticker_set_id": { "description": "Previous identifier of the chat sticker set; 0 if none", "is_optional": false, "type": "int64" } }, "type": "ChatEventAction" }, "chatEventDescriptionChanged": { "description": "The chat description was changed", "args": { "new_description": { "description": "New chat description", "is_optional": false, "type": "string" }, "old_description": { "description": "Previous chat description", "is_optional": false, "type": "string" } }, "type": "ChatEventAction" }, "chatEventEmojiStatusChanged": { "description": "The chat emoji status was changed", "args": { "new_emoji_status": { "description": "New emoji status; may be null if none", "is_optional": true, "type": "emojiStatus" }, "old_emoji_status": { "description": "Previous emoji status; may be null if none", "is_optional": true, "type": "emojiStatus" } }, "type": "ChatEventAction" }, "chatEventForumTopicCreated": { "description": "A new forum topic was created", "args": { "topic_info": { "description": "Information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventForumTopicDeleted": { "description": "A forum topic was deleted", "args": { "topic_info": { "description": "Information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventForumTopicEdited": { "description": "A forum topic was edited", "args": { "new_topic_info": { "description": "New information about the topic", "is_optional": false, "type": "forumTopicInfo" }, "old_topic_info": { "description": "Old information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventForumTopicPinned": { "description": "A pinned forum topic was changed", "args": { "new_topic_info": { "description": "Information about the new pinned topic; may be null", "is_optional": true, "type": "forumTopicInfo" }, "old_topic_info": { "description": "Information about the old pinned topic; may be null", "is_optional": true, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventForumTopicToggleIsClosed": { "description": "A forum topic was closed or reopened", "args": { "topic_info": { "description": "New information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventForumTopicToggleIsHidden": { "description": "The General forum topic was hidden or unhidden", "args": { "topic_info": { "description": "New information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "ChatEventAction" }, "chatEventHasAggressiveAntiSpamEnabledToggled": { "description": "The has_aggressive_anti_spam_enabled setting of a supergroup was toggled", "args": { "has_aggressive_anti_spam_enabled": { "description": "New value of has_aggressive_anti_spam_enabled", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventHasProtectedContentToggled": { "description": "The has_protected_content setting of a chat was toggled", "args": { "has_protected_content": { "description": "New value of has_protected_content", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventInviteLinkDeleted": { "description": "A revoked chat invite link was deleted", "args": { "invite_link": { "description": "The invite link", "is_optional": false, "type": "chatInviteLink" } }, "type": "ChatEventAction" }, "chatEventInviteLinkEdited": { "description": "A chat invite link was edited", "args": { "new_invite_link": { "description": "New information about the invite link", "is_optional": false, "type": "chatInviteLink" }, "old_invite_link": { "description": "Previous information about the invite link", "is_optional": false, "type": "chatInviteLink" } }, "type": "ChatEventAction" }, "chatEventInviteLinkRevoked": { "description": "A chat invite link was revoked", "args": { "invite_link": { "description": "The invite link", "is_optional": false, "type": "chatInviteLink" } }, "type": "ChatEventAction" }, "chatEventInvitesToggled": { "description": "The can_invite_users permission of a supergroup chat was toggled", "args": { "can_invite_users": { "description": "New value of can_invite_users permission", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventIsAllHistoryAvailableToggled": { "description": "The is_all_history_available setting of a supergroup was toggled", "args": { "is_all_history_available": { "description": "New value of is_all_history_available", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventIsForumToggled": { "description": "The is_forum setting of a supergroup was toggled", "args": { "is_forum": { "description": "New value of is_forum", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventLinkedChatChanged": { "description": "The linked chat of a supergroup was changed", "args": { "new_linked_chat_id": { "description": "New supergroup linked chat identifier", "is_optional": false, "type": "int53" }, "old_linked_chat_id": { "description": "Previous supergroup linked chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatEventAction" }, "chatEventLocationChanged": { "description": "The supergroup location was changed", "args": { "new_location": { "description": "New location; may be null", "is_optional": true, "type": "chatLocation" }, "old_location": { "description": "Previous location; may be null", "is_optional": true, "type": "chatLocation" } }, "type": "ChatEventAction" }, "chatEventLogFilters": { "description": "Represents a set of filters used to obtain a chat event log", "args": { "forum_changes": { "description": "True, if forum-related actions need to be returned", "is_optional": false, "type": "Bool" }, "info_changes": { "description": "True, if changes in chat information need to be returned", "is_optional": false, "type": "Bool" }, "invite_link_changes": { "description": "True, if changes to invite links need to be returned", "is_optional": false, "type": "Bool" }, "member_invites": { "description": "True, if invited member events need to be returned", "is_optional": false, "type": "Bool" }, "member_joins": { "description": "True, if members joining events need to be returned", "is_optional": false, "type": "Bool" }, "member_leaves": { "description": "True, if members leaving events need to be returned", "is_optional": false, "type": "Bool" }, "member_promotions": { "description": "True, if member promotion/demotion events need to be returned", "is_optional": false, "type": "Bool" }, "member_restrictions": { "description": "True, if member restricted/unrestricted/banned/unbanned events need to be returned", "is_optional": false, "type": "Bool" }, "member_tag_changes": { "description": "True, if member tag and custom title change events need to be returned", "is_optional": false, "type": "Bool" }, "message_deletions": { "description": "True, if message deletions need to be returned", "is_optional": false, "type": "Bool" }, "message_edits": { "description": "True, if message edits need to be returned", "is_optional": false, "type": "Bool" }, "message_pins": { "description": "True, if pin/unpin events need to be returned", "is_optional": false, "type": "Bool" }, "setting_changes": { "description": "True, if changes in chat settings need to be returned", "is_optional": false, "type": "Bool" }, "subscription_extensions": { "description": "True, if subscription extensions need to be returned", "is_optional": false, "type": "Bool" }, "video_chat_changes": { "description": "True, if video chat actions need to be returned", "is_optional": false, "type": "Bool" } }, "type": "ChatEventLogFilters" }, "chatEventMemberInvited": { "description": "A new chat member was invited", "args": { "status": { "description": "New member status", "is_optional": false, "type": "ChatMemberStatus" }, "user_id": { "description": "New member user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatEventAction" }, "chatEventMemberJoined": { "description": "A new member joined the chat", "args": {}, "type": "ChatEventAction" }, "chatEventMemberJoinedByInviteLink": { "description": "A new member joined the chat via an invite link", "args": { "invite_link": { "description": "Invite link used to join the chat", "is_optional": false, "type": "chatInviteLink" }, "via_chat_folder_invite_link": { "description": "True, if the user has joined the chat using an invite link for a chat folder", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventMemberJoinedByRequest": { "description": "A new member was accepted to the chat by an administrator", "args": { "approver_user_id": { "description": "User identifier of the chat administrator, approved user join request", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link used to join the chat; may be null", "is_optional": true, "type": "chatInviteLink" } }, "type": "ChatEventAction" }, "chatEventMemberLeft": { "description": "A member left the chat", "args": {}, "type": "ChatEventAction" }, "chatEventMemberPromoted": { "description": "A chat member has gained/lost administrator status, or the list of their administrator privileges has changed", "args": { "new_status": { "description": "New status of the chat member", "is_optional": false, "type": "ChatMemberStatus" }, "old_status": { "description": "Previous status of the chat member", "is_optional": false, "type": "ChatMemberStatus" }, "user_id": { "description": "Affected chat member user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatEventAction" }, "chatEventMemberRestricted": { "description": "A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed", "args": { "member_id": { "description": "Affected chat member identifier", "is_optional": false, "type": "MessageSender" }, "new_status": { "description": "New status of the chat member", "is_optional": false, "type": "ChatMemberStatus" }, "old_status": { "description": "Previous status of the chat member", "is_optional": false, "type": "ChatMemberStatus" } }, "type": "ChatEventAction" }, "chatEventMemberSubscriptionExtended": { "description": "A chat member extended their subscription to the chat", "args": { "new_status": { "description": "New status of the chat member", "is_optional": false, "type": "ChatMemberStatus" }, "old_status": { "description": "Previous status of the chat member", "is_optional": false, "type": "ChatMemberStatus" }, "user_id": { "description": "Affected chat member user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatEventAction" }, "chatEventMemberTagChanged": { "description": "A chat member tag has been changed", "args": { "new_tag": { "description": "New tag of the chat member", "is_optional": false, "type": "string" }, "old_tag": { "description": "Previous tag of the chat member", "is_optional": false, "type": "string" }, "user_id": { "description": "Affected chat member user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatEventAction" }, "chatEventMessageAutoDeleteTimeChanged": { "description": "The message auto-delete timer was changed", "args": { "new_message_auto_delete_time": { "description": "New value of message_auto_delete_time", "is_optional": false, "type": "int32" }, "old_message_auto_delete_time": { "description": "Previous value of message_auto_delete_time", "is_optional": false, "type": "int32" } }, "type": "ChatEventAction" }, "chatEventMessageDeleted": { "description": "A message was deleted", "args": { "can_report_anti_spam_false_positive": { "description": "True, if the message deletion can be reported via reportSupergroupAntiSpamFalsePositive", "is_optional": false, "type": "Bool" }, "message": { "description": "Deleted message", "is_optional": false, "type": "message" } }, "type": "ChatEventAction" }, "chatEventMessageEdited": { "description": "A message was edited", "args": { "new_message": { "description": "The message after it was edited", "is_optional": false, "type": "message" }, "old_message": { "description": "The original message before the edit", "is_optional": false, "type": "message" } }, "type": "ChatEventAction" }, "chatEventMessagePinned": { "description": "A message was pinned", "args": { "message": { "description": "Pinned message", "is_optional": false, "type": "message" } }, "type": "ChatEventAction" }, "chatEventMessageUnpinned": { "description": "A message was unpinned", "args": { "message": { "description": "Unpinned message", "is_optional": false, "type": "message" } }, "type": "ChatEventAction" }, "chatEventPermissionsChanged": { "description": "The chat permissions were changed", "args": { "new_permissions": { "description": "New chat permissions", "is_optional": false, "type": "chatPermissions" }, "old_permissions": { "description": "Previous chat permissions", "is_optional": false, "type": "chatPermissions" } }, "type": "ChatEventAction" }, "chatEventPhotoChanged": { "description": "The chat photo was changed", "args": { "new_photo": { "description": "New chat photo value; may be null", "is_optional": true, "type": "chatPhoto" }, "old_photo": { "description": "Previous chat photo value; may be null", "is_optional": true, "type": "chatPhoto" } }, "type": "ChatEventAction" }, "chatEventPollStopped": { "description": "A poll in a message was stopped", "args": { "message": { "description": "The message with the poll", "is_optional": false, "type": "message" } }, "type": "ChatEventAction" }, "chatEventProfileAccentColorChanged": { "description": "The chat's profile accent color or profile background custom emoji were changed", "args": { "new_profile_accent_color_id": { "description": "New identifier of chat's profile accent color; -1 if none", "is_optional": false, "type": "int32" }, "new_profile_background_custom_emoji_id": { "description": "New identifier of the custom emoji; 0 if none", "is_optional": false, "type": "int64" }, "old_profile_accent_color_id": { "description": "Previous identifier of chat's profile accent color; -1 if none", "is_optional": false, "type": "int32" }, "old_profile_background_custom_emoji_id": { "description": "Previous identifier of the custom emoji; 0 if none", "is_optional": false, "type": "int64" } }, "type": "ChatEventAction" }, "chatEventShowMessageSenderToggled": { "description": "The show_message_sender setting of a channel was toggled", "args": { "show_message_sender": { "description": "New value of show_message_sender", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventSignMessagesToggled": { "description": "The sign_messages setting of a channel was toggled", "args": { "sign_messages": { "description": "New value of sign_messages", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventSlowModeDelayChanged": { "description": "The slow_mode_delay setting of a supergroup was changed", "args": { "new_slow_mode_delay": { "description": "New value of slow_mode_delay, in seconds", "is_optional": false, "type": "int32" }, "old_slow_mode_delay": { "description": "Previous value of slow_mode_delay, in seconds", "is_optional": false, "type": "int32" } }, "type": "ChatEventAction" }, "chatEventStickerSetChanged": { "description": "The supergroup sticker set was changed", "args": { "new_sticker_set_id": { "description": "New identifier of the chat sticker set; 0 if none", "is_optional": false, "type": "int64" }, "old_sticker_set_id": { "description": "Previous identifier of the chat sticker set; 0 if none", "is_optional": false, "type": "int64" } }, "type": "ChatEventAction" }, "chatEventTitleChanged": { "description": "The chat title was changed", "args": { "new_title": { "description": "New chat title", "is_optional": false, "type": "string" }, "old_title": { "description": "Previous chat title", "is_optional": false, "type": "string" } }, "type": "ChatEventAction" }, "chatEventUsernameChanged": { "description": "The chat editable username was changed", "args": { "new_username": { "description": "New chat username", "is_optional": false, "type": "string" }, "old_username": { "description": "Previous chat username", "is_optional": false, "type": "string" } }, "type": "ChatEventAction" }, "chatEventVideoChatCreated": { "description": "A video chat was created", "args": { "group_call_id": { "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" } }, "type": "ChatEventAction" }, "chatEventVideoChatEnded": { "description": "A video chat was ended", "args": { "group_call_id": { "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" } }, "type": "ChatEventAction" }, "chatEventVideoChatMuteNewParticipantsToggled": { "description": "The mute_new_participants setting of a video chat was toggled", "args": { "mute_new_participants": { "description": "New value of the mute_new_participants setting", "is_optional": false, "type": "Bool" } }, "type": "ChatEventAction" }, "chatEventVideoChatParticipantIsMutedToggled": { "description": "A video chat participant was muted or unmuted", "args": { "is_muted": { "description": "New value of is_muted", "is_optional": false, "type": "Bool" }, "participant_id": { "description": "Identifier of the affected group call participant", "is_optional": false, "type": "MessageSender" } }, "type": "ChatEventAction" }, "chatEventVideoChatParticipantVolumeLevelChanged": { "description": "A video chat participant volume level was changed", "args": { "participant_id": { "description": "Identifier of the affected group call participant", "is_optional": false, "type": "MessageSender" }, "volume_level": { "description": "New value of volume_level; 1-20000 in hundreds of percents", "is_optional": false, "type": "int32" } }, "type": "ChatEventAction" }, "chatEvents": { "description": "Contains a list of chat events", "args": { "events": { "description": "List of events", "is_optional": false, "type": "vector\u003cchatEvent\u003e" } }, "type": "ChatEvents" }, "chatFolder": { "description": "Represents a folder for user chats", "args": { "color_id": { "description": "The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled. Can't be changed if folder tags are disabled or the current user doesn't have Telegram Premium subscription", "is_optional": false, "type": "int32" }, "exclude_archived": { "description": "True, if archived chats need to be excluded", "is_optional": false, "type": "Bool" }, "exclude_muted": { "description": "True, if muted chats need to be excluded", "is_optional": false, "type": "Bool" }, "exclude_read": { "description": "True, if read chats need to be excluded", "is_optional": false, "type": "Bool" }, "excluded_chat_ids": { "description": "The chat identifiers of always excluded chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium", "is_optional": false, "type": "vector\u003cint53\u003e" }, "icon": { "description": "The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder", "is_optional": true, "type": "chatFolderIcon" }, "include_bots": { "description": "True, if bots need to be included", "is_optional": false, "type": "Bool" }, "include_channels": { "description": "True, if channels need to be included", "is_optional": false, "type": "Bool" }, "include_contacts": { "description": "True, if contacts need to be included", "is_optional": false, "type": "Bool" }, "include_groups": { "description": "True, if basic groups and supergroups need to be included", "is_optional": false, "type": "Bool" }, "include_non_contacts": { "description": "True, if non-contact users need to be included", "is_optional": false, "type": "Bool" }, "included_chat_ids": { "description": "The chat identifiers of always included chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium", "is_optional": false, "type": "vector\u003cint53\u003e" }, "is_shareable": { "description": "True, if at least one link has been created for the folder", "is_optional": false, "type": "Bool" }, "name": { "description": "The name of the folder", "is_optional": false, "type": "chatFolderName" }, "pinned_chat_ids": { "description": "The chat identifiers of pinned chats in the folder. There can be up to getOption(\"chat_folder_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "ChatFolder" }, "chatFolderIcon": { "description": "Represents an icon for a chat folder", "args": { "name": { "description": "The chosen icon name for short folder representation; one of \"All\", \"Unread\", \"Unmuted\", \"Bots\", \"Channels\", \"Groups\", \"Private\", \"Custom\", \"Setup\", \"Cat\", \"Crown\",", "is_optional": false, "type": "string" } }, "type": "ChatFolderIcon" }, "chatFolderInfo": { "description": "Contains basic information about a chat folder", "args": { "color_id": { "description": "The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled", "is_optional": false, "type": "int32" }, "has_my_invite_links": { "description": "True, if the chat folder has invite links created by the current user", "is_optional": false, "type": "Bool" }, "icon": { "description": "The chosen or default icon for the chat folder", "is_optional": false, "type": "chatFolderIcon" }, "id": { "description": "Unique chat folder identifier", "is_optional": false, "type": "int32" }, "is_shareable": { "description": "True, if at least one link has been created for the folder", "is_optional": false, "type": "Bool" }, "name": { "description": "The name of the folder", "is_optional": false, "type": "chatFolderName" } }, "type": "ChatFolderInfo" }, "chatFolderInviteLink": { "description": "Contains a chat folder invite link", "args": { "chat_ids": { "description": "Identifiers of chats, included in the link", "is_optional": false, "type": "vector\u003cint53\u003e" }, "invite_link": { "description": "The chat folder invite link", "is_optional": false, "type": "string" }, "name": { "description": "Name of the link", "is_optional": false, "type": "string" } }, "type": "ChatFolderInviteLink" }, "chatFolderInviteLinkInfo": { "description": "Contains information about an invite link to a chat folder", "args": { "added_chat_ids": { "description": "Identifiers of the chats from the link, which are added to the folder already", "is_optional": false, "type": "vector\u003cint53\u003e" }, "chat_folder_info": { "description": "Basic information about the chat folder; chat folder identifier will be 0 if the user didn't have the chat folder yet", "is_optional": false, "type": "chatFolderInfo" }, "missing_chat_ids": { "description": "Identifiers of the chats from the link, which aren't added to the folder yet", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "ChatFolderInviteLinkInfo" }, "chatFolderInviteLinks": { "description": "Represents a list of chat folder invite links", "args": { "invite_links": { "description": "List of the invite links", "is_optional": false, "type": "vector\u003cchatFolderInviteLink\u003e" } }, "type": "ChatFolderInviteLinks" }, "chatFolderName": { "description": "Describes name of a chat folder", "args": { "animate_custom_emoji": { "description": "True, if custom emoji in the name must be animated", "is_optional": false, "type": "Bool" }, "text": { "description": "The text of the chat folder name; 1-12 characters without line feeds. May contain only CustomEmoji entities", "is_optional": false, "type": "formattedText" } }, "type": "ChatFolderName" }, "chatInviteLink": { "description": "Contains a chat invite link", "args": { "creates_join_request": { "description": "True, if the link only creates join request. If true, total number of joining members will be unlimited", "is_optional": false, "type": "Bool" }, "creator_user_id": { "description": "User identifier of an administrator created the link", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) when the link was created", "is_optional": false, "type": "int32" }, "edit_date": { "description": "Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown", "is_optional": false, "type": "int32" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the link will expire; 0 if never", "is_optional": false, "type": "int32" }, "expired_member_count": { "description": "Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only", "is_optional": false, "type": "int32" }, "invite_link": { "description": "Chat invite link", "is_optional": false, "type": "string" }, "is_primary": { "description": "True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. Primary link can create join requests only if this is set up using toggleSupergroupJoinByRequest.", "is_optional": false, "type": "Bool" }, "is_revoked": { "description": "True, if the link was revoked", "is_optional": false, "type": "Bool" }, "member_count": { "description": "Number of chat members, which joined the chat using the link", "is_optional": false, "type": "int32" }, "member_limit": { "description": "The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the link", "is_optional": false, "type": "string" }, "pending_join_request_count": { "description": "Number of pending join requests created using this link", "is_optional": false, "type": "int32" }, "subscription_pricing": { "description": "Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription", "is_optional": true, "type": "starSubscriptionPricing" } }, "type": "ChatInviteLink" }, "chatInviteLinkCount": { "description": "Describes a chat administrator with a number of active and revoked chat invite links", "args": { "invite_link_count": { "description": "Number of active invite links", "is_optional": false, "type": "int32" }, "revoked_invite_link_count": { "description": "Number of revoked invite links", "is_optional": false, "type": "int32" }, "user_id": { "description": "Administrator's user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatInviteLinkCount" }, "chatInviteLinkCounts": { "description": "Contains a list of chat invite link counts", "args": { "invite_link_counts": { "description": "List of invite link counts", "is_optional": false, "type": "vector\u003cchatInviteLinkCount\u003e" } }, "type": "ChatInviteLinkCounts" }, "chatInviteLinkInfo": { "description": "Contains information about a chat invite link", "args": { "accent_color_id": { "description": "Identifier of the accent color for chat title and background of chat photo", "is_optional": false, "type": "int32" }, "accessible_for": { "description": "If non-zero, the amount of time for which read access to the chat will remain available, in seconds", "is_optional": false, "type": "int32" }, "chat_id": { "description": "Chat identifier of the invite link; 0 if the user has no access to the chat before joining", "is_optional": false, "type": "int53" }, "creates_join_request": { "description": "True, if the link only creates join request", "is_optional": false, "type": "Bool" }, "description": { "description": "Chat description", "is_optional": false, "type": "string" }, "is_public": { "description": "True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup", "is_optional": false, "type": "Bool" }, "member_count": { "description": "Number of members in the chat", "is_optional": false, "type": "int32" }, "member_user_ids": { "description": "User identifiers of some chat members that may be known to the current user", "is_optional": false, "type": "vector\u003cint53\u003e" }, "photo": { "description": "Chat photo; may be null", "is_optional": true, "type": "chatPhotoInfo" }, "subscription_info": { "description": "Information about subscription plan that must be paid by the user to use the link; may be null if the link doesn't require subscription", "is_optional": true, "type": "chatInviteLinkSubscriptionInfo" }, "title": { "description": "Title of the chat", "is_optional": false, "type": "string" }, "type": { "description": "Type of the chat", "is_optional": false, "type": "InviteLinkChatType" }, "verification_status": { "description": "Information about verification status of the chat; may be null if none", "is_optional": true, "type": "verificationStatus" } }, "type": "ChatInviteLinkInfo" }, "chatInviteLinkMember": { "description": "Describes a chat member joined a chat via an invite link", "args": { "approver_user_id": { "description": "User identifier of the chat administrator, approved user join request", "is_optional": false, "type": "int53" }, "joined_chat_date": { "description": "Point in time (Unix timestamp) when the user joined the chat", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" }, "via_chat_folder_invite_link": { "description": "True, if the user has joined the chat using an invite link for a chat folder", "is_optional": false, "type": "Bool" } }, "type": "ChatInviteLinkMember" }, "chatInviteLinkMembers": { "description": "Contains a list of chat members joined a chat via an invite link", "args": { "members": { "description": "List of chat members, joined a chat via an invite link", "is_optional": false, "type": "vector\u003cchatInviteLinkMember\u003e" }, "total_count": { "description": "Approximate total number of chat members found", "is_optional": false, "type": "int32" } }, "type": "ChatInviteLinkMembers" }, "chatInviteLinkSubscriptionInfo": { "description": "Contains information about subscription plan that must be paid by the user to use a chat invite link", "args": { "can_reuse": { "description": "True, if the user has already paid for the subscription and can use joinChatByInviteLink to join the subscribed chat again", "is_optional": false, "type": "Bool" }, "form_id": { "description": "Identifier of the payment form to use for subscription payment; 0 if the subscription can't be paid", "is_optional": false, "type": "int64" }, "pricing": { "description": "Information about subscription plan that must be paid by the user to use the link", "is_optional": false, "type": "starSubscriptionPricing" } }, "type": "ChatInviteLinkSubscriptionInfo" }, "chatInviteLinks": { "description": "Contains a list of chat invite links", "args": { "invite_links": { "description": "List of invite links", "is_optional": false, "type": "vector\u003cchatInviteLink\u003e" }, "total_count": { "description": "Approximate total number of chat invite links found", "is_optional": false, "type": "int32" } }, "type": "ChatInviteLinks" }, "chatJoinRequest": { "description": "Describes a user who sent a join request and waits for administrator approval", "args": { "bio": { "description": "A short bio of the user", "is_optional": false, "type": "string" }, "date": { "description": "Point in time (Unix timestamp) when the user sent the join request", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "ChatJoinRequest" }, "chatJoinRequestResultApproved": { "description": "The request was approved", "args": {}, "type": "ChatJoinRequestResult" }, "chatJoinRequestResultDeclined": { "description": "The request was declined", "args": {}, "type": "ChatJoinRequestResult" }, "chatJoinRequestResultQueued": { "description": "The request was postponed without a decision", "args": {}, "type": "ChatJoinRequestResult" }, "chatJoinRequests": { "description": "Contains a list of requests to join a chat", "args": { "requests": { "description": "List of the requests", "is_optional": false, "type": "vector\u003cchatJoinRequest\u003e" }, "total_count": { "description": "Approximate total number of requests found", "is_optional": false, "type": "int32" } }, "type": "ChatJoinRequests" }, "chatJoinRequestsInfo": { "description": "Contains information about pending join requests for a chat", "args": { "total_count": { "description": "Total number of pending join requests", "is_optional": false, "type": "int32" }, "user_ids": { "description": "Identifiers of at most 3 users sent the newest pending join requests", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "ChatJoinRequestsInfo" }, "chatJoinResultDeclined": { "description": "The join was declined by the guard bot", "args": {}, "type": "ChatJoinResult" }, "chatJoinResultGuardBotApprovalRequired": { "description": "An approval from a guard bot through a Web App is required to join the chat", "args": { "bot_user_id": { "description": "Identifier of the guard bot", "is_optional": false, "type": "int53" }, "query_id": { "description": "Unique identifier of the join request, which will be used in getGuardBotWebAppUrl and updateChatJoinResult", "is_optional": false, "type": "int64" } }, "type": "ChatJoinResult" }, "chatJoinResultRequestSent": { "description": "The join request was sent and have to be approved by administrators of the chat", "args": {}, "type": "ChatJoinResult" }, "chatJoinResultSuccess": { "description": "The chat was joined successfully", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "ChatJoinResult" }, "chatListArchive": { "description": "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", "args": {}, "type": "ChatList" }, "chatListFolder": { "description": "A list of chats added to a chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "ChatList" }, "chatListMain": { "description": "A main list of chats", "args": {}, "type": "ChatList" }, "chatLists": { "description": "Contains a list of chat lists", "args": { "chat_lists": { "description": "List of chat lists", "is_optional": false, "type": "vector\u003cChatList\u003e" } }, "type": "ChatLists" }, "chatLocation": { "description": "Represents a location to which a chat is connected", "args": { "address": { "description": "Location address; 1-64 characters, as defined by the chat owner", "is_optional": false, "type": "string" }, "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "ChatLocation" }, "chatMember": { "description": "Describes a user or a chat as a member of another chat", "args": { "inviter_user_id": { "description": "Identifier of a user who invited/promoted/banned this member in the chat; 0 if unknown", "is_optional": false, "type": "int53" }, "joined_chat_date": { "description": "Point in time (Unix timestamp) when the user joined/was promoted/was banned in the chat", "is_optional": false, "type": "int32" }, "member_id": { "description": "Identifier of the chat member. Currently, other chats can be only Left or Banned. Only supergroups and channels can have other chats as Left or Banned members and these chats must be supergroups or channels", "is_optional": false, "type": "MessageSender" }, "status": { "description": "Status of the member in the chat", "is_optional": false, "type": "ChatMemberStatus" }, "tag": { "description": "Tag of the chat member or its custom title if the member is an administrator of the chat; 0-16 characters without emoji; applicable to basic groups and supergroups only", "is_optional": false, "type": "string" } }, "type": "ChatMember" }, "chatMemberStatusAdministrator": { "description": "The user is a member of the chat and has some additional privileges. In basic groups, administrators have all applicable rights.", "args": { "can_be_edited": { "description": "True, if the current user can edit the administrator privileges for the called user", "is_optional": false, "type": "Bool" }, "rights": { "description": "Rights of the administrator", "is_optional": false, "type": "chatAdministratorRights" } }, "type": "ChatMemberStatus" }, "chatMemberStatusBanned": { "description": "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", "args": { "banned_until_date": { "description": "Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Always 0 in basic groups", "is_optional": false, "type": "int32" } }, "type": "ChatMemberStatus" }, "chatMemberStatusCreator": { "description": "The user is the owner of the chat and has all the administrator privileges", "args": { "is_anonymous": { "description": "True, if the creator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only", "is_optional": false, "type": "Bool" }, "is_member": { "description": "True, if the user is a member of the chat", "is_optional": false, "type": "Bool" } }, "type": "ChatMemberStatus" }, "chatMemberStatusLeft": { "description": "The user or the chat is not a chat member", "args": {}, "type": "ChatMemberStatus" }, "chatMemberStatusMember": { "description": "The user is a member of the chat, without any additional privileges or restrictions", "args": { "member_until_date": { "description": "Point in time (Unix timestamp) when the user will be removed from the chat because of the expired subscription; 0 if never. Ignored in setChatMemberStatus", "is_optional": false, "type": "int32" } }, "type": "ChatMemberStatus" }, "chatMemberStatusRestricted": { "description": "The user is under certain restrictions in the chat. Not supported in basic groups and channels", "args": { "is_member": { "description": "True, if the user is a member of the chat", "is_optional": false, "type": "Bool" }, "permissions": { "description": "User permissions in the chat", "is_optional": false, "type": "chatPermissions" }, "restricted_until_date": { "description": "Point in time (Unix timestamp) when restrictions will be lifted from the user; 0 if never. If the user is restricted for more than 366 days or for less than 30 seconds from the current time, the user is considered to be restricted forever", "is_optional": false, "type": "int32" } }, "type": "ChatMemberStatus" }, "chatMembers": { "description": "Contains a list of chat members", "args": { "members": { "description": "A list of chat members", "is_optional": false, "type": "vector\u003cchatMember\u003e" }, "total_count": { "description": "Approximate total number of chat members found", "is_optional": false, "type": "int32" } }, "type": "ChatMembers" }, "chatMembersFilterAdministrators": { "description": "Returns the owner and administrators", "args": {}, "type": "ChatMembersFilter" }, "chatMembersFilterBanned": { "description": "Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel", "args": {}, "type": "ChatMembersFilter" }, "chatMembersFilterBots": { "description": "Returns bot members of the chat", "args": {}, "type": "ChatMembersFilter" }, "chatMembersFilterContacts": { "description": "Returns contacts of the user", "args": {}, "type": "ChatMembersFilter" }, "chatMembersFilterMembers": { "description": "Returns all chat members, including restricted chat members", "args": {}, "type": "ChatMembersFilter" }, "chatMembersFilterMention": { "description": "Returns users who can be mentioned in the chat", "args": { "topic_id": { "description": "Identifier of the topic in which the users will be mentioned; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "ChatMembersFilter" }, "chatMembersFilterRestricted": { "description": "Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup", "args": {}, "type": "ChatMembersFilter" }, "chatMessageSender": { "description": "Represents a message sender, which can be used to send messages in a chat", "args": { "needs_premium": { "description": "True, if Telegram Premium is needed to use the message sender", "is_optional": false, "type": "Bool" }, "sender": { "description": "The message sender", "is_optional": false, "type": "MessageSender" } }, "type": "ChatMessageSender" }, "chatMessageSenders": { "description": "Represents a list of message senders, which can be used to send messages in a chat", "args": { "senders": { "description": "List of available message senders", "is_optional": false, "type": "vector\u003cchatMessageSender\u003e" } }, "type": "ChatMessageSenders" }, "chatNotificationSettings": { "description": "Contains information about notification settings for a chat or a forum topic", "args": { "disable_mention_notifications": { "description": "If true, notifications for messages with mentions will be created as for an ordinary unread message", "is_optional": false, "type": "Bool" }, "disable_pinned_message_notifications": { "description": "If true, notifications for incoming pinned messages will be created as for an ordinary unread message", "is_optional": false, "type": "Bool" }, "mute_for": { "description": "Time left before notifications will be unmuted, in seconds", "is_optional": false, "type": "int32" }, "mute_stories": { "description": "True, if story notifications are disabled for the chat", "is_optional": false, "type": "Bool" }, "show_preview": { "description": "True, if message content must be displayed in notifications", "is_optional": false, "type": "Bool" }, "show_story_poster": { "description": "True, if the chat that posted a story must be displayed in notifications", "is_optional": false, "type": "Bool" }, "sound_id": { "description": "Identifier of the notification sound to be played for messages; 0 if sound is disabled", "is_optional": false, "type": "int64" }, "story_sound_id": { "description": "Identifier of the notification sound to be played for stories; 0 if sound is disabled", "is_optional": false, "type": "int64" }, "use_default_disable_mention_notifications": { "description": "If true, the value for the relevant type of chat or the forum chat is used instead of disable_mention_notifications", "is_optional": false, "type": "Bool" }, "use_default_disable_pinned_message_notifications": { "description": "If true, the value for the relevant type of chat or the forum chat is used instead of disable_pinned_message_notifications", "is_optional": false, "type": "Bool" }, "use_default_mute_for": { "description": "If true, the value for the relevant type of chat or the forum chat is used instead of mute_for", "is_optional": false, "type": "Bool" }, "use_default_mute_stories": { "description": "If true, the value for the relevant type of chat is used instead of mute_stories", "is_optional": false, "type": "Bool" }, "use_default_show_preview": { "description": "If true, the value for the relevant type of chat or the forum chat is used instead of show_preview", "is_optional": false, "type": "Bool" }, "use_default_show_story_poster": { "description": "If true, the value for the relevant type of chat is used instead of show_story_poster", "is_optional": false, "type": "Bool" }, "use_default_sound": { "description": "If true, the value for the relevant type of chat or the forum chat is used instead of sound_id", "is_optional": false, "type": "Bool" }, "use_default_story_sound": { "description": "If true, the value for the relevant type of chat is used instead of story_sound_id", "is_optional": false, "type": "Bool" } }, "type": "ChatNotificationSettings" }, "chatPermissions": { "description": "Describes actions that a user is allowed to take in a chat", "args": { "can_add_link_previews": { "description": "True, if the user may add a link preview to their messages", "is_optional": false, "type": "Bool" }, "can_change_info": { "description": "True, if the user can change the chat title, photo, and other settings", "is_optional": false, "type": "Bool" }, "can_create_topics": { "description": "True, if the user can create topics", "is_optional": false, "type": "Bool" }, "can_edit_tag": { "description": "True, if the user may change the tag of self", "is_optional": false, "type": "Bool" }, "can_invite_users": { "description": "True, if the user can invite new users to the chat", "is_optional": false, "type": "Bool" }, "can_pin_messages": { "description": "True, if the user can pin messages", "is_optional": false, "type": "Bool" }, "can_react_to_messages": { "description": "True, if the user can react to messages", "is_optional": false, "type": "Bool" }, "can_send_audios": { "description": "True, if the user can send music files", "is_optional": false, "type": "Bool" }, "can_send_basic_messages": { "description": "True, if the user can send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations, and venues", "is_optional": false, "type": "Bool" }, "can_send_documents": { "description": "True, if the user can send documents", "is_optional": false, "type": "Bool" }, "can_send_other_messages": { "description": "True, if the user can send animations, games, stickers, and dice and use inline bots", "is_optional": false, "type": "Bool" }, "can_send_photos": { "description": "True, if the user can send photos", "is_optional": false, "type": "Bool" }, "can_send_polls": { "description": "True, if the user can send polls and checklists", "is_optional": false, "type": "Bool" }, "can_send_video_notes": { "description": "True, if the user can send video notes", "is_optional": false, "type": "Bool" }, "can_send_videos": { "description": "True, if the user can send videos", "is_optional": false, "type": "Bool" }, "can_send_voice_notes": { "description": "True, if the user can send voice notes", "is_optional": false, "type": "Bool" } }, "type": "ChatPermissions" }, "chatPhoto": { "description": "Describes a chat or user profile photo", "args": { "added_date": { "description": "Point in time (Unix timestamp) when the photo has been added", "is_optional": false, "type": "int32" }, "animation": { "description": "A big (up to 1280x1280) animated variant of the photo in MPEG4 format; may be null", "is_optional": true, "type": "animatedChatPhoto" }, "id": { "description": "Unique photo identifier", "is_optional": false, "type": "int64" }, "minithumbnail": { "description": "Photo minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "sizes": { "description": "Available variants of the photo in JPEG format, in different size", "is_optional": false, "type": "vector\u003cphotoSize\u003e" }, "small_animation": { "description": "A small (160x160) animated variant of the photo in MPEG4 format; may be null even if the big animation is available", "is_optional": true, "type": "animatedChatPhoto" }, "sticker": { "description": "Sticker-based version of the chat photo; may be null", "is_optional": true, "type": "chatPhotoSticker" } }, "type": "ChatPhoto" }, "chatPhotoInfo": { "description": "Contains basic information about the photo of a chat", "args": { "big": { "description": "A big (640x640) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed", "is_optional": false, "type": "file" }, "has_animation": { "description": "True, if the photo has animated variant", "is_optional": false, "type": "Bool" }, "is_personal": { "description": "True, if the photo is visible only for the current user", "is_optional": false, "type": "Bool" }, "minithumbnail": { "description": "Chat photo minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "small": { "description": "A small (160x160) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed", "is_optional": false, "type": "file" } }, "type": "ChatPhotoInfo" }, "chatPhotoSticker": { "description": "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", "args": { "background_fill": { "description": "The fill to be used as background for the sticker; rotation angle in backgroundFillGradient isn't supported", "is_optional": false, "type": "BackgroundFill" }, "type": { "description": "Type of the sticker", "is_optional": false, "type": "ChatPhotoStickerType" } }, "type": "ChatPhotoSticker" }, "chatPhotoStickerTypeCustomEmoji": { "description": "Information about the custom emoji, which was used to create the chat photo", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji", "is_optional": false, "type": "int64" } }, "type": "ChatPhotoStickerType" }, "chatPhotoStickerTypeRegularOrMask": { "description": "Information about the sticker, which was used to create the chat photo", "args": { "sticker_id": { "description": "Identifier of the sticker in the set", "is_optional": false, "type": "int64" }, "sticker_set_id": { "description": "Sticker set identifier", "is_optional": false, "type": "int64" } }, "type": "ChatPhotoStickerType" }, "chatPhotos": { "description": "Contains a list of chat or user profile photos", "args": { "photos": { "description": "List of photos", "is_optional": false, "type": "vector\u003cchatPhoto\u003e" }, "total_count": { "description": "Total number of photos", "is_optional": false, "type": "int32" } }, "type": "ChatPhotos" }, "chatPosition": { "description": "Describes a position of a chat in a chat list", "args": { "is_pinned": { "description": "True, if the chat is pinned in the chat list", "is_optional": false, "type": "Bool" }, "list": { "description": "The chat list", "is_optional": false, "type": "ChatList" }, "order": { "description": "A parameter used to determine order of the chat in the chat list. Chats must be sorted by the pair (order, chat.id) in descending order", "is_optional": false, "type": "int64" }, "source": { "description": "Source of the chat in the chat list; may be null", "is_optional": true, "type": "ChatSource" } }, "type": "ChatPosition" }, "chatRevenueAmount": { "description": "Contains information about revenue earned from sponsored messages in a chat", "args": { "available_amount": { "description": "Amount of the cryptocurrency available for withdrawal, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "balance_amount": { "description": "Amount of the cryptocurrency that isn't withdrawn yet, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "cryptocurrency": { "description": "Cryptocurrency in which revenue is calculated", "is_optional": false, "type": "string" }, "total_amount": { "description": "Total amount of the cryptocurrency earned, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "withdrawal_enabled": { "description": "True, if Telegram Stars can be withdrawn now or later", "is_optional": false, "type": "Bool" } }, "type": "ChatRevenueAmount" }, "chatRevenueStatistics": { "description": "A detailed statistics about revenue earned from sponsored messages in a chat", "args": { "revenue_amount": { "description": "Amount of earned revenue", "is_optional": false, "type": "chatRevenueAmount" }, "revenue_by_hour_graph": { "description": "A graph containing amount of revenue in a given hour", "is_optional": false, "type": "StatisticalGraph" }, "revenue_graph": { "description": "A graph containing amount of revenue", "is_optional": false, "type": "StatisticalGraph" }, "usd_rate": { "description": "Current exchange rate of the cryptocurrency in which revenue is calculated to USD", "is_optional": false, "type": "double" } }, "type": "ChatRevenueStatistics" }, "chatRevenueTransaction": { "description": "Contains a chat revenue transactions", "args": { "cryptocurrency": { "description": "Cryptocurrency in which revenue is calculated", "is_optional": false, "type": "string" }, "cryptocurrency_amount": { "description": "The withdrawn amount, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "type": { "description": "Type of the transaction", "is_optional": false, "type": "ChatRevenueTransactionType" } }, "type": "ChatRevenueTransaction" }, "chatRevenueTransactionTypeFragmentRefund": { "description": "Describes a refund for failed withdrawal of earnings through Fragment", "args": { "refund_date": { "description": "Point in time (Unix timestamp) when the transaction was refunded", "is_optional": false, "type": "int32" } }, "type": "ChatRevenueTransactionType" }, "chatRevenueTransactionTypeFragmentWithdrawal": { "description": "Describes a withdrawal of earnings through Fragment", "args": { "state": { "description": "State of the withdrawal", "is_optional": false, "type": "RevenueWithdrawalState" }, "withdrawal_date": { "description": "Point in time (Unix timestamp) when the earnings withdrawal started", "is_optional": false, "type": "int32" } }, "type": "ChatRevenueTransactionType" }, "chatRevenueTransactionTypeSponsoredMessageEarnings": { "description": "Describes earnings from sponsored messages in a chat in some time frame", "args": { "end_date": { "description": "Point in time (Unix timestamp) when the earnings ended", "is_optional": false, "type": "int32" }, "start_date": { "description": "Point in time (Unix timestamp) when the earnings started", "is_optional": false, "type": "int32" } }, "type": "ChatRevenueTransactionType" }, "chatRevenueTransactionTypeSuggestedPostEarnings": { "description": "Describes earnings from a published suggested post", "args": { "user_id": { "description": "Identifier of the user who paid for the suggested post", "is_optional": false, "type": "int53" } }, "type": "ChatRevenueTransactionType" }, "chatRevenueTransactionTypeUnsupported": { "description": "Describes an unsupported transaction", "args": {}, "type": "ChatRevenueTransactionType" }, "chatRevenueTransactions": { "description": "Contains a list of chat revenue transactions", "args": { "gram_amount": { "description": "The amount of owned TON Grams; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "transactions": { "description": "List of transactions", "is_optional": false, "type": "vector\u003cchatRevenueTransaction\u003e" } }, "type": "ChatRevenueTransactions" }, "chatSourceMtprotoProxy": { "description": "The chat is sponsored by the user's MTProxy server", "args": {}, "type": "ChatSource" }, "chatSourcePublicServiceAnnouncement": { "description": "The chat contains a public service announcement", "args": { "text": { "description": "The text of the announcement", "is_optional": false, "type": "string" }, "type": { "description": "The type of the announcement", "is_optional": false, "type": "string" } }, "type": "ChatSource" }, "chatStatisticsAdministratorActionsInfo": { "description": "Contains statistics about administrator actions done by a user", "args": { "banned_user_count": { "description": "Number of users banned by the administrator", "is_optional": false, "type": "int32" }, "deleted_message_count": { "description": "Number of messages deleted by the administrator", "is_optional": false, "type": "int32" }, "restricted_user_count": { "description": "Number of users restricted by the administrator", "is_optional": false, "type": "int32" }, "user_id": { "description": "Administrator user identifier", "is_optional": false, "type": "int53" } }, "type": "ChatStatisticsAdministratorActionsInfo" }, "chatStatisticsChannel": { "description": "A detailed statistics about a channel chat", "args": { "enabled_notifications_percentage": { "description": "A percentage of users with enabled notifications for the chat; 0-100", "is_optional": false, "type": "double" }, "instant_view_interaction_graph": { "description": "A graph containing number of views of associated with the chat instant views", "is_optional": false, "type": "StatisticalGraph" }, "join_by_source_graph": { "description": "A graph containing number of new member joins per source", "is_optional": false, "type": "StatisticalGraph" }, "join_graph": { "description": "A graph containing number of members joined and left the chat", "is_optional": false, "type": "StatisticalGraph" }, "language_graph": { "description": "A graph containing number of users viewed chat messages per language", "is_optional": false, "type": "StatisticalGraph" }, "mean_message_reaction_count": { "description": "Mean number of times reactions were added to the recently sent messages", "is_optional": false, "type": "statisticalValue" }, "mean_message_share_count": { "description": "Mean number of times the recently sent messages were shared", "is_optional": false, "type": "statisticalValue" }, "mean_message_view_count": { "description": "Mean number of times the recently sent messages were viewed", "is_optional": false, "type": "statisticalValue" }, "mean_story_reaction_count": { "description": "Mean number of times reactions were added to the recently posted stories", "is_optional": false, "type": "statisticalValue" }, "mean_story_share_count": { "description": "Mean number of times the recently posted stories were shared", "is_optional": false, "type": "statisticalValue" }, "mean_story_view_count": { "description": "Mean number of times the recently posted stories were viewed", "is_optional": false, "type": "statisticalValue" }, "member_count": { "description": "Number of members in the chat", "is_optional": false, "type": "statisticalValue" }, "member_count_graph": { "description": "A graph containing number of members in the chat", "is_optional": false, "type": "StatisticalGraph" }, "message_interaction_graph": { "description": "A graph containing number of chat message views and shares", "is_optional": false, "type": "StatisticalGraph" }, "message_reaction_graph": { "description": "A graph containing number of reactions on messages", "is_optional": false, "type": "StatisticalGraph" }, "mute_graph": { "description": "A graph containing number of members muted and unmuted the chat", "is_optional": false, "type": "StatisticalGraph" }, "period": { "description": "A period to which the statistics applies", "is_optional": false, "type": "dateRange" }, "recent_interactions": { "description": "Detailed statistics about number of views and shares of recently sent messages and posted stories", "is_optional": false, "type": "vector\u003cchatStatisticsInteractionInfo\u003e" }, "story_interaction_graph": { "description": "A graph containing number of story views and shares", "is_optional": false, "type": "StatisticalGraph" }, "story_reaction_graph": { "description": "A graph containing number of reactions on stories", "is_optional": false, "type": "StatisticalGraph" }, "view_count_by_hour_graph": { "description": "A graph containing number of message views in a given hour in the last two weeks", "is_optional": false, "type": "StatisticalGraph" }, "view_count_by_source_graph": { "description": "A graph containing number of message views per source", "is_optional": false, "type": "StatisticalGraph" } }, "type": "ChatStatistics" }, "chatStatisticsInteractionInfo": { "description": "Contains statistics about interactions with a message sent in the chat or a story posted on behalf of the chat", "args": { "forward_count": { "description": "Number of times the object was forwarded", "is_optional": false, "type": "int32" }, "object_type": { "description": "Type of the object", "is_optional": false, "type": "ChatStatisticsObjectType" }, "reaction_count": { "description": "Number of times reactions were added to the object", "is_optional": false, "type": "int32" }, "view_count": { "description": "Number of times the object was viewed", "is_optional": false, "type": "int32" } }, "type": "ChatStatisticsInteractionInfo" }, "chatStatisticsInviterInfo": { "description": "Contains statistics about number of new members invited by a user", "args": { "added_member_count": { "description": "Number of new members invited by the user", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "ChatStatisticsInviterInfo" }, "chatStatisticsMessageSenderInfo": { "description": "Contains statistics about messages sent by a user", "args": { "average_character_count": { "description": "Average number of characters in sent messages; 0 if unknown", "is_optional": false, "type": "int32" }, "sent_message_count": { "description": "Number of sent messages", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "ChatStatisticsMessageSenderInfo" }, "chatStatisticsObjectTypeMessage": { "description": "Describes a message sent in the chat", "args": { "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "ChatStatisticsObjectType" }, "chatStatisticsObjectTypeStory": { "description": "Describes a story posted on behalf of the chat", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" } }, "type": "ChatStatisticsObjectType" }, "chatStatisticsSupergroup": { "description": "A detailed statistics about a supergroup chat", "args": { "action_graph": { "description": "A graph containing number of different actions in the chat", "is_optional": false, "type": "StatisticalGraph" }, "day_graph": { "description": "A graph containing distribution of message views per hour", "is_optional": false, "type": "StatisticalGraph" }, "join_by_source_graph": { "description": "A graph containing number of new member joins per source", "is_optional": false, "type": "StatisticalGraph" }, "join_graph": { "description": "A graph containing number of members joined and left the chat", "is_optional": false, "type": "StatisticalGraph" }, "language_graph": { "description": "A graph containing distribution of active users per language", "is_optional": false, "type": "StatisticalGraph" }, "member_count": { "description": "Number of members in the chat", "is_optional": false, "type": "statisticalValue" }, "member_count_graph": { "description": "A graph containing number of members in the chat", "is_optional": false, "type": "StatisticalGraph" }, "message_content_graph": { "description": "A graph containing distribution of sent messages by content type", "is_optional": false, "type": "StatisticalGraph" }, "message_count": { "description": "Number of messages sent to the chat", "is_optional": false, "type": "statisticalValue" }, "period": { "description": "A period to which the statistics applies", "is_optional": false, "type": "dateRange" }, "sender_count": { "description": "Number of users who sent messages to the chat", "is_optional": false, "type": "statisticalValue" }, "top_administrators": { "description": "List of most active administrators in the last week", "is_optional": false, "type": "vector\u003cchatStatisticsAdministratorActionsInfo\u003e" }, "top_inviters": { "description": "List of most active inviters of new members in the last week", "is_optional": false, "type": "vector\u003cchatStatisticsInviterInfo\u003e" }, "top_senders": { "description": "List of users sent most messages in the last week", "is_optional": false, "type": "vector\u003cchatStatisticsMessageSenderInfo\u003e" }, "viewer_count": { "description": "Number of users who viewed messages in the chat", "is_optional": false, "type": "statisticalValue" }, "week_graph": { "description": "A graph containing distribution of message views per day of week", "is_optional": false, "type": "StatisticalGraph" } }, "type": "ChatStatistics" }, "chatThemeEmoji": { "description": "A chat theme based on an emoji", "args": { "name": { "description": "Name of the theme; full theme description is received through updateEmojiChatThemes", "is_optional": false, "type": "string" } }, "type": "ChatTheme" }, "chatThemeGift": { "description": "A chat theme based on an upgraded gift", "args": { "gift_theme": { "description": "The chat theme", "is_optional": false, "type": "giftChatTheme" } }, "type": "ChatTheme" }, "chatTypeBasicGroup": { "description": "A basic group (a chat with 0-200 other users)", "args": { "basic_group_id": { "description": "Basic group identifier", "is_optional": false, "type": "int53" } }, "type": "ChatType" }, "chatTypePrivate": { "description": "An ordinary chat with a user", "args": { "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "ChatType" }, "chatTypeSecret": { "description": "A secret chat with a user", "args": { "secret_chat_id": { "description": "Secret chat identifier", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier of the other user in the secret chat", "is_optional": false, "type": "int53" } }, "type": "ChatType" }, "chatTypeSupergroup": { "description": "A supergroup or channel (with unlimited members)", "args": { "is_channel": { "description": "True, if the supergroup is a channel", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Supergroup or channel identifier", "is_optional": false, "type": "int53" } }, "type": "ChatType" }, "chats": { "description": "Represents a list of chats", "args": { "chat_ids": { "description": "List of chat identifiers", "is_optional": false, "type": "vector\u003cint53\u003e" }, "total_count": { "description": "Approximate total number of chats found", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "checkChatUsernameResultOk": { "description": "The username can be set", "args": {}, "type": "CheckChatUsernameResult" }, "checkChatUsernameResultPublicChatsTooMany": { "description": "The user has too many chats with username, one of them must be made private first", "args": {}, "type": "CheckChatUsernameResult" }, "checkChatUsernameResultPublicGroupsUnavailable": { "description": "The user can't be a member of a public supergroup", "args": {}, "type": "CheckChatUsernameResult" }, "checkChatUsernameResultUsernameInvalid": { "description": "The username is invalid", "args": {}, "type": "CheckChatUsernameResult" }, "checkChatUsernameResultUsernameOccupied": { "description": "The username is occupied", "args": {}, "type": "CheckChatUsernameResult" }, "checkChatUsernameResultUsernamePurchasable": { "description": "The username can be purchased at https://fragment.com. Information about the username can be received using getCollectibleItemInfo", "args": {}, "type": "CheckChatUsernameResult" }, "checkStickerSetNameResultNameInvalid": { "description": "The name is invalid", "args": {}, "type": "CheckStickerSetNameResult" }, "checkStickerSetNameResultNameOccupied": { "description": "The name is occupied", "args": {}, "type": "CheckStickerSetNameResult" }, "checkStickerSetNameResultOk": { "description": "The name can be set", "args": {}, "type": "CheckStickerSetNameResult" }, "checklist": { "description": "Describes a checklist", "args": { "can_add_tasks": { "description": "True, if the current user can add tasks to the list if they have Telegram Premium subscription", "is_optional": false, "type": "Bool" }, "can_mark_tasks_as_done": { "description": "True, if the current user can mark tasks as done or not done if they have Telegram Premium subscription", "is_optional": false, "type": "Bool" }, "others_can_add_tasks": { "description": "True, if users other than creator of the list can add tasks to the list", "is_optional": false, "type": "Bool" }, "others_can_mark_tasks_as_done": { "description": "True, if users other than creator of the list can mark tasks as done or not done. If true, then the checklist is called \"group checklist\"", "is_optional": false, "type": "Bool" }, "tasks": { "description": "List of tasks in the checklist", "is_optional": false, "type": "vector\u003cchecklistTask\u003e" }, "title": { "description": "Title of the checklist; may contain only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities", "is_optional": false, "type": "formattedText" } }, "type": "Checklist" }, "checklistTask": { "description": "Describes a task in a checklist", "args": { "completed_by": { "description": "Identifier of the user or chat that completed the task; may be null if the task isn't completed yet", "is_optional": true, "type": "MessageSender" }, "completion_date": { "description": "Point in time (Unix timestamp) when the task was completed; 0 if the task isn't completed", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the task", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the task; may contain only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, DateTime and automatically found entities", "is_optional": false, "type": "formattedText" } }, "type": "ChecklistTask" }, "closeBirthdayUser": { "description": "Describes a user who had or will have a birthday soon", "args": { "birthdate": { "description": "Birthdate of the user", "is_optional": false, "type": "birthdate" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "CloseBirthdayUser" }, "closedVectorPath": { "description": "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", "args": { "commands": { "description": "List of vector path commands", "is_optional": false, "type": "vector\u003cVectorPathCommand\u003e" } }, "type": "ClosedVectorPath" }, "collectibleItemInfo": { "description": "Contains information about a collectible item and its last purchase", "args": { "amount": { "description": "The paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "cryptocurrency": { "description": "Cryptocurrency used to pay for the item", "is_optional": false, "type": "string" }, "cryptocurrency_amount": { "description": "The paid amount, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "currency": { "description": "Currency for the paid amount", "is_optional": false, "type": "string" }, "purchase_date": { "description": "Point in time (Unix timestamp) when the item was purchased", "is_optional": false, "type": "int32" }, "url": { "description": "Individual URL for the item on https://fragment.com", "is_optional": false, "type": "string" } }, "type": "CollectibleItemInfo" }, "collectibleItemTypePhoneNumber": { "description": "A phone number", "args": { "phone_number": { "description": "The phone number", "is_optional": false, "type": "string" } }, "type": "CollectibleItemType" }, "collectibleItemTypeUsername": { "description": "A username", "args": { "username": { "description": "The username", "is_optional": false, "type": "string" } }, "type": "CollectibleItemType" }, "community": { "description": "Represents a community consisting of supergroup chats, channel chats and chats with bots", "args": { "date": { "description": "Point in time (Unix timestamp) when the community was joined, or the point in time when the community was created, in case the user is not a member of any chat in the community", "is_optional": false, "type": "int32" }, "have_access": { "description": "If false, the community is inaccessible, and the only information known about the community is inside this class. Identifier of the community can't be passed to any method", "is_optional": false, "type": "Bool" }, "id": { "description": "Community identifier", "is_optional": false, "type": "int53" }, "name": { "description": "Community name", "is_optional": false, "type": "string" }, "permissions": { "description": "Actions that non-administrator community members are allowed to take in the community", "is_optional": false, "type": "communityPermissions" }, "photo": { "description": "Community photo; may be null", "is_optional": true, "type": "chatPhotoInfo" }, "status": { "description": "Status of the current user in the community", "is_optional": false, "type": "CommunityMemberStatus" } }, "type": "Community" }, "communityAdministratorRights": { "description": "Describes rights of the administrator in a community", "args": { "can_ban_members": { "description": "True, if the administrator can ban, or unban community members", "is_optional": false, "type": "Bool" }, "can_change_info": { "description": "True, if the administrator can change the community name, photo, and other settings", "is_optional": false, "type": "Bool" }, "can_edit_chat_list": { "description": "True, if the user can change the chats added to the community", "is_optional": false, "type": "Bool" }, "can_manage_community": { "description": "True, if the user is an administrator. Implied by any other privilege", "is_optional": false, "type": "Bool" }, "can_promote_members": { "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that were directly or indirectly promoted by them", "is_optional": false, "type": "Bool" } }, "type": "CommunityAdministratorRights" }, "communityChat": { "description": "Describes a chat in a community", "args": { "can_view_history": { "description": "True, if message history of the chat can be viewed", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Identifier of the chat in the community", "is_optional": false, "type": "int53" }, "is_hidden": { "description": "True, if the chat is hidden in the list of community chats; for community administrators only", "is_optional": false, "type": "Bool" } }, "type": "CommunityChat" }, "communityFullInfo": { "description": "Contains full information about a community", "args": { "add_chat_request_count": { "description": "Number of pending requests for addition of chats to the community; 0 if the current user isn't an administrator of the community", "is_optional": false, "type": "int32" }, "administrator_count": { "description": "Number of privileged users in the community; 0 if the current user isn't an administrator of the community", "is_optional": false, "type": "int32" }, "banned_count": { "description": "Number of users banned from the community; 0 if the current user isn't an administrator of the community", "is_optional": false, "type": "int32" }, "chats": { "description": "Chats belonging to the community", "is_optional": false, "type": "vector\u003ccommunityChat\u003e" }, "photo": { "description": "Photo of the community", "is_optional": false, "type": "chatPhoto" } }, "type": "CommunityFullInfo" }, "communityId": { "description": "Contains identifier of a community", "args": { "id": { "description": "Community identifier", "is_optional": false, "type": "int53" } }, "type": "CommunityId" }, "communityMemberStatusAdministrator": { "description": "The user is a member of the community and has some additional privileges", "args": { "can_be_edited": { "description": "True, if the current user can edit the administrator privileges for the called user", "is_optional": false, "type": "Bool" }, "rights": { "description": "Rights of the administrator", "is_optional": false, "type": "communityAdministratorRights" } }, "type": "CommunityMemberStatus" }, "communityMemberStatusBanned": { "description": "The user or the chat was banned in the community; implies ban in all chats in the community", "args": {}, "type": "CommunityMemberStatus" }, "communityMemberStatusCreator": { "description": "The user is the owner of the community and has all the administrator privileges", "args": {}, "type": "CommunityMemberStatus" }, "communityMemberStatusLeft": { "description": "The user or the chat is not a community member", "args": {}, "type": "CommunityMemberStatus" }, "communityMemberStatusMember": { "description": "The user is a member of the community, without any additional privileges or restrictions", "args": {}, "type": "CommunityMemberStatus" }, "communityPermissions": { "description": "Describes actions that a user is allowed to take in a community", "args": { "can_edit_chat_list": { "description": "True, if the user can change the chats added to the community", "is_optional": false, "type": "Bool" } }, "type": "CommunityPermissions" }, "connectedAffiliateProgram": { "description": "Describes an affiliate program that was connected to an affiliate", "args": { "bot_user_id": { "description": "User identifier of the bot created the program", "is_optional": false, "type": "int53" }, "connection_date": { "description": "Point in time (Unix timestamp) when the affiliate program was connected", "is_optional": false, "type": "int32" }, "is_disconnected": { "description": "True, if the program was canceled by the bot, or disconnected by the chat owner and isn't available anymore", "is_optional": false, "type": "Bool" }, "parameters": { "description": "The parameters of the affiliate program", "is_optional": false, "type": "affiliateProgramParameters" }, "revenue_star_count": { "description": "The number of Telegram Stars that were earned by the affiliate program", "is_optional": false, "type": "int53" }, "url": { "description": "The link that can be used to refer users if the program is still active", "is_optional": false, "type": "string" }, "user_count": { "description": "The number of users that used the affiliate program", "is_optional": false, "type": "int64" } }, "type": "ConnectedAffiliateProgram" }, "connectedAffiliatePrograms": { "description": "Represents a list of affiliate programs that were connected to an affiliate", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "programs": { "description": "The list of connected affiliate programs", "is_optional": false, "type": "vector\u003cconnectedAffiliateProgram\u003e" }, "total_count": { "description": "The total number of affiliate programs that were connected to the affiliate", "is_optional": false, "type": "int32" } }, "type": "ConnectedAffiliatePrograms" }, "connectedWebsite": { "description": "Contains information about one website the current user is logged in with Telegram", "args": { "bot_user_id": { "description": "User identifier of a bot linked with the website", "is_optional": false, "type": "int53" }, "browser": { "description": "The version of a browser used to log in", "is_optional": false, "type": "string" }, "domain_name": { "description": "The domain name of the website", "is_optional": false, "type": "string" }, "id": { "description": "Website identifier", "is_optional": false, "type": "int64" }, "ip_address": { "description": "IP address from which the user was logged in, in human-readable format", "is_optional": false, "type": "string" }, "last_active_date": { "description": "Point in time (Unix timestamp) when obtained authorization was last used", "is_optional": false, "type": "int32" }, "location": { "description": "Human-readable description of a country and a region from which the user was logged in, based on the IP address", "is_optional": false, "type": "string" }, "log_in_date": { "description": "Point in time (Unix timestamp) when the user was logged in", "is_optional": false, "type": "int32" }, "platform": { "description": "Operating system the browser is running on", "is_optional": false, "type": "string" } }, "type": "ConnectedWebsite" }, "connectedWebsites": { "description": "Contains a list of websites the current user is logged in with Telegram", "args": { "websites": { "description": "List of connected websites", "is_optional": false, "type": "vector\u003cconnectedWebsite\u003e" } }, "type": "ConnectedWebsites" }, "connectionStateConnecting": { "description": "Establishing a connection to the Telegram servers", "args": {}, "type": "ConnectionState" }, "connectionStateConnectingToProxy": { "description": "Establishing a connection with a proxy server", "args": {}, "type": "ConnectionState" }, "connectionStateReady": { "description": "There is a working connection to the Telegram servers", "args": {}, "type": "ConnectionState" }, "connectionStateUpdating": { "description": "Downloading data expected to be received while the application was offline", "args": {}, "type": "ConnectionState" }, "connectionStateWaitingForNetwork": { "description": "Waiting for the network to become available. Use setNetworkType to change the available network type", "args": {}, "type": "ConnectionState" }, "contact": { "description": "Describes a contact of a user", "args": { "first_name": { "description": "First name of the user; 1-64 characters", "is_optional": false, "type": "string" }, "last_name": { "description": "Last name of the user; 0-64 characters", "is_optional": false, "type": "string" }, "phone_number": { "description": "Phone number of the user", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user, if known; 0 otherwise", "is_optional": false, "type": "int53" }, "vcard": { "description": "Additional data about the user in a form of vCard; 0-2048 bytes in length", "is_optional": false, "type": "string" } }, "type": "Contact" }, "count": { "description": "Contains a counter", "args": { "count": { "description": "Count", "is_optional": false, "type": "int32" } }, "type": "Count" }, "countries": { "description": "Contains information about countries", "args": { "countries": { "description": "The list of countries", "is_optional": false, "type": "vector\u003ccountryInfo\u003e" } }, "type": "Countries" }, "countryInfo": { "description": "Contains information about a country", "args": { "calling_codes": { "description": "List of country calling codes", "is_optional": false, "type": "vector\u003cstring\u003e" }, "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code", "is_optional": false, "type": "string" }, "english_name": { "description": "English name of the country", "is_optional": false, "type": "string" }, "flag_emoji": { "description": "An emoji for the flag of the country; may be empty if unknown", "is_optional": true, "type": "string" }, "is_hidden": { "description": "True, if the country must be hidden from the list of all countries", "is_optional": false, "type": "Bool" }, "name": { "description": "Native name of the country", "is_optional": false, "type": "string" } }, "type": "CountryInfo" }, "craftGiftResultFail": { "description": "Crafting has failed", "args": {}, "type": "CraftGiftResult" }, "craftGiftResultInvalidGift": { "description": "Crafting isn't possible because one of the gifts isn't suitable for crafting", "args": {}, "type": "CraftGiftResult" }, "craftGiftResultSuccess": { "description": "Crafting was successful", "args": { "gift": { "description": "The created gift", "is_optional": false, "type": "upgradedGift" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user", "is_optional": false, "type": "string" } }, "type": "CraftGiftResult" }, "craftGiftResultTooEarly": { "description": "Crafting isn't possible because one of the gifts can't be used for crafting yet", "args": { "retry_after": { "description": "Time left before the gift can be used for crafting", "is_optional": false, "type": "int32" } }, "type": "CraftGiftResult" }, "createdBasicGroupChat": { "description": "Contains information about a newly created basic group chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "failed_to_add_members": { "description": "Information about failed to add members", "is_optional": false, "type": "failedToAddMembers" } }, "type": "CreatedBasicGroupChat" }, "currencies": { "description": "Represents a list of currencies", "args": { "currencies": { "description": "A list of ISO 4217 currency codes", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Currencies" }, "currencyExchangeRate": { "description": "Describes exchange rate of a currency to USD", "args": { "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "rate": { "description": "Exchange rate of the currency to USD", "is_optional": false, "type": "double" } }, "type": "CurrencyExchangeRate" }, "currencyExchangeRates": { "description": "Represents a list of currency exchange rates", "args": { "rates": { "description": "A list of currency exchange rates", "is_optional": false, "type": "vector\u003ccurrencyExchangeRate\u003e" } }, "type": "CurrencyExchangeRates" }, "currentWeather": { "description": "Describes the current weather", "args": { "emoji": { "description": "Emoji representing the weather", "is_optional": false, "type": "string" }, "temperature": { "description": "Temperature, in degree Celsius", "is_optional": false, "type": "double" } }, "type": "CurrentWeather" }, "customRequestResult": { "description": "Contains the result of a custom request", "args": { "result": { "description": "A JSON-serialized result", "is_optional": false, "type": "string" } }, "type": "CustomRequestResult" }, "data": { "description": "Contains some binary data", "args": { "data": { "description": "Data", "is_optional": false, "type": "bytes" } }, "type": "Data" }, "databaseStatistics": { "description": "Contains database statistics", "args": { "statistics": { "description": "Database statistics in an unspecified human-readable format", "is_optional": false, "type": "string" } }, "type": "DatabaseStatistics" }, "date": { "description": "Represents a date according to the Gregorian calendar", "args": { "day": { "description": "Day of the month; 1-31", "is_optional": false, "type": "int32" }, "month": { "description": "Month; 1-12", "is_optional": false, "type": "int32" }, "year": { "description": "Year; 1-9999", "is_optional": false, "type": "int32" } }, "type": "Date" }, "dateRange": { "description": "Represents a date range", "args": { "end_date": { "description": "Point in time (Unix timestamp) at which the date range ends", "is_optional": false, "type": "int32" }, "start_date": { "description": "Point in time (Unix timestamp) at which the date range begins", "is_optional": false, "type": "int32" } }, "type": "DateRange" }, "dateTimeFormattingTypeAbsolute": { "description": "The date and time must be shown as absolute timestamps", "args": { "date_precision": { "description": "The precision with which the date is shown", "is_optional": false, "type": "DateTimePartPrecision" }, "show_day_of_week": { "description": "True, if the day of week must be shown", "is_optional": false, "type": "Bool" }, "time_precision": { "description": "The precision with which hours, minutes and seconds are shown", "is_optional": false, "type": "DateTimePartPrecision" } }, "type": "DateTimeFormattingType" }, "dateTimeFormattingTypeRelative": { "description": "The time must be shown relative to the current time ([in ] X seconds, minutes, hours, days, months, years [ago])", "args": {}, "type": "DateTimeFormattingType" }, "dateTimePartPrecisionLong": { "description": "Show the date or time in a long way (March 17, 2022 or 22:45:00)", "args": {}, "type": "DateTimePartPrecision" }, "dateTimePartPrecisionNone": { "description": "Don't show the date or time", "args": {}, "type": "DateTimePartPrecision" }, "dateTimePartPrecisionShort": { "description": "Show the date or time in a short way (17.03.22 or 22:45)", "args": {}, "type": "DateTimePartPrecision" }, "datedFile": { "description": "File with the date it was uploaded", "args": { "date": { "description": "Point in time (Unix timestamp) when the file was uploaded", "is_optional": false, "type": "int32" }, "file": { "description": "The file", "is_optional": false, "type": "file" } }, "type": "DatedFile" }, "deepLinkInfo": { "description": "Contains information about a tg: deep link", "args": { "need_update_application": { "description": "True, if the user must be asked to update the application", "is_optional": false, "type": "Bool" }, "text": { "description": "Text to be shown to the user", "is_optional": false, "type": "formattedText" } }, "type": "DeepLinkInfo" }, "deviceTokenApplePush": { "description": "A token for Apple Push Notification service", "args": { "device_token": { "description": "Device token; may be empty to deregister a device", "is_optional": true, "type": "string" }, "is_app_sandbox": { "description": "True, if App Sandbox is enabled", "is_optional": false, "type": "Bool" } }, "type": "DeviceToken" }, "deviceTokenApplePushVoIP": { "description": "A token for Apple Push Notification service VoIP notifications", "args": { "device_token": { "description": "Device token; may be empty to deregister a device", "is_optional": true, "type": "string" }, "encrypt": { "description": "True, if push notifications must be additionally encrypted", "is_optional": false, "type": "Bool" }, "is_app_sandbox": { "description": "True, if App Sandbox is enabled", "is_optional": false, "type": "Bool" } }, "type": "DeviceToken" }, "deviceTokenBlackBerryPush": { "description": "A token for BlackBerry Push Service", "args": { "token": { "description": "Token; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenFirebaseCloudMessaging": { "description": "A token for Firebase Cloud Messaging", "args": { "encrypt": { "description": "True, if push notifications must be additionally encrypted", "is_optional": false, "type": "Bool" }, "token": { "description": "Device registration token; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenHuaweiPush": { "description": "A token for HUAWEI Push Service", "args": { "encrypt": { "description": "True, if push notifications must be additionally encrypted", "is_optional": false, "type": "Bool" }, "token": { "description": "Device registration token; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenMicrosoftPush": { "description": "A token for Microsoft Push Notification Service", "args": { "channel_uri": { "description": "Push notification channel URI; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenMicrosoftPushVoIP": { "description": "A token for Microsoft Push Notification Service VoIP channel", "args": { "channel_uri": { "description": "Push notification channel URI; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenSimplePush": { "description": "A token for Simple Push API for Firefox OS", "args": { "endpoint": { "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenTizenPush": { "description": "A token for Tizen Push Service", "args": { "reg_id": { "description": "Push service registration identifier; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenUbuntuPush": { "description": "A token for Ubuntu Push Client service", "args": { "token": { "description": "Token; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenWebPush": { "description": "A token for web Push API", "args": { "auth_base64url": { "description": "Base64url-encoded authentication secret", "is_optional": false, "type": "string" }, "endpoint": { "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device", "is_optional": true, "type": "string" }, "p256dh_base64url": { "description": "Base64url-encoded P-256 elliptic curve Diffie-Hellman public key", "is_optional": false, "type": "string" } }, "type": "DeviceToken" }, "deviceTokenWindowsPush": { "description": "A token for Windows Push Notification Services", "args": { "access_token": { "description": "The access token that will be used to send notifications; may be empty to deregister a device", "is_optional": true, "type": "string" } }, "type": "DeviceToken" }, "diceStickersRegular": { "description": "A regular animated sticker", "args": { "sticker": { "description": "The animated sticker with the dice animation", "is_optional": false, "type": "sticker" } }, "type": "DiceStickers" }, "diceStickersSlotMachine": { "description": "Animated stickers to be combined into a slot machine", "args": { "background": { "description": "The animated sticker with the slot machine background. The background animation must start playing after all reel animations finish", "is_optional": false, "type": "sticker" }, "center_reel": { "description": "The animated sticker with the center reel", "is_optional": false, "type": "sticker" }, "left_reel": { "description": "The animated sticker with the left reel", "is_optional": false, "type": "sticker" }, "lever": { "description": "The animated sticker with the lever animation. The lever animation must play once in the initial dice state", "is_optional": false, "type": "sticker" }, "right_reel": { "description": "The animated sticker with the right reel", "is_optional": false, "type": "sticker" } }, "type": "DiceStickers" }, "diffEntity": { "description": "Represents a change of a text", "args": { "length": { "description": "Length of the entity, in UTF-16 code units", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the entity, in UTF-16 code units", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the entity", "is_optional": false, "type": "DiffEntityType" } }, "type": "DiffEntity" }, "diffEntityTypeDelete": { "description": "Removal of some text", "args": {}, "type": "DiffEntityType" }, "diffEntityTypeInsert": { "description": "Addition of some text", "args": {}, "type": "DiffEntityType" }, "diffEntityTypeReplace": { "description": "Change of some text", "args": { "old_text": { "description": "The old text", "is_optional": false, "type": "string" } }, "type": "DiffEntityType" }, "diffText": { "description": "A text with some changes highlighted", "args": { "entities": { "description": "Entities describing changes in the text. Entities don't mutually intersect with each other", "is_optional": false, "type": "vector\u003cdiffEntity\u003e" }, "text": { "description": "The text", "is_optional": false, "type": "string" } }, "type": "DiffText" }, "directMessagesChatTopic": { "description": "Contains information about a topic in a channel direct messages chat administered by the current user", "args": { "can_send_unpaid_messages": { "description": "True, if the other party can send unpaid messages even if the chat has paid messages enabled", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Identifier of the chat to which the topic belongs", "is_optional": false, "type": "int53" }, "draft_message": { "description": "A draft of a message in the topic; may be null if none", "is_optional": true, "type": "draftMessage" }, "id": { "description": "Unique topic identifier", "is_optional": false, "type": "int53" }, "is_marked_as_unread": { "description": "True, if the topic is marked as unread", "is_optional": false, "type": "Bool" }, "last_message": { "description": "Last message in the topic; may be null if none or unknown", "is_optional": true, "type": "message" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming message", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of the last read outgoing message", "is_optional": false, "type": "int53" }, "order": { "description": "A parameter used to determine order of the topic in the topic list. Topics must be sorted by the order in descending order", "is_optional": false, "type": "int64" }, "sender_id": { "description": "Identifier of the user or chat that sends the messages to the topic", "is_optional": false, "type": "MessageSender" }, "unread_count": { "description": "Number of unread messages in the chat", "is_optional": false, "type": "int53" }, "unread_reaction_count": { "description": "Number of messages with unread reactions in the chat", "is_optional": false, "type": "int53" } }, "type": "DirectMessagesChatTopic" }, "document": { "description": "Describes a document of any type", "args": { "document": { "description": "File containing the document", "is_optional": false, "type": "file" }, "file_name": { "description": "Original name of the file; as defined by the sender", "is_optional": false, "type": "string" }, "mime_type": { "description": "MIME type of the file; as defined by the sender", "is_optional": false, "type": "string" }, "minithumbnail": { "description": "Document minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "thumbnail": { "description": "Document thumbnail in JPEG or PNG format (PNG will be used only for background patterns); as defined by the sender; may be null", "is_optional": true, "type": "thumbnail" } }, "type": "Document" }, "downloadedFileCounts": { "description": "Contains number of being downloaded and recently downloaded files found", "args": { "active_count": { "description": "Number of active file downloads found, including paused", "is_optional": false, "type": "int32" }, "completed_count": { "description": "Number of completed file downloads found", "is_optional": false, "type": "int32" }, "paused_count": { "description": "Number of paused file downloads found", "is_optional": false, "type": "int32" } }, "type": "DownloadedFileCounts" }, "draftMessage": { "description": "Contains information about a message draft", "args": { "content": { "description": "Content of the message draft", "is_optional": false, "type": "DraftMessageContent" }, "date": { "description": "Point in time (Unix timestamp) when the draft was created", "is_optional": false, "type": "int32" }, "effect_id": { "description": "Identifier of the effect to apply to the message when it is sent; 0 if none", "is_optional": false, "type": "int64" }, "reply_to": { "description": "Information about the message to be replied; inputMessageReplyToStory is unsupported; may be null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "suggested_post_info": { "description": "Information about the suggested post; may be null if none", "is_optional": true, "type": "inputSuggestedPostInfo" } }, "type": "DraftMessage" }, "draftMessageContentInputRichMessage": { "description": "A rich message draft; only for setChatDraftMessage", "args": { "message": { "description": "The rich message", "is_optional": false, "type": "inputRichMessage" } }, "type": "DraftMessageContent" }, "draftMessageContentRichMessage": { "description": "A rich message draft; not supported in setChatDraftMessage", "args": { "message": { "description": "The rich message", "is_optional": false, "type": "richMessage" } }, "type": "DraftMessageContent" }, "draftMessageContentText": { "description": "A text message draft", "args": { "link_preview_options": { "description": "Options to be used for generation of a link preview; may be null if none; pass null to use default link preview options", "is_optional": true, "type": "linkPreviewOptions" }, "text": { "description": "Formatted text to be saved as a draft; 0-getOption(\"message_text_length_max\") characters", "is_optional": false, "type": "formattedText" } }, "type": "DraftMessageContent" }, "draftMessageContentVideoNote": { "description": "A video note message draft", "args": { "duration": { "description": "Duration of the video, in seconds; 0-60", "is_optional": false, "type": "int32" }, "file_path": { "description": "Path to the file with the video note", "is_optional": false, "type": "string" }, "length": { "description": "Video width and height; must be positive and not greater than 640", "is_optional": false, "type": "int32" }, "self_destruct_type": { "description": "Video note self-destruct type; may be null if none; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" } }, "type": "DraftMessageContent" }, "draftMessageContentVoiceNote": { "description": "A voice note message draft", "args": { "duration": { "description": "Duration of the voice note, in seconds", "is_optional": false, "type": "int32" }, "file_path": { "description": "Path to the file with the voice note", "is_optional": false, "type": "string" }, "self_destruct_type": { "description": "Voice note self-destruct type; may be null if none; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" }, "waveform": { "description": "Waveform representation of the voice note in 5-bit format", "is_optional": false, "type": "bytes" } }, "type": "DraftMessageContent" }, "emailAddressAuthenticationAppleId": { "description": "An authentication token received through Apple ID", "args": { "token": { "description": "The token", "is_optional": false, "type": "string" } }, "type": "EmailAddressAuthentication" }, "emailAddressAuthenticationCode": { "description": "An authentication code delivered to a user's email address", "args": { "code": { "description": "The code", "is_optional": false, "type": "string" } }, "type": "EmailAddressAuthentication" }, "emailAddressAuthenticationCodeInfo": { "description": "Information about the email address authentication code that was sent", "args": { "email_address_pattern": { "description": "Pattern of the email address to which an authentication code was sent", "is_optional": false, "type": "string" }, "length": { "description": "Length of the code; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "EmailAddressAuthenticationCodeInfo" }, "emailAddressAuthenticationGoogleId": { "description": "An authentication token received through Google ID", "args": { "token": { "description": "The token", "is_optional": false, "type": "string" } }, "type": "EmailAddressAuthentication" }, "emailAddressResetStateAvailable": { "description": "Email address can be reset after the given period. Call resetAuthenticationEmailAddress to reset it and allow the user to authorize with a code sent to the user's phone number", "args": { "wait_period": { "description": "Time required to wait before the email address can be reset; 0 if the user is subscribed to Telegram Premium", "is_optional": false, "type": "int32" } }, "type": "EmailAddressResetState" }, "emailAddressResetStatePending": { "description": "Email address reset has already been requested. Call resetAuthenticationEmailAddress to check whether immediate reset is possible", "args": { "reset_in": { "description": "Left time before the email address will be reset, in seconds. updateAuthorizationState is not sent when this field changes", "is_optional": false, "type": "int32" } }, "type": "EmailAddressResetState" }, "emojiCategories": { "description": "Represents a list of emoji categories", "args": { "categories": { "description": "List of categories", "is_optional": false, "type": "vector\u003cemojiCategory\u003e" } }, "type": "EmojiCategories" }, "emojiCategory": { "description": "Describes an emoji category", "args": { "icon": { "description": "Custom emoji sticker, which represents icon of the category", "is_optional": false, "type": "sticker" }, "is_greeting": { "description": "True, if the category must be shown first when choosing a sticker for the start page", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the category", "is_optional": false, "type": "string" }, "source": { "description": "Source of stickers for the emoji category", "is_optional": false, "type": "EmojiCategorySource" } }, "type": "EmojiCategory" }, "emojiCategorySourcePremium": { "description": "The category contains premium stickers that must be found by getPremiumStickers", "args": {}, "type": "EmojiCategorySource" }, "emojiCategorySourceSearch": { "description": "The category contains a list of similar emoji to search for in getStickers and searchStickers for stickers,", "args": { "emojis": { "description": "List of emojis to search for", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "EmojiCategorySource" }, "emojiCategoryTypeChatPhoto": { "description": "The category must be used for chat photo emoji selection", "args": {}, "type": "EmojiCategoryType" }, "emojiCategoryTypeDefault": { "description": "The category must be used by default (e.g., for custom emoji or animation search)", "args": {}, "type": "EmojiCategoryType" }, "emojiCategoryTypeEmojiStatus": { "description": "The category must be used for emoji status selection", "args": {}, "type": "EmojiCategoryType" }, "emojiCategoryTypeRegularStickers": { "description": "The category must be used by default for regular sticker selection. It may contain greeting emoji category and premium stickers", "args": {}, "type": "EmojiCategoryType" }, "emojiChatTheme": { "description": "Describes a chat theme based on an emoji", "args": { "dark_settings": { "description": "Theme settings for a dark chat theme", "is_optional": false, "type": "themeSettings" }, "light_settings": { "description": "Theme settings for a light chat theme", "is_optional": false, "type": "themeSettings" }, "name": { "description": "Theme name", "is_optional": false, "type": "string" } }, "type": "EmojiChatTheme" }, "emojiKeyword": { "description": "Represents an emoji with its keyword", "args": { "emoji": { "description": "The emoji", "is_optional": false, "type": "string" }, "keyword": { "description": "The keyword", "is_optional": false, "type": "string" } }, "type": "EmojiKeyword" }, "emojiKeywords": { "description": "Represents a list of emojis with their keywords", "args": { "emoji_keywords": { "description": "List of emojis with their keywords", "is_optional": false, "type": "vector\u003cemojiKeyword\u003e" } }, "type": "EmojiKeywords" }, "emojiReaction": { "description": "Contains information about an emoji reaction", "args": { "activate_animation": { "description": "Activate animation for the reaction", "is_optional": false, "type": "sticker" }, "appear_animation": { "description": "Appear animation for the reaction", "is_optional": false, "type": "sticker" }, "around_animation": { "description": "Around animation for the reaction; may be null", "is_optional": true, "type": "sticker" }, "center_animation": { "description": "Center animation for the reaction; may be null", "is_optional": true, "type": "sticker" }, "effect_animation": { "description": "Effect animation for the reaction", "is_optional": false, "type": "sticker" }, "emoji": { "description": "Text representation of the reaction", "is_optional": false, "type": "string" }, "is_active": { "description": "True, if the reaction can be added to new messages and enabled in chats", "is_optional": false, "type": "Bool" }, "select_animation": { "description": "Select animation for the reaction", "is_optional": false, "type": "sticker" }, "static_icon": { "description": "Static icon for the reaction", "is_optional": false, "type": "sticker" }, "title": { "description": "Reaction title", "is_optional": false, "type": "string" } }, "type": "EmojiReaction" }, "emojiStatus": { "description": "Describes an emoji to be shown instead of the Telegram Premium badge", "args": { "expiration_date": { "description": "Point in time (Unix timestamp) when the status will expire; 0 if never", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the emoji status", "is_optional": false, "type": "EmojiStatusType" } }, "type": "EmojiStatus" }, "emojiStatusCustomEmojis": { "description": "Contains a list of custom emoji identifiers for emoji statuses", "args": { "custom_emoji_ids": { "description": "The list of custom emoji identifiers", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "EmojiStatusCustomEmojis" }, "emojiStatusTypeCustomEmoji": { "description": "A custom emoji set as emoji status", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji in stickerFormatTgs format", "is_optional": false, "type": "int64" } }, "type": "EmojiStatusType" }, "emojiStatusTypeUpgradedGift": { "description": "An upgraded gift set as emoji status", "args": { "backdrop_colors": { "description": "Colors of the backdrop of the upgraded gift", "is_optional": false, "type": "upgradedGiftBackdropColors" }, "gift_name": { "description": "Unique name of the upgraded gift that can be used with internalLinkTypeUpgradedGift", "is_optional": false, "type": "string" }, "gift_title": { "description": "The title of the upgraded gift", "is_optional": false, "type": "string" }, "model_custom_emoji_id": { "description": "Custom emoji identifier of the model of the upgraded gift", "is_optional": false, "type": "int64" }, "symbol_custom_emoji_id": { "description": "Custom emoji identifier of the symbol of the upgraded gift", "is_optional": false, "type": "int64" }, "upgraded_gift_id": { "description": "Identifier of the upgraded gift", "is_optional": false, "type": "int64" } }, "type": "EmojiStatusType" }, "emojiStatuses": { "description": "Contains a list of emoji statuses", "args": { "emoji_statuses": { "description": "The list of emoji statuses identifiers", "is_optional": false, "type": "vector\u003cemojiStatus\u003e" } }, "type": "EmojiStatuses" }, "emojis": { "description": "Represents a list of emojis", "args": { "emojis": { "description": "List of emojis", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Emojis" }, "encryptedCredentials": { "description": "Contains encrypted Telegram Passport data credentials", "args": { "data": { "description": "The encrypted credentials", "is_optional": false, "type": "bytes" }, "hash": { "description": "The decrypted data hash", "is_optional": false, "type": "bytes" }, "secret": { "description": "Secret for data decryption, encrypted with the service's public key", "is_optional": false, "type": "bytes" } }, "type": "EncryptedCredentials" }, "encryptedPassportElement": { "description": "Contains information about an encrypted Telegram Passport element; for bots only", "args": { "data": { "description": "Encrypted JSON-encoded data about the user", "is_optional": false, "type": "bytes" }, "files": { "description": "List of attached files", "is_optional": false, "type": "vector\u003cdatedFile\u003e" }, "front_side": { "description": "The front side of an identity document; may be null if the element isn't an identity document", "is_optional": true, "type": "datedFile" }, "hash": { "description": "Hash of the entire element", "is_optional": false, "type": "string" }, "reverse_side": { "description": "The reverse side of an identity document; may be null", "is_optional": true, "type": "datedFile" }, "selfie": { "description": "Selfie with the document; may be null", "is_optional": true, "type": "datedFile" }, "translation": { "description": "List of files containing a certified English translation of the document", "is_optional": false, "type": "vector\u003cdatedFile\u003e" }, "type": { "description": "Type of Telegram Passport element", "is_optional": false, "type": "PassportElementType" }, "value": { "description": "Unencrypted data, phone number or email address", "is_optional": false, "type": "string" } }, "type": "EncryptedPassportElement" }, "ephemeralMessageContent": { "description": "Describes an ephemeral content of a regular message, which must be shown instead of the regular content", "args": { "can_be_saved": { "description": "True, if content of the message can be saved locally", "is_optional": false, "type": "Bool" }, "content": { "description": "Content of the message", "is_optional": false, "type": "MessageContent" }, "has_timestamped_media": { "description": "True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message", "is_optional": false, "type": "Bool" }, "reply_markup": { "description": "Reply markup for the message; may be null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "EphemeralMessageContent" }, "error": { "description": "An object of this type can be returned on every function call, in case of an error", "args": { "code": { "description": "Error code; subject to future changes. If the error code is 406, the error message must not be processed in any way and must not be displayed to the user", "is_optional": false, "type": "int32" }, "message": { "description": "Error message; subject to future changes", "is_optional": false, "type": "string" } }, "type": "Error" }, "factCheck": { "description": "Describes a fact-check added to the message by an independent checker", "args": { "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code of the country for which the fact-check is shown", "is_optional": false, "type": "string" }, "text": { "description": "Text of the fact-check", "is_optional": false, "type": "formattedText" } }, "type": "FactCheck" }, "failedToAddMember": { "description": "Contains information about a user who has failed to be added to a chat", "args": { "premium_required_to_send_messages": { "description": "True, if subscription to Telegram Premium is required to send the user chat invite link", "is_optional": false, "type": "Bool" }, "premium_would_allow_invite": { "description": "True, if subscription to Telegram Premium would have allowed to add the user to the chat", "is_optional": false, "type": "Bool" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "FailedToAddMember" }, "failedToAddMembers": { "description": "Represents a list of users that has failed to be added to a chat", "args": { "failed_to_add_members": { "description": "Information about users that weren't added to the chat", "is_optional": false, "type": "vector\u003cfailedToAddMember\u003e" } }, "type": "FailedToAddMembers" }, "file": { "description": "Represents a file", "args": { "expected_size": { "description": "Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress", "is_optional": false, "type": "int53" }, "id": { "description": "Unique file identifier", "is_optional": false, "type": "int32" }, "local": { "description": "Information about the local copy of the file", "is_optional": false, "type": "localFile" }, "remote": { "description": "Information about the remote copy of the file", "is_optional": false, "type": "remoteFile" }, "size": { "description": "File size, in bytes; 0 if unknown", "is_optional": false, "type": "int53" } }, "type": "File" }, "fileDownload": { "description": "Describes a file added to file download list", "args": { "add_date": { "description": "Point in time (Unix timestamp) when the file was added to the download list", "is_optional": false, "type": "int32" }, "complete_date": { "description": "Point in time (Unix timestamp) when the file downloading was completed; 0 if the file downloading isn't completed", "is_optional": false, "type": "int32" }, "file_id": { "description": "File identifier", "is_optional": false, "type": "int32" }, "is_paused": { "description": "True, if downloading of the file is paused", "is_optional": false, "type": "Bool" }, "message": { "description": "The message with the file", "is_optional": false, "type": "message" } }, "type": "FileDownload" }, "fileDownloadedPrefixSize": { "description": "Contains size of downloaded prefix of a file", "args": { "size": { "description": "The prefix size, in bytes", "is_optional": false, "type": "int53" } }, "type": "FileDownloadedPrefixSize" }, "fileTypeAnimation": { "description": "The file is an animation", "args": {}, "type": "FileType" }, "fileTypeAudio": { "description": "The file is an audio file", "args": {}, "type": "FileType" }, "fileTypeDocument": { "description": "The file is a document", "args": {}, "type": "FileType" }, "fileTypeLivePhotoVideo": { "description": "The file is a video for a live photo", "args": {}, "type": "FileType" }, "fileTypeNone": { "description": "The data is not a file", "args": {}, "type": "FileType" }, "fileTypeNotificationSound": { "description": "The file is a notification sound", "args": {}, "type": "FileType" }, "fileTypePhoto": { "description": "The file is a photo", "args": {}, "type": "FileType" }, "fileTypePhotoStory": { "description": "The file is a photo published as a story", "args": {}, "type": "FileType" }, "fileTypeProfilePhoto": { "description": "The file is a profile photo", "args": {}, "type": "FileType" }, "fileTypeSecret": { "description": "The file was sent to a secret chat (the file type is not known to the server)", "args": {}, "type": "FileType" }, "fileTypeSecretThumbnail": { "description": "The file is a thumbnail of a file from a secret chat", "args": {}, "type": "FileType" }, "fileTypeSecure": { "description": "The file is a file from Secure storage used for storing Telegram Passport files", "args": {}, "type": "FileType" }, "fileTypeSelfDestructingLivePhotoVideo": { "description": "The file is a self-destructing video for a live photo in a private chat", "args": {}, "type": "FileType" }, "fileTypeSelfDestructingPhoto": { "description": "The file is a self-destructing photo in a private chat", "args": {}, "type": "FileType" }, "fileTypeSelfDestructingVideo": { "description": "The file is a self-destructing video in a private chat", "args": {}, "type": "FileType" }, "fileTypeSelfDestructingVideoNote": { "description": "The file is a self-destructing video note in a private chat", "args": {}, "type": "FileType" }, "fileTypeSelfDestructingVoiceNote": { "description": "The file is a self-destructing voice note in a private chat", "args": {}, "type": "FileType" }, "fileTypeSticker": { "description": "The file is a sticker", "args": {}, "type": "FileType" }, "fileTypeThumbnail": { "description": "The file is a thumbnail of another file", "args": {}, "type": "FileType" }, "fileTypeUnknown": { "description": "The file type is not yet known", "args": {}, "type": "FileType" }, "fileTypeVideo": { "description": "The file is a video", "args": {}, "type": "FileType" }, "fileTypeVideoNote": { "description": "The file is a video note", "args": {}, "type": "FileType" }, "fileTypeVideoStory": { "description": "The file is a video published as a story", "args": {}, "type": "FileType" }, "fileTypeVoiceNote": { "description": "The file is a voice note", "args": {}, "type": "FileType" }, "fileTypeWallpaper": { "description": "The file is a wallpaper or a background pattern", "args": {}, "type": "FileType" }, "firebaseAuthenticationSettingsAndroid": { "description": "Settings for Firebase Authentication in the official Android application", "args": {}, "type": "FirebaseAuthenticationSettings" }, "firebaseAuthenticationSettingsIos": { "description": "Settings for Firebase Authentication in the official iOS application", "args": { "device_token": { "description": "Device token from Apple Push Notification service", "is_optional": false, "type": "string" }, "is_app_sandbox": { "description": "True, if App Sandbox is enabled", "is_optional": false, "type": "Bool" } }, "type": "FirebaseAuthenticationSettings" }, "firebaseDeviceVerificationParametersPlayIntegrity": { "description": "Device verification must be performed with the classic Play Integrity verification (https://developer.android.com/google/play/integrity/classic)", "args": { "cloud_project_number": { "description": "Cloud project number to pass to the Play Integrity API", "is_optional": false, "type": "int64" }, "nonce": { "description": "Base64url-encoded nonce to pass to the Play Integrity API", "is_optional": false, "type": "string" } }, "type": "FirebaseDeviceVerificationParameters" }, "firebaseDeviceVerificationParametersSafetyNet": { "description": "Device verification must be performed with the SafetyNet Attestation API", "args": { "nonce": { "description": "Nonce to pass to the SafetyNet Attestation API", "is_optional": false, "type": "bytes" } }, "type": "FirebaseDeviceVerificationParameters" }, "fixedText": { "description": "A text fixed using fixTextWithAi", "args": { "diff_text": { "description": "Changes made to the original text", "is_optional": false, "type": "diffText" }, "text": { "description": "The resulting text", "is_optional": false, "type": "formattedText" } }, "type": "FixedText" }, "formattedText": { "description": "A text with some entities", "args": { "entities": { "description": "Entities contained in the text. Entities can be nested, but must not mutually intersect with each other.", "is_optional": false, "type": "vector\u003ctextEntity\u003e" }, "text": { "description": "The text", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "forumTopic": { "description": "Describes a forum topic", "args": { "draft_message": { "description": "A draft of a message in the topic; may be null if none", "is_optional": true, "type": "draftMessage" }, "info": { "description": "Basic information about the topic", "is_optional": false, "type": "forumTopicInfo" }, "is_pinned": { "description": "True, if the topic is pinned in the topic list", "is_optional": false, "type": "Bool" }, "last_message": { "description": "Last message in the topic; may be null if unknown", "is_optional": true, "type": "message" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming message", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of the last read outgoing message", "is_optional": false, "type": "int53" }, "notification_settings": { "description": "Notification settings for the topic", "is_optional": false, "type": "chatNotificationSettings" }, "order": { "description": "A parameter used to determine order of the topic in the topic list. Topics must be sorted by the order in descending order", "is_optional": false, "type": "int64" }, "unread_count": { "description": "Number of unread messages in the topic", "is_optional": false, "type": "int32" }, "unread_mention_count": { "description": "Number of unread messages with a mention/reply in the topic", "is_optional": false, "type": "int32" }, "unread_poll_vote_count": { "description": "Number of messages with unread poll votes in the topic", "is_optional": false, "type": "int32" }, "unread_reaction_count": { "description": "Number of messages with unread reactions in the topic", "is_optional": false, "type": "int32" } }, "type": "ForumTopic" }, "forumTopicIcon": { "description": "Describes a forum topic icon", "args": { "color": { "description": "Color of the topic icon in RGB format", "is_optional": false, "type": "int32" }, "custom_emoji_id": { "description": "Unique identifier of the custom emoji shown on the topic icon; 0 if none", "is_optional": false, "type": "int64" } }, "type": "ForumTopicIcon" }, "forumTopicInfo": { "description": "Contains basic information about a forum topic", "args": { "chat_id": { "description": "Identifier of a forum supergroup chat or a chat with a bot to which the topic belongs", "is_optional": false, "type": "int53" }, "creation_date": { "description": "Point in time (Unix timestamp) when the topic was created", "is_optional": false, "type": "int32" }, "creator_id": { "description": "Identifier of the creator of the topic", "is_optional": false, "type": "MessageSender" }, "forum_topic_id": { "description": "Forum topic identifier of the topic", "is_optional": false, "type": "int32" }, "icon": { "description": "Icon of the topic", "is_optional": false, "type": "forumTopicIcon" }, "is_closed": { "description": "True, if the topic is closed. If the topic is closed, then the user must have can_manage_topics administrator right in the supergroup or must be the creator of the topic to send messages there", "is_optional": false, "type": "Bool" }, "is_general": { "description": "True, if the topic is the General topic", "is_optional": false, "type": "Bool" }, "is_hidden": { "description": "True, if the topic is hidden above the topic list and closed; for General topic only", "is_optional": false, "type": "Bool" }, "is_name_implicit": { "description": "True, if the name of the topic wasn't added explicitly", "is_optional": false, "type": "Bool" }, "is_outgoing": { "description": "True, if the topic was created by the current user", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the topic", "is_optional": false, "type": "string" } }, "type": "ForumTopicInfo" }, "forumTopics": { "description": "Describes a list of forum topics", "args": { "next_offset_date": { "description": "Offset date for the next getForumTopics request", "is_optional": false, "type": "int32" }, "next_offset_forum_topic_id": { "description": "Offset forum topic identifier for the next getForumTopics request", "is_optional": false, "type": "int32" }, "next_offset_message_id": { "description": "Offset message identifier for the next getForumTopics request", "is_optional": false, "type": "int53" }, "topics": { "description": "List of forum topics", "is_optional": false, "type": "vector\u003cforumTopic\u003e" }, "total_count": { "description": "Approximate total number of forum topics found", "is_optional": false, "type": "int32" } }, "type": "ForumTopics" }, "forwardSource": { "description": "Contains information about the last message from which a new message was forwarded last time", "args": { "chat_id": { "description": "Identifier of the chat to which the message that was forwarded belonged; may be 0 if unknown", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) when the message is sent; 0 if unknown", "is_optional": false, "type": "int32" }, "is_outgoing": { "description": "True, if the message that was forwarded is outgoing; always false if sender is unknown", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message; may be 0 if unknown", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of the message; may be null if unknown or the new message was forwarded not to Saved Messages", "is_optional": true, "type": "MessageSender" }, "sender_name": { "description": "Name of the sender of the message if the sender is hidden by their privacy settings", "is_optional": false, "type": "string" } }, "type": "ForwardSource" }, "foundAffiliateProgram": { "description": "Describes a found affiliate program", "args": { "bot_user_id": { "description": "User identifier of the bot created the program", "is_optional": false, "type": "int53" }, "info": { "description": "Information about the affiliate program", "is_optional": false, "type": "affiliateProgramInfo" } }, "type": "FoundAffiliateProgram" }, "foundAffiliatePrograms": { "description": "Represents a list of found affiliate programs", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "programs": { "description": "The list of affiliate programs", "is_optional": false, "type": "vector\u003cfoundAffiliateProgram\u003e" }, "total_count": { "description": "The total number of found affiliate programs", "is_optional": false, "type": "int32" } }, "type": "FoundAffiliatePrograms" }, "foundChatBoosts": { "description": "Contains a list of boosts applied to a chat", "args": { "boosts": { "description": "List of boosts", "is_optional": false, "type": "vector\u003cchatBoost\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "Total number of boosts applied to the chat", "is_optional": false, "type": "int32" } }, "type": "FoundChatBoosts" }, "foundChatMessages": { "description": "Contains a list of messages found by a search in a given chat", "args": { "messages": { "description": "List of messages", "is_optional": false, "type": "vector\u003cmessage\u003e" }, "next_from_message_id": { "description": "The offset for the next request. If 0, there are no more results", "is_optional": false, "type": "int53" }, "total_count": { "description": "Approximate total number of messages found; -1 if unknown", "is_optional": false, "type": "int32" } }, "type": "FoundChatMessages" }, "foundFileDownloads": { "description": "Contains a list of downloaded files, found by a search", "args": { "files": { "description": "The list of files", "is_optional": false, "type": "vector\u003cfileDownload\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_counts": { "description": "Total number of suitable files, ignoring offset", "is_optional": false, "type": "downloadedFileCounts" } }, "type": "FoundFileDownloads" }, "foundMessages": { "description": "Contains a list of messages found by a search", "args": { "messages": { "description": "List of messages", "is_optional": false, "type": "vector\u003cmessage\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "Approximate total number of messages found; -1 if unknown", "is_optional": false, "type": "int32" } }, "type": "FoundMessages" }, "foundPosition": { "description": "Contains 0-based match position", "args": { "position": { "description": "The position of the match", "is_optional": false, "type": "int32" } }, "type": "FoundPosition" }, "foundPositions": { "description": "Contains 0-based positions of matched objects", "args": { "positions": { "description": "The positions of the matched objects", "is_optional": false, "type": "vector\u003cint32\u003e" }, "total_count": { "description": "Total number of matched objects", "is_optional": false, "type": "int32" } }, "type": "FoundPositions" }, "foundPublicPosts": { "description": "Contains a list of messages found by a public post search", "args": { "are_limits_exceeded": { "description": "True, if the query has failed because search limits are exceeded. In this case search_limits.daily_free_query_count will be equal to 0", "is_optional": false, "type": "Bool" }, "messages": { "description": "List of found public posts", "is_optional": false, "type": "vector\u003cmessage\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "search_limits": { "description": "Updated public post search limits after the query; repeated requests with the same query will be free; may be null if they didn't change", "is_optional": true, "type": "publicPostSearchLimits" } }, "type": "FoundPublicPosts" }, "foundStories": { "description": "Contains a list of stories found by a search", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "stories": { "description": "List of stories", "is_optional": false, "type": "vector\u003cstory\u003e" }, "total_count": { "description": "Approximate total number of stories found", "is_optional": false, "type": "int32" } }, "type": "FoundStories" }, "foundUsers": { "description": "Represents a list of found users", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "user_ids": { "description": "Identifiers of the found users", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "FoundUsers" }, "foundWebApp": { "description": "Contains information about a Web App found by its short name", "args": { "request_write_access": { "description": "True, if the user must be asked for the permission to the bot to send them messages", "is_optional": false, "type": "Bool" }, "skip_confirmation": { "description": "True, if there is no need to show an ordinary open URL confirmation before opening the Web App. The field must be ignored and confirmation must be shown anyway if the Web App link was hidden", "is_optional": false, "type": "Bool" }, "web_app": { "description": "The Web App", "is_optional": false, "type": "webApp" } }, "type": "FoundWebApp" }, "game": { "description": "Describes a game. Use getInternalLink with internalLinkTypeGame to share the game", "args": { "animation": { "description": "Game animation; may be null", "is_optional": true, "type": "animation" }, "description": { "description": "Game description", "is_optional": false, "type": "string" }, "id": { "description": "Unique game identifier", "is_optional": false, "type": "int64" }, "photo": { "description": "Game photo", "is_optional": false, "type": "photo" }, "short_name": { "description": "Game short name", "is_optional": false, "type": "string" }, "text": { "description": "Game text, usually containing scoreboards for a game", "is_optional": false, "type": "formattedText" }, "title": { "description": "Game title", "is_optional": false, "type": "string" } }, "type": "Game" }, "gameHighScore": { "description": "Contains one row of the game high score table", "args": { "position": { "description": "Position in the high score table", "is_optional": false, "type": "int32" }, "score": { "description": "User score", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "GameHighScore" }, "gameHighScores": { "description": "Contains a list of game high scores", "args": { "scores": { "description": "A list of game high scores", "is_optional": false, "type": "vector\u003cgameHighScore\u003e" } }, "type": "GameHighScores" }, "gift": { "description": "Describes a gift that can be sent to another user or channel chat", "args": { "auction_info": { "description": "Information about the auction on which the gift can be purchased; may be null if the gift can be purchased directly", "is_optional": true, "type": "giftAuction" }, "background": { "description": "Background of the gift; may be null if the gift has no background", "is_optional": true, "type": "giftBackground" }, "default_sell_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver instead of the regular gift by default. If the gift was paid with just bought Telegram Stars, then full value can be claimed", "is_optional": false, "type": "int53" }, "first_send_date": { "description": "Point in time (Unix timestamp) when the gift was sent for the first time; for sold out gifts only", "is_optional": false, "type": "int32" }, "has_colors": { "description": "True, if the gift can be used to customize the user's name, and backgrounds of profile photo, reply header, and link preview", "is_optional": false, "type": "Bool" }, "id": { "description": "Unique identifier of the gift", "is_optional": false, "type": "int64" }, "is_for_birthday": { "description": "True, if the gift is a birthday gift", "is_optional": false, "type": "Bool" }, "is_premium": { "description": "True, if the gift can be bought only by Telegram Premium subscribers", "is_optional": false, "type": "Bool" }, "last_send_date": { "description": "Point in time (Unix timestamp) when the gift was sent for the last time; for sold out gifts only", "is_optional": false, "type": "int32" }, "next_send_date": { "description": "Point in time (Unix timestamp) when the gift can be sent next time by the current user; may be 0 or a date in the past.", "is_optional": false, "type": "int32" }, "overall_limits": { "description": "Number of times the gift can be purchased by all users; may be null if not limited", "is_optional": true, "type": "giftPurchaseLimits" }, "publisher_chat_id": { "description": "Identifier of the chat that published the gift; 0 if none", "is_optional": false, "type": "int53" }, "star_count": { "description": "Number of Telegram Stars that must be paid for the gift", "is_optional": false, "type": "int53" }, "sticker": { "description": "The sticker representing the gift", "is_optional": false, "type": "sticker" }, "upgrade_star_count": { "description": "Number of Telegram Stars that must be paid to upgrade the gift; 0 if upgrade isn't possible", "is_optional": false, "type": "int53" }, "upgrade_variant_count": { "description": "Number of unique gift variants that are available for the upgraded gift; 0 if unknown", "is_optional": false, "type": "int32" }, "user_limits": { "description": "Number of times the gift can be purchased by the current user; may be null if not limited", "is_optional": true, "type": "giftPurchaseLimits" } }, "type": "Gift" }, "giftAuction": { "description": "Describes an auction on which a gift can be purchased", "args": { "gifts_per_round": { "description": "Number of gifts distributed in each round", "is_optional": false, "type": "int32" }, "id": { "description": "Identifier of the auction", "is_optional": false, "type": "string" }, "start_date": { "description": "Point in time (Unix timestamp) when the auction will start", "is_optional": false, "type": "int32" } }, "type": "GiftAuction" }, "giftAuctionAcquiredGift": { "description": "Represents a gift that was acquired by the current user on an auction", "args": { "auction_round_number": { "description": "Identifier of the auction round in which the gift was acquired", "is_optional": false, "type": "int32" }, "auction_round_position": { "description": "Position of the user in the round among all auction participants", "is_optional": false, "type": "int32" }, "date": { "description": "Point in time (Unix timestamp) when the gift was acquired", "is_optional": false, "type": "int32" }, "is_private": { "description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "receiver_id": { "description": "Receiver of the gift", "is_optional": false, "type": "MessageSender" }, "star_count": { "description": "The number of Telegram Stars that were paid for the gift", "is_optional": false, "type": "int53" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" }, "unique_gift_number": { "description": "Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned", "is_optional": false, "type": "int32" } }, "type": "GiftAuctionAcquiredGift" }, "giftAuctionAcquiredGifts": { "description": "Represents a list of gifts that were acquired by the current user on an auction", "args": { "gifts": { "description": "The list of acquired gifts", "is_optional": false, "type": "vector\u003cgiftAuctionAcquiredGift\u003e" } }, "type": "GiftAuctionAcquiredGifts" }, "giftAuctionState": { "description": "Represent auction state of a gift", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "state": { "description": "Auction state of the gift", "is_optional": false, "type": "AuctionState" } }, "type": "GiftAuctionState" }, "giftBackground": { "description": "Describes background of a gift", "args": { "center_color": { "description": "Center color in RGB format", "is_optional": false, "type": "int32" }, "edge_color": { "description": "Edge color in RGB format", "is_optional": false, "type": "int32" }, "text_color": { "description": "Text color in RGB format", "is_optional": false, "type": "int32" } }, "type": "GiftBackground" }, "giftChatTheme": { "description": "Describes a chat theme based on an upgraded gift", "args": { "dark_settings": { "description": "Theme settings for a dark chat theme", "is_optional": false, "type": "themeSettings" }, "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "light_settings": { "description": "Theme settings for a light chat theme", "is_optional": false, "type": "themeSettings" } }, "type": "GiftChatTheme" }, "giftChatThemes": { "description": "Contains a list of chat themes based on upgraded gifts", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "themes": { "description": "A list of chat themes", "is_optional": false, "type": "vector\u003cgiftChatTheme\u003e" } }, "type": "GiftChatThemes" }, "giftCollection": { "description": "Describes collection of gifts", "args": { "gift_count": { "description": "Total number of gifts in the collection", "is_optional": false, "type": "int32" }, "icon": { "description": "Icon of the collection; may be null if none", "is_optional": true, "type": "sticker" }, "id": { "description": "Unique identifier of the collection", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the collection", "is_optional": false, "type": "string" } }, "type": "GiftCollection" }, "giftCollections": { "description": "Contains a list of gift collections", "args": { "collections": { "description": "List of gift collections", "is_optional": false, "type": "vector\u003cgiftCollection\u003e" } }, "type": "GiftCollections" }, "giftForResale": { "description": "Describes a gift available for resale", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user; only for the gifts owned by the current user", "is_optional": false, "type": "string" } }, "type": "GiftForResale" }, "giftForResaleOrderNumber": { "description": "The gifts will be sorted by their number from the smallest to the largest", "args": {}, "type": "GiftForResaleOrder" }, "giftForResaleOrderPrice": { "description": "The gifts will be sorted by their price from the lowest to the highest", "args": {}, "type": "GiftForResaleOrder" }, "giftForResaleOrderPriceChangeDate": { "description": "The gifts will be sorted by the last date when their price was changed from the newest to the oldest", "args": {}, "type": "GiftForResaleOrder" }, "giftPurchaseLimits": { "description": "Describes the maximum number of times that a specific gift can be purchased", "args": { "remaining_count": { "description": "Number of remaining times the gift can be purchased", "is_optional": false, "type": "int32" }, "total_count": { "description": "The maximum number of times the gifts can be purchased", "is_optional": false, "type": "int32" } }, "type": "GiftPurchaseLimits" }, "giftPurchaseOfferStateAccepted": { "description": "The offer was accepted", "args": {}, "type": "GiftPurchaseOfferState" }, "giftPurchaseOfferStatePending": { "description": "The offer must be accepted or rejected", "args": {}, "type": "GiftPurchaseOfferState" }, "giftPurchaseOfferStateRejected": { "description": "The offer was rejected", "args": {}, "type": "GiftPurchaseOfferState" }, "giftResaleParameters": { "description": "Describes parameters of a unique gift available for resale", "args": { "gram_cent_count": { "description": "Resale price of the gift in 1/100 of TON Gram", "is_optional": false, "type": "int53" }, "gram_only": { "description": "True, if the gift can be bought only using Grams", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Resale price of the gift in Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "GiftResaleParameters" }, "giftResalePriceGram": { "description": "Describes price of a resold gift in TON Grams", "args": { "gram_cent_count": { "description": "The amount of 1/100 of Gram expected to be paid for the gift. Must be in the range", "is_optional": false, "type": "int53" } }, "type": "GiftResalePrice" }, "giftResalePriceStar": { "description": "Describes price of a resold gift in Telegram Stars", "args": { "star_count": { "description": "The Telegram Star amount expected to be paid for the gift. Must be in the range", "is_optional": false, "type": "int53" } }, "type": "GiftResalePrice" }, "giftResaleResultOk": { "description": "Operation was successfully completed", "args": { "received_gift_id": { "description": "Unique identifier of the received gift; only for the gifts sent to the current user", "is_optional": false, "type": "string" } }, "type": "GiftResaleResult" }, "giftResaleResultPriceIncreased": { "description": "Operation has failed, because price has increased. If the price has decreased, then the buying will succeed anyway", "args": { "price": { "description": "New price for the gift", "is_optional": false, "type": "GiftResalePrice" } }, "type": "GiftResaleResult" }, "giftSettings": { "description": "Contains settings for gift receiving for a user", "args": { "accepted_gift_types": { "description": "Types of gifts accepted by the user; for Telegram Premium users only", "is_optional": false, "type": "acceptedGiftTypes" }, "show_gift_button": { "description": "True, if a button for sending a gift to the user or by the user must always be shown in the input field", "is_optional": false, "type": "Bool" } }, "type": "GiftSettings" }, "giftUpgradePreview": { "description": "Contains examples of possible upgraded gifts for the given regular gift", "args": { "backdrops": { "description": "Examples of possible backdrops that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftBackdrop\u003e" }, "models": { "description": "Examples of possible models that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftModel\u003e" }, "next_prices": { "description": "Next changes for the price for gift upgrade with more granularity than in prices", "is_optional": false, "type": "vector\u003cgiftUpgradePrice\u003e" }, "prices": { "description": "Examples of price for gift upgrade from the maximum price to the minimum price", "is_optional": false, "type": "vector\u003cgiftUpgradePrice\u003e" }, "symbols": { "description": "Examples of possible symbols that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftSymbol\u003e" } }, "type": "GiftUpgradePreview" }, "giftUpgradePrice": { "description": "Describes a price required to pay to upgrade a gift", "args": { "date": { "description": "Point in time (Unix timestamp) when the price will be in effect", "is_optional": false, "type": "int32" }, "star_count": { "description": "The Telegram Star amount required to pay to upgrade the gift", "is_optional": false, "type": "int53" } }, "type": "GiftUpgradePrice" }, "giftUpgradeVariants": { "description": "Contains all possible variants of upgraded gifts for the given regular gift", "args": { "backdrops": { "description": "Backdrops that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftBackdrop\u003e" }, "models": { "description": "Models that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftModel\u003e" }, "symbols": { "description": "Symbols that can be chosen for the gift after upgrade", "is_optional": false, "type": "vector\u003cupgradedGiftSymbol\u003e" } }, "type": "GiftUpgradeVariants" }, "giftsForCrafting": { "description": "Represents a list of gifts received by a user or a chat", "args": { "attribute_persistence_probabilities": { "description": "The 4 objects that describe probabilities of the crafted gift to have the backdrop or symbol of one of the original gifts", "is_optional": false, "type": "vector\u003cattributeCraftPersistenceProbability\u003e" }, "gifts": { "description": "The list of gifts", "is_optional": false, "type": "vector\u003creceivedGift\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "The total number of received gifts", "is_optional": false, "type": "int32" } }, "type": "GiftsForCrafting" }, "giftsForResale": { "description": "Describes gifts available for resale", "args": { "backdrops": { "description": "Available backdrops; for searchGiftsForResale requests without offset and attributes only", "is_optional": false, "type": "vector\u003cupgradedGiftBackdropCount\u003e" }, "gifts": { "description": "The gifts", "is_optional": false, "type": "vector\u003cgiftForResale\u003e" }, "models": { "description": "Available models; for searchGiftsForResale requests without offset and attributes only", "is_optional": false, "type": "vector\u003cupgradedGiftModelCount\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "symbols": { "description": "Available symbols; for searchGiftsForResale requests without offset and attributes only", "is_optional": false, "type": "vector\u003cupgradedGiftSymbolCount\u003e" }, "total_count": { "description": "Total number of gifts found", "is_optional": false, "type": "int32" } }, "type": "GiftsForResale" }, "giveawayInfoCompleted": { "description": "Describes a completed giveaway", "args": { "activation_count": { "description": "Number of winners, which activated their gift codes; for Telegram Premium giveaways only", "is_optional": false, "type": "int32" }, "actual_winners_selection_date": { "description": "Point in time (Unix timestamp) when the winners were selected. May be bigger than winners selection date specified in parameters of the giveaway", "is_optional": false, "type": "int32" }, "creation_date": { "description": "Point in time (Unix timestamp) when the giveaway was created", "is_optional": false, "type": "int32" }, "gift_code": { "description": "Telegram Premium gift code that was received by the current user; empty if the user isn't a winner in the giveaway or the giveaway isn't a Telegram Premium giveaway", "is_optional": false, "type": "string" }, "is_winner": { "description": "True, if the current user is a winner of the giveaway", "is_optional": false, "type": "Bool" }, "was_refunded": { "description": "True, if the giveaway was canceled and was fully refunded", "is_optional": false, "type": "Bool" }, "winner_count": { "description": "Number of winners in the giveaway", "is_optional": false, "type": "int32" }, "won_star_count": { "description": "The Telegram Star amount won by the current user; 0 if the user isn't a winner in the giveaway or the giveaway isn't a Telegram Star giveaway", "is_optional": false, "type": "int53" } }, "type": "GiveawayInfo" }, "giveawayInfoOngoing": { "description": "Describes an ongoing giveaway", "args": { "creation_date": { "description": "Point in time (Unix timestamp) when the giveaway was created", "is_optional": false, "type": "int32" }, "is_ended": { "description": "True, if the giveaway has ended and results are being prepared", "is_optional": false, "type": "Bool" }, "status": { "description": "Status of the current user in the giveaway", "is_optional": false, "type": "GiveawayParticipantStatus" } }, "type": "GiveawayInfo" }, "giveawayParameters": { "description": "Describes parameters of a giveaway", "args": { "additional_chat_ids": { "description": "Identifiers of other supergroup or channel chats that must be subscribed by the users to be eligible for the giveaway. There can be up to getOption(\"giveaway_additional_chat_count_max\") additional chats", "is_optional": false, "type": "vector\u003cint53\u003e" }, "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the winners of the giveaway for duration of the Telegram Premium subscription,", "is_optional": false, "type": "int53" }, "country_codes": { "description": "The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be eligible for the giveaway. If empty, then all users can participate in the giveaway.", "is_optional": false, "type": "vector\u003cstring\u003e" }, "has_public_winners": { "description": "True, if the list of winners of the giveaway will be available to everyone", "is_optional": false, "type": "Bool" }, "only_new_members": { "description": "True, if only new members of the chats will be eligible for the giveaway", "is_optional": false, "type": "Bool" }, "prize_description": { "description": "Additional description of the giveaway prize; 0-128 characters", "is_optional": false, "type": "string" }, "winners_selection_date": { "description": "Point in time (Unix timestamp) when the giveaway is expected to be performed; must be 60-getOption(\"giveaway_duration_max\") seconds in the future in scheduled giveaways", "is_optional": false, "type": "int32" } }, "type": "GiveawayParameters" }, "giveawayParticipantStatusAdministrator": { "description": "The user can't participate in the giveaway, because they are an administrator in one of the chats that created the giveaway", "args": { "chat_id": { "description": "Identifier of the chat administered by the user", "is_optional": false, "type": "int53" } }, "type": "GiveawayParticipantStatus" }, "giveawayParticipantStatusAlreadyWasMember": { "description": "The user can't participate in the giveaway, because they have already been member of the chat", "args": { "joined_chat_date": { "description": "Point in time (Unix timestamp) when the user joined the chat", "is_optional": false, "type": "int32" } }, "type": "GiveawayParticipantStatus" }, "giveawayParticipantStatusDisallowedCountry": { "description": "The user can't participate in the giveaway, because their phone number is from a disallowed country", "args": { "user_country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code of the user's country", "is_optional": false, "type": "string" } }, "type": "GiveawayParticipantStatus" }, "giveawayParticipantStatusEligible": { "description": "The user is eligible for the giveaway", "args": {}, "type": "GiveawayParticipantStatus" }, "giveawayParticipantStatusParticipating": { "description": "The user participates in the giveaway", "args": {}, "type": "GiveawayParticipantStatus" }, "giveawayPrizePremium": { "description": "The giveaway sends Telegram Premium subscriptions to the winners", "args": { "month_count": { "description": "Number of months the Telegram Premium subscription will be active after code activation", "is_optional": false, "type": "int32" } }, "type": "GiveawayPrize" }, "giveawayPrizeStars": { "description": "The giveaway sends Telegram Stars to the winners", "args": { "star_count": { "description": "Number of Telegram Stars that will be shared by all winners", "is_optional": false, "type": "int53" } }, "type": "GiveawayPrize" }, "gramRevenueStatistics": { "description": "A detailed statistics about TON Grams earned by the current user", "args": { "revenue_by_day_graph": { "description": "A graph containing amount of revenue in a given day", "is_optional": false, "type": "StatisticalGraph" }, "status": { "description": "Amount of earned revenue", "is_optional": false, "type": "gramRevenueStatus" }, "usd_rate": { "description": "Current exchange rate of nanogram to USD cents", "is_optional": false, "type": "double" } }, "type": "GramRevenueStatistics" }, "gramRevenueStatus": { "description": "Contains information about TON Grams earned by the current user", "args": { "available_amount": { "description": "The Gram amount that is available for withdrawal; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "balance_amount": { "description": "The Gram amount that isn't withdrawn yet; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "total_amount": { "description": "Total Gram amount earned; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int64" }, "withdrawal_enabled": { "description": "True, if Grams can be withdrawn", "is_optional": false, "type": "Bool" } }, "type": "GramRevenueStatus" }, "groupCall": { "description": "Describes a group call", "args": { "are_messages_allowed": { "description": "True, if sending of messages is allowed in the group call", "is_optional": false, "type": "Bool" }, "can_be_managed": { "description": "True, if the current user can manage the group call; for video chats and live stories only", "is_optional": false, "type": "Bool" }, "can_delete_messages": { "description": "True, if the user can delete messages in the group call", "is_optional": false, "type": "Bool" }, "can_enable_video": { "description": "True, if the current user can broadcast video or share screen", "is_optional": false, "type": "Bool" }, "can_send_messages": { "description": "True, if the current user can send messages to the group call", "is_optional": false, "type": "Bool" }, "can_toggle_are_messages_allowed": { "description": "True, if the current user can enable or disable sending of messages in the group call", "is_optional": false, "type": "Bool" }, "can_toggle_mute_new_participants": { "description": "True, if the current user can enable or disable mute_new_participants setting; for video chats only", "is_optional": false, "type": "Bool" }, "duration": { "description": "Call duration, in seconds; for ended calls only", "is_optional": false, "type": "int32" }, "enabled_start_notification": { "description": "True, if the group call is scheduled and the current user will receive a notification when the group call starts; for video chats only", "is_optional": false, "type": "Bool" }, "has_hidden_listeners": { "description": "True, if group call participants, which are muted, aren't returned in participant list; for video chats only", "is_optional": false, "type": "Bool" }, "id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "invite_link": { "description": "Invite link for the group call; for group calls that aren't bound to a chat. For video chats call getVideoChatInviteLink to get the link.", "is_optional": false, "type": "string" }, "is_active": { "description": "True, if the call is active", "is_optional": false, "type": "Bool" }, "is_joined": { "description": "True, if the call is joined", "is_optional": false, "type": "Bool" }, "is_live_story": { "description": "True, if the call is a live story of a chat", "is_optional": false, "type": "Bool" }, "is_my_video_enabled": { "description": "True, if the current user's video is enabled", "is_optional": false, "type": "Bool" }, "is_my_video_paused": { "description": "True, if the current user's video is paused", "is_optional": false, "type": "Bool" }, "is_owned": { "description": "True, if the user is the owner of the call and can end the call, change volume level of other users, or ban users there; for group calls that aren't bound to a chat", "is_optional": false, "type": "Bool" }, "is_rtmp_stream": { "description": "True, if the call is an RTMP stream instead of an ordinary video chat; for video chats and live stories only", "is_optional": false, "type": "Bool" }, "is_video_chat": { "description": "True, if the call is bound to a chat", "is_optional": false, "type": "Bool" }, "is_video_recorded": { "description": "True, if a video file is being recorded for the call", "is_optional": false, "type": "Bool" }, "loaded_all_participants": { "description": "True, if all group call participants are loaded", "is_optional": false, "type": "Bool" }, "message_sender_id": { "description": "Message sender chosen to send messages to the group call; for live stories only; may be null if the call isn't a live story", "is_optional": true, "type": "MessageSender" }, "mute_new_participants": { "description": "True, if only group call administrators can unmute new participants; for video chats only", "is_optional": false, "type": "Bool" }, "need_rejoin": { "description": "True, if user was kicked from the call because of network loss and the call needs to be rejoined", "is_optional": false, "type": "Bool" }, "paid_message_star_count": { "description": "The minimum number of Telegram Stars that must be paid by general participant for each sent message to the call; for live stories only", "is_optional": false, "type": "int53" }, "participant_count": { "description": "Number of participants in the group call", "is_optional": false, "type": "int32" }, "recent_speakers": { "description": "At most 3 recently speaking users in the group call", "is_optional": false, "type": "vector\u003cgroupCallRecentSpeaker\u003e" }, "record_duration": { "description": "Duration of the ongoing group call recording, in seconds; 0 if none. An updateGroupCall update is not triggered when value of this field changes, but the same recording goes on", "is_optional": false, "type": "int32" }, "scheduled_start_date": { "description": "Point in time (Unix timestamp) when the group call is expected to be started by an administrator; 0 if it is already active or was ended; for video chats only", "is_optional": false, "type": "int32" }, "title": { "description": "Group call title; for video chats only", "is_optional": false, "type": "string" }, "unique_id": { "description": "Persistent unique group call identifier", "is_optional": false, "type": "int64" } }, "type": "GroupCall" }, "groupCallDataChannelMain": { "description": "The main data channel for audio and video data", "args": {}, "type": "GroupCallDataChannel" }, "groupCallDataChannelScreenSharing": { "description": "The data channel for screen sharing", "args": {}, "type": "GroupCallDataChannel" }, "groupCallId": { "description": "Contains the group call identifier", "args": { "id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "GroupCallId" }, "groupCallInfo": { "description": "Contains information about a just created or just joined group call", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "join_payload": { "description": "Join response payload for tgcalls; empty if the call isn't joined", "is_optional": false, "type": "string" } }, "type": "GroupCallInfo" }, "groupCallJoinParameters": { "description": "Describes parameters used to join a group call", "args": { "audio_source_id": { "description": "Audio channel synchronization source identifier; received from tgcalls", "is_optional": false, "type": "int32" }, "is_muted": { "description": "Pass true to join the call with muted microphone", "is_optional": false, "type": "Bool" }, "is_my_video_enabled": { "description": "Pass true if the user's video is enabled", "is_optional": false, "type": "Bool" }, "payload": { "description": "Group call join payload; received from tgcalls", "is_optional": false, "type": "string" } }, "type": "GroupCallJoinParameters" }, "groupCallMessage": { "description": "Represents a message sent in a group call", "args": { "can_be_deleted": { "description": "True, if the message can be deleted by the current user; for live stories only", "is_optional": false, "type": "Bool" }, "date": { "description": "Point in time (Unix timestamp) when the message was sent", "is_optional": false, "type": "int32" }, "is_from_owner": { "description": "True, if the message is sent by the owner of the call and must be treated as a message of the maximum level; for live stories only", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Unique message identifier within the group call", "is_optional": false, "type": "int32" }, "paid_message_star_count": { "description": "The number of Telegram Stars that were paid to send the message; for live stories only", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of the message", "is_optional": false, "type": "MessageSender" }, "text": { "description": "Text of the message. If empty, then the message is a paid reaction in a live story", "is_optional": false, "type": "formattedText" } }, "type": "GroupCallMessage" }, "groupCallMessageLevel": { "description": "Represents a level of features for a message sent in a live story group call", "args": { "background_color": { "description": "Background color for the message the RGB format", "is_optional": false, "type": "int32" }, "first_color": { "description": "The first color used to show the message text in the RGB format", "is_optional": false, "type": "int32" }, "max_custom_emoji_count": { "description": "The maximum allowed number of custom emoji in the message text", "is_optional": false, "type": "int32" }, "max_text_length": { "description": "The maximum allowed length of the message text", "is_optional": false, "type": "int32" }, "min_star_count": { "description": "The minimum number of Telegram Stars required to get features of the level", "is_optional": false, "type": "int53" }, "pin_duration": { "description": "The amount of time the message of this level will be pinned, in seconds", "is_optional": false, "type": "int32" }, "second_color": { "description": "The second color used to show the message text in the RGB format", "is_optional": false, "type": "int32" } }, "type": "GroupCallMessageLevel" }, "groupCallParticipant": { "description": "Represents a group call participant", "args": { "audio_source_id": { "description": "User's audio channel synchronization source identifier", "is_optional": false, "type": "int32" }, "bio": { "description": "The participant user's bio or the participant chat's description", "is_optional": false, "type": "string" }, "can_be_muted_for_all_users": { "description": "True, if the current user can mute the participant for all other group call participants", "is_optional": false, "type": "Bool" }, "can_be_muted_for_current_user": { "description": "True, if the current user can mute the participant only for self", "is_optional": false, "type": "Bool" }, "can_be_unmuted_for_all_users": { "description": "True, if the current user can allow the participant to unmute themselves or unmute the participant (if the participant is the current user)", "is_optional": false, "type": "Bool" }, "can_be_unmuted_for_current_user": { "description": "True, if the current user can unmute the participant for self", "is_optional": false, "type": "Bool" }, "can_unmute_self": { "description": "True, if the participant is muted for all users, but can unmute themselves", "is_optional": false, "type": "Bool" }, "is_current_user": { "description": "True, if the participant is the current user", "is_optional": false, "type": "Bool" }, "is_hand_raised": { "description": "True, if the participant hand is raised", "is_optional": false, "type": "Bool" }, "is_muted_for_all_users": { "description": "True, if the participant is muted for all users", "is_optional": false, "type": "Bool" }, "is_muted_for_current_user": { "description": "True, if the participant is muted for the current user", "is_optional": false, "type": "Bool" }, "is_speaking": { "description": "True, if the participant is speaking as set by setGroupCallParticipantIsSpeaking", "is_optional": false, "type": "Bool" }, "order": { "description": "User's order in the group call participant list. Orders must be compared lexicographically. The bigger is order, the higher is user in the list. If order is empty, the user must be removed from the participant list", "is_optional": false, "type": "string" }, "participant_id": { "description": "Identifier of the group call participant", "is_optional": false, "type": "MessageSender" }, "screen_sharing_audio_source_id": { "description": "User's screen sharing audio channel synchronization source identifier", "is_optional": false, "type": "int32" }, "screen_sharing_video_info": { "description": "Information about user's screen sharing video channel; may be null if there is no active screen sharing video", "is_optional": true, "type": "groupCallParticipantVideoInfo" }, "video_info": { "description": "Information about user's video channel; may be null if there is no active video", "is_optional": true, "type": "groupCallParticipantVideoInfo" }, "volume_level": { "description": "Participant's volume level; 1-20000 in hundreds of percents", "is_optional": false, "type": "int32" } }, "type": "GroupCallParticipant" }, "groupCallParticipantVideoInfo": { "description": "Contains information about a group call participant's video channel", "args": { "endpoint_id": { "description": "Video channel endpoint identifier", "is_optional": false, "type": "string" }, "is_paused": { "description": "True, if the video is paused. This flag needs to be ignored, if new video frames are received", "is_optional": false, "type": "Bool" }, "source_groups": { "description": "List of synchronization source groups of the video", "is_optional": false, "type": "vector\u003cgroupCallVideoSourceGroup\u003e" } }, "type": "GroupCallParticipantVideoInfo" }, "groupCallParticipants": { "description": "Contains identifiers of group call participants", "args": { "participant_ids": { "description": "Identifiers of the participants", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "total_count": { "description": "Total number of group call participants", "is_optional": false, "type": "int32" } }, "type": "GroupCallParticipants" }, "groupCallRecentSpeaker": { "description": "Describes a recently speaking participant in a group call", "args": { "is_speaking": { "description": "True, is the user has spoken recently", "is_optional": false, "type": "Bool" }, "participant_id": { "description": "Group call participant identifier", "is_optional": false, "type": "MessageSender" } }, "type": "GroupCallRecentSpeaker" }, "groupCallStream": { "description": "Describes an available stream in a video chat or a live story", "args": { "channel_id": { "description": "Identifier of an audio/video channel", "is_optional": false, "type": "int32" }, "scale": { "description": "Scale of segment durations in the stream. The duration is 1000/(2**scale) milliseconds", "is_optional": false, "type": "int32" }, "time_offset": { "description": "Point in time when the stream currently ends; Unix timestamp in milliseconds", "is_optional": false, "type": "int53" } }, "type": "GroupCallStream" }, "groupCallStreams": { "description": "Represents a list of group call streams", "args": { "streams": { "description": "A list of group call streams", "is_optional": false, "type": "vector\u003cgroupCallStream\u003e" } }, "type": "GroupCallStreams" }, "groupCallVideoQualityFull": { "description": "The best available video quality", "args": {}, "type": "GroupCallVideoQuality" }, "groupCallVideoQualityMedium": { "description": "The medium video quality", "args": {}, "type": "GroupCallVideoQuality" }, "groupCallVideoQualityThumbnail": { "description": "The worst available video quality", "args": {}, "type": "GroupCallVideoQuality" }, "groupCallVideoSourceGroup": { "description": "Describes a group of video synchronization source identifiers", "args": { "semantics": { "description": "The semantics of sources, one of \"SIM\" or \"FID\"", "is_optional": false, "type": "string" }, "source_ids": { "description": "The list of synchronization source identifiers", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "GroupCallVideoSourceGroup" }, "hashtags": { "description": "Contains a list of hashtags", "args": { "hashtags": { "description": "A list of hashtags", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Hashtags" }, "httpUrl": { "description": "Contains an HTTP URL", "args": { "url": { "description": "The URL", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "identityDocument": { "description": "An identity document", "args": { "expiration_date": { "description": "Document expiration date; may be null if not applicable", "is_optional": true, "type": "date" }, "front_side": { "description": "Front side of the document", "is_optional": false, "type": "datedFile" }, "number": { "description": "Document number; 1-24 characters", "is_optional": false, "type": "string" }, "reverse_side": { "description": "Reverse side of the document; only for driver license and identity card; may be null", "is_optional": true, "type": "datedFile" }, "selfie": { "description": "Selfie with the document; may be null", "is_optional": true, "type": "datedFile" }, "translation": { "description": "List of files containing a certified English translation of the document", "is_optional": false, "type": "vector\u003cdatedFile\u003e" } }, "type": "IdentityDocument" }, "importedContact": { "description": "Describes a contact to import", "args": { "first_name": { "description": "First name of the user; 1-64 characters", "is_optional": false, "type": "string" }, "last_name": { "description": "Last name of the user; 0-64 characters", "is_optional": false, "type": "string" }, "note": { "description": "Note to add about the user; 0-getOption(\"user_note_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed;", "is_optional": false, "type": "formattedText" }, "phone_number": { "description": "Phone number of the user", "is_optional": false, "type": "string" } }, "type": "ImportedContact" }, "importedContacts": { "description": "Represents the result of an importContacts request", "args": { "importer_count": { "description": "The number of users that imported the corresponding contact; 0 for already registered users or if unavailable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "user_ids": { "description": "User identifiers of the imported contacts in the same order as they were specified in the request; 0 if the contact is not yet a registered user", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "ImportedContacts" }, "inlineButton": { "description": "Represents a button inside a rich message", "args": { "style": { "description": "Style of the button", "is_optional": false, "type": "ButtonStyle" }, "text": { "description": "Text of the button; only richTexts, richTextPlain, and richTextCustomEmoji are allowed", "is_optional": false, "type": "RichText" }, "type": { "description": "Type of the button; must be one of inlineKeyboardButtonTypeUrl, inlineKeyboardButtonTypeLoginUrl, inlineKeyboardButtonTypeWebApp, inlineKeyboardButtonTypeCallback,", "is_optional": false, "type": "InlineKeyboardButtonType" } }, "type": "InlineButton" }, "inlineKeyboardButton": { "description": "Represents a single button in an inline keyboard", "args": { "icon_custom_emoji_id": { "description": "Identifier of the custom emoji that must be shown on the button; 0 if none", "is_optional": false, "type": "int64" }, "style": { "description": "Style of the button", "is_optional": false, "type": "ButtonStyle" }, "text": { "description": "Text of the button", "is_optional": false, "type": "string" }, "type": { "description": "Type of the button", "is_optional": false, "type": "InlineKeyboardButtonType" } }, "type": "InlineKeyboardButton" }, "inlineKeyboardButtonTypeBuy": { "description": "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", "args": {}, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeCallback": { "description": "A button that sends a callback query to a bot", "args": { "data": { "description": "Data to be sent to the bot via a callback query", "is_optional": false, "type": "bytes" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeCallbackGame": { "description": "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", "args": {}, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeCallbackWithPassword": { "description": "A button that asks for the 2-step verification password of the current user and then sends a callback query to a bot", "args": { "data": { "description": "Data to be sent to the bot via a callback query", "is_optional": false, "type": "bytes" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeCopyText": { "description": "A button that copies specified text to clipboard", "args": { "text": { "description": "The text to copy to clipboard", "is_optional": false, "type": "string" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeDisabled": { "description": "A disabled button", "args": {}, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeLoginUrl": { "description": "A button that opens a specified URL and automatically authorize the current user by calling getLoginUrlInfo; not supported in ephemeral messages", "args": { "forward_text": { "description": "If non-empty, new text of the button in forwarded messages", "is_optional": true, "type": "string" }, "id": { "description": "Unique button identifier", "is_optional": false, "type": "int53" }, "url": { "description": "An HTTP URL to pass to getLoginUrlInfo", "is_optional": false, "type": "string" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeSwitchInline": { "description": "A button that forces an inline query to the bot to be inserted in the input field", "args": { "query": { "description": "Inline query to be sent to the bot", "is_optional": false, "type": "string" }, "target_chat": { "description": "Target chat from which to send the inline query", "is_optional": false, "type": "TargetChat" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeUrl": { "description": "A button that opens a specified URL", "args": { "url": { "description": "HTTP or tg:// URL to open. If the link is of the type internalLinkTypeWebApp, then the button must be marked as a Web App button", "is_optional": false, "type": "string" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeUser": { "description": "A button with a user reference to be handled in the same way as textEntityTypeMentionName entities", "args": { "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "InlineKeyboardButtonType" }, "inlineKeyboardButtonTypeWebApp": { "description": "A button that opens a Web App by calling openWebApp", "args": { "url": { "description": "An HTTP URL to pass to openWebApp", "is_optional": false, "type": "string" } }, "type": "InlineKeyboardButtonType" }, "inlineMessageId": { "description": "Contains identifier of a sent guest message", "args": { "id": { "description": "Unique identifier for the message", "is_optional": false, "type": "string" } }, "type": "InlineMessageId" }, "inlineQueryResultAnimation": { "description": "Represents an animation file", "args": { "animation": { "description": "Animation file", "is_optional": false, "type": "animation" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "title": { "description": "Animation title", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultArticle": { "description": "Represents a link to an article or web page", "args": { "description": { "description": "A short description of the result", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "thumbnail": { "description": "Result thumbnail in JPEG format; may be null", "is_optional": true, "type": "thumbnail" }, "title": { "description": "Title of the result", "is_optional": false, "type": "string" }, "url": { "description": "URL of the result, if it exists", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultAudio": { "description": "Represents an audio file", "args": { "audio": { "description": "Audio file", "is_optional": false, "type": "audio" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultContact": { "description": "Represents a user contact", "args": { "contact": { "description": "A user contact", "is_optional": false, "type": "contact" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "thumbnail": { "description": "Result thumbnail in JPEG format; may be null", "is_optional": true, "type": "thumbnail" } }, "type": "InlineQueryResult" }, "inlineQueryResultDocument": { "description": "Represents a document", "args": { "description": { "description": "Document description", "is_optional": false, "type": "string" }, "document": { "description": "Document", "is_optional": false, "type": "document" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "title": { "description": "Document title", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultGame": { "description": "Represents information about a game", "args": { "game": { "description": "Game result", "is_optional": false, "type": "game" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultLocation": { "description": "Represents a point on the map", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "location": { "description": "Location result", "is_optional": false, "type": "location" }, "thumbnail": { "description": "Result thumbnail in JPEG format; may be null", "is_optional": true, "type": "thumbnail" }, "title": { "description": "Title of the result", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultPhoto": { "description": "Represents a photo", "args": { "description": { "description": "A short description of the result, if known", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "photo": { "description": "Photo", "is_optional": false, "type": "photo" }, "title": { "description": "Title of the result, if known", "is_optional": false, "type": "string" } }, "type": "InlineQueryResult" }, "inlineQueryResultSticker": { "description": "Represents a sticker", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "sticker": { "description": "Sticker", "is_optional": false, "type": "sticker" } }, "type": "InlineQueryResult" }, "inlineQueryResultVenue": { "description": "Represents information about a venue", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "thumbnail": { "description": "Result thumbnail in JPEG format; may be null", "is_optional": true, "type": "thumbnail" }, "venue": { "description": "Venue result", "is_optional": false, "type": "venue" } }, "type": "InlineQueryResult" }, "inlineQueryResultVideo": { "description": "Represents a video", "args": { "description": { "description": "Description of the video", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "title": { "description": "Title of the video", "is_optional": false, "type": "string" }, "video": { "description": "Video", "is_optional": false, "type": "video" } }, "type": "InlineQueryResult" }, "inlineQueryResultVoiceNote": { "description": "Represents a voice note", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "title": { "description": "Title of the voice note", "is_optional": false, "type": "string" }, "voice_note": { "description": "Voice note", "is_optional": false, "type": "voiceNote" } }, "type": "InlineQueryResult" }, "inlineQueryResults": { "description": "Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query", "args": { "button": { "description": "Button to be shown above inline query results; may be null", "is_optional": true, "type": "inlineQueryResultsButton" }, "inline_query_id": { "description": "Unique identifier of the inline query", "is_optional": false, "type": "int64" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "results": { "description": "Results of the query", "is_optional": false, "type": "vector\u003cInlineQueryResult\u003e" } }, "type": "InlineQueryResults" }, "inlineQueryResultsButton": { "description": "Represents a button to be shown above inline query results", "args": { "text": { "description": "The text of the button", "is_optional": false, "type": "string" }, "type": { "description": "Type of the button", "is_optional": false, "type": "InlineQueryResultsButtonType" } }, "type": "InlineQueryResultsButton" }, "inlineQueryResultsButtonTypeStartBot": { "description": "Describes the button that opens a private chat with the bot and sends a start message to the bot with the given parameter", "args": { "parameter": { "description": "The parameter for the bot start message", "is_optional": false, "type": "string" } }, "type": "InlineQueryResultsButtonType" }, "inlineQueryResultsButtonTypeWebApp": { "description": "Describes the button that opens a Web App by calling getWebAppUrl", "args": { "url": { "description": "An HTTP URL to pass to getWebAppUrl", "is_optional": false, "type": "string" } }, "type": "InlineQueryResultsButtonType" }, "inputAnimation": { "description": "An animation to be sent", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the animation, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "animation": { "description": "Animation file to be sent", "is_optional": false, "type": "InputFile" }, "duration": { "description": "Duration of the animation, in seconds; may be replaced by the server", "is_optional": false, "type": "int32" }, "height": { "description": "Height of the animation; may be replaced by the server", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Animation thumbnail; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "width": { "description": "Width of the animation; may be replaced by the server", "is_optional": false, "type": "int32" } }, "type": "InputAnimation" }, "inputAudio": { "description": "An audio to be sent", "args": { "album_cover_thumbnail": { "description": "Thumbnail of the cover for the album; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "audio": { "description": "Audio file to be sent", "is_optional": false, "type": "InputFile" }, "duration": { "description": "Duration of the audio, in seconds; may be replaced by the server", "is_optional": false, "type": "int32" }, "performer": { "description": "Performer of the audio; 0-64 characters, may be replaced by the server", "is_optional": false, "type": "string" }, "title": { "description": "Title of the audio; 0-64 characters; may be replaced by the server", "is_optional": false, "type": "string" } }, "type": "InputAudio" }, "inputBackgroundLocal": { "description": "A background from a local file", "args": { "background": { "description": "Background file to use. Only inputFileLocal and inputFileGenerated are supported. The file must be in JPEG format for wallpapers and in PNG format for patterns", "is_optional": false, "type": "InputFile" } }, "type": "InputBackground" }, "inputBackgroundPrevious": { "description": "A background previously set in the chat; for chat backgrounds only", "args": { "message_id": { "description": "Identifier of the message with the background", "is_optional": false, "type": "int53" } }, "type": "InputBackground" }, "inputBackgroundRemote": { "description": "A background from the server", "args": { "background_id": { "description": "The background identifier", "is_optional": false, "type": "int64" } }, "type": "InputBackground" }, "inputBusinessChatLink": { "description": "Describes a business chat link to create or edit", "args": { "text": { "description": "Message draft text that will be added to the input field", "is_optional": false, "type": "formattedText" }, "title": { "description": "Link title", "is_optional": false, "type": "string" } }, "type": "InputBusinessChatLink" }, "inputBusinessStartPage": { "description": "Describes settings for a business account start page to set", "args": { "message": { "description": "Message text of the start page; 0-getOption(\"business_start_page_message_length_max\") characters", "is_optional": false, "type": "string" }, "sticker": { "description": "Greeting sticker of the start page; pass null if none. The sticker must belong to a sticker set and must not be a custom emoji", "is_optional": true, "type": "InputFile" }, "title": { "description": "Title text of the start page; 0-getOption(\"business_start_page_title_length_max\") characters", "is_optional": false, "type": "string" } }, "type": "InputBusinessStartPage" }, "inputCallDiscarded": { "description": "A just ended call", "args": { "call_id": { "description": "Identifier of the call", "is_optional": false, "type": "int32" } }, "type": "InputCall" }, "inputCallFromMessage": { "description": "A call from a message of the type messageCall with non-zero messageCall.unique_id", "args": { "chat_id": { "description": "Chat identifier of the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "InputCall" }, "inputChatPhotoAnimation": { "description": "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", "args": { "animation": { "description": "Animation to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed", "is_optional": false, "type": "InputFile" }, "main_frame_timestamp": { "description": "Timestamp of the frame, which will be used as static chat photo", "is_optional": false, "type": "double" } }, "type": "InputChatPhoto" }, "inputChatPhotoPrevious": { "description": "A previously used profile photo of the current user", "args": { "chat_photo_id": { "description": "Identifier of the current user's profile photo to reuse", "is_optional": false, "type": "int64" } }, "type": "InputChatPhoto" }, "inputChatPhotoStatic": { "description": "A static photo in JPEG format", "args": { "photo": { "description": "Photo to be set as profile photo. Only inputFileLocal and inputFileGenerated are allowed", "is_optional": false, "type": "InputFile" } }, "type": "InputChatPhoto" }, "inputChatPhotoSticker": { "description": "A sticker on a custom background", "args": { "sticker": { "description": "Information about the sticker", "is_optional": false, "type": "chatPhotoSticker" } }, "type": "InputChatPhoto" }, "inputChatThemeEmoji": { "description": "A theme based on an emoji", "args": { "name": { "description": "Name of the theme", "is_optional": false, "type": "string" } }, "type": "InputChatTheme" }, "inputChatThemeGift": { "description": "A theme based on an upgraded gift", "args": { "name": { "description": "Name of the upgraded gift. A gift can be used only in one chat in a time.", "is_optional": false, "type": "string" } }, "type": "InputChatTheme" }, "inputChecklist": { "description": "Describes a checklist to be sent", "args": { "others_can_add_tasks": { "description": "True, if other users can add tasks to the list", "is_optional": false, "type": "Bool" }, "others_can_mark_tasks_as_done": { "description": "True, if other users can mark tasks as done or not done", "is_optional": false, "type": "Bool" }, "tasks": { "description": "List of tasks in the checklist; 1-getOption(\"checklist_task_count_max\") tasks", "is_optional": false, "type": "vector\u003cinputChecklistTask\u003e" }, "title": { "description": "Title of the checklist; 1-getOption(\"checklist_title_length_max\") characters. May contain only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities", "is_optional": false, "type": "formattedText" } }, "type": "InputChecklist" }, "inputChecklistTask": { "description": "Describes a task in a checklist to be sent", "args": { "id": { "description": "Unique identifier of the task; must be positive", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the task; 1-getOption(\"checklist_task_text_length_max\") characters without line feeds. May contain only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities", "is_optional": false, "type": "formattedText" } }, "type": "InputChecklistTask" }, "inputCredentialsApplePay": { "description": "Applies if a user enters new credentials using Apple Pay", "args": { "data": { "description": "JSON-encoded data with the credential identifier", "is_optional": false, "type": "string" } }, "type": "InputCredentials" }, "inputCredentialsGooglePay": { "description": "Applies if a user enters new credentials using Google Pay", "args": { "data": { "description": "JSON-encoded data with the credential identifier", "is_optional": false, "type": "string" } }, "type": "InputCredentials" }, "inputCredentialsNew": { "description": "Applies if a user enters new credentials on a payment provider website", "args": { "allow_save": { "description": "True, if the credential identifier can be saved on the server side", "is_optional": false, "type": "Bool" }, "data": { "description": "JSON-encoded data with the credential identifier from the payment provider", "is_optional": false, "type": "string" } }, "type": "InputCredentials" }, "inputCredentialsSaved": { "description": "Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password", "args": { "saved_credentials_id": { "description": "Identifier of the saved credentials", "is_optional": false, "type": "string" } }, "type": "InputCredentials" }, "inputDocument": { "description": "A document (general file) to be sent", "args": { "disable_content_type_detection": { "description": "Pass true to disable automatic file type detection and send the document as a file. Always true for files sent to secret chats", "is_optional": false, "type": "Bool" }, "document": { "description": "File to be sent", "is_optional": false, "type": "InputFile" }, "thumbnail": { "description": "Document thumbnail; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" } }, "type": "InputDocument" }, "inputFileGenerated": { "description": "A file generated by the application. The application must handle updates updateFileGenerationStart and updateFileGenerationStop to generate the file when asked by TDLib", "args": { "conversion": { "description": "String specifying the conversion applied to the original file; must be persistent across application restarts. Conversions beginning with '#' are reserved for internal TDLib usage", "is_optional": false, "type": "string" }, "expected_size": { "description": "Expected size of the generated file, in bytes; pass 0 if unknown", "is_optional": false, "type": "int53" }, "original_path": { "description": "Local path to a file from which the file is generated. The path doesn't have to be a valid path and is used by TDLib only to detect name and MIME type of the generated file", "is_optional": false, "type": "string" } }, "type": "InputFile" }, "inputFileId": { "description": "A file defined by its unique identifier", "args": { "id": { "description": "Unique file identifier", "is_optional": false, "type": "int32" } }, "type": "InputFile" }, "inputFileLocal": { "description": "A file defined by a local path", "args": { "path": { "description": "Local path to the file", "is_optional": false, "type": "string" } }, "type": "InputFile" }, "inputFileRemote": { "description": "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.", "args": { "id": { "description": "Remote file identifier", "is_optional": false, "type": "string" } }, "type": "InputFile" }, "inputGroupCallLink": { "description": "The group call is accessible through a link", "args": { "link": { "description": "The link for the group call", "is_optional": false, "type": "string" } }, "type": "InputGroupCall" }, "inputGroupCallMessage": { "description": "The group call is accessible through a message of the type messageGroupCall", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message of the type messageGroupCall", "is_optional": false, "type": "int53" } }, "type": "InputGroupCall" }, "inputIdentityDocument": { "description": "An identity document to be saved to Telegram Passport", "args": { "expiration_date": { "description": "Document expiration date; pass null if not applicable", "is_optional": true, "type": "date" }, "front_side": { "description": "Front side of the document", "is_optional": false, "type": "InputFile" }, "number": { "description": "Document number; 1-24 characters", "is_optional": false, "type": "string" }, "reverse_side": { "description": "Reverse side of the document; only for driver license and identity card; pass null otherwise", "is_optional": true, "type": "InputFile" }, "selfie": { "description": "Selfie with the document; pass null if unavailable", "is_optional": true, "type": "InputFile" }, "translation": { "description": "List of files containing a certified English translation of the document", "is_optional": false, "type": "vector\u003cInputFile\u003e" } }, "type": "InputIdentityDocument" }, "inputInlineQueryResultAnimation": { "description": "Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC video", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageAnimation, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_mime_type": { "description": "MIME type of the video thumbnail. If non-empty, must be one of \"image/jpeg\", \"image/gif\" and \"video/mp4\"", "is_optional": true, "type": "string" }, "thumbnail_url": { "description": "URL of the result thumbnail (JPEG, GIF, or MPEG4), if it exists", "is_optional": false, "type": "string" }, "title": { "description": "Title of the query result", "is_optional": false, "type": "string" }, "video_duration": { "description": "Duration of the video, in seconds", "is_optional": false, "type": "int32" }, "video_height": { "description": "Height of the video", "is_optional": false, "type": "int32" }, "video_mime_type": { "description": "MIME type of the video file. Must be one of \"image/gif\" and \"video/mp4\"", "is_optional": false, "type": "string" }, "video_url": { "description": "The URL of the video file (file size must not exceed 1MB)", "is_optional": false, "type": "string" }, "video_width": { "description": "Width of the video", "is_optional": false, "type": "int32" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultArticle": { "description": "Represents a link to an article or web page", "args": { "description": { "description": "A short description of the result", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_height": { "description": "Thumbnail height, if known", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "URL of the result thumbnail, if it exists", "is_optional": false, "type": "string" }, "thumbnail_width": { "description": "Thumbnail width, if known", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the result", "is_optional": false, "type": "string" }, "url": { "description": "URL of the result, if it exists", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultAudio": { "description": "Represents a link to an MP3 audio file", "args": { "audio_duration": { "description": "Audio file duration, in seconds", "is_optional": false, "type": "int32" }, "audio_url": { "description": "The URL of the audio file", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageAudio, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "performer": { "description": "Performer of the audio file", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "title": { "description": "Title of the audio file", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultContact": { "description": "Represents a user contact", "args": { "contact": { "description": "User contact", "is_optional": false, "type": "contact" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_height": { "description": "Thumbnail height, if known", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "URL of the result thumbnail, if it exists", "is_optional": false, "type": "string" }, "thumbnail_width": { "description": "Thumbnail width, if known", "is_optional": false, "type": "int32" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultDocument": { "description": "Represents a link to a file", "args": { "description": { "description": "Short description of the result, if known", "is_optional": false, "type": "string" }, "document_url": { "description": "URL of the file", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageDocument, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "mime_type": { "description": "MIME type of the file content; only \"application/pdf\" and \"application/zip\" are currently allowed", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_height": { "description": "Height of the thumbnail", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "The URL of the file thumbnail, if it exists", "is_optional": false, "type": "string" }, "thumbnail_width": { "description": "Width of the thumbnail", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the resulting file", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultGame": { "description": "Represents a game", "args": { "game_short_name": { "description": "Short name of the game", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultLocation": { "description": "Represents a point on the map", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "live_period": { "description": "Amount of time relative to the message sent time until the location can be updated, in seconds", "is_optional": false, "type": "int32" }, "location": { "description": "Location result", "is_optional": false, "type": "location" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_height": { "description": "Thumbnail height, if known", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "URL of the result thumbnail, if it exists", "is_optional": false, "type": "string" }, "thumbnail_width": { "description": "Thumbnail width, if known", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the result", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultPhoto": { "description": "Represents link to a JPEG image", "args": { "description": { "description": "A short description of the result, if known", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessagePhoto, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "photo_height": { "description": "Height of the photo", "is_optional": false, "type": "int32" }, "photo_url": { "description": "The URL of the JPEG photo (photo size must not exceed 5MB)", "is_optional": false, "type": "string" }, "photo_width": { "description": "Width of the photo", "is_optional": false, "type": "int32" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_url": { "description": "URL of the photo thumbnail, if it exists", "is_optional": false, "type": "string" }, "title": { "description": "Title of the result, if known", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultSticker": { "description": "Represents a link to a WEBP, TGS, or WEBM sticker", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageSticker, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "sticker_height": { "description": "Height of the sticker", "is_optional": false, "type": "int32" }, "sticker_url": { "description": "The URL of the WEBP, TGS, or WEBM sticker (sticker file size must not exceed 5MB)", "is_optional": false, "type": "string" }, "sticker_width": { "description": "Width of the sticker", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "URL of the sticker thumbnail, if it exists", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultVenue": { "description": "Represents information about a venue", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_height": { "description": "Thumbnail height, if known", "is_optional": false, "type": "int32" }, "thumbnail_url": { "description": "URL of the result thumbnail, if it exists", "is_optional": false, "type": "string" }, "thumbnail_width": { "description": "Thumbnail width, if known", "is_optional": false, "type": "int32" }, "venue": { "description": "Venue result", "is_optional": false, "type": "venue" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultVideo": { "description": "Represents a link to a page containing an embedded video player or a video file", "args": { "description": { "description": "A short description of the result, if known", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageVideo, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "mime_type": { "description": "MIME type of the content of the video URL, only \"text/html\" or \"video/mp4\" are currently supported", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "thumbnail_url": { "description": "The URL of the video thumbnail (JPEG), if it exists", "is_optional": false, "type": "string" }, "title": { "description": "Title of the result", "is_optional": false, "type": "string" }, "video_duration": { "description": "Video duration, in seconds", "is_optional": false, "type": "int32" }, "video_height": { "description": "Height of the video", "is_optional": false, "type": "int32" }, "video_url": { "description": "URL of the embedded video player or video file", "is_optional": false, "type": "string" }, "video_width": { "description": "Width of the video", "is_optional": false, "type": "int32" } }, "type": "InputInlineQueryResult" }, "inputInlineQueryResultVoiceNote": { "description": "Represents a link to an opus-encoded audio file within an OGG container, single channel audio", "args": { "id": { "description": "Unique identifier of the query result", "is_optional": false, "type": "string" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageRichMessage, inputMessageVoiceNote, inputMessageInvoice, inputMessageLiveLocation, inputMessageLocation, inputMessageVenue or inputMessageContact", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null", "is_optional": true, "type": "ReplyMarkup" }, "title": { "description": "Title of the voice note", "is_optional": false, "type": "string" }, "voice_note_duration": { "description": "Duration of the voice note, in seconds", "is_optional": false, "type": "int32" }, "voice_note_url": { "description": "The URL of the voice note file", "is_optional": false, "type": "string" } }, "type": "InputInlineQueryResult" }, "inputInvoiceMessage": { "description": "An invoice from a message of the type messageInvoice or paid media purchase from messagePaidMedia", "args": { "chat_id": { "description": "Chat identifier of the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier. Use messageProperties.can_be_paid to check whether the message can be used in the method", "is_optional": false, "type": "int53" } }, "type": "InputInvoice" }, "inputInvoiceName": { "description": "An invoice from a link of the type internalLinkTypeInvoice", "args": { "name": { "description": "Name of the invoice", "is_optional": false, "type": "string" } }, "type": "InputInvoice" }, "inputInvoiceTelegram": { "description": "An invoice for a payment toward Telegram; must not be used in the in-store apps", "args": { "purpose": { "description": "Transaction purpose", "is_optional": false, "type": "TelegramPaymentPurpose" } }, "type": "InputInvoice" }, "inputMessageAnimation": { "description": "An animation message (GIF-style).", "args": { "animation": { "description": "The animation to be sent", "is_optional": false, "type": "inputAnimation" }, "caption": { "description": "Animation caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "has_spoiler": { "description": "True, if the animation preview must be covered by a spoiler animation; not supported in secret chats", "is_optional": false, "type": "Bool" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats", "is_optional": false, "type": "Bool" } }, "type": "InputMessageContent" }, "inputMessageAudio": { "description": "An audio message", "args": { "audio": { "description": "Audio to be sent", "is_optional": false, "type": "inputAudio" }, "caption": { "description": "Audio caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" } }, "type": "InputMessageContent" }, "inputMessageChecklist": { "description": "A message with a checklist. Checklists can't be sent to secret chats, channel chats and channel direct messages chats; for Telegram Premium users only", "args": { "checklist": { "description": "The checklist to send", "is_optional": false, "type": "inputChecklist" } }, "type": "InputMessageContent" }, "inputMessageContact": { "description": "A message containing a user contact", "args": { "contact": { "description": "Contact to send", "is_optional": false, "type": "contact" } }, "type": "InputMessageContent" }, "inputMessageDice": { "description": "A dice message", "args": { "clear_draft": { "description": "Pass true to delete message draft in the chat", "is_optional": false, "type": "Bool" }, "emoji": { "description": "Emoji on which the dice throw animation is based", "is_optional": false, "type": "string" } }, "type": "InputMessageContent" }, "inputMessageDocument": { "description": "A document message (general file)", "args": { "caption": { "description": "Document caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "document": { "description": "Document to be sent", "is_optional": false, "type": "inputDocument" } }, "type": "InputMessageContent" }, "inputMessageForwarded": { "description": "A forwarded message", "args": { "copy_options": { "description": "Options to be used to copy content of the message without reference to the original sender; pass null to forward the message as usual", "is_optional": true, "type": "messageCopyOptions" }, "from_chat_id": { "description": "Identifier for the chat this forwarded message came from", "is_optional": false, "type": "int53" }, "in_game_share": { "description": "Pass true if a game message is being shared from a launched game; applies only to game messages", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message to forward. A message can be forwarded only if messageProperties.can_be_forwarded", "is_optional": false, "type": "int53" }, "new_video_start_timestamp": { "description": "The new video start timestamp; ignored if replace_video_start_timestamp == false", "is_optional": false, "type": "int32" }, "replace_video_start_timestamp": { "description": "Pass true to replace video start timestamp in the forwarded message", "is_optional": false, "type": "Bool" } }, "type": "InputMessageContent" }, "inputMessageGame": { "description": "A message with a game; not supported for channels or secret chats", "args": { "bot_user_id": { "description": "User identifier of the bot that owns the game", "is_optional": false, "type": "int53" }, "game_short_name": { "description": "Short name of the game", "is_optional": false, "type": "string" } }, "type": "InputMessageContent" }, "inputMessageInvoice": { "description": "A message with an invoice; can be used only by bots", "args": { "description": { "description": "Product description; 0-255 characters", "is_optional": false, "type": "string" }, "invoice": { "description": "Invoice", "is_optional": false, "type": "invoice" }, "paid_media": { "description": "The content of paid media attached to the invoice; pass null if none", "is_optional": true, "type": "inputPaidMedia" }, "paid_media_caption": { "description": "Paid media caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "payload": { "description": "The invoice payload", "is_optional": false, "type": "bytes" }, "photo_height": { "description": "Product photo height", "is_optional": false, "type": "int32" }, "photo_size": { "description": "Product photo size", "is_optional": false, "type": "int32" }, "photo_url": { "description": "Product photo URL; optional", "is_optional": false, "type": "string" }, "photo_width": { "description": "Product photo width", "is_optional": false, "type": "int32" }, "provider_data": { "description": "JSON-encoded data about the invoice, which will be shared with the payment provider", "is_optional": false, "type": "string" }, "provider_token": { "description": "Payment provider token; may be empty for payments in Telegram Stars", "is_optional": true, "type": "string" }, "start_parameter": { "description": "Unique invoice bot deep link parameter for the generation of this invoice. If empty, it would be possible to pay directly from forwards of the invoice message", "is_optional": false, "type": "string" }, "title": { "description": "Product title; 1-32 characters", "is_optional": false, "type": "string" } }, "type": "InputMessageContent" }, "inputMessageLiveLocation": { "description": "A message with a live location", "args": { "location": { "description": "Initial state of the live location to be sent. Live period must be equal to 0x7FFFFFFF for permanent live locations, or between 60 and 86400", "is_optional": false, "type": "liveLocation" } }, "type": "InputMessageContent" }, "inputMessageLocation": { "description": "A message with a location", "args": { "location": { "description": "Location to be sent", "is_optional": false, "type": "location" } }, "type": "InputMessageContent" }, "inputMessagePaidMedia": { "description": "A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed", "args": { "caption": { "description": "Message caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "paid_media": { "description": "The content of the paid media", "is_optional": false, "type": "vector\u003cinputPaidMedia\u003e" }, "payload": { "description": "Bot-provided data for the paid media; bots only", "is_optional": false, "type": "string" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the media; otherwise, the caption must be shown below the media; not supported in secret chats", "is_optional": false, "type": "Bool" }, "star_count": { "description": "The number of Telegram Stars that must be paid to see the media; 1-getOption(\"paid_media_message_star_count_max\")", "is_optional": false, "type": "int53" } }, "type": "InputMessageContent" }, "inputMessagePhoto": { "description": "A photo message", "args": { "caption": { "description": "Photo caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "has_spoiler": { "description": "True, if the photo preview must be covered by a spoiler animation; not supported in secret chats", "is_optional": false, "type": "Bool" }, "photo": { "description": "Photo to be sent", "is_optional": false, "type": "inputPhoto" }, "self_destruct_type": { "description": "Photo self-destruct type; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the photo; otherwise, the caption must be shown below the photo; not supported in secret chats", "is_optional": false, "type": "Bool" } }, "type": "InputMessageContent" }, "inputMessagePoll": { "description": "A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat", "args": { "allows_multiple_answers": { "description": "True, if multiple answer options can be chosen simultaneously", "is_optional": false, "type": "Bool" }, "allows_revoting": { "description": "True, if the poll can be answered multiple times", "is_optional": false, "type": "Bool" }, "close_date": { "description": "Point in time (Unix timestamp) when the poll will automatically be closed; must be 0-getOption(\"poll_open_period_max\") seconds in the future; pass 0 if not specified", "is_optional": false, "type": "int32" }, "country_codes": { "description": "The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be able to vote; for channel chats only. If empty, then all users can participate in the poll.", "is_optional": false, "type": "vector\u003cstring\u003e" }, "description": { "description": "Poll description; pass null to use an empty description; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "hide_results_until_closes": { "description": "True, if the poll results will appear only after the poll closes", "is_optional": false, "type": "Bool" }, "is_anonymous": { "description": "True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels", "is_optional": false, "type": "Bool" }, "is_closed": { "description": "True, if the poll needs to be sent already closed; for bots only", "is_optional": false, "type": "Bool" }, "media": { "description": "Media attached to the poll; pass null if none. Must be one of the following types: inputPollMediaAnimation, inputPollMediaAudio, inputPollMediaDocument, inputPollMediaLocation,", "is_optional": true, "type": "InputPollMedia" }, "members_only": { "description": "True, if only the users that are members of the chat for more than a day will be able to vote; for channel chats only", "is_optional": false, "type": "Bool" }, "open_period": { "description": "Amount of time the poll will be active after creation, in seconds; 0-getOption(\"poll_open_period_max\"); pass 0 if not specified", "is_optional": false, "type": "int32" }, "options": { "description": "List of poll answer options; 1-getOption(\"poll_answer_count_max\") options", "is_optional": false, "type": "vector\u003cinputPollOption\u003e" }, "question": { "description": "Poll question; 1-255 characters (up to 300 characters for bots). Only custom emoji entities are allowed to be added and only by Premium users", "is_optional": false, "type": "formattedText" }, "shuffle_options": { "description": "True, if poll options must be shown in a fixed random order", "is_optional": false, "type": "Bool" }, "type": { "description": "Type of the poll", "is_optional": false, "type": "InputPollType" } }, "type": "InputMessageContent" }, "inputMessageReplyToEphemeralMessage": { "description": "Describes an ephemeral message to be replied; for bots only", "args": { "ephemeral_message_id": { "description": "The identifier of the ephemeral message to be replied", "is_optional": false, "type": "int32" } }, "type": "InputMessageReplyTo" }, "inputMessageReplyToExternalMessage": { "description": "Describes a message to be replied that is from a different chat or a forum topic; not supported in secret chats", "args": { "chat_id": { "description": "The identifier of the chat to which the message to be replied belongs", "is_optional": false, "type": "int53" }, "checklist_task_id": { "description": "Identifier of the checklist task in the message to be replied; pass 0 to reply to the whole message", "is_optional": false, "type": "int32" }, "message_id": { "description": "The identifier of the message to be replied in the specified chat. A message can be replied in another chat or forum topic only if messageProperties.can_be_replied_in_another_chat", "is_optional": false, "type": "int53" }, "poll_option_id": { "description": "Identifier of the poll option in the message to be replied; pass an empty string if none", "is_optional": false, "type": "string" }, "quote": { "description": "Quote from the message to be replied; pass null if none", "is_optional": true, "type": "inputTextQuote" } }, "type": "InputMessageReplyTo" }, "inputMessageReplyToMessage": { "description": "Describes a message to be replied in the same chat and forum topic", "args": { "checklist_task_id": { "description": "Identifier of the checklist task in the message to be replied; pass 0 to reply to the whole message", "is_optional": false, "type": "int32" }, "message_id": { "description": "The identifier of the message to be replied in the same chat and forum topic. A message can be replied in the same chat and forum topic only if messageProperties.can_be_replied", "is_optional": false, "type": "int53" }, "poll_option_id": { "description": "Identifier of the poll option in the message to be replied; pass an empty string if none", "is_optional": false, "type": "string" }, "quote": { "description": "Quote from the message to be replied; pass null if none. Must always be null for replies in secret chats", "is_optional": true, "type": "inputTextQuote" } }, "type": "InputMessageReplyTo" }, "inputMessageReplyToStory": { "description": "Describes a story to be replied", "args": { "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story. Currently, stories can be replied only in the chat that posted the story; channel stories can't be replied", "is_optional": false, "type": "int53" } }, "type": "InputMessageReplyTo" }, "inputMessageRichMessage": { "description": "A rich message", "args": { "clear_draft": { "description": "Pass true to delete message draft in the chat", "is_optional": false, "type": "Bool" }, "message": { "description": "The rich message to send", "is_optional": false, "type": "inputRichMessage" } }, "type": "InputMessageContent" }, "inputMessageStakeDice": { "description": "A stake dice message", "args": { "clear_draft": { "description": "Pass true to delete message draft in the chat", "is_optional": false, "type": "Bool" }, "stake_gram_amount": { "description": "The TON Gram amount that will be staked; in the smallest units of the currency. Must be in the range", "is_optional": false, "type": "int53" }, "state_hash": { "description": "Hash of the stake dice state. The state hash can be used only if it was received recently enough. Otherwise, a new state must be requested using getStakeDiceState", "is_optional": false, "type": "string" } }, "type": "InputMessageContent" }, "inputMessageSticker": { "description": "A sticker message", "args": { "emoji": { "description": "Emoji used to choose the sticker", "is_optional": false, "type": "string" }, "sticker": { "description": "Sticker to be sent", "is_optional": false, "type": "inputSticker" } }, "type": "InputMessageContent" }, "inputMessageStory": { "description": "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", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "InputMessageContent" }, "inputMessageText": { "description": "A text message", "args": { "clear_draft": { "description": "Pass true to delete message draft in the chat", "is_optional": false, "type": "Bool" }, "link_preview_options": { "description": "Options to be used for generation of a link preview; may be null if none; pass null to use default link preview options", "is_optional": true, "type": "linkPreviewOptions" }, "text": { "description": "Formatted text to be sent; 0-getOption(\"message_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, ExpandableBlockQuote,", "is_optional": false, "type": "formattedText" } }, "type": "InputMessageContent" }, "inputMessageVenue": { "description": "A message with information about a venue", "args": { "venue": { "description": "Venue to send", "is_optional": false, "type": "venue" } }, "type": "InputMessageContent" }, "inputMessageVideo": { "description": "A video message", "args": { "caption": { "description": "Video caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "has_spoiler": { "description": "True, if the video preview must be covered by a spoiler animation; not supported in secret chats", "is_optional": false, "type": "Bool" }, "self_destruct_type": { "description": "Video self-destruct type; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the video; otherwise, the caption must be shown below the video; not supported in secret chats", "is_optional": false, "type": "Bool" }, "video": { "description": "Video to be sent", "is_optional": false, "type": "inputVideo" } }, "type": "InputMessageContent" }, "inputMessageVideoNote": { "description": "A video note message", "args": { "self_destruct_type": { "description": "Video note self-destruct type; may be null if none; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" }, "video_note": { "description": "Video note to be sent", "is_optional": false, "type": "inputVideoNote" } }, "type": "InputMessageContent" }, "inputMessageVoiceNote": { "description": "A voice note message", "args": { "caption": { "description": "Voice note caption; pass null to use an empty caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "self_destruct_type": { "description": "Voice note self-destruct type; may be null if none; pass null if none; private chats only", "is_optional": true, "type": "MessageSelfDestructType" }, "voice_note": { "description": "Voice note to be sent", "is_optional": false, "type": "inputVoiceNote" } }, "type": "InputMessageContent" }, "inputPageBlockAnchor": { "description": "An invisible anchor", "args": { "name": { "description": "Name of the anchor", "is_optional": false, "type": "string" } }, "type": "InputPageBlock" }, "inputPageBlockAnimation": { "description": "An animation", "args": { "animation": { "description": "The animation to be sent", "is_optional": false, "type": "inputAnimation" }, "caption": { "description": "Animation caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the animation preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" } }, "type": "InputPageBlock" }, "inputPageBlockAudio": { "description": "An audio file", "args": { "audio": { "description": "The audio to be sent", "is_optional": false, "type": "inputAudio" }, "caption": { "description": "Audio file caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "InputPageBlock" }, "inputPageBlockBlockQuote": { "description": "A block quote", "args": { "blocks": { "description": "Quote blocks", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" }, "credit": { "description": "Quote credit; pass null if none", "is_optional": true, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockButtonRow": { "description": "A list of buttons shown in a row", "args": { "align": { "description": "Horizontal alignment of the buttons; pass null if the buttons must be shown full-width", "is_optional": true, "type": "PageBlockHorizontalAlignment" }, "buttons": { "description": "The buttons", "is_optional": false, "type": "vector\u003cinlineButton\u003e" } }, "type": "InputPageBlock" }, "inputPageBlockCollage": { "description": "A collage", "args": { "blocks": { "description": "Collage item contents", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" }, "caption": { "description": "Block caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "InputPageBlock" }, "inputPageBlockDetails": { "description": "A collapsible block", "args": { "blocks": { "description": "Block contents", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" }, "header": { "description": "Always visible heading for the block", "is_optional": false, "type": "RichText" }, "is_open": { "description": "True, if the block is open by default", "is_optional": false, "type": "Bool" } }, "type": "InputPageBlock" }, "inputPageBlockDivider": { "description": "An empty block separating the page", "args": {}, "type": "InputPageBlock" }, "inputPageBlockDocument": { "description": "A general file", "args": { "caption": { "description": "File caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "document": { "description": "The file to be sent", "is_optional": false, "type": "inputDocument" } }, "type": "InputPageBlock" }, "inputPageBlockExpandableBlockQuote": { "description": "An expandable block quote", "args": { "credit": { "description": "Quote credit; pass null if none", "is_optional": true, "type": "RichText" }, "text": { "description": "Quote text", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockFooter": { "description": "The footer of the page", "args": { "footer": { "description": "Footer", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockList": { "description": "A list of data blocks", "args": { "items": { "description": "The items of the list", "is_optional": false, "type": "vector\u003cinputPageBlockListItem\u003e" } }, "type": "InputPageBlock" }, "inputPageBlockListItem": { "description": "Describes an item of a list page block to be sent", "args": { "blocks": { "description": "Item blocks", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" }, "has_checkbox": { "description": "True, if the item has a checkbox", "is_optional": false, "type": "Bool" }, "is_checked": { "description": "True, if the item is checked", "is_optional": false, "type": "Bool" }, "type": { "description": "Type of the item numbering type; must be one of \"a\" for a lowercase letter, \"A\" for an uppercase letter, \"i\" for lowercase Roman numerals, \"I\" for uppercase Roman numerals,", "is_optional": false, "type": "string" }, "value": { "description": "Value of the item; pass 0 for unordered lists", "is_optional": false, "type": "int32" } }, "type": "InputPageBlockListItem" }, "inputPageBlockMap": { "description": "A map. The map's width and height must not exceed 10000 in total. Width and height ratio must be at most 20", "args": { "caption": { "description": "Block caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "height": { "description": "Map height; 0-10000", "is_optional": false, "type": "int32" }, "location": { "description": "Location of the map center", "is_optional": false, "type": "location" }, "width": { "description": "Map width; 0-10000", "is_optional": false, "type": "int32" }, "zoom": { "description": "Map zoom level; 0-24", "is_optional": false, "type": "int32" } }, "type": "InputPageBlock" }, "inputPageBlockMathematicalExpression": { "description": "A mathematical expression", "args": { "expression": { "description": "The expression in LaTeX format", "is_optional": false, "type": "string" } }, "type": "InputPageBlock" }, "inputPageBlockParagraph": { "description": "A text paragraph", "args": { "text": { "description": "Paragraph text", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockPhoto": { "description": "A photo", "args": { "caption": { "description": "Photo caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the photo preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "photo": { "description": "The photo to be sent", "is_optional": false, "type": "inputPhoto" } }, "type": "InputPageBlock" }, "inputPageBlockPreformatted": { "description": "A preformatted text paragraph", "args": { "language": { "description": "Programming language for which the text needs to be formatted", "is_optional": false, "type": "string" }, "text": { "description": "Paragraph text", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockPullQuote": { "description": "A pull quote", "args": { "credit": { "description": "Quote credit; pass null if none", "is_optional": true, "type": "RichText" }, "text": { "description": "Quote text", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockSectionHeading": { "description": "A section heading", "args": { "size": { "description": "Relative size of the text font; 1-6, 1 is the largest, 6 is the smallest", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the section heading", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockSlideshow": { "description": "A slideshow", "args": { "blocks": { "description": "Slideshow item contents", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" }, "caption": { "description": "Block caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "InputPageBlock" }, "inputPageBlockTable": { "description": "A table", "args": { "caption": { "description": "Table caption", "is_optional": false, "type": "RichText" }, "cells": { "description": "Table cells", "is_optional": false, "type": "vector\u003cvector\u003cpageBlockTableCell\u003e\u003e" }, "is_bordered": { "description": "Pass true if the table is bordered", "is_optional": false, "type": "Bool" }, "is_compact": { "description": "Pass true if table cells must have smaller indents", "is_optional": false, "type": "Bool" }, "is_striped": { "description": "Pass true if the table is striped", "is_optional": false, "type": "Bool" } }, "type": "InputPageBlock" }, "inputPageBlockThinking": { "description": "A \"Thinking...\" placeholder; for pending rich messages only; for bots only", "args": { "text": { "description": "Text of the placeholder", "is_optional": false, "type": "RichText" } }, "type": "InputPageBlock" }, "inputPageBlockVideo": { "description": "A video", "args": { "caption": { "description": "Video caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the video preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "video": { "description": "The video to be sent", "is_optional": false, "type": "inputVideo" } }, "type": "InputPageBlock" }, "inputPageBlockVoiceNote": { "description": "A voice note", "args": { "caption": { "description": "Voice note caption; pass null if none", "is_optional": true, "type": "pageBlockCaption" }, "voice_note": { "description": "The voice note to be sent", "is_optional": false, "type": "inputVoiceNote" } }, "type": "InputPageBlock" }, "inputPaidMedia": { "description": "Describes a paid media to be sent", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the media, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "height": { "description": "Media height", "is_optional": false, "type": "int32" }, "media": { "description": "Photo or video to be sent", "is_optional": false, "type": "InputFile" }, "thumbnail": { "description": "Media thumbnail; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "type": { "description": "Type of the media", "is_optional": false, "type": "InputPaidMediaType" }, "width": { "description": "Media width", "is_optional": false, "type": "int32" } }, "type": "InputPaidMedia" }, "inputPaidMediaTypePhoto": { "description": "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", "args": { "video": { "description": "Video of the live photo; pass null if the photo isn't a live photo", "is_optional": true, "type": "InputFile" } }, "type": "InputPaidMediaType" }, "inputPaidMediaTypeVideo": { "description": "The media is a video", "args": { "cover": { "description": "Cover of the video; pass null to skip cover uploading", "is_optional": true, "type": "InputFile" }, "duration": { "description": "Duration of the video, in seconds", "is_optional": false, "type": "int32" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "supports_streaming": { "description": "True, if the video is expected to be streamed", "is_optional": false, "type": "Bool" } }, "type": "InputPaidMediaType" }, "inputPassportElementAddress": { "description": "A Telegram Passport element to be saved containing the user's address", "args": { "address": { "description": "The address to be saved", "is_optional": false, "type": "address" } }, "type": "InputPassportElement" }, "inputPassportElementBankStatement": { "description": "A Telegram Passport element to be saved containing the user's bank statement", "args": { "bank_statement": { "description": "The bank statement to be saved", "is_optional": false, "type": "inputPersonalDocument" } }, "type": "InputPassportElement" }, "inputPassportElementDriverLicense": { "description": "A Telegram Passport element to be saved containing the user's driver license", "args": { "driver_license": { "description": "The driver license to be saved", "is_optional": false, "type": "inputIdentityDocument" } }, "type": "InputPassportElement" }, "inputPassportElementEmailAddress": { "description": "A Telegram Passport element to be saved containing the user's email address", "args": { "email_address": { "description": "The email address to be saved", "is_optional": false, "type": "string" } }, "type": "InputPassportElement" }, "inputPassportElementError": { "description": "Contains the description of an error in a Telegram Passport element; for bots only", "args": { "message": { "description": "Error message", "is_optional": false, "type": "string" }, "source": { "description": "Error source", "is_optional": false, "type": "InputPassportElementErrorSource" }, "type": { "description": "Type of Telegram Passport element that has the error", "is_optional": false, "type": "PassportElementType" } }, "type": "InputPassportElementError" }, "inputPassportElementErrorSourceDataField": { "description": "A data field contains an error. The error is considered resolved when the field's value changes", "args": { "data_hash": { "description": "Current data hash", "is_optional": false, "type": "bytes" }, "field_name": { "description": "Field name", "is_optional": false, "type": "string" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceFile": { "description": "The file contains an error. The error is considered resolved when the file changes", "args": { "file_hash": { "description": "Current hash of the file which has the error", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceFiles": { "description": "The list of attached files contains an error. The error is considered resolved when the file list changes", "args": { "file_hashes": { "description": "Current hashes of all attached files", "is_optional": false, "type": "vector\u003cbytes\u003e" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceFrontSide": { "description": "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", "args": { "file_hash": { "description": "Current hash of the file containing the front side", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceReverseSide": { "description": "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", "args": { "file_hash": { "description": "Current hash of the file containing the reverse side", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceSelfie": { "description": "The selfie contains an error. The error is considered resolved when the file with the selfie changes", "args": { "file_hash": { "description": "Current hash of the file containing the selfie", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceTranslationFile": { "description": "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", "args": { "file_hash": { "description": "Current hash of the file containing the translation", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceTranslationFiles": { "description": "The translation of the document contains an error. The error is considered resolved when the list of files changes", "args": { "file_hashes": { "description": "Current hashes of all files with the translation", "is_optional": false, "type": "vector\u003cbytes\u003e" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementErrorSourceUnspecified": { "description": "The element contains an error in an unspecified place. The error will be considered resolved when new data is added", "args": { "element_hash": { "description": "Current hash of the entire element", "is_optional": false, "type": "bytes" } }, "type": "InputPassportElementErrorSource" }, "inputPassportElementIdentityCard": { "description": "A Telegram Passport element to be saved containing the user's identity card", "args": { "identity_card": { "description": "The identity card to be saved", "is_optional": false, "type": "inputIdentityDocument" } }, "type": "InputPassportElement" }, "inputPassportElementInternalPassport": { "description": "A Telegram Passport element to be saved containing the user's internal passport", "args": { "internal_passport": { "description": "The internal passport to be saved", "is_optional": false, "type": "inputIdentityDocument" } }, "type": "InputPassportElement" }, "inputPassportElementPassport": { "description": "A Telegram Passport element to be saved containing the user's passport", "args": { "passport": { "description": "The passport to be saved", "is_optional": false, "type": "inputIdentityDocument" } }, "type": "InputPassportElement" }, "inputPassportElementPassportRegistration": { "description": "A Telegram Passport element to be saved containing the user's passport registration", "args": { "passport_registration": { "description": "The passport registration page to be saved", "is_optional": false, "type": "inputPersonalDocument" } }, "type": "InputPassportElement" }, "inputPassportElementPersonalDetails": { "description": "A Telegram Passport element to be saved containing the user's personal details", "args": { "personal_details": { "description": "Personal details of the user", "is_optional": false, "type": "personalDetails" } }, "type": "InputPassportElement" }, "inputPassportElementPhoneNumber": { "description": "A Telegram Passport element to be saved containing the user's phone number", "args": { "phone_number": { "description": "The phone number to be saved", "is_optional": false, "type": "string" } }, "type": "InputPassportElement" }, "inputPassportElementRentalAgreement": { "description": "A Telegram Passport element to be saved containing the user's rental agreement", "args": { "rental_agreement": { "description": "The rental agreement to be saved", "is_optional": false, "type": "inputPersonalDocument" } }, "type": "InputPassportElement" }, "inputPassportElementTemporaryRegistration": { "description": "A Telegram Passport element to be saved containing the user's temporary registration", "args": { "temporary_registration": { "description": "The temporary registration document to be saved", "is_optional": false, "type": "inputPersonalDocument" } }, "type": "InputPassportElement" }, "inputPassportElementUtilityBill": { "description": "A Telegram Passport element to be saved containing the user's utility bill", "args": { "utility_bill": { "description": "The utility bill to be saved", "is_optional": false, "type": "inputPersonalDocument" } }, "type": "InputPassportElement" }, "inputPersonalDocument": { "description": "A personal document to be saved to Telegram Passport", "args": { "files": { "description": "List of files containing the pages of the document", "is_optional": false, "type": "vector\u003cInputFile\u003e" }, "translation": { "description": "List of files containing a certified English translation of the document", "is_optional": false, "type": "vector\u003cInputFile\u003e" } }, "type": "InputPersonalDocument" }, "inputPhoto": { "description": "A photo to be sent", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the photo, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "height": { "description": "Photo height; may be replaced by the server", "is_optional": false, "type": "int32" }, "photo": { "description": "Photo to be sent. 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", "is_optional": false, "type": "InputFile" }, "thumbnail": { "description": "Photo thumbnail; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats", "is_optional": true, "type": "inputThumbnail" }, "video": { "description": "Video of the live photo; not supported in secret chats; pass null if the photo isn't a live photo", "is_optional": true, "type": "InputFile" }, "width": { "description": "Photo width; may be replaced by the server", "is_optional": false, "type": "int32" } }, "type": "InputPhoto" }, "inputPollMediaAnimation": { "description": "An animation", "args": { "animation": { "description": "The animation to be sent", "is_optional": false, "type": "inputAnimation" } }, "type": "InputPollMedia" }, "inputPollMediaAudio": { "description": "An audio", "args": { "audio": { "description": "The audio to be sent", "is_optional": false, "type": "inputAudio" } }, "type": "InputPollMedia" }, "inputPollMediaDocument": { "description": "A document (general file)", "args": { "document": { "description": "The document to be sent", "is_optional": false, "type": "inputDocument" } }, "type": "InputPollMedia" }, "inputPollMediaLink": { "description": "A link", "args": { "url": { "description": "URL of the link", "is_optional": false, "type": "string" } }, "type": "InputPollMedia" }, "inputPollMediaLocation": { "description": "A location", "args": { "location": { "description": "Location to be sent", "is_optional": false, "type": "location" } }, "type": "InputPollMedia" }, "inputPollMediaPhoto": { "description": "A photo", "args": { "photo": { "description": "Photo to be sent", "is_optional": false, "type": "inputPhoto" } }, "type": "InputPollMedia" }, "inputPollMediaSticker": { "description": "A sticker", "args": { "sticker": { "description": "Sticker to be sent", "is_optional": false, "type": "inputSticker" } }, "type": "InputPollMedia" }, "inputPollMediaVenue": { "description": "A venue", "args": { "venue": { "description": "Venue to send", "is_optional": false, "type": "venue" } }, "type": "InputPollMedia" }, "inputPollMediaVideo": { "description": "A video", "args": { "video": { "description": "The video to be sent", "is_optional": false, "type": "inputVideo" } }, "type": "InputPollMedia" }, "inputPollOption": { "description": "Describes one answer option of a poll to be created", "args": { "media": { "description": "Option media; pass null if none. Must be one of the following types:", "is_optional": true, "type": "InputPollMedia" }, "text": { "description": "Option text; 1-100 characters. Only custom emoji entities are allowed to be added and only by Premium users", "is_optional": false, "type": "formattedText" } }, "type": "InputPollOption" }, "inputPollTypeQuiz": { "description": "A poll in quiz mode, which has predefined correct answers", "args": { "correct_option_ids": { "description": "Increasing list of 0-based identifiers of the correct answer options; must be non-empty", "is_optional": false, "type": "vector\u003cint32\u003e" }, "explanation": { "description": "Text that is shown when the user chooses an incorrect answer or taps on the lamp icon; 0-200 characters with at most 2 line feeds", "is_optional": false, "type": "formattedText" }, "explanation_media": { "description": "Media that is shown when the user chooses an incorrect answer or taps on the lamp icon; pass null if none. Must be one of the following types:", "is_optional": true, "type": "InputPollMedia" } }, "type": "InputPollType" }, "inputPollTypeRegular": { "description": "A regular poll", "args": { "allow_adding_options": { "description": "True, if answer options can be added to the poll after creation; not supported in channel chats and for anonymous polls", "is_optional": false, "type": "Bool" } }, "type": "InputPollType" }, "inputRichMessage": { "description": "A rich message to send. Total length of all texts, including custom emoji alternative text and formula source, must not exceed getOption(\"rich_message_text_length_max\").", "args": { "detect_automatic_blocks": { "description": "Pass true to enable detection of URLs, email addresses and other automatic blocks", "is_optional": false, "type": "Bool" }, "is_rtl": { "description": "Pass true if the message must be shown from right to left", "is_optional": false, "type": "Bool" }, "source": { "description": "Source of the rich message", "is_optional": false, "type": "RichMessageSource" } }, "type": "InputRichMessage" }, "inputRichMessageMedia": { "description": "Describes a media to be used in a sent rich message", "args": { "id": { "description": "Unique identifier of the media; 1-64 base64url characters", "is_optional": false, "type": "string" }, "media": { "description": "The media to send. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessagePhoto, inputMessageVideo, or inputMessageVoiceNote", "is_optional": false, "type": "InputMessageContent" } }, "type": "InputRichMessageMedia" }, "inputSticker": { "description": "A sticker to be sent", "args": { "height": { "description": "Sticker height", "is_optional": false, "type": "int32" }, "sticker": { "description": "Sticker to be sent", "is_optional": false, "type": "InputFile" }, "thumbnail": { "description": "Sticker thumbnail; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "width": { "description": "Sticker width", "is_optional": false, "type": "int32" } }, "type": "InputSticker" }, "inputStoryArea": { "description": "Describes a clickable rectangle area on a story media to be added", "args": { "position": { "description": "Position of the area", "is_optional": false, "type": "storyAreaPosition" }, "type": { "description": "Type of the area", "is_optional": false, "type": "InputStoryAreaType" } }, "type": "InputStoryArea" }, "inputStoryAreaTypeFoundVenue": { "description": "An area pointing to a venue found by the bot getOption(\"venue_search_bot_username\")", "args": { "query_id": { "description": "Identifier of the inline query, used to found the venue", "is_optional": false, "type": "int64" }, "result_id": { "description": "Identifier of the inline query result", "is_optional": false, "type": "string" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeLink": { "description": "An area pointing to a HTTP or tg:// link", "args": { "url": { "description": "HTTP or tg:// URL to be opened when the area is clicked", "is_optional": false, "type": "string" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeLocation": { "description": "An area pointing to a location", "args": { "address": { "description": "Address of the location; pass null if unknown", "is_optional": true, "type": "locationAddress" }, "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeMessage": { "description": "An area pointing to a message", "args": { "chat_id": { "description": "Identifier of the chat with the message. Currently, the chat must be a supergroup or a channel chat", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_shared_in_story to check whether the message is suitable", "is_optional": false, "type": "int53" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypePreviousVenue": { "description": "An area pointing to a venue already added to the story", "args": { "venue_id": { "description": "Identifier of the venue in the provider database", "is_optional": false, "type": "string" }, "venue_provider": { "description": "Provider of the venue", "is_optional": false, "type": "string" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeSuggestedReaction": { "description": "An area pointing to a suggested reaction", "args": { "is_dark": { "description": "True, if reaction has a dark background", "is_optional": false, "type": "Bool" }, "is_flipped": { "description": "True, if reaction corner is flipped", "is_optional": false, "type": "Bool" }, "reaction_type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeUpgradedGift": { "description": "An area with an upgraded gift", "args": { "gift_name": { "description": "Unique name of the upgraded gift", "is_optional": false, "type": "string" } }, "type": "InputStoryAreaType" }, "inputStoryAreaTypeWeather": { "description": "An area with information about weather", "args": { "background_color": { "description": "A color of the area background in the ARGB format", "is_optional": false, "type": "int32" }, "emoji": { "description": "Emoji representing the weather", "is_optional": false, "type": "string" }, "temperature": { "description": "Temperature, in degree Celsius", "is_optional": false, "type": "double" } }, "type": "InputStoryAreaType" }, "inputStoryAreas": { "description": "Contains a list of story areas to be added", "args": { "areas": { "description": "List of input story areas. Currently, a story can have", "is_optional": false, "type": "vector\u003cinputStoryArea\u003e" } }, "type": "InputStoryAreas" }, "inputStoryContentPhoto": { "description": "A photo story", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the photo, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "photo": { "description": "Photo to send. The photo must be at most 10 MB in size. The photo size must be 1080x1920", "is_optional": false, "type": "InputFile" } }, "type": "InputStoryContent" }, "inputStoryContentVideo": { "description": "A video story", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the video, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "cover_frame_timestamp": { "description": "Timestamp of the frame, which will be used as video thumbnail", "is_optional": false, "type": "double" }, "duration": { "description": "Precise duration of the video, in seconds; 0-60", "is_optional": false, "type": "double" }, "is_animation": { "description": "True, if the video has no sound", "is_optional": false, "type": "Bool" }, "video": { "description": "Video to be sent. The video size must be 720x1280. The video must be streamable and stored in MPEG4 format, after encoding with H.265 codec and key frames added each second", "is_optional": false, "type": "InputFile" } }, "type": "InputStoryContent" }, "inputSuggestedPostInfo": { "description": "Contains information about a post to suggest", "args": { "price": { "description": "Price of the suggested post; pass null to suggest a post without payment. If the current user isn't an administrator of the channel direct messages chat", "is_optional": true, "type": "SuggestedPostPrice" }, "send_date": { "description": "Point in time (Unix timestamp) when the post is expected to be published; pass 0 if the date isn't restricted. If specified,", "is_optional": false, "type": "int32" } }, "type": "InputSuggestedPostInfo" }, "inputTextQuote": { "description": "Describes manually chosen quote from another message", "args": { "position": { "description": "Quote position in the original message in UTF-16 code units", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the quote; 0-getOption(\"message_reply_quote_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed to be kept and must be kept in the quote", "is_optional": false, "type": "formattedText" } }, "type": "InputTextQuote" }, "inputThumbnail": { "description": "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", "args": { "height": { "description": "Thumbnail height, usually shouldn't exceed 320. Use 0 if unknown", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Thumbnail file to send. Sending thumbnails by file_id is currently not supported", "is_optional": false, "type": "InputFile" }, "width": { "description": "Thumbnail width, usually shouldn't exceed 320. Use 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "InputThumbnail" }, "inputVideo": { "description": "A video to be sent", "args": { "added_sticker_file_ids": { "description": "File identifiers of the stickers added to the video, if applicable", "is_optional": false, "type": "vector\u003cint32\u003e" }, "cover": { "description": "Cover of the video; pass null to skip cover uploading; not supported in secret chats and for self-destructing messages", "is_optional": true, "type": "InputFile" }, "duration": { "description": "Duration of the video, in seconds", "is_optional": false, "type": "int32" }, "height": { "description": "Video height", "is_optional": false, "type": "int32" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "supports_streaming": { "description": "True, if the video is expected to be streamed", "is_optional": false, "type": "Bool" }, "thumbnail": { "description": "Video thumbnail; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "video": { "description": "Video file to be sent. The video is expected to be re-encoded to MPEG4 format with H.264 codec by the sender", "is_optional": false, "type": "InputFile" }, "width": { "description": "Video width", "is_optional": false, "type": "int32" } }, "type": "InputVideo" }, "inputVideoNote": { "description": "A video note to be sent", "args": { "duration": { "description": "Duration of the video, in seconds; 0-60", "is_optional": false, "type": "int32" }, "length": { "description": "Video width and height; must be positive and not greater than 640", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Video thumbnail; may be null if empty; pass null to skip thumbnail uploading", "is_optional": true, "type": "inputThumbnail" }, "video_note": { "description": "Video note file to be sent. The video is expected to be encoded to MPEG4 format with H.264 codec and have no data outside of the visible circle", "is_optional": false, "type": "InputFile" } }, "type": "InputVideoNote" }, "inputVoiceNote": { "description": "A video note to be sent", "args": { "duration": { "description": "Duration of the voice note, in seconds", "is_optional": false, "type": "int32" }, "voice_note": { "description": "Voice note file to be sent. The voice note must be encoded with the Opus codec and stored inside an OGG container with a single audio channel, or be in MP3 or M4A format as regular audio", "is_optional": false, "type": "InputFile" }, "waveform": { "description": "Waveform representation of the voice note in 5-bit format", "is_optional": false, "type": "bytes" } }, "type": "InputVoiceNote" }, "internalLinkTypeAttachmentMenuBot": { "description": "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.", "args": { "bot_username": { "description": "Username of the bot", "is_optional": false, "type": "string" }, "target_chat": { "description": "Target chat to be opened", "is_optional": false, "type": "TargetChat" }, "url": { "description": "URL to be passed to openWebApp", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeAuthenticationCode": { "description": "The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization state is authorizationStateWaitCode", "args": { "code": { "description": "The authentication code", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeBackground": { "description": "The link is a link to a background. Call searchBackground with the given background name to process the link.", "args": { "background_name": { "description": "Name of the background", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeBotAddToChannel": { "description": "The link is a link to a Telegram bot, which is expected to be added to a channel chat as an administrator. Call searchPublicChat with the given bot username and check that the user is a bot,", "args": { "administrator_rights": { "description": "Expected administrator rights for the bot", "is_optional": false, "type": "chatAdministratorRights" }, "bot_username": { "description": "Username of the bot", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeBotStart": { "description": "The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the user is a bot, show START button in the chat with the bot,", "args": { "autostart": { "description": "True, if sendBotStartMessage must be called automatically without showing the START button", "is_optional": false, "type": "Bool" }, "bot_username": { "description": "Username of the bot", "is_optional": false, "type": "string" }, "start_parameter": { "description": "The parameter to be passed to sendBotStartMessage", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeBotStartInGroup": { "description": "The link is a link to a Telegram bot, which is expected to be added to a group chat. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to groups,", "args": { "administrator_rights": { "description": "Expected administrator rights for the bot; may be null", "is_optional": true, "type": "chatAdministratorRights" }, "bot_username": { "description": "Username of the bot", "is_optional": false, "type": "string" }, "start_parameter": { "description": "The parameter to be passed to sendBotStartMessage", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeBusinessChat": { "description": "The link is a link to a business chat. Use getBusinessChatLinkInfo with the provided link name to get information about the link,", "args": { "link_name": { "description": "Name of the link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeCallsPage": { "description": "The link is a link to the Call tab or page", "args": { "section": { "description": "Section of the page; may be one of", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeChatAffiliateProgram": { "description": "The link is an affiliate program link. Call searchChatAffiliateProgram with the given username and referrer to process the link", "args": { "referrer": { "description": "Referrer to be passed to searchChatAffiliateProgram", "is_optional": false, "type": "string" }, "username": { "description": "Username to be passed to searchChatAffiliateProgram", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeChatBoost": { "description": "The link is a link to boost a Telegram chat. Call getChatBoostLinkInfo with the given URL to process the link.", "args": { "url": { "description": "URL to be passed to getChatBoostLinkInfo", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeChatFolderInvite": { "description": "The link is an invite link to a chat folder. Call checkChatFolderInviteLink with the given invite link to process the link.", "args": { "invite_link": { "description": "Internal representation of the invite link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeChatInvite": { "description": "The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link.", "args": { "invite_link": { "description": "Internal representation of the invite link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeChatSelection": { "description": "The link is a link that allows to select some chats", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeContactsPage": { "description": "The link is a link to the Contacts tab or page", "args": { "section": { "description": "Section of the page; may be one of", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeDirectMessagesChat": { "description": "The link is a link to a channel direct messages chat by username of the channel. Call searchPublicChat with the given chat username to process the link.", "args": { "channel_username": { "description": "Username of the channel", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeGame": { "description": "The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot,", "args": { "bot_username": { "description": "Username of the bot that owns the game", "is_optional": false, "type": "string" }, "game_short_name": { "description": "Short name of the game", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeGiftAuction": { "description": "The link is a link to a gift auction. Call getGiftAuctionState with the given auction identifier to process the link", "args": { "auction_id": { "description": "Unique identifier of the auction", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeGiftCollection": { "description": "The link is a link to a gift collection. Call searchPublicChat with the given username, then call getReceivedGifts with the received gift owner identifier", "args": { "collection_id": { "description": "Gift collection identifier", "is_optional": false, "type": "int32" }, "gift_owner_username": { "description": "Username of the owner of the gift collection", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeGroupCall": { "description": "The link is a link to a group call that isn't bound to a chat. Use getGroupCallParticipants to get the list of group call participants and show them on the join group call screen.", "args": { "invite_link": { "description": "Internal representation of the invite link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeInstantView": { "description": "The link must be opened in an Instant View. Call getWebPageInstantView with the given URL to process the link.", "args": { "fallback_url": { "description": "An URL to open if getWebPageInstantView fails", "is_optional": false, "type": "string" }, "url": { "description": "URL to be passed to getWebPageInstantView", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeInvoice": { "description": "The link is a link to an invoice. Call getPaymentForm with the given invoice name to process the link", "args": { "invoice_name": { "description": "Name of the invoice", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeLanguagePack": { "description": "The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process the link.", "args": { "language_pack_id": { "description": "Language pack identifier", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeLiveStory": { "description": "The link is a link to a live story. Call searchPublicChat with the given chat username, then getChatActiveStories to get active stories in the chat,", "args": { "story_poster_username": { "description": "Username of the poster of the story", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeMainWebApp": { "description": "The link is a link to the main Web App of a bot. Call searchPublicChat with the given bot username, check that the user is a bot and has the main Web App.", "args": { "bot_username": { "description": "Username of the bot", "is_optional": false, "type": "string" }, "mode": { "description": "The mode to be passed to getMainWebApp", "is_optional": false, "type": "WebAppOpenMode" }, "start_parameter": { "description": "Start parameter to be passed to getMainWebApp", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeMessage": { "description": "The link is a link to a Telegram message or a forum topic. Call getMessageLinkInfo with the given URL to process the link,", "args": { "url": { "description": "URL to be passed to getMessageLinkInfo", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeMessageDraft": { "description": "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", "args": { "contains_link": { "description": "True, if the first line of the text contains a link. If true, the input field needs to be focused and the text after the link must be selected", "is_optional": false, "type": "Bool" }, "text": { "description": "Message draft text", "is_optional": false, "type": "formattedText" } }, "type": "InternalLinkType" }, "internalLinkTypeMyProfilePage": { "description": "The link is a link to the My Profile application page", "args": { "section": { "description": "Section of the page; may be one of", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeNewChannelChat": { "description": "The link is a link to the screen for creating a new channel chat", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeNewGroupChat": { "description": "The link is a link to the screen for creating a new group chat", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeNewPrivateChat": { "description": "The link is a link to the screen for creating a new private chat with a contact", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeNewStory": { "description": "The link is a link to open the story posting interface", "args": { "content_type": { "description": "The type of the content of the story to post; may be null if unspecified", "is_optional": true, "type": "StoryContentType" } }, "type": "InternalLinkType" }, "internalLinkTypeOauth": { "description": "The link is an OAuth link. Call getOauthLinkInfo with the given URL to process the link if the link was received from outside of the application; otherwise, ignore it.", "args": { "url": { "description": "URL to be passed to getOauthLinkInfo", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypePassportDataRequest": { "description": "The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to process the link if the link was received from outside of the application; otherwise, ignore it", "args": { "bot_user_id": { "description": "User identifier of the service's bot; the corresponding user may be unknown yet", "is_optional": false, "type": "int53" }, "callback_url": { "description": "An HTTP URL to open once the request is finished, canceled, or failed with the parameters tg_passport=success, tg_passport=cancel, or tg_passport=error\u0026error=... respectively.", "is_optional": false, "type": "string" }, "nonce": { "description": "Unique request identifier provided by the service", "is_optional": false, "type": "string" }, "public_key": { "description": "Service's public key", "is_optional": false, "type": "string" }, "scope": { "description": "Telegram Passport element types requested by the service", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypePhoneNumberConfirmation": { "description": "The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberCode with the given phone number and with phoneNumberCodeTypeConfirmOwnership with the given hash to process the link.", "args": { "hash": { "description": "Hash value from the link", "is_optional": false, "type": "string" }, "phone_number": { "description": "Phone number value from the link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypePremiumFeaturesPage": { "description": "The link is a link to the Premium features screen of the application from which the user can subscribe to Telegram Premium. Call getPremiumFeatures with the given referrer to process the link", "args": { "referrer": { "description": "Referrer specified in the link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypePremiumGiftCode": { "description": "The link is a link with a Telegram Premium gift code. Call checkPremiumGiftCode with the given code to process the link.", "args": { "code": { "description": "The Telegram Premium gift code", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypePremiumGiftPurchase": { "description": "The link is a link to the screen for gifting Telegram Premium subscriptions to friends via inputInvoiceTelegram with telegramPaymentPurposePremiumGift payments or in-store purchases", "args": { "referrer": { "description": "Referrer specified in the link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeProxy": { "description": "The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxy", "args": { "proxy": { "description": "The proxy; may be null if the proxy is unsupported, in which case an alert can be shown to the user", "is_optional": true, "type": "proxy" } }, "type": "InternalLinkType" }, "internalLinkTypePublicChat": { "description": "The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link.", "args": { "chat_username": { "description": "Username of the chat", "is_optional": false, "type": "string" }, "draft_text": { "description": "Draft text for message to send in the chat", "is_optional": false, "type": "string" }, "open_profile": { "description": "True, if chat profile information screen must be opened; otherwise, the chat itself must be opened", "is_optional": false, "type": "Bool" } }, "type": "InternalLinkType" }, "internalLinkTypeQrCodeAuthentication": { "description": "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", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeRequestManagedBot": { "description": "The link is a link to a dialog for creating of a managed bot. Call searchPublicChat with the given manager bot username.", "args": { "manager_bot_username": { "description": "Username of the bot which will manage the new bot", "is_optional": false, "type": "string" }, "suggested_bot_name": { "description": "Suggested name for the bot; may be empty if not specified", "is_optional": true, "type": "string" }, "suggested_bot_username": { "description": "Suggested username for the bot; always ends with \"bot\" or a string from updateAllowedBotUsernamePremiumSuffixes case-insensitive", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeRestorePurchases": { "description": "The link forces restore of App Store purchases when opened. For official iOS application only", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeSavedMessages": { "description": "The link is a link to the Saved Messages chat. Call createPrivateChat with getOption(\"my_id\") and open the chat", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeSearch": { "description": "The link is a link to the global chat and messages search field", "args": {}, "type": "InternalLinkType" }, "internalLinkTypeSettings": { "description": "The link is a link to application settings", "args": { "section": { "description": "Section of the application settings to open; may be null if none", "is_optional": true, "type": "SettingsSection" } }, "type": "InternalLinkType" }, "internalLinkTypeStarPurchase": { "description": "The link is a link to the Telegram Star purchase section of the application", "args": { "purpose": { "description": "Purpose of Telegram Star purchase. Arbitrary string specified by the server, for example, \"subs\" if the Telegram Stars are required to extend channel subscriptions", "is_optional": false, "type": "string" }, "star_count": { "description": "The number of Telegram Stars that must be owned by the user", "is_optional": false, "type": "int53" } }, "type": "InternalLinkType" }, "internalLinkTypeStickerSet": { "description": "The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and show the sticker set.", "args": { "expect_custom_emoji": { "description": "True, if the sticker set is expected to contain custom emoji", "is_optional": false, "type": "Bool" }, "sticker_set_name": { "description": "Name of the sticker set", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeStory": { "description": "The link is a link to a story. Call searchPublicChat with the given poster username, then call getStory with the received chat identifier and the given story identifier, then show the story if received", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_username": { "description": "Username of the poster of the story", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeStoryAlbum": { "description": "The link is a link to an album of stories. Call searchPublicChat with the given username, then call getStoryAlbumStories with the received chat identifier", "args": { "story_album_id": { "description": "Story album identifier", "is_optional": false, "type": "int32" }, "story_album_owner_username": { "description": "Username of the owner of the story album", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeTextCompositionStyle": { "description": "The link is a link to a text composition style. Call searchTextCompositionStyle with the given style name to get information about the style.", "args": { "style_name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeTheme": { "description": "The link is a link to a cloud theme. TDLib has no theme support yet", "args": { "theme_name": { "description": "Name of the theme", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeTonConnect": { "description": "The link is a universal TON Connect link", "args": { "connect_request": { "description": "TON Connect connect request", "is_optional": false, "type": "tonConnectConnectRequest" }, "dapp_client_id": { "description": "Hex-encoded public X25519 key of the dApp", "is_optional": false, "type": "string" }, "return_strategy": { "description": "Request return strategy; one of \"back\", \"none\", or a URL to open", "is_optional": false, "type": "string" }, "rpc_request": { "description": "Embedded RPC request represented as base64url-encoded JSON", "is_optional": false, "type": "string" }, "trace_id": { "description": "Identifier to trace the connection request", "is_optional": false, "type": "string" }, "version": { "description": "TON Connect version", "is_optional": false, "type": "int32" } }, "type": "InternalLinkType" }, "internalLinkTypeTonWalletTransfer": { "description": "The link is a link for sending Grams from the user's TON wallet", "args": { "gram_amount": { "description": "The pre-filled amount of TON Grams to send; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "receiver": { "description": "Chosen receiver of the transfer; may be null if none", "is_optional": true, "type": "TonWalletTransferReceiver" } }, "type": "InternalLinkType" }, "internalLinkTypeUnknownDeepLink": { "description": "The link is an unknown tg: link. Call getDeepLinkInfo to process the link", "args": { "link": { "description": "Link to be passed to getDeepLinkInfo", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeUpgradedGift": { "description": "The link is a link to an upgraded gift. Call getUpgradedGift with the given name to process the link", "args": { "name": { "description": "Name of the unique gift", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeUserPhoneNumber": { "description": "The link is a link to a user by its phone number. Call searchUserByPhoneNumber with the given phone number to process the link.", "args": { "draft_text": { "description": "Draft text for message to send in the chat", "is_optional": false, "type": "string" }, "open_profile": { "description": "True, if user's profile information screen must be opened; otherwise, the chat itself must be opened", "is_optional": false, "type": "Bool" }, "phone_number": { "description": "Phone number of the user", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeUserToken": { "description": "The link is a link to a user by a temporary token. Call searchUserByToken with the given token to process the link.", "args": { "token": { "description": "The token", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "internalLinkTypeVideoChat": { "description": "The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinVideoChat with the given invite hash to process the link", "args": { "chat_username": { "description": "Username of the chat with the video chat", "is_optional": false, "type": "string" }, "invite_hash": { "description": "If non-empty, invite hash to be used to join the video chat without being muted by administrators", "is_optional": true, "type": "string" }, "is_live_stream": { "description": "True, if the video chat is expected to be a live stream in a channel or a broadcast group", "is_optional": false, "type": "Bool" } }, "type": "InternalLinkType" }, "internalLinkTypeWebApp": { "description": "The link is a link to a Web App. Call searchPublicChat 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.", "args": { "bot_username": { "description": "Username of the bot that owns the Web App", "is_optional": false, "type": "string" }, "mode": { "description": "The mode in which the Web App must be opened", "is_optional": false, "type": "WebAppOpenMode" }, "start_parameter": { "description": "Start parameter to be passed to getWebAppLinkUrl", "is_optional": false, "type": "string" }, "web_app_short_name": { "description": "Short name of the Web App", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "inviteGroupCallParticipantResultSuccess": { "description": "The user was invited and a service message of the type messageGroupCall was sent which can be used in declineGroupCallInvitation to cancel the invitation", "args": { "chat_id": { "description": "Identifier of the chat with the invitation message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "InviteGroupCallParticipantResult" }, "inviteGroupCallParticipantResultUserAlreadyParticipant": { "description": "The user can't be invited because they are already a participant of the call", "args": {}, "type": "InviteGroupCallParticipantResult" }, "inviteGroupCallParticipantResultUserPrivacyRestricted": { "description": "The user can't be invited due to their privacy settings", "args": {}, "type": "InviteGroupCallParticipantResult" }, "inviteGroupCallParticipantResultUserWasBanned": { "description": "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", "args": {}, "type": "InviteGroupCallParticipantResult" }, "inviteLinkChatTypeBasicGroup": { "description": "The link is an invite link for a basic group", "args": {}, "type": "InviteLinkChatType" }, "inviteLinkChatTypeChannel": { "description": "The link is an invite link for a channel", "args": {}, "type": "InviteLinkChatType" }, "inviteLinkChatTypeSupergroup": { "description": "The link is an invite link for a supergroup", "args": {}, "type": "InviteLinkChatType" }, "invoice": { "description": "Product invoice", "args": { "currency": { "description": "ISO 4217 currency code", "is_optional": false, "type": "string" }, "is_flexible": { "description": "True, if the total price depends on the shipping method", "is_optional": false, "type": "Bool" }, "is_test": { "description": "True, if the payment is a test payment", "is_optional": false, "type": "Bool" }, "max_tip_amount": { "description": "The maximum allowed amount of tip in the smallest units of the currency", "is_optional": false, "type": "int53" }, "need_email_address": { "description": "True, if the user's email address is needed for payment", "is_optional": false, "type": "Bool" }, "need_name": { "description": "True, if the user's name is needed for payment", "is_optional": false, "type": "Bool" }, "need_phone_number": { "description": "True, if the user's phone number is needed for payment", "is_optional": false, "type": "Bool" }, "need_shipping_address": { "description": "True, if the user's shipping address is needed for payment", "is_optional": false, "type": "Bool" }, "price_parts": { "description": "A list of objects used to calculate the total price of the product", "is_optional": false, "type": "vector\u003clabeledPricePart\u003e" }, "recurring_payment_terms_of_service_url": { "description": "An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay", "is_optional": true, "type": "string" }, "send_email_address_to_provider": { "description": "True, if the user's email address will be sent to the provider", "is_optional": false, "type": "Bool" }, "send_phone_number_to_provider": { "description": "True, if the user's phone number will be sent to the provider", "is_optional": false, "type": "Bool" }, "subscription_period": { "description": "The number of seconds between consecutive Telegram Star debiting for subscription invoices; 0 if the invoice doesn't create subscription", "is_optional": false, "type": "int32" }, "suggested_tip_amounts": { "description": "Suggested amounts of tip in the smallest units of the currency", "is_optional": false, "type": "vector\u003cint53\u003e" }, "terms_of_service_url": { "description": "An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay", "is_optional": true, "type": "string" } }, "type": "Invoice" }, "jsonObjectMember": { "description": "Represents one member of a JSON object", "args": { "key": { "description": "Member's key", "is_optional": false, "type": "string" }, "value": { "description": "Member's value", "is_optional": false, "type": "JsonValue" } }, "type": "JsonObjectMember" }, "jsonValueArray": { "description": "Represents a JSON array", "args": { "values": { "description": "The list of array elements", "is_optional": false, "type": "vector\u003cJsonValue\u003e" } }, "type": "JsonValue" }, "jsonValueBoolean": { "description": "Represents a boolean JSON value", "args": { "value": { "description": "The value", "is_optional": false, "type": "Bool" } }, "type": "JsonValue" }, "jsonValueNull": { "description": "Represents a null JSON value", "args": {}, "type": "JsonValue" }, "jsonValueNumber": { "description": "Represents a numeric JSON value", "args": { "value": { "description": "The value", "is_optional": false, "type": "double" } }, "type": "JsonValue" }, "jsonValueObject": { "description": "Represents a JSON object", "args": { "members": { "description": "The list of object members", "is_optional": false, "type": "vector\u003cjsonObjectMember\u003e" } }, "type": "JsonValue" }, "jsonValueString": { "description": "Represents a string JSON value", "args": { "value": { "description": "The value", "is_optional": false, "type": "string" } }, "type": "JsonValue" }, "keyboardButton": { "description": "Represents a single button in a bot keyboard", "args": { "icon_custom_emoji_id": { "description": "Identifier of the custom emoji that must be shown on the button; 0 if none", "is_optional": false, "type": "int64" }, "style": { "description": "Style of the button", "is_optional": false, "type": "ButtonStyle" }, "text": { "description": "Text of the button", "is_optional": false, "type": "string" }, "type": { "description": "Type of the button", "is_optional": false, "type": "KeyboardButtonType" } }, "type": "KeyboardButton" }, "keyboardButtonSourceMessage": { "description": "The button is from a bot's message", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message with the button", "is_optional": false, "type": "int53" } }, "type": "KeyboardButtonSource" }, "keyboardButtonSourceWebApp": { "description": "The button is a prepared keyboard button from a Mini App received via getPreparedKeyboardButton", "args": { "bot_user_id": { "description": "Identifier of the bot that created the button", "is_optional": false, "type": "int53" }, "prepared_button_id": { "description": "Identifier of the prepared button", "is_optional": false, "type": "string" } }, "type": "KeyboardButtonSource" }, "keyboardButtonTypeRequestChat": { "description": "A button that requests a chat to be shared by the current user; available only in private chats. Use the method shareChatWithBot to complete the request", "args": { "bot_administrator_rights": { "description": "Expected bot administrator rights in the chat; may be null if they aren't restricted", "is_optional": true, "type": "chatAdministratorRights" }, "bot_is_member": { "description": "True, if the bot must be a member of the chat; for basic group and supergroup chats only", "is_optional": false, "type": "Bool" }, "chat_has_username": { "description": "True, if the chat must have a username; otherwise, the chat must not have a username. Ignored if restrict_chat_has_username is false", "is_optional": false, "type": "Bool" }, "chat_is_channel": { "description": "True, if the chat must be a channel; otherwise, a basic group or a supergroup chat is shared", "is_optional": false, "type": "Bool" }, "chat_is_created": { "description": "True, if the chat must be created by the current user", "is_optional": false, "type": "Bool" }, "chat_is_forum": { "description": "True, if the chat must be a forum supergroup; otherwise, the chat must not be a forum supergroup. Ignored if restrict_chat_is_forum is false", "is_optional": false, "type": "Bool" }, "id": { "description": "Unique button identifier", "is_optional": false, "type": "int32" }, "request_photo": { "description": "Pass true to request photo of the chat; bots only", "is_optional": false, "type": "Bool" }, "request_title": { "description": "Pass true to request title of the chat; bots only", "is_optional": false, "type": "Bool" }, "request_username": { "description": "Pass true to request username of the chat; bots only", "is_optional": false, "type": "Bool" }, "restrict_chat_has_username": { "description": "True, if the chat must or must not have a username", "is_optional": false, "type": "Bool" }, "restrict_chat_is_forum": { "description": "True, if the chat must or must not be a forum supergroup", "is_optional": false, "type": "Bool" }, "user_administrator_rights": { "description": "Expected user administrator rights in the chat; may be null if they aren't restricted", "is_optional": true, "type": "chatAdministratorRights" } }, "type": "KeyboardButtonType" }, "keyboardButtonTypeRequestLocation": { "description": "A button that sends the user's location when pressed; available only in private chats", "args": {}, "type": "KeyboardButtonType" }, "keyboardButtonTypeRequestManagedBot": { "description": "A button that requests creation of a managed bot by the current user; available only in private chats. Use the method createBot to complete the request", "args": { "id": { "description": "Unique button identifier", "is_optional": false, "type": "int32" }, "suggested_name": { "description": "Suggested name for the bot; may be empty if not specified", "is_optional": true, "type": "string" }, "suggested_username": { "description": "Suggested username for the bot; may be empty if not specified", "is_optional": true, "type": "string" } }, "type": "KeyboardButtonType" }, "keyboardButtonTypeRequestPhoneNumber": { "description": "A button that sends the user's phone number when pressed; available only in private chats", "args": {}, "type": "KeyboardButtonType" }, "keyboardButtonTypeRequestPoll": { "description": "A button that allows the user to create and send a poll when pressed; available only in private chats", "args": { "force_quiz": { "description": "If true, only polls in quiz mode must be allowed to create", "is_optional": false, "type": "Bool" }, "force_regular": { "description": "If true, only regular polls must be allowed to create", "is_optional": false, "type": "Bool" } }, "type": "KeyboardButtonType" }, "keyboardButtonTypeRequestUsers": { "description": "A button that requests users to be shared by the current user; available only in private chats. Use the method shareUsersWithBot to complete the request", "args": { "id": { "description": "Unique button identifier", "is_optional": false, "type": "int32" }, "max_quantity": { "description": "The maximum number of users to share", "is_optional": false, "type": "int32" }, "request_name": { "description": "Pass true to request name of the users; bots only", "is_optional": false, "type": "Bool" }, "request_photo": { "description": "Pass true to request photo of the users; bots only", "is_optional": false, "type": "Bool" }, "request_username": { "description": "Pass true to request username of the users; bots only", "is_optional": false, "type": "Bool" }, "restrict_user_is_bot": { "description": "True, if the shared users must or must not be bots", "is_optional": false, "type": "Bool" }, "restrict_user_is_premium": { "description": "True, if the shared users must or must not be Telegram Premium users", "is_optional": false, "type": "Bool" }, "user_is_bot": { "description": "True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false", "is_optional": false, "type": "Bool" }, "user_is_premium": { "description": "True, if the shared users must be Telegram Premium users; otherwise, the shared users must not be Telegram Premium users. Ignored if restrict_user_is_premium is false", "is_optional": false, "type": "Bool" } }, "type": "KeyboardButtonType" }, "keyboardButtonTypeText": { "description": "A simple button, with text that must be sent when the button is pressed", "args": {}, "type": "KeyboardButtonType" }, "keyboardButtonTypeWebApp": { "description": "A button that opens a Web App by calling getWebAppUrl", "args": { "url": { "description": "An HTTP URL to pass to getWebAppUrl", "is_optional": false, "type": "string" } }, "type": "KeyboardButtonType" }, "labeledPricePart": { "description": "Portion of the price of a product (e.g., \"delivery cost\", \"tax amount\")", "args": { "amount": { "description": "Currency amount in the smallest units of the currency", "is_optional": false, "type": "int53" }, "label": { "description": "Label for this portion of the product price", "is_optional": false, "type": "string" } }, "type": "LabeledPricePart" }, "languagePackInfo": { "description": "Contains information about a language pack", "args": { "base_language_pack_id": { "description": "Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it must be fetched from base language pack. Unsupported in custom language packs", "is_optional": true, "type": "string" }, "id": { "description": "Unique language pack identifier", "is_optional": false, "type": "string" }, "is_beta": { "description": "True, if the language pack is a beta language pack", "is_optional": false, "type": "Bool" }, "is_installed": { "description": "True, if the language pack is installed by the current user", "is_optional": false, "type": "Bool" }, "is_official": { "description": "True, if the language pack is official", "is_optional": false, "type": "Bool" }, "is_rtl": { "description": "True, if the language pack strings are RTL", "is_optional": false, "type": "Bool" }, "local_string_count": { "description": "Total number of non-deleted strings from the language pack available locally", "is_optional": false, "type": "int32" }, "name": { "description": "Language name", "is_optional": false, "type": "string" }, "native_name": { "description": "Name of the language in that language", "is_optional": false, "type": "string" }, "plural_code": { "description": "A language code to be used to apply plural forms. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information", "is_optional": false, "type": "string" }, "total_string_count": { "description": "Total number of non-deleted strings from the language pack", "is_optional": false, "type": "int32" }, "translated_string_count": { "description": "Total number of translated strings from the language pack", "is_optional": false, "type": "int32" }, "translation_url": { "description": "Link to language translation interface; empty for custom local language packs", "is_optional": false, "type": "string" } }, "type": "LanguagePackInfo" }, "languagePackString": { "description": "Represents one language pack string", "args": { "key": { "description": "String key", "is_optional": false, "type": "string" }, "value": { "description": "String value; pass null if the string needs to be taken from the built-in English language pack", "is_optional": true, "type": "LanguagePackStringValue" } }, "type": "LanguagePackString" }, "languagePackStringValueDeleted": { "description": "A deleted language pack string, the value must be taken from the built-in English language pack", "args": {}, "type": "LanguagePackStringValue" }, "languagePackStringValueOrdinary": { "description": "An ordinary language pack string", "args": { "value": { "description": "String value", "is_optional": false, "type": "string" } }, "type": "LanguagePackStringValue" }, "languagePackStringValuePluralized": { "description": "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", "args": { "few_value": { "description": "Value for few objects", "is_optional": false, "type": "string" }, "many_value": { "description": "Value for many objects", "is_optional": false, "type": "string" }, "one_value": { "description": "Value for one object", "is_optional": false, "type": "string" }, "other_value": { "description": "Default value", "is_optional": false, "type": "string" }, "two_value": { "description": "Value for two objects", "is_optional": false, "type": "string" }, "zero_value": { "description": "Value for zero objects", "is_optional": false, "type": "string" } }, "type": "LanguagePackStringValue" }, "languagePackStrings": { "description": "Contains a list of language pack strings", "args": { "strings": { "description": "A list of language pack strings", "is_optional": false, "type": "vector\u003clanguagePackString\u003e" } }, "type": "LanguagePackStrings" }, "linkPreview": { "description": "Describes a link preview", "args": { "author": { "description": "Author of the content", "is_optional": false, "type": "string" }, "description": { "description": "Description of the content", "is_optional": false, "type": "formattedText" }, "display_url": { "description": "URL to display", "is_optional": false, "type": "string" }, "has_large_media": { "description": "True, if size of media in the preview can be changed", "is_optional": false, "type": "Bool" }, "instant_view_version": { "description": "Version of instant view (currently, can be 1 or 2) for the web page; 0 if none", "is_optional": false, "type": "int32" }, "show_above_text": { "description": "True, if the link preview must be shown above message text; otherwise, the link preview must be shown below the message text", "is_optional": false, "type": "Bool" }, "show_large_media": { "description": "True, if large media preview must be shown; otherwise, the media preview must be shown small and only the first frame must be shown for videos", "is_optional": false, "type": "Bool" }, "show_media_above_description": { "description": "True, if media must be shown above link preview description; otherwise, the media must be shown below the description", "is_optional": false, "type": "Bool" }, "site_name": { "description": "Short name of the website (e.g., Google Docs, App Store)", "is_optional": false, "type": "string" }, "skip_confirmation": { "description": "True, if there is no need to show an ordinary open URL confirmation, when opening the URL from the preview, because the URL is shown in the message text in clear", "is_optional": false, "type": "Bool" }, "title": { "description": "Title of the content", "is_optional": false, "type": "string" }, "type": { "description": "Type of the link preview", "is_optional": false, "type": "LinkPreviewType" }, "url": { "description": "Original URL of the link", "is_optional": false, "type": "string" } }, "type": "LinkPreview" }, "linkPreviewAlbumMediaPhoto": { "description": "The media is a photo", "args": { "photo": { "description": "Photo description", "is_optional": false, "type": "photo" } }, "type": "LinkPreviewAlbumMedia" }, "linkPreviewAlbumMediaVideo": { "description": "The media is a video", "args": { "video": { "description": "Video description", "is_optional": false, "type": "video" } }, "type": "LinkPreviewAlbumMedia" }, "linkPreviewOptions": { "description": "Options to be used for generation of a link preview", "args": { "force_large_media": { "description": "True, if shown media preview must be large; ignored in secret chats or if the URL isn't explicitly specified", "is_optional": false, "type": "Bool" }, "force_small_media": { "description": "True, if shown media preview must be small; ignored in secret chats or if the URL isn't explicitly specified", "is_optional": false, "type": "Bool" }, "is_disabled": { "description": "True, if link preview must be disabled", "is_optional": false, "type": "Bool" }, "show_above_text": { "description": "True, if link preview must be shown above message text; otherwise, the link preview will be shown below the message text; ignored in secret chats", "is_optional": false, "type": "Bool" }, "url": { "description": "URL to use for link preview. If empty, then the first URL found in the message text will be used", "is_optional": false, "type": "string" } }, "type": "LinkPreviewOptions" }, "linkPreviewTypeAlbum": { "description": "The link is a link to a media album consisting of photos and videos", "args": { "caption": { "description": "Album caption", "is_optional": false, "type": "string" }, "media": { "description": "The list of album media", "is_optional": false, "type": "vector\u003cLinkPreviewAlbumMedia\u003e" } }, "type": "LinkPreviewType" }, "linkPreviewTypeAnimation": { "description": "The link is a link to an animation", "args": { "animation": { "description": "The animation", "is_optional": false, "type": "animation" } }, "type": "LinkPreviewType" }, "linkPreviewTypeApp": { "description": "The link is a link to an app at App Store or Google Play", "args": { "photo": { "description": "Photo for the app", "is_optional": false, "type": "photo" } }, "type": "LinkPreviewType" }, "linkPreviewTypeArticle": { "description": "The link is a link to a website", "args": { "photo": { "description": "Article's main photo; may be null", "is_optional": true, "type": "photo" } }, "type": "LinkPreviewType" }, "linkPreviewTypeAudio": { "description": "The link is a link to an audio", "args": { "audio": { "description": "The audio description", "is_optional": false, "type": "audio" } }, "type": "LinkPreviewType" }, "linkPreviewTypeBackground": { "description": "The link is a link to a background. Link preview title and description are available only for filled backgrounds", "args": { "background_type": { "description": "Type of the background; may be null if unknown", "is_optional": true, "type": "BackgroundType" }, "document": { "description": "Document with the background; may be null for filled backgrounds", "is_optional": true, "type": "document" } }, "type": "LinkPreviewType" }, "linkPreviewTypeChannelBoost": { "description": "The link is a link to boost a channel chat", "args": { "photo": { "description": "Photo of the chat; may be null", "is_optional": true, "type": "chatPhoto" } }, "type": "LinkPreviewType" }, "linkPreviewTypeChat": { "description": "The link is a link to a chat", "args": { "creates_join_request": { "description": "True, if the link only creates join request", "is_optional": false, "type": "Bool" }, "photo": { "description": "Photo of the chat; may be null", "is_optional": true, "type": "chatPhoto" }, "type": { "description": "Type of the chat", "is_optional": false, "type": "InviteLinkChatType" } }, "type": "LinkPreviewType" }, "linkPreviewTypeDirectMessagesChat": { "description": "The link is a link to a direct messages chat of a channel", "args": { "photo": { "description": "Photo of the channel chat; may be null", "is_optional": true, "type": "chatPhoto" } }, "type": "LinkPreviewType" }, "linkPreviewTypeDocument": { "description": "The link is a link to a general file", "args": { "document": { "description": "The document description", "is_optional": false, "type": "document" } }, "type": "LinkPreviewType" }, "linkPreviewTypeEmbeddedAnimationPlayer": { "description": "The link is a link to an animation player", "args": { "animation": { "description": "The cached animation; may be null if unknown", "is_optional": true, "type": "animation" }, "duration": { "description": "Duration of the animation, in seconds", "is_optional": false, "type": "int32" }, "height": { "description": "Expected height of the embedded player", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Thumbnail of the animation; may be null if unknown", "is_optional": true, "type": "photo" }, "url": { "description": "URL of the external animation player", "is_optional": false, "type": "string" }, "width": { "description": "Expected width of the embedded player", "is_optional": false, "type": "int32" } }, "type": "LinkPreviewType" }, "linkPreviewTypeEmbeddedAudioPlayer": { "description": "The link is a link to an audio player", "args": { "audio": { "description": "The cached audio; may be null if unknown", "is_optional": true, "type": "audio" }, "duration": { "description": "Duration of the audio, in seconds", "is_optional": false, "type": "int32" }, "height": { "description": "Expected height of the embedded player", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Thumbnail of the audio; may be null if unknown", "is_optional": true, "type": "photo" }, "url": { "description": "URL of the external audio player", "is_optional": false, "type": "string" }, "width": { "description": "Expected width of the embedded player", "is_optional": false, "type": "int32" } }, "type": "LinkPreviewType" }, "linkPreviewTypeEmbeddedVideoPlayer": { "description": "The link is a link to a video player", "args": { "duration": { "description": "Duration of the video, in seconds", "is_optional": false, "type": "int32" }, "height": { "description": "Expected height of the embedded player", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Thumbnail of the video; may be null if unknown", "is_optional": true, "type": "photo" }, "url": { "description": "URL of the external video player", "is_optional": false, "type": "string" }, "video": { "description": "The cached video; may be null if unknown", "is_optional": true, "type": "video" }, "width": { "description": "Expected width of the embedded player", "is_optional": false, "type": "int32" } }, "type": "LinkPreviewType" }, "linkPreviewTypeExternalAudio": { "description": "The link is a link to an audio file", "args": { "duration": { "description": "Duration of the audio, in seconds; 0 if unknown", "is_optional": false, "type": "int32" }, "mime_type": { "description": "MIME type of the audio file", "is_optional": false, "type": "string" }, "url": { "description": "URL of the audio file", "is_optional": false, "type": "string" } }, "type": "LinkPreviewType" }, "linkPreviewTypeExternalVideo": { "description": "The link is a link to a video file", "args": { "duration": { "description": "Duration of the video, in seconds; 0 if unknown", "is_optional": false, "type": "int32" }, "height": { "description": "Expected height of the video preview; 0 if unknown", "is_optional": false, "type": "int32" }, "mime_type": { "description": "MIME type of the video file", "is_optional": false, "type": "string" }, "url": { "description": "URL of the video file", "is_optional": false, "type": "string" }, "width": { "description": "Expected width of the video preview; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "LinkPreviewType" }, "linkPreviewTypeGiftAuction": { "description": "The link is a link to a gift auction", "args": { "auction_end_date": { "description": "Point in time (Unix timestamp) when the auction will be ended", "is_optional": false, "type": "int32" }, "gift": { "description": "The gift", "is_optional": false, "type": "gift" } }, "type": "LinkPreviewType" }, "linkPreviewTypeGiftCollection": { "description": "The link is a link to a gift collection", "args": { "icons": { "description": "Icons for some gifts from the collection; may be empty", "is_optional": true, "type": "vector\u003csticker\u003e" } }, "type": "LinkPreviewType" }, "linkPreviewTypeGroupCall": { "description": "The link is a link to a group call that isn't bound to a chat", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeInvoice": { "description": "The link is a link to an invoice", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeLiveStory": { "description": "The link is a link to a live story group call", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "LinkPreviewType" }, "linkPreviewTypeMessage": { "description": "The link is a link to a text or a poll Telegram message", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypePhoto": { "description": "The link is a link to a photo", "args": { "photo": { "description": "The photo", "is_optional": false, "type": "photo" } }, "type": "LinkPreviewType" }, "linkPreviewTypePremiumGiftCode": { "description": "The link is a link to a Telegram Premium gift code", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeRequestManagedBot": { "description": "The link is a link to a dialog for creating of a managed bot", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeShareableChatFolder": { "description": "The link is a link to a shareable chat folder", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeSticker": { "description": "The link is a link to a sticker", "args": { "sticker": { "description": "The sticker. It can be an arbitrary WEBP image and can have dimensions bigger than 512", "is_optional": false, "type": "sticker" } }, "type": "LinkPreviewType" }, "linkPreviewTypeStickerSet": { "description": "The link is a link to a sticker set", "args": { "stickers": { "description": "Up to 4 stickers from the sticker set", "is_optional": false, "type": "vector\u003csticker\u003e" } }, "type": "LinkPreviewType" }, "linkPreviewTypeStory": { "description": "The link is a link to a story. Link preview description is unavailable", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "LinkPreviewType" }, "linkPreviewTypeStoryAlbum": { "description": "The link is a link to an album of stories", "args": { "photo_icon": { "description": "Icon of the album; may be null if none", "is_optional": true, "type": "photo" }, "video_icon": { "description": "Video icon of the album; may be null if none", "is_optional": true, "type": "video" } }, "type": "LinkPreviewType" }, "linkPreviewTypeSupergroupBoost": { "description": "The link is a link to boost a supergroup chat", "args": { "photo": { "description": "Photo of the chat; may be null", "is_optional": true, "type": "chatPhoto" } }, "type": "LinkPreviewType" }, "linkPreviewTypeTextCompositionStyle": { "description": "The link is a link to a text composition style", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji corresponding to the style; 0 if none", "is_optional": false, "type": "int64" } }, "type": "LinkPreviewType" }, "linkPreviewTypeTheme": { "description": "The link is a link to a cloud theme. TDLib has no theme support yet", "args": { "documents": { "description": "The list of files with theme description", "is_optional": false, "type": "vector\u003cdocument\u003e" }, "settings": { "description": "Settings for the cloud theme; may be null if unknown", "is_optional": true, "type": "themeSettings" } }, "type": "LinkPreviewType" }, "linkPreviewTypeUnsupported": { "description": "The link preview type is unsupported yet", "args": {}, "type": "LinkPreviewType" }, "linkPreviewTypeUpgradedGift": { "description": "The link is a link to an upgraded gift", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" } }, "type": "LinkPreviewType" }, "linkPreviewTypeUser": { "description": "The link is a link to a user", "args": { "is_bot": { "description": "True, if the user is a bot", "is_optional": false, "type": "Bool" }, "photo": { "description": "Photo of the user; may be null if none", "is_optional": true, "type": "chatPhoto" } }, "type": "LinkPreviewType" }, "linkPreviewTypeVideo": { "description": "The link is a link to a video", "args": { "cover": { "description": "Cover of the video; may be null if none", "is_optional": true, "type": "photo" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "video": { "description": "The video description", "is_optional": false, "type": "video" } }, "type": "LinkPreviewType" }, "linkPreviewTypeVideoChat": { "description": "The link is a link to a video chat", "args": { "is_live_stream": { "description": "True, if the video chat is expected to be a live stream in a channel or a broadcast group", "is_optional": false, "type": "Bool" }, "joins_as_speaker": { "description": "True, if the user can use the link to join the video chat without being muted by administrators", "is_optional": false, "type": "Bool" }, "photo": { "description": "Photo of the chat with the video chat; may be null if none", "is_optional": true, "type": "chatPhoto" } }, "type": "LinkPreviewType" }, "linkPreviewTypeVideoNote": { "description": "The link is a link to a video note message", "args": { "video_note": { "description": "The video note", "is_optional": false, "type": "videoNote" } }, "type": "LinkPreviewType" }, "linkPreviewTypeVoiceNote": { "description": "The link is a link to a voice note message", "args": { "voice_note": { "description": "The voice note", "is_optional": false, "type": "voiceNote" } }, "type": "LinkPreviewType" }, "linkPreviewTypeWebApp": { "description": "The link is a link to a Web App", "args": { "photo": { "description": "Web App photo; may be null if none", "is_optional": true, "type": "photo" } }, "type": "LinkPreviewType" }, "liveLocation": { "description": "A live location", "args": { "heading": { "description": "The direction in which the location moves, in degrees; 1-360; 0 if unknown", "is_optional": false, "type": "int32" }, "live_period": { "description": "Time relative to the message send date, for which the location can be updated, in seconds; if 0x7FFFFFFF, then location can be updated forever", "is_optional": false, "type": "int32" }, "location": { "description": "The current location", "is_optional": false, "type": "location" }, "proximity_alert_radius": { "description": "The maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled.", "is_optional": false, "type": "int32" } }, "type": "LiveLocation" }, "liveStoryDonors": { "description": "Contains a list of users and chats that spend most money on paid messages and reactions in a live story", "args": { "top_donors": { "description": "List of top donors in the live story", "is_optional": false, "type": "vector\u003cpaidReactor\u003e" }, "total_star_count": { "description": "Total amount of spend Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "LiveStoryDonors" }, "localFile": { "description": "Represents a local file", "args": { "can_be_deleted": { "description": "True, if the file can be deleted", "is_optional": false, "type": "Bool" }, "can_be_downloaded": { "description": "True, if it is possible to download or generate the file", "is_optional": false, "type": "Bool" }, "download_offset": { "description": "Download will be started from this offset. downloaded_prefix_size is calculated from this offset", "is_optional": false, "type": "int53" }, "downloaded_prefix_size": { "description": "If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes", "is_optional": false, "type": "int53" }, "downloaded_size": { "description": "Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage", "is_optional": false, "type": "int53" }, "is_downloading_active": { "description": "True, if the file is currently being downloaded (or a local copy is being generated by some other means)", "is_optional": false, "type": "Bool" }, "is_downloading_completed": { "description": "True, if the local copy is fully available", "is_optional": false, "type": "Bool" }, "path": { "description": "Local path to the locally available file part; may be empty", "is_optional": true, "type": "string" } }, "type": "LocalFile" }, "localizationTargetInfo": { "description": "Contains information about the current localization target", "args": { "language_packs": { "description": "List of available language packs for this application", "is_optional": false, "type": "vector\u003clanguagePackInfo\u003e" } }, "type": "LocalizationTargetInfo" }, "location": { "description": "Describes a location on planet Earth", "args": { "horizontal_accuracy": { "description": "The estimated horizontal accuracy of the location, in meters; as defined by the sender. 0 if unknown", "is_optional": false, "type": "double" }, "latitude": { "description": "Latitude of the location in degrees; as defined by the sender", "is_optional": false, "type": "double" }, "longitude": { "description": "Longitude of the location, in degrees; as defined by the sender", "is_optional": false, "type": "double" } }, "type": "Location" }, "locationAddress": { "description": "Describes an address of a location", "args": { "city": { "description": "City; empty if unknown", "is_optional": false, "type": "string" }, "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code", "is_optional": false, "type": "string" }, "state": { "description": "State, if applicable; empty if unknown", "is_optional": false, "type": "string" }, "street": { "description": "The address; empty if unknown", "is_optional": false, "type": "string" } }, "type": "LocationAddress" }, "logStreamDefault": { "description": "The log is written to stderr or an OS specific log", "args": {}, "type": "LogStream" }, "logStreamEmpty": { "description": "The log is written nowhere", "args": {}, "type": "LogStream" }, "logStreamFile": { "description": "The log is written to a file", "args": { "max_file_size": { "description": "The maximum size of the file to where the internal TDLib log is written before the file will automatically be rotated, in bytes", "is_optional": false, "type": "int53" }, "path": { "description": "Path to the file to where the internal TDLib log will be written", "is_optional": false, "type": "string" }, "redirect_stderr": { "description": "Pass true to additionally redirect stderr to the log file. Ignored on Windows", "is_optional": false, "type": "Bool" } }, "type": "LogStream" }, "logTags": { "description": "Contains a list of available TDLib internal log tags", "args": { "tags": { "description": "List of log tags", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "LogTags" }, "logVerbosityLevel": { "description": "Contains a TDLib internal log verbosity level", "args": { "verbosity_level": { "description": "Log verbosity level", "is_optional": false, "type": "int32" } }, "type": "LogVerbosityLevel" }, "loginUrlInfoOpen": { "description": "An HTTP URL needs to be open", "args": { "skip_confirmation": { "description": "True, if there is no need to show an ordinary open URL confirmation", "is_optional": false, "type": "Bool" }, "url": { "description": "The URL to open", "is_optional": false, "type": "string" } }, "type": "LoginUrlInfo" }, "loginUrlInfoRequestConfirmation": { "description": "An authorization confirmation dialog needs to be shown to the user", "args": { "bot_user_id": { "description": "User identifier of a bot linked with the website", "is_optional": false, "type": "int53" }, "domain": { "description": "A domain of the URL", "is_optional": false, "type": "string" }, "request_write_access": { "description": "True, if the user must be asked for the permission to the bot to send them messages", "is_optional": false, "type": "Bool" }, "url": { "description": "An HTTP URL to be opened", "is_optional": false, "type": "string" } }, "type": "LoginUrlInfo" }, "mainWebApp": { "description": "Contains information about the main Web App of a bot", "args": { "mode": { "description": "The mode in which the Web App must be opened", "is_optional": false, "type": "WebAppOpenMode" }, "url": { "description": "URL of the Web App to open", "is_optional": false, "type": "webAppUrl" } }, "type": "MainWebApp" }, "maskPointChin": { "description": "The mask is placed relatively to the chin", "args": {}, "type": "MaskPoint" }, "maskPointEyes": { "description": "The mask is placed relatively to the eyes", "args": {}, "type": "MaskPoint" }, "maskPointForehead": { "description": "The mask is placed relatively to the forehead", "args": {}, "type": "MaskPoint" }, "maskPointMouth": { "description": "The mask is placed relatively to the mouth", "args": {}, "type": "MaskPoint" }, "maskPosition": { "description": "Position on a photo where a mask is placed", "args": { "point": { "description": "Part of the face, relative to which the mask is placed", "is_optional": false, "type": "MaskPoint" }, "scale": { "description": "Mask scaling coefficient. (For example, 2.0 means a doubled size)", "is_optional": false, "type": "double" }, "x_shift": { "description": "Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)", "is_optional": false, "type": "double" }, "y_shift": { "description": "Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. (For example, 1.0 will place the mask just below the default mask position)", "is_optional": false, "type": "double" } }, "type": "MaskPosition" }, "message": { "description": "Describes a message", "args": { "author_signature": { "description": "For channel posts and anonymous group messages, optional author signature", "is_optional": false, "type": "string" }, "auto_delete_in": { "description": "Time left before the message will be automatically deleted by message_auto_delete_time setting of the chat, in seconds; 0 if never", "is_optional": false, "type": "double" }, "can_be_saved": { "description": "True, if content of the message can be saved locally", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "chat_instance": { "description": "Identifier that uniquely corresponds to the chat to which the message was sent; for bots only", "is_optional": false, "type": "int64" }, "contains_unread_mention": { "description": "True, if the message contains an unread mention for the current user", "is_optional": false, "type": "Bool" }, "contains_unread_poll_votes": { "description": "True, if the message is a poll message with unread votes", "is_optional": false, "type": "Bool" }, "content": { "description": "Content of the message", "is_optional": false, "type": "MessageContent" }, "date": { "description": "Point in time (Unix timestamp) when the message was sent; 0 for scheduled messages", "is_optional": false, "type": "int32" }, "edit_date": { "description": "Point in time (Unix timestamp) when the message was last edited; 0 for scheduled messages. If getOption(\"show_message_edit_date_by_default\") is true,", "is_optional": false, "type": "int32" }, "effect_id": { "description": "Unique identifier of the effect added to the message; 0 if none", "is_optional": false, "type": "int64" }, "ephemeral_content": { "description": "Content of the message, which is visible only to the current user and must be shown instead of the regular content; may be null if none", "is_optional": true, "type": "ephemeralMessageContent" }, "ephemeral_message_id": { "description": "Unique identifier of the ephemeral message if the message is ephemeral; for bots only", "is_optional": false, "type": "int32" }, "fact_check": { "description": "Information about fact-check added to the message; may be null if none", "is_optional": true, "type": "factCheck" }, "forward_info": { "description": "Information about the initial message sender; may be null if none or unknown", "is_optional": true, "type": "messageForwardInfo" }, "guest_bot_caller_id": { "description": "The identifier of the user or chat which used a guest bot to send the message; may be null if none", "is_optional": true, "type": "MessageSender" }, "has_timestamped_media": { "description": "True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message", "is_optional": false, "type": "Bool" }, "id": { "description": "Message identifier; unique for the chat to which the message belongs", "is_optional": false, "type": "int53" }, "import_info": { "description": "Information about the initial message for messages created with importMessages; may be null if the message isn't imported", "is_optional": true, "type": "messageImportInfo" }, "interaction_info": { "description": "Information about interactions with the message; may be null if none", "is_optional": true, "type": "messageInteractionInfo" }, "is_channel_post": { "description": "True, if the message is a channel post. All messages to channels are channel posts, all other messages are not channel posts", "is_optional": false, "type": "Bool" }, "is_from_offline": { "description": "True, if the message was sent because of a scheduled action by the message sender, for example, as away, or greeting service message", "is_optional": false, "type": "Bool" }, "is_outgoing": { "description": "True, if the message is outgoing", "is_optional": false, "type": "Bool" }, "is_paid_gram_suggested_post": { "description": "True, if the message is a suggested channel post which was paid in TON Grams; a warning must be shown if the message is deleted in less than getOption(\"suggested_post_lifetime_min\") seconds after sending", "is_optional": false, "type": "Bool" }, "is_paid_star_suggested_post": { "description": "True, if the message is a suggested channel post which was paid in Telegram Stars; a warning must be shown if the message is deleted in less than getOption(\"suggested_post_lifetime_min\") seconds after sending", "is_optional": false, "type": "Bool" }, "is_pinned": { "description": "True, if the message is pinned", "is_optional": false, "type": "Bool" }, "media_album_id": { "description": "Unique identifier of an album this message belongs to; 0 if none. Only audios, documents, photos and videos can be grouped together in albums", "is_optional": false, "type": "int64" }, "paid_message_star_count": { "description": "The number of Telegram Stars the sender paid to send the message", "is_optional": false, "type": "int53" }, "receiver_id": { "description": "Identifier of the user or the chat which received the ephemeral message; may be null. Always null for non-ephemeral messages", "is_optional": true, "type": "MessageSender" }, "reply_markup": { "description": "Reply markup for the message; may be null if none", "is_optional": true, "type": "ReplyMarkup" }, "reply_to": { "description": "Information about the message or the story this message is replying to; may be null if none", "is_optional": true, "type": "MessageReplyTo" }, "restriction_info": { "description": "Information about the restrictions that must be applied to the message content; may be null if none", "is_optional": true, "type": "restrictionInfo" }, "scheduling_state": { "description": "The scheduling state of the message; may be null if the message isn't scheduled", "is_optional": true, "type": "MessageSchedulingState" }, "self_destruct_in": { "description": "Time left before the message self-destruct timer expires, in seconds; 0 if self-destruction isn't scheduled yet", "is_optional": false, "type": "double" }, "self_destruct_type": { "description": "The message's self-destruct type; may be null if none", "is_optional": true, "type": "MessageSelfDestructType" }, "sender_boost_count": { "description": "Number of times the sender of the message boosted the supergroup at the time the message was sent; 0 if none or unknown. For messages sent by the current user, supergroupFullInfo.my_boost_count must be used instead", "is_optional": false, "type": "int32" }, "sender_business_bot_user_id": { "description": "If non-zero, the user identifier of the business bot that sent this message", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of the message", "is_optional": false, "type": "MessageSender" }, "sender_tag": { "description": "Tag of the sender of the message in the supergroup at the time the message was sent; may be empty if none or unknown. For messages sent in basic groups or supergroup administrators, the current custom title or tag must be used instead", "is_optional": true, "type": "string" }, "sending_state": { "description": "The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent", "is_optional": true, "type": "MessageSendingState" }, "suggested_post_info": { "description": "Information about the suggested post; may be null if the message isn't a suggested post", "is_optional": true, "type": "suggestedPostInfo" }, "summary_language_code": { "description": "IETF language tag of the message language on which it can be summarized; empty if summary isn't available for the message", "is_optional": false, "type": "string" }, "topic_id": { "description": "Identifier of the topic within the chat to which the message belongs; may be null if none; may change when the chat is converted to a forum or back", "is_optional": true, "type": "MessageTopic" }, "unread_reactions": { "description": "Information about unread reactions added to the message", "is_optional": false, "type": "vector\u003cunreadReaction\u003e" }, "via_bot_user_id": { "description": "If non-zero, the user identifier of the inline bot through which this message was sent", "is_optional": false, "type": "int53" } }, "type": "Message" }, "messageAnimatedEmoji": { "description": "A message with an animated emoji", "args": { "animated_emoji": { "description": "The animated emoji", "is_optional": false, "type": "animatedEmoji" }, "emoji": { "description": "The corresponding emoji", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageAnimation": { "description": "An animation message (GIF-style).", "args": { "animation": { "description": "The animation description", "is_optional": false, "type": "animation" }, "caption": { "description": "Animation caption", "is_optional": false, "type": "formattedText" }, "has_spoiler": { "description": "True, if the animation preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "is_secret": { "description": "True, if the animation thumbnail must be blurred and the animation must be shown only while tapped", "is_optional": false, "type": "Bool" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageAudio": { "description": "An audio message", "args": { "audio": { "description": "The audio description", "is_optional": false, "type": "audio" }, "caption": { "description": "Audio caption", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messageAutoDeleteTime": { "description": "Contains default auto-delete timer setting for new chats", "args": { "time": { "description": "Message auto-delete time, in seconds. If 0, then messages aren't deleted automatically", "is_optional": false, "type": "int32" } }, "type": "MessageAutoDeleteTime" }, "messageBasicGroupChatCreate": { "description": "A newly created basic group", "args": { "member_user_ids": { "description": "User identifiers of members in the basic group", "is_optional": false, "type": "vector\u003cint53\u003e" }, "title": { "description": "Title of the basic group", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageBotWriteAccessAllowed": { "description": "The user allowed the bot to send messages", "args": { "reason": { "description": "The reason why the bot was allowed to write messages", "is_optional": false, "type": "BotWriteAccessAllowReason" } }, "type": "MessageContent" }, "messageCalendar": { "description": "Contains information about found messages, split by days according to the option \"utc_time_offset\"", "args": { "days": { "description": "Information about messages sent", "is_optional": false, "type": "vector\u003cmessageCalendarDay\u003e" }, "total_count": { "description": "Total number of found messages", "is_optional": false, "type": "int32" } }, "type": "MessageCalendar" }, "messageCalendarDay": { "description": "Contains information about found messages sent on a specific day", "args": { "message": { "description": "First message sent on the day", "is_optional": false, "type": "message" }, "total_count": { "description": "Total number of found messages sent on the day", "is_optional": false, "type": "int32" } }, "type": "MessageCalendarDay" }, "messageCall": { "description": "A message with information about an ended call", "args": { "discard_reason": { "description": "Reason why the call was discarded", "is_optional": false, "type": "CallDiscardReason" }, "duration": { "description": "Call duration, in seconds", "is_optional": false, "type": "int32" }, "is_video": { "description": "True, if the call was a video call", "is_optional": false, "type": "Bool" }, "unique_id": { "description": "Persistent unique call identifier; 0 for calls from other devices, which can't be passed as inputCallFromMessage", "is_optional": false, "type": "int64" } }, "type": "MessageContent" }, "messageChatAddMembers": { "description": "New chat members were added", "args": { "member_user_ids": { "description": "User identifiers of the new members", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "MessageContent" }, "messageChatAddedToCommunity": { "description": "The chat was added to a community", "args": { "community_id": { "description": "Identifier of the community to which the chat was added", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatBoost": { "description": "The chat was boosted by the sender of the message", "args": { "boost_count": { "description": "Number of times the chat was boosted", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageChatChangePhoto": { "description": "An updated chat photo", "args": { "photo": { "description": "New chat photo", "is_optional": false, "type": "chatPhoto" } }, "type": "MessageContent" }, "messageChatChangeTitle": { "description": "An updated chat title", "args": { "title": { "description": "New chat title", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageChatDeleteMember": { "description": "A chat member was deleted", "args": { "user_id": { "description": "User identifier of the deleted chat member", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatDeletePhoto": { "description": "A deleted chat photo", "args": {}, "type": "MessageContent" }, "messageChatHasProtectedContentDisableRequested": { "description": "Chat has_protected_content setting was requested to be disabled", "args": { "is_expired": { "description": "True, if the request has expired", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageChatHasProtectedContentToggled": { "description": "Chat has_protected_content setting was changed or request to change it was rejected", "args": { "new_has_protected_content": { "description": "New value of the setting", "is_optional": false, "type": "Bool" }, "old_has_protected_content": { "description": "Previous value of the setting", "is_optional": false, "type": "Bool" }, "request_message_id": { "description": "Identifier of the message with the request to change the setting; can be an identifier of a deleted message or 0", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatJoinByLink": { "description": "A new member joined the chat via an invite link", "args": {}, "type": "MessageContent" }, "messageChatJoinByRequest": { "description": "A new member was accepted to the chat by an administrator", "args": {}, "type": "MessageContent" }, "messageChatJoinFromCommunity": { "description": "A new member joined the chat from a community", "args": { "community_id": { "description": "Identifier of the community from which the user joined the chat", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatOwnerChanged": { "description": "The owner of the chat has changed", "args": { "new_owner_user_id": { "description": "Identifier of the user who is the new owner of the chat", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatOwnerLeft": { "description": "The owner of the chat has left", "args": { "new_owner_user_id": { "description": "Identifier of the user who will become the new owner of the chat if the previous owner isn't return; 0 if none", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChatRemovedFromCommunity": { "description": "The chat was removed from a community", "args": {}, "type": "MessageContent" }, "messageChatSetBackground": { "description": "A new background was set in the chat", "args": { "background": { "description": "The new background", "is_optional": false, "type": "chatBackground" }, "old_background_message_id": { "description": "Identifier of the message with a previously set same background; 0 if none. Can be an identifier of a deleted message", "is_optional": false, "type": "int53" }, "only_for_self": { "description": "True, if the background was set only for self", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageChatSetMessageAutoDeleteTime": { "description": "The auto-delete or self-destruct timer for messages in the chat has been changed", "args": { "from_user_id": { "description": "If not 0, a user identifier, which default setting was automatically applied", "is_optional": false, "type": "int53" }, "message_auto_delete_time": { "description": "New value auto-delete or self-destruct time, in seconds; 0 if disabled", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageChatSetTheme": { "description": "A theme in the chat has been changed", "args": { "theme": { "description": "New theme for the chat; may be null if chat theme was reset to the default one", "is_optional": true, "type": "ChatTheme" } }, "type": "MessageContent" }, "messageChatShared": { "description": "The current user shared a chat, which was requested by the bot", "args": { "button_id": { "description": "Identifier of the keyboard button with the request", "is_optional": false, "type": "int32" }, "chat": { "description": "The shared chat", "is_optional": false, "type": "sharedChat" } }, "type": "MessageContent" }, "messageChatUpgradeFrom": { "description": "A supergroup has been created from a basic group", "args": { "basic_group_id": { "description": "The identifier of the original basic group", "is_optional": false, "type": "int53" }, "title": { "description": "Title of the newly created supergroup", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageChatUpgradeTo": { "description": "A basic group was upgraded to a supergroup and was deactivated as the result", "args": { "supergroup_id": { "description": "Identifier of the supergroup to which the basic group was upgraded", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageChecklist": { "description": "A message with a checklist", "args": { "list": { "description": "The checklist description", "is_optional": false, "type": "checklist" } }, "type": "MessageContent" }, "messageChecklistTasksAdded": { "description": "Some tasks were added to a checklist", "args": { "checklist_message_id": { "description": "Identifier of the message with the checklist; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "tasks": { "description": "List of tasks added to the checklist", "is_optional": false, "type": "vector\u003cchecklistTask\u003e" } }, "type": "MessageContent" }, "messageChecklistTasksDone": { "description": "Some tasks from a checklist were marked as done or not done", "args": { "checklist_message_id": { "description": "Identifier of the message with the checklist; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "marked_as_done_task_ids": { "description": "Identifiers of tasks that were marked as done", "is_optional": false, "type": "vector\u003cint32\u003e" }, "marked_as_not_done_task_ids": { "description": "Identifiers of tasks that were marked as not done", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "MessageContent" }, "messageContact": { "description": "A message with a user contact", "args": { "contact": { "description": "The contact description", "is_optional": false, "type": "contact" } }, "type": "MessageContent" }, "messageContactRegistered": { "description": "A contact has registered with Telegram", "args": {}, "type": "MessageContent" }, "messageCopyOptions": { "description": "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", "args": { "new_caption": { "description": "New message caption; pass null to copy message without caption. Ignored if replace_caption is false", "is_optional": true, "type": "formattedText" }, "new_show_caption_above_media": { "description": "True, if new caption must be shown above the media; otherwise, new caption must be shown below the media; not supported in secret chats. Ignored if replace_caption is false", "is_optional": false, "type": "Bool" }, "replace_caption": { "description": "True, if media caption of the message copy needs to be replaced. Ignored if send_copy is false", "is_optional": false, "type": "Bool" }, "send_copy": { "description": "True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local.", "is_optional": false, "type": "Bool" } }, "type": "MessageCopyOptions" }, "messageCustomServiceAction": { "description": "A non-standard action has happened in the chat", "args": { "text": { "description": "Message text to be shown in the chat", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageDice": { "description": "A dice message. The dice value is randomly generated by the server", "args": { "emoji": { "description": "Emoji on which the dice throw animation is based", "is_optional": false, "type": "string" }, "final_state": { "description": "The animated stickers with the final dice animation; may be null if unknown. The update updateMessageContent will be sent when the sticker became known", "is_optional": true, "type": "DiceStickers" }, "initial_state": { "description": "The animated stickers with the initial dice animation; may be null if unknown. The update updateMessageContent will be sent when the sticker became known", "is_optional": true, "type": "DiceStickers" }, "success_animation_frame_number": { "description": "Number of frame after which a success animation like a shower of confetti needs to be shown on updateMessageSendSucceeded", "is_optional": false, "type": "int32" }, "value": { "description": "The dice value. If the value is 0, then the dice don't have final state yet", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageDirectMessagePriceChanged": { "description": "A price for direct messages was changed in the channel chat", "args": { "is_enabled": { "description": "True, if direct messages group was enabled for the channel; false otherwise", "is_optional": false, "type": "Bool" }, "paid_message_star_count": { "description": "The new number of Telegram Stars that must be paid by non-administrator users of the channel chat for each message sent to the direct messages group;", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageDocument": { "description": "A document message (general file)", "args": { "caption": { "description": "Document caption", "is_optional": false, "type": "formattedText" }, "document": { "description": "The document description", "is_optional": false, "type": "document" } }, "type": "MessageContent" }, "messageEffect": { "description": "Contains information about an effect added to a message", "args": { "emoji": { "description": "Emoji corresponding to the effect that can be used if static icon isn't available", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the effect", "is_optional": false, "type": "int64" }, "is_premium": { "description": "True, if Telegram Premium subscription is required to use the effect", "is_optional": false, "type": "Bool" }, "static_icon": { "description": "Static icon for the effect in WEBP format; may be null if none", "is_optional": true, "type": "sticker" }, "type": { "description": "Type of the effect", "is_optional": false, "type": "MessageEffectType" } }, "type": "MessageEffect" }, "messageEffectTypeEmojiReaction": { "description": "An effect from an emoji reaction", "args": { "effect_animation": { "description": "Effect animation for the effect in TGS format", "is_optional": false, "type": "sticker" }, "select_animation": { "description": "Select animation for the effect in TGS format", "is_optional": false, "type": "sticker" } }, "type": "MessageEffectType" }, "messageEffectTypePremiumSticker": { "description": "An effect from a premium sticker", "args": { "sticker": { "description": "The premium sticker. The effect can be found at sticker.full_type.premium_animation", "is_optional": false, "type": "sticker" } }, "type": "MessageEffectType" }, "messageExpiredPhoto": { "description": "A self-destructed photo message", "args": {}, "type": "MessageContent" }, "messageExpiredVideo": { "description": "A self-destructed video message", "args": {}, "type": "MessageContent" }, "messageExpiredVideoNote": { "description": "A self-destructed video note message", "args": {}, "type": "MessageContent" }, "messageExpiredVoiceNote": { "description": "A self-destructed voice note message", "args": {}, "type": "MessageContent" }, "messageFileTypeGroup": { "description": "The messages were exported from a group chat", "args": { "title": { "description": "Title of the group chat; may be empty if unrecognized", "is_optional": true, "type": "string" } }, "type": "MessageFileType" }, "messageFileTypePrivate": { "description": "The messages were exported from a private chat", "args": { "name": { "description": "Name of the other party; may be empty if unrecognized", "is_optional": true, "type": "string" } }, "type": "MessageFileType" }, "messageFileTypeUnknown": { "description": "The messages were exported from a chat of unknown type", "args": {}, "type": "MessageFileType" }, "messageForumTopicCreated": { "description": "A forum topic has been created", "args": { "icon": { "description": "Icon of the topic", "is_optional": false, "type": "forumTopicIcon" }, "is_name_implicit": { "description": "True, if the name of the topic wasn't added explicitly", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the topic", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageForumTopicEdited": { "description": "A forum topic has been edited", "args": { "edit_icon_custom_emoji_id": { "description": "True, if icon's custom_emoji_id is changed", "is_optional": false, "type": "Bool" }, "icon_custom_emoji_id": { "description": "New unique identifier of the custom emoji shown on the topic icon; 0 if none. Must be ignored if edit_icon_custom_emoji_id is false", "is_optional": false, "type": "int64" }, "name": { "description": "If non-empty, the new name of the topic", "is_optional": true, "type": "string" } }, "type": "MessageContent" }, "messageForumTopicIsClosedToggled": { "description": "A forum topic has been closed or opened", "args": { "is_closed": { "description": "True, if the topic was closed; otherwise, the topic was reopened", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageForumTopicIsHiddenToggled": { "description": "A General forum topic has been hidden or unhidden", "args": { "is_hidden": { "description": "True, if the topic was hidden; otherwise, the topic was unhidden", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageForwardInfo": { "description": "Contains information about a forwarded message", "args": { "date": { "description": "Point in time (Unix timestamp) when the message was originally sent", "is_optional": false, "type": "int32" }, "origin": { "description": "Origin of the forwarded message", "is_optional": false, "type": "MessageOrigin" }, "public_service_announcement_type": { "description": "The type of public service announcement for the forwarded message", "is_optional": false, "type": "string" }, "source": { "description": "For messages forwarded to the chat with the current user (Saved Messages), to the Replies bot chat, or to the channel's discussion group, information about the source message from which the message was forwarded last time; may be null for other forwards or if unknown", "is_optional": true, "type": "forwardSource" } }, "type": "MessageForwardInfo" }, "messageGame": { "description": "A message with a game", "args": { "game": { "description": "The game description", "is_optional": false, "type": "game" } }, "type": "MessageContent" }, "messageGameScore": { "description": "A new high score was achieved in a game", "args": { "game_id": { "description": "Identifier of the game; may be different from the games presented in the message with the game", "is_optional": false, "type": "int64" }, "game_message_id": { "description": "Identifier of the message with the game, can be an identifier of a deleted message", "is_optional": false, "type": "int53" }, "score": { "description": "New score", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageGift": { "description": "A regular gift was received or sent by the current user, or the current user was notified about a channel gift", "args": { "can_be_upgraded": { "description": "True, if the gift can be upgraded to a unique gift; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "is_from_auction": { "description": "True, if the message is a notification about a gift won on an auction", "is_optional": false, "type": "Bool" }, "is_prepaid_upgrade": { "description": "True, if the message is about prepaid upgrade of the gift by another user", "is_optional": false, "type": "Bool" }, "is_private": { "description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "is_saved": { "description": "True, if the gift is displayed on the user's or the channel's profile page; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "is_upgrade_separate": { "description": "True, if the upgrade was bought after the gift was sent. In this case, prepaid upgrade cost must not be added to the gift cost", "is_optional": false, "type": "Bool" }, "prepaid_upgrade_hash": { "description": "If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade", "is_optional": true, "type": "string" }, "prepaid_upgrade_star_count": { "description": "Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift", "is_optional": false, "type": "int53" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user; only for the receiver of the gift", "is_optional": false, "type": "string" }, "receiver_id": { "description": "Receiver of the gift", "is_optional": false, "type": "MessageSender" }, "sell_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver instead of the regular gift; 0 if the gift can't be sold by the receiver", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Sender of the gift; may be null for outgoing messages about prepaid upgrade of gifts from unknown users", "is_optional": true, "type": "MessageSender" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" }, "unique_gift_number": { "description": "Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned", "is_optional": false, "type": "int32" }, "upgraded_received_gift_id": { "description": "Identifier of the corresponding upgraded gift; may be empty if unknown. Use getReceivedGift to get information about the gift", "is_optional": true, "type": "string" }, "was_converted": { "description": "True, if the gift was converted to Telegram Stars; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "was_refunded": { "description": "True, if the gift was refunded and isn't available anymore", "is_optional": false, "type": "Bool" }, "was_upgraded": { "description": "True, if the gift was upgraded to a unique gift", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageGiftedGrams": { "description": "TON Grams were gifted to a user", "args": { "gifter_user_id": { "description": "The identifier of a user who gifted Grams; 0 if the gift was anonymous or is outgoing", "is_optional": false, "type": "int53" }, "gram_amount": { "description": "The received Gram amount, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "receiver_user_id": { "description": "The identifier of a user who received Grams; 0 if the gift is incoming", "is_optional": false, "type": "int53" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "transaction_id": { "description": "Identifier of the transaction for Gram credit; for receiver only", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageGiftedPremium": { "description": "Telegram Premium was gifted to a user", "args": { "amount": { "description": "The paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "cryptocurrency": { "description": "Cryptocurrency used to pay for the gift; may be empty if none", "is_optional": true, "type": "string" }, "cryptocurrency_amount": { "description": "The paid amount, in the smallest units of the cryptocurrency; 0 if none", "is_optional": false, "type": "int64" }, "currency": { "description": "Currency for the paid amount", "is_optional": false, "type": "string" }, "day_count": { "description": "Number of days the Telegram Premium subscription will be active", "is_optional": false, "type": "int32" }, "gifter_user_id": { "description": "The identifier of a user who gifted Telegram Premium; 0 if the gift was anonymous or is outgoing", "is_optional": false, "type": "int53" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active after code activation; 0 if the number of months isn't integer", "is_optional": false, "type": "int32" }, "receiver_user_id": { "description": "The identifier of a user who received Telegram Premium; 0 if the gift is incoming", "is_optional": false, "type": "int53" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "text": { "description": "Message added to the gifted Telegram Premium by the sender", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messageGiftedStars": { "description": "Telegram Stars were gifted to a user", "args": { "amount": { "description": "The paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "cryptocurrency": { "description": "Cryptocurrency used to pay for the gift; may be empty if none", "is_optional": true, "type": "string" }, "cryptocurrency_amount": { "description": "The paid amount, in the smallest units of the cryptocurrency; 0 if none", "is_optional": false, "type": "int64" }, "currency": { "description": "Currency for the paid amount", "is_optional": false, "type": "string" }, "gifter_user_id": { "description": "The identifier of a user who gifted Telegram Stars; 0 if the gift was anonymous or is outgoing", "is_optional": false, "type": "int53" }, "receiver_user_id": { "description": "The identifier of a user who received Telegram Stars; 0 if the gift is incoming", "is_optional": false, "type": "int53" }, "star_count": { "description": "Number of Telegram Stars that were gifted", "is_optional": false, "type": "int53" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "transaction_id": { "description": "Identifier of the transaction for Telegram Stars purchase; for receiver only", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageGiveaway": { "description": "A giveaway", "args": { "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" }, "prize": { "description": "Prize of the giveaway", "is_optional": false, "type": "GiveawayPrize" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "winner_count": { "description": "Number of users who will receive Telegram Premium subscription gift codes", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageGiveawayCompleted": { "description": "A giveaway without public winners has been completed for the chat", "args": { "giveaway_message_id": { "description": "Identifier of the message with the giveaway; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "is_star_giveaway": { "description": "True, if the giveaway is a Telegram Star giveaway", "is_optional": false, "type": "Bool" }, "unclaimed_prize_count": { "description": "Number of undistributed prizes; for Telegram Premium giveaways only", "is_optional": false, "type": "int32" }, "winner_count": { "description": "Number of winners in the giveaway", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageGiveawayCreated": { "description": "A giveaway was created for the chat. Use telegramPaymentPurposePremiumGiveaway, storePaymentPurposePremiumGiveaway, telegramPaymentPurposeStarGiveaway, or storePaymentPurposeStarGiveaway to create a giveaway", "args": { "star_count": { "description": "Number of Telegram Stars that will be shared by winners of the giveaway; 0 for Telegram Premium giveaways", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageGiveawayPrizeStars": { "description": "Telegram Stars were received by the current user from a giveaway", "args": { "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which was automatically boosted by the winners of the giveaway", "is_optional": false, "type": "int53" }, "giveaway_message_id": { "description": "Identifier of the message with the giveaway in the boosted chat; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "is_unclaimed": { "description": "True, if the corresponding winner wasn't chosen and the Telegram Stars were received by the owner of the boosted chat", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars that were received", "is_optional": false, "type": "int53" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "transaction_id": { "description": "Identifier of the transaction for Telegram Stars credit", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageGiveawayWinners": { "description": "A giveaway with public winners has been completed for the chat", "args": { "actual_winners_selection_date": { "description": "Point in time (Unix timestamp) when the winners were selected. May be bigger than winners selection date specified in parameters of the giveaway", "is_optional": false, "type": "int32" }, "additional_chat_count": { "description": "Number of other chats that participated in the giveaway", "is_optional": false, "type": "int32" }, "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which was automatically boosted by the winners of the giveaway", "is_optional": false, "type": "int53" }, "giveaway_message_id": { "description": "Identifier of the message with the giveaway in the boosted chat", "is_optional": false, "type": "int53" }, "only_new_members": { "description": "True, if only new members of the chats were eligible for the giveaway", "is_optional": false, "type": "Bool" }, "prize": { "description": "Prize of the giveaway", "is_optional": false, "type": "GiveawayPrize" }, "prize_description": { "description": "Additional description of the giveaway prize", "is_optional": false, "type": "string" }, "unclaimed_prize_count": { "description": "Number of undistributed prizes; for Telegram Premium giveaways only", "is_optional": false, "type": "int32" }, "was_refunded": { "description": "True, if the giveaway was canceled and was fully refunded", "is_optional": false, "type": "Bool" }, "winner_count": { "description": "Total number of winners in the giveaway", "is_optional": false, "type": "int32" }, "winner_user_ids": { "description": "Up to 100 user identifiers of the winners of the giveaway", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "MessageContent" }, "messageGroupCall": { "description": "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,", "args": { "duration": { "description": "Call duration, in seconds; for left calls only", "is_optional": false, "type": "int32" }, "is_active": { "description": "True, if the call is active, i.e. the called user joined the call", "is_optional": false, "type": "Bool" }, "is_video": { "description": "True, if the call is a video call", "is_optional": false, "type": "Bool" }, "other_participant_ids": { "description": "Identifiers of some other call participants", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "unique_id": { "description": "Persistent unique group call identifier", "is_optional": false, "type": "int64" }, "was_missed": { "description": "True, if the called user missed or declined the call", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageImportInfo": { "description": "Contains information about a message created with importMessages", "args": { "date": { "description": "Point in time (Unix timestamp) when the message was originally sent", "is_optional": false, "type": "int32" }, "sender_name": { "description": "Name of the original sender", "is_optional": false, "type": "string" } }, "type": "MessageImportInfo" }, "messageInteractionInfo": { "description": "Contains information about interactions with a message", "args": { "forward_count": { "description": "Number of times the message was forwarded", "is_optional": false, "type": "int32" }, "reactions": { "description": "The list of reactions or tags added to the message; may be null", "is_optional": true, "type": "messageReactions" }, "reply_info": { "description": "Information about direct or indirect replies to the message; may be null. Currently, available only in channels with a discussion supergroup and discussion supergroups for messages, which are not replies itself", "is_optional": true, "type": "messageReplyInfo" }, "view_count": { "description": "Number of times the message was viewed", "is_optional": false, "type": "int32" } }, "type": "MessageInteractionInfo" }, "messageInviteVideoChatParticipants": { "description": "A message with information about an invitation to a video chat", "args": { "group_call_id": { "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" }, "user_ids": { "description": "Invited user identifiers", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "MessageContent" }, "messageInvoice": { "description": "A message with an invoice from a bot. Use getInternalLink with internalLinkTypeBotStart to share the invoice", "args": { "currency": { "description": "Currency for the product price", "is_optional": false, "type": "string" }, "is_test": { "description": "True, if the invoice is a test invoice", "is_optional": false, "type": "Bool" }, "need_shipping_address": { "description": "True, if the shipping address must be specified", "is_optional": false, "type": "Bool" }, "paid_media": { "description": "Extended media attached to the invoice; may be null if none", "is_optional": true, "type": "PaidMedia" }, "paid_media_caption": { "description": "Extended media caption; may be null if none", "is_optional": true, "type": "formattedText" }, "product_info": { "description": "Information about the product", "is_optional": false, "type": "productInfo" }, "receipt_message_id": { "description": "The identifier of the message with the receipt, after the product has been purchased", "is_optional": false, "type": "int53" }, "start_parameter": { "description": "Unique invoice bot start_parameter to be passed to getInternalLink", "is_optional": false, "type": "string" }, "total_amount": { "description": "Product total price in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageLink": { "description": "Contains an HTTPS link to a message in a supergroup or channel, or a forum topic", "args": { "is_public": { "description": "True, if the link will work for non-members of the chat", "is_optional": false, "type": "Bool" }, "link": { "description": "The link", "is_optional": false, "type": "string" } }, "type": "MessageLink" }, "messageLinkInfo": { "description": "Contains information about a link to a message or a forum topic in a chat", "args": { "chat_id": { "description": "If found, identifier of the chat to which the link points, 0 otherwise", "is_optional": false, "type": "int53" }, "checklist_task_id": { "description": "Identifier of the checklist task that is linked; 0 if none", "is_optional": false, "type": "int32" }, "for_album": { "description": "True, if the whole media album to which the message belongs is linked", "is_optional": false, "type": "Bool" }, "is_public": { "description": "True, if the link is a public link for a message or a forum topic in a chat", "is_optional": false, "type": "Bool" }, "media_timestamp": { "description": "Timestamp from which the video/audio/video note/voice note/story playing must start, in seconds; 0 if not specified. The media can be in the message content or in its link preview", "is_optional": false, "type": "int32" }, "message": { "description": "If found, the linked message; may be null", "is_optional": true, "type": "message" }, "poll_option_id": { "description": "Identifier of the poll option that is linked; empty if none", "is_optional": false, "type": "string" }, "topic_id": { "description": "Identifier of the specific topic in which the message must be opened, or a topic to open if the message is missing; may be null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "MessageLinkInfo" }, "messageLiveLocation": { "description": "A message with a live location", "args": { "expires_in": { "description": "Left time for which the location can be updated, in seconds. If 0, then the location can't be updated anymore. The update updateMessageContent is not sent when this field changes", "is_optional": false, "type": "int32" }, "location": { "description": "The current location", "is_optional": false, "type": "liveLocation" } }, "type": "MessageContent" }, "messageLocation": { "description": "A message with a location", "args": { "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "MessageContent" }, "messageManagedBotCreated": { "description": "A bot managed by another bot was created by the user", "args": { "bot_user_id": { "description": "User identifier of the created bot", "is_optional": false, "type": "int53" }, "manager_bot_user_id": { "description": "Identifier of the bot which will manage the new bot", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageOriginChannel": { "description": "The message was originally a post in a channel", "args": { "author_signature": { "description": "Original post author signature", "is_optional": false, "type": "string" }, "chat_id": { "description": "Identifier of the channel chat to which the message was originally sent", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier of the original message", "is_optional": false, "type": "int53" } }, "type": "MessageOrigin" }, "messageOriginChat": { "description": "The message was originally sent on behalf of a chat", "args": { "author_signature": { "description": "For messages originally sent by an anonymous chat administrator, original message author signature", "is_optional": false, "type": "string" }, "sender_chat_id": { "description": "Identifier of the chat that originally sent the message", "is_optional": false, "type": "int53" } }, "type": "MessageOrigin" }, "messageOriginHiddenUser": { "description": "The message was originally sent by a user who is hidden by their privacy settings", "args": { "sender_name": { "description": "Name of the sender", "is_optional": false, "type": "string" } }, "type": "MessageOrigin" }, "messageOriginUser": { "description": "The message was originally sent by a known user", "args": { "sender_user_id": { "description": "Identifier of the user who originally sent the message", "is_optional": false, "type": "int53" } }, "type": "MessageOrigin" }, "messagePaidMedia": { "description": "A message with paid media", "args": { "caption": { "description": "Media caption", "is_optional": false, "type": "formattedText" }, "media": { "description": "Information about the media", "is_optional": false, "type": "vector\u003cPaidMedia\u003e" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the media; otherwise, the caption must be shown below the media", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars needed to buy access to the media in the message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePaidMessagePriceChanged": { "description": "A price for paid messages was changed in the supergroup chat", "args": { "paid_message_star_count": { "description": "The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePaidMessagesRefunded": { "description": "Paid messages were refunded", "args": { "message_count": { "description": "The number of refunded messages", "is_optional": false, "type": "int32" }, "star_count": { "description": "The number of refunded Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePassportDataReceived": { "description": "Telegram Passport data has been received; for bots only", "args": { "credentials": { "description": "Encrypted data credentials", "is_optional": false, "type": "encryptedCredentials" }, "elements": { "description": "List of received Telegram Passport elements", "is_optional": false, "type": "vector\u003cencryptedPassportElement\u003e" } }, "type": "MessageContent" }, "messagePassportDataSent": { "description": "Telegram Passport data has been sent to a bot", "args": { "types": { "description": "List of Telegram Passport element types sent", "is_optional": false, "type": "vector\u003cPassportElementType\u003e" } }, "type": "MessageContent" }, "messagePaymentRefunded": { "description": "A payment has been refunded", "args": { "currency": { "description": "Currency for the price of the product", "is_optional": false, "type": "string" }, "invoice_payload": { "description": "Invoice payload; only for bots", "is_optional": false, "type": "bytes" }, "owner_id": { "description": "Identifier of the previous owner of the Telegram Stars that refunds them", "is_optional": false, "type": "MessageSender" }, "provider_payment_charge_id": { "description": "Provider payment identifier", "is_optional": false, "type": "string" }, "telegram_payment_charge_id": { "description": "Telegram payment identifier", "is_optional": false, "type": "string" }, "total_amount": { "description": "Total price for the product, in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePaymentSuccessful": { "description": "A payment has been sent to a bot or a business account", "args": { "currency": { "description": "Currency for the price of the product", "is_optional": false, "type": "string" }, "invoice_chat_id": { "description": "Identifier of the chat, containing the corresponding invoice message", "is_optional": false, "type": "int53" }, "invoice_message_id": { "description": "Identifier of the message with the corresponding invoice; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "invoice_name": { "description": "Name of the invoice; may be empty if unknown", "is_optional": true, "type": "string" }, "is_first_recurring": { "description": "True, if this is the first recurring payment", "is_optional": false, "type": "Bool" }, "is_recurring": { "description": "True, if this is a recurring payment", "is_optional": false, "type": "Bool" }, "subscription_until_date": { "description": "Point in time (Unix timestamp) when the subscription will expire; 0 if unknown or the payment isn't recurring", "is_optional": false, "type": "int32" }, "total_amount": { "description": "Total price for the product, in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePaymentSuccessfulBot": { "description": "A payment has been received by the bot or the business account", "args": { "currency": { "description": "Currency for price of the product", "is_optional": false, "type": "string" }, "invoice_payload": { "description": "Invoice payload", "is_optional": false, "type": "bytes" }, "is_first_recurring": { "description": "True, if this is the first recurring payment", "is_optional": false, "type": "Bool" }, "is_recurring": { "description": "True, if this is a recurring payment", "is_optional": false, "type": "Bool" }, "order_info": { "description": "Information about the order; may be null; for bots only", "is_optional": true, "type": "orderInfo" }, "provider_payment_charge_id": { "description": "Provider payment identifier", "is_optional": false, "type": "string" }, "shipping_option_id": { "description": "Identifier of the shipping option chosen by the user; may be empty if not applicable; for bots only", "is_optional": true, "type": "string" }, "subscription_until_date": { "description": "Point in time (Unix timestamp) when the subscription will expire; 0 if unknown or the payment isn't recurring", "is_optional": false, "type": "int32" }, "telegram_payment_charge_id": { "description": "Telegram payment identifier", "is_optional": false, "type": "string" }, "total_amount": { "description": "Total price for the product, in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePhoto": { "description": "A photo message", "args": { "caption": { "description": "Photo caption", "is_optional": false, "type": "formattedText" }, "has_spoiler": { "description": "True, if the photo preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "is_secret": { "description": "True, if the photo must be blurred and must be shown only while tapped", "is_optional": false, "type": "Bool" }, "photo": { "description": "The photo", "is_optional": false, "type": "photo" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the photo; otherwise, the caption must be shown below the photo", "is_optional": false, "type": "Bool" }, "video": { "description": "The video representing the live photo; may be null if the photo is static", "is_optional": true, "type": "video" } }, "type": "MessageContent" }, "messagePinMessage": { "description": "A message has been pinned", "args": { "message_id": { "description": "Identifier of the pinned message, can be an identifier of a deleted message or 0", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messagePoll": { "description": "A message with a poll", "args": { "can_add_option": { "description": "True, if an option can be added to the poll using addPollOption", "is_optional": false, "type": "Bool" }, "description": { "description": "Description of the poll", "is_optional": false, "type": "formattedText" }, "media": { "description": "Media attached to the poll; may be null if none. If present, currently, can be only of the types pollMediaAnimation, pollMediaAudio, pollMediaDocument, pollMediaLocation, pollMediaPhoto, pollMediaVenue, or pollMediaVideo", "is_optional": true, "type": "PollMedia" }, "poll": { "description": "Information about the poll", "is_optional": false, "type": "poll" } }, "type": "MessageContent" }, "messagePollOptionAdded": { "description": "A message with information about an added poll option", "args": { "option_id": { "description": "Identifier of the added option in the poll", "is_optional": false, "type": "string" }, "poll_message_id": { "description": "Identifier of the message with the poll; can be an identifier of a deleted message or 0", "is_optional": false, "type": "int53" }, "text": { "description": "Text of the option; 1-100 characters; may contain only custom emoji entities", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messagePollOptionDeleted": { "description": "A message with information about a deleted poll option", "args": { "option_id": { "description": "Identifier of the deleted option in the poll", "is_optional": false, "type": "string" }, "poll_message_id": { "description": "Identifier of the message with the poll; can be an identifier of a deleted message or 0", "is_optional": false, "type": "int53" }, "text": { "description": "Text of the option; 1-100 characters; may contain only custom emoji entities", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messagePosition": { "description": "Contains information about a message in a specific position", "args": { "date": { "description": "Point in time (Unix timestamp) when the message was sent", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "position": { "description": "0-based message position in the full list of suitable messages", "is_optional": false, "type": "int32" } }, "type": "MessagePosition" }, "messagePositions": { "description": "Contains a list of message positions", "args": { "positions": { "description": "List of message positions", "is_optional": false, "type": "vector\u003cmessagePosition\u003e" }, "total_count": { "description": "Total number of messages found", "is_optional": false, "type": "int32" } }, "type": "MessagePositions" }, "messagePremiumGiftCode": { "description": "A Telegram Premium gift code was created for the user", "args": { "amount": { "description": "The paid amount, in the smallest units of the currency; 0 if unknown", "is_optional": false, "type": "int53" }, "code": { "description": "The gift code", "is_optional": false, "type": "string" }, "creator_id": { "description": "Identifier of a chat or a user who created the gift code; may be null if unknown", "is_optional": true, "type": "MessageSender" }, "cryptocurrency": { "description": "Cryptocurrency used to pay for the gift; may be empty if none or unknown", "is_optional": true, "type": "string" }, "cryptocurrency_amount": { "description": "The paid amount, in the smallest units of the cryptocurrency; 0 if unknown", "is_optional": false, "type": "int64" }, "currency": { "description": "Currency for the paid amount; empty if unknown", "is_optional": false, "type": "string" }, "day_count": { "description": "Number of days the Telegram Premium subscription will be active after code activation", "is_optional": false, "type": "int32" }, "is_from_giveaway": { "description": "True, if the gift code was created for a giveaway", "is_optional": false, "type": "Bool" }, "is_unclaimed": { "description": "True, if the winner for the corresponding Telegram Premium subscription wasn't chosen", "is_optional": false, "type": "Bool" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active after code activation; 0 if the number of months isn't integer", "is_optional": false, "type": "int32" }, "sticker": { "description": "A sticker to be shown in the message; may be null if unknown", "is_optional": true, "type": "sticker" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messageProperties": { "description": "Contains properties of a message and describes actions that can be done with the message right now", "args": { "can_add_offer": { "description": "True, if an offer can be added to the message using addOffer", "is_optional": false, "type": "Bool" }, "can_add_tasks": { "description": "True, if tasks can be added to the message's checklist using addChecklistTasks if the current user has Telegram Premium subscription", "is_optional": false, "type": "Bool" }, "can_be_approved": { "description": "True, if the message is a suggested post that can be approved by the user using approveSuggestedPost", "is_optional": false, "type": "Bool" }, "can_be_copied": { "description": "True, if content of the message can be copied using inputMessageForwarded or forwardMessages with copy options", "is_optional": false, "type": "Bool" }, "can_be_copied_to_secret_chat": { "description": "True, if content of the message can be copied to a secret chat using inputMessageForwarded or forwardMessages with copy options", "is_optional": false, "type": "Bool" }, "can_be_declined": { "description": "True, if the message is a suggested post that can be declined by the user using declineSuggestedPost", "is_optional": false, "type": "Bool" }, "can_be_deleted_for_all_users": { "description": "True, if the message can be deleted for all users using the method deleteMessages with revoke == true", "is_optional": false, "type": "Bool" }, "can_be_deleted_only_for_self": { "description": "True, if the message can be deleted only for the current user while other users will continue to see it using the method deleteMessages with revoke == false", "is_optional": false, "type": "Bool" }, "can_be_edited": { "description": "True, if the message can be edited using the methods editMessageText, editMessageCaption, or editMessageReplyMarkup.", "is_optional": false, "type": "Bool" }, "can_be_forwarded": { "description": "True, if the message can be forwarded using inputMessageForwarded or forwardMessages without copy options", "is_optional": false, "type": "Bool" }, "can_be_paid": { "description": "True, if the message can be paid using inputInvoiceMessage", "is_optional": false, "type": "Bool" }, "can_be_pinned": { "description": "True, if the message can be pinned or unpinned in the chat using pinChatMessage or unpinChatMessage", "is_optional": false, "type": "Bool" }, "can_be_replied": { "description": "True, if the message can be replied in the same chat and forum topic using inputMessageReplyToMessage. Ephemeral messages can be replied only by other ephemeral messages", "is_optional": false, "type": "Bool" }, "can_be_replied_in_another_chat": { "description": "True, if the message can be replied in another chat or forum topic using inputMessageReplyToExternalMessage", "is_optional": false, "type": "Bool" }, "can_be_saved": { "description": "True, if content of the message can be saved locally", "is_optional": false, "type": "Bool" }, "can_be_shared_in_story": { "description": "True, if the message can be shared in a story using inputStoryAreaTypeMessage", "is_optional": false, "type": "Bool" }, "can_delete_reactions": { "description": "True, if the user can delete reactions of other users in the message using the method deleteMessageReactionsFromSender", "is_optional": false, "type": "Bool" }, "can_edit_media": { "description": "True, if the message can be edited using the method editMessageMedia", "is_optional": false, "type": "Bool" }, "can_edit_scheduling_state": { "description": "True, if scheduling state of the message can be edited", "is_optional": false, "type": "Bool" }, "can_edit_suggested_post_info": { "description": "True, if another price or post send time can be suggested using addOffer", "is_optional": false, "type": "Bool" }, "can_get_author": { "description": "True, if author of the message sent on behalf of a chat can be received through getMessageAuthor", "is_optional": false, "type": "Bool" }, "can_get_embedding_code": { "description": "True, if code for message embedding can be received using getMessageEmbeddingCode", "is_optional": false, "type": "Bool" }, "can_get_link": { "description": "True, if a link can be generated for the message using getMessageLink", "is_optional": false, "type": "Bool" }, "can_get_media_timestamp_links": { "description": "True, if media timestamp links can be generated for media timestamp entities in the message text, caption or link preview description using getMessageLink", "is_optional": false, "type": "Bool" }, "can_get_message_thread": { "description": "True, if information about the message thread is available through getMessageThread and getMessageThreadHistory", "is_optional": false, "type": "Bool" }, "can_get_poll_vote_statistics": { "description": "True, if the message is a poll and vote statistics are available through getPollVoteStatistics", "is_optional": false, "type": "Bool" }, "can_get_read_date": { "description": "True, if read date of the message can be received through getMessageReadDate", "is_optional": false, "type": "Bool" }, "can_get_statistics": { "description": "True, if message statistics are available through getMessageStatistics and message forwards can be received using getMessagePublicForwards", "is_optional": false, "type": "Bool" }, "can_get_video_advertisements": { "description": "True, if advertisements for video of the message can be received through getVideoMessageAdvertisements", "is_optional": false, "type": "Bool" }, "can_get_viewers": { "description": "True, if chat members already viewed the message can be received through getMessageViewers", "is_optional": false, "type": "Bool" }, "can_mark_tasks_as_done": { "description": "True, if tasks can be marked as done or not done in the message's checklist using markChecklistTasksAsDone if the current user has Telegram Premium subscription", "is_optional": false, "type": "Bool" }, "can_recognize_speech": { "description": "True, if speech can be recognized for the message through recognizeSpeech", "is_optional": false, "type": "Bool" }, "can_report_chat": { "description": "True, if the message can be reported using reportChat", "is_optional": false, "type": "Bool" }, "can_report_reactions": { "description": "True, if reactions on the message can be reported through reportMessageReactions", "is_optional": false, "type": "Bool" }, "can_report_supergroup_spam": { "description": "True, if the message can be reported using reportSupergroupSpam", "is_optional": false, "type": "Bool" }, "can_set_fact_check": { "description": "True, if fact check for the message can be changed through setMessageFactCheck", "is_optional": false, "type": "Bool" }, "custom_emoji_ids": { "description": "Identifiers of custom emoji used in the message", "is_optional": false, "type": "vector\u003cint64\u003e" }, "has_protected_content_by_current_user": { "description": "True, if content of the message can't be saved locally, because it is protected by the current user; if true, then can_be_saved is false", "is_optional": false, "type": "Bool" }, "has_protected_content_by_other_user": { "description": "True, if content of the message can't be saved locally, because it is protected by the other user; if true, then can_be_saved is false", "is_optional": false, "type": "Bool" }, "need_show_statistics": { "description": "True, if message statistics must be available from context menu of the message", "is_optional": false, "type": "Bool" } }, "type": "MessageProperties" }, "messageProximityAlertTriggered": { "description": "A user in the chat came within proximity alert range", "args": { "distance": { "description": "The distance between the users", "is_optional": false, "type": "int32" }, "traveler_id": { "description": "The identifier of a user or chat that triggered the proximity alert", "is_optional": false, "type": "MessageSender" }, "watcher_id": { "description": "The identifier of a user or chat that subscribed for the proximity alert", "is_optional": false, "type": "MessageSender" } }, "type": "MessageContent" }, "messageReaction": { "description": "Contains information about a reaction to a message", "args": { "is_chosen": { "description": "True, if the reaction is chosen by the current user", "is_optional": false, "type": "Bool" }, "recent_sender_ids": { "description": "Identifiers of at most 3 recent message senders, added the reaction; available in private, basic group and supergroup chats", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "total_count": { "description": "Number of times the reaction was added", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" }, "used_sender_id": { "description": "Identifier of the message sender used by the current user to add the reaction; may be null if unknown or the reaction isn't chosen", "is_optional": true, "type": "MessageSender" } }, "type": "MessageReaction" }, "messageReactions": { "description": "Contains a list of reactions added to a message", "args": { "are_tags": { "description": "True, if the reactions are tags and Telegram Premium users can filter messages by them", "is_optional": false, "type": "Bool" }, "can_get_added_reactions": { "description": "True, if the list of added reactions is available using getMessageAddedReactions", "is_optional": false, "type": "Bool" }, "paid_reactors": { "description": "Information about top users that added the paid reaction", "is_optional": false, "type": "vector\u003cpaidReactor\u003e" }, "reactions": { "description": "List of added reactions", "is_optional": false, "type": "vector\u003cmessageReaction\u003e" } }, "type": "MessageReactions" }, "messageReadDateMyPrivacyRestricted": { "description": "The read date is unknown due to privacy settings of the current user, but will be known if the user subscribes to Telegram Premium", "args": {}, "type": "MessageReadDate" }, "messageReadDateRead": { "description": "Contains read date of the message", "args": { "read_date": { "description": "Point in time (Unix timestamp) when the message was read by the other user", "is_optional": false, "type": "int32" } }, "type": "MessageReadDate" }, "messageReadDateTooOld": { "description": "The message is too old to get read date", "args": {}, "type": "MessageReadDate" }, "messageReadDateUnread": { "description": "The message is unread yet", "args": {}, "type": "MessageReadDate" }, "messageReadDateUserPrivacyRestricted": { "description": "The read date is unknown due to privacy settings of the other user", "args": {}, "type": "MessageReadDate" }, "messageRefundedUpgradedGift": { "description": "A gift which purchase, upgrade or transfer were refunded", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "origin": { "description": "Origin of the upgraded gift", "is_optional": false, "type": "UpgradedGiftOrigin" }, "receiver_id": { "description": "Receiver of the gift", "is_optional": false, "type": "MessageSender" }, "sender_id": { "description": "Sender of the gift", "is_optional": false, "type": "MessageSender" } }, "type": "MessageContent" }, "messageReplyInfo": { "description": "Contains information about replies to a message", "args": { "last_message_id": { "description": "Identifier of the last reply to the message", "is_optional": false, "type": "int53" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming reply to the message", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of the last read outgoing reply to the message", "is_optional": false, "type": "int53" }, "recent_replier_ids": { "description": "Identifiers of at most 3 recent repliers to the message; available in channels with a discussion supergroup. The users and chats are expected to be inaccessible: only their photo and name will be available", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "reply_count": { "description": "Number of times the message was directly or indirectly replied", "is_optional": false, "type": "int32" } }, "type": "MessageReplyInfo" }, "messageReplyToMessage": { "description": "Describes a message replied by a given message", "args": { "chat_id": { "description": "The identifier of the chat to which the message belongs; may be 0 if the replied message is in unknown chat", "is_optional": false, "type": "int53" }, "checklist_task_id": { "description": "Identifier of the checklist task in the original message that was replied; 0 if none", "is_optional": false, "type": "int32" }, "content": { "description": "Media content of the message if the message was from another chat or topic; may be null for messages from the same chat and messages without media.", "is_optional": true, "type": "MessageContent" }, "message_id": { "description": "The identifier of the message; may be 0 if the replied message is in unknown chat", "is_optional": false, "type": "int53" }, "origin": { "description": "Information about origin of the message if the message was from another chat or topic; may be null for messages from the same chat", "is_optional": true, "type": "MessageOrigin" }, "origin_send_date": { "description": "Point in time (Unix timestamp) when the message was sent if the message was from another chat or topic; 0 for messages from the same chat", "is_optional": false, "type": "int32" }, "poll_option_id": { "description": "Identifier of the poll option in the original message that was replied; empty if none", "is_optional": false, "type": "string" }, "quote": { "description": "Chosen quote from the replied message; may be null if none", "is_optional": true, "type": "textQuote" } }, "type": "MessageReplyTo" }, "messageReplyToStory": { "description": "Describes a story replied by a given message", "args": { "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story", "is_optional": false, "type": "int53" } }, "type": "MessageReplyTo" }, "messageRichMessage": { "description": "A rich message; the message can have multiple media of the same type, all of which must be shown in the corresponding profile tab", "args": { "message": { "description": "The rich message", "is_optional": false, "type": "richMessage" } }, "type": "MessageContent" }, "messageSchedulingStateSendAtDate": { "description": "The message will be sent at the specified date", "args": { "repeat_period": { "description": "Period after which the message will be sent again; in seconds; 0 if never; for Telegram Premium users only; may be non-zero only in sendMessage and forwardMessages with one message requests;", "is_optional": false, "type": "int32" }, "send_date": { "description": "Point in time (Unix timestamp) when the message will be sent. The date must be within 367 days in the future", "is_optional": false, "type": "int32" } }, "type": "MessageSchedulingState" }, "messageSchedulingStateSendWhenOnline": { "description": "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", "args": {}, "type": "MessageSchedulingState" }, "messageSchedulingStateSendWhenVideoProcessed": { "description": "The message will be sent when the video in the message is converted and optimized; can be used only by the server", "args": { "send_date": { "description": "Approximate point in time (Unix timestamp) when the message is expected to be sent", "is_optional": false, "type": "int32" } }, "type": "MessageSchedulingState" }, "messageScreenshotTaken": { "description": "A screenshot of a message in the chat has been taken", "args": {}, "type": "MessageContent" }, "messageSelfDestructTypeImmediately": { "description": "The message can be opened only once and will be self-destructed once closed", "args": {}, "type": "MessageSelfDestructType" }, "messageSelfDestructTypeTimer": { "description": "The message will be self-destructed in the specified time after its content was opened", "args": { "self_destruct_time": { "description": "The message's self-destruct time, in seconds; must be between 0 and 60 in private chats", "is_optional": false, "type": "int32" } }, "type": "MessageSelfDestructType" }, "messageSendOptions": { "description": "Options to be used when a message is sent", "args": { "allow_paid_broadcast": { "description": "Pass true to allow the message to ignore regular broadcast limits for a small fee; for bots only", "is_optional": false, "type": "Bool" }, "disable_notification": { "description": "Pass true to disable notification for the message", "is_optional": false, "type": "Bool" }, "effect_id": { "description": "Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage, sendMessageAlbum in private chats and forwardMessages with one message to private chats", "is_optional": false, "type": "int64" }, "from_background": { "description": "Pass true if the message is sent from the background", "is_optional": false, "type": "Bool" }, "only_preview": { "description": "Pass true to get a fake message instead of actually sending them", "is_optional": false, "type": "Bool" }, "paid_message_star_count": { "description": "The number of Telegram Stars the user agreed to pay to send the messages", "is_optional": false, "type": "int53" }, "protect_content": { "description": "Pass true if the content of the message must be protected from forwarding and saving; for bots only", "is_optional": false, "type": "Bool" }, "scheduling_state": { "description": "Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, to a chat with paid messages, to a channel direct messages chat,", "is_optional": true, "type": "MessageSchedulingState" }, "sending_id": { "description": "Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates", "is_optional": false, "type": "int32" }, "suggested_post_info": { "description": "Information about the suggested post; pass null if none. For messages to channel direct messages chat only. Applicable only to sendMessage and addOffer", "is_optional": true, "type": "inputSuggestedPostInfo" }, "update_order_of_installed_sticker_sets": { "description": "Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum", "is_optional": false, "type": "Bool" } }, "type": "MessageSendOptions" }, "messageSenderChat": { "description": "The message was sent on behalf of a chat", "args": { "chat_id": { "description": "Identifier of the chat that sent the message", "is_optional": false, "type": "int53" } }, "type": "MessageSender" }, "messageSenderUser": { "description": "The message was sent by a known user", "args": { "user_id": { "description": "Identifier of the user who sent the message", "is_optional": false, "type": "int53" } }, "type": "MessageSender" }, "messageSenders": { "description": "Represents a list of message senders", "args": { "senders": { "description": "List of message senders", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "total_count": { "description": "Approximate total number of message senders found", "is_optional": false, "type": "int32" } }, "type": "MessageSenders" }, "messageSendingStateFailed": { "description": "The message failed to be sent", "args": { "can_retry": { "description": "True, if the message can be re-sent using resendMessages or readdQuickReplyShortcutMessages", "is_optional": false, "type": "Bool" }, "error": { "description": "The cause of the message sending failure", "is_optional": false, "type": "error" }, "need_another_reply_quote": { "description": "True, if the message can be re-sent only if another quote is chosen in the message that is replied by the given message", "is_optional": false, "type": "Bool" }, "need_another_sender": { "description": "True, if the message can be re-sent only on behalf of a different sender", "is_optional": false, "type": "Bool" }, "need_drop_reply": { "description": "True, if the message can be re-sent only if the message to be replied is removed. This will be done automatically by resendMessages", "is_optional": false, "type": "Bool" }, "required_paid_message_star_count": { "description": "The number of Telegram Stars that must be paid to send the message; 0 if the current amount is correct", "is_optional": false, "type": "int53" }, "retry_after": { "description": "Time left before the message can be re-sent, in seconds. No update is sent when this field changes", "is_optional": false, "type": "double" } }, "type": "MessageSendingState" }, "messageSendingStatePending": { "description": "The message is being sent now, but has not yet been delivered to the server", "args": { "sending_id": { "description": "Non-persistent message sending identifier, specified by the application", "is_optional": false, "type": "int32" } }, "type": "MessageSendingState" }, "messageSourceChatEventLog": { "description": "The message is from a chat event log", "args": {}, "type": "MessageSource" }, "messageSourceChatHistory": { "description": "The message is from a chat history", "args": {}, "type": "MessageSource" }, "messageSourceChatList": { "description": "The message is from a chat list or a forum topic list", "args": {}, "type": "MessageSource" }, "messageSourceDirectMessagesChatTopicHistory": { "description": "The message is from history of a topic in a channel direct messages chat administered by the current user", "args": {}, "type": "MessageSource" }, "messageSourceForumTopicHistory": { "description": "The message is from history of a forum topic", "args": {}, "type": "MessageSource" }, "messageSourceHistoryPreview": { "description": "The message is from chat, message thread or forum topic history preview", "args": {}, "type": "MessageSource" }, "messageSourceMessageThreadHistory": { "description": "The message is from history of a message thread", "args": {}, "type": "MessageSource" }, "messageSourceNotification": { "description": "The message is from a notification", "args": {}, "type": "MessageSource" }, "messageSourceOther": { "description": "The message is from some other source", "args": {}, "type": "MessageSource" }, "messageSourceScreenshot": { "description": "The message was screenshotted; the source must be used only if the message content was visible during the screenshot", "args": {}, "type": "MessageSource" }, "messageSourceSearch": { "description": "The message is from search results, including file downloads, local file list, outgoing document messages, calendar", "args": {}, "type": "MessageSource" }, "messageStakeDice": { "description": "A stake dice message. The dice value is randomly generated by the server", "args": { "final_state": { "description": "The animated stickers with the final dice animation; may be null if unknown. The update updateMessageContent will be sent when the sticker became known", "is_optional": true, "type": "DiceStickers" }, "initial_state": { "description": "The animated stickers with the initial dice animation; may be null if unknown. The update updateMessageContent will be sent when the sticker became known", "is_optional": true, "type": "DiceStickers" }, "prize_gram_amount": { "description": "The TON Gram amount that was gained from the roll; in the smallest units of the currency; -1 if the dice don't have final state yet", "is_optional": false, "type": "int53" }, "stake_gram_amount": { "description": "The TON Gram amount that was staked; in the smallest units of the currency", "is_optional": false, "type": "int53" }, "value": { "description": "The dice value. If the value is 0, then the dice don't have final state yet", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageStatistics": { "description": "A detailed statistics about a message", "args": { "message_interaction_graph": { "description": "A graph containing number of message views and shares", "is_optional": false, "type": "StatisticalGraph" }, "message_reaction_graph": { "description": "A graph containing number of message reactions", "is_optional": false, "type": "StatisticalGraph" } }, "type": "MessageStatistics" }, "messageSticker": { "description": "A sticker message", "args": { "is_premium": { "description": "True, if premium animation of the sticker must be played", "is_optional": false, "type": "Bool" }, "sticker": { "description": "The sticker description", "is_optional": false, "type": "sticker" } }, "type": "MessageContent" }, "messageStory": { "description": "A message with a forwarded story", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" }, "via_mention": { "description": "True, if the story was automatically forwarded because of a mention of the user", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageSuggestBirthdate": { "description": "A birthdate was suggested to be set", "args": { "birthdate": { "description": "The suggested birthdate. Use the method setBirthdate to apply the birthdate", "is_optional": false, "type": "birthdate" } }, "type": "MessageContent" }, "messageSuggestProfilePhoto": { "description": "A profile photo was suggested to a user in a private chat", "args": { "photo": { "description": "The suggested chat photo. Use the method setProfilePhoto with inputChatPhotoPrevious to apply the photo", "is_optional": false, "type": "chatPhoto" } }, "type": "MessageContent" }, "messageSuggestedPostApprovalFailed": { "description": "Approval of suggested post has failed, because the user who proposed the post didn't have enough funds", "args": { "price": { "description": "Price of the suggested post", "is_optional": false, "type": "SuggestedPostPrice" }, "suggested_post_message_id": { "description": "Identifier of the message with the suggested post; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageSuggestedPostApproved": { "description": "A suggested post was approved", "args": { "price": { "description": "Price of the suggested post; may be null if the post is non-paid", "is_optional": true, "type": "SuggestedPostPrice" }, "send_date": { "description": "Point in time (Unix timestamp) when the post is expected to be published", "is_optional": false, "type": "int32" }, "suggested_post_message_id": { "description": "Identifier of the message with the suggested post; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageSuggestedPostDeclined": { "description": "A suggested post was declined", "args": { "comment": { "description": "Comment added by administrator of the channel when the post was declined", "is_optional": false, "type": "string" }, "suggested_post_message_id": { "description": "Identifier of the message with the suggested post; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageSuggestedPostPaid": { "description": "A suggested post was published for getOption(\"suggested_post_lifetime_min\") seconds and payment for the post was received", "args": { "gram_amount": { "description": "The amount of received TON Grams; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "star_amount": { "description": "The amount of received Telegram Stars", "is_optional": false, "type": "starAmount" }, "suggested_post_message_id": { "description": "Identifier of the message with the suggested post; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageSuggestedPostRefunded": { "description": "A suggested post was refunded", "args": { "reason": { "description": "Reason of the refund", "is_optional": false, "type": "SuggestedPostRefundReason" }, "suggested_post_message_id": { "description": "Identifier of the message with the suggested post; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "MessageContent" }, "messageSupergroupChatCreate": { "description": "A newly created supergroup or channel", "args": { "title": { "description": "Title of the supergroup or channel", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageText": { "description": "A text message", "args": { "link_preview": { "description": "A link preview attached to the message; may be null", "is_optional": true, "type": "linkPreview" }, "link_preview_options": { "description": "Options which were used for generation of the link preview; may be null if default options were used", "is_optional": true, "type": "linkPreviewOptions" }, "text": { "description": "Text of the message", "is_optional": false, "type": "formattedText" } }, "type": "MessageContent" }, "messageThreadInfo": { "description": "Contains information about a message thread", "args": { "chat_id": { "description": "Identifier of the chat to which the message thread belongs", "is_optional": false, "type": "int53" }, "draft_message": { "description": "A draft of a message in the message thread; may be null if none", "is_optional": true, "type": "draftMessage" }, "message_thread_id": { "description": "Message thread identifier, unique within the chat", "is_optional": false, "type": "int53" }, "messages": { "description": "The messages from which the thread starts. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id)", "is_optional": false, "type": "vector\u003cmessage\u003e" }, "reply_info": { "description": "Information about the message thread; may be null for forum topic threads", "is_optional": true, "type": "messageReplyInfo" }, "unread_message_count": { "description": "Approximate number of unread messages in the message thread", "is_optional": false, "type": "int32" } }, "type": "MessageThreadInfo" }, "messageTonConnectRequest": { "description": "A request from a dApp was received through TON Connect", "args": { "dapp_name": { "description": "Name of the dApp; may be empty if unknown", "is_optional": true, "type": "string" }, "session_id": { "description": "Unique identifier of the TON Connect session", "is_optional": false, "type": "int64" }, "state": { "description": "State of the request", "is_optional": false, "type": "TonConnectRequestState" }, "topic": { "description": "Topic of the request; may be empty if none", "is_optional": true, "type": "string" }, "trace_id": { "description": "Identifier to trace the request; may be empty if none", "is_optional": true, "type": "string" } }, "type": "MessageContent" }, "messageTonWalletTransfer": { "description": "Represents a transfer with the TON wallet of the current user", "args": { "amount": { "description": "The amount of received cryptocurrency, in the smallest units of the cryptocurrency; negative for outgoing transactions", "is_optional": false, "type": "int53" }, "comment": { "description": "Comment added to the transaction", "is_optional": false, "type": "string" }, "is_comment_encrypted": { "description": "True, if the comment is encrypted and must be decrypted using the receiver's or sender's private key", "is_optional": false, "type": "Bool" }, "peer_address": { "description": "Address in the TON blockchain of the transaction peer", "is_optional": false, "type": "string" }, "sender_user_id": { "description": "Sender of the transfer; 0 if unknown", "is_optional": false, "type": "int53" }, "transaction_id": { "description": "Unique identifier of the transaction; may be empty if the transfer isn't send yet. Use getTonWalletTransaction to get additional information about the transaction", "is_optional": true, "type": "string" } }, "type": "MessageContent" }, "messageTopicDirectMessages": { "description": "A topic in a channel direct messages chat administered by the current user", "args": { "direct_messages_chat_topic_id": { "description": "Unique identifier of the topic", "is_optional": false, "type": "int53" } }, "type": "MessageTopic" }, "messageTopicForum": { "description": "A topic in a forum supergroup chat or a chat with a bot", "args": { "forum_topic_id": { "description": "Unique identifier of the forum topic", "is_optional": false, "type": "int32" } }, "type": "MessageTopic" }, "messageTopicSavedMessages": { "description": "A topic in Saved Messages chat", "args": { "saved_messages_topic_id": { "description": "Unique identifier of the Saved Messages topic", "is_optional": false, "type": "int53" } }, "type": "MessageTopic" }, "messageTopicThread": { "description": "A topic in a non-forum supergroup chat", "args": { "message_thread_id": { "description": "Unique identifier of the message thread", "is_optional": false, "type": "int53" } }, "type": "MessageTopic" }, "messageUnsupported": { "description": "A message content that is not supported in the current TDLib version", "args": {}, "type": "MessageContent" }, "messageUpgradedGift": { "description": "An upgraded gift was received or sent by the current user, or the current user was notified about a channel gift", "args": { "can_be_transferred": { "description": "True, if the gift can be transferred to another owner; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "craft_date": { "description": "Point in time (Unix timestamp) when the gift can be used to craft another gift; can be in the past; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "drop_original_details_star_count": { "description": "Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available; only for the receiver of the gift", "is_optional": false, "type": "int53" }, "export_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred to the TON blockchain as an NFT; can be in the past; 0 if NFT export isn't possible; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "is_private": { "description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "is_saved": { "description": "True, if the gift is displayed on the user's or the channel's profile page; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "next_resale_date": { "description": "Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can't be resold; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn't possible; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "origin": { "description": "Origin of the upgraded gift", "is_optional": false, "type": "UpgradedGiftOrigin" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user; only for the receiver of the gift", "is_optional": false, "type": "string" }, "receiver_id": { "description": "Receiver of the gift", "is_optional": false, "type": "MessageSender" }, "sender_id": { "description": "Sender of the gift; may be null for anonymous gifts", "is_optional": true, "type": "MessageSender" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift", "is_optional": false, "type": "int53" }, "was_transferred": { "description": "True, if the gift has already been transferred to another owner; only for the receiver of the gift", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageUpgradedGiftPurchaseOffer": { "description": "An offer to purchase an upgraded gift was sent or received", "args": { "expiration_date": { "description": "Point in time (Unix timestamp) when the offer will expire or has expired", "is_optional": false, "type": "int32" }, "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "price": { "description": "The proposed price", "is_optional": false, "type": "GiftResalePrice" }, "state": { "description": "State of the offer", "is_optional": false, "type": "GiftPurchaseOfferState" } }, "type": "MessageContent" }, "messageUpgradedGiftPurchaseOfferRejected": { "description": "An offer to purchase a gift was rejected or expired", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "offer_message_id": { "description": "Identifier of the message with purchase offer which was rejected or expired; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "price": { "description": "The proposed price", "is_optional": false, "type": "GiftResalePrice" }, "was_expired": { "description": "True, if the offer has expired; otherwise, the offer was explicitly rejected", "is_optional": false, "type": "Bool" } }, "type": "MessageContent" }, "messageUsersShared": { "description": "The current user shared users who were requested by the bot", "args": { "button_id": { "description": "Identifier of the keyboard button with the request", "is_optional": false, "type": "int32" }, "users": { "description": "The shared users", "is_optional": false, "type": "vector\u003csharedUser\u003e" } }, "type": "MessageContent" }, "messageVenue": { "description": "A message with information about a venue", "args": { "venue": { "description": "The venue description", "is_optional": false, "type": "venue" } }, "type": "MessageContent" }, "messageVideo": { "description": "A video message", "args": { "alternative_videos": { "description": "Alternative qualities of the video", "is_optional": false, "type": "vector\u003calternativeVideo\u003e" }, "caption": { "description": "Video caption", "is_optional": false, "type": "formattedText" }, "cover": { "description": "Cover of the video; may be null if none", "is_optional": true, "type": "photo" }, "has_spoiler": { "description": "True, if the video preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "is_secret": { "description": "True, if the video thumbnail must be blurred and the video must be shown only while tapped", "is_optional": false, "type": "Bool" }, "show_caption_above_media": { "description": "True, if the caption must be shown above the video; otherwise, the caption must be shown below the video", "is_optional": false, "type": "Bool" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "storyboards": { "description": "Available storyboards for the video", "is_optional": false, "type": "vector\u003cvideoStoryboard\u003e" }, "video": { "description": "The video description", "is_optional": false, "type": "video" } }, "type": "MessageContent" }, "messageVideoChatEnded": { "description": "A message with information about an ended video chat", "args": { "duration": { "description": "Call duration, in seconds", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageVideoChatScheduled": { "description": "A new video chat was scheduled", "args": { "group_call_id": { "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" }, "start_date": { "description": "Point in time (Unix timestamp) when the group call is expected to be started by an administrator", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageVideoChatStarted": { "description": "A newly created video chat", "args": { "group_call_id": { "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" } }, "type": "MessageContent" }, "messageVideoNote": { "description": "A video note message", "args": { "is_secret": { "description": "True, if the video note thumbnail must be blurred and the video note must be shown only while tapped", "is_optional": false, "type": "Bool" }, "is_viewed": { "description": "True, if at least one of the recipients has viewed the video note", "is_optional": false, "type": "Bool" }, "video_note": { "description": "The video note description", "is_optional": false, "type": "videoNote" } }, "type": "MessageContent" }, "messageViewer": { "description": "Represents a viewer of a message", "args": { "user_id": { "description": "User identifier of the viewer", "is_optional": false, "type": "int53" }, "view_date": { "description": "Approximate point in time (Unix timestamp) when the message was viewed", "is_optional": false, "type": "int32" } }, "type": "MessageViewer" }, "messageViewers": { "description": "Represents a list of message viewers", "args": { "viewers": { "description": "List of message viewers", "is_optional": false, "type": "vector\u003cmessageViewer\u003e" } }, "type": "MessageViewers" }, "messageVoiceNote": { "description": "A voice note message", "args": { "caption": { "description": "Voice note caption", "is_optional": false, "type": "formattedText" }, "is_listened": { "description": "True, if at least one of the recipients has listened to the voice note", "is_optional": false, "type": "Bool" }, "voice_note": { "description": "The voice note description", "is_optional": false, "type": "voiceNote" } }, "type": "MessageContent" }, "messageWebAppDataReceived": { "description": "Data from a Web App has been received; for bots only", "args": { "button_text": { "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App", "is_optional": false, "type": "string" }, "data": { "description": "The data", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messageWebAppDataSent": { "description": "Data from a Web App has been sent to a bot", "args": { "button_text": { "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App", "is_optional": false, "type": "string" } }, "type": "MessageContent" }, "messages": { "description": "Contains a list of messages", "args": { "messages": { "description": "List of messages; messages may be null", "is_optional": true, "type": "vector\u003cmessage\u003e" }, "total_count": { "description": "Approximate total number of messages found", "is_optional": false, "type": "int32" } }, "type": "Messages" }, "minithumbnail": { "description": "Thumbnail image of a very poor quality and low resolution", "args": { "data": { "description": "The thumbnail in JPEG format", "is_optional": false, "type": "bytes" }, "height": { "description": "Thumbnail height, usually doesn't exceed 40", "is_optional": false, "type": "int32" }, "width": { "description": "Thumbnail width, usually doesn't exceed 40", "is_optional": false, "type": "int32" } }, "type": "Minithumbnail" }, "networkStatistics": { "description": "A full list of available network statistic entries", "args": { "entries": { "description": "Network statistics entries", "is_optional": false, "type": "vector\u003cNetworkStatisticsEntry\u003e" }, "since_date": { "description": "Point in time (Unix timestamp) from which the statistics are collected", "is_optional": false, "type": "int32" } }, "type": "NetworkStatistics" }, "networkStatisticsEntryCall": { "description": "Contains information about the total amount of data that was used for calls", "args": { "duration": { "description": "Total call duration, in seconds", "is_optional": false, "type": "double" }, "network_type": { "description": "Type of the network the data was sent through. Call setNetworkType to maintain the actual network type", "is_optional": false, "type": "NetworkType" }, "received_bytes": { "description": "Total number of bytes received", "is_optional": false, "type": "int53" }, "sent_bytes": { "description": "Total number of bytes sent", "is_optional": false, "type": "int53" } }, "type": "NetworkStatisticsEntry" }, "networkStatisticsEntryFile": { "description": "Contains information about the total amount of data that was used to send and receive files", "args": { "file_type": { "description": "Type of the file the data is part of; pass null if the data isn't related to files", "is_optional": true, "type": "FileType" }, "network_type": { "description": "Type of the network the data was sent through. Call setNetworkType to maintain the actual network type", "is_optional": false, "type": "NetworkType" }, "received_bytes": { "description": "Total number of bytes received", "is_optional": false, "type": "int53" }, "sent_bytes": { "description": "Total number of bytes sent", "is_optional": false, "type": "int53" } }, "type": "NetworkStatisticsEntry" }, "networkTypeMobile": { "description": "A mobile network", "args": {}, "type": "NetworkType" }, "networkTypeMobileRoaming": { "description": "A mobile roaming network", "args": {}, "type": "NetworkType" }, "networkTypeNone": { "description": "The network is not available", "args": {}, "type": "NetworkType" }, "networkTypeOther": { "description": "A different network type (e.g., Ethernet network)", "args": {}, "type": "NetworkType" }, "networkTypeWiFi": { "description": "A Wi-Fi network", "args": {}, "type": "NetworkType" }, "newChatPrivacySettings": { "description": "Contains privacy settings for chats with non-contacts", "args": { "allow_new_chats_from_unknown_users": { "description": "True, if non-contacts users are able to write first to the current user. Telegram Premium subscribers are able to write first regardless of this setting", "is_optional": false, "type": "Bool" }, "incoming_paid_message_star_count": { "description": "Number of Telegram Stars that must be paid for every incoming private message by non-contacts; 0-getOption(\"paid_message_star_count_max\").", "is_optional": false, "type": "int53" } }, "type": "NewChatPrivacySettings" }, "newSticker": { "description": "A sticker to be added to a sticker set", "args": { "emojis": { "description": "String with 1-20 emoji corresponding to the sticker", "is_optional": false, "type": "string" }, "format": { "description": "Format of the sticker", "is_optional": false, "type": "StickerFormat" }, "keywords": { "description": "List of up to 20 keywords with total length up to 64 characters, which can be used to find the sticker", "is_optional": false, "type": "vector\u003cstring\u003e" }, "mask_position": { "description": "Position where the mask is placed; pass null if not specified", "is_optional": true, "type": "maskPosition" }, "sticker": { "description": "File with the sticker; must fit in a 512x512 square. For WEBP stickers the file must be in WEBP or PNG format, which will be converted to WEBP server-side.", "is_optional": false, "type": "InputFile" } }, "type": "NewSticker" }, "notification": { "description": "Contains information about a notification", "args": { "date": { "description": "Notification date", "is_optional": false, "type": "int32" }, "id": { "description": "Unique persistent identifier of this notification", "is_optional": false, "type": "int32" }, "is_silent": { "description": "True, if the notification was explicitly sent without sound", "is_optional": false, "type": "Bool" }, "type": { "description": "Notification type", "is_optional": false, "type": "NotificationType" } }, "type": "Notification" }, "notificationGroup": { "description": "Describes a group of notifications", "args": { "chat_id": { "description": "Identifier of a chat to which all notifications in the group belong", "is_optional": false, "type": "int53" }, "id": { "description": "Unique persistent auto-incremented from 1 identifier of the notification group", "is_optional": false, "type": "int32" }, "notifications": { "description": "The list of active notifications", "is_optional": false, "type": "vector\u003cnotification\u003e" }, "total_count": { "description": "Total number of active notifications in the group", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the group", "is_optional": false, "type": "NotificationGroupType" } }, "type": "NotificationGroup" }, "notificationGroupTypeCalls": { "description": "A group containing notifications of type notificationTypeNewCall", "args": {}, "type": "NotificationGroupType" }, "notificationGroupTypeMentions": { "description": "A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current user, replies to their messages, or a pinned message", "args": {}, "type": "NotificationGroupType" }, "notificationGroupTypeMessages": { "description": "A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages", "args": {}, "type": "NotificationGroupType" }, "notificationGroupTypeSecretChat": { "description": "A group containing a notification of type notificationTypeNewSecretChat", "args": {}, "type": "NotificationGroupType" }, "notificationSettingsScopeChannelChats": { "description": "Notification settings applied to all channel chats when the corresponding chat setting has a default value", "args": {}, "type": "NotificationSettingsScope" }, "notificationSettingsScopeGroupChats": { "description": "Notification settings applied to all basic group and supergroup chats when the corresponding chat setting has a default value", "args": {}, "type": "NotificationSettingsScope" }, "notificationSettingsScopePrivateChats": { "description": "Notification settings applied to all private and secret chats when the corresponding chat setting has a default value", "args": {}, "type": "NotificationSettingsScope" }, "notificationSound": { "description": "Describes a notification sound in MP3 format", "args": { "data": { "description": "Arbitrary data, defined while the sound was uploaded", "is_optional": false, "type": "string" }, "date": { "description": "Point in time (Unix timestamp) when the sound was created", "is_optional": false, "type": "int32" }, "duration": { "description": "Duration of the sound, in seconds", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the notification sound", "is_optional": false, "type": "int64" }, "sound": { "description": "File containing the sound", "is_optional": false, "type": "file" }, "title": { "description": "Title of the notification sound", "is_optional": false, "type": "string" } }, "type": "NotificationSound" }, "notificationSounds": { "description": "Contains a list of notification sounds", "args": { "notification_sounds": { "description": "A list of notification sounds", "is_optional": false, "type": "vector\u003cnotificationSound\u003e" } }, "type": "NotificationSounds" }, "notificationTypeNewCall": { "description": "New call was received", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "int32" } }, "type": "NotificationType" }, "notificationTypeNewMessage": { "description": "New message was received", "args": { "message": { "description": "The message", "is_optional": false, "type": "message" }, "show_preview": { "description": "True, if message content must be displayed in notifications", "is_optional": false, "type": "Bool" } }, "type": "NotificationType" }, "notificationTypeNewPushMessage": { "description": "New message was received through a push notification", "args": { "content": { "description": "Push message content", "is_optional": false, "type": "PushMessageContent" }, "is_outgoing": { "description": "True, if the message is outgoing", "is_optional": false, "type": "Bool" }, "message_id": { "description": "The message identifier. The message will not be available in the chat history, but the identifier can be used in viewMessages, or as a message to be replied in the same chat", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of the message. Corresponding user or chat may be inaccessible", "is_optional": false, "type": "MessageSender" }, "sender_name": { "description": "Name of the sender", "is_optional": false, "type": "string" } }, "type": "NotificationType" }, "notificationTypeNewSecretChat": { "description": "New secret chat was created", "args": {}, "type": "NotificationType" }, "oauthLinkInfo": { "description": "Information about the OAuth authorization", "args": { "bot_user_id": { "description": "User identifier of a bot linked with the website", "is_optional": false, "type": "int53" }, "browser": { "description": "The version of a browser used for the authorization", "is_optional": false, "type": "string" }, "domain": { "description": "A domain of the URL", "is_optional": false, "type": "string" }, "from_app": { "description": "True, if the authorization originates from an application", "is_optional": false, "type": "Bool" }, "ip_address": { "description": "IP address from which the authorization is performed, in human-readable format", "is_optional": false, "type": "string" }, "location": { "description": "Human-readable description of a country and a region from which the authorization is performed, based on the IP address", "is_optional": false, "type": "string" }, "match_code_first": { "description": "True, if code matching dialog must be shown first and checkOauthRequestMatchCode must be called before acceptOauthRequest. Otherwise, checkOauthRequestMatchCode must not be called", "is_optional": false, "type": "Bool" }, "match_codes": { "description": "The list of codes to match; may be empty if irrelevant", "is_optional": true, "type": "vector\u003cstring\u003e" }, "platform": { "description": "Operating system the browser is running on", "is_optional": false, "type": "string" }, "request_phone_number_access": { "description": "True, if the user must be asked for the permission to share their phone number", "is_optional": false, "type": "Bool" }, "request_write_access": { "description": "True, if the user must be asked for the permission to the bot to send them messages", "is_optional": false, "type": "Bool" }, "url": { "description": "An HTTP URL where the user authorizes", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user for which the link was generated; may be 0 if unknown. The corresponding user may be unknown.", "is_optional": false, "type": "int53" }, "verified_app_name": { "description": "Verified name of the application; if empty, then \"Unverified App\" must be shown instead", "is_optional": false, "type": "string" } }, "type": "OauthLinkInfo" }, "ok": { "description": "An object of this type is returned on a successful function call for certain functions", "args": {}, "type": "Ok" }, "onRampPaymentAvailability": { "description": "Describes availability of cryptocurrency purchase through an on-ramp provider", "args": { "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code of the current user's country", "is_optional": false, "type": "string" }, "is_allowed": { "description": "True, if the current user can use the provider", "is_optional": false, "type": "Bool" }, "is_purchase_allowed": { "description": "True, if the current user can purchase through the provider", "is_optional": false, "type": "Bool" }, "methods": { "description": "The list of available payment methods", "is_optional": false, "type": "vector\u003conRampPaymentMethod\u003e" }, "state": { "description": "Code of the state of the current user; may be empty if unknown", "is_optional": true, "type": "string" } }, "type": "OnRampPaymentAvailability" }, "onRampPaymentLimits": { "description": "Describes limits for an on-ramp purchase", "args": { "base_currency_max_amount": { "description": "The maximum allowed amount of the base currency", "is_optional": false, "type": "string" }, "base_currency_min_amount": { "description": "The minimum allowed amount of the base currency", "is_optional": false, "type": "string" }, "cryptocurrency_max_amount": { "description": "The maximum allowed amount of the bought cryptocurrency", "is_optional": false, "type": "string" }, "cryptocurrency_min_amount": { "description": "The minimum allowed amount of the bought cryptocurrency", "is_optional": false, "type": "string" }, "payment_method": { "description": "The payment method to be used", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentLimits" }, "onRampPaymentMethod": { "description": "Describes a payment method of an on-ramp provider", "args": { "is_available": { "description": "True, if the method is available to the user", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the method", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentMethod" }, "onRampPaymentQuote": { "description": "Describes a quote for an on-ramp purchase", "args": { "base_currency_amount": { "description": "Paid amount of the base currency", "is_optional": false, "type": "string" }, "cryptocurrency_amount": { "description": "Purchased amount of the cryptocurrency", "is_optional": false, "type": "string" }, "cryptocurrency_price": { "description": "The price of the cryptocurrency", "is_optional": false, "type": "string" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the quote will expire", "is_optional": false, "type": "int32" }, "extra_fee_amount": { "description": "Extra fee amount", "is_optional": false, "type": "string" }, "fee_amount": { "description": "Fee amount", "is_optional": false, "type": "string" }, "network_fee_amount": { "description": "Network fee amount", "is_optional": false, "type": "string" }, "payment_method": { "description": "The payment method to be used", "is_optional": false, "type": "string" }, "total_amount": { "description": "Total paid amount", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentQuote" }, "onRampPaymentSession": { "description": "Describes a session for an on-ramp purchase", "args": { "expiration_date": { "description": "Point in time (Unix timestamp) when the session will expire", "is_optional": false, "type": "int32" }, "session_id": { "description": "Identifier of the session", "is_optional": false, "type": "string" }, "url": { "description": "HTTPS URL to be opened in a WebView to complete the purchase", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentSession" }, "onRampProvider": { "description": "Describes an on-ramp provider", "args": { "cryptocurrencies": { "description": "List of cryptocurrencies supported by the provider", "is_optional": false, "type": "vector\u003cstring\u003e" }, "id": { "description": "Unique identifier of the provider", "is_optional": false, "type": "string" }, "name": { "description": "Name of the provider", "is_optional": false, "type": "string" }, "supports_base_currencies": { "description": "True, if the provider supports base currencies and can be used in the method getOnRampProviderBaseCurrencies", "is_optional": false, "type": "Bool" }, "supports_limits": { "description": "True, if the provider supports limits retrieval using the method getOnRampPaymentLimits", "is_optional": false, "type": "Bool" }, "supports_quote": { "description": "True, if the provider supports quote retrieval using the method getOnRampPaymentQuote", "is_optional": false, "type": "Bool" } }, "type": "OnRampProvider" }, "onRampProviders": { "description": "Represents a list of on-ramp providers", "args": { "providers": { "description": "A list of providers", "is_optional": false, "type": "vector\u003conRampProvider\u003e" } }, "type": "OnRampProviders" }, "optionValueBoolean": { "description": "Represents a boolean option", "args": { "value": { "description": "The value of the option", "is_optional": false, "type": "Bool" } }, "type": "OptionValue" }, "optionValueEmpty": { "description": "Represents an unknown option or an option which has a default value", "args": {}, "type": "OptionValue" }, "optionValueInteger": { "description": "Represents an integer option", "args": { "value": { "description": "The value of the option", "is_optional": false, "type": "int64" } }, "type": "OptionValue" }, "optionValueString": { "description": "Represents a string option", "args": { "value": { "description": "The value of the option", "is_optional": false, "type": "string" } }, "type": "OptionValue" }, "orderInfo": { "description": "Order information", "args": { "email_address": { "description": "Email address of the user", "is_optional": false, "type": "string" }, "name": { "description": "Name of the user", "is_optional": false, "type": "string" }, "phone_number": { "description": "Phone number of the user", "is_optional": false, "type": "string" }, "shipping_address": { "description": "Shipping address for this order; may be null", "is_optional": true, "type": "address" } }, "type": "OrderInfo" }, "outline": { "description": "Represents outline of an image", "args": { "paths": { "description": "The list of closed vector paths", "is_optional": false, "type": "vector\u003cclosedVectorPath\u003e" } }, "type": "Outline" }, "pageBlockAnchor": { "description": "An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor", "args": { "name": { "description": "Name of the anchor", "is_optional": false, "type": "string" } }, "type": "PageBlock" }, "pageBlockAnimation": { "description": "An animation", "args": { "animation": { "description": "Animation file; may be null", "is_optional": true, "type": "animation" }, "caption": { "description": "Animation caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the animation preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "need_autoplay": { "description": "True, if the animation must be played automatically", "is_optional": false, "type": "Bool" } }, "type": "PageBlock" }, "pageBlockAudio": { "description": "An audio file", "args": { "audio": { "description": "Audio file", "is_optional": false, "type": "audio" }, "caption": { "description": "Audio file caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "PageBlock" }, "pageBlockAuthorDate": { "description": "The author and publishing date of a page; instant view only", "args": { "author": { "description": "Author", "is_optional": false, "type": "RichText" }, "publish_date": { "description": "Point in time (Unix timestamp) when the article was published; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "PageBlock" }, "pageBlockBlockQuote": { "description": "A block quote", "args": { "blocks": { "description": "Quote blocks", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "credit": { "description": "Quote credit; may be null if none", "is_optional": true, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockButtonRow": { "description": "A list of buttons shown in a row", "args": { "align": { "description": "Horizontal alignment of the buttons; may be null if the buttons must be shown full-width", "is_optional": true, "type": "PageBlockHorizontalAlignment" }, "buttons": { "description": "The buttons", "is_optional": false, "type": "vector\u003cinlineButton\u003e" } }, "type": "PageBlock" }, "pageBlockCaption": { "description": "Contains a caption of another block", "args": { "credit": { "description": "Block credit (like HTML tag \u003ccite\u003e); may be null if none", "is_optional": true, "type": "RichText" }, "text": { "description": "Content of the caption", "is_optional": false, "type": "RichText" } }, "type": "PageBlockCaption" }, "pageBlockChatLink": { "description": "A link to a chat; instant view only", "args": { "accent_color_id": { "description": "Identifier of the accent color for chat title and background of chat photo", "is_optional": false, "type": "int32" }, "photo": { "description": "Chat photo; may be null", "is_optional": true, "type": "chatPhotoInfo" }, "title": { "description": "Chat title", "is_optional": false, "type": "string" }, "username": { "description": "Chat username by which all other information about the chat can be resolved", "is_optional": false, "type": "string" } }, "type": "PageBlock" }, "pageBlockCollage": { "description": "A collage", "args": { "blocks": { "description": "Collage item contents", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "caption": { "description": "Block caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "PageBlock" }, "pageBlockCover": { "description": "A page cover; instant view only", "args": { "cover": { "description": "Cover", "is_optional": false, "type": "PageBlock" } }, "type": "PageBlock" }, "pageBlockDetails": { "description": "A collapsible block", "args": { "blocks": { "description": "Block contents", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "header": { "description": "Always visible heading for the block", "is_optional": false, "type": "RichText" }, "is_open": { "description": "True, if the block is open by default", "is_optional": false, "type": "Bool" } }, "type": "PageBlock" }, "pageBlockDivider": { "description": "An empty block separating a page", "args": {}, "type": "PageBlock" }, "pageBlockDocument": { "description": "A general file", "args": { "caption": { "description": "File caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "document": { "description": "The file", "is_optional": false, "type": "document" } }, "type": "PageBlock" }, "pageBlockEmbedded": { "description": "An embedded web page; instant view only", "args": { "allow_scrolling": { "description": "True, if scrolling needs to be allowed", "is_optional": false, "type": "Bool" }, "caption": { "description": "Block caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "height": { "description": "Block height; 0 if unknown", "is_optional": false, "type": "int32" }, "html": { "description": "HTML-markup of the embedded page", "is_optional": false, "type": "string" }, "is_full_width": { "description": "True, if the block must be full width", "is_optional": false, "type": "Bool" }, "poster_photo": { "description": "Poster photo, if available; may be null", "is_optional": true, "type": "photo" }, "url": { "description": "URL of the embedded page, if available", "is_optional": false, "type": "string" }, "width": { "description": "Block width; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "PageBlock" }, "pageBlockEmbeddedPost": { "description": "An embedded post; instant view only", "args": { "author": { "description": "Post author", "is_optional": false, "type": "string" }, "author_photo": { "description": "Post author photo; may be null", "is_optional": true, "type": "photo" }, "blocks": { "description": "Post content", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "caption": { "description": "Post caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "date": { "description": "Point in time (Unix timestamp) when the post was created; 0 if unknown", "is_optional": false, "type": "int32" }, "url": { "description": "URL of the embedded post", "is_optional": false, "type": "string" } }, "type": "PageBlock" }, "pageBlockExpandableBlockQuote": { "description": "An expandable block quote", "args": { "credit": { "description": "Quote credit; may be null if none", "is_optional": true, "type": "RichText" }, "text": { "description": "Text of the quote", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockFooter": { "description": "The footer of a page", "args": { "footer": { "description": "Footer", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockHeader": { "description": "A header; instant view only", "args": { "header": { "description": "Header", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockHorizontalAlignmentCenter": { "description": "The content must be center-aligned", "args": {}, "type": "PageBlockHorizontalAlignment" }, "pageBlockHorizontalAlignmentLeft": { "description": "The content must be left-aligned", "args": {}, "type": "PageBlockHorizontalAlignment" }, "pageBlockHorizontalAlignmentRight": { "description": "The content must be right-aligned", "args": {}, "type": "PageBlockHorizontalAlignment" }, "pageBlockKicker": { "description": "A kicker; instant view only", "args": { "kicker": { "description": "Kicker", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockList": { "description": "A list of data blocks", "args": { "items": { "description": "The items of the list", "is_optional": false, "type": "vector\u003cpageBlockListItem\u003e" } }, "type": "PageBlock" }, "pageBlockListItem": { "description": "Describes an item of a list page block", "args": { "blocks": { "description": "Item blocks", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "has_checkbox": { "description": "True, if the item has a checkbox", "is_optional": false, "type": "Bool" }, "is_checked": { "description": "True, if the item is checked", "is_optional": false, "type": "Bool" }, "label": { "description": "Item label", "is_optional": false, "type": "string" }, "type": { "description": "Type of the item numbering type; must be one of \"a\" for lowercase letters, \"A\" for uppercase letters, \"i\" for lowercase Roman numerals, \"I\" for uppercase Roman numerals,", "is_optional": false, "type": "string" }, "value": { "description": "Value of the item; 0 for unordered lists", "is_optional": false, "type": "int32" } }, "type": "PageBlockListItem" }, "pageBlockMap": { "description": "A map", "args": { "caption": { "description": "Block caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "height": { "description": "Map height", "is_optional": false, "type": "int32" }, "location": { "description": "Location of the map center", "is_optional": false, "type": "location" }, "width": { "description": "Map width", "is_optional": false, "type": "int32" }, "zoom": { "description": "Map zoom level", "is_optional": false, "type": "int32" } }, "type": "PageBlock" }, "pageBlockMathematicalExpression": { "description": "A mathematical expression", "args": { "expression": { "description": "The expression in LaTeX format", "is_optional": false, "type": "string" } }, "type": "PageBlock" }, "pageBlockParagraph": { "description": "A text paragraph", "args": { "text": { "description": "Paragraph text", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockPhoto": { "description": "A photo", "args": { "caption": { "description": "Photo caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the photo preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "photo": { "description": "Photo file; may be null", "is_optional": true, "type": "photo" }, "url": { "description": "URL that needs to be opened when the photo is clicked; instant view only", "is_optional": false, "type": "string" } }, "type": "PageBlock" }, "pageBlockPreformatted": { "description": "A preformatted text paragraph", "args": { "language": { "description": "Programming language for which the text needs to be formatted", "is_optional": false, "type": "string" }, "text": { "description": "Paragraph text", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockPullQuote": { "description": "A pull quote", "args": { "credit": { "description": "Quote credit; may be null if none", "is_optional": true, "type": "RichText" }, "text": { "description": "Quote text", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockRelatedArticle": { "description": "Contains information about a related article", "args": { "author": { "description": "Article author; may be empty", "is_optional": true, "type": "string" }, "description": { "description": "Article description; may be empty", "is_optional": true, "type": "string" }, "photo": { "description": "Article photo; may be null", "is_optional": true, "type": "photo" }, "publish_date": { "description": "Point in time (Unix timestamp) when the article was published; 0 if unknown", "is_optional": false, "type": "int32" }, "title": { "description": "Article title; may be empty", "is_optional": true, "type": "string" }, "url": { "description": "Related article URL", "is_optional": false, "type": "string" } }, "type": "PageBlockRelatedArticle" }, "pageBlockRelatedArticles": { "description": "Related articles; instant view only", "args": { "articles": { "description": "List of related articles", "is_optional": false, "type": "vector\u003cpageBlockRelatedArticle\u003e" }, "header": { "description": "Block header", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockSectionHeading": { "description": "A section heading", "args": { "size": { "description": "Relative size of the text font; 1-6, 1 is the largest, 6 is the smallest", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the section heading", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockSlideshow": { "description": "A slideshow", "args": { "blocks": { "description": "Slideshow item contents", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "caption": { "description": "Block caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" } }, "type": "PageBlock" }, "pageBlockSubheader": { "description": "A subheader; instant view only", "args": { "subheader": { "description": "Subheader", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockSubtitle": { "description": "The subtitle of a page; instant view only", "args": { "subtitle": { "description": "Subtitle", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockTable": { "description": "A table", "args": { "caption": { "description": "Table caption; may be null if none", "is_optional": true, "type": "RichText" }, "cells": { "description": "Table cells", "is_optional": false, "type": "vector\u003cvector\u003cpageBlockTableCell\u003e\u003e" }, "is_bordered": { "description": "True, if the table is bordered", "is_optional": false, "type": "Bool" }, "is_compact": { "description": "True, if table cells must have smaller indents", "is_optional": false, "type": "Bool" }, "is_striped": { "description": "True, if the table is striped", "is_optional": false, "type": "Bool" } }, "type": "PageBlock" }, "pageBlockTableCell": { "description": "Represents a cell of a table", "args": { "align": { "description": "Horizontal cell content alignment", "is_optional": false, "type": "PageBlockHorizontalAlignment" }, "colspan": { "description": "The number of columns the cell spans", "is_optional": false, "type": "int32" }, "is_header": { "description": "True, if it is a header cell", "is_optional": false, "type": "Bool" }, "rowspan": { "description": "The number of rows the cell spans", "is_optional": false, "type": "int32" }, "text": { "description": "Cell text; may be null. If the text is null, then the cell must be invisible", "is_optional": true, "type": "RichText" }, "valign": { "description": "Vertical cell content alignment", "is_optional": false, "type": "PageBlockVerticalAlignment" } }, "type": "PageBlockTableCell" }, "pageBlockThinking": { "description": "A \"Thinking...\" placeholder; for pending rich messages only", "args": { "text": { "description": "Text of the placeholder", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockTitle": { "description": "The title of a page; instant view only", "args": { "title": { "description": "Title", "is_optional": false, "type": "RichText" } }, "type": "PageBlock" }, "pageBlockUnsupported": { "description": "Represents a block unsupported by the current application version", "args": {}, "type": "PageBlock" }, "pageBlockVerticalAlignmentBottom": { "description": "The content must be bottom-aligned", "args": {}, "type": "PageBlockVerticalAlignment" }, "pageBlockVerticalAlignmentMiddle": { "description": "The content must be middle-aligned", "args": {}, "type": "PageBlockVerticalAlignment" }, "pageBlockVerticalAlignmentTop": { "description": "The content must be top-aligned", "args": {}, "type": "PageBlockVerticalAlignment" }, "pageBlockVideo": { "description": "A video", "args": { "caption": { "description": "Video caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "has_spoiler": { "description": "True, if the video preview must be covered by a spoiler animation", "is_optional": false, "type": "Bool" }, "is_looped": { "description": "True, if the video must be looped", "is_optional": false, "type": "Bool" }, "need_autoplay": { "description": "True, if the video must be played automatically", "is_optional": false, "type": "Bool" }, "video": { "description": "Video file; may be null", "is_optional": true, "type": "video" } }, "type": "PageBlock" }, "pageBlockVoiceNote": { "description": "A voice note", "args": { "caption": { "description": "Voice note caption; may be null if none", "is_optional": true, "type": "pageBlockCaption" }, "voice_note": { "description": "Voice note", "is_optional": false, "type": "voiceNote" } }, "type": "PageBlock" }, "paidMediaPhoto": { "description": "The media is a photo", "args": { "photo": { "description": "The photo", "is_optional": false, "type": "photo" }, "video": { "description": "The video representing the live photo; may be null if the photo is static", "is_optional": true, "type": "video" } }, "type": "PaidMedia" }, "paidMediaPreview": { "description": "The media is hidden until the invoice is paid", "args": { "duration": { "description": "Media duration, in seconds; 0 if unknown", "is_optional": false, "type": "int32" }, "height": { "description": "Media height; 0 if unknown", "is_optional": false, "type": "int32" }, "minithumbnail": { "description": "Media minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "width": { "description": "Media width; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "PaidMedia" }, "paidMediaUnsupported": { "description": "The media is unsupported", "args": {}, "type": "PaidMedia" }, "paidMediaVideo": { "description": "The media is a video", "args": { "cover": { "description": "Cover of the video; may be null if none", "is_optional": true, "type": "photo" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "video": { "description": "The video", "is_optional": false, "type": "video" } }, "type": "PaidMedia" }, "paidReactionTypeAnonymous": { "description": "An anonymous paid reaction", "args": {}, "type": "PaidReactionType" }, "paidReactionTypeChat": { "description": "A paid reaction on behalf of an owned chat", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "PaidReactionType" }, "paidReactionTypeRegular": { "description": "A paid reaction on behalf of the current user", "args": {}, "type": "PaidReactionType" }, "paidReactor": { "description": "Contains information about a user who added paid reactions", "args": { "is_anonymous": { "description": "True, if the reactor is anonymous", "is_optional": false, "type": "Bool" }, "is_me": { "description": "True, if the paid reaction was added by the current user", "is_optional": false, "type": "Bool" }, "is_top": { "description": "True, if the reactor is one of the most active reactors; may be false if the reactor is the current user", "is_optional": false, "type": "Bool" }, "sender_id": { "description": "Identifier of the user or chat that added the reactions; may be null for anonymous reactors that aren't the current user", "is_optional": true, "type": "MessageSender" }, "star_count": { "description": "Number of Telegram Stars added", "is_optional": false, "type": "int53" } }, "type": "PaidReactor" }, "passkey": { "description": "Describes a passkey", "args": { "addition_date": { "description": "Point in time (Unix timestamp) when the passkey was added", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the passkey", "is_optional": false, "type": "string" }, "last_usage_date": { "description": "Point in time (Unix timestamp) when the passkey was used last time; 0 if never", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the passkey", "is_optional": false, "type": "string" }, "software_icon_custom_emoji_id": { "description": "Identifier of the custom emoji that is used as the icon of the software that created the passkey; 0 if unknown", "is_optional": false, "type": "int64" } }, "type": "Passkey" }, "passkeys": { "description": "Contains a list of passkeys", "args": { "passkeys": { "description": "List of passkeys", "is_optional": false, "type": "vector\u003cpasskey\u003e" } }, "type": "Passkeys" }, "passportAuthorizationForm": { "description": "Contains information about a Telegram Passport authorization form that was requested", "args": { "id": { "description": "Unique identifier of the authorization form", "is_optional": false, "type": "int32" }, "privacy_policy_url": { "description": "URL for the privacy policy of the service; may be empty", "is_optional": true, "type": "string" }, "required_elements": { "description": "Telegram Passport elements that must be provided to complete the form", "is_optional": false, "type": "vector\u003cpassportRequiredElement\u003e" } }, "type": "PassportAuthorizationForm" }, "passportElementAddress": { "description": "A Telegram Passport element containing the user's address", "args": { "address": { "description": "Address", "is_optional": false, "type": "address" } }, "type": "PassportElement" }, "passportElementBankStatement": { "description": "A Telegram Passport element containing the user's bank statement", "args": { "bank_statement": { "description": "Bank statement", "is_optional": false, "type": "personalDocument" } }, "type": "PassportElement" }, "passportElementDriverLicense": { "description": "A Telegram Passport element containing the user's driver license", "args": { "driver_license": { "description": "Driver license", "is_optional": false, "type": "identityDocument" } }, "type": "PassportElement" }, "passportElementEmailAddress": { "description": "A Telegram Passport element containing the user's email address", "args": { "email_address": { "description": "Email address", "is_optional": false, "type": "string" } }, "type": "PassportElement" }, "passportElementError": { "description": "Contains the description of an error in a Telegram Passport element", "args": { "message": { "description": "Error message", "is_optional": false, "type": "string" }, "source": { "description": "Error source", "is_optional": false, "type": "PassportElementErrorSource" }, "type": { "description": "Type of the Telegram Passport element which has the error", "is_optional": false, "type": "PassportElementType" } }, "type": "PassportElementError" }, "passportElementErrorSourceDataField": { "description": "One of the data fields contains an error. The error will be considered resolved when the value of the field changes", "args": { "field_name": { "description": "Field name", "is_optional": false, "type": "string" } }, "type": "PassportElementErrorSource" }, "passportElementErrorSourceFile": { "description": "The file contains an error. The error will be considered resolved when the file changes", "args": { "file_index": { "description": "Index of a file with the error", "is_optional": false, "type": "int32" } }, "type": "PassportElementErrorSource" }, "passportElementErrorSourceFiles": { "description": "The list of attached files contains an error. The error will be considered resolved when the list of files changes", "args": {}, "type": "PassportElementErrorSource" }, "passportElementErrorSourceFrontSide": { "description": "The front side of the document contains an error. The error will be considered resolved when the file with the front side changes", "args": {}, "type": "PassportElementErrorSource" }, "passportElementErrorSourceReverseSide": { "description": "The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes", "args": {}, "type": "PassportElementErrorSource" }, "passportElementErrorSourceSelfie": { "description": "The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes", "args": {}, "type": "PassportElementErrorSource" }, "passportElementErrorSourceTranslationFile": { "description": "One of files with the translation of the document contains an error. The error will be considered resolved when the file changes", "args": { "file_index": { "description": "Index of a file with the error", "is_optional": false, "type": "int32" } }, "type": "PassportElementErrorSource" }, "passportElementErrorSourceTranslationFiles": { "description": "The translation of the document contains an error. The error will be considered resolved when the list of translation files changes", "args": {}, "type": "PassportElementErrorSource" }, "passportElementErrorSourceUnspecified": { "description": "The element contains an error in an unspecified place. The error will be considered resolved when new data is added", "args": {}, "type": "PassportElementErrorSource" }, "passportElementIdentityCard": { "description": "A Telegram Passport element containing the user's identity card", "args": { "identity_card": { "description": "Identity card", "is_optional": false, "type": "identityDocument" } }, "type": "PassportElement" }, "passportElementInternalPassport": { "description": "A Telegram Passport element containing the user's internal passport", "args": { "internal_passport": { "description": "Internal passport", "is_optional": false, "type": "identityDocument" } }, "type": "PassportElement" }, "passportElementPassport": { "description": "A Telegram Passport element containing the user's passport", "args": { "passport": { "description": "Passport", "is_optional": false, "type": "identityDocument" } }, "type": "PassportElement" }, "passportElementPassportRegistration": { "description": "A Telegram Passport element containing the user's passport registration pages", "args": { "passport_registration": { "description": "Passport registration pages", "is_optional": false, "type": "personalDocument" } }, "type": "PassportElement" }, "passportElementPersonalDetails": { "description": "A Telegram Passport element containing the user's personal details", "args": { "personal_details": { "description": "Personal details of the user", "is_optional": false, "type": "personalDetails" } }, "type": "PassportElement" }, "passportElementPhoneNumber": { "description": "A Telegram Passport element containing the user's phone number", "args": { "phone_number": { "description": "Phone number", "is_optional": false, "type": "string" } }, "type": "PassportElement" }, "passportElementRentalAgreement": { "description": "A Telegram Passport element containing the user's rental agreement", "args": { "rental_agreement": { "description": "Rental agreement", "is_optional": false, "type": "personalDocument" } }, "type": "PassportElement" }, "passportElementTemporaryRegistration": { "description": "A Telegram Passport element containing the user's temporary registration", "args": { "temporary_registration": { "description": "Temporary registration", "is_optional": false, "type": "personalDocument" } }, "type": "PassportElement" }, "passportElementTypeAddress": { "description": "A Telegram Passport element containing the user's address", "args": {}, "type": "PassportElementType" }, "passportElementTypeBankStatement": { "description": "A Telegram Passport element containing the user's bank statement", "args": {}, "type": "PassportElementType" }, "passportElementTypeDriverLicense": { "description": "A Telegram Passport element containing the user's driver license", "args": {}, "type": "PassportElementType" }, "passportElementTypeEmailAddress": { "description": "A Telegram Passport element containing the user's email address", "args": {}, "type": "PassportElementType" }, "passportElementTypeIdentityCard": { "description": "A Telegram Passport element containing the user's identity card", "args": {}, "type": "PassportElementType" }, "passportElementTypeInternalPassport": { "description": "A Telegram Passport element containing the user's internal passport", "args": {}, "type": "PassportElementType" }, "passportElementTypePassport": { "description": "A Telegram Passport element containing the user's passport", "args": {}, "type": "PassportElementType" }, "passportElementTypePassportRegistration": { "description": "A Telegram Passport element containing the registration page of the user's passport", "args": {}, "type": "PassportElementType" }, "passportElementTypePersonalDetails": { "description": "A Telegram Passport element containing the user's personal details", "args": {}, "type": "PassportElementType" }, "passportElementTypePhoneNumber": { "description": "A Telegram Passport element containing the user's phone number", "args": {}, "type": "PassportElementType" }, "passportElementTypeRentalAgreement": { "description": "A Telegram Passport element containing the user's rental agreement", "args": {}, "type": "PassportElementType" }, "passportElementTypeTemporaryRegistration": { "description": "A Telegram Passport element containing the user's temporary registration", "args": {}, "type": "PassportElementType" }, "passportElementTypeUtilityBill": { "description": "A Telegram Passport element containing the user's utility bill", "args": {}, "type": "PassportElementType" }, "passportElementUtilityBill": { "description": "A Telegram Passport element containing the user's utility bill", "args": { "utility_bill": { "description": "Utility bill", "is_optional": false, "type": "personalDocument" } }, "type": "PassportElement" }, "passportElements": { "description": "Contains information about saved Telegram Passport elements", "args": { "elements": { "description": "Telegram Passport elements", "is_optional": false, "type": "vector\u003cPassportElement\u003e" } }, "type": "PassportElements" }, "passportElementsWithErrors": { "description": "Contains information about a Telegram Passport elements and corresponding errors", "args": { "elements": { "description": "Telegram Passport elements", "is_optional": false, "type": "vector\u003cPassportElement\u003e" }, "errors": { "description": "Errors in the elements that are already available", "is_optional": false, "type": "vector\u003cpassportElementError\u003e" } }, "type": "PassportElementsWithErrors" }, "passportRequiredElement": { "description": "Contains a description of the required Telegram Passport element that was requested by a service", "args": { "suitable_elements": { "description": "List of Telegram Passport elements any of which is enough to provide", "is_optional": false, "type": "vector\u003cpassportSuitableElement\u003e" } }, "type": "PassportRequiredElement" }, "passportSuitableElement": { "description": "Contains information about a Telegram Passport element that was requested by a service", "args": { "is_native_name_required": { "description": "True, if personal details must include the user's name in the language of their country of residence", "is_optional": false, "type": "Bool" }, "is_selfie_required": { "description": "True, if a selfie is required with the identity document", "is_optional": false, "type": "Bool" }, "is_translation_required": { "description": "True, if a certified English translation is required with the document", "is_optional": false, "type": "Bool" }, "type": { "description": "Type of the element", "is_optional": false, "type": "PassportElementType" } }, "type": "PassportSuitableElement" }, "passwordState": { "description": "Represents the current state of 2-step verification", "args": { "has_passport_data": { "description": "True, if some Telegram Passport elements were saved", "is_optional": false, "type": "Bool" }, "has_password": { "description": "True, if a 2-step verification password is set", "is_optional": false, "type": "Bool" }, "has_recovery_email_address": { "description": "True, if a recovery email is set", "is_optional": false, "type": "Bool" }, "login_email_address_pattern": { "description": "Pattern of the email address set up for logging in", "is_optional": false, "type": "string" }, "password_hint": { "description": "Hint for the password; may be empty", "is_optional": true, "type": "string" }, "pending_reset_date": { "description": "If not 0, point in time (Unix timestamp) after which the 2-step verification password can be reset immediately using resetPassword", "is_optional": false, "type": "int32" }, "recovery_email_address_code_info": { "description": "Information about the recovery email address to which the confirmation email was sent; may be null", "is_optional": true, "type": "emailAddressAuthenticationCodeInfo" } }, "type": "PasswordState" }, "paymentForm": { "description": "Contains information about an invoice payment form", "args": { "id": { "description": "The payment form identifier", "is_optional": false, "type": "int64" }, "product_info": { "description": "Information about the product", "is_optional": false, "type": "productInfo" }, "seller_bot_user_id": { "description": "User identifier of the seller bot", "is_optional": false, "type": "int53" }, "type": { "description": "Type of the payment form", "is_optional": false, "type": "PaymentFormType" } }, "type": "PaymentForm" }, "paymentFormTypeRegular": { "description": "The payment form is for a regular payment", "args": { "additional_payment_options": { "description": "The list of additional payment options", "is_optional": false, "type": "vector\u003cpaymentOption\u003e" }, "can_save_credentials": { "description": "True, if the user can choose to save credentials", "is_optional": false, "type": "Bool" }, "invoice": { "description": "Full information about the invoice", "is_optional": false, "type": "invoice" }, "need_password": { "description": "True, if the user will be able to save credentials, if sets up a 2-step verification password", "is_optional": false, "type": "Bool" }, "payment_provider": { "description": "Information about the payment provider", "is_optional": false, "type": "PaymentProvider" }, "payment_provider_user_id": { "description": "User identifier of the payment provider bot", "is_optional": false, "type": "int53" }, "saved_credentials": { "description": "The list of saved payment credentials", "is_optional": false, "type": "vector\u003csavedCredentials\u003e" }, "saved_order_info": { "description": "Saved server-side order information; may be null", "is_optional": true, "type": "orderInfo" } }, "type": "PaymentFormType" }, "paymentFormTypeStarSubscription": { "description": "The payment form is for a payment in Telegram Stars for subscription", "args": { "pricing": { "description": "Information about subscription plan", "is_optional": false, "type": "starSubscriptionPricing" } }, "type": "PaymentFormType" }, "paymentFormTypeStars": { "description": "The payment form is for a payment in Telegram Stars", "args": { "star_count": { "description": "Number of Telegram Stars that will be paid", "is_optional": false, "type": "int53" } }, "type": "PaymentFormType" }, "paymentOption": { "description": "Describes an additional payment option", "args": { "title": { "description": "Title for the payment option", "is_optional": false, "type": "string" }, "url": { "description": "Payment form URL to be opened in a web view", "is_optional": false, "type": "string" } }, "type": "PaymentOption" }, "paymentProviderOther": { "description": "Some other payment provider, for which a web payment form must be shown", "args": { "url": { "description": "Payment form URL", "is_optional": false, "type": "string" } }, "type": "PaymentProvider" }, "paymentProviderSmartGlocal": { "description": "Smart Glocal payment provider", "args": { "public_token": { "description": "Public payment token", "is_optional": false, "type": "string" }, "tokenize_url": { "description": "URL for sending card tokenization requests", "is_optional": false, "type": "string" } }, "type": "PaymentProvider" }, "paymentProviderStripe": { "description": "Stripe payment provider", "args": { "need_cardholder_name": { "description": "True, if the cardholder name must be provided", "is_optional": false, "type": "Bool" }, "need_country": { "description": "True, if the user country must be provided", "is_optional": false, "type": "Bool" }, "need_postal_code": { "description": "True, if the user ZIP/postal code must be provided", "is_optional": false, "type": "Bool" }, "publishable_key": { "description": "Stripe API publishable key", "is_optional": false, "type": "string" } }, "type": "PaymentProvider" }, "paymentReceipt": { "description": "Contains information about a successful payment", "args": { "date": { "description": "Point in time (Unix timestamp) when the payment was made", "is_optional": false, "type": "int32" }, "product_info": { "description": "Information about the product", "is_optional": false, "type": "productInfo" }, "seller_bot_user_id": { "description": "User identifier of the seller bot", "is_optional": false, "type": "int53" }, "type": { "description": "Type of the payment receipt", "is_optional": false, "type": "PaymentReceiptType" } }, "type": "PaymentReceipt" }, "paymentReceiptTypeRegular": { "description": "The payment was done using a third-party payment provider", "args": { "credentials_title": { "description": "Title of the saved credentials chosen by the buyer", "is_optional": false, "type": "string" }, "invoice": { "description": "Information about the invoice", "is_optional": false, "type": "invoice" }, "order_info": { "description": "Order information; may be null", "is_optional": true, "type": "orderInfo" }, "payment_provider_user_id": { "description": "User identifier of the payment provider bot", "is_optional": false, "type": "int53" }, "shipping_option": { "description": "Chosen shipping option; may be null", "is_optional": true, "type": "shippingOption" }, "tip_amount": { "description": "The amount of tip chosen by the buyer in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "PaymentReceiptType" }, "paymentReceiptTypeStars": { "description": "The payment was done using Telegram Stars", "args": { "star_count": { "description": "Number of Telegram Stars that were paid", "is_optional": false, "type": "int53" }, "transaction_id": { "description": "Unique identifier of the transaction that can be used to dispute it", "is_optional": false, "type": "string" } }, "type": "PaymentReceiptType" }, "paymentResult": { "description": "Contains the result of a payment request", "args": { "success": { "description": "True, if the payment request was successful; otherwise, the verification_url will be non-empty", "is_optional": false, "type": "Bool" }, "verification_url": { "description": "URL for additional payment credentials verification", "is_optional": false, "type": "string" } }, "type": "PaymentResult" }, "personalDetails": { "description": "Contains the user's personal details", "args": { "birthdate": { "description": "Birthdate of the user", "is_optional": false, "type": "date" }, "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code of the user's country", "is_optional": false, "type": "string" }, "first_name": { "description": "First name of the user written in English; 1-255 characters", "is_optional": false, "type": "string" }, "gender": { "description": "Gender of the user, \"male\" or \"female\"", "is_optional": false, "type": "string" }, "last_name": { "description": "Last name of the user written in English; 1-255 characters", "is_optional": false, "type": "string" }, "middle_name": { "description": "Middle name of the user written in English; 0-255 characters", "is_optional": false, "type": "string" }, "native_first_name": { "description": "Native first name of the user; 1-255 characters", "is_optional": false, "type": "string" }, "native_last_name": { "description": "Native last name of the user; 1-255 characters", "is_optional": false, "type": "string" }, "native_middle_name": { "description": "Native middle name of the user; 0-255 characters", "is_optional": false, "type": "string" }, "residence_country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code of the user's residence country", "is_optional": false, "type": "string" } }, "type": "PersonalDetails" }, "personalDocument": { "description": "A personal document, containing some information about a user", "args": { "files": { "description": "List of files containing the pages of the document", "is_optional": false, "type": "vector\u003cdatedFile\u003e" }, "translation": { "description": "List of files containing a certified English translation of the document", "is_optional": false, "type": "vector\u003cdatedFile\u003e" } }, "type": "PersonalDocument" }, "phoneNumberAuthenticationSettings": { "description": "Contains settings for the authentication of the user's phone number", "args": { "allow_flash_call": { "description": "Pass true if the authentication code may be sent via a flash call to the specified phone number", "is_optional": false, "type": "Bool" }, "allow_missed_call": { "description": "Pass true if the authentication code may be sent via a missed call to the specified phone number", "is_optional": false, "type": "Bool" }, "allow_sms_retriever_api": { "description": "For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services \u003e= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details", "is_optional": false, "type": "Bool" }, "authentication_tokens": { "description": "List of up to 20 authentication tokens, recently received in updateOption(\"authentication_token\") in previously logged out sessions; for setAuthenticationPhoneNumber only", "is_optional": false, "type": "vector\u003cstring\u003e" }, "firebase_authentication_settings": { "description": "For official Android and iOS applications only; pass null otherwise. Settings for Firebase Authentication", "is_optional": true, "type": "FirebaseAuthenticationSettings" }, "has_unknown_phone_number": { "description": "Pass true if there is a SIM card in the current device, but it is not possible to check whether phone number matches", "is_optional": false, "type": "Bool" }, "is_current_phone_number": { "description": "Pass true if the authenticated phone number is used on the current device", "is_optional": false, "type": "Bool" } }, "type": "PhoneNumberAuthenticationSettings" }, "phoneNumberCodeTypeChange": { "description": "Checks ownership of a new phone number to change the user's authentication phone number; for official Android and iOS applications only", "args": {}, "type": "PhoneNumberCodeType" }, "phoneNumberCodeTypeConfirmOwnership": { "description": "Confirms ownership of a phone number to prevent account deletion while handling links of the type internalLinkTypePhoneNumberConfirmation", "args": { "hash": { "description": "Hash value from the link", "is_optional": false, "type": "string" } }, "type": "PhoneNumberCodeType" }, "phoneNumberCodeTypeVerify": { "description": "Verifies ownership of a phone number to be added to the user's Telegram Passport", "args": {}, "type": "PhoneNumberCodeType" }, "phoneNumberInfo": { "description": "Contains information about a phone number", "args": { "country": { "description": "Information about the country to which the phone number belongs; may be null", "is_optional": true, "type": "countryInfo" }, "country_calling_code": { "description": "The part of the phone number denoting country calling code or its part", "is_optional": false, "type": "string" }, "formatted_phone_number": { "description": "The phone number without country calling code formatted accordingly to local rules. Expected digits are returned as '-', but even more digits might be entered by the user", "is_optional": false, "type": "string" }, "is_anonymous": { "description": "True, if the phone number was bought at https://fragment.com and isn't tied to a SIM card. Information about the phone number can be received using getCollectibleItemInfo", "is_optional": false, "type": "Bool" } }, "type": "PhoneNumberInfo" }, "photo": { "description": "Describes a photo", "args": { "has_stickers": { "description": "True, if stickers were added to the photo. The list of corresponding sticker sets can be received using getAttachedStickerSets", "is_optional": false, "type": "Bool" }, "minithumbnail": { "description": "Photo minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "sizes": { "description": "Available variants of the photo, in different sizes", "is_optional": false, "type": "vector\u003cphotoSize\u003e" } }, "type": "Photo" }, "photoSize": { "description": "Describes an image in JPEG format", "args": { "height": { "description": "Image height", "is_optional": false, "type": "int32" }, "photo": { "description": "Information about the image file", "is_optional": false, "type": "file" }, "progressive_sizes": { "description": "Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image; in bytes", "is_optional": false, "type": "vector\u003cint32\u003e" }, "type": { "description": "Image type (see https://core.telegram.org/constructor/photoSize)", "is_optional": false, "type": "string" }, "width": { "description": "Image width", "is_optional": false, "type": "int32" } }, "type": "PhotoSize" }, "point": { "description": "A point on a Cartesian plane", "args": { "x": { "description": "The point's first coordinate", "is_optional": false, "type": "double" }, "y": { "description": "The point's second coordinate", "is_optional": false, "type": "double" } }, "type": "Point" }, "poll": { "description": "Describes a poll", "args": { "allows_multiple_answers": { "description": "True, if multiple answer options can be chosen simultaneously", "is_optional": false, "type": "Bool" }, "allows_revoting": { "description": "True, if the poll can be answered multiple times", "is_optional": false, "type": "Bool" }, "can_get_voters": { "description": "True, if the current user can get voters in the poll using getPollVoters", "is_optional": false, "type": "Bool" }, "can_see_results": { "description": "True, if the current user can see results of the poll", "is_optional": false, "type": "Bool" }, "close_date": { "description": "Point in time (Unix timestamp) when the poll will automatically be closed", "is_optional": false, "type": "int32" }, "country_codes": { "description": "The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be able to vote. If empty, then all users can participate in the poll", "is_optional": false, "type": "vector\u003cstring\u003e" }, "id": { "description": "Unique poll identifier", "is_optional": false, "type": "int64" }, "is_anonymous": { "description": "True, if the poll is anonymous", "is_optional": false, "type": "Bool" }, "is_closed": { "description": "True, if the poll is closed", "is_optional": false, "type": "Bool" }, "members_only": { "description": "True, if only the users that are members of the chat for more than a day will be able to vote", "is_optional": false, "type": "Bool" }, "open_period": { "description": "Amount of time the poll will be active after creation, in seconds", "is_optional": false, "type": "int32" }, "option_order": { "description": "The list of 0-based poll identifiers in which the options of the poll must be shown; empty if the order of options must not be changed", "is_optional": false, "type": "vector\u003cint32\u003e" }, "options": { "description": "List of poll answer options", "is_optional": false, "type": "vector\u003cpollOption\u003e" }, "question": { "description": "Poll question; 1-300 characters; may contain only custom emoji entities", "is_optional": false, "type": "formattedText" }, "recent_voter_ids": { "description": "Identifiers of recent voters, if the poll is non-anonymous and poll results are available", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "total_voter_count": { "description": "Total number of voters, participating in the poll", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the poll", "is_optional": false, "type": "PollType" }, "vote_restriction_reason": { "description": "The reason describing, why the current user can't vote in the poll; may be null if the user can vote in the poll", "is_optional": true, "type": "PollVoteRestrictionReason" } }, "type": "Poll" }, "pollMediaAnimation": { "description": "An animation", "args": { "animation": { "description": "The animation", "is_optional": false, "type": "animation" } }, "type": "PollMedia" }, "pollMediaAudio": { "description": "An audio", "args": { "audio": { "description": "The audio", "is_optional": false, "type": "audio" } }, "type": "PollMedia" }, "pollMediaDocument": { "description": "A document (general file)", "args": { "document": { "description": "The document", "is_optional": false, "type": "document" } }, "type": "PollMedia" }, "pollMediaLink": { "description": "A link", "args": { "link_preview": { "description": "Preview of the link; may be null if unknown", "is_optional": true, "type": "linkPreview" }, "url": { "description": "URL of the link", "is_optional": false, "type": "string" } }, "type": "PollMedia" }, "pollMediaLocation": { "description": "A location", "args": { "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "PollMedia" }, "pollMediaPhoto": { "description": "A photo", "args": { "photo": { "description": "The photo", "is_optional": false, "type": "photo" }, "video": { "description": "The video representing the live photo; may be null if the photo is static", "is_optional": true, "type": "video" } }, "type": "PollMedia" }, "pollMediaSticker": { "description": "A sticker", "args": { "sticker": { "description": "The sticker", "is_optional": false, "type": "sticker" } }, "type": "PollMedia" }, "pollMediaVenue": { "description": "A venue", "args": { "venue": { "description": "The venue", "is_optional": false, "type": "venue" } }, "type": "PollMedia" }, "pollMediaVideo": { "description": "A video", "args": { "alternative_videos": { "description": "Alternative qualities of the video", "is_optional": false, "type": "vector\u003calternativeVideo\u003e" }, "cover": { "description": "Cover of the video; may be null if none", "is_optional": true, "type": "photo" }, "start_timestamp": { "description": "Timestamp from which the video playing must start, in seconds", "is_optional": false, "type": "int32" }, "storyboards": { "description": "Available storyboards for the video", "is_optional": false, "type": "vector\u003cvideoStoryboard\u003e" }, "video": { "description": "The video description", "is_optional": false, "type": "video" } }, "type": "PollMedia" }, "pollOption": { "description": "Describes one answer option of a poll", "args": { "addition_date": { "description": "Point in time (Unix timestamp) when the option was added; 0 if the option existed from creation of the poll", "is_optional": false, "type": "int32" }, "author": { "description": "Identifier of the user or chat who added the option; may be null if the option existed from creation of the poll", "is_optional": true, "type": "MessageSender" }, "id": { "description": "Unique identifier of the option in the poll; may be empty if yet unassigned", "is_optional": true, "type": "string" }, "is_being_chosen": { "description": "True, if the option is being chosen by a pending setPollAnswer request", "is_optional": false, "type": "Bool" }, "is_chosen": { "description": "True, if the option was chosen by the user", "is_optional": false, "type": "Bool" }, "media": { "description": "Option media; may be null if none. If present, currently, can be only of the types pollMediaAnimation, pollMediaLink, pollMediaLocation, pollMediaPhoto, pollMediaSticker, pollMediaVenue, or pollMediaVideo", "is_optional": true, "type": "PollMedia" }, "recent_voter_ids": { "description": "Identifiers of recent voters for the option, if the poll is non-anonymous and poll results are available", "is_optional": false, "type": "vector\u003cMessageSender\u003e" }, "text": { "description": "Option text; 1-100 characters; may contain only custom emoji entities", "is_optional": false, "type": "formattedText" }, "vote_percentage": { "description": "The percentage of votes for this option; 0-100", "is_optional": false, "type": "int32" }, "voter_count": { "description": "Number of voters for this option, available only for closed or voted polls, or if the current user is the creator of the poll", "is_optional": false, "type": "int32" } }, "type": "PollOption" }, "pollOptionProperties": { "description": "Contains properties of a poll option and describes actions that can be done with the option right now", "args": { "can_be_deleted": { "description": "True, if the option can be deleted using deletePollOption", "is_optional": false, "type": "Bool" }, "can_be_replied": { "description": "True, if the poll option can be replied in the same chat and forum topic using inputMessageReplyToMessage", "is_optional": false, "type": "Bool" }, "can_be_replied_in_another_chat": { "description": "True, if the poll option can be replied in another chat or forum topic using inputMessageReplyToExternalMessage", "is_optional": false, "type": "Bool" }, "can_get_link": { "description": "True, if a link can be generated for the poll option using getMessageLink", "is_optional": false, "type": "Bool" } }, "type": "PollOptionProperties" }, "pollTypeQuiz": { "description": "A poll in quiz mode, which has predefined correct answers", "args": { "correct_option_ids": { "description": "Increasing list of 0-based identifiers of the correct answer options; empty for a yet unanswered poll", "is_optional": false, "type": "vector\u003cint32\u003e" }, "explanation": { "description": "Text that is shown when the user chooses an incorrect answer or taps on the lamp icon; empty for a yet unanswered poll", "is_optional": false, "type": "formattedText" }, "explanation_media": { "description": "Media that is shown when the user chooses an incorrect answer or taps on the lamp icon; may be null if none or the poll is unanswered yet.", "is_optional": true, "type": "PollMedia" } }, "type": "PollType" }, "pollTypeRegular": { "description": "A regular poll", "args": {}, "type": "PollType" }, "pollVoteRestrictionReasonClosed": { "description": "The poll is closed", "args": {}, "type": "PollVoteRestrictionReason" }, "pollVoteRestrictionReasonCountryRestricted": { "description": "The user is from a country, users from which aren't allowed to vote", "args": { "country_code": { "description": "Two-letter ISO 3166-1 alpha-2 code of the current user's country", "is_optional": false, "type": "string" } }, "type": "PollVoteRestrictionReason" }, "pollVoteRestrictionReasonMembershipRequired": { "description": "The user must be a member of the chat for at least a day to vote", "args": { "chat_id": { "description": "Identifier of the chat which must be joined for at least a day before the user can vote", "is_optional": false, "type": "int53" } }, "type": "PollVoteRestrictionReason" }, "pollVoteRestrictionReasonOther": { "description": "The poll can't be voted by the user due to some other reason", "args": {}, "type": "PollVoteRestrictionReason" }, "pollVoteRestrictionReasonScheduled": { "description": "The poll is from a scheduled message", "args": {}, "type": "PollVoteRestrictionReason" }, "pollVoteRestrictionReasonYetUnsent": { "description": "The poll isn't sent yet", "args": {}, "type": "PollVoteRestrictionReason" }, "pollVoteStatistics": { "description": "A detailed statistics about poll votes", "args": { "vote_graph": { "description": "A graph containing distribution of votes in the poll", "is_optional": false, "type": "StatisticalGraph" } }, "type": "PollVoteStatistics" }, "pollVoter": { "description": "Represents a poll voter", "args": { "date": { "description": "Point in time (Unix timestamp) when the vote was added", "is_optional": false, "type": "int32" }, "voter_id": { "description": "The voter identifier", "is_optional": false, "type": "MessageSender" } }, "type": "PollVoter" }, "pollVoters": { "description": "Represents a list of poll voters", "args": { "total_count": { "description": "Approximate total number of poll voters found", "is_optional": false, "type": "int32" }, "voters": { "description": "List of poll voters", "is_optional": false, "type": "vector\u003cpollVoter\u003e" } }, "type": "PollVoters" }, "premiumFeatureAccentColor": { "description": "The ability to choose accent color for replies and user profile", "args": {}, "type": "PremiumFeature" }, "premiumFeatureAdvancedChatManagement": { "description": "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", "args": {}, "type": "PremiumFeature" }, "premiumFeatureAnimatedProfilePhoto": { "description": "Profile photo animation on message and chat screens", "args": {}, "type": "PremiumFeature" }, "premiumFeatureAppIcons": { "description": "Allowed to set a premium application icons", "args": {}, "type": "PremiumFeature" }, "premiumFeatureBackgroundForBoth": { "description": "The ability to set private chat background for both users", "args": {}, "type": "PremiumFeature" }, "premiumFeatureBusiness": { "description": "The ability to use Business features", "args": {}, "type": "PremiumFeature" }, "premiumFeatureChatBoost": { "description": "The ability to boost chats", "args": {}, "type": "PremiumFeature" }, "premiumFeatureChecklists": { "description": "The ability to create and use checklist messages", "args": {}, "type": "PremiumFeature" }, "premiumFeatureCustomEmoji": { "description": "Allowed to use custom emoji stickers in message texts and captions", "args": {}, "type": "PremiumFeature" }, "premiumFeatureDisabledAds": { "description": "Disabled ads", "args": {}, "type": "PremiumFeature" }, "premiumFeatureEmojiStatus": { "description": "The ability to show an emoji status along with the user's name", "args": {}, "type": "PremiumFeature" }, "premiumFeatureForumTopicIcon": { "description": "The ability to set a custom emoji as a forum topic icon", "args": {}, "type": "PremiumFeature" }, "premiumFeatureImprovedDownloadSpeed": { "description": "Improved download speed", "args": {}, "type": "PremiumFeature" }, "premiumFeatureIncreasedLimits": { "description": "Increased limits", "args": {}, "type": "PremiumFeature" }, "premiumFeatureIncreasedUploadFileSize": { "description": "Increased maximum upload file size", "args": {}, "type": "PremiumFeature" }, "premiumFeatureLastSeenTimes": { "description": "The ability to view last seen and read times of other users even if they can't view last seen or read time for the current user", "args": {}, "type": "PremiumFeature" }, "premiumFeatureMessageEffects": { "description": "The ability to use all available message effects", "args": {}, "type": "PremiumFeature" }, "premiumFeatureMessagePrivacy": { "description": "The ability to disallow incoming voice and video note messages in private chats using setUserPrivacySettingRules with userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages", "args": {}, "type": "PremiumFeature" }, "premiumFeaturePaidMessages": { "description": "The ability to require a payment for incoming messages in new chats", "args": {}, "type": "PremiumFeature" }, "premiumFeatureProfileBadge": { "description": "A badge in the user's profile", "args": {}, "type": "PremiumFeature" }, "premiumFeaturePromotionAnimation": { "description": "Describes a promotion animation for a Premium feature", "args": { "animation": { "description": "Promotion animation for the feature", "is_optional": false, "type": "animation" }, "feature": { "description": "Premium feature", "is_optional": false, "type": "PremiumFeature" } }, "type": "PremiumFeaturePromotionAnimation" }, "premiumFeatureProtectPrivateChatContent": { "description": "The ability to enable content protection in private chats", "args": {}, "type": "PremiumFeature" }, "premiumFeatureRealTimeChatTranslation": { "description": "Allowed to translate chat messages real-time", "args": {}, "type": "PremiumFeature" }, "premiumFeatureRichMessages": { "description": "The ability to send rich messages", "args": {}, "type": "PremiumFeature" }, "premiumFeatureSavedMessagesTags": { "description": "The ability to use tags in Saved Messages", "args": {}, "type": "PremiumFeature" }, "premiumFeatureTextComposition": { "description": "The ability to compose text with AI", "args": {}, "type": "PremiumFeature" }, "premiumFeatureUniqueReactions": { "description": "Allowed to use more reactions", "args": {}, "type": "PremiumFeature" }, "premiumFeatureUniqueStickers": { "description": "Allowed to use premium stickers with unique effects", "args": {}, "type": "PremiumFeature" }, "premiumFeatureUpgradedStories": { "description": "Allowed to use many additional features for stories", "args": {}, "type": "PremiumFeature" }, "premiumFeatureVoiceRecognition": { "description": "The ability to convert voice notes to text", "args": {}, "type": "PremiumFeature" }, "premiumFeatures": { "description": "Contains information about features, available to Premium users", "args": { "features": { "description": "The list of available features", "is_optional": false, "type": "vector\u003cPremiumFeature\u003e" }, "limits": { "description": "The list of limits, increased for Premium users", "is_optional": false, "type": "vector\u003cpremiumLimit\u003e" }, "payment_link": { "description": "An internal link to be opened to pay for Telegram Premium if store payment isn't possible; may be null if direct payment isn't available", "is_optional": true, "type": "InternalLinkType" } }, "type": "PremiumFeatures" }, "premiumGiftCodeInfo": { "description": "Contains information about a Telegram Premium gift code", "args": { "creation_date": { "description": "Point in time (Unix timestamp) when the code was created", "is_optional": false, "type": "int32" }, "creator_id": { "description": "Identifier of a chat or a user who created the gift code; may be null if unknown. If null and the code is from messagePremiumGiftCode message, then creator_id from the message can be used", "is_optional": true, "type": "MessageSender" }, "day_count": { "description": "Number of days the Telegram Premium subscription will be active after code activation", "is_optional": false, "type": "int32" }, "giveaway_message_id": { "description": "Identifier of the corresponding giveaway message in the creator_id chat; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "is_from_giveaway": { "description": "True, if the gift code was created for a giveaway", "is_optional": false, "type": "Bool" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active after code activation; 0 if the number of months isn't integer", "is_optional": false, "type": "int32" }, "use_date": { "description": "Point in time (Unix timestamp) when the code was activated; 0 if none", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of a user for which the code was created; 0 if none", "is_optional": false, "type": "int53" } }, "type": "PremiumGiftCodeInfo" }, "premiumGiftPaymentOption": { "description": "Describes an option for gifting Telegram Premium to a user. Use telegramPaymentPurposePremiumGift for out-of-store payments or payments in Telegram Stars", "args": { "amount": { "description": "The amount to pay, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code for the payment", "is_optional": false, "type": "string" }, "discount_percentage": { "description": "The discount associated with this option, as a percentage", "is_optional": false, "type": "int32" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active", "is_optional": false, "type": "int32" }, "star_count": { "description": "The alternative Telegram Star amount to pay; 0 if payment in Telegram Stars is not possible", "is_optional": false, "type": "int53" }, "sticker": { "description": "A sticker to be shown along with the option; may be null if unknown", "is_optional": true, "type": "sticker" }, "store_product_id": { "description": "Identifier of the store product associated with the option", "is_optional": false, "type": "string" } }, "type": "PremiumGiftPaymentOption" }, "premiumGiftPaymentOptions": { "description": "Contains a list of options for gifting Telegram Premium to a user", "args": { "options": { "description": "The list of options sorted by Telegram Premium subscription duration", "is_optional": false, "type": "vector\u003cpremiumGiftPaymentOption\u003e" } }, "type": "PremiumGiftPaymentOptions" }, "premiumGiveawayPaymentOption": { "description": "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", "args": { "amount": { "description": "The amount to pay, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code for Telegram Premium gift code payment", "is_optional": false, "type": "string" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active", "is_optional": false, "type": "int32" }, "store_product_id": { "description": "Identifier of the store product associated with the option; may be empty if none", "is_optional": true, "type": "string" }, "store_product_quantity": { "description": "Number of times the store product must be paid", "is_optional": false, "type": "int32" }, "winner_count": { "description": "Number of users who will be able to activate the gift codes", "is_optional": false, "type": "int32" } }, "type": "PremiumGiveawayPaymentOption" }, "premiumGiveawayPaymentOptions": { "description": "Contains a list of options for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among chat members", "args": { "options": { "description": "The list of options", "is_optional": false, "type": "vector\u003cpremiumGiveawayPaymentOption\u003e" } }, "type": "PremiumGiveawayPaymentOptions" }, "premiumLimit": { "description": "Contains information about a limit, increased for Premium users", "args": { "default_value": { "description": "Default value of the limit", "is_optional": false, "type": "int32" }, "premium_value": { "description": "Value of the limit for Premium users", "is_optional": false, "type": "int32" }, "type": { "description": "The type of the limit", "is_optional": false, "type": "PremiumLimitType" } }, "type": "PremiumLimit" }, "premiumLimitTypeActiveStoryCount": { "description": "The maximum number of active stories", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeBioLength": { "description": "The maximum length of the user's bio", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeCaptionLength": { "description": "The maximum length of sent media caption", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeChatFolderChosenChatCount": { "description": "The maximum number of pinned and always included, or always excluded chats in a chat folder", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeChatFolderCount": { "description": "The maximum number of chat folders", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeChatFolderInviteLinkCount": { "description": "The maximum number of invite links for a chat folder", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeCreatedPublicChatCount": { "description": "The maximum number of created public chats", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeCustomTextCompositionStyleCount": { "description": "The maximum number of added text composition styles", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeFavoriteStickerCount": { "description": "The maximum number of favorite stickers", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeMessageTextLength": { "description": "The maximum length of text of sent messages", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeMonthlyPostedStoryCount": { "description": "The maximum number of stories posted per month", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeOwnedBotCount": { "description": "The maximum number of owned bots", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypePinnedArchivedChatCount": { "description": "The maximum number of pinned chats in the archive chat list", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypePinnedChatCount": { "description": "The maximum number of pinned chats in the main chat list", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypePinnedSavedMessagesTopicCount": { "description": "The maximum number of pinned Saved Messages topics", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeSavedAnimationCount": { "description": "The maximum number of saved animations", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeShareableChatFolderCount": { "description": "The maximum number of added shareable chat folders", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeSimilarChatCount": { "description": "The maximum number of received similar chats", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeStoryCaptionLength": { "description": "The maximum length of captions of posted stories", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeStorySuggestedReactionAreaCount": { "description": "The maximum number of suggested reaction areas on a story", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeSupergroupCount": { "description": "The maximum number of joined supergroups and channels", "args": {}, "type": "PremiumLimitType" }, "premiumLimitTypeWeeklyPostedStoryCount": { "description": "The maximum number of stories posted per week", "args": {}, "type": "PremiumLimitType" }, "premiumPaymentOption": { "description": "Describes an option for buying Telegram Premium to a user", "args": { "amount": { "description": "The amount to pay, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code for Telegram Premium subscription payment", "is_optional": false, "type": "string" }, "discount_percentage": { "description": "The discount associated with this option, as a percentage", "is_optional": false, "type": "int32" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active. Use getPremiumInfoSticker to get the sticker to be used as representation of the Telegram Premium subscription", "is_optional": false, "type": "int32" }, "payment_link": { "description": "An internal link to be opened for buying Telegram Premium to the user if store payment isn't possible; may be null if direct payment isn't available", "is_optional": true, "type": "InternalLinkType" }, "store_product_id": { "description": "Identifier of the store product associated with the option", "is_optional": false, "type": "string" } }, "type": "PremiumPaymentOption" }, "premiumSourceBusinessFeature": { "description": "A user tried to use a Business feature", "args": { "feature": { "description": "The used feature; pass null if none specific feature was used", "is_optional": true, "type": "BusinessFeature" } }, "type": "PremiumSource" }, "premiumSourceFeature": { "description": "A user tried to use a Premium feature", "args": { "feature": { "description": "The used feature", "is_optional": false, "type": "PremiumFeature" } }, "type": "PremiumSource" }, "premiumSourceLimitExceeded": { "description": "A limit was exceeded", "args": { "limit_type": { "description": "Type of the exceeded limit", "is_optional": false, "type": "PremiumLimitType" } }, "type": "PremiumSource" }, "premiumSourceLink": { "description": "A user opened an internal link of the type internalLinkTypePremiumFeaturesPage", "args": { "referrer": { "description": "The referrer from the link", "is_optional": false, "type": "string" } }, "type": "PremiumSource" }, "premiumSourceSettings": { "description": "A user opened the Premium features screen from settings", "args": {}, "type": "PremiumSource" }, "premiumSourceStoryFeature": { "description": "A user tried to use a Premium story feature", "args": { "feature": { "description": "The used feature", "is_optional": false, "type": "PremiumStoryFeature" } }, "type": "PremiumSource" }, "premiumState": { "description": "Contains state of Telegram Premium subscription and promotion videos for Premium features", "args": { "animations": { "description": "The list of available promotion animations for Premium features", "is_optional": false, "type": "vector\u003cpremiumFeaturePromotionAnimation\u003e" }, "business_animations": { "description": "The list of available promotion animations for Business features", "is_optional": false, "type": "vector\u003cbusinessFeaturePromotionAnimation\u003e" }, "payment_options": { "description": "The list of available options for buying Telegram Premium", "is_optional": false, "type": "vector\u003cpremiumStatePaymentOption\u003e" }, "state": { "description": "Text description of the state of the current Premium subscription; may be empty if the current user has no Telegram Premium subscription", "is_optional": true, "type": "formattedText" } }, "type": "PremiumState" }, "premiumStatePaymentOption": { "description": "Describes an option for buying or upgrading Telegram Premium for self", "args": { "is_current": { "description": "True, if this is the currently used Telegram Premium subscription option", "is_optional": false, "type": "Bool" }, "is_upgrade": { "description": "True, if the payment option can be used to upgrade the existing Telegram Premium subscription", "is_optional": false, "type": "Bool" }, "last_transaction_id": { "description": "Identifier of the last in-store transaction for the currently used option", "is_optional": false, "type": "string" }, "payment_option": { "description": "Information about the payment option", "is_optional": false, "type": "premiumPaymentOption" } }, "type": "PremiumStatePaymentOption" }, "premiumStoryFeatureCustomExpirationDuration": { "description": "The ability to set custom expiration duration for stories", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeatureLinksAndFormatting": { "description": "The ability to use links and formatting in story caption, and use inputStoryAreaTypeLink areas", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeaturePermanentViewsHistory": { "description": "The ability to check who opened the current user's stories after they expire", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeaturePriorityOrder": { "description": "Stories of the current user are displayed before stories of non-Premium contacts, supergroups, and channels", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeatureSaveStories": { "description": "The ability to save other's unprotected stories", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeatureStealthMode": { "description": "The ability to hide the fact that the user viewed other's stories", "args": {}, "type": "PremiumStoryFeature" }, "premiumStoryFeatureVideoQuality": { "description": "The ability to choose better quality for viewed stories", "args": {}, "type": "PremiumStoryFeature" }, "prepaidGiveaway": { "description": "Describes a prepaid giveaway", "args": { "boost_count": { "description": "The number of boosts received by the chat from the giveaway; for Telegram Star giveaways only", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the prepaid giveaway", "is_optional": false, "type": "int64" }, "payment_date": { "description": "Point in time (Unix timestamp) when the giveaway was paid", "is_optional": false, "type": "int32" }, "prize": { "description": "Prize of the giveaway", "is_optional": false, "type": "GiveawayPrize" }, "winner_count": { "description": "Number of users who will receive giveaway prize", "is_optional": false, "type": "int32" } }, "type": "PrepaidGiveaway" }, "preparedInlineMessage": { "description": "Represents a ready to send inline message. Use sendInlineQueryResultMessage to send the message", "args": { "chat_types": { "description": "Types of the chats to which the message can be sent", "is_optional": false, "type": "targetChatTypes" }, "inline_query_id": { "description": "Unique identifier of the inline query to pass to sendInlineQueryResultMessage", "is_optional": false, "type": "int64" }, "result": { "description": "Resulted inline message of the query", "is_optional": false, "type": "InlineQueryResult" } }, "type": "PreparedInlineMessage" }, "preparedInlineMessageId": { "description": "Represents an inline message that can be sent via the bot", "args": { "expiration_date": { "description": "Point in time (Unix timestamp) when the message can't be used anymore", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier for the message", "is_optional": false, "type": "string" } }, "type": "PreparedInlineMessageId" }, "productInfo": { "description": "Contains information about a product that can be paid with invoice", "args": { "description": { "description": "Product description", "is_optional": false, "type": "formattedText" }, "photo": { "description": "Product photo; may be null", "is_optional": true, "type": "photo" }, "title": { "description": "Product title", "is_optional": false, "type": "string" } }, "type": "ProductInfo" }, "profileAccentColor": { "description": "Contains information about supported accent color for user profile photo background", "args": { "dark_theme_colors": { "description": "Accent colors expected to be used in dark themes", "is_optional": false, "type": "profileAccentColors" }, "id": { "description": "Profile accent color identifier", "is_optional": false, "type": "int32" }, "light_theme_colors": { "description": "Accent colors expected to be used in light themes", "is_optional": false, "type": "profileAccentColors" }, "min_channel_chat_boost_level": { "description": "The minimum chat boost level required to use the color in a channel chat", "is_optional": false, "type": "int32" }, "min_supergroup_chat_boost_level": { "description": "The minimum chat boost level required to use the color in a supergroup chat", "is_optional": false, "type": "int32" } }, "type": "ProfileAccentColor" }, "profileAccentColors": { "description": "Contains information about supported accent colors for user profile photo background in RGB format", "args": { "background_colors": { "description": "The list of 1-2 colors in RGB format, describing the colors, as expected to be used for the profile photo background", "is_optional": false, "type": "vector\u003cint32\u003e" }, "palette_colors": { "description": "The list of 1-2 colors in RGB format, describing the colors, as expected to be shown in the color palette settings", "is_optional": false, "type": "vector\u003cint32\u003e" }, "story_colors": { "description": "The list of 2 colors in RGB format, describing the colors of the gradient to be used for the unread active story indicator around profile photo", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "ProfileAccentColors" }, "profilePhoto": { "description": "Describes a user profile photo", "args": { "big": { "description": "A big (640x640) user profile photo. The file can be downloaded only before the photo is changed", "is_optional": false, "type": "file" }, "has_animation": { "description": "True, if the photo has animated variant", "is_optional": false, "type": "Bool" }, "id": { "description": "Photo identifier; 0 for an empty photo. Can be used to find a photo in a list of user profile photos", "is_optional": false, "type": "int64" }, "is_personal": { "description": "True, if the photo is visible only for the current user", "is_optional": false, "type": "Bool" }, "minithumbnail": { "description": "User profile photo minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "small": { "description": "A small (160x160) user profile photo. The file can be downloaded only before the photo is changed", "is_optional": false, "type": "file" } }, "type": "ProfilePhoto" }, "profileTabFiles": { "description": "A tab with documents posted by the channel", "args": {}, "type": "ProfileTab" }, "profileTabGifs": { "description": "A tab with animations posted by the channel", "args": {}, "type": "ProfileTab" }, "profileTabGifts": { "description": "A tab with gifts received by the user or the channel chat", "args": {}, "type": "ProfileTab" }, "profileTabLinks": { "description": "A tab with messages posted by the channel and containing links", "args": {}, "type": "ProfileTab" }, "profileTabMedia": { "description": "A tab with photos and videos posted by the channel", "args": {}, "type": "ProfileTab" }, "profileTabMusic": { "description": "A tab with audio messages posted by the channel", "args": {}, "type": "ProfileTab" }, "profileTabPosts": { "description": "A tab with stories posted by the user or the channel chat and saved to profile", "args": {}, "type": "ProfileTab" }, "profileTabVoice": { "description": "A tab with voice notes posted by the channel", "args": {}, "type": "ProfileTab" }, "proxy": { "description": "Describes a proxy server", "args": { "port": { "description": "Proxy server port", "is_optional": false, "type": "int32" }, "server": { "description": "Proxy server domain or IP address", "is_optional": false, "type": "string" }, "type": { "description": "Type of the proxy", "is_optional": false, "type": "ProxyType" } }, "type": "Proxy" }, "proxyTypeHttp": { "description": "A HTTP transparent proxy server", "args": { "http_only": { "description": "Pass true if the proxy supports only HTTP requests and doesn't support transparent TCP connections via HTTP CONNECT method", "is_optional": false, "type": "Bool" }, "password": { "description": "Password for logging in; may be empty", "is_optional": true, "type": "string" }, "username": { "description": "Username for logging in; may be empty", "is_optional": true, "type": "string" } }, "type": "ProxyType" }, "proxyTypeMtproto": { "description": "An MTProto proxy server", "args": { "secret": { "description": "The proxy's secret in hexadecimal encoding", "is_optional": false, "type": "string" } }, "type": "ProxyType" }, "proxyTypeSocks5": { "description": "A SOCKS5 proxy server", "args": { "password": { "description": "Password for logging in; may be empty", "is_optional": true, "type": "string" }, "username": { "description": "Username for logging in; may be empty", "is_optional": true, "type": "string" } }, "type": "ProxyType" }, "publicChatTypeHasUsername": { "description": "The chat is public, because it has an active username", "args": {}, "type": "PublicChatType" }, "publicChatTypeIsLocationBased": { "description": "The chat is public, because it is a location-based supergroup", "args": {}, "type": "PublicChatType" }, "publicForwardMessage": { "description": "Contains a public forward as a message", "args": { "message": { "description": "Information about the message", "is_optional": false, "type": "message" } }, "type": "PublicForward" }, "publicForwardStory": { "description": "Contains a public repost to a story", "args": { "story": { "description": "Information about the story", "is_optional": false, "type": "story" } }, "type": "PublicForward" }, "publicForwards": { "description": "Represents a list of public forwards and reposts as a story of a message or a story", "args": { "forwards": { "description": "List of found public forwards and reposts", "is_optional": false, "type": "vector\u003cPublicForward\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "Approximate total number of messages and stories found", "is_optional": false, "type": "int32" } }, "type": "PublicForwards" }, "publicPostSearchLimits": { "description": "Contains information about public post search limits", "args": { "daily_free_query_count": { "description": "Number of queries that can be sent daily for free", "is_optional": false, "type": "int32" }, "is_current_query_free": { "description": "True, if the search for the specified query isn't charged", "is_optional": false, "type": "Bool" }, "next_free_query_in": { "description": "Amount of time till the next free query can be sent; 0 if it can be sent now", "is_optional": false, "type": "int32" }, "remaining_free_query_count": { "description": "Number of remaining free queries today", "is_optional": false, "type": "int32" }, "star_count": { "description": "Number of Telegram Stars that must be paid for each non-free query", "is_optional": false, "type": "int53" } }, "type": "PublicPostSearchLimits" }, "pushMessageContentAnimation": { "description": "An animation message (GIF-style).", "args": { "animation": { "description": "Message content; may be null", "is_optional": true, "type": "animation" }, "caption": { "description": "Animation caption", "is_optional": false, "type": "string" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentAudio": { "description": "An audio message", "args": { "audio": { "description": "Message content; may be null", "is_optional": true, "type": "audio" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentBasicGroupChatCreate": { "description": "A newly created basic group", "args": {}, "type": "PushMessageContent" }, "pushMessageContentChatAddMembers": { "description": "New chat members were invited to a group", "args": { "is_current_user": { "description": "True, if the current user was added to the group", "is_optional": false, "type": "Bool" }, "is_returned": { "description": "True, if the user has returned to the group themselves", "is_optional": false, "type": "Bool" }, "member_name": { "description": "Name of the added member", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentChatChangePhoto": { "description": "A chat photo was edited", "args": {}, "type": "PushMessageContent" }, "pushMessageContentChatChangeTitle": { "description": "A chat title was edited", "args": { "title": { "description": "New chat title", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentChatDeleteMember": { "description": "A chat member was deleted", "args": { "is_current_user": { "description": "True, if the current user was deleted from the group", "is_optional": false, "type": "Bool" }, "is_left": { "description": "True, if the user has left the group themselves", "is_optional": false, "type": "Bool" }, "member_name": { "description": "Name of the deleted member", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentChatJoinByLink": { "description": "A new member joined the chat via an invite link", "args": {}, "type": "PushMessageContent" }, "pushMessageContentChatJoinByRequest": { "description": "A new member was accepted to the chat by an administrator", "args": {}, "type": "PushMessageContent" }, "pushMessageContentChatSetBackground": { "description": "A chat background was edited", "args": { "is_same": { "description": "True, if the set background is the same as the background of the current user", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentChatSetTheme": { "description": "A chat theme was edited", "args": { "name": { "description": "If non-empty, human-readable name of the new theme. Otherwise, the chat theme was reset to the default one", "is_optional": true, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentChecklist": { "description": "A message with a checklist", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "title": { "description": "Checklist title", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentChecklistTasksAdded": { "description": "Some tasks were added to a checklist", "args": { "task_count": { "description": "Number of added tasks", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentChecklistTasksDone": { "description": "Some tasks from a checklist were marked as done or not done", "args": { "task_count": { "description": "Number of changed tasks", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentContact": { "description": "A message with a user contact", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "name": { "description": "Contact's name", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentContactRegistered": { "description": "A contact has registered with Telegram", "args": { "as_premium_account": { "description": "True, if the user joined Telegram as a Telegram Premium account", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentDocument": { "description": "A document message (a general file)", "args": { "document": { "description": "Message content; may be null", "is_optional": true, "type": "document" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentGame": { "description": "A message with a game", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "title": { "description": "Game title, empty for pinned game message", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentGameScore": { "description": "A new high score was achieved in a game", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "score": { "description": "New score, 0 for pinned message", "is_optional": false, "type": "int32" }, "title": { "description": "Game title, empty for pinned message", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentGift": { "description": "A message with a gift", "args": { "is_prepaid_upgrade": { "description": "True, if the message is about prepaid upgrade of the gift by another user instead of actual receiving of a new gift", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars that sender paid for the gift", "is_optional": false, "type": "int53" } }, "type": "PushMessageContent" }, "pushMessageContentGiveaway": { "description": "A message with a giveaway", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "prize": { "description": "Prize of the giveaway; may be null for pinned message", "is_optional": true, "type": "GiveawayPrize" }, "winner_count": { "description": "Number of users who will receive giveaway prizes; 0 for pinned message", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentHidden": { "description": "A general message with hidden content", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentInviteVideoChatParticipants": { "description": "An invitation of participants to a video chat or live stream", "args": { "is_current_user": { "description": "True, if the current user was invited to the video chat or the live stream", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentInvoice": { "description": "A message with an invoice from a bot", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "price": { "description": "Product price", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentLocation": { "description": "A message with a location", "args": { "is_live": { "description": "True, if the location is live", "is_optional": false, "type": "Bool" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentMediaAlbum": { "description": "A media album", "args": { "has_audios": { "description": "True, if the album has at least one audio file", "is_optional": false, "type": "Bool" }, "has_documents": { "description": "True, if the album has at least one document", "is_optional": false, "type": "Bool" }, "has_photos": { "description": "True, if the album has at least one photo", "is_optional": false, "type": "Bool" }, "has_videos": { "description": "True, if the album has at least one video file", "is_optional": false, "type": "Bool" }, "total_count": { "description": "Number of messages in the album", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentMessageForwards": { "description": "A forwarded messages", "args": { "total_count": { "description": "Number of forwarded messages", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentPaidMedia": { "description": "A message with paid media", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars needed to buy access to the media in the message; 0 for pinned message", "is_optional": false, "type": "int53" } }, "type": "PushMessageContent" }, "pushMessageContentPhoto": { "description": "A photo message", "args": { "caption": { "description": "Photo caption", "is_optional": false, "type": "string" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "is_secret": { "description": "True, if the photo is secret", "is_optional": false, "type": "Bool" }, "photo": { "description": "Message content; may be null", "is_optional": true, "type": "photo" } }, "type": "PushMessageContent" }, "pushMessageContentPoll": { "description": "A message with a poll", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "is_regular": { "description": "True, if the poll is regular and not in quiz mode", "is_optional": false, "type": "Bool" }, "question": { "description": "Poll question", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentPollOptionAdded": { "description": "An option was added to a poll", "args": { "text": { "description": "Text of the option", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentPremiumGiftCode": { "description": "A message with a Telegram Premium gift code created for the user", "args": { "month_count": { "description": "Number of months the Telegram Premium subscription will be active after code activation", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentProximityAlertTriggered": { "description": "A user in the chat came within proximity alert range from the current user", "args": { "distance": { "description": "The distance to the user", "is_optional": false, "type": "int32" } }, "type": "PushMessageContent" }, "pushMessageContentRecurringPayment": { "description": "A new recurring payment was made by the current user", "args": { "amount": { "description": "The paid amount", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentScreenshotTaken": { "description": "A screenshot of a message in the chat has been taken", "args": {}, "type": "PushMessageContent" }, "pushMessageContentSticker": { "description": "A message with a sticker", "args": { "emoji": { "description": "Emoji corresponding to the sticker; may be empty", "is_optional": true, "type": "string" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "sticker": { "description": "Message content; may be null", "is_optional": true, "type": "sticker" } }, "type": "PushMessageContent" }, "pushMessageContentStory": { "description": "A message with a story", "args": { "is_mention": { "description": "True, if the user was mentioned in the story", "is_optional": false, "type": "Bool" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentSuggestBirthdate": { "description": "A birthdate was suggested to be set", "args": {}, "type": "PushMessageContent" }, "pushMessageContentSuggestProfilePhoto": { "description": "A profile photo was suggested to the user", "args": {}, "type": "PushMessageContent" }, "pushMessageContentText": { "description": "A text message", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "text": { "description": "Message text", "is_optional": false, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentTonConnectRequest": { "description": "A message with a request from a dApp was received through TON Connect", "args": { "dapp_name": { "description": "Name of the dApp; may be empty if unknown", "is_optional": true, "type": "string" } }, "type": "PushMessageContent" }, "pushMessageContentTonWalletTransfer": { "description": "A message with a TON wallet transfer", "args": { "amount": { "description": "String representation of the received amount", "is_optional": false, "type": "string" }, "comment": { "description": "Comment added to the transaction if it is public", "is_optional": false, "type": "string" }, "sender_user_id": { "description": "Sender of the transfer; 0 if unknown", "is_optional": false, "type": "int53" } }, "type": "PushMessageContent" }, "pushMessageContentUpgradedGift": { "description": "A message with an upgraded gift", "args": { "is_prepaid_upgrade": { "description": "True, if the message is about completion of prepaid upgrade of the gift instead of actual receiving of a new gift", "is_optional": false, "type": "Bool" }, "is_upgrade": { "description": "True, if the gift was obtained by upgrading of a previously received gift; otherwise, if is_prepaid_upgrade == false, then this is a transferred or resold gift", "is_optional": false, "type": "Bool" } }, "type": "PushMessageContent" }, "pushMessageContentVideo": { "description": "A video message", "args": { "caption": { "description": "Video caption", "is_optional": false, "type": "string" }, "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "is_secret": { "description": "True, if the video is secret", "is_optional": false, "type": "Bool" }, "video": { "description": "Message content; may be null", "is_optional": true, "type": "video" } }, "type": "PushMessageContent" }, "pushMessageContentVideoChatEnded": { "description": "A video chat or live stream has ended", "args": {}, "type": "PushMessageContent" }, "pushMessageContentVideoChatStarted": { "description": "A video chat or live stream was started", "args": {}, "type": "PushMessageContent" }, "pushMessageContentVideoNote": { "description": "A video note message", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "video_note": { "description": "Message content; may be null", "is_optional": true, "type": "videoNote" } }, "type": "PushMessageContent" }, "pushMessageContentVoiceNote": { "description": "A voice note message", "args": { "is_pinned": { "description": "True, if the message is a pinned message with the specified content", "is_optional": false, "type": "Bool" }, "voice_note": { "description": "Message content; may be null", "is_optional": true, "type": "voiceNote" } }, "type": "PushMessageContent" }, "pushReceiverId": { "description": "Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification", "args": { "id": { "description": "The globally unique identifier of push notification subscription", "is_optional": false, "type": "int64" } }, "type": "PushReceiverId" }, "quickReplyMessage": { "description": "Describes a message that can be used for quick reply", "args": { "can_be_edited": { "description": "True, if the message can be edited", "is_optional": false, "type": "Bool" }, "content": { "description": "Content of the message", "is_optional": false, "type": "MessageContent" }, "id": { "description": "Unique message identifier among all quick replies", "is_optional": false, "type": "int53" }, "media_album_id": { "description": "Unique identifier of an album this message belongs to; 0 if none. Only audios, documents, photos and videos can be grouped together in albums", "is_optional": false, "type": "int64" }, "reply_markup": { "description": "Inline keyboard reply markup for the message; may be null if none", "is_optional": true, "type": "ReplyMarkup" }, "reply_to_message_id": { "description": "The identifier of the quick reply message to which the message replies; 0 if none", "is_optional": false, "type": "int53" }, "sending_state": { "description": "The sending state of the message; may be null if the message isn't being sent and didn't fail to be sent", "is_optional": true, "type": "MessageSendingState" }, "via_bot_user_id": { "description": "If non-zero, the user identifier of the bot through which this message was sent", "is_optional": false, "type": "int53" } }, "type": "QuickReplyMessage" }, "quickReplyMessages": { "description": "Contains a list of quick reply messages", "args": { "messages": { "description": "List of quick reply messages; messages may be null", "is_optional": true, "type": "vector\u003cquickReplyMessage\u003e" } }, "type": "QuickReplyMessages" }, "quickReplyShortcut": { "description": "Describes a shortcut that can be used for a quick reply", "args": { "first_message": { "description": "The first shortcut message", "is_optional": false, "type": "quickReplyMessage" }, "id": { "description": "Unique shortcut identifier", "is_optional": false, "type": "int32" }, "message_count": { "description": "The total number of messages in the shortcut", "is_optional": false, "type": "int32" }, "name": { "description": "The name of the shortcut that can be used to use the shortcut", "is_optional": false, "type": "string" } }, "type": "QuickReplyShortcut" }, "reactionNotificationSettings": { "description": "Contains information about notification settings for reactions and poll votes", "args": { "message_reaction_source": { "description": "Source of message reactions for which notifications are shown", "is_optional": false, "type": "ReactionNotificationSource" }, "poll_vote_source": { "description": "Source of poll votes for which notifications are shown", "is_optional": false, "type": "ReactionNotificationSource" }, "show_preview": { "description": "True, if reaction sender and emoji must be displayed in notifications", "is_optional": false, "type": "Bool" }, "sound_id": { "description": "Identifier of the notification sound to be played; 0 if sound is disabled; pass -1 to use the app-dependent default sound", "is_optional": false, "type": "int64" }, "story_reaction_source": { "description": "Source of story reactions for which notifications are shown", "is_optional": false, "type": "ReactionNotificationSource" } }, "type": "ReactionNotificationSettings" }, "reactionNotificationSourceAll": { "description": "Notifications for reactions are shown for all reactions", "args": {}, "type": "ReactionNotificationSource" }, "reactionNotificationSourceContacts": { "description": "Notifications for reactions are shown only for reactions from contacts", "args": {}, "type": "ReactionNotificationSource" }, "reactionNotificationSourceNone": { "description": "Notifications for reactions are disabled", "args": {}, "type": "ReactionNotificationSource" }, "reactionTypeCustomEmoji": { "description": "A reaction with a custom emoji", "args": { "custom_emoji_id": { "description": "Unique identifier of the custom emoji", "is_optional": false, "type": "int64" } }, "type": "ReactionType" }, "reactionTypeEmoji": { "description": "A reaction with an emoji", "args": { "emoji": { "description": "Text representation of the reaction", "is_optional": false, "type": "string" } }, "type": "ReactionType" }, "reactionTypePaid": { "description": "The paid reaction in a channel chat", "args": {}, "type": "ReactionType" }, "reactionUnavailabilityReasonAnonymousAdministrator": { "description": "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", "args": {}, "type": "ReactionUnavailabilityReason" }, "reactionUnavailabilityReasonGuest": { "description": "The user isn't a member of the supergroup and can't send messages and reactions there without joining", "args": {}, "type": "ReactionUnavailabilityReason" }, "reactionUnavailabilityReasonRestricted": { "description": "The user is restricted in the chat", "args": {}, "type": "ReactionUnavailabilityReason" }, "readDatePrivacySettings": { "description": "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", "args": { "show_read_date": { "description": "True, if message read date is shown to other users in private chats. If false and the current user isn't a Telegram Premium user, then they will not be able to see other's message read date", "is_optional": false, "type": "Bool" } }, "type": "ReadDatePrivacySettings" }, "receivedGift": { "description": "Represents a gift received by a user or a chat", "args": { "can_be_transferred": { "description": "True, if the gift is an upgraded gift that can be transferred to another owner; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "can_be_upgraded": { "description": "True, if the gift is a regular gift that can be upgraded to a unique gift; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "collection_ids": { "description": "Identifiers of collections to which the gift is added; only for the receiver of the gift", "is_optional": false, "type": "vector\u003cint32\u003e" }, "craft_date": { "description": "Point in time (Unix timestamp) when the gift can be used to craft another gift; can be in the past; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "date": { "description": "Point in time (Unix timestamp) when the gift was sent", "is_optional": false, "type": "int32" }, "drop_original_details_star_count": { "description": "Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available; only for the receiver of the gift", "is_optional": false, "type": "int53" }, "export_date": { "description": "Point in time (Unix timestamp) when the upgraded gift can be transferred to the TON blockchain as an NFT; can be in the past; 0 if NFT export isn't possible; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "gift": { "description": "The gift", "is_optional": false, "type": "SentGift" }, "is_pinned": { "description": "True, if the gift is pinned to the top of the chat's profile page", "is_optional": false, "type": "Bool" }, "is_private": { "description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone are able to see them", "is_optional": false, "type": "Bool" }, "is_saved": { "description": "True, if the gift is displayed on the chat's profile page; only for the receiver of the gift", "is_optional": false, "type": "Bool" }, "is_upgrade_separate": { "description": "True, if the upgrade was bought after the gift was sent. In this case, prepaid upgrade cost must not be added to the gift cost", "is_optional": false, "type": "Bool" }, "next_resale_date": { "description": "Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can't be resold; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn't possible; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "prepaid_upgrade_hash": { "description": "If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade", "is_optional": true, "type": "string" }, "prepaid_upgrade_star_count": { "description": "Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift", "is_optional": false, "type": "int53" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user; only for the receiver of the gift", "is_optional": false, "type": "string" }, "sell_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver instead of the regular gift; 0 if the gift can't be sold by the current user", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of a user or a chat that sent the gift; may be null if unknown", "is_optional": true, "type": "MessageSender" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift", "is_optional": false, "type": "int53" }, "unique_gift_number": { "description": "Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned", "is_optional": false, "type": "int32" }, "was_refunded": { "description": "True, if the gift was refunded and isn't available anymore", "is_optional": false, "type": "Bool" } }, "type": "ReceivedGift" }, "receivedGifts": { "description": "Represents a list of gifts received by a user or a chat", "args": { "are_notifications_enabled": { "description": "True, if notifications about new gifts of the owner are enabled", "is_optional": false, "type": "Bool" }, "gifts": { "description": "The list of gifts", "is_optional": false, "type": "vector\u003creceivedGift\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "The total number of received gifts", "is_optional": false, "type": "int32" } }, "type": "ReceivedGifts" }, "recommendedChatFolder": { "description": "Describes a recommended chat folder", "args": { "description": { "description": "Chat folder description", "is_optional": false, "type": "string" }, "folder": { "description": "The chat folder", "is_optional": false, "type": "chatFolder" } }, "type": "RecommendedChatFolder" }, "recommendedChatFolders": { "description": "Contains a list of recommended chat folders", "args": { "chat_folders": { "description": "List of recommended chat folders", "is_optional": false, "type": "vector\u003crecommendedChatFolder\u003e" } }, "type": "RecommendedChatFolders" }, "recoveryEmailAddress": { "description": "Contains information about the current recovery email address", "args": { "recovery_email_address": { "description": "Recovery email address", "is_optional": false, "type": "string" } }, "type": "RecoveryEmailAddress" }, "remoteFile": { "description": "Represents a remote file", "args": { "id": { "description": "Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers.", "is_optional": true, "type": "string" }, "is_uploading_active": { "description": "True, if the file is currently being uploaded (or a remote copy is being generated by some other means)", "is_optional": false, "type": "Bool" }, "is_uploading_completed": { "description": "True, if a remote copy is fully available", "is_optional": false, "type": "Bool" }, "unique_id": { "description": "Unique file identifier; may be empty if unknown. The unique file identifier which is the same for the same file even for different users and is persistent over time", "is_optional": true, "type": "string" }, "uploaded_size": { "description": "Size of the remote available part of the file, in bytes; 0 if unknown", "is_optional": false, "type": "int53" } }, "type": "RemoteFile" }, "replyMarkupForceReply": { "description": "Instructs application to force a reply to this message", "args": { "input_field_placeholder": { "description": "If non-empty, the placeholder to be shown in the input field when the reply is active; 0-64 characters", "is_optional": true, "type": "string" }, "is_personal": { "description": "True, if a forced reply must automatically be shown to the current user. For outgoing messages, specify true to show the forced reply only for the mentioned users and for the target user of a reply", "is_optional": false, "type": "Bool" } }, "type": "ReplyMarkup" }, "replyMarkupInlineKeyboard": { "description": "Contains an inline keyboard layout", "args": { "force_reply": { "description": "True, if a reply to the message must be forced when the message is received", "is_optional": false, "type": "Bool" }, "rows": { "description": "A list of rows of inline keyboard buttons", "is_optional": false, "type": "vector\u003cvector\u003cinlineKeyboardButton\u003e\u003e" } }, "type": "ReplyMarkup" }, "replyMarkupRemoveKeyboard": { "description": "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 reply_markup_message == null will be sent", "args": { "is_personal": { "description": "True, if the keyboard is removed only for the mentioned users or the target user of a reply", "is_optional": false, "type": "Bool" } }, "type": "ReplyMarkup" }, "replyMarkupShowKeyboard": { "description": "Contains a custom keyboard layout to quickly reply to bots", "args": { "force_reply": { "description": "True, if the keyboard must force reply to the message with the keyboard", "is_optional": false, "type": "Bool" }, "input_field_placeholder": { "description": "If non-empty, the placeholder to be shown in the input field when the keyboard is active; 0-64 characters", "is_optional": true, "type": "string" }, "is_persistent": { "description": "True, if the keyboard is expected to always be shown when the ordinary keyboard is hidden", "is_optional": false, "type": "Bool" }, "is_personal": { "description": "True, if the keyboard must automatically be shown to the current user. For outgoing messages, specify true to show the keyboard only for the mentioned users and for the target user of a reply", "is_optional": false, "type": "Bool" }, "one_time": { "description": "True, if the application needs to hide the keyboard after use", "is_optional": false, "type": "Bool" }, "resize_keyboard": { "description": "True, if the application needs to resize the keyboard vertically", "is_optional": false, "type": "Bool" }, "rows": { "description": "A list of rows of bot keyboard buttons", "is_optional": false, "type": "vector\u003cvector\u003ckeyboardButton\u003e\u003e" } }, "type": "ReplyMarkup" }, "reportChatResultMessagesRequired": { "description": "The user must choose messages to report and repeat the reportChat request with the chosen messages", "args": {}, "type": "ReportChatResult" }, "reportChatResultOk": { "description": "The chat was reported successfully", "args": {}, "type": "ReportChatResult" }, "reportChatResultOptionRequired": { "description": "The user must choose an option to report the chat and repeat request with the chosen option", "args": { "options": { "description": "List of available options", "is_optional": false, "type": "vector\u003creportOption\u003e" }, "title": { "description": "Title for the option choice", "is_optional": false, "type": "string" } }, "type": "ReportChatResult" }, "reportChatResultTextRequired": { "description": "The user must add additional text details to the report", "args": { "is_optional": { "description": "True, if the user can skip text adding", "is_optional": false, "type": "Bool" }, "option_id": { "description": "Option identifier for the next reportChat request", "is_optional": false, "type": "bytes" } }, "type": "ReportChatResult" }, "reportOption": { "description": "Describes an option to report an entity to Telegram", "args": { "id": { "description": "Unique identifier of the option", "is_optional": false, "type": "bytes" }, "text": { "description": "Text of the option", "is_optional": false, "type": "string" } }, "type": "ReportOption" }, "reportReasonChildAbuse": { "description": "The chat has child abuse related content", "args": {}, "type": "ReportReason" }, "reportReasonCopyright": { "description": "The chat contains copyrighted content", "args": {}, "type": "ReportReason" }, "reportReasonCustom": { "description": "A custom reason provided by the user", "args": {}, "type": "ReportReason" }, "reportReasonFake": { "description": "The chat represents a fake account", "args": {}, "type": "ReportReason" }, "reportReasonIllegalDrugs": { "description": "The chat has illegal drugs related content", "args": {}, "type": "ReportReason" }, "reportReasonPersonalDetails": { "description": "The chat contains messages with personal details", "args": {}, "type": "ReportReason" }, "reportReasonPornography": { "description": "The chat contains pornographic messages", "args": {}, "type": "ReportReason" }, "reportReasonSpam": { "description": "The chat contains spam messages", "args": {}, "type": "ReportReason" }, "reportReasonUnrelatedLocation": { "description": "The location-based chat is unrelated to its stated location", "args": {}, "type": "ReportReason" }, "reportReasonViolence": { "description": "The chat promotes violence", "args": {}, "type": "ReportReason" }, "reportSponsoredResultAdsHidden": { "description": "Sponsored messages were hidden for the user in all chats", "args": {}, "type": "ReportSponsoredResult" }, "reportSponsoredResultFailed": { "description": "The sponsored message is too old or not found", "args": {}, "type": "ReportSponsoredResult" }, "reportSponsoredResultOk": { "description": "The message was reported successfully", "args": {}, "type": "ReportSponsoredResult" }, "reportSponsoredResultOptionRequired": { "description": "The user must choose an option to report the message and repeat request with the chosen option", "args": { "options": { "description": "List of available options", "is_optional": false, "type": "vector\u003creportOption\u003e" }, "title": { "description": "Title for the option choice", "is_optional": false, "type": "string" } }, "type": "ReportSponsoredResult" }, "reportSponsoredResultPremiumRequired": { "description": "The user asked to hide sponsored messages, but Telegram Premium is required for this", "args": {}, "type": "ReportSponsoredResult" }, "reportStoryResultOk": { "description": "The story was reported successfully", "args": {}, "type": "ReportStoryResult" }, "reportStoryResultOptionRequired": { "description": "The user must choose an option to report the story and repeat request with the chosen option", "args": { "options": { "description": "List of available options", "is_optional": false, "type": "vector\u003creportOption\u003e" }, "title": { "description": "Title for the option choice", "is_optional": false, "type": "string" } }, "type": "ReportStoryResult" }, "reportStoryResultTextRequired": { "description": "The user must add additional text details to the report", "args": { "is_optional": { "description": "True, if the user can skip text adding", "is_optional": false, "type": "Bool" }, "option_id": { "description": "Option identifier for the next reportStory request", "is_optional": false, "type": "bytes" } }, "type": "ReportStoryResult" }, "resendCodeReasonUserRequest": { "description": "The user requested to resend the code", "args": {}, "type": "ResendCodeReason" }, "resendCodeReasonVerificationFailed": { "description": "The code is re-sent, because device verification has failed", "args": { "error_message": { "description": "Cause of the verification failure, for example, \"PLAY_SERVICES_NOT_AVAILABLE\", \"APNS_RECEIVE_TIMEOUT\", or \"APNS_INIT_FAILED\"", "is_optional": false, "type": "string" } }, "type": "ResendCodeReason" }, "resetPasswordResultDeclined": { "description": "The password reset request was declined", "args": { "retry_date": { "description": "Point in time (Unix timestamp) when the password reset can be retried", "is_optional": false, "type": "int32" } }, "type": "ResetPasswordResult" }, "resetPasswordResultOk": { "description": "The password was reset", "args": {}, "type": "ResetPasswordResult" }, "resetPasswordResultPending": { "description": "The password reset request is pending", "args": { "pending_reset_date": { "description": "Point in time (Unix timestamp) after which the password can be reset immediately using resetPassword", "is_optional": false, "type": "int32" } }, "type": "ResetPasswordResult" }, "restrictionInfo": { "description": "Contains information about restrictions that must be applied to a chat or a message", "args": { "has_sensitive_content": { "description": "True, if media content of the messages must be hidden with 18+ spoiler.", "is_optional": false, "type": "Bool" }, "restriction_reason": { "description": "A human-readable description of the reason why access to the content must be restricted. If empty, then the content can be accessed,", "is_optional": false, "type": "string" } }, "type": "RestrictionInfo" }, "revenueWithdrawalStateFailed": { "description": "Withdrawal failed", "args": {}, "type": "RevenueWithdrawalState" }, "revenueWithdrawalStatePending": { "description": "Withdrawal is pending", "args": {}, "type": "RevenueWithdrawalState" }, "revenueWithdrawalStateSucceeded": { "description": "Withdrawal succeeded", "args": { "date": { "description": "Point in time (Unix timestamp) when the withdrawal was completed", "is_optional": false, "type": "int32" }, "url": { "description": "The URL where the withdrawal transaction can be viewed", "is_optional": false, "type": "string" } }, "type": "RevenueWithdrawalState" }, "richMessage": { "description": "Describes a message with rich formatting", "args": { "blocks": { "description": "Content of the message", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "is_full": { "description": "True, if the object contains the full message. Otherwise, getFullRichMessage must be used to get the full message", "is_optional": false, "type": "Bool" }, "is_rtl": { "description": "True, if the message must be shown from right to left", "is_optional": false, "type": "Bool" } }, "type": "RichMessage" }, "richMessageSourceBlocks": { "description": "A rich message defined by blocks", "args": { "blocks": { "description": "Content of the message", "is_optional": false, "type": "vector\u003cInputPageBlock\u003e" } }, "type": "RichMessageSource" }, "richMessageSourceHtml": { "description": "An HTML-formatted rich message; for bots only", "args": { "media": { "description": "Media used in the message", "is_optional": false, "type": "vector\u003cinputRichMessageMedia\u003e" }, "text": { "description": "HTML-formatted text of the message", "is_optional": false, "type": "string" } }, "type": "RichMessageSource" }, "richMessageSourceMarkdown": { "description": "A Markdown-formatted rich message; for bots only", "args": { "media": { "description": "Media used in the message", "is_optional": false, "type": "vector\u003cinputRichMessageMedia\u003e" }, "text": { "description": "Markdown-formatted text of the message", "is_optional": false, "type": "string" } }, "type": "RichMessageSource" }, "richTextAnchor": { "description": "An anchor", "args": { "name": { "description": "Anchor name", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextAnchorLink": { "description": "A link to an anchor on the same page", "args": { "anchor_name": { "description": "The anchor name. If the name is empty, the link must bring back to top", "is_optional": false, "type": "string" }, "text": { "description": "The link text", "is_optional": false, "type": "RichText" }, "url": { "description": "An HTTP URL that opens the anchor", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextBankCardNumber": { "description": "A bank card number", "args": { "bank_card_number": { "description": "The number of the bank card", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextBold": { "description": "A bold rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextBotCommand": { "description": "A bot command", "args": { "bot_command": { "description": "The bot command", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextButton": { "description": "A button", "args": { "button": { "description": "The button", "is_optional": false, "type": "inlineButton" } }, "type": "RichText" }, "richTextCashtag": { "description": "A cashtag", "args": { "cashtag": { "description": "The cashtag", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextCustomEmoji": { "description": "A custom emoji", "args": { "alternative_text": { "description": "Alternative text for the custom emoji", "is_optional": false, "type": "string" }, "custom_emoji_id": { "description": "Unique identifier of the custom emoji", "is_optional": false, "type": "int64" } }, "type": "RichText" }, "richTextDateTime": { "description": "A date and time", "args": { "formatting_type": { "description": "Date and time formatting type; may be null if none and the original text must not be changed", "is_optional": true, "type": "DateTimeFormattingType" }, "text": { "description": "Original text", "is_optional": false, "type": "RichText" }, "unix_time": { "description": "Point in time (Unix timestamp) representing the date and time", "is_optional": false, "type": "int32" } }, "type": "RichText" }, "richTextDiff": { "description": "A rich text replacing another rich text; not supported in inputRichMessage", "args": { "old_text": { "description": "The old text", "is_optional": false, "type": "RichText" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextEmailAddress": { "description": "A rich text email address", "args": { "email_address": { "description": "Email address", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextFixed": { "description": "A fixed-width rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextHashtag": { "description": "A hashtag", "args": { "hashtag": { "description": "The hashtag", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextIcon": { "description": "A small image inside the text; instant view only", "args": { "document": { "description": "The image represented as a document. The image can be in GIF, JPEG or PNG format", "is_optional": false, "type": "document" }, "height": { "description": "Height of a bounding box in which the image must be shown; 0 if unknown", "is_optional": false, "type": "int32" }, "width": { "description": "Width of a bounding box in which the image must be shown; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "RichText" }, "richTextItalic": { "description": "An italicized rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextMarked": { "description": "A marked rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextMathematicalExpression": { "description": "A mathematical expression", "args": { "expression": { "description": "The expression in LaTeX format", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextMention": { "description": "A mention of a Telegram user or chat by a username", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" }, "username": { "description": "The username", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextMentionName": { "description": "A rich text that serves as a mention of a user", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" }, "user_id": { "description": "Identifier of the mentioned user", "is_optional": false, "type": "int53" } }, "type": "RichText" }, "richTextPhoneNumber": { "description": "A rich text phone number", "args": { "phone_number": { "description": "Phone number", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextPlain": { "description": "A plain text", "args": { "text": { "description": "Text", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextReference": { "description": "A reference", "args": { "name": { "description": "Reference name", "is_optional": false, "type": "string" }, "text": { "description": "Text of the reference", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextReferenceLink": { "description": "A link to a reference on the same page", "args": { "reference_name": { "description": "The reference name", "is_optional": false, "type": "string" }, "text": { "description": "The link text", "is_optional": false, "type": "RichText" }, "url": { "description": "An HTTP URL that opens the reference", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTextSpoiler": { "description": "A spoilered rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextStrikethrough": { "description": "A strikethrough rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextSubscript": { "description": "A subscript rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextSuperscript": { "description": "A superscript rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextTonAddress": { "description": "An address in the TON blockchain", "args": { "address": { "description": "The address", "is_optional": false, "type": "string" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextUnderline": { "description": "An underlined rich text", "args": { "text": { "description": "Text", "is_optional": false, "type": "RichText" } }, "type": "RichText" }, "richTextUrl": { "description": "A rich text URL link", "args": { "is_cached": { "description": "True, if the URL has cached instant view server-side; instant view only", "is_optional": false, "type": "Bool" }, "text": { "description": "Text", "is_optional": false, "type": "RichText" }, "url": { "description": "URL", "is_optional": false, "type": "string" } }, "type": "RichText" }, "richTexts": { "description": "A concatenation of rich texts", "args": { "texts": { "description": "Texts", "is_optional": false, "type": "vector\u003cRichText\u003e" } }, "type": "RichText" }, "rtmpUrl": { "description": "Represents an RTMP URL", "args": { "stream_key": { "description": "Stream key", "is_optional": false, "type": "string" }, "url": { "description": "The URL", "is_optional": false, "type": "string" } }, "type": "RtmpUrl" }, "savedCredentials": { "description": "Contains information about saved payment credentials", "args": { "id": { "description": "Unique identifier of the saved credentials", "is_optional": false, "type": "string" }, "title": { "description": "Title of the saved credentials", "is_optional": false, "type": "string" } }, "type": "SavedCredentials" }, "savedMessagesTag": { "description": "Represents a tag used in Saved Messages or a Saved Messages topic", "args": { "count": { "description": "Number of times the tag was used; may be 0 if the tag has non-empty label", "is_optional": false, "type": "int32" }, "label": { "description": "Label of the tag; 0-12 characters. Always empty if the tag is returned for a Saved Messages topic", "is_optional": false, "type": "string" }, "tag": { "description": "The tag", "is_optional": false, "type": "ReactionType" } }, "type": "SavedMessagesTag" }, "savedMessagesTags": { "description": "Contains a list of tags used in Saved Messages", "args": { "tags": { "description": "List of tags", "is_optional": false, "type": "vector\u003csavedMessagesTag\u003e" } }, "type": "SavedMessagesTags" }, "savedMessagesTopic": { "description": "Contains information about a Saved Messages topic", "args": { "draft_message": { "description": "A draft of a message in the topic; may be null if none", "is_optional": true, "type": "draftMessage" }, "id": { "description": "Unique topic identifier", "is_optional": false, "type": "int53" }, "is_pinned": { "description": "True, if the topic is pinned", "is_optional": false, "type": "Bool" }, "last_message": { "description": "Last message in the topic; may be null if none or unknown", "is_optional": true, "type": "message" }, "order": { "description": "A parameter used to determine order of the topic in the topic list. Topics must be sorted by the order in descending order", "is_optional": false, "type": "int64" }, "type": { "description": "Type of the topic", "is_optional": false, "type": "SavedMessagesTopicType" } }, "type": "SavedMessagesTopic" }, "savedMessagesTopicTypeAuthorHidden": { "description": "Topic containing messages forwarded from a user with hidden privacy", "args": {}, "type": "SavedMessagesTopicType" }, "savedMessagesTopicTypeMyNotes": { "description": "Topic containing messages sent by the current user of forwarded from an unknown chat", "args": {}, "type": "SavedMessagesTopicType" }, "savedMessagesTopicTypeSavedFromChat": { "description": "Topic containing messages forwarded from a specific chat", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "SavedMessagesTopicType" }, "scopeAutosaveSettings": { "description": "Contains autosave settings for an autosave settings scope", "args": { "autosave_photos": { "description": "True, if photo autosave is enabled", "is_optional": false, "type": "Bool" }, "autosave_videos": { "description": "True, if video autosave is enabled", "is_optional": false, "type": "Bool" }, "max_video_file_size": { "description": "The maximum size of a video file to be autosaved, in bytes; 512 KB - 4000 MB", "is_optional": false, "type": "int53" } }, "type": "ScopeAutosaveSettings" }, "scopeNotificationSettings": { "description": "Contains information about notification settings for several chats", "args": { "disable_mention_notifications": { "description": "True, if notifications for messages with mentions will be created as for an ordinary unread message", "is_optional": false, "type": "Bool" }, "disable_pinned_message_notifications": { "description": "True, if notifications for incoming pinned messages will be created as for an ordinary unread message", "is_optional": false, "type": "Bool" }, "mute_for": { "description": "Time left before notifications will be unmuted, in seconds", "is_optional": false, "type": "int32" }, "mute_stories": { "description": "True, if story notifications are disabled", "is_optional": false, "type": "Bool" }, "show_preview": { "description": "True, if message content must be displayed in notifications", "is_optional": false, "type": "Bool" }, "show_story_poster": { "description": "True, if the chat that posted a story must be displayed in notifications", "is_optional": false, "type": "Bool" }, "sound_id": { "description": "Identifier of the notification sound to be played; 0 if sound is disabled; pass -1 to use the app-dependent default sound", "is_optional": false, "type": "int64" }, "story_sound_id": { "description": "Identifier of the notification sound to be played for stories; 0 if sound is disabled; pass -1 to use the app-dependent default sound", "is_optional": false, "type": "int64" }, "use_default_mute_stories": { "description": "If true, story notifications are received only for the first 5 chats from topChatCategoryUsers regardless of the value of mute_stories", "is_optional": false, "type": "Bool" } }, "type": "ScopeNotificationSettings" }, "searchChatTypeFilterBot": { "description": "Returns only private chats with bots", "args": {}, "type": "SearchChatTypeFilter" }, "searchChatTypeFilterChannel": { "description": "Returns only channel chats", "args": {}, "type": "SearchChatTypeFilter" }, "searchMessagesChatTypeFilterChannel": { "description": "Returns only messages in channel chats", "args": {}, "type": "SearchMessagesChatTypeFilter" }, "searchMessagesChatTypeFilterCommunity": { "description": "Returns only messages in the specified community", "args": { "community_id": { "description": "Identifier of the community to search in", "is_optional": false, "type": "int53" } }, "type": "SearchMessagesChatTypeFilter" }, "searchMessagesChatTypeFilterGroup": { "description": "Returns only messages in basic group and supergroup chats", "args": {}, "type": "SearchMessagesChatTypeFilter" }, "searchMessagesChatTypeFilterPrivate": { "description": "Returns only messages in private chats", "args": {}, "type": "SearchMessagesChatTypeFilter" }, "searchMessagesFilterAnimation": { "description": "Returns only animation messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterAudio": { "description": "Returns only audio messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterChatPhoto": { "description": "Returns only messages containing chat photos", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterDocument": { "description": "Returns only document messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterEmpty": { "description": "Returns all found messages, no filter is applied", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterFailedToSend": { "description": "Returns only failed to send messages. This filter can be used only if the message database is used", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterMention": { "description": "Returns only messages with mentions of the current user, or messages that are replies to their messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterPhoto": { "description": "Returns only photo messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterPhotoAndVideo": { "description": "Returns only photo and video messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterPinned": { "description": "Returns only pinned messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterPoll": { "description": "Returns only poll messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterUnreadMention": { "description": "Returns only messages with unread mentions of the current user, or messages that are replies to their messages. When using this filter the results can't be additionally filtered by a query or by the sending user", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterUnreadPollVote": { "description": "Returns only messages with unread poll votes for the current user. When using this filter the results can't be additionally filtered by a query or by the sending user", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterUnreadReaction": { "description": "Returns only messages with unread reactions for the current user. When using this filter the results can't be additionally filtered by a query or by the sending user", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterUrl": { "description": "Returns only messages containing URLs", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterVideo": { "description": "Returns only video messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterVideoNote": { "description": "Returns only video note messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterVoiceAndVideoNote": { "description": "Returns only voice and video note messages", "args": {}, "type": "SearchMessagesFilter" }, "searchMessagesFilterVoiceNote": { "description": "Returns only voice note messages", "args": {}, "type": "SearchMessagesFilter" }, "seconds": { "description": "Contains a value representing a number of seconds", "args": { "seconds": { "description": "Number of seconds", "is_optional": false, "type": "double" } }, "type": "Seconds" }, "secretChat": { "description": "Represents a secret chat", "args": { "id": { "description": "Secret chat identifier", "is_optional": false, "type": "int32" }, "is_outbound": { "description": "True, if the chat was created by the current user; false otherwise", "is_optional": false, "type": "Bool" }, "key_hash": { "description": "Hash of the currently used key for comparison with the hash of the chat partner's key. This is a string of 36 little-endian bytes, which must be split into groups of 2 bits, each denoting a pixel of one of 4 colors FFFFFF, D5E6F3, 2D5775, and 2F99C9.", "is_optional": false, "type": "bytes" }, "layer": { "description": "Secret chat layer; determines features supported by the chat partner's application. Nested text entities and underline and strikethrough entities are supported if the layer \u003e= 101,", "is_optional": false, "type": "int32" }, "state": { "description": "State of the secret chat", "is_optional": false, "type": "SecretChatState" }, "user_id": { "description": "Identifier of the chat partner", "is_optional": false, "type": "int53" } }, "type": "SecretChat" }, "secretChatStateClosed": { "description": "The secret chat is closed", "args": {}, "type": "SecretChatState" }, "secretChatStatePending": { "description": "The secret chat is not yet created; waiting for the other user to get online", "args": {}, "type": "SecretChatState" }, "secretChatStateReady": { "description": "The secret chat is ready to use", "args": {}, "type": "SecretChatState" }, "sentGiftRegular": { "description": "Regular gift", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" } }, "type": "SentGift" }, "sentGiftUpgraded": { "description": "Upgraded gift", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" } }, "type": "SentGift" }, "session": { "description": "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", "args": { "api_id": { "description": "Telegram API identifier, as provided by the application", "is_optional": false, "type": "int32" }, "application_name": { "description": "Name of the application, as provided by the application", "is_optional": false, "type": "string" }, "application_version": { "description": "The version of the application, as provided by the application", "is_optional": false, "type": "string" }, "can_accept_calls": { "description": "True, if incoming calls can be accepted by the session", "is_optional": false, "type": "Bool" }, "can_accept_secret_chats": { "description": "True, if incoming secret chats can be accepted by the session", "is_optional": false, "type": "Bool" }, "device_model": { "description": "Model of the device the application has been run or is running on, as provided by the application", "is_optional": false, "type": "string" }, "device_type": { "description": "Session device type based on the system and application version, which can be used to display a corresponding icon", "is_optional": false, "type": "SessionDeviceType" }, "id": { "description": "Session identifier", "is_optional": false, "type": "int64" }, "ip_address": { "description": "IP address from which the session was created, in human-readable format", "is_optional": false, "type": "string" }, "is_current": { "description": "True, if this session is the current session", "is_optional": false, "type": "Bool" }, "is_official_application": { "description": "True, if the application is an official application or uses the api_id of an official application", "is_optional": false, "type": "Bool" }, "is_password_pending": { "description": "True, if a 2-step verification password is needed to complete authorization of the session", "is_optional": false, "type": "Bool" }, "is_unconfirmed": { "description": "True, if the session wasn't confirmed from another session", "is_optional": false, "type": "Bool" }, "last_active_date": { "description": "Point in time (Unix timestamp) when the session was last used", "is_optional": false, "type": "int32" }, "location": { "description": "A human-readable description of the location from which the session was created, based on the IP address", "is_optional": false, "type": "string" }, "log_in_date": { "description": "Point in time (Unix timestamp) when the user has logged in", "is_optional": false, "type": "int32" }, "platform": { "description": "Operating system the application has been run or is running on, as provided by the application", "is_optional": false, "type": "string" }, "system_version": { "description": "Version of the operating system the application has been run or is running on, as provided by the application", "is_optional": false, "type": "string" } }, "type": "Session" }, "sessionDeviceTypeAndroid": { "description": "The session is running on an Android device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeApple": { "description": "The session is running on a generic Apple device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeBrave": { "description": "The session is running on the Brave browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeChrome": { "description": "The session is running on the Chrome browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeEdge": { "description": "The session is running on the Edge browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeFirefox": { "description": "The session is running on the Firefox browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeIpad": { "description": "The session is running on an iPad device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeIphone": { "description": "The session is running on an iPhone device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeLinux": { "description": "The session is running on a Linux device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeMac": { "description": "The session is running on a Mac device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeOpera": { "description": "The session is running on the Opera browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeSafari": { "description": "The session is running on the Safari browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeUbuntu": { "description": "The session is running on an Ubuntu device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeUnknown": { "description": "The session is running on an unknown type of device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeVivaldi": { "description": "The session is running on the Vivaldi browser", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeWindows": { "description": "The session is running on a Windows device", "args": {}, "type": "SessionDeviceType" }, "sessionDeviceTypeXbox": { "description": "The session is running on an Xbox console", "args": {}, "type": "SessionDeviceType" }, "sessionTypeConnectedBot": { "description": "A business bot connected to the current user's account", "args": { "bot_user_id": { "description": "User identifier of the bot. Use deleteBusinessConnectedBot to remove it or confirmBusinessConnectedBot to confirm it if it isn't confirmed yet", "is_optional": false, "type": "int53" } }, "type": "SessionType" }, "sessionTypeDevice": { "description": "A regular session from a device", "args": { "session_id": { "description": "Unique identifier of the session. Use terminateSession to terminate it or confirmSession to confirm it if it isn't confirmed yet", "is_optional": false, "type": "int64" } }, "type": "SessionType" }, "sessions": { "description": "Contains a list of sessions", "args": { "inactive_session_ttl_days": { "description": "Number of days of inactivity before sessions will automatically be terminated; 1-366 days", "is_optional": false, "type": "int32" }, "sessions": { "description": "List of sessions", "is_optional": false, "type": "vector\u003csession\u003e" } }, "type": "Sessions" }, "settingsSectionAppearance": { "description": "The appearance section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionAskQuestion": { "description": "The \"Ask a question\" section", "args": {}, "type": "SettingsSection" }, "settingsSectionBusiness": { "description": "The \"Telegram Business\" section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionChatFolders": { "description": "The chat folder settings section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionDataAndStorage": { "description": "The data and storage settings section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionDevices": { "description": "The Devices section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionEditProfile": { "description": "The profile edit section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionFaq": { "description": "The FAQ section", "args": {}, "type": "SettingsSection" }, "settingsSectionFeatures": { "description": "The \"Telegram Features\" section", "args": {}, "type": "SettingsSection" }, "settingsSectionInAppBrowser": { "description": "The in-app browser settings section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionLanguage": { "description": "The application language section", "args": { "subsection": { "description": "Subsection of the section; may be one of \"\", \"show-button\" for Show Translate Button toggle,", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionMyGrams": { "description": "The TON Gram balance and transaction section", "args": {}, "type": "SettingsSection" }, "settingsSectionMyStars": { "description": "The Telegram Star balance and transaction section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionNotifications": { "description": "The notification settings section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionPowerSaving": { "description": "The power saving settings section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionPremium": { "description": "The \"Telegram Premium\" section", "args": {}, "type": "SettingsSection" }, "settingsSectionPrivacyAndSecurity": { "description": "The privacy and security section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionPrivacyPolicy": { "description": "The \"Privacy Policy\" section", "args": {}, "type": "SettingsSection" }, "settingsSectionQrCode": { "description": "The current user's QR code section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "settingsSectionSearch": { "description": "Search in Settings", "args": {}, "type": "SettingsSection" }, "settingsSectionSendGift": { "description": "The \"Send a gift\" section", "args": { "subsection": { "description": "Subsection of the section; may be one of", "is_optional": false, "type": "string" } }, "type": "SettingsSection" }, "sharedChat": { "description": "Contains information about a chat shared with a bot", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "photo": { "description": "Photo of the chat; for bots only; may be null", "is_optional": true, "type": "photo" }, "title": { "description": "Title of the chat; for bots only", "is_optional": false, "type": "string" }, "username": { "description": "Username of the chat; for bots only", "is_optional": false, "type": "string" } }, "type": "SharedChat" }, "sharedUser": { "description": "Contains information about a user shared with a bot", "args": { "first_name": { "description": "First name of the user; for bots only", "is_optional": false, "type": "string" }, "last_name": { "description": "Last name of the user; for bots only", "is_optional": false, "type": "string" }, "photo": { "description": "Profile photo of the user; for bots only; may be null", "is_optional": true, "type": "photo" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" }, "username": { "description": "Username of the user; for bots only", "is_optional": false, "type": "string" } }, "type": "SharedUser" }, "shippingOption": { "description": "One shipping option", "args": { "id": { "description": "Shipping option identifier", "is_optional": false, "type": "string" }, "price_parts": { "description": "A list of objects used to calculate the total shipping costs", "is_optional": false, "type": "vector\u003clabeledPricePart\u003e" }, "title": { "description": "Option title", "is_optional": false, "type": "string" } }, "type": "ShippingOption" }, "speechRecognitionResultError": { "description": "The speech recognition failed", "args": { "error": { "description": "Recognition error. An error with a message \"MSG_VOICE_TOO_LONG\" is returned when media duration is too big to be recognized", "is_optional": false, "type": "error" } }, "type": "SpeechRecognitionResult" }, "speechRecognitionResultPending": { "description": "The speech recognition is ongoing", "args": { "partial_text": { "description": "Partially recognized text", "is_optional": false, "type": "string" } }, "type": "SpeechRecognitionResult" }, "speechRecognitionResultText": { "description": "The speech recognition successfully finished", "args": { "text": { "description": "Recognized text", "is_optional": false, "type": "string" } }, "type": "SpeechRecognitionResult" }, "sponsoredChat": { "description": "Describes a sponsored chat", "args": { "additional_info": { "description": "If non-empty, additional information about the sponsored chat to be shown along with the chat", "is_optional": true, "type": "string" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "sponsor_info": { "description": "Additional optional information about the sponsor to be shown along with the chat", "is_optional": false, "type": "string" }, "unique_id": { "description": "Unique identifier of this result", "is_optional": false, "type": "int53" } }, "type": "SponsoredChat" }, "sponsoredChats": { "description": "Contains a list of sponsored chats", "args": { "chats": { "description": "List of sponsored chats", "is_optional": false, "type": "vector\u003csponsoredChat\u003e" } }, "type": "SponsoredChats" }, "sponsoredMessage": { "description": "Describes a sponsored message", "args": { "accent_color_id": { "description": "Identifier of the accent color for title, button text and message background", "is_optional": false, "type": "int32" }, "additional_info": { "description": "If non-empty, additional information about the sponsored message to be shown along with the message", "is_optional": true, "type": "string" }, "background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the message background; 0 if none", "is_optional": false, "type": "int64" }, "button_text": { "description": "Text for the message action button", "is_optional": false, "type": "string" }, "can_be_reported": { "description": "True, if the message can be reported to Telegram moderators through reportChatSponsoredMessage", "is_optional": false, "type": "Bool" }, "content": { "description": "Content of the message. Currently, can be only of the types messageText, messageAnimation, messagePhoto, or messageVideo. Video messages can be viewed fullscreen.", "is_optional": false, "type": "MessageContent" }, "is_recommended": { "description": "True, if the message needs to be labeled as \"recommended\" instead of \"sponsored\"", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages", "is_optional": false, "type": "int53" }, "sponsor": { "description": "Information about the sponsor of the message", "is_optional": false, "type": "advertisementSponsor" }, "title": { "description": "Title of the sponsored message", "is_optional": false, "type": "string" } }, "type": "SponsoredMessage" }, "sponsoredMessages": { "description": "Contains a list of sponsored messages", "args": { "messages": { "description": "List of sponsored messages", "is_optional": false, "type": "vector\u003csponsoredMessage\u003e" }, "messages_between": { "description": "The minimum number of messages between shown sponsored messages, or 0 if only one sponsored message must be shown after all ordinary messages", "is_optional": false, "type": "int32" } }, "type": "SponsoredMessages" }, "stakeDiceState": { "description": "Describes state of the stake dice", "args": { "current_streak": { "description": "The number of rolled sixes towards the streak; 0-2", "is_optional": false, "type": "int32" }, "prize_per_mille": { "description": "The number of Grams received by the user for each 1000 Grams staked if the dice outcome is 1-6 correspondingly; may be empty if the stake dice can't be sent by the current user", "is_optional": true, "type": "vector\u003cint32\u003e" }, "stake_gram_amount": { "description": "The amount of TON Grams staked in the previous roll; in the smallest units of the currency", "is_optional": false, "type": "int53" }, "state_hash": { "description": "Hash of the state to use for sending the next dice; may be empty if the stake dice can't be sent by the current user", "is_optional": true, "type": "string" }, "streak_prize_per_mille": { "description": "The number of Grams received by the user for each 1000 Grams staked if the dice outcome is 6 three times in a row with the same stake", "is_optional": false, "type": "int32" }, "suggested_stake_gram_amounts": { "description": "The amounts of Grams that are suggested to be staked; in the smallest units of the currency", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "StakeDiceState" }, "starAmount": { "description": "Describes a possibly non-integer Telegram Star amount", "args": { "nanostar_count": { "description": "The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999", "is_optional": false, "type": "int32" }, "star_count": { "description": "The integer Telegram Star amount rounded to 0", "is_optional": false, "type": "int53" } }, "type": "StarAmount" }, "starCount": { "description": "Contains a number of Telegram Stars", "args": { "star_count": { "description": "Number of Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "StarCount" }, "starGiveawayPaymentOption": { "description": "Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments", "args": { "amount": { "description": "The amount to pay, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code for the payment", "is_optional": false, "type": "string" }, "is_additional": { "description": "True, if the option must be shown only in the full list of payment options", "is_optional": false, "type": "Bool" }, "is_default": { "description": "True, if the option must be chosen by default", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars that will be distributed among winners", "is_optional": false, "type": "int53" }, "store_product_id": { "description": "Identifier of the store product associated with the option; may be empty if none", "is_optional": true, "type": "string" }, "winner_options": { "description": "Allowed options for the number of giveaway winners", "is_optional": false, "type": "vector\u003cstarGiveawayWinnerOption\u003e" }, "yearly_boost_count": { "description": "Number of times the chat will be boosted for one year if the option is chosen", "is_optional": false, "type": "int32" } }, "type": "StarGiveawayPaymentOption" }, "starGiveawayPaymentOptions": { "description": "Contains a list of options for creating of Telegram Star giveaway", "args": { "options": { "description": "The list of options", "is_optional": false, "type": "vector\u003cstarGiveawayPaymentOption\u003e" } }, "type": "StarGiveawayPaymentOptions" }, "starGiveawayWinnerOption": { "description": "Describes an option for the number of winners of a Telegram Star giveaway", "args": { "is_default": { "description": "True, if the option must be chosen by default", "is_optional": false, "type": "Bool" }, "winner_count": { "description": "The number of users that will be chosen as winners", "is_optional": false, "type": "int32" }, "won_star_count": { "description": "The number of Telegram Stars that will be won by the winners of the giveaway", "is_optional": false, "type": "int53" } }, "type": "StarGiveawayWinnerOption" }, "starPaymentOption": { "description": "Describes an option for buying Telegram Stars. Use telegramPaymentPurposeStars for out-of-store payments", "args": { "amount": { "description": "The amount to pay, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code for the payment", "is_optional": false, "type": "string" }, "is_additional": { "description": "True, if the option must be shown only in the full list of payment options", "is_optional": false, "type": "Bool" }, "star_count": { "description": "Number of Telegram Stars that will be purchased", "is_optional": false, "type": "int53" }, "store_product_id": { "description": "Identifier of the store product associated with the option; may be empty if none", "is_optional": true, "type": "string" } }, "type": "StarPaymentOption" }, "starPaymentOptions": { "description": "Contains a list of options for buying Telegram Stars", "args": { "options": { "description": "The list of options", "is_optional": false, "type": "vector\u003cstarPaymentOption\u003e" } }, "type": "StarPaymentOptions" }, "starRevenueStatistics": { "description": "A detailed statistics about Telegram Stars earned by a user or a chat", "args": { "revenue_by_day_graph": { "description": "A graph containing amount of revenue in a given day", "is_optional": false, "type": "StatisticalGraph" }, "status": { "description": "Telegram Star revenue status", "is_optional": false, "type": "starRevenueStatus" }, "usd_rate": { "description": "Current exchange rate of a Telegram Star to USD", "is_optional": false, "type": "double" } }, "type": "StarRevenueStatistics" }, "starRevenueStatus": { "description": "Contains information about Telegram Stars earned by a user or a chat", "args": { "available_amount": { "description": "The Telegram Star amount that is available for withdrawal", "is_optional": false, "type": "starAmount" }, "current_amount": { "description": "The Telegram Star amount that isn't withdrawn yet", "is_optional": false, "type": "starAmount" }, "next_withdrawal_in": { "description": "Time left before the next withdrawal can be started, in seconds; 0 if withdrawal can be started now", "is_optional": false, "type": "int32" }, "total_amount": { "description": "Total Telegram Star amount earned", "is_optional": false, "type": "starAmount" }, "withdrawal_enabled": { "description": "True, if Telegram Stars can be withdrawn now or later", "is_optional": false, "type": "Bool" } }, "type": "StarRevenueStatus" }, "starSubscription": { "description": "Contains information about subscription to a channel chat, a bot, or a business account that was paid in Telegram Stars", "args": { "chat_id": { "description": "Identifier of the chat that is subscribed", "is_optional": false, "type": "int53" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the subscription will expire or expired", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the subscription", "is_optional": false, "type": "string" }, "is_canceled": { "description": "True, if the subscription was canceled", "is_optional": false, "type": "Bool" }, "is_expiring": { "description": "True, if the subscription expires soon and there aren't enough Telegram Stars on the user's balance to extend it", "is_optional": false, "type": "Bool" }, "pricing": { "description": "The subscription plan", "is_optional": false, "type": "starSubscriptionPricing" }, "type": { "description": "Type of the subscription", "is_optional": false, "type": "StarSubscriptionType" } }, "type": "StarSubscription" }, "starSubscriptionPricing": { "description": "Describes subscription plan paid in Telegram Stars", "args": { "period": { "description": "The number of seconds between consecutive Telegram Star debiting", "is_optional": false, "type": "int32" }, "star_count": { "description": "The Telegram Star amount that must be paid for each period", "is_optional": false, "type": "int53" } }, "type": "StarSubscriptionPricing" }, "starSubscriptionTypeBot": { "description": "Describes a subscription in a bot or a business account", "args": { "invoice_link": { "description": "The link to the subscription invoice", "is_optional": false, "type": "string" }, "is_canceled_by_bot": { "description": "True, if the subscription was canceled by the bot and can't be extended", "is_optional": false, "type": "Bool" }, "photo": { "description": "Subscription invoice photo", "is_optional": false, "type": "photo" }, "title": { "description": "Subscription invoice title", "is_optional": false, "type": "string" } }, "type": "StarSubscriptionType" }, "starSubscriptionTypeChannel": { "description": "Describes a subscription to a channel chat", "args": { "can_reuse": { "description": "True, if the subscription is active and the user can use the method reuseStarSubscription to join the subscribed chat again", "is_optional": false, "type": "Bool" }, "invite_link": { "description": "The invite link that can be used to renew the subscription if it has expired; may be empty if the link isn't available anymore", "is_optional": true, "type": "string" } }, "type": "StarSubscriptionType" }, "starSubscriptions": { "description": "Represents a list of Telegram Star subscriptions", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "required_star_count": { "description": "The number of Telegram Stars required to buy to extend subscriptions expiring soon", "is_optional": false, "type": "int53" }, "star_amount": { "description": "The amount of owned Telegram Stars", "is_optional": false, "type": "starAmount" }, "subscriptions": { "description": "List of subscriptions for Telegram Stars", "is_optional": false, "type": "vector\u003cstarSubscription\u003e" } }, "type": "StarSubscriptions" }, "starTransaction": { "description": "Represents a transaction changing the amount of owned Telegram Stars", "args": { "date": { "description": "Point in time (Unix timestamp) when the transaction was completed", "is_optional": false, "type": "int32" }, "id": { "description": "Unique identifier of the transaction", "is_optional": false, "type": "string" }, "is_refund": { "description": "True, if the transaction is a refund of a previous transaction", "is_optional": false, "type": "Bool" }, "star_amount": { "description": "The amount of added owned Telegram Stars; negative for outgoing transactions", "is_optional": false, "type": "starAmount" }, "type": { "description": "Type of the transaction", "is_optional": false, "type": "StarTransactionType" } }, "type": "StarTransaction" }, "starTransactionTypeAffiliateProgramCommission": { "description": "The transaction is a receiving of a commission from an affiliate program; relevant for regular users, bots and channel chats only", "args": { "chat_id": { "description": "Identifier of the chat that created the affiliate program", "is_optional": false, "type": "int53" }, "commission_per_mille": { "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the program owner", "is_optional": false, "type": "int32" } }, "type": "StarTransactionType" }, "starTransactionTypeAppStoreDeposit": { "description": "The transaction is a deposit of Telegram Stars from App Store; relevant for regular users only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypeBotInvoicePurchase": { "description": "The transaction is a purchase of a product from a bot or a business account by the current user; relevant for regular users only", "args": { "product_info": { "description": "Information about the bought product", "is_optional": false, "type": "productInfo" }, "user_id": { "description": "Identifier of the bot or the business account user who created the invoice", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBotInvoiceSale": { "description": "The transaction is a sale of a product by the bot; relevant for bots only", "args": { "affiliate": { "description": "Information about the affiliate which received commission from the transaction; may be null if none", "is_optional": true, "type": "affiliateInfo" }, "invoice_payload": { "description": "Invoice payload", "is_optional": false, "type": "bytes" }, "product_info": { "description": "Information about the bought product", "is_optional": false, "type": "productInfo" }, "user_id": { "description": "Identifier of the user who bought the product", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBotPaidMediaPurchase": { "description": "The transaction is a purchase of paid media from a bot or a business account by the current user; relevant for regular users only", "args": { "media": { "description": "The bought media if the transaction wasn't refunded", "is_optional": false, "type": "vector\u003cPaidMedia\u003e" }, "user_id": { "description": "Identifier of the bot or the business account user who sent the paid media", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBotPaidMediaSale": { "description": "The transaction is a sale of paid media by the bot or a business account managed by the bot; relevant for bots only", "args": { "affiliate": { "description": "Information about the affiliate which received commission from the transaction; may be null if none", "is_optional": true, "type": "affiliateInfo" }, "media": { "description": "The bought media", "is_optional": false, "type": "vector\u003cPaidMedia\u003e" }, "payload": { "description": "Bot-provided payload", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user who bought the media", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBotSubscriptionPurchase": { "description": "The transaction is a purchase of a subscription from a bot or a business account by the current user; relevant for regular users only", "args": { "product_info": { "description": "Information about the bought subscription; may be null if no information about the subscription is available", "is_optional": true, "type": "productInfo" }, "subscription_period": { "description": "The number of seconds between consecutive Telegram Star debitings", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of the bot or the business account user who created the subscription link", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBotSubscriptionSale": { "description": "The transaction is a sale of a subscription by the bot; relevant for bots only", "args": { "affiliate": { "description": "Information about the affiliate which received commission from the transaction; may be null if none", "is_optional": true, "type": "affiliateInfo" }, "invoice_payload": { "description": "Invoice payload", "is_optional": false, "type": "bytes" }, "product_info": { "description": "Information about the bought subscription; may be null if no information about the subscription is available", "is_optional": true, "type": "productInfo" }, "subscription_period": { "description": "The number of seconds between consecutive Telegram Star debitings", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of the user who bought the subscription", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBusinessBotTransferReceive": { "description": "The transaction is a transfer of Telegram Stars from a business account; relevant for bots only", "args": { "user_id": { "description": "Identifier of the user who sent Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeBusinessBotTransferSend": { "description": "The transaction is a transfer of Telegram Stars to a business bot; relevant for regular users only", "args": { "user_id": { "description": "Identifier of the bot that received Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelPaidMediaPurchase": { "description": "The transaction is a purchase of paid media from a channel by the current user; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the channel chat that sent the paid media", "is_optional": false, "type": "int53" }, "media": { "description": "The bought media if the transaction wasn't refunded", "is_optional": false, "type": "vector\u003cPaidMedia\u003e" }, "message_id": { "description": "Identifier of the corresponding message with paid media; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelPaidMediaSale": { "description": "The transaction is a sale of paid media by the channel chat; relevant for channel chats only", "args": { "media": { "description": "The bought media", "is_optional": false, "type": "vector\u003cPaidMedia\u003e" }, "message_id": { "description": "Identifier of the corresponding message with paid media; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user who bought the media", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelPaidReactionReceive": { "description": "The transaction is a receiving of a paid reaction to a message by the channel chat; relevant for channel chats only", "args": { "message_id": { "description": "Identifier of the reacted message; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user who added the paid reaction", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelPaidReactionSend": { "description": "The transaction is a sending of a paid reaction to a message in a channel chat by the current user; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the channel chat", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the reacted message; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelSubscriptionPurchase": { "description": "The transaction is a purchase of a subscription to a channel chat by the current user; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the channel chat that created the subscription", "is_optional": false, "type": "int53" }, "subscription_period": { "description": "The number of seconds between consecutive Telegram Star debitings", "is_optional": false, "type": "int32" } }, "type": "StarTransactionType" }, "starTransactionTypeChannelSubscriptionSale": { "description": "The transaction is a sale of a subscription by the channel chat; relevant for channel chats only", "args": { "subscription_period": { "description": "The number of seconds between consecutive Telegram Star debitings", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of the user who bought the subscription", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeFragmentDeposit": { "description": "The transaction is a deposit of Telegram Stars from Fragment; relevant for regular users and bots only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypeFragmentWithdrawal": { "description": "The transaction is a withdrawal of earned Telegram Stars to Fragment; relevant for regular users, bots, supergroup and channel chats only", "args": { "withdrawal_state": { "description": "State of the withdrawal; may be null for refunds from Fragment", "is_optional": true, "type": "RevenueWithdrawalState" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftAuctionBid": { "description": "The transaction is a bid on a gift auction; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "owner_id": { "description": "Identifier of the user who will receive the gift", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftOriginalDetailsDrop": { "description": "The transaction is a drop of original details of an upgraded gift; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "owner_id": { "description": "Identifier of the user or the channel that owns the gift", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftPurchase": { "description": "The transaction is a purchase of a regular gift; relevant for regular users and bots only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "owner_id": { "description": "Identifier of the user or the channel that received the gift", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftPurchaseOffer": { "description": "The transaction is an offer of gift purchase; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftSale": { "description": "The transaction is a sale of a received gift; relevant for regular users and channel chats only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "user_id": { "description": "Identifier of the user who sent the gift", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftTransfer": { "description": "The transaction is a transfer of an upgraded gift; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "owner_id": { "description": "Identifier of the user or the channel that received the gift", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftUpgrade": { "description": "The transaction is an upgrade of a gift; relevant for regular users only", "args": { "gift": { "description": "The upgraded gift", "is_optional": false, "type": "upgradedGift" }, "user_id": { "description": "Identifier of the user who initially sent the gift", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeGiftUpgradePurchase": { "description": "The transaction is a purchase of an upgrade of a gift owned by another user or channel; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "gift" }, "owner_id": { "description": "Owner of the upgraded gift", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypeGiveawayDeposit": { "description": "The transaction is a deposit of Telegram Stars from a giveaway; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of a supergroup or a channel chat that created the giveaway", "is_optional": false, "type": "int53" }, "giveaway_message_id": { "description": "Identifier of the message with the giveaway; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeGooglePlayDeposit": { "description": "The transaction is a deposit of Telegram Stars from Google Play; relevant for regular users only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypePaidGroupCallMessageReceive": { "description": "The transaction is a receiving of a paid group call message; relevant for regular users and channel chats only", "args": { "commission_per_mille": { "description": "The number of Telegram Stars received by the Telegram for each 1000 Telegram Stars paid for message sending", "is_optional": false, "type": "int32" }, "commission_star_amount": { "description": "The Telegram Star amount that was received by Telegram; can be negative for refunds", "is_optional": false, "type": "starAmount" }, "sender_id": { "description": "Identifier of the sender of the message", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypePaidGroupCallMessageSend": { "description": "The transaction is a sending of a paid group call message; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the chat that received the payment", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypePaidGroupCallReactionReceive": { "description": "The transaction is a receiving of a paid group call reaction; relevant for regular users and channel chats only", "args": { "commission_per_mille": { "description": "The number of Telegram Stars received by the Telegram for each 1000 Telegram Stars paid for reaction sending", "is_optional": false, "type": "int32" }, "commission_star_amount": { "description": "The Telegram Star amount that was received by Telegram; can be negative for refunds", "is_optional": false, "type": "starAmount" }, "sender_id": { "description": "Identifier of the sender of the reaction", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypePaidGroupCallReactionSend": { "description": "The transaction is a sending of a paid group reaction; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the chat that received the payment", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypePaidMessageReceive": { "description": "The transaction is a receiving of a paid message; relevant for regular users, supergroup and channel chats only", "args": { "commission_per_mille": { "description": "The number of Telegram Stars received by the Telegram for each 1000 Telegram Stars paid for message sending", "is_optional": false, "type": "int32" }, "commission_star_amount": { "description": "The Telegram Star amount that was received by Telegram; can be negative for refunds", "is_optional": false, "type": "starAmount" }, "message_count": { "description": "Number of received paid messages", "is_optional": false, "type": "int32" }, "sender_id": { "description": "Identifier of the sender of the message", "is_optional": false, "type": "MessageSender" } }, "type": "StarTransactionType" }, "starTransactionTypePaidMessageSend": { "description": "The transaction is a sending of a paid message; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the chat that received the payment", "is_optional": false, "type": "int53" }, "message_count": { "description": "Number of sent paid messages", "is_optional": false, "type": "int32" } }, "type": "StarTransactionType" }, "starTransactionTypePremiumBotDeposit": { "description": "The transaction is a deposit of Telegram Stars from the Premium bot; relevant for regular users only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypePremiumPurchase": { "description": "The transaction is a purchase of Telegram Premium subscription; relevant for regular users and bots only", "args": { "month_count": { "description": "Number of months the Telegram Premium subscription will be active", "is_optional": false, "type": "int32" }, "sticker": { "description": "A sticker to be shown in the transaction information; may be null if unknown", "is_optional": true, "type": "sticker" }, "user_id": { "description": "Identifier of the user who received the Telegram Premium subscription", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypePublicPostSearch": { "description": "The transaction is a payment for search of posts in public Telegram channels; relevant for regular users only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypeSuggestedPostPaymentReceive": { "description": "The transaction is a receiving of a payment for a suggested post by the channel chat; relevant for channel chats only", "args": { "user_id": { "description": "Identifier of the user who paid for the suggested post", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeSuggestedPostPaymentSend": { "description": "The transaction is a payment for a suggested post; relevant for regular users only", "args": { "chat_id": { "description": "Identifier of the channel chat that posted the post", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeTelegramAdsWithdrawal": { "description": "The transaction is a withdrawal of earned Telegram Stars to Telegram Ad platform; relevant for bots and channel chats only", "args": {}, "type": "StarTransactionType" }, "starTransactionTypeTelegramApiUsage": { "description": "The transaction is a payment for Telegram API usage; relevant for bots only", "args": { "request_count": { "description": "The number of billed requests", "is_optional": false, "type": "int32" } }, "type": "StarTransactionType" }, "starTransactionTypeUnsupported": { "description": "The transaction is a transaction of an unsupported type", "args": {}, "type": "StarTransactionType" }, "starTransactionTypeUpgradedGiftPurchase": { "description": "The transaction is a purchase of an upgraded gift for some user or channel; relevant for regular users only", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "user_id": { "description": "Identifier of the user who sold the gift", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactionTypeUpgradedGiftSale": { "description": "The transaction is a sale of an upgraded gift; relevant for regular users only", "args": { "commission_per_mille": { "description": "The number of Telegram Stars received by the Telegram for each 1000 Telegram Stars received by the seller of the gift", "is_optional": false, "type": "int32" }, "commission_star_amount": { "description": "The Telegram Star amount that was received by Telegram; can be negative for refunds", "is_optional": false, "type": "starAmount" }, "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "user_id": { "description": "Identifier of the user who bought the gift", "is_optional": false, "type": "int53" }, "via_offer": { "description": "True, if the gift was sold through a purchase offer", "is_optional": false, "type": "Bool" } }, "type": "StarTransactionType" }, "starTransactionTypeUserDeposit": { "description": "The transaction is a deposit of Telegram Stars by another user; relevant for regular users only", "args": { "sticker": { "description": "The sticker to be shown in the transaction information; may be null if unknown", "is_optional": true, "type": "sticker" }, "user_id": { "description": "Identifier of the user who gifted Telegram Stars; 0 if the user was anonymous", "is_optional": false, "type": "int53" } }, "type": "StarTransactionType" }, "starTransactions": { "description": "Represents a list of Telegram Star transactions", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "star_amount": { "description": "The amount of owned Telegram Stars", "is_optional": false, "type": "starAmount" }, "transactions": { "description": "List of transactions with Telegram Stars", "is_optional": false, "type": "vector\u003cstarTransaction\u003e" } }, "type": "StarTransactions" }, "startLiveStoryResultFail": { "description": "The live story failed to post with an error to be handled", "args": { "error_type": { "description": "Type of the error; other error types may be returned as regular errors", "is_optional": false, "type": "CanPostStoryResult" } }, "type": "StartLiveStoryResult" }, "startLiveStoryResultOk": { "description": "The live story was successfully posted", "args": { "story": { "description": "The live story", "is_optional": false, "type": "story" } }, "type": "StartLiveStoryResult" }, "statisticalGraphAsync": { "description": "The graph data to be asynchronously loaded through getStatisticalGraph", "args": { "token": { "description": "The token to use for data loading", "is_optional": false, "type": "string" } }, "type": "StatisticalGraph" }, "statisticalGraphData": { "description": "A graph data", "args": { "json_data": { "description": "Graph data in JSON format", "is_optional": false, "type": "string" }, "zoom_token": { "description": "If non-empty, a token which can be used to receive a zoomed in graph", "is_optional": true, "type": "string" } }, "type": "StatisticalGraph" }, "statisticalGraphError": { "description": "An error message to be shown to the user instead of the graph", "args": { "error_message": { "description": "The error message", "is_optional": false, "type": "string" } }, "type": "StatisticalGraph" }, "statisticalValue": { "description": "A value with information about its recent changes", "args": { "growth_rate_percentage": { "description": "The growth rate of the value, as a percentage", "is_optional": false, "type": "double" }, "previous_value": { "description": "The value for the previous day", "is_optional": false, "type": "double" }, "value": { "description": "The current value", "is_optional": false, "type": "double" } }, "type": "StatisticalValue" }, "sticker": { "description": "Describes a sticker", "args": { "emoji": { "description": "Emoji corresponding to the sticker; may be empty if unknown", "is_optional": true, "type": "string" }, "format": { "description": "Sticker format", "is_optional": false, "type": "StickerFormat" }, "full_type": { "description": "Sticker's full type", "is_optional": false, "type": "StickerFullType" }, "height": { "description": "Sticker height; as defined by the sender", "is_optional": false, "type": "int32" }, "id": { "description": "Unique sticker identifier within the set; 0 if none", "is_optional": false, "type": "int64" }, "set_id": { "description": "Identifier of the sticker set to which the sticker belongs; 0 if none", "is_optional": false, "type": "int64" }, "sticker": { "description": "File containing the sticker", "is_optional": false, "type": "file" }, "thumbnail": { "description": "Sticker thumbnail in WEBP or JPEG format; may be null", "is_optional": true, "type": "thumbnail" }, "width": { "description": "Sticker width; as defined by the sender", "is_optional": false, "type": "int32" } }, "type": "Sticker" }, "stickerFormatTgs": { "description": "The sticker is an animation in TGS format", "args": {}, "type": "StickerFormat" }, "stickerFormatWebm": { "description": "The sticker is a video in WEBM format", "args": {}, "type": "StickerFormat" }, "stickerFormatWebp": { "description": "The sticker is an image in WEBP format", "args": {}, "type": "StickerFormat" }, "stickerFullTypeCustomEmoji": { "description": "The sticker is a custom emoji to be used inside message text and caption. Currently, only Telegram Premium users can use custom emoji", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji", "is_optional": false, "type": "int64" }, "needs_repainting": { "description": "True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places", "is_optional": false, "type": "Bool" } }, "type": "StickerFullType" }, "stickerFullTypeMask": { "description": "The sticker is a mask in WEBP format to be placed on photos or videos", "args": { "mask_position": { "description": "Position where the mask is placed; may be null", "is_optional": true, "type": "maskPosition" } }, "type": "StickerFullType" }, "stickerFullTypeRegular": { "description": "The sticker is a regular sticker", "args": { "premium_animation": { "description": "Premium animation of the sticker; may be null. If present, only Telegram Premium users can use the sticker", "is_optional": true, "type": "file" } }, "type": "StickerFullType" }, "stickerSet": { "description": "Represents a sticker set", "args": { "emojis": { "description": "A list of emojis corresponding to the stickers in the same order. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object", "is_optional": false, "type": "vector\u003cemojis\u003e" }, "id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" }, "is_allowed_as_chat_emoji_status": { "description": "True, if stickers in the sticker set are custom emoji that can be used as chat emoji status; for custom emoji sticker sets only", "is_optional": false, "type": "Bool" }, "is_archived": { "description": "True, if the sticker set has been archived. A sticker set can't be installed and archived simultaneously", "is_optional": false, "type": "Bool" }, "is_installed": { "description": "True, if the sticker set has been installed by the current user", "is_optional": false, "type": "Bool" }, "is_official": { "description": "True, if the sticker set is official", "is_optional": false, "type": "Bool" }, "is_owned": { "description": "True, if the sticker set is owned by the current user", "is_optional": false, "type": "Bool" }, "is_viewed": { "description": "True for already viewed trending sticker sets", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the sticker set", "is_optional": false, "type": "string" }, "needs_repainting": { "description": "True, if stickers in the sticker set are custom emoji that must be repainted; for custom emoji sticker sets only", "is_optional": false, "type": "Bool" }, "sticker_type": { "description": "Type of the stickers in the set", "is_optional": false, "type": "StickerType" }, "stickers": { "description": "List of stickers in this set", "is_optional": false, "type": "vector\u003csticker\u003e" }, "thumbnail": { "description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed", "is_optional": true, "type": "thumbnail" }, "thumbnail_outline": { "description": "Sticker set thumbnail's outline; may be null if unknown", "is_optional": true, "type": "outline" }, "title": { "description": "Title of the sticker set", "is_optional": false, "type": "string" } }, "type": "StickerSet" }, "stickerSetInfo": { "description": "Represents short information about a sticker set", "args": { "covers": { "description": "Up to the first 5 stickers from the set, depending on the context. If the application needs more stickers the full sticker set needs to be requested", "is_optional": false, "type": "vector\u003csticker\u003e" }, "id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" }, "is_allowed_as_chat_emoji_status": { "description": "True, if stickers in the sticker set are custom emoji that can be used as chat emoji status; for custom emoji sticker sets only", "is_optional": false, "type": "Bool" }, "is_archived": { "description": "True, if the sticker set has been archived. A sticker set can't be installed and archived simultaneously", "is_optional": false, "type": "Bool" }, "is_installed": { "description": "True, if the sticker set has been installed by the current user", "is_optional": false, "type": "Bool" }, "is_official": { "description": "True, if the sticker set is official", "is_optional": false, "type": "Bool" }, "is_owned": { "description": "True, if the sticker set is owned by the current user", "is_optional": false, "type": "Bool" }, "is_viewed": { "description": "True for already viewed trending sticker sets", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the sticker set", "is_optional": false, "type": "string" }, "needs_repainting": { "description": "True, if stickers in the sticker set are custom emoji that must be repainted; for custom emoji sticker sets only", "is_optional": false, "type": "Bool" }, "size": { "description": "Total number of stickers in the set", "is_optional": false, "type": "int32" }, "sticker_type": { "description": "Type of the stickers in the set", "is_optional": false, "type": "StickerType" }, "thumbnail": { "description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed", "is_optional": true, "type": "thumbnail" }, "thumbnail_outline": { "description": "Sticker set thumbnail's outline; may be null if unknown", "is_optional": true, "type": "outline" }, "title": { "description": "Title of the sticker set", "is_optional": false, "type": "string" } }, "type": "StickerSetInfo" }, "stickerSets": { "description": "Represents a list of sticker sets", "args": { "sets": { "description": "List of sticker sets", "is_optional": false, "type": "vector\u003cstickerSetInfo\u003e" }, "total_count": { "description": "Approximate total number of sticker sets found", "is_optional": false, "type": "int32" } }, "type": "StickerSets" }, "stickerTypeCustomEmoji": { "description": "The sticker is a custom emoji to be used inside message text and caption", "args": {}, "type": "StickerType" }, "stickerTypeMask": { "description": "The sticker is a mask in WEBP format to be placed on photos or videos", "args": {}, "type": "StickerType" }, "stickerTypeRegular": { "description": "The sticker is a regular sticker", "args": {}, "type": "StickerType" }, "stickers": { "description": "Represents a list of stickers", "args": { "stickers": { "description": "List of stickers", "is_optional": false, "type": "vector\u003csticker\u003e" } }, "type": "Stickers" }, "storageStatistics": { "description": "Contains the exact storage usage statistics split by chats and file type", "args": { "by_chat": { "description": "Statistics split by chats", "is_optional": false, "type": "vector\u003cstorageStatisticsByChat\u003e" }, "count": { "description": "Total number of files", "is_optional": false, "type": "int32" }, "size": { "description": "Total size of files, in bytes", "is_optional": false, "type": "int53" } }, "type": "StorageStatistics" }, "storageStatisticsByChat": { "description": "Contains the storage usage statistics for a specific chat", "args": { "by_file_type": { "description": "Statistics split by file types", "is_optional": false, "type": "vector\u003cstorageStatisticsByFileType\u003e" }, "chat_id": { "description": "Chat identifier; 0 if none", "is_optional": false, "type": "int53" }, "count": { "description": "Total number of files in the chat", "is_optional": false, "type": "int32" }, "size": { "description": "Total size of the files in the chat, in bytes", "is_optional": false, "type": "int53" } }, "type": "StorageStatisticsByChat" }, "storageStatisticsByFileType": { "description": "Contains the storage usage statistics for a specific file type", "args": { "count": { "description": "Total number of files", "is_optional": false, "type": "int32" }, "file_type": { "description": "File type", "is_optional": false, "type": "FileType" }, "size": { "description": "Total size of the files, in bytes", "is_optional": false, "type": "int53" } }, "type": "StorageStatisticsByFileType" }, "storageStatisticsFast": { "description": "Contains approximate storage usage statistics, excluding files of unknown file type", "args": { "database_size": { "description": "Size of the database", "is_optional": false, "type": "int53" }, "file_count": { "description": "Approximate number of files", "is_optional": false, "type": "int32" }, "files_size": { "description": "Approximate total size of files, in bytes", "is_optional": false, "type": "int53" }, "language_pack_database_size": { "description": "Size of the language pack database", "is_optional": false, "type": "int53" }, "log_size": { "description": "Size of the TDLib internal log", "is_optional": false, "type": "int53" } }, "type": "StorageStatisticsFast" }, "storePaymentPurposeGiftedStars": { "description": "The user buying Telegram Stars for other users", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "star_count": { "description": "Number of bought Telegram Stars", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user to which Telegram Stars are gifted", "is_optional": false, "type": "int53" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposePremiumGift": { "description": "The user gifting Telegram Premium to another user", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "text": { "description": "Text to show along with the gift codes; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "Identifier of the user who will receive Telegram Premium", "is_optional": false, "type": "int53" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposePremiumGiftCodes": { "description": "The user boosting a chat by creating Telegram Premium gift codes for other users", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the users for duration of the Premium subscription and which is administered by the user", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "text": { "description": "Text to show along with the gift codes; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_ids": { "description": "Identifiers of the users who can activate the gift codes", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposePremiumGiveaway": { "description": "The user creating a Telegram Premium giveaway", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposePremiumSubscription": { "description": "The user subscribing to Telegram Premium", "args": { "is_restore": { "description": "Pass true if this is a restore of a Telegram Premium purchase; only for App Store", "is_optional": false, "type": "Bool" }, "is_upgrade": { "description": "Pass true if this is an upgrade from a monthly subscription to early subscription; only for App Store", "is_optional": false, "type": "Bool" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposeStarGiveaway": { "description": "The user creating a Telegram Star giveaway", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" }, "star_count": { "description": "The number of Telegram Stars to be distributed through the giveaway", "is_optional": false, "type": "int53" }, "winner_count": { "description": "The number of users to receive Telegram Stars", "is_optional": false, "type": "int32" } }, "type": "StorePaymentPurpose" }, "storePaymentPurposeStars": { "description": "The user buying Telegram Stars", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat that is supposed to receive the Telegram Stars; pass 0 if none", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "star_count": { "description": "Number of bought Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "StorePaymentPurpose" }, "storeTransactionAppStore": { "description": "A purchase through App Store", "args": { "receipt": { "description": "App Store receipt", "is_optional": false, "type": "bytes" } }, "type": "StoreTransaction" }, "storeTransactionGooglePlay": { "description": "A purchase through Google Play", "args": { "package_name": { "description": "Application package name", "is_optional": false, "type": "string" }, "purchase_token": { "description": "Google Play purchase token", "is_optional": false, "type": "string" }, "store_product_id": { "description": "Identifier of the purchased store product", "is_optional": false, "type": "string" } }, "type": "StoreTransaction" }, "stories": { "description": "Represents a list of stories", "args": { "pinned_story_ids": { "description": "Identifiers of the pinned stories; returned only in getChatPostedToChatPageStories with from_story_id == 0", "is_optional": false, "type": "vector\u003cint32\u003e" }, "stories": { "description": "The list of stories", "is_optional": false, "type": "vector\u003cstory\u003e" }, "total_count": { "description": "Approximate total number of stories found", "is_optional": false, "type": "int32" } }, "type": "Stories" }, "story": { "description": "Represents a story", "args": { "album_ids": { "description": "Identifiers of story albums to which the story is added; only for manageable stories", "is_optional": false, "type": "vector\u003cint32\u003e" }, "areas": { "description": "Clickable areas to be shown on the story content", "is_optional": false, "type": "vector\u003cstoryArea\u003e" }, "can_be_added_to_album": { "description": "True, if the story can be added to an album using createStoryAlbum and addStoryAlbumStories", "is_optional": false, "type": "Bool" }, "can_be_deleted": { "description": "True, if the story can be deleted", "is_optional": false, "type": "Bool" }, "can_be_edited": { "description": "True, if the story can be edited", "is_optional": false, "type": "Bool" }, "can_be_forwarded": { "description": "True, if the story can be forwarded as a message or reposted as a story. Otherwise, screenshotting and saving of the story content must be also forbidden", "is_optional": false, "type": "Bool" }, "can_be_replied": { "description": "True, if the story can be replied in the chat with the user who posted the story", "is_optional": false, "type": "Bool" }, "can_get_interactions": { "description": "True, if interactions with the story can be received through getStoryInteractions", "is_optional": false, "type": "Bool" }, "can_get_statistics": { "description": "True, if the story statistics are available through getStoryStatistics", "is_optional": false, "type": "Bool" }, "can_set_privacy_settings": { "description": "True, if the story privacy settings can be changed", "is_optional": false, "type": "Bool" }, "can_toggle_is_posted_to_chat_page": { "description": "True, if the story's is_posted_to_chat_page value can be changed", "is_optional": false, "type": "Bool" }, "caption": { "description": "Caption of the story", "is_optional": false, "type": "formattedText" }, "chosen_reaction_type": { "description": "Type of the chosen reaction; may be null if none", "is_optional": true, "type": "ReactionType" }, "content": { "description": "Content of the story", "is_optional": false, "type": "StoryContent" }, "date": { "description": "Point in time (Unix timestamp) when the story was published", "is_optional": false, "type": "int32" }, "has_expired_viewers": { "description": "True, if users who viewed the story can't be received, because the story has expired more than getOption(\"story_viewers_expiration_delay\") seconds ago", "is_optional": false, "type": "Bool" }, "id": { "description": "Unique story identifier among stories posted by the given chat", "is_optional": false, "type": "int32" }, "interaction_info": { "description": "Information about interactions with the story; may be null if the story isn't owned or there were no interactions", "is_optional": true, "type": "storyInteractionInfo" }, "is_being_edited": { "description": "True, if the story is being edited by the current user", "is_optional": false, "type": "Bool" }, "is_being_posted": { "description": "True, if the story is being posted by the current user", "is_optional": false, "type": "Bool" }, "is_edited": { "description": "True, if the story was edited", "is_optional": false, "type": "Bool" }, "is_posted_to_chat_page": { "description": "True, if the story is saved in the profile of the chat that posted it and will be available there after expiration", "is_optional": false, "type": "Bool" }, "is_visible_only_for_self": { "description": "True, if the story is visible only for the current user", "is_optional": false, "type": "Bool" }, "poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" }, "poster_id": { "description": "Identifier of the user or chat that posted the story; may be null if the story is posted on behalf of the poster_chat_id", "is_optional": true, "type": "MessageSender" }, "privacy_settings": { "description": "Privacy rules affecting story visibility; may be approximate for non-owned stories", "is_optional": false, "type": "StoryPrivacySettings" }, "repost_info": { "description": "Information about the original story; may be null if the story wasn't reposted", "is_optional": true, "type": "storyRepostInfo" } }, "type": "Story" }, "storyAlbum": { "description": "Describes album of stories", "args": { "id": { "description": "Unique identifier of the album", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the album", "is_optional": false, "type": "string" }, "photo_icon": { "description": "Icon of the album; may be null if none", "is_optional": true, "type": "photo" }, "video_icon": { "description": "Video icon of the album; may be null if none", "is_optional": true, "type": "video" } }, "type": "StoryAlbum" }, "storyAlbums": { "description": "Represents a list of story albums", "args": { "albums": { "description": "List of story albums", "is_optional": false, "type": "vector\u003cstoryAlbum\u003e" } }, "type": "StoryAlbums" }, "storyArea": { "description": "Describes a clickable rectangle area on a story media", "args": { "position": { "description": "Position of the area", "is_optional": false, "type": "storyAreaPosition" }, "type": { "description": "Type of the area", "is_optional": false, "type": "StoryAreaType" } }, "type": "StoryArea" }, "storyAreaPosition": { "description": "Describes position of a clickable rectangle area on a story media", "args": { "corner_radius_percentage": { "description": "The radius of the rectangle corner rounding, as a percentage of the media width", "is_optional": false, "type": "double" }, "height_percentage": { "description": "The height of the rectangle, as a percentage of the media height", "is_optional": false, "type": "double" }, "rotation_angle": { "description": "Clockwise rotation angle of the rectangle, in degrees; 0-360", "is_optional": false, "type": "double" }, "width_percentage": { "description": "The width of the rectangle, as a percentage of the media width", "is_optional": false, "type": "double" }, "x_percentage": { "description": "The abscissa of the rectangle's center, as a percentage of the media width", "is_optional": false, "type": "double" }, "y_percentage": { "description": "The ordinate of the rectangle's center, as a percentage of the media height", "is_optional": false, "type": "double" } }, "type": "StoryAreaPosition" }, "storyAreaTypeLink": { "description": "An area pointing to a HTTP or tg:// link", "args": { "url": { "description": "HTTP or tg:// URL to be opened when the area is clicked", "is_optional": false, "type": "string" } }, "type": "StoryAreaType" }, "storyAreaTypeLocation": { "description": "An area pointing to a location", "args": { "address": { "description": "Address of the location; may be null if unknown", "is_optional": true, "type": "locationAddress" }, "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "StoryAreaType" }, "storyAreaTypeMessage": { "description": "An area pointing to a message", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "StoryAreaType" }, "storyAreaTypeSuggestedReaction": { "description": "An area pointing to a suggested reaction. App needs to show a clickable reaction on the area and call setStoryReaction when the area is clicked", "args": { "is_dark": { "description": "True, if reaction has a dark background", "is_optional": false, "type": "Bool" }, "is_flipped": { "description": "True, if reaction corner is flipped", "is_optional": false, "type": "Bool" }, "reaction_type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" }, "total_count": { "description": "Number of times the reaction was added", "is_optional": false, "type": "int32" } }, "type": "StoryAreaType" }, "storyAreaTypeUpgradedGift": { "description": "An area with an upgraded gift", "args": { "gift_name": { "description": "Unique name of the upgraded gift", "is_optional": false, "type": "string" } }, "type": "StoryAreaType" }, "storyAreaTypeVenue": { "description": "An area pointing to a venue", "args": { "venue": { "description": "Information about the venue", "is_optional": false, "type": "venue" } }, "type": "StoryAreaType" }, "storyAreaTypeWeather": { "description": "An area with information about weather", "args": { "background_color": { "description": "A color of the area background in the ARGB format", "is_optional": false, "type": "int32" }, "emoji": { "description": "Emoji representing the weather", "is_optional": false, "type": "string" }, "temperature": { "description": "Temperature, in degree Celsius", "is_optional": false, "type": "double" } }, "type": "StoryAreaType" }, "storyContentLive": { "description": "A live story", "args": { "group_call_id": { "description": "Identifier of the corresponding group call. The group call can be received through the method getGroupCall", "is_optional": false, "type": "int32" }, "is_rtmp_stream": { "description": "True, if the call is an RTMP stream instead of an ordinary group call", "is_optional": false, "type": "Bool" } }, "type": "StoryContent" }, "storyContentPhoto": { "description": "A photo story", "args": { "photo": { "description": "The photo", "is_optional": false, "type": "photo" } }, "type": "StoryContent" }, "storyContentTypeLive": { "description": "A live story", "args": {}, "type": "StoryContentType" }, "storyContentTypePhoto": { "description": "A photo story", "args": {}, "type": "StoryContentType" }, "storyContentTypeUnsupported": { "description": "A story of unknown content type", "args": {}, "type": "StoryContentType" }, "storyContentTypeVideo": { "description": "A video story", "args": {}, "type": "StoryContentType" }, "storyContentUnsupported": { "description": "A story content that is not supported in the current TDLib version", "args": {}, "type": "StoryContent" }, "storyContentVideo": { "description": "A video story", "args": { "alternative_video": { "description": "Alternative version of the video in MPEG4 format, encoded with H.264 codec; may be null", "is_optional": true, "type": "storyVideo" }, "video": { "description": "The video in MPEG4 format", "is_optional": false, "type": "storyVideo" } }, "type": "StoryContent" }, "storyFullId": { "description": "Contains identifier of a story along with identifier of the chat that posted it", "args": { "poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" }, "story_id": { "description": "Unique story identifier among stories of the chat", "is_optional": false, "type": "int32" } }, "type": "StoryFullId" }, "storyInfo": { "description": "Contains basic information about a story", "args": { "date": { "description": "Point in time (Unix timestamp) when the story was published", "is_optional": false, "type": "int32" }, "is_for_close_friends": { "description": "True, if the story is available only to close friends", "is_optional": false, "type": "Bool" }, "is_live": { "description": "True, if the story is a live story", "is_optional": false, "type": "Bool" }, "story_id": { "description": "Unique story identifier among stories of the chat", "is_optional": false, "type": "int32" } }, "type": "StoryInfo" }, "storyInteraction": { "description": "Represents interaction with a story", "args": { "actor_id": { "description": "Identifier of the user or chat that made the interaction", "is_optional": false, "type": "MessageSender" }, "block_list": { "description": "Block list to which the actor is added; may be null if none or for chat stories", "is_optional": true, "type": "BlockList" }, "interaction_date": { "description": "Approximate point in time (Unix timestamp) when the interaction happened", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the interaction", "is_optional": false, "type": "StoryInteractionType" } }, "type": "StoryInteraction" }, "storyInteractionInfo": { "description": "Contains information about interactions with a story", "args": { "forward_count": { "description": "Number of times the story was forwarded; 0 if none or unknown", "is_optional": false, "type": "int32" }, "reaction_count": { "description": "Number of reactions added to the story; 0 if none or unknown", "is_optional": false, "type": "int32" }, "recent_viewer_user_ids": { "description": "Identifiers of at most 3 recent viewers of the story", "is_optional": false, "type": "vector\u003cint53\u003e" }, "view_count": { "description": "Number of times the story was viewed", "is_optional": false, "type": "int32" } }, "type": "StoryInteractionInfo" }, "storyInteractionTypeForward": { "description": "A forward of the story as a message", "args": { "message": { "description": "The message with story forward", "is_optional": false, "type": "message" } }, "type": "StoryInteractionType" }, "storyInteractionTypeRepost": { "description": "A repost of the story as a story", "args": { "story": { "description": "The reposted story", "is_optional": false, "type": "story" } }, "type": "StoryInteractionType" }, "storyInteractionTypeView": { "description": "A view of the story", "args": { "chosen_reaction_type": { "description": "Type of the reaction that was chosen by the viewer; may be null if none", "is_optional": true, "type": "ReactionType" } }, "type": "StoryInteractionType" }, "storyInteractions": { "description": "Represents a list of interactions with a story", "args": { "interactions": { "description": "List of story interactions", "is_optional": false, "type": "vector\u003cstoryInteraction\u003e" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "total_count": { "description": "Approximate total number of interactions found", "is_optional": false, "type": "int32" }, "total_forward_count": { "description": "Approximate total number of found forwards and reposts; always 0 for chat stories", "is_optional": false, "type": "int32" }, "total_reaction_count": { "description": "Approximate total number of found reactions; always 0 for chat stories", "is_optional": false, "type": "int32" } }, "type": "StoryInteractions" }, "storyListArchive": { "description": "The list of stories, shown in the Archive chat list", "args": {}, "type": "StoryList" }, "storyListMain": { "description": "The list of stories, shown in the main chat list and folder chat lists", "args": {}, "type": "StoryList" }, "storyOriginHiddenUser": { "description": "The original story was posted by an unknown user", "args": { "poster_name": { "description": "Name of the user or the chat that posted the story", "is_optional": false, "type": "string" } }, "type": "StoryOrigin" }, "storyOriginPublicStory": { "description": "The original story was a public story that was posted by a known chat", "args": { "chat_id": { "description": "Identifier of the chat that posted original story", "is_optional": false, "type": "int53" }, "story_id": { "description": "Story identifier of the original story", "is_optional": false, "type": "int32" } }, "type": "StoryOrigin" }, "storyPrivacySettingsCloseFriends": { "description": "The story can be viewed by all close friends", "args": {}, "type": "StoryPrivacySettings" }, "storyPrivacySettingsContacts": { "description": "The story can be viewed by all contacts except chosen users", "args": { "except_user_ids": { "description": "User identifiers of the contacts that can't see the story; always unknown and empty for non-owned stories", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "StoryPrivacySettings" }, "storyPrivacySettingsEveryone": { "description": "The story can be viewed by everyone", "args": { "except_user_ids": { "description": "Identifiers of the users that can't see the story; always unknown and empty for non-owned stories", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "StoryPrivacySettings" }, "storyPrivacySettingsSelectedUsers": { "description": "The story can be viewed by certain specified users", "args": { "user_ids": { "description": "Identifiers of the users; always unknown and empty for non-owned stories", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "StoryPrivacySettings" }, "storyRepostInfo": { "description": "Contains information about original story that was reposted", "args": { "is_content_modified": { "description": "True, if story content was modified during reposting; otherwise, story wasn't modified", "is_optional": false, "type": "Bool" }, "origin": { "description": "Origin of the story that was reposted", "is_optional": false, "type": "StoryOrigin" } }, "type": "StoryRepostInfo" }, "storyStatistics": { "description": "A detailed statistics about a story", "args": { "story_interaction_graph": { "description": "A graph containing number of story views and shares", "is_optional": false, "type": "StatisticalGraph" }, "story_reaction_graph": { "description": "A graph containing number of story reactions", "is_optional": false, "type": "StatisticalGraph" } }, "type": "StoryStatistics" }, "storyVideo": { "description": "Describes a video file posted as a story", "args": { "cover_frame_timestamp": { "description": "Timestamp of the frame used as video thumbnail", "is_optional": false, "type": "double" }, "duration": { "description": "Duration of the video, in seconds", "is_optional": false, "type": "double" }, "has_stickers": { "description": "True, if stickers were added to the video. The list of corresponding sticker sets can be received using getAttachedStickerSets", "is_optional": false, "type": "Bool" }, "height": { "description": "Video height", "is_optional": false, "type": "int32" }, "is_animation": { "description": "True, if the video has no sound", "is_optional": false, "type": "Bool" }, "minithumbnail": { "description": "Video minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "preload_prefix_size": { "description": "Size of file prefix, which is expected to be preloaded, in bytes", "is_optional": false, "type": "int32" }, "thumbnail": { "description": "Video thumbnail in JPEG or MPEG4 format; may be null", "is_optional": true, "type": "thumbnail" }, "video": { "description": "File containing the video", "is_optional": false, "type": "file" }, "width": { "description": "Video width", "is_optional": false, "type": "int32" } }, "type": "StoryVideo" }, "suggestedActionAddLoginPasskey": { "description": "Suggests the user to add a passkey for login using addLoginPasskey", "args": {}, "type": "SuggestedAction" }, "suggestedActionCheckPassword": { "description": "Suggests the user to check whether they still remember their 2-step verification password", "args": {}, "type": "SuggestedAction" }, "suggestedActionCheckPhoneNumber": { "description": "Suggests the user to check whether authorization phone number is correct and change the phone number if it is inaccessible", "args": {}, "type": "SuggestedAction" }, "suggestedActionConvertToBroadcastGroup": { "description": "Suggests the user to convert specified supergroup to a broadcast group", "args": { "supergroup_id": { "description": "Supergroup identifier", "is_optional": false, "type": "int53" } }, "type": "SuggestedAction" }, "suggestedActionCustom": { "description": "A custom suggestion to be shown at the top of the chat list", "args": { "description": { "description": "Description of the suggestion", "is_optional": false, "type": "formattedText" }, "name": { "description": "Unique name of the suggestion", "is_optional": false, "type": "string" }, "title": { "description": "Title of the suggestion", "is_optional": false, "type": "formattedText" }, "url": { "description": "The link to open when the suggestion is clicked", "is_optional": false, "type": "string" } }, "type": "SuggestedAction" }, "suggestedActionEnableArchiveAndMuteNewChats": { "description": "Suggests the user to enable archive_and_mute_new_chats_from_unknown_users setting in archiveChatListSettings", "args": {}, "type": "SuggestedAction" }, "suggestedActionExtendPremium": { "description": "Suggests the user to extend their expiring Telegram Premium subscription", "args": { "manage_premium_subscription_url": { "description": "A URL for managing Telegram Premium subscription", "is_optional": false, "type": "string" } }, "type": "SuggestedAction" }, "suggestedActionExtendStarSubscriptions": { "description": "Suggests the user to extend their expiring Telegram Star subscriptions. Call getStarSubscriptions with only_expiring == true", "args": {}, "type": "SuggestedAction" }, "suggestedActionGiftPremiumForChristmas": { "description": "Suggests the user to gift Telegram Premium to friends for Christmas", "args": {}, "type": "SuggestedAction" }, "suggestedActionRestorePremium": { "description": "Suggests the user to restore a recently expired Premium subscription", "args": {}, "type": "SuggestedAction" }, "suggestedActionSetBirthdate": { "description": "Suggests the user to set birthdate", "args": {}, "type": "SuggestedAction" }, "suggestedActionSetLoginEmailAddress": { "description": "Suggests the user to add login email address. Call isLoginEmailAddressRequired, and then setLoginEmailAddress or checkLoginEmailAddressCode to change the login email address", "args": { "can_be_hidden": { "description": "True, if the suggested action can be hidden using hideSuggestedAction. Otherwise, the user must not be able to use the application without setting up the email address", "is_optional": false, "type": "Bool" } }, "type": "SuggestedAction" }, "suggestedActionSetPassword": { "description": "Suggests the user to set a 2-step verification password to be able to log in again", "args": { "authorization_delay": { "description": "The number of days to pass between consecutive authorizations if the user declines to set password; if 0, then the user is advised to set the password for security reasons", "is_optional": false, "type": "int32" } }, "type": "SuggestedAction" }, "suggestedActionSetProfilePhoto": { "description": "Suggests the user to set profile photo", "args": {}, "type": "SuggestedAction" }, "suggestedActionSubscribeToAnnualPremium": { "description": "Suggests the user to subscribe to the Premium subscription with annual payments", "args": {}, "type": "SuggestedAction" }, "suggestedActionUpgradePremium": { "description": "Suggests the user to upgrade the Premium subscription from monthly payments to annual payments", "args": {}, "type": "SuggestedAction" }, "suggestedActionViewChecksHint": { "description": "Suggests the user to view a hint about the meaning of one and two check marks on sent messages", "args": {}, "type": "SuggestedAction" }, "suggestedActionViewFirstTonWalletTransferHint": { "description": "Suggests the user to view a hint about receiving of the first TON wallet transfer", "args": {}, "type": "SuggestedAction" }, "suggestedPostInfo": { "description": "Contains information about a suggested post. If the post can be approved or declined, then changes to the post can be also suggested. Use sendMessage with reply to the message", "args": { "can_be_approved": { "description": "True, if the suggested post can be approved by the current user using approveSuggestedPost; updates aren't sent when value of this field changes", "is_optional": false, "type": "Bool" }, "can_be_declined": { "description": "True, if the suggested post can be declined by the current user using declineSuggestedPost; updates aren't sent when value of this field changes", "is_optional": false, "type": "Bool" }, "price": { "description": "Price of the suggested post; may be null if the post is non-paid", "is_optional": true, "type": "SuggestedPostPrice" }, "send_date": { "description": "Point in time (Unix timestamp) when the post is expected to be published; 0 if the specific date isn't set yet", "is_optional": false, "type": "int32" }, "state": { "description": "State of the post", "is_optional": false, "type": "SuggestedPostState" } }, "type": "SuggestedPostInfo" }, "suggestedPostPriceGram": { "description": "Describes price of a suggested post in TON Grams", "args": { "gram_cent_count": { "description": "The amount of 1/100 of Gram expected to be paid for the post; getOption(\"suggested_post_gram_cent_count_min\")-getOption(\"suggested_post_gram_cent_count_max\")", "is_optional": false, "type": "int53" } }, "type": "SuggestedPostPrice" }, "suggestedPostPriceStar": { "description": "Describes price of a suggested post in Telegram Stars", "args": { "star_count": { "description": "The Telegram Star amount expected to be paid for the post; getOption(\"suggested_post_star_count_min\")-getOption(\"suggested_post_star_count_max\")", "is_optional": false, "type": "int53" } }, "type": "SuggestedPostPrice" }, "suggestedPostRefundReasonPaymentRefunded": { "description": "The post was refunded, because the payment for the post was refunded", "args": {}, "type": "SuggestedPostRefundReason" }, "suggestedPostRefundReasonPostDeleted": { "description": "The post was refunded, because it was deleted by channel administrators in less than getOption(\"suggested_post_lifetime_min\") seconds", "args": {}, "type": "SuggestedPostRefundReason" }, "suggestedPostStateApproved": { "description": "The post was approved", "args": {}, "type": "SuggestedPostState" }, "suggestedPostStateDeclined": { "description": "The post was declined", "args": {}, "type": "SuggestedPostState" }, "suggestedPostStatePending": { "description": "The post must be approved or declined", "args": {}, "type": "SuggestedPostState" }, "supergroup": { "description": "Represents a supergroup or channel with zero or more members (subscribers in the case of channels)", "args": { "active_story_state": { "description": "State of active stories of the supergroup or channel; may be null if there are no active stories", "is_optional": true, "type": "ActiveStoryState" }, "boost_level": { "description": "Approximate boost level for the chat", "is_optional": false, "type": "int32" }, "date": { "description": "Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member", "is_optional": false, "type": "int32" }, "has_automatic_translation": { "description": "True, if automatic translation of messages is enabled in the channel", "is_optional": false, "type": "Bool" }, "has_direct_messages_group": { "description": "True, if the channel has direct messages group", "is_optional": false, "type": "Bool" }, "has_forum_tabs": { "description": "True, if the supergroup is a forum, which topics are shown in the same way as in channel direct messages groups", "is_optional": false, "type": "Bool" }, "has_linked_chat": { "description": "True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel", "is_optional": false, "type": "Bool" }, "has_location": { "description": "True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup", "is_optional": false, "type": "Bool" }, "id": { "description": "Supergroup or channel identifier", "is_optional": false, "type": "int53" }, "is_administered_direct_messages_group": { "description": "True, if the supergroup is a direct messages group for a channel chat that is administered by the current user", "is_optional": false, "type": "Bool" }, "is_broadcast_group": { "description": "True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members", "is_optional": false, "type": "Bool" }, "is_channel": { "description": "True, if the supergroup is a channel, which can have an unlimited number of subscribers, but only administrators can post there and see the list of subscribers", "is_optional": false, "type": "Bool" }, "is_direct_messages_group": { "description": "True, if the supergroup is a direct message group for a channel chat", "is_optional": false, "type": "Bool" }, "is_forum": { "description": "True, if the supergroup is a forum with topics", "is_optional": false, "type": "Bool" }, "is_slow_mode_enabled": { "description": "True, if the slow mode is enabled in the supergroup", "is_optional": false, "type": "Bool" }, "join_by_request": { "description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators", "is_optional": false, "type": "Bool" }, "join_to_send_messages": { "description": "True, if users need to join the supergroup before they can send messages. May be false only for discussion supergroups and channel direct messages groups", "is_optional": false, "type": "Bool" }, "member_count": { "description": "Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through", "is_optional": false, "type": "int32" }, "paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message", "is_optional": false, "type": "int53" }, "restriction_info": { "description": "Information about the restrictions that must be applied to the corresponding supergroup or channel chat; may be null if none", "is_optional": true, "type": "restrictionInfo" }, "show_message_sender": { "description": "True, if messages sent to the channel have information about the sender user. This field is only applicable to channels", "is_optional": false, "type": "Bool" }, "sign_messages": { "description": "True, if messages sent to the channel contains name of the sender. This field is only applicable to channels", "is_optional": false, "type": "Bool" }, "status": { "description": "Status of the current user in the supergroup or channel", "is_optional": false, "type": "ChatMemberStatus" }, "usernames": { "description": "Usernames of the supergroup or channel; may be null", "is_optional": true, "type": "usernames" }, "verification_status": { "description": "Information about verification status of the supergroup or channel; may be null if none", "is_optional": true, "type": "verificationStatus" } }, "type": "Supergroup" }, "supergroupFullInfo": { "description": "Contains full information about a supergroup or channel", "args": { "administrator_count": { "description": "Number of privileged users in the supergroup or channel; 0 if unknown", "is_optional": false, "type": "int32" }, "banned_count": { "description": "Number of users banned from chat; 0 if unknown", "is_optional": false, "type": "int32" }, "bot_commands": { "description": "List of commands of bots in the group", "is_optional": false, "type": "vector\u003cbotCommands\u003e" }, "bot_verification": { "description": "Information about verification status of the supergroup or the channel provided by a bot; may be null if none or unknown", "is_optional": true, "type": "botVerification" }, "can_enable_paid_messages": { "description": "True, if paid messages can be enabled in the supergroup chat; for supergroup only", "is_optional": false, "type": "Bool" }, "can_enable_paid_reaction": { "description": "True, if paid reaction can be enabled in the channel chat; for channels only", "is_optional": false, "type": "Bool" }, "can_get_members": { "description": "True, if members of the chat can be retrieved via getSupergroupMembers or searchChatMembers", "is_optional": false, "type": "Bool" }, "can_get_revenue_statistics": { "description": "True, if the supergroup or channel revenue statistics are available", "is_optional": false, "type": "Bool" }, "can_get_star_revenue_statistics": { "description": "True, if the supergroup or channel Telegram Star revenue statistics are available", "is_optional": false, "type": "Bool" }, "can_get_statistics": { "description": "True, if the supergroup or channel statistics are available", "is_optional": false, "type": "Bool" }, "can_have_sponsored_messages": { "description": "True, if the chat can have sponsored messages. The value of this field is only available to the owner of the chat", "is_optional": false, "type": "Bool" }, "can_hide_members": { "description": "True, if non-administrators and non-bots can be hidden in responses to getSupergroupMembers and searchChatMembers for non-administrators", "is_optional": false, "type": "Bool" }, "can_send_gift": { "description": "True, if the user can send a gift to the supergroup or channel using sendGift or transferGift", "is_optional": false, "type": "Bool" }, "can_set_location": { "description": "True, if the supergroup location can be changed", "is_optional": false, "type": "Bool" }, "can_set_sticker_set": { "description": "True, if the supergroup sticker set can be changed", "is_optional": false, "type": "Bool" }, "can_toggle_aggressive_anti_spam": { "description": "True, if aggressive anti-spam checks can be enabled or disabled in the supergroup", "is_optional": false, "type": "Bool" }, "community_id": { "description": "Identifier of the community to which the corresponding chat was added", "is_optional": false, "type": "int53" }, "custom_emoji_sticker_set_id": { "description": "Identifier of the custom emoji sticker set that can be used in the supergroup without Telegram Premium subscription; 0 if none", "is_optional": false, "type": "int64" }, "description": { "description": "Supergroup or channel description", "is_optional": false, "type": "string" }, "direct_messages_chat_id": { "description": "Chat identifier of a direct messages group for the channel, or a channel, for which the supergroup is the designated direct messages group; 0 if none", "is_optional": false, "type": "int53" }, "gift_count": { "description": "Number of saved to profile gifts for channels without can_post_messages administrator right, otherwise, the total number of received gifts", "is_optional": false, "type": "int32" }, "guard_bot_user_id": { "description": "User identifier of the guard bot in the group; for chat administrators only", "is_optional": false, "type": "int53" }, "has_aggressive_anti_spam_enabled": { "description": "True, if aggressive anti-spam checks are enabled in the supergroup. The value of this field is only available to chat administrators", "is_optional": false, "type": "Bool" }, "has_hidden_members": { "description": "True, if non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatMembers", "is_optional": false, "type": "Bool" }, "has_paid_media_allowed": { "description": "True, if paid media can be sent and forwarded to the channel chat; for channels only", "is_optional": false, "type": "Bool" }, "has_pinned_stories": { "description": "True, if the supergroup or channel has pinned stories", "is_optional": false, "type": "Bool" }, "invite_link": { "description": "Primary invite link for the chat; may be null. For chat administrators with can_invite_users right only", "is_optional": true, "type": "chatInviteLink" }, "is_all_history_available": { "description": "True, if new chat members will have access to old messages. In public, discussion, of forum groups and all channels, old messages are always available,", "is_optional": false, "type": "Bool" }, "linked_chat_id": { "description": "Chat identifier of a discussion group for the channel, or a channel, for which the supergroup is the designated discussion group; 0 if none or unknown", "is_optional": false, "type": "int53" }, "location": { "description": "Location to which the supergroup is connected; may be null if none", "is_optional": true, "type": "chatLocation" }, "main_profile_tab": { "description": "The main tab chosen by the administrators of the channel; may be null if not chosen manually", "is_optional": true, "type": "ProfileTab" }, "member_count": { "description": "Number of members in the supergroup or channel; 0 if unknown", "is_optional": false, "type": "int32" }, "my_boost_count": { "description": "Number of times the current user boosted the supergroup or channel", "is_optional": false, "type": "int32" }, "outgoing_paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by the current user for each sent message to the supergroup", "is_optional": false, "type": "int53" }, "photo": { "description": "Chat photo; may be null if empty or unknown. If non-null, then it is the same photo as in chat.photo", "is_optional": true, "type": "chatPhoto" }, "restricted_count": { "description": "Number of restricted users in the supergroup; 0 if unknown", "is_optional": false, "type": "int32" }, "slow_mode_delay": { "description": "Delay between consecutive sent messages for non-administrator supergroup members, in seconds", "is_optional": false, "type": "int32" }, "slow_mode_delay_expires_in": { "description": "Time left before next message can be sent in the supergroup, in seconds. An updateSupergroupFullInfo update is not triggered when value of this field changes, but both new and old values are non-zero", "is_optional": false, "type": "double" }, "sticker_set_id": { "description": "Identifier of the supergroup sticker set that must be shown before user sticker sets; 0 if none", "is_optional": false, "type": "int64" }, "unrestrict_boost_count": { "description": "Number of times the supergroup must be boosted by a user to ignore slow mode and chat permission restrictions; 0 if unspecified", "is_optional": false, "type": "int32" }, "upgraded_from_basic_group_id": { "description": "Identifier of the basic group from which supergroup was upgraded; 0 if none", "is_optional": false, "type": "int53" }, "upgraded_from_max_message_id": { "description": "Identifier of the last message in the basic group from which supergroup was upgraded; 0 if none", "is_optional": false, "type": "int53" } }, "type": "SupergroupFullInfo" }, "supergroupMembersFilterAdministrators": { "description": "Returns the owner and administrators", "args": {}, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterBanned": { "description": "Returns users banned from the supergroup or channel; can be used only by administrators", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterBots": { "description": "Returns bot members of the supergroup or channel", "args": {}, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterContacts": { "description": "Returns contacts of the current user who are members of the supergroup or channel", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterMention": { "description": "Returns users who can be mentioned in the supergroup", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "topic_id": { "description": "Identifier of the topic in which the users will be mentioned; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterRecent": { "description": "Returns recently active users in reverse chronological order", "args": {}, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterRestricted": { "description": "Returns restricted supergroup members; can be used only by administrators", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "SupergroupMembersFilter" }, "supergroupMembersFilterSearch": { "description": "Used to search for supergroup or channel members via a (string) query", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "SupergroupMembersFilter" }, "tMeUrl": { "description": "Represents a URL linking to an internal Telegram entity", "args": { "type": { "description": "Type of the URL", "is_optional": false, "type": "TMeUrlType" }, "url": { "description": "URL", "is_optional": false, "type": "string" } }, "type": "TMeUrl" }, "tMeUrlTypeChatInvite": { "description": "A chat invite link", "args": { "info": { "description": "Information about the chat invite link", "is_optional": false, "type": "chatInviteLinkInfo" } }, "type": "TMeUrlType" }, "tMeUrlTypeStickerSet": { "description": "A URL linking to a sticker set", "args": { "sticker_set_id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" } }, "type": "TMeUrlType" }, "tMeUrlTypeSupergroup": { "description": "A URL linking to a public supergroup or channel", "args": { "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" } }, "type": "TMeUrlType" }, "tMeUrlTypeUser": { "description": "A URL linking to a user", "args": { "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "TMeUrlType" }, "tMeUrls": { "description": "Contains a list of t.me URLs", "args": { "urls": { "description": "List of URLs", "is_optional": false, "type": "vector\u003ctMeUrl\u003e" } }, "type": "TMeUrls" }, "targetChatChosen": { "description": "The chat needs to be chosen by the user among chats of the specified types", "args": { "types": { "description": "Allowed types for the chat", "is_optional": false, "type": "targetChatTypes" } }, "type": "TargetChat" }, "targetChatCurrent": { "description": "The currently opened chat and forum topic must be kept", "args": {}, "type": "TargetChat" }, "targetChatInternalLink": { "description": "The chat needs to be open with the provided internal link", "args": { "link": { "description": "An internal link pointing to the chat", "is_optional": false, "type": "InternalLinkType" } }, "type": "TargetChat" }, "targetChatTypes": { "description": "Describes allowed types for the target chat", "args": { "allow_bot_chats": { "description": "True, if private chats with other bots are allowed", "is_optional": false, "type": "Bool" }, "allow_channel_chats": { "description": "True, if channel chats are allowed", "is_optional": false, "type": "Bool" }, "allow_group_chats": { "description": "True, if basic group and supergroup chats are allowed", "is_optional": false, "type": "Bool" }, "allow_user_chats": { "description": "True, if private chats with ordinary users are allowed", "is_optional": false, "type": "Bool" } }, "type": "TargetChatTypes" }, "telegramPaymentPurposeGiftedStars": { "description": "The user buying Telegram Stars for other users", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "star_count": { "description": "Number of bought Telegram Stars", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user to which Telegram Stars are gifted", "is_optional": false, "type": "int53" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposeJoinChat": { "description": "The user joins a chat and subscribes to regular payments in Telegram Stars", "args": { "invite_link": { "description": "Invite link to use", "is_optional": false, "type": "string" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposePremiumGift": { "description": "The user gifting Telegram Premium to another user", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency, or \"XTR\" for payments in Telegram Stars", "is_optional": false, "type": "string" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active for the user", "is_optional": false, "type": "int32" }, "text": { "description": "Text to show to the user receiving Telegram Premium; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "Identifier of the user who will receive Telegram Premium", "is_optional": false, "type": "int53" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposePremiumGiftCodes": { "description": "The user boosting a chat by creating Telegram Premium gift codes for other users", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which will be automatically boosted by the users for duration of the Premium subscription and which is administered by the user", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active for the users", "is_optional": false, "type": "int32" }, "text": { "description": "Text to show along with the gift codes; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_ids": { "description": "Identifiers of the users who can activate the gift codes", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposePremiumGiveaway": { "description": "The user creating a Telegram Premium giveaway", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "month_count": { "description": "Number of months the Telegram Premium subscription will be active for the users", "is_optional": false, "type": "int32" }, "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" }, "winner_count": { "description": "Number of users who will be able to activate the gift codes", "is_optional": false, "type": "int32" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposeStarGiveaway": { "description": "The user creating a Telegram Star giveaway", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" }, "star_count": { "description": "The number of Telegram Stars to be distributed through the giveaway", "is_optional": false, "type": "int53" }, "winner_count": { "description": "The number of users to receive Telegram Stars", "is_optional": false, "type": "int32" } }, "type": "TelegramPaymentPurpose" }, "telegramPaymentPurposeStars": { "description": "The user buying Telegram Stars", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat that is supposed to receive the Telegram Stars; pass 0 if none. If non-zero and getOption(\"star_top_up_disabled\"),", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "star_count": { "description": "Number of bought Telegram Stars", "is_optional": false, "type": "int53" } }, "type": "TelegramPaymentPurpose" }, "temporaryPasswordState": { "description": "Returns information about the availability of a temporary password, which can be used for payments", "args": { "has_password": { "description": "True, if a temporary password is available", "is_optional": false, "type": "Bool" }, "valid_for": { "description": "Time left before the temporary password expires, in seconds", "is_optional": false, "type": "int32" } }, "type": "TemporaryPasswordState" }, "termsOfService": { "description": "Contains Telegram terms of service", "args": { "min_user_age": { "description": "The minimum age of a user to be able to accept the terms; 0 if age isn't restricted", "is_optional": false, "type": "int32" }, "show_popup": { "description": "True, if a blocking popup with terms of service must be shown to the user", "is_optional": false, "type": "Bool" }, "text": { "description": "Text of the terms of service", "is_optional": false, "type": "formattedText" } }, "type": "TermsOfService" }, "testBytes": { "description": "A simple object containing a sequence of bytes; for testing only", "args": { "value": { "description": "Bytes", "is_optional": false, "type": "bytes" } }, "type": "TestBytes" }, "testInt": { "description": "A simple object containing a number; for testing only", "args": { "value": { "description": "Number", "is_optional": false, "type": "int32" } }, "type": "TestInt" }, "testString": { "description": "A simple object containing a string; for testing only", "args": { "value": { "description": "String", "is_optional": false, "type": "string" } }, "type": "TestString" }, "testVectorInt": { "description": "A simple object containing a vector of numbers; for testing only", "args": { "value": { "description": "Vector of numbers", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "TestVectorInt" }, "testVectorIntObject": { "description": "A simple object containing a vector of objects that hold a number; for testing only", "args": { "value": { "description": "Vector of objects", "is_optional": false, "type": "vector\u003ctestInt\u003e" } }, "type": "TestVectorIntObject" }, "testVectorString": { "description": "A simple object containing a vector of strings; for testing only", "args": { "value": { "description": "Vector of strings", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "TestVectorString" }, "testVectorStringObject": { "description": "A simple object containing a vector of objects that hold a string; for testing only", "args": { "value": { "description": "Vector of objects", "is_optional": false, "type": "vector\u003ctestString\u003e" } }, "type": "TestVectorStringObject" }, "text": { "description": "Contains some text", "args": { "text": { "description": "Text", "is_optional": false, "type": "string" } }, "type": "Text" }, "textCompositionStyle": { "description": "Describes a style that can be used to compose a text", "args": { "creator_user_id": { "description": "User identifier of the creator of the style; 0 if none or unknown", "is_optional": false, "type": "int53" }, "custom_emoji_id": { "description": "Identifier of the custom emoji corresponding to the style; 0 if none", "is_optional": false, "type": "int64" }, "english_example": { "description": "Example of the style usage in English; may be null if unknown", "is_optional": true, "type": "textCompositionStyleExample" }, "install_count": { "description": "Number of users that installed the style; for created custom styles only; 0 if unknown", "is_optional": false, "type": "int32" }, "is_creator": { "description": "True, if the user is creator of the style", "is_optional": false, "type": "Bool" }, "is_custom": { "description": "True, if the style is created by a user", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the style", "is_optional": false, "type": "string" }, "prompt": { "description": "Prompt of the style; for created custom styles only", "is_optional": false, "type": "string" }, "title": { "description": "Title of the style in the user application's language", "is_optional": false, "type": "string" } }, "type": "TextCompositionStyle" }, "textCompositionStyleExample": { "description": "Contains an example of text composition style usage", "args": { "result_text": { "description": "The text after the style was applied to the source text", "is_optional": false, "type": "formattedText" }, "source_text": { "description": "Source text", "is_optional": false, "type": "formattedText" } }, "type": "TextCompositionStyleExample" }, "textEntities": { "description": "Contains a list of text entities", "args": { "entities": { "description": "List of text entities", "is_optional": false, "type": "vector\u003ctextEntity\u003e" } }, "type": "TextEntities" }, "textEntity": { "description": "Represents a part of the text that needs to be formatted in some unusual way", "args": { "length": { "description": "Length of the entity, in UTF-16 code units", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the entity, in UTF-16 code units", "is_optional": false, "type": "int32" }, "type": { "description": "Type of the entity", "is_optional": false, "type": "TextEntityType" } }, "type": "TextEntity" }, "textEntityTypeBankCardNumber": { "description": "A bank card number. The getBankCardInfo method can be used to get information about the bank card", "args": {}, "type": "TextEntityType" }, "textEntityTypeBlockQuote": { "description": "Text that must be formatted as if inside a blockquote HTML tag; not supported in secret chats", "args": {}, "type": "TextEntityType" }, "textEntityTypeBold": { "description": "A bold text", "args": {}, "type": "TextEntityType" }, "textEntityTypeBotCommand": { "description": "A bot command, beginning with \"/\"", "args": {}, "type": "TextEntityType" }, "textEntityTypeCashtag": { "description": "A cashtag text, beginning with \"$\", consisting of capital English letters (e.g., \"$USD\"), and optionally containing a chat username at the end", "args": {}, "type": "TextEntityType" }, "textEntityTypeCode": { "description": "Text that must be formatted as if inside a code HTML tag", "args": {}, "type": "TextEntityType" }, "textEntityTypeCustomEmoji": { "description": "A custom emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emoji", "args": { "custom_emoji_id": { "description": "Unique identifier of the custom emoji", "is_optional": false, "type": "int64" } }, "type": "TextEntityType" }, "textEntityTypeDateTime": { "description": "A date and time", "args": { "formatting_type": { "description": "Date and time formatting type; may be null if none and the original text must not be changed", "is_optional": true, "type": "DateTimeFormattingType" }, "unix_time": { "description": "Point in time (Unix timestamp) representing the date and time", "is_optional": false, "type": "int32" } }, "type": "TextEntityType" }, "textEntityTypeEmailAddress": { "description": "An email address", "args": {}, "type": "TextEntityType" }, "textEntityTypeExpandableBlockQuote": { "description": "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", "args": {}, "type": "TextEntityType" }, "textEntityTypeHashtag": { "description": "A hashtag text, beginning with \"#\" and optionally containing a chat username at the end", "args": {}, "type": "TextEntityType" }, "textEntityTypeItalic": { "description": "An italic text", "args": {}, "type": "TextEntityType" }, "textEntityTypeMediaTimestamp": { "description": "A media timestamp", "args": { "media_timestamp": { "description": "Timestamp from which a video/audio/video note/voice note/story playing must start, in seconds. The media can be in the content or the link preview of the current message, or in the same places in the replied message", "is_optional": false, "type": "int32" } }, "type": "TextEntityType" }, "textEntityTypeMention": { "description": "A mention of a user, a supergroup, or a channel by their username", "args": {}, "type": "TextEntityType" }, "textEntityTypeMentionName": { "description": "A text shows instead of a raw mention of the user (e.g., when the user has no username)", "args": { "user_id": { "description": "Identifier of the mentioned user", "is_optional": false, "type": "int53" } }, "type": "TextEntityType" }, "textEntityTypePhoneNumber": { "description": "A phone number", "args": {}, "type": "TextEntityType" }, "textEntityTypePre": { "description": "Text that must be formatted as if inside a pre HTML tag", "args": {}, "type": "TextEntityType" }, "textEntityTypePreCode": { "description": "Text that must be formatted as if inside pre, and code HTML tags", "args": { "language": { "description": "Programming language of the code; as defined by the sender", "is_optional": false, "type": "string" } }, "type": "TextEntityType" }, "textEntityTypeSpoiler": { "description": "A spoiler text", "args": {}, "type": "TextEntityType" }, "textEntityTypeStrikethrough": { "description": "A strikethrough text", "args": {}, "type": "TextEntityType" }, "textEntityTypeTextUrl": { "description": "A text description shown instead of a raw URL", "args": { "url": { "description": "HTTP or tg:// URL to be opened when the link is clicked", "is_optional": false, "type": "string" } }, "type": "TextEntityType" }, "textEntityTypeTonAddress": { "description": "An address in the TON blockchain", "args": {}, "type": "TextEntityType" }, "textEntityTypeUnderline": { "description": "An underlined text", "args": {}, "type": "TextEntityType" }, "textEntityTypeUrl": { "description": "An HTTP URL", "args": {}, "type": "TextEntityType" }, "textParseModeHTML": { "description": "The text uses HTML-style formatting. The same as Telegram Bot API \"HTML\" parse mode", "args": {}, "type": "TextParseMode" }, "textParseModeMarkdown": { "description": "The text uses Markdown-style formatting", "args": { "version": { "description": "Version of the parser: 0 or 1 - Telegram Bot API \"Markdown\" parse mode, 2 - Telegram Bot API \"MarkdownV2\" parse mode", "is_optional": false, "type": "int32" } }, "type": "TextParseMode" }, "textQuote": { "description": "Describes manually or automatically chosen quote from another message", "args": { "is_manual": { "description": "True, if the quote was manually chosen by the message sender", "is_optional": false, "type": "Bool" }, "position": { "description": "Approximate quote position in the original message in UTF-16 code units as specified by the message sender", "is_optional": false, "type": "int32" }, "text": { "description": "Text of the quote. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities can be present in the text", "is_optional": false, "type": "formattedText" } }, "type": "TextQuote" }, "themeParameters": { "description": "Contains parameters of the application theme", "args": { "accent_text_color": { "description": "An accent color of the text in the RGB format", "is_optional": false, "type": "int32" }, "background_color": { "description": "A color of the background in the RGB format", "is_optional": false, "type": "int32" }, "bottom_bar_background_color": { "description": "A color of the bottom bar background in the RGB format", "is_optional": false, "type": "int32" }, "button_color": { "description": "A color of the buttons in the RGB format", "is_optional": false, "type": "int32" }, "button_text_color": { "description": "A color of text on the buttons in the RGB format", "is_optional": false, "type": "int32" }, "destructive_text_color": { "description": "A color of the text for destructive actions in the RGB format", "is_optional": false, "type": "int32" }, "header_background_color": { "description": "A color of the header background in the RGB format", "is_optional": false, "type": "int32" }, "hint_color": { "description": "A color of hints in the RGB format", "is_optional": false, "type": "int32" }, "link_color": { "description": "A color of links in the RGB format", "is_optional": false, "type": "int32" }, "secondary_background_color": { "description": "A secondary color for the background in the RGB format", "is_optional": false, "type": "int32" }, "section_background_color": { "description": "A color of the section background in the RGB format", "is_optional": false, "type": "int32" }, "section_header_text_color": { "description": "A color of text on the section headers in the RGB format", "is_optional": false, "type": "int32" }, "section_separator_color": { "description": "A color of the section separator in the RGB format", "is_optional": false, "type": "int32" }, "subtitle_text_color": { "description": "A color of the subtitle text in the RGB format", "is_optional": false, "type": "int32" }, "text_color": { "description": "A color of text in the RGB format", "is_optional": false, "type": "int32" } }, "type": "ThemeParameters" }, "themeSettings": { "description": "Describes theme settings", "args": { "accent_color": { "description": "Theme accent color in ARGB format", "is_optional": false, "type": "int32" }, "animate_outgoing_message_fill": { "description": "If true, the freeform gradient fill needs to be animated on every sent message", "is_optional": false, "type": "Bool" }, "background": { "description": "The background to be used in chats; may be null", "is_optional": true, "type": "background" }, "base_theme": { "description": "Base theme for this theme", "is_optional": false, "type": "BuiltInTheme" }, "has_outgoing_message_accent_color": { "description": "True, if there is chosen accent color for outgoing messages; otherwise, the color must be deduced from other theme settings", "is_optional": false, "type": "Bool" }, "outgoing_message_accent_color": { "description": "Accent color of outgoing messages in ARGB format; must be ignored if has_outgoing_message_accent_color is false", "is_optional": false, "type": "int32" }, "outgoing_message_fill": { "description": "The fill to be used as a background for outgoing messages; may be null if the fill from the base theme must be used instead", "is_optional": true, "type": "BackgroundFill" } }, "type": "ThemeSettings" }, "thumbnail": { "description": "Represents a thumbnail", "args": { "file": { "description": "The thumbnail", "is_optional": false, "type": "file" }, "format": { "description": "Thumbnail format", "is_optional": false, "type": "ThumbnailFormat" }, "height": { "description": "Thumbnail height", "is_optional": false, "type": "int32" }, "width": { "description": "Thumbnail width", "is_optional": false, "type": "int32" } }, "type": "Thumbnail" }, "thumbnailFormatGif": { "description": "The thumbnail is in static GIF format. It will be used only for some bot inline query results", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatJpeg": { "description": "The thumbnail is in JPEG format", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatMpeg4": { "description": "The thumbnail is in MPEG4 format. It will be used only for some animations and videos", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatPng": { "description": "The thumbnail is in PNG format. It will be used only for background patterns", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatTgs": { "description": "The thumbnail is in TGS format. It will be used only for sticker sets", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatWebm": { "description": "The thumbnail is in WEBM format. It will be used only for sticker sets", "args": {}, "type": "ThumbnailFormat" }, "thumbnailFormatWebp": { "description": "The thumbnail is in WEBP format. It will be used only for some stickers and sticker sets", "args": {}, "type": "ThumbnailFormat" }, "timeZone": { "description": "Describes a time zone", "args": { "id": { "description": "Unique time zone identifier", "is_optional": false, "type": "string" }, "name": { "description": "Time zone name", "is_optional": false, "type": "string" }, "utc_time_offset": { "description": "Current UTC time offset for the time zone", "is_optional": false, "type": "int32" } }, "type": "TimeZone" }, "timeZones": { "description": "Contains a list of time zones", "args": { "time_zones": { "description": "A list of time zones", "is_optional": false, "type": "vector\u003ctimeZone\u003e" } }, "type": "TimeZones" }, "tonCenterApiRequestTypeGet": { "description": "A GET request", "args": { "query": { "description": "URL-encoded query of the request", "is_optional": false, "type": "string" } }, "type": "TonCenterApiRequestType" }, "tonCenterApiRequestTypePost": { "description": "A POST request", "args": { "payload": { "description": "Payload of the request", "is_optional": false, "type": "string" } }, "type": "TonCenterApiRequestType" }, "tonCenterStreamingApiUrl": { "description": "Contains an HTTP URL for TON Center Streaming API", "args": { "expires_in": { "description": "Time after which the URL expires", "is_optional": false, "type": "int32" }, "url": { "description": "The URL", "is_optional": false, "type": "string" } }, "type": "TonCenterStreamingApiUrl" }, "tonConnectChallenge": { "description": "Represents a TON Connect challenge", "args": { "challenge": { "description": "104-byte challenge", "is_optional": false, "type": "bytes" }, "event_id": { "description": "Unique identifier of the first outgoing event", "is_optional": false, "type": "int64" } }, "type": "TonConnectChallenge" }, "tonConnectConnectItemAddress": { "description": "Address of the wallet", "args": { "network": { "description": "Stringified TON network global_id (e.g. \"-239\" for mainnet); may be empty", "is_optional": true, "type": "string" } }, "type": "TonConnectConnectItem" }, "tonConnectConnectItemProof": { "description": "Proof of the wallet ownership", "args": { "payload": { "description": "Payload to be used for the proof (e.g. nonce + expiration timestamp)", "is_optional": false, "type": "string" } }, "type": "TonConnectConnectItem" }, "tonConnectConnectRequest": { "description": "Contains information about a request to connect the user's TON wallet to a dApp using TON Connect", "args": { "items": { "description": "Items requested from the wallet", "is_optional": false, "type": "vector\u003cTonConnectConnectItem\u003e" }, "manifest_url": { "description": "URL of the manifest of the dApp", "is_optional": false, "type": "string" } }, "type": "TonConnectConnectRequest" }, "tonConnectManifestFailed": { "description": "The manifest has failed to download", "args": {}, "type": "TonConnectManifest" }, "tonConnectManifestInfo": { "description": "The manifest is available", "args": { "icon": { "description": "App icon in PNG or ICO format", "is_optional": false, "type": "document" }, "name": { "description": "Name of the dApp", "is_optional": false, "type": "string" }, "url": { "description": "URL of the dApp", "is_optional": false, "type": "string" } }, "type": "TonConnectManifest" }, "tonConnectManifestInvalid": { "description": "The manifest is invalid", "args": {}, "type": "TonConnectManifest" }, "tonConnectManifestPending": { "description": "The manifest is being downloaded", "args": {}, "type": "TonConnectManifest" }, "tonConnectRequest": { "description": "Represents a pending TON Connect request", "args": { "body": { "description": "Body of the request", "is_optional": false, "type": "bytes" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the request will expire; 0 if never", "is_optional": false, "type": "int32" }, "message_id": { "description": "Unique identifier of the service message in the chat 777000 with the request", "is_optional": false, "type": "int53" }, "session_id": { "description": "Unique identifier of the session", "is_optional": false, "type": "int64" }, "topic": { "description": "Topic of the request; may be empty if none", "is_optional": true, "type": "string" }, "trace_id": { "description": "Identifier to trace the request; may be empty if none", "is_optional": true, "type": "string" } }, "type": "TonConnectRequest" }, "tonConnectRequestStateAccepted": { "description": "The request was accepted", "args": {}, "type": "TonConnectRequestState" }, "tonConnectRequestStatePending": { "description": "The request must be accepted or rejected if it isn't expired yet", "args": { "expiration_date": { "description": "Point in time (Unix timestamp) when the request will expire or has expired", "is_optional": false, "type": "int32" } }, "type": "TonConnectRequestState" }, "tonConnectRequestStateRejected": { "description": "The request was rejected", "args": {}, "type": "TonConnectRequestState" }, "tonConnectRequests": { "description": "Represents a session with its pending TON Connect requests", "args": { "requests": { "description": "The requests", "is_optional": false, "type": "vector\u003ctonConnectRequest\u003e" }, "session": { "description": "The session", "is_optional": false, "type": "tonConnectSession" } }, "type": "TonConnectRequests" }, "tonConnectSession": { "description": "Represents a TON Connect session. See https://github.com/ton-blockchain/ton-connect/tree/main/spec for full TON Connect protocol documentation", "args": { "creation_date": { "description": "Point in time (Unix timestamp) when the session was created", "is_optional": false, "type": "int32" }, "dapp_client_id": { "description": "Hex-encoded public X25519 key of the dApp", "is_optional": false, "type": "string" }, "id": { "description": "Unique identifier of the session", "is_optional": false, "type": "int64" }, "manifest": { "description": "Manifest of the dApp", "is_optional": false, "type": "TonConnectManifest" }, "nonce": { "description": "Nonce used for the session", "is_optional": false, "type": "bytes" }, "state": { "description": "Session state", "is_optional": false, "type": "TonConnectSessionState" }, "wallet_client_id": { "description": "Hex-encoded public X25519 key of the current user's application; may be empty if none", "is_optional": true, "type": "string" } }, "type": "TonConnectSession" }, "tonConnectSessionEventId": { "description": "Represents identifier of an event in a TON Connect session", "args": { "event_id": { "description": "The event identifier", "is_optional": false, "type": "int64" } }, "type": "TonConnectSessionEventId" }, "tonConnectSessionStateClosed": { "description": "The session is closed", "args": {}, "type": "TonConnectSessionState" }, "tonConnectSessionStateClosing": { "description": "The session is being closed", "args": {}, "type": "TonConnectSessionState" }, "tonConnectSessionStatePending": { "description": "The session is pending", "args": {}, "type": "TonConnectSessionState" }, "tonConnectSessionStateReady": { "description": "The session is ready", "args": {}, "type": "TonConnectSessionState" }, "tonConnectSessions": { "description": "Contains a list of TON Connect sessions", "args": { "sessions": { "description": "The list of sessions", "is_optional": false, "type": "vector\u003ctonConnectSession\u003e" } }, "type": "TonConnectSessions" }, "tonNft": { "description": "Represents an NFT in the TON blockchain", "args": { "address": { "description": "Address of the NFT", "is_optional": false, "type": "string" }, "attributes": { "description": "Attributes of the NFT", "is_optional": false, "type": "vector\u003ctonNftAttribute\u003e" }, "collection_address": { "description": "Address of the collection to which the NFT belongs; may be empty if unknown", "is_optional": true, "type": "string" }, "content": { "description": "Content of the NFT; may be null if none", "is_optional": true, "type": "document" }, "description": { "description": "Description of the NFT", "is_optional": false, "type": "string" }, "extra": { "description": "Additional data about the NFT; may be null if none", "is_optional": true, "type": "JsonValue" }, "image": { "description": "Image of the NFT; may be null if none", "is_optional": true, "type": "photoSize" }, "index": { "description": "Index of the NFT among all NFTs from the collection as a decimal number", "is_optional": false, "type": "string" }, "name": { "description": "Name of the NFT", "is_optional": false, "type": "string" }, "owner_address": { "description": "Address of the owner of the NFT", "is_optional": false, "type": "string" }, "sticker": { "description": "Sticker of the NFT; may be null if none", "is_optional": true, "type": "sticker" }, "thumbnail": { "description": "Thumbnail of the NFT; may be null if none", "is_optional": true, "type": "photoSize" } }, "type": "TonNft" }, "tonNftAttribute": { "description": "Represents an attribute of an NFT in the TON blockchain", "args": { "trait_type": { "description": "Trait type", "is_optional": false, "type": "string" }, "value": { "description": "Value of the attribute", "is_optional": false, "type": "string" } }, "type": "TonNftAttribute" }, "tonNfts": { "description": "Represents a list of TON NFTs", "args": { "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "nfts": { "description": "List of NFTs", "is_optional": false, "type": "vector\u003ctonNft\u003e" } }, "type": "TonNfts" }, "tonTransaction": { "description": "Represents a transaction changing the amount of owned TON Grams", "args": { "date": { "description": "Point in time (Unix timestamp) when the transaction was completed", "is_optional": false, "type": "int32" }, "gram_amount": { "description": "The amount of added owned Grams, in the smallest units of the cryptocurrency; negative for outgoing transactions", "is_optional": false, "type": "int53" }, "id": { "description": "Unique identifier of the transaction", "is_optional": false, "type": "string" }, "is_refund": { "description": "True, if the transaction is a refund of a previous transaction", "is_optional": false, "type": "Bool" }, "type": { "description": "Type of the transaction", "is_optional": false, "type": "TonTransactionType" } }, "type": "TonTransaction" }, "tonTransactionTypeFragmentDeposit": { "description": "The transaction is a deposit of Grams from Fragment", "args": { "is_gift": { "description": "True, if the transaction is a gift from another user", "is_optional": false, "type": "Bool" }, "sticker": { "description": "The sticker to be shown in the transaction information; may be null if unknown", "is_optional": true, "type": "sticker" } }, "type": "TonTransactionType" }, "tonTransactionTypeFragmentWithdrawal": { "description": "The transaction is a withdrawal of earned Grams to Fragment", "args": { "withdrawal_state": { "description": "State of the withdrawal; may be null for refunds from Fragment", "is_optional": true, "type": "RevenueWithdrawalState" } }, "type": "TonTransactionType" }, "tonTransactionTypeGiftPurchaseOffer": { "description": "The transaction is an offer of gift purchase", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" } }, "type": "TonTransactionType" }, "tonTransactionTypeStakeDicePayout": { "description": "The transaction is a payment for successful stake dice throw", "args": {}, "type": "TonTransactionType" }, "tonTransactionTypeStakeDiceStake": { "description": "The transaction is a payment for stake dice throw", "args": {}, "type": "TonTransactionType" }, "tonTransactionTypeSuggestedPostPayment": { "description": "The transaction is a payment for a suggested post", "args": { "chat_id": { "description": "Identifier of the channel chat that posted the post", "is_optional": false, "type": "int53" } }, "type": "TonTransactionType" }, "tonTransactionTypeUnsupported": { "description": "The transaction is a transaction of an unsupported type", "args": {}, "type": "TonTransactionType" }, "tonTransactionTypeUpgradedGiftPurchase": { "description": "The transaction is a purchase of an upgraded gift for some user or channel", "args": { "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "user_id": { "description": "Identifier of the user who sold the gift", "is_optional": false, "type": "int53" } }, "type": "TonTransactionType" }, "tonTransactionTypeUpgradedGiftSale": { "description": "The transaction is a sale of an upgraded gift", "args": { "commission_gram_amount": { "description": "The Gram amount that was received by the Telegram; in the smallest units of the currency", "is_optional": false, "type": "int53" }, "commission_per_mille": { "description": "The number of Grams received by the Telegram for each 1000 Grams received by the seller of the gift", "is_optional": false, "type": "int32" }, "gift": { "description": "The gift", "is_optional": false, "type": "upgradedGift" }, "user_id": { "description": "Identifier of the user who bought the gift", "is_optional": false, "type": "int53" }, "via_offer": { "description": "True, if the gift was sold through a purchase offer", "is_optional": false, "type": "Bool" } }, "type": "TonTransactionType" }, "tonTransactions": { "description": "Represents a list of TON Gram transactions", "args": { "gram_amount": { "description": "The total amount of owned Grams, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "transactions": { "description": "List of Gram transactions", "is_optional": false, "type": "vector\u003ctonTransaction\u003e" } }, "type": "TonTransactions" }, "tonWalletGaslessTransfersInfo": { "description": "Represents state of gasless transfers for the current user", "args": { "left_count": { "description": "Number of left gasless transfers. The daily available number of gasless transfers is available as getOption(\"ton_wallet_gasless_transfer_daily_count_max\")", "is_optional": false, "type": "int32" }, "relayer_address": { "description": "Address of the relayer for gasless transfers; may be empty if unavailable", "is_optional": true, "type": "string" }, "reset_date": { "description": "Point in time (Unix timestamp) when the number of left transfers will be reset; 0 if never", "is_optional": false, "type": "int32" } }, "type": "TonWalletGaslessTransfersInfo" }, "tonWalletOwnershipProof": { "description": "Represents a proof of TON wallet ownership", "args": { "public_key": { "description": "Public key of the wallet", "is_optional": false, "type": "bytes" }, "signature": { "description": "The signature prooving the ownership", "is_optional": false, "type": "bytes" }, "timestamp": { "description": "The current UNIX timestamp which was used to create the proof", "is_optional": false, "type": "int32" } }, "type": "TonWalletOwnershipProof" }, "tonWalletOwnershipProofChallenge": { "description": "Represents a challenge for TON wallet ownership proof", "args": { "domain": { "description": "Domain of the proof requester", "is_optional": false, "type": "string" }, "payload": { "description": "Payload of the challenge", "is_optional": false, "type": "string" } }, "type": "TonWalletOwnershipProofChallenge" }, "tonWalletState": { "description": "Describes state of the wallet of the current user in the TON blockchain", "args": { "address": { "description": "Address of the wallet; may be empty if none", "is_optional": true, "type": "string" }, "can_enable_backup": { "description": "True, if the user can enable backup for the wallet key", "is_optional": false, "type": "Bool" }, "can_export_phrase": { "description": "True, if the wallet key can be exported using getTonWalletSecretPhrase", "is_optional": false, "type": "Bool" }, "gram_amount": { "description": "The total amount of owned TON Grams, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "is_backup_enabled": { "description": "True, if backup for the wallet key is enabled", "is_optional": false, "type": "Bool" }, "is_being_created": { "description": "True, if the wallet is being created", "is_optional": false, "type": "Bool" }, "public_key": { "description": "Public key of the wallet; may be empty if none", "is_optional": true, "type": "bytes" } }, "type": "TonWalletState" }, "tonWalletTransaction": { "description": "Represents a transaction with the TON wallet of the current user", "args": { "date": { "description": "Point in time (Unix timestamp) when the transaction was completed", "is_optional": false, "type": "int32" }, "fee_amount": { "description": "The fee amount paid for the transaction in TON Grams, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "id": { "description": "Unique identifier of the transaction", "is_optional": false, "type": "string" }, "peer_address": { "description": "Address in the TON blockchain of the transaction peer; may be empty if the transaction isn't a wallet transfer", "is_optional": true, "type": "string" }, "peer_domain": { "description": "Identifier of the domain assigned to the peer address; may be empty if none", "is_optional": true, "type": "string" }, "peer_user_id": { "description": "Identifier of the other user who participated in the transaction; 0 if unknown", "is_optional": false, "type": "int53" }, "state": { "description": "State of the transaction", "is_optional": false, "type": "TonWalletTransactionState" }, "type": { "description": "Type of the transaction", "is_optional": false, "type": "TonWalletTransactionType" } }, "type": "TonWalletTransaction" }, "tonWalletTransactionStateFailed": { "description": "The transaction failed", "args": {}, "type": "TonWalletTransactionState" }, "tonWalletTransactionStateSucceeded": { "description": "The transaction succeeded", "args": { "tx_hash": { "description": "Hash of the transaction", "is_optional": false, "type": "string" } }, "type": "TonWalletTransactionState" }, "tonWalletTransactionTypeKeyChange": { "description": "Change of the wallet key", "args": {}, "type": "TonWalletTransactionType" }, "tonWalletTransactionTypeNftTransfer": { "description": "A transfer of a TON NFT to or from the wallet", "args": { "comment": { "description": "Comment added to the transaction", "is_optional": false, "type": "string" }, "is_comment_encrypted": { "description": "True, if the comment is encrypted and must be decrypted using the user's private key", "is_optional": false, "type": "Bool" }, "is_outgoing": { "description": "True, if the transfer is outgoing", "is_optional": false, "type": "Bool" }, "nft": { "description": "The transferred NFT", "is_optional": false, "type": "tonNft" } }, "type": "TonWalletTransactionType" }, "tonWalletTransactionTypeOnRampDeposit": { "description": "The transaction is a deposit from an on-ramp provider", "args": { "amount": { "description": "The amount of received cryptocurrency, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "provider_name": { "description": "Name of the on-ramp provider", "is_optional": false, "type": "string" } }, "type": "TonWalletTransactionType" }, "tonWalletTransactionTypeTransfer": { "description": "A transfer of TON Grams to or from the wallet", "args": { "amount": { "description": "The amount of received cryptocurrency, in the smallest units of the cryptocurrency; negative for outgoing transactions", "is_optional": false, "type": "int53" }, "comment": { "description": "Comment added to the transaction", "is_optional": false, "type": "string" }, "is_comment_encrypted": { "description": "True, if the comment is encrypted and must be decrypted using the user's private key", "is_optional": false, "type": "Bool" }, "is_gasless": { "description": "True, if the fee was paid by Telegram", "is_optional": false, "type": "Bool" } }, "type": "TonWalletTransactionType" }, "tonWalletTransactions": { "description": "Represents a list of TON Gram transactions", "args": { "gram_amount": { "description": "The total amount of owned TON Grams, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "next_offset": { "description": "The offset for the next request. If empty, then there are no more results", "is_optional": false, "type": "string" }, "transactions": { "description": "List of transactions", "is_optional": false, "type": "vector\u003ctonWalletTransaction\u003e" } }, "type": "TonWalletTransactions" }, "tonWalletTransferReceiverAddress": { "description": "The receiver is specified by its address", "args": { "address": { "description": "Address of the receiver. Use getAddressTonWallet to get information about the user's TON wallet", "is_optional": false, "type": "string" } }, "type": "TonWalletTransferReceiver" }, "tonWalletTransferReceiverUser": { "description": "The receiver is specified by its username", "args": { "username": { "description": "Username of the user. Use searchPublicChat to find the user, check that it is a regular user,", "is_optional": false, "type": "string" } }, "type": "TonWalletTransferReceiver" }, "tonWalletTransferResult": { "description": "Represents result of cryptocurrency transfer from the current user's TON wallet", "args": { "is_gasless": { "description": "True, if the transfer is gasless", "is_optional": false, "type": "Bool" }, "msg_hash": { "description": "Unique identifier of the sent message; use getTonWalletTransactionByMsgHash to poll information about the transaction", "is_optional": false, "type": "bytes" }, "transaction": { "description": "The completed transaction; may be null if the transaction is still pending", "is_optional": true, "type": "tonWalletTransaction" } }, "type": "TonWalletTransferResult" }, "topChatCategoryBots": { "description": "A category containing frequently used private chats with bot users", "args": {}, "type": "TopChatCategory" }, "topChatCategoryCalls": { "description": "A category containing frequently used chats used for calls", "args": {}, "type": "TopChatCategory" }, "topChatCategoryChannels": { "description": "A category containing frequently used channels", "args": {}, "type": "TopChatCategory" }, "topChatCategoryForwardChats": { "description": "A category containing frequently used chats used to forward messages", "args": {}, "type": "TopChatCategory" }, "topChatCategoryGroups": { "description": "A category containing frequently used basic groups and supergroups", "args": {}, "type": "TopChatCategory" }, "topChatCategoryGuestBots": { "description": "A category containing frequently used chats with bots, which were used as guest bots", "args": {}, "type": "TopChatCategory" }, "topChatCategoryInlineBots": { "description": "A category containing frequently used chats with inline bots sorted by their usage in inline mode", "args": {}, "type": "TopChatCategory" }, "topChatCategoryUsers": { "description": "A category containing frequently used private chats with non-bot users", "args": {}, "type": "TopChatCategory" }, "topChatCategoryWebAppBots": { "description": "A category containing frequently used chats with bots, which Web Apps were opened", "args": {}, "type": "TopChatCategory" }, "transactionDirectionIncoming": { "description": "The transaction is incoming and increases the amount of owned currency", "args": {}, "type": "TransactionDirection" }, "transactionDirectionOutgoing": { "description": "The transaction is outgoing and decreases the amount of owned currency", "args": {}, "type": "TransactionDirection" }, "trendingStickerSets": { "description": "Represents a list of trending sticker sets", "args": { "is_premium": { "description": "True, if the list contains sticker sets with premium stickers", "is_optional": false, "type": "Bool" }, "sets": { "description": "List of trending sticker sets", "is_optional": false, "type": "vector\u003cstickerSetInfo\u003e" }, "total_count": { "description": "Approximate total number of trending sticker sets", "is_optional": false, "type": "int32" } }, "type": "TrendingStickerSets" }, "unconfirmedSession": { "description": "Contains information about an unconfirmed session", "args": { "date": { "description": "Point in time (Unix timestamp) when the user has logged in or the business bot was connected", "is_optional": false, "type": "int32" }, "device_model": { "description": "Model of the device that was used for the session creation, as provided by the application", "is_optional": false, "type": "string" }, "location": { "description": "A human-readable description of the location from which the session was created, based on the IP address", "is_optional": false, "type": "string" }, "type": { "description": "Session type", "is_optional": false, "type": "SessionType" } }, "type": "UnconfirmedSession" }, "unreadReaction": { "description": "Contains information about an unread reaction to a message", "args": { "is_big": { "description": "True, if the reaction was added with a big animation", "is_optional": false, "type": "Bool" }, "sender_id": { "description": "Identifier of the sender, added the reaction", "is_optional": false, "type": "MessageSender" }, "type": { "description": "Type of the reaction", "is_optional": false, "type": "ReactionType" } }, "type": "UnreadReaction" }, "upgradeGiftResult": { "description": "Contains result of gift upgrading", "args": { "can_be_transferred": { "description": "True, if the gift can be transferred to another owner", "is_optional": false, "type": "Bool" }, "drop_original_details_star_count": { "description": "Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available", "is_optional": false, "type": "int53" }, "export_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred to the TON blockchain as an NFT; can be in the past", "is_optional": false, "type": "int32" }, "gift": { "description": "The upgraded gift", "is_optional": false, "type": "upgradedGift" }, "is_saved": { "description": "True, if the gift is displayed on the user's or the channel's profile page", "is_optional": false, "type": "Bool" }, "next_resale_date": { "description": "Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can't be resold; only for the receiver of the gift", "is_optional": false, "type": "int32" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn't possible", "is_optional": false, "type": "int32" }, "received_gift_id": { "description": "Unique identifier of the received gift for the current user", "is_optional": false, "type": "string" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the upgraded gift", "is_optional": false, "type": "int53" } }, "type": "UpgradeGiftResult" }, "upgradedGift": { "description": "Describes an upgraded gift that can be transferred to another owner or transferred to the TON blockchain as an NFT", "args": { "backdrop": { "description": "Backdrop of the upgraded gift", "is_optional": false, "type": "upgradedGiftBackdrop" }, "can_send_purchase_offer": { "description": "True, if an offer to purchase the gift can be sent using sendGiftPurchaseOffer", "is_optional": false, "type": "Bool" }, "colors": { "description": "Colors that can be set for user's name, background of empty chat photo, replies to messages and link previews; may be null if none or unknown", "is_optional": true, "type": "upgradedGiftColors" }, "craft_probability_per_mille": { "description": "Probability that the gift adds to the chance of successful crafting of a new gift; 0 if the gift can't be used for crafting", "is_optional": false, "type": "int32" }, "gift_address": { "description": "Address of the gift NFT in TON blockchain; may be empty if none. Append the address to getOption(\"ton_blockchain_explorer_url\") to get a link with information about the address", "is_optional": true, "type": "string" }, "host_id": { "description": "Identifier of the user or the chat to which the upgraded gift was assigned from blockchain; may be null if none or unknown", "is_optional": true, "type": "MessageSender" }, "id": { "description": "Unique identifier of the gift", "is_optional": false, "type": "int64" }, "is_burned": { "description": "True, if the gift was used to craft another gift", "is_optional": false, "type": "Bool" }, "is_crafted": { "description": "True, if the gift was crafted from other gifts", "is_optional": false, "type": "Bool" }, "is_premium": { "description": "True, if the original gift could have been bought only by Telegram Premium subscribers", "is_optional": false, "type": "Bool" }, "is_theme_available": { "description": "True, if the gift can be used to set a theme in a chat", "is_optional": false, "type": "Bool" }, "max_upgraded_count": { "description": "The maximum number of gifts that can be upgraded from the same gift", "is_optional": false, "type": "int32" }, "model": { "description": "Model of the upgraded gift", "is_optional": false, "type": "upgradedGiftModel" }, "name": { "description": "Unique name of the upgraded gift that can be used with internalLinkTypeUpgradedGift or sendResoldGift", "is_optional": false, "type": "string" }, "number": { "description": "Unique number of the upgraded gift among gifts upgraded from the same gift", "is_optional": false, "type": "int32" }, "original_details": { "description": "Information about the originally sent gift; may be null if unknown", "is_optional": true, "type": "upgradedGiftOriginalDetails" }, "owner_address": { "description": "Address of the gift NFT owner in TON blockchain; may be empty if none. Append the address to getOption(\"ton_blockchain_explorer_url\") to get a link with information about the address", "is_optional": true, "type": "string" }, "owner_id": { "description": "Identifier of the user or the chat that owns the upgraded gift; may be null if none or unknown", "is_optional": true, "type": "MessageSender" }, "owner_name": { "description": "Name of the owner for the case when owner identifier and address aren't known", "is_optional": false, "type": "string" }, "publisher_chat_id": { "description": "Identifier of the chat that published the gift; 0 if none", "is_optional": false, "type": "int53" }, "regular_gift_id": { "description": "Unique identifier of the regular gift from which the gift was upgraded; may be 0 for short period of time for old gifts from database", "is_optional": false, "type": "int64" }, "resale_parameters": { "description": "Resale parameters of the gift; may be null if resale isn't possible", "is_optional": true, "type": "giftResaleParameters" }, "symbol": { "description": "Symbol of the upgraded gift", "is_optional": false, "type": "upgradedGiftSymbol" }, "title": { "description": "The title of the upgraded gift", "is_optional": false, "type": "string" }, "total_upgraded_count": { "description": "Total number of gifts that were upgraded from the same gift", "is_optional": false, "type": "int32" }, "used_theme_chat_id": { "description": "Identifier of the chat for which the gift is used to set a theme; 0 if none or the gift isn't owned by the current user", "is_optional": false, "type": "int53" }, "value_amount": { "description": "Estimated value of the gift; in the smallest units of the currency; 0 if unavailable", "is_optional": false, "type": "int53" }, "value_currency": { "description": "ISO 4217 currency code of the currency in which value of the gift is represented; may be empty if unavailable", "is_optional": true, "type": "string" }, "value_usd_amount": { "description": "Estimated value of the gift in USD; in USD cents; 0 if unavailable", "is_optional": false, "type": "int53" } }, "type": "UpgradedGift" }, "upgradedGiftAttributeIdBackdrop": { "description": "Identifier of a gift backdrop", "args": { "backdrop_id": { "description": "Identifier of the backdrop", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftAttributeId" }, "upgradedGiftAttributeIdModel": { "description": "Identifier of a gift model", "args": { "sticker_id": { "description": "Identifier of the sticker representing the model", "is_optional": false, "type": "int64" } }, "type": "UpgradedGiftAttributeId" }, "upgradedGiftAttributeIdSymbol": { "description": "Identifier of a gift symbol", "args": { "sticker_id": { "description": "Identifier of the sticker representing the symbol", "is_optional": false, "type": "int64" } }, "type": "UpgradedGiftAttributeId" }, "upgradedGiftAttributeRarityEpic": { "description": "The attribute is epic", "args": {}, "type": "UpgradedGiftAttributeRarity" }, "upgradedGiftAttributeRarityLegendary": { "description": "The attribute is legendary", "args": {}, "type": "UpgradedGiftAttributeRarity" }, "upgradedGiftAttributeRarityPerMille": { "description": "The rarity is represented as the numeric frequency of the model", "args": { "per_mille": { "description": "The number of upgraded gifts that receive this attribute for each 1000 gifts upgraded; if 0, then it can be shown as \"\u003c0.1%\"", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftAttributeRarity" }, "upgradedGiftAttributeRarityRare": { "description": "The attribute is rare", "args": {}, "type": "UpgradedGiftAttributeRarity" }, "upgradedGiftAttributeRarityUncommon": { "description": "The attribute is uncommon", "args": {}, "type": "UpgradedGiftAttributeRarity" }, "upgradedGiftBackdrop": { "description": "Describes a backdrop of an upgraded gift", "args": { "colors": { "description": "Colors of the backdrop", "is_optional": false, "type": "upgradedGiftBackdropColors" }, "id": { "description": "Unique identifier of the backdrop", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the backdrop", "is_optional": false, "type": "string" }, "rarity": { "description": "The rarity of the backdrop", "is_optional": false, "type": "UpgradedGiftAttributeRarity" } }, "type": "UpgradedGiftBackdrop" }, "upgradedGiftBackdropColors": { "description": "Describes colors of a backdrop of an upgraded gift", "args": { "center_color": { "description": "A color in the center of the backdrop in the RGB format", "is_optional": false, "type": "int32" }, "edge_color": { "description": "A color on the edges of the backdrop in the RGB format", "is_optional": false, "type": "int32" }, "symbol_color": { "description": "A color to be applied for the symbol in the RGB format", "is_optional": false, "type": "int32" }, "text_color": { "description": "A color for the text on the backdrop in the RGB format", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftBackdropColors" }, "upgradedGiftBackdropCount": { "description": "Describes a backdrop of an upgraded gift", "args": { "backdrop": { "description": "The backdrop", "is_optional": false, "type": "upgradedGiftBackdrop" }, "total_count": { "description": "Total number of gifts with the symbol", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftBackdropCount" }, "upgradedGiftColors": { "description": "Contains information about color scheme for user's name, background of empty chat photo, replies to messages and link previews", "args": { "dark_theme_accent_color": { "description": "Accent color to use in dark themes in RGB format", "is_optional": false, "type": "int32" }, "dark_theme_colors": { "description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in dark themes", "is_optional": false, "type": "vector\u003cint32\u003e" }, "id": { "description": "Unique identifier of the upgraded gift colors", "is_optional": false, "type": "int64" }, "light_theme_accent_color": { "description": "Accent color to use in light themes in RGB format", "is_optional": false, "type": "int32" }, "light_theme_colors": { "description": "The list of 1-3 colors in RGB format, describing the accent color, as expected to be shown in light themes", "is_optional": false, "type": "vector\u003cint32\u003e" }, "model_custom_emoji_id": { "description": "Custom emoji identifier of the model of the upgraded gift", "is_optional": false, "type": "int64" }, "symbol_custom_emoji_id": { "description": "Custom emoji identifier of the symbol of the upgraded gift", "is_optional": false, "type": "int64" } }, "type": "UpgradedGiftColors" }, "upgradedGiftModel": { "description": "Describes a model of an upgraded gift", "args": { "is_crafted": { "description": "True, if the model can be obtained only through gift crafting", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the model", "is_optional": false, "type": "string" }, "rarity": { "description": "The rarity of the model", "is_optional": false, "type": "UpgradedGiftAttributeRarity" }, "sticker": { "description": "The sticker representing the upgraded gift", "is_optional": false, "type": "sticker" } }, "type": "UpgradedGiftModel" }, "upgradedGiftModelCount": { "description": "Describes a model of an upgraded gift with the number of gifts found", "args": { "model": { "description": "The model", "is_optional": false, "type": "upgradedGiftModel" }, "total_count": { "description": "Total number of gifts with the model", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftModelCount" }, "upgradedGiftOriginBlockchain": { "description": "The gift was assigned from blockchain and isn't owned by the current user. The gift can't be transferred, resold or withdrawn to blockchain", "args": {}, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginCraft": { "description": "The gift was crafted from other gifts", "args": {}, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginOffer": { "description": "The gift was bought through an offer", "args": { "price": { "description": "Price paid for the gift", "is_optional": false, "type": "GiftResalePrice" } }, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginPrepaidUpgrade": { "description": "The sender or receiver of the message has paid for upgrade of the gift, which has been completed", "args": {}, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginResale": { "description": "The gift was bought from another user", "args": { "price": { "description": "Price paid for the gift", "is_optional": false, "type": "GiftResalePrice" } }, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginTransfer": { "description": "The gift was transferred from another owner", "args": {}, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginUpgrade": { "description": "The gift was obtained by upgrading of a previously received gift", "args": { "gift_message_id": { "description": "Identifier of the message with the regular gift that was upgraded; may be 0 or an identifier of a deleted message", "is_optional": false, "type": "int53" } }, "type": "UpgradedGiftOrigin" }, "upgradedGiftOriginalDetails": { "description": "Describes the original details about the gift", "args": { "date": { "description": "Point in time (Unix timestamp) when the gift was sent", "is_optional": false, "type": "int32" }, "receiver_id": { "description": "Identifier of the user or the chat that received the gift", "is_optional": false, "type": "MessageSender" }, "sender_id": { "description": "Identifier of the user or the chat that sent the gift; may be null if the gift was private", "is_optional": true, "type": "MessageSender" }, "text": { "description": "Message added to the gift", "is_optional": false, "type": "formattedText" } }, "type": "UpgradedGiftOriginalDetails" }, "upgradedGiftSymbol": { "description": "Describes a symbol shown on the pattern of an upgraded gift", "args": { "name": { "description": "Name of the symbol", "is_optional": false, "type": "string" }, "rarity": { "description": "The rarity of the symbol", "is_optional": false, "type": "UpgradedGiftAttributeRarity" }, "sticker": { "description": "The sticker representing the symbol", "is_optional": false, "type": "sticker" } }, "type": "UpgradedGiftSymbol" }, "upgradedGiftSymbolCount": { "description": "Describes a symbol shown on the pattern of an upgraded gift", "args": { "symbol": { "description": "The symbol", "is_optional": false, "type": "upgradedGiftSymbol" }, "total_count": { "description": "Total number of gifts with the symbol", "is_optional": false, "type": "int32" } }, "type": "UpgradedGiftSymbolCount" }, "upgradedGiftValueInfo": { "description": "Contains information about value of an upgraded gift", "args": { "average_sale_price": { "description": "The average sale price in the last month of gifts upgraded from the same gift; in the smallest units of the currency; 0 if there were no such sales", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the currency in which the prices are represented", "is_optional": false, "type": "string" }, "fragment_listed_gift_count": { "description": "Number of gifts upgraded from the same gift being resold on Fragment", "is_optional": false, "type": "int32" }, "fragment_url": { "description": "The HTTPS link to the Fragment for the gift; may be empty if there are no such gifts being sold on Fragment", "is_optional": true, "type": "string" }, "initial_sale_date": { "description": "Point in time (Unix timestamp) when the corresponding regular gift was originally purchased", "is_optional": false, "type": "int32" }, "initial_sale_price": { "description": "Initial price of the gift; in the smallest units of the currency", "is_optional": false, "type": "int53" }, "initial_sale_star_count": { "description": "The Telegram Star amount that was paid for the gift", "is_optional": false, "type": "int53" }, "is_last_sale_on_fragment": { "description": "True, if the last sale was completed on Fragment", "is_optional": false, "type": "Bool" }, "is_value_average": { "description": "True, if the value is calculated as average value of similar sold gifts. Otherwise, it is based on the sale price of the gift", "is_optional": false, "type": "Bool" }, "last_sale_date": { "description": "Point in time (Unix timestamp) when the upgraded gift was purchased last time; 0 if never", "is_optional": false, "type": "int32" }, "last_sale_price": { "description": "Last purchase price of the gift; in the smallest units of the currency; 0 if the gift has never been resold", "is_optional": false, "type": "int53" }, "minimum_price": { "description": "The current minimum price of gifts upgraded from the same gift; in the smallest units of the currency; 0 if there are no such gifts", "is_optional": false, "type": "int53" }, "telegram_listed_gift_count": { "description": "Number of gifts upgraded from the same gift being resold on Telegram", "is_optional": false, "type": "int32" }, "value": { "description": "Estimated value of the gift; in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "UpgradedGiftValueInfo" }, "user": { "description": "Represents a user", "args": { "accent_color_id": { "description": "Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview", "is_optional": false, "type": "int32" }, "active_story_state": { "description": "State of active stories of the user; may be null if the user has no active stories", "is_optional": true, "type": "ActiveStoryState" }, "added_to_attachment_menu": { "description": "True, if the user added the current bot to attachment menu; only available to bots", "is_optional": false, "type": "Bool" }, "background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none", "is_optional": false, "type": "int64" }, "emoji_status": { "description": "Emoji status to be shown instead of the default Telegram Premium badge; may be null", "is_optional": true, "type": "emojiStatus" }, "first_name": { "description": "First name of the user", "is_optional": false, "type": "string" }, "have_access": { "description": "If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can't be passed to any method", "is_optional": false, "type": "Bool" }, "id": { "description": "User identifier", "is_optional": false, "type": "int53" }, "is_close_friend": { "description": "The user is a close friend of the current user; implies that the user is a contact", "is_optional": false, "type": "Bool" }, "is_contact": { "description": "The user is a contact of the current user", "is_optional": false, "type": "Bool" }, "is_mutual_contact": { "description": "The user is a contact of the current user and the current user is a contact of the user", "is_optional": false, "type": "Bool" }, "is_premium": { "description": "True, if the user is a Telegram Premium user", "is_optional": false, "type": "Bool" }, "is_support": { "description": "True, if the user is Telegram support account", "is_optional": false, "type": "Bool" }, "language_code": { "description": "IETF language tag of the user's language; only available to bots", "is_optional": false, "type": "string" }, "last_name": { "description": "Last name of the user", "is_optional": false, "type": "string" }, "paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by general user for each sent message to the user. If positive and userFullInfo is unknown, use canSendMessageToUser to check whether the current user must pay", "is_optional": false, "type": "int53" }, "phone_number": { "description": "Phone number of the user", "is_optional": false, "type": "string" }, "profile_accent_color_id": { "description": "Identifier of the accent color for the user's profile; -1 if none", "is_optional": false, "type": "int32" }, "profile_background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the background of the user's profile; 0 if none", "is_optional": false, "type": "int64" }, "profile_photo": { "description": "Profile photo of the user; may be null", "is_optional": true, "type": "profilePhoto" }, "restriction_info": { "description": "Information about restrictions that must be applied to the corresponding private chat; may be null if none", "is_optional": true, "type": "restrictionInfo" }, "restricts_new_chats": { "description": "True, if the user may restrict new chats with non-contacts. Use canSendMessageToUser to check whether the current user can message the user or try to create a chat with them", "is_optional": false, "type": "Bool" }, "status": { "description": "Current online status of the user", "is_optional": false, "type": "UserStatus" }, "type": { "description": "Type of the user", "is_optional": false, "type": "UserType" }, "upgraded_gift_colors": { "description": "Color scheme based on an upgraded gift to be used for the user instead of accent_color_id and background_custom_emoji_id; may be null if none", "is_optional": true, "type": "upgradedGiftColors" }, "usernames": { "description": "Usernames of the user; may be null", "is_optional": true, "type": "usernames" }, "verification_status": { "description": "Information about verification status of the user; may be null if none", "is_optional": true, "type": "verificationStatus" } }, "type": "User" }, "userAuctionBid": { "description": "Describes a bid of the current user in an auction", "args": { "bid_date": { "description": "Point in time (Unix timestamp) when the bid was made", "is_optional": false, "type": "int32" }, "next_bid_star_count": { "description": "The minimum number of Telegram Stars that can be put for the next bid", "is_optional": false, "type": "int53" }, "owner_id": { "description": "Identifier of the user or the chat that will receive the auctioned item. If the auction is opened in context of another user or chat, then a warning is supposed to be shown to the current user", "is_optional": false, "type": "MessageSender" }, "star_count": { "description": "The number of Telegram Stars that were put in the bid", "is_optional": false, "type": "int53" }, "was_returned": { "description": "True, if the bid was returned to the user, because it was outbid and can't win anymore", "is_optional": false, "type": "Bool" } }, "type": "UserAuctionBid" }, "userFullInfo": { "description": "Contains full information about a user", "args": { "bio": { "description": "A short user bio; may be null for bots", "is_optional": true, "type": "formattedText" }, "birthdate": { "description": "Birthdate of the user; may be null if unknown", "is_optional": true, "type": "birthdate" }, "block_list": { "description": "Block list to which the user is added; may be null if none", "is_optional": true, "type": "BlockList" }, "bot_info": { "description": "For bots, information about the bot; may be null if the user isn't a bot", "is_optional": true, "type": "botInfo" }, "bot_verification": { "description": "Information about verification status of the user provided by a bot; may be null if none or unknown", "is_optional": true, "type": "botVerification" }, "business_info": { "description": "Information about business settings for Telegram Business accounts; may be null if none", "is_optional": true, "type": "businessInfo" }, "can_be_called": { "description": "True, if the user can be called", "is_optional": false, "type": "Bool" }, "community_id": { "description": "Identifier of the community to which chat with the bot was added; for bots only", "is_optional": false, "type": "int53" }, "first_profile_audio": { "description": "The first audio file added to the user's profile; may be null if none", "is_optional": true, "type": "audio" }, "gift_count": { "description": "Number of saved to profile gifts for other users or the total number of received gifts for the current user", "is_optional": false, "type": "int32" }, "gift_settings": { "description": "Settings for gift receiving for the user", "is_optional": false, "type": "giftSettings" }, "group_in_common_count": { "description": "Number of group chats where both the other user and the current user are a member; 0 for the current user", "is_optional": false, "type": "int32" }, "has_posted_to_profile_stories": { "description": "True, if the user has posted to profile stories", "is_optional": false, "type": "Bool" }, "has_private_calls": { "description": "True, if the user can't be called due to their privacy settings", "is_optional": false, "type": "Bool" }, "has_private_forwards": { "description": "True, if the user can't be linked in forwarded messages due to their privacy settings", "is_optional": false, "type": "Bool" }, "has_restricted_voice_and_video_note_messages": { "description": "True, if voice and video notes can't be sent or forwarded to the user", "is_optional": false, "type": "Bool" }, "has_sponsored_messages_enabled": { "description": "True, if the user always enabled sponsored messages; known only for the current user", "is_optional": false, "type": "Bool" }, "incoming_paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by the user for each sent message to the current user", "is_optional": false, "type": "int53" }, "main_profile_tab": { "description": "The main tab chosen by the user; may be null if not chosen manually", "is_optional": true, "type": "ProfileTab" }, "need_phone_number_privacy_exception": { "description": "True, if the current user needs to explicitly allow to share their phone number with the user when the method addContact is used", "is_optional": false, "type": "Bool" }, "note": { "description": "Note added to the user's contact; may be null if none", "is_optional": true, "type": "formattedText" }, "outgoing_paid_message_star_count": { "description": "Number of Telegram Stars that must be paid by the current user for each sent message to the user", "is_optional": false, "type": "int53" }, "pending_rating": { "description": "The rating of the user after the next change; may be null if the user isn't the current user or there are no pending rating changes", "is_optional": true, "type": "userRating" }, "pending_rating_date": { "description": "Unix timestamp when rating of the user will change to pending_rating; 0 if the user isn't the current user or there are no pending rating changes", "is_optional": false, "type": "int32" }, "personal_chat_id": { "description": "Identifier of the personal chat of the user; 0 if none", "is_optional": false, "type": "int53" }, "personal_photo": { "description": "User profile photo set by the current user for the contact; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown.", "is_optional": true, "type": "chatPhoto" }, "photo": { "description": "User profile photo; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown.", "is_optional": true, "type": "chatPhoto" }, "public_photo": { "description": "User profile photo visible if the main photo is hidden by privacy settings; may be null. If null and user.profile_photo is null, then the photo is empty; otherwise, it is unknown.", "is_optional": true, "type": "chatPhoto" }, "rating": { "description": "The current rating of the user; may be null if none", "is_optional": true, "type": "userRating" }, "set_chat_background": { "description": "True, if the user set chat background for both chat users and it wasn't reverted yet", "is_optional": false, "type": "Bool" }, "supports_video_calls": { "description": "True, if a video call can be created with the user", "is_optional": false, "type": "Bool" }, "uses_unofficial_app": { "description": "True, if the user uses an unofficial application that poses a security risk", "is_optional": false, "type": "Bool" } }, "type": "UserFullInfo" }, "userLink": { "description": "Contains an HTTPS URL, which can be used to get information about a user", "args": { "expires_in": { "description": "Left time for which the link is valid, in seconds; 0 if the link is a public username link", "is_optional": false, "type": "int32" }, "url": { "description": "The URL", "is_optional": false, "type": "string" } }, "type": "UserLink" }, "userPrivacySettingAllowCalls": { "description": "A privacy setting for managing whether the user can be called", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAllowChatInvites": { "description": "A privacy setting for managing whether the user can be invited to chats", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAllowFindingByPhoneNumber": { "description": "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\"", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAllowPeerToPeerCalls": { "description": "A privacy setting for managing whether peer-to-peer connections can be used for calls", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages": { "description": "A privacy setting for managing whether the user can receive voice and video messages in private chats; for Telegram Premium users only", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAllowUnpaidMessages": { "description": "A privacy setting for managing whether the user can receive messages without additional payment", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingAutosaveGifts": { "description": "A privacy setting for managing whether received gifts are automatically shown on the user's profile page", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingRuleAllowAll": { "description": "A rule to allow all users to do something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleAllowBots": { "description": "A rule to allow all bots to do something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleAllowChatMembers": { "description": "A rule to allow all members of certain specified basic groups and supergroups to doing something", "args": { "chat_ids": { "description": "The chat identifiers, total number of chats in all rules must not exceed 20", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleAllowContacts": { "description": "A rule to allow all contacts of the user to do something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleAllowPremiumUsers": { "description": "A rule to allow all Premium Users to do something; currently, allowed only for userPrivacySettingAllowChatInvites", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleAllowUsers": { "description": "A rule to allow certain specified users to do something", "args": { "user_ids": { "description": "The user identifiers, total number of users in all rules must not exceed 1000", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleRestrictAll": { "description": "A rule to restrict all users from doing something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleRestrictBots": { "description": "A rule to restrict all bots from doing something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleRestrictChatMembers": { "description": "A rule to restrict all members of specified basic groups and supergroups from doing something", "args": { "chat_ids": { "description": "The chat identifiers, total number of chats in all rules must not exceed 20", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleRestrictContacts": { "description": "A rule to restrict all contacts of the user from doing something", "args": {}, "type": "UserPrivacySettingRule" }, "userPrivacySettingRuleRestrictUsers": { "description": "A rule to restrict all specified users from doing something", "args": { "user_ids": { "description": "The user identifiers, total number of users in all rules must not exceed 1000", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "UserPrivacySettingRule" }, "userPrivacySettingRules": { "description": "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", "args": { "rules": { "description": "A list of rules", "is_optional": false, "type": "vector\u003cUserPrivacySettingRule\u003e" } }, "type": "UserPrivacySettingRules" }, "userPrivacySettingShowBio": { "description": "A privacy setting for managing whether the user's bio is visible", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowBirthdate": { "description": "A privacy setting for managing whether the user's birthdate is visible", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowLinkInForwardedMessages": { "description": "A privacy setting for managing whether a link to the user's account is included in forwarded messages", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowPhoneNumber": { "description": "A privacy setting for managing whether the user's phone number is visible", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowProfileAudio": { "description": "A privacy setting for managing whether the user's profile audio files are visible", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowProfilePhoto": { "description": "A privacy setting for managing whether the user's profile photo is visible", "args": {}, "type": "UserPrivacySetting" }, "userPrivacySettingShowStatus": { "description": "A privacy setting for managing whether the user's online status is visible", "args": {}, "type": "UserPrivacySetting" }, "userRating": { "description": "Contains description of user rating", "args": { "current_level_rating": { "description": "The rating required for the current level", "is_optional": false, "type": "int53" }, "is_maximum_level_reached": { "description": "True, if the maximum level is reached", "is_optional": false, "type": "Bool" }, "level": { "description": "The level of the user; may be negative", "is_optional": false, "type": "int32" }, "next_level_rating": { "description": "The rating required for the next level; 0 if the maximum level is reached", "is_optional": false, "type": "int53" }, "rating": { "description": "Numerical value of the rating", "is_optional": false, "type": "int53" } }, "type": "UserRating" }, "userStatusEmpty": { "description": "The user's status has never been changed", "args": {}, "type": "UserStatus" }, "userStatusLastMonth": { "description": "The user is offline, but was online last month", "args": { "by_my_privacy_settings": { "description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium", "is_optional": false, "type": "Bool" } }, "type": "UserStatus" }, "userStatusLastWeek": { "description": "The user is offline, but was online last week", "args": { "by_my_privacy_settings": { "description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium", "is_optional": false, "type": "Bool" } }, "type": "UserStatus" }, "userStatusOffline": { "description": "The user is offline", "args": { "was_online": { "description": "Point in time (Unix timestamp) when the user was last online", "is_optional": false, "type": "int32" } }, "type": "UserStatus" }, "userStatusOnline": { "description": "The user is online", "args": { "expires": { "description": "Point in time (Unix timestamp) when the user's online status will expire", "is_optional": false, "type": "int32" } }, "type": "UserStatus" }, "userStatusRecently": { "description": "The user was online recently", "args": { "by_my_privacy_settings": { "description": "Exact user's status is hidden because the current user enabled userPrivacySettingShowStatus privacy setting for the user and has no Telegram Premium", "is_optional": false, "type": "Bool" } }, "type": "UserStatus" }, "userSupportInfo": { "description": "Contains custom information about the user", "args": { "author": { "description": "Information author", "is_optional": false, "type": "string" }, "date": { "description": "Information change date", "is_optional": false, "type": "int32" }, "message": { "description": "Information message", "is_optional": false, "type": "formattedText" } }, "type": "UserSupportInfo" }, "userTonWalletAddress": { "description": "Contains TON wallet address of a user", "args": { "public_key": { "description": "Public key of the user", "is_optional": false, "type": "bytes" }, "user_id": { "description": "Identifier of the user; 0 if unknown", "is_optional": false, "type": "int53" }, "wallet_address": { "description": "Address of the user's wallet in the TON blockchain", "is_optional": false, "type": "string" } }, "type": "UserTonWalletAddress" }, "userTonWalletAddresses": { "description": "Represents a list of TON wallet addresses of users", "args": { "addresses": { "description": "A list of TON wallet addresses", "is_optional": false, "type": "vector\u003cuserTonWalletAddress\u003e" } }, "type": "UserTonWalletAddresses" }, "userTypeBot": { "description": "A bot (see https://core.telegram.org/bots)", "args": { "active_user_count": { "description": "The number of recently active users of the bot", "is_optional": false, "type": "int32" }, "allows_users_to_create_topics": { "description": "True, if users can create and delete topics in the chat with the bot", "is_optional": false, "type": "Bool" }, "can_be_added_to_attachment_menu": { "description": "True, if the bot can be added to attachment or side menu", "is_optional": false, "type": "Bool" }, "can_be_edited": { "description": "True, if the bot is owned by the current user and can be edited using the methods toggleBotUsernameIsActive, reorderBotActiveUsernames, setBotProfilePhoto, setBotName, setBotInfoDescription, and setBotInfoShortDescription", "is_optional": false, "type": "Bool" }, "can_connect_to_business": { "description": "True, if the bot supports connection to user accounts for chat automation", "is_optional": false, "type": "Bool" }, "can_join_groups": { "description": "True, if the bot can be invited to basic group and supergroup chats", "is_optional": false, "type": "Bool" }, "can_manage_bots": { "description": "True, if the bot can manage other bots", "is_optional": false, "type": "Bool" }, "can_read_all_group_messages": { "description": "True, if the bot can read all messages in basic group or supergroup chats and not just those addressed to the bot. In private and channel chats a bot can always read all messages", "is_optional": false, "type": "Bool" }, "has_main_web_app": { "description": "True, if the bot has the main Web App", "is_optional": false, "type": "Bool" }, "has_topics": { "description": "True, if the bot has topics", "is_optional": false, "type": "Bool" }, "inline_query_placeholder": { "description": "Placeholder for inline queries (displayed on the application input field)", "is_optional": false, "type": "string" }, "is_guard": { "description": "True, if the bot can be set as a guard bot in supergroup chats", "is_optional": false, "type": "Bool" }, "is_inline": { "description": "True, if the bot supports inline queries", "is_optional": false, "type": "Bool" }, "need_location": { "description": "True, if the location of the user is expected to be sent with every inline query to this bot", "is_optional": false, "type": "Bool" }, "supports_guest_queries": { "description": "True, if the bot can be queried by username from any non-secret chat", "is_optional": false, "type": "Bool" } }, "type": "UserType" }, "userTypeDeleted": { "description": "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", "args": {}, "type": "UserType" }, "userTypeRegular": { "description": "A regular user", "args": {}, "type": "UserType" }, "userTypeUnknown": { "description": "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", "args": {}, "type": "UserType" }, "usernames": { "description": "Describes usernames assigned to a user, a supergroup, or a channel", "args": { "active_usernames": { "description": "List of active usernames; the first one must be shown as the primary username. The order of active usernames can be changed with reorderActiveUsernames, reorderBotActiveUsernames or reorderSupergroupActiveUsernames", "is_optional": false, "type": "vector\u003cstring\u003e" }, "collectible_usernames": { "description": "Collectible usernames that were purchased at https://fragment.com and can be passed to getCollectibleItemInfo for more details", "is_optional": false, "type": "vector\u003cstring\u003e" }, "disabled_usernames": { "description": "List of currently disabled usernames; the username can be activated with toggleUsernameIsActive, toggleBotUsernameIsActive, or toggleSupergroupUsernameIsActive", "is_optional": false, "type": "vector\u003cstring\u003e" }, "editable_username": { "description": "Active or disabled username, which may be changed with setUsername or setSupergroupUsername", "is_optional": false, "type": "string" }, "secondary_username": { "description": "Secondary non-collectible username. Currently, must be non-empty only for bot accounts. Can't be used in toggleBotUsernameIsActive;", "is_optional": false, "type": "string" } }, "type": "Usernames" }, "users": { "description": "Represents a list of users", "args": { "total_count": { "description": "Approximate total number of users found", "is_optional": false, "type": "int32" }, "user_ids": { "description": "A list of user identifiers", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Users" }, "validatedOrderInfo": { "description": "Contains a temporary identifier of validated order information, which is stored for one hour, and the available shipping options", "args": { "order_info_id": { "description": "Temporary identifier of the order information", "is_optional": false, "type": "string" }, "shipping_options": { "description": "Available shipping options", "is_optional": false, "type": "vector\u003cshippingOption\u003e" } }, "type": "ValidatedOrderInfo" }, "vectorPathCommandCubicBezierCurve": { "description": "A cubic Bézier curve to a given point", "args": { "end_control_point": { "description": "The end control point of the curve", "is_optional": false, "type": "point" }, "end_point": { "description": "The end point of the curve", "is_optional": false, "type": "point" }, "start_control_point": { "description": "The start control point of the curve", "is_optional": false, "type": "point" } }, "type": "VectorPathCommand" }, "vectorPathCommandLine": { "description": "A straight line to a given point", "args": { "end_point": { "description": "The end point of the straight line", "is_optional": false, "type": "point" } }, "type": "VectorPathCommand" }, "venue": { "description": "Describes a venue", "args": { "address": { "description": "Venue address; as defined by the sender", "is_optional": false, "type": "string" }, "id": { "description": "Identifier of the venue in the provider database; as defined by the sender", "is_optional": false, "type": "string" }, "location": { "description": "Venue location; as defined by the sender", "is_optional": false, "type": "location" }, "provider": { "description": "Provider of the venue database; as defined by the sender. Currently, only \"foursquare\" and \"gplaces\" (Google Places) need to be supported", "is_optional": false, "type": "string" }, "title": { "description": "Venue name; as defined by the sender", "is_optional": false, "type": "string" }, "type": { "description": "Type of the venue in the provider database; as defined by the sender", "is_optional": false, "type": "string" } }, "type": "Venue" }, "verificationStatus": { "description": "Contains information about verification status of a chat or a user", "args": { "bot_verification_icon_custom_emoji_id": { "description": "Identifier of the custom emoji to be shown as verification sign provided by a bot for the user; 0 if none", "is_optional": false, "type": "int64" }, "is_fake": { "description": "True, if the chat or the user is marked as fake by Telegram", "is_optional": false, "type": "Bool" }, "is_scam": { "description": "True, if the chat or the user is marked as scam by Telegram", "is_optional": false, "type": "Bool" }, "is_verified": { "description": "True, if the chat or the user is verified by Telegram", "is_optional": false, "type": "Bool" } }, "type": "VerificationStatus" }, "video": { "description": "Describes a video file", "args": { "duration": { "description": "Duration of the video, in seconds; as defined by the sender", "is_optional": false, "type": "int32" }, "file_name": { "description": "Original name of the file; as defined by the sender", "is_optional": false, "type": "string" }, "has_stickers": { "description": "True, if stickers were added to the video. The list of corresponding sticker sets can be received using getAttachedStickerSets", "is_optional": false, "type": "Bool" }, "height": { "description": "Video height; as defined by the sender", "is_optional": false, "type": "int32" }, "mime_type": { "description": "MIME type of the file; as defined by the sender", "is_optional": false, "type": "string" }, "minithumbnail": { "description": "Video minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "supports_streaming": { "description": "True, if the video is expected to be streamed", "is_optional": false, "type": "Bool" }, "thumbnail": { "description": "Video thumbnail in JPEG or MPEG4 format; as defined by the sender; may be null", "is_optional": true, "type": "thumbnail" }, "video": { "description": "File containing the video", "is_optional": false, "type": "file" }, "width": { "description": "Video width; as defined by the sender", "is_optional": false, "type": "int32" } }, "type": "Video" }, "videoChat": { "description": "Describes a video chat, i.e. a group call bound to a chat", "args": { "default_participant_id": { "description": "Default group call participant identifier to join the video chat; may be null", "is_optional": true, "type": "MessageSender" }, "group_call_id": { "description": "Group call identifier of an active video chat; 0 if none. Full information about the video chat can be received through the method getGroupCall", "is_optional": false, "type": "int32" }, "has_participants": { "description": "True, if the video chat has participants", "is_optional": false, "type": "Bool" } }, "type": "VideoChat" }, "videoMessageAdvertisement": { "description": "Describes an advertisement to be shown while a video from a message is watched", "args": { "additional_info": { "description": "If non-empty, additional information about the sponsored message to be shown along with the message", "is_optional": true, "type": "string" }, "can_be_reported": { "description": "True, if the advertisement can be reported to Telegram moderators through reportVideoMessageAdvertisement", "is_optional": false, "type": "Bool" }, "max_display_duration": { "description": "The maximum amount of time the advertisement must be displayed before it must be automatically hidden, in seconds", "is_optional": false, "type": "int32" }, "min_display_duration": { "description": "The minimum amount of time the advertisement must be displayed before it can be hidden by the user, in seconds", "is_optional": false, "type": "int32" }, "sponsor": { "description": "Information about the sponsor of the advertisement", "is_optional": false, "type": "advertisementSponsor" }, "text": { "description": "Text of the advertisement", "is_optional": false, "type": "string" }, "title": { "description": "Title of the sponsored message", "is_optional": false, "type": "string" }, "unique_id": { "description": "Unique identifier of this result", "is_optional": false, "type": "int53" } }, "type": "VideoMessageAdvertisement" }, "videoMessageAdvertisements": { "description": "Contains a list of advertisements to be shown while a video from a message is watched", "args": { "advertisements": { "description": "List of advertisements", "is_optional": false, "type": "vector\u003cvideoMessageAdvertisement\u003e" }, "between_delay": { "description": "Delay between consecutive advertisements, in seconds", "is_optional": false, "type": "int32" }, "start_delay": { "description": "Delay before the first advertisement is shown, in seconds", "is_optional": false, "type": "int32" } }, "type": "VideoMessageAdvertisements" }, "videoNote": { "description": "Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format", "args": { "duration": { "description": "Duration of the video, in seconds; as defined by the sender", "is_optional": false, "type": "int32" }, "length": { "description": "Video width and height; as defined by the sender", "is_optional": false, "type": "int32" }, "minithumbnail": { "description": "Video minithumbnail; may be null", "is_optional": true, "type": "minithumbnail" }, "speech_recognition_result": { "description": "Result of speech recognition in the video note; may be null", "is_optional": true, "type": "SpeechRecognitionResult" }, "thumbnail": { "description": "Video thumbnail in JPEG format; as defined by the sender; may be null", "is_optional": true, "type": "thumbnail" }, "video": { "description": "File containing the video", "is_optional": false, "type": "file" }, "waveform": { "description": "A waveform representation of the video note's audio in 5-bit format; may be empty if unknown", "is_optional": true, "type": "bytes" } }, "type": "VideoNote" }, "videoStoryboard": { "description": "Describes a storyboard for a video", "args": { "height": { "description": "Height of a tile", "is_optional": false, "type": "int32" }, "map_file": { "description": "File that describes mapping of position in the video to a tile in the JPEG file", "is_optional": false, "type": "file" }, "storyboard_file": { "description": "A JPEG file that contains tiled previews of video", "is_optional": false, "type": "file" }, "width": { "description": "Width of a tile", "is_optional": false, "type": "int32" } }, "type": "VideoStoryboard" }, "voiceNote": { "description": "Describes a voice note", "args": { "duration": { "description": "Duration of the voice note, in seconds; as defined by the sender", "is_optional": false, "type": "int32" }, "mime_type": { "description": "MIME type of the file; as defined by the sender. Usually, one of \"audio/ogg\" for Opus in an OGG container, \"audio/mpeg\" for an MP3 audio, or \"audio/mp4\" for an M4A audio", "is_optional": false, "type": "string" }, "speech_recognition_result": { "description": "Result of speech recognition in the voice note; may be null", "is_optional": true, "type": "SpeechRecognitionResult" }, "voice": { "description": "File containing the voice note", "is_optional": false, "type": "file" }, "waveform": { "description": "A waveform representation of the voice note in 5-bit format", "is_optional": false, "type": "bytes" } }, "type": "VoiceNote" }, "walletBotBalance": { "description": "Describes balance of the current user in the bot https://t.me/walt", "args": { "has_balance": { "description": "True, if the user has positive TON Gram balance", "is_optional": false, "type": "Bool" }, "url": { "description": "The URL to open to launch the bot; may be empty if none", "is_optional": true, "type": "string" } }, "type": "WalletBotBalance" }, "webApp": { "description": "Describes a Web App. Use getInternalLink with internalLinkTypeWebApp to share the Web App", "args": { "animation": { "description": "Web App animation; may be null", "is_optional": true, "type": "animation" }, "description": { "description": "Web App description", "is_optional": false, "type": "string" }, "photo": { "description": "Web App photo", "is_optional": false, "type": "photo" }, "short_name": { "description": "Web App short name", "is_optional": false, "type": "string" }, "title": { "description": "Web App title", "is_optional": false, "type": "string" } }, "type": "WebApp" }, "webAppInfo": { "description": "Contains information about a Web App", "args": { "launch_id": { "description": "Unique identifier for the Web App launch", "is_optional": false, "type": "int64" }, "url": { "description": "The Web App URL to open in a web view", "is_optional": false, "type": "webAppUrl" } }, "type": "WebAppInfo" }, "webAppOpenModeCompact": { "description": "The Web App is opened in the compact mode", "args": {}, "type": "WebAppOpenMode" }, "webAppOpenModeFullScreen": { "description": "The Web App is opened in the full-screen mode", "args": {}, "type": "WebAppOpenMode" }, "webAppOpenModeFullSize": { "description": "The Web App is opened in the full-size mode", "args": {}, "type": "WebAppOpenMode" }, "webAppOpenParameters": { "description": "Options to be used when a Web App is opened", "args": { "application_name": { "description": "Short name of the current application; 0-64 English letters, digits, and underscores", "is_optional": false, "type": "string" }, "mode": { "description": "The mode in which the Web App is opened; pass null to open in webAppOpenModeFullSize", "is_optional": true, "type": "WebAppOpenMode" }, "theme": { "description": "Preferred Web App theme; pass null to use the default theme", "is_optional": true, "type": "themeParameters" } }, "type": "WebAppOpenParameters" }, "webAppUrl": { "description": "Contains information about a Web App URL", "args": { "require_same_origin": { "description": "True, if events from the Web App must be accepted only from the same origin as the URL", "is_optional": false, "type": "Bool" }, "url": { "description": "The Web App URL to open in a web view", "is_optional": false, "type": "string" } }, "type": "WebAppUrl" }, "webBrowserSettings": { "description": "Describes web browser settings", "args": { "display_close_button": { "description": "True, if a close button must be shown in the in-app browser; for Android app only", "is_optional": false, "type": "Bool" }, "external_exceptions": { "description": "The list of websites which must always be opened in an external browser", "is_optional": false, "type": "vector\u003cwebDomainException\u003e" }, "in_app_exceptions": { "description": "The list of websites which must always be opened in the in-app browser", "is_optional": false, "type": "vector\u003cwebDomainException\u003e" }, "open_external_browser": { "description": "True, if links are opened in an external browser by default", "is_optional": false, "type": "Bool" } }, "type": "WebBrowserSettings" }, "webBrowserTypeExternal": { "description": "An external web browser", "args": {}, "type": "WebBrowserType" }, "webBrowserTypeInApp": { "description": "The in-app browser", "args": {}, "type": "WebBrowserType" }, "webDomainException": { "description": "Describes an exception for built-in browser usage", "args": { "domain": { "description": "Domain of the URL. All URLs on the domain and subdomains of the domain are subject to the exception", "is_optional": false, "type": "string" }, "favicon_custom_emoji_id": { "description": "Identifier of the custom emoji with favicon of the website; may be 0 if unknown, in which case the first letter of the domain must be used", "is_optional": false, "type": "int64" }, "title": { "description": "Title of the website", "is_optional": false, "type": "string" }, "url": { "description": "URL for which the exception is done", "is_optional": false, "type": "string" } }, "type": "WebDomainException" }, "webPageInstantView": { "description": "Describes an instant view page for a web page", "args": { "blocks": { "description": "Content of the instant view page", "is_optional": false, "type": "vector\u003cPageBlock\u003e" }, "feedback_link": { "description": "An internal link to be opened to leave feedback about the instant view", "is_optional": false, "type": "InternalLinkType" }, "is_full": { "description": "True, if the instant view contains the full page. A network request might be needed to get the full instant view", "is_optional": false, "type": "Bool" }, "is_rtl": { "description": "True, if the instant view must be shown from right to left", "is_optional": false, "type": "Bool" }, "version": { "description": "Version of the instant view; currently, can be 1 or 2", "is_optional": false, "type": "int32" }, "view_count": { "description": "Number of the instant view views; 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "WebPageInstantView" }, "welcomeMessage": { "description": "Describes a set up welcome message", "args": { "content": { "description": "Content of the welcome message", "is_optional": false, "type": "MessageContent" }, "id": { "description": "Welcome message identifier; unique for the chat to which the welcome message belongs", "is_optional": false, "type": "int32" } }, "type": "WelcomeMessage" } }, "updates": { "updateAccentColors": { "description": "The list of supported accent colors has changed", "args": { "available_accent_color_ids": { "description": "The list of accent color identifiers, which can be set through setAccentColor and setChatAccentColor. The colors must be shown in the specified order", "is_optional": false, "type": "vector\u003cint32\u003e" }, "colors": { "description": "Information about supported colors; colors with identifiers 0 (red), 1 (orange), 2 (purple/violet), 3 (green), 4 (cyan), 5 (blue), 6 (pink) must always be supported", "is_optional": false, "type": "vector\u003caccentColor\u003e" } }, "type": "Update" }, "updateActiveEmojiReactions": { "description": "The list of active emoji reactions has changed", "args": { "emojis": { "description": "The new list of active emoji reactions", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Update" }, "updateActiveGiftAuctions": { "description": "The list of auctions in which the current user participates has changed", "args": { "states": { "description": "New states of the auctions", "is_optional": false, "type": "vector\u003cgiftAuctionState\u003e" } }, "type": "Update" }, "updateActiveLiveLocationMessages": { "description": "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", "args": { "messages": { "description": "The list of messages with active live locations", "is_optional": false, "type": "vector\u003cmessage\u003e" } }, "type": "Update" }, "updateActiveNotifications": { "description": "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", "args": { "groups": { "description": "Lists of active notification groups", "is_optional": false, "type": "vector\u003cnotificationGroup\u003e" } }, "type": "Update" }, "updateAgeVerificationParameters": { "description": "The parameters for age verification of the current user's account have changed", "args": { "parameters": { "description": "Parameters for the age verification; may be null if age verification isn't needed", "is_optional": true, "type": "ageVerificationParameters" } }, "type": "Update" }, "updateAllowedBotUsernamePremiumSuffixes": { "description": "Lists of suffixes allowed in secondary bot usernames, which can be added additionally to the main username if the bot's owner has a Telegram Premium subscription", "args": { "suffixes": { "description": "The list of allowed suffixes", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Update" }, "updateAnimatedEmojiMessageClicked": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "sticker": { "description": "The animated sticker to be played", "is_optional": false, "type": "sticker" } }, "type": "Update" }, "updateAnimationSearchParameters": { "description": "The parameters of animation search through getOption(\"animation_search_bot_username\") bot have changed", "args": { "emojis": { "description": "The new list of emojis suggested for searching", "is_optional": false, "type": "vector\u003cstring\u003e" }, "provider": { "description": "Name of the animation search provider", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateApplicationRecaptchaVerificationRequired": { "description": "A request can't be completed unless reCAPTCHA verification is performed; for official mobile applications only.", "args": { "action": { "description": "The action for the check", "is_optional": false, "type": "string" }, "recaptcha_key_id": { "description": "Identifier of the reCAPTCHA key", "is_optional": false, "type": "string" }, "verification_id": { "description": "Unique identifier for the verification process", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateApplicationVerificationRequired": { "description": "A request can't be completed unless application verification is performed; for official mobile applications only.", "args": { "cloud_project_number": { "description": "Cloud project number to pass to the Play Integrity API on Android", "is_optional": false, "type": "int64" }, "nonce": { "description": "Unique base64url-encoded nonce for the classic Play Integrity verification (https://developer.android.com/google/play/integrity/classic) for Android,", "is_optional": false, "type": "string" }, "verification_id": { "description": "Unique identifier for the verification process", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateAttachmentMenuBots": { "description": "The list of bots added to attachment or side menu has changed", "args": { "bots": { "description": "The new list of bots. The bots must not be shown on scheduled messages screen", "is_optional": false, "type": "vector\u003cattachmentMenuBot\u003e" } }, "type": "Update" }, "updateAuthorizationState": { "description": "The user authorization state has changed", "args": { "authorization_state": { "description": "New authorization state", "is_optional": false, "type": "AuthorizationState" } }, "type": "Update" }, "updateAutosaveSettings": { "description": "Autosave settings for some type of chats were updated", "args": { "scope": { "description": "Type of chats for which autosave settings were updated", "is_optional": false, "type": "AutosaveSettingsScope" }, "settings": { "description": "The new autosave settings; may be null if the settings are reset to default", "is_optional": true, "type": "scopeAutosaveSettings" } }, "type": "Update" }, "updateAvailableMessageEffects": { "description": "The list of available message effects has changed", "args": { "reaction_effect_ids": { "description": "The new list of available message effects from emoji reactions", "is_optional": false, "type": "vector\u003cint64\u003e" }, "sticker_effect_ids": { "description": "The new list of available message effects from Premium stickers", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Update" }, "updateBasicGroup": { "description": "Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the application", "args": { "basic_group": { "description": "New data about the group", "is_optional": false, "type": "basicGroup" } }, "type": "Update" }, "updateBasicGroupFullInfo": { "description": "Some data in basicGroupFullInfo has been changed", "args": { "basic_group_full_info": { "description": "New full information about the group", "is_optional": false, "type": "basicGroupFullInfo" }, "basic_group_id": { "description": "Identifier of a basic group", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateBusinessConnection": { "description": "A business connection has changed; for bots only", "args": { "connection": { "description": "New data about the connection", "is_optional": false, "type": "businessConnection" } }, "type": "Update" }, "updateBusinessMessageEdited": { "description": "A message in a business account was edited; for bots only", "args": { "connection_id": { "description": "Unique identifier of the business connection", "is_optional": false, "type": "string" }, "message": { "description": "The edited message", "is_optional": false, "type": "businessMessage" } }, "type": "Update" }, "updateBusinessMessagesDeleted": { "description": "Messages in a business account were deleted; for bots only", "args": { "chat_id": { "description": "Identifier of a chat in the business account in which messages were deleted", "is_optional": false, "type": "int53" }, "connection_id": { "description": "Unique identifier of the business connection", "is_optional": false, "type": "string" }, "message_ids": { "description": "Unique message identifiers of the deleted messages", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Update" }, "updateCall": { "description": "New call was created or information about a call was updated", "args": { "call": { "description": "New data about a call", "is_optional": false, "type": "call" } }, "type": "Update" }, "updateChatAccentColors": { "description": "Chat accent colors have changed", "args": { "accent_color_id": { "description": "The new chat accent color identifier", "is_optional": false, "type": "int32" }, "background_custom_emoji_id": { "description": "The new identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none", "is_optional": false, "type": "int64" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "profile_accent_color_id": { "description": "The new chat profile accent color identifier; -1 if none", "is_optional": false, "type": "int32" }, "profile_background_custom_emoji_id": { "description": "The new identifier of a custom emoji to be shown on the profile background; 0 if none", "is_optional": false, "type": "int64" }, "upgraded_gift_colors": { "description": "Color scheme based on an upgraded gift to be used for the chat instead of accent_color_id and background_custom_emoji_id; may be null if none", "is_optional": true, "type": "upgradedGiftColors" } }, "type": "Update" }, "updateChatAction": { "description": "A message sender activity in the chat has changed", "args": { "action": { "description": "The action", "is_optional": false, "type": "ChatAction" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of a message sender performing the action", "is_optional": false, "type": "MessageSender" }, "topic_id": { "description": "Identifier of the specific topic in which the action was performed; may be null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Update" }, "updateChatActionBar": { "description": "The chat action bar was changed", "args": { "action_bar": { "description": "The new value of the action bar; may be null", "is_optional": true, "type": "ChatActionBar" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatActiveStories": { "description": "The list of active stories posted by a specific chat has changed", "args": { "active_stories": { "description": "The new list of active stories", "is_optional": false, "type": "chatActiveStories" } }, "type": "Update" }, "updateChatAddedToList": { "description": "A chat was added to a chat list", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "chat_list": { "description": "The chat list to which the chat was added", "is_optional": false, "type": "ChatList" } }, "type": "Update" }, "updateChatAvailableReactions": { "description": "The chat available reactions were changed", "args": { "available_reactions": { "description": "The new reactions, available in the chat", "is_optional": false, "type": "ChatAvailableReactions" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatBackground": { "description": "The chat background was changed", "args": { "background": { "description": "The new chat background; may be null if background was reset to default", "is_optional": true, "type": "chatBackground" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatBlockList": { "description": "A chat was blocked or unblocked", "args": { "block_list": { "description": "Block list to which the chat is added; may be null if none", "is_optional": true, "type": "BlockList" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatBoost": { "description": "A chat boost has changed; for bots only", "args": { "boost": { "description": "New information about the boost", "is_optional": false, "type": "chatBoost" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatBusinessBotManageBar": { "description": "The bar for managing business bot was changed in a chat", "args": { "business_bot_manage_bar": { "description": "The new value of the business bot manage bar; may be null", "is_optional": true, "type": "businessBotManageBar" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatDefaultDisableNotification": { "description": "The value of the default disable_notification parameter, used when a message is sent to the chat, was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "default_disable_notification": { "description": "The new default_disable_notification value", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatDraftMessage": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_message": { "description": "The new draft message; may be null if none", "is_optional": true, "type": "draftMessage" }, "positions": { "description": "The new chat positions in the chat lists", "is_optional": false, "type": "vector\u003cchatPosition\u003e" } }, "type": "Update" }, "updateChatEmojiStatus": { "description": "Chat emoji status has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "emoji_status": { "description": "The new chat emoji status; may be null", "is_optional": true, "type": "emojiStatus" } }, "type": "Update" }, "updateChatFolders": { "description": "The list of chat folders or a chat folder has changed", "args": { "are_tags_enabled": { "description": "True, if folder tags are enabled", "is_optional": false, "type": "Bool" }, "chat_folders": { "description": "The new list of chat folders", "is_optional": false, "type": "vector\u003cchatFolderInfo\u003e" }, "main_chat_list_position": { "description": "Position of the main chat list among chat folders, 0-based", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatHasProtectedContent": { "description": "A chat content was allowed or restricted for saving", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "has_protected_content": { "description": "New value of has_protected_content", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatHasScheduledMessages": { "description": "A chat's has_scheduled_messages field has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "has_scheduled_messages": { "description": "New value of has_scheduled_messages", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatHasWelcomeMessages": { "description": "A chat's has_welcome_messages field has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "has_welcome_messages": { "description": "New value of has_welcome_messages", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatIsMarkedAsUnread": { "description": "A chat was marked as unread or was read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_marked_as_unread": { "description": "New value of is_marked_as_unread", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatIsTranslatable": { "description": "Translation of chat messages was enabled or disabled", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_translatable": { "description": "New value of is_translatable", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatJoinResult": { "description": "A join request from the user was completed", "args": { "chat_id": { "description": "Identifier of the joined chat, or 0 if the request wasn't approved", "is_optional": false, "type": "int53" }, "query_id": { "description": "Identifier of the join request query as received in chatJoinResultGuardBotApprovalRequired. If the corresponding Web App is still open, then it must be closed", "is_optional": false, "type": "int64" }, "result": { "description": "Result of the join", "is_optional": false, "type": "ChatJoinRequestResult" } }, "type": "Update" }, "updateChatLastMessage": { "description": "The last message of a chat was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "last_message": { "description": "The new last message in the chat; may be null if the last message became unknown. While the last message is unknown, new messages can be added to the chat without corresponding updateNewMessage update", "is_optional": true, "type": "message" }, "positions": { "description": "The new chat positions in the chat lists", "is_optional": false, "type": "vector\u003cchatPosition\u003e" } }, "type": "Update" }, "updateChatMember": { "description": "User rights changed in a chat; for bots only", "args": { "actor_user_id": { "description": "Identifier of the user, changing the rights", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) when the user rights were changed", "is_optional": false, "type": "int32" }, "invite_link": { "description": "If user has joined the chat using an invite link, the invite link; may be null", "is_optional": true, "type": "chatInviteLink" }, "new_chat_member": { "description": "New chat member", "is_optional": false, "type": "chatMember" }, "old_chat_member": { "description": "Previous chat member", "is_optional": false, "type": "chatMember" }, "via_chat_folder_invite_link": { "description": "True, if the user has joined the chat using an invite link for a chat folder", "is_optional": false, "type": "Bool" }, "via_join_request": { "description": "True, if the user has joined the chat after sending a join request and being approved by an administrator", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatMessageAutoDeleteTime": { "description": "The message auto-delete or self-destruct timer setting for a chat was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_auto_delete_time": { "description": "New value of message_auto_delete_time", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatMessageSender": { "description": "The message sender that is selected to send messages in a chat has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_sender_id": { "description": "New value of message_sender_id; may be null if the user can't change message sender", "is_optional": true, "type": "MessageSender" } }, "type": "Update" }, "updateChatNotificationSettings": { "description": "Notification settings for a chat were changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "notification_settings": { "description": "The new notification settings", "is_optional": false, "type": "chatNotificationSettings" } }, "type": "Update" }, "updateChatOnlineMemberCount": { "description": "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.", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "online_member_count": { "description": "New number of online members in the chat, or 0 if unknown", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatPendingJoinRequests": { "description": "The chat pending join requests were changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "pending_join_requests": { "description": "The new data about pending join requests; may be null", "is_optional": true, "type": "chatJoinRequestsInfo" } }, "type": "Update" }, "updateChatPermissions": { "description": "Chat permissions were changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "permissions": { "description": "The new chat permissions", "is_optional": false, "type": "chatPermissions" } }, "type": "Update" }, "updateChatPhoto": { "description": "A chat photo was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "photo": { "description": "The new chat photo; may be null", "is_optional": true, "type": "chatPhotoInfo" } }, "type": "Update" }, "updateChatPosition": { "description": "The position of a chat in a chat list has changed. An updateChatLastMessage or updateChatDraftMessage update might be sent instead of the update", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "position": { "description": "New chat position. If new order is 0, then the chat needs to be removed from the list", "is_optional": false, "type": "chatPosition" } }, "type": "Update" }, "updateChatReadInbox": { "description": "Incoming messages were read or the number of unread messages has been changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming message", "is_optional": false, "type": "int53" }, "unread_count": { "description": "The number of unread messages left in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatReadOutbox": { "description": "Outgoing messages were read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of last read outgoing message", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateChatRemovedFromList": { "description": "A chat was removed from a chat list", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "chat_list": { "description": "The chat list from which the chat was removed", "is_optional": false, "type": "ChatList" } }, "type": "Update" }, "updateChatReplyMarkup": { "description": "The chat reply markup was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "reply_markup_message": { "description": "The message from which the reply markup must be used; may be null if there is no default reply markup in the chat", "is_optional": true, "type": "message" } }, "type": "Update" }, "updateChatRevenueAmount": { "description": "The revenue earned from sponsored messages in a chat has changed. If chat revenue screen is opened, then getChatRevenueTransactions may be called to fetch new transactions", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "revenue_amount": { "description": "New amount of earned revenue", "is_optional": false, "type": "chatRevenueAmount" } }, "type": "Update" }, "updateChatTheme": { "description": "The chat theme was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "theme": { "description": "The new theme of the chat; may be null if theme was reset to default", "is_optional": true, "type": "ChatTheme" } }, "type": "Update" }, "updateChatTitle": { "description": "The title of a chat was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "title": { "description": "The new chat title", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateChatUnreadMentionCount": { "description": "The chat unread_mention_count has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "unread_mention_count": { "description": "The number of unread mention messages left in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatUnreadPollVoteCount": { "description": "The chat unread_poll_vote_count has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "unread_poll_vote_count": { "description": "The number of messages with unread poll votes left in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatUnreadReactionCount": { "description": "The chat unread_reaction_count has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "unread_reaction_count": { "description": "The number of messages with unread reactions left in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateChatVideoChat": { "description": "A chat video chat state has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "video_chat": { "description": "New value of video_chat", "is_optional": false, "type": "videoChat" } }, "type": "Update" }, "updateChatViewAsTopics": { "description": "A chat default appearance has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "view_as_topics": { "description": "New value of view_as_topics", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateChatWelcomeMessages": { "description": "The list of welcome messages of a chat has changed", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" }, "messages": { "description": "The new list of welcome messages of the chat in the order from the first to the last sent", "is_optional": false, "type": "vector\u003cwelcomeMessage\u003e" } }, "type": "Update" }, "updateCommunity": { "description": "Some data of a community has changed. This update is guaranteed to come before the community identifier is returned to the application", "args": { "community": { "description": "New data about the community", "is_optional": false, "type": "community" } }, "type": "Update" }, "updateCommunityFullInfo": { "description": "Some data in communityFullInfo has been changed", "args": { "community_full_info": { "description": "New full information about the community", "is_optional": false, "type": "communityFullInfo" }, "community_id": { "description": "Identifier of the community", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateConnectionState": { "description": "The connection state has changed. This update must be used only to show a human-readable description of the connection state", "args": { "state": { "description": "The new connection state", "is_optional": false, "type": "ConnectionState" } }, "type": "Update" }, "updateContactCloseBirthdays": { "description": "The list of contacts that had birthdays recently or will have birthday soon has changed", "args": { "close_birthday_users": { "description": "List of contact users with close birthday", "is_optional": false, "type": "vector\u003ccloseBirthdayUser\u003e" } }, "type": "Update" }, "updateDefaultBackground": { "description": "The default background has changed", "args": { "background": { "description": "The new default background; may be null", "is_optional": true, "type": "background" }, "for_dark_theme": { "description": "True, if default background for dark theme has changed", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateDefaultPaidReactionType": { "description": "The type of default paid reaction has changed", "args": { "type": { "description": "The new type of the default paid reaction", "is_optional": false, "type": "PaidReactionType" } }, "type": "Update" }, "updateDefaultReactionType": { "description": "The type of default reaction has changed", "args": { "reaction_type": { "description": "The new type of the default reaction", "is_optional": false, "type": "ReactionType" } }, "type": "Update" }, "updateDeleteMessages": { "description": "Some messages were deleted", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "from_cache": { "description": "True, if the messages are deleted only from the cache and can possibly be retrieved again in the future", "is_optional": false, "type": "Bool" }, "is_permanent": { "description": "True, if the messages are permanently deleted by a user (as opposed to just becoming inaccessible)", "is_optional": false, "type": "Bool" }, "message_ids": { "description": "Identifiers of the deleted messages", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Update" }, "updateDiceEmojis": { "description": "The list of supported dice emojis has changed", "args": { "emojis": { "description": "The new list of supported dice emojis", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Update" }, "updateDirectMessagesChatTopic": { "description": "Basic information about a topic in a channel direct messages chat administered by the current user has changed. This update is guaranteed to come before the topic identifier is returned to the application", "args": { "topic": { "description": "New data about the topic", "is_optional": false, "type": "directMessagesChatTopic" } }, "type": "Update" }, "updateEmojiChatThemes": { "description": "The list of available emoji chat themes has changed", "args": { "chat_themes": { "description": "The new list of emoji chat themes", "is_optional": false, "type": "vector\u003cemojiChatTheme\u003e" } }, "type": "Update" }, "updateFavoriteStickers": { "description": "The list of favorite stickers was updated", "args": { "sticker_ids": { "description": "The new list of file identifiers of favorite stickers", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Update" }, "updateFile": { "description": "Information about a file was updated", "args": { "file": { "description": "New data about the file", "is_optional": false, "type": "file" } }, "type": "Update" }, "updateFileAddedToDownloads": { "description": "A file was added to the file download list. This update is sent only after file download list is loaded for the first time", "args": { "counts": { "description": "New number of being downloaded and recently downloaded files found", "is_optional": false, "type": "downloadedFileCounts" }, "file_download": { "description": "The added file download", "is_optional": false, "type": "fileDownload" } }, "type": "Update" }, "updateFileDownload": { "description": "A file download was changed. This update is sent only after file download list is loaded for the first time", "args": { "complete_date": { "description": "Point in time (Unix timestamp) when the file downloading was completed; 0 if the file downloading isn't completed", "is_optional": false, "type": "int32" }, "counts": { "description": "New number of being downloaded and recently downloaded files found", "is_optional": false, "type": "downloadedFileCounts" }, "file_id": { "description": "File identifier", "is_optional": false, "type": "int32" }, "is_paused": { "description": "True, if downloading of the file is paused", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateFileDownloads": { "description": "The state of the file download list has changed", "args": { "downloaded_size": { "description": "Total downloaded size of files in the file download list, in bytes", "is_optional": false, "type": "int53" }, "total_count": { "description": "Total number of files in the file download list", "is_optional": false, "type": "int32" }, "total_size": { "description": "Total size of files in the file download list, in bytes", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateFileGenerationStart": { "description": "The file generation process needs to be started by the application. Use setFileGenerationProgress and finishFileGeneration to generate the file", "args": { "conversion": { "description": "If the conversion is \"#url#\", then original_path contains an HTTP/HTTPS URL of a file that must be downloaded by the application.", "is_optional": false, "type": "string" }, "destination_path": { "description": "The path to a file that must be created and where the new file must be generated by the application.", "is_optional": false, "type": "string" }, "generation_id": { "description": "Unique identifier for the generation process", "is_optional": false, "type": "int64" }, "original_path": { "description": "The original path specified by the application in inputFileGenerated", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateFileGenerationStop": { "description": "File generation is no longer needed", "args": { "generation_id": { "description": "Unique identifier for the generation process", "is_optional": false, "type": "int64" } }, "type": "Update" }, "updateFileRemovedFromDownloads": { "description": "A file was removed from the file download list. This update is sent only after file download list is loaded for the first time", "args": { "counts": { "description": "New number of being downloaded and recently downloaded files found", "is_optional": false, "type": "downloadedFileCounts" }, "file_id": { "description": "File identifier", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateForumTopic": { "description": "Information about a topic in a forum chat was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_message": { "description": "A draft of a message in the topic; may be null if none", "is_optional": true, "type": "draftMessage" }, "forum_topic_id": { "description": "Forum topic identifier of the topic", "is_optional": false, "type": "int32" }, "is_pinned": { "description": "True, if the topic is pinned in the topic list", "is_optional": false, "type": "Bool" }, "last_read_inbox_message_id": { "description": "Identifier of the last read incoming message", "is_optional": false, "type": "int53" }, "last_read_outbox_message_id": { "description": "Identifier of the last read outgoing message", "is_optional": false, "type": "int53" }, "notification_settings": { "description": "Notification settings for the topic", "is_optional": false, "type": "chatNotificationSettings" }, "unread_mention_count": { "description": "Number of unread messages with a mention/reply in the topic", "is_optional": false, "type": "int32" }, "unread_poll_vote_count": { "description": "Number of messages with unread poll votes in the topic", "is_optional": false, "type": "int32" }, "unread_reaction_count": { "description": "Number of messages with unread reactions in the topic", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateForumTopicInfo": { "description": "Basic information about a topic in a forum chat was changed", "args": { "info": { "description": "New information about the topic", "is_optional": false, "type": "forumTopicInfo" } }, "type": "Update" }, "updateFreezeState": { "description": "The freeze state of the current user's account has changed", "args": { "appeal_link": { "description": "The link to open to send an appeal to unfreeze the account", "is_optional": false, "type": "string" }, "deletion_date": { "description": "Point in time (Unix timestamp) when the account will be deleted and can't be unfrozen; 0 if the account isn't frozen", "is_optional": false, "type": "int32" }, "freezing_date": { "description": "Point in time (Unix timestamp) when the account was frozen; 0 if the account isn't frozen", "is_optional": false, "type": "int32" }, "is_frozen": { "description": "True, if the account is frozen", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateGiftAuctionState": { "description": "State of a gift auction was updated", "args": { "state": { "description": "New state of the auction", "is_optional": false, "type": "giftAuctionState" } }, "type": "Update" }, "updateGramRevenueStatus": { "description": "The TON Gram revenue earned by the current user has changed. If Gram transaction screen of the chat is opened, then getTonTransactions may be called to fetch new transactions", "args": { "status": { "description": "New Gram revenue status", "is_optional": false, "type": "gramRevenueStatus" } }, "type": "Update" }, "updateGroupCall": { "description": "Information about a group call was updated", "args": { "group_call": { "description": "New data about the group call", "is_optional": false, "type": "groupCall" } }, "type": "Update" }, "updateGroupCallMessageLevels": { "description": "The levels of live story group call messages have changed", "args": { "levels": { "description": "New description of the levels in decreasing order of groupCallMessageLevel.min_star_count", "is_optional": false, "type": "vector\u003cgroupCallMessageLevel\u003e" } }, "type": "Update" }, "updateGroupCallMessageSendFailed": { "description": "A group call message failed to send", "args": { "error": { "description": "The cause of the message sending failure", "is_optional": false, "type": "error" }, "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateGroupCallMessagesDeleted": { "description": "Some group call messages were deleted", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "message_ids": { "description": "Identifiers of the deleted messages", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Update" }, "updateGroupCallParticipant": { "description": "Information about a group call participant was changed. The updates are sent only after the group call is received through getGroupCall and only if the call is joined or being joined", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "participant": { "description": "New data about the participant", "is_optional": false, "type": "groupCallParticipant" } }, "type": "Update" }, "updateGroupCallParticipants": { "description": "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", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "participant_user_ids": { "description": "New list of group call participant user identifiers. The identifiers may be invalid or the corresponding users may be unknown.", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Update" }, "updateGroupCallVerificationState": { "description": "The verification state of an encrypted group call has changed; for group calls not bound to a chat only", "args": { "emojis": { "description": "Group call state fingerprint represented as 4 emoji; may be empty if the state isn't verified yet", "is_optional": true, "type": "vector\u003cstring\u003e" }, "generation": { "description": "The call state generation to which the emoji corresponds. If generation is different for two users, then their emoji may be also different", "is_optional": false, "type": "int32" }, "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateHavePendingNotifications": { "description": "Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some pending notifications", "args": { "have_delayed_notifications": { "description": "True, if there are some delayed notification updates, which will be sent soon", "is_optional": false, "type": "Bool" }, "have_unreceived_notifications": { "description": "True, if there can be some yet unreceived notifications, which are being fetched from the server", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateInstalledStickerSets": { "description": "The list of installed sticker sets was updated", "args": { "sticker_set_ids": { "description": "The new list of installed ordinary sticker sets", "is_optional": false, "type": "vector\u003cint64\u003e" }, "sticker_type": { "description": "Type of the affected stickers", "is_optional": false, "type": "StickerType" } }, "type": "Update" }, "updateLanguagePackStrings": { "description": "Some language pack strings have been updated", "args": { "language_pack_id": { "description": "Identifier of the updated language pack", "is_optional": false, "type": "string" }, "localization_target": { "description": "Localization target to which the language pack belongs", "is_optional": false, "type": "string" }, "strings": { "description": "List of changed language pack strings; empty if all strings have changed", "is_optional": false, "type": "vector\u003clanguagePackString\u003e" } }, "type": "Update" }, "updateLiveStoryTopDonors": { "description": "The list of top donors in live story group call has changed", "args": { "donors": { "description": "New list of live story donors", "is_optional": false, "type": "liveStoryDonors" }, "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateManagedBot": { "description": "A bot that can be managed by the current bot was created or updated; for bots only", "args": { "bot_user_id": { "description": "Identifier of the created managed bot", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user who created the bot", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageContainsUnreadPollVotes": { "description": "Unread votes were added or removed from a poll message", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "contains_unread_poll_votes": { "description": "True, if the message is a poll message with unread votes", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "unread_poll_vote_count": { "description": "The new number of messages with unread poll votes in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateMessageContent": { "description": "The message content has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "new_content": { "description": "New message content", "is_optional": false, "type": "MessageContent" } }, "type": "Update" }, "updateMessageContentOpened": { "description": "The message content was opened. Updates voice note messages to \"listened\", video note messages to \"viewed\" and starts the self-destruct timer", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageEdited": { "description": "A message was edited. Changes in the message content will come in a separate updateMessageContent", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "edit_date": { "description": "Point in time (Unix timestamp) when the message was edited", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "New message reply markup; may be null", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Update" }, "updateMessageEphemeralContent": { "description": "The message ephemeral content has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "ephemeral_content": { "description": "New ephemeral content of the message; may be null if none", "is_optional": true, "type": "ephemeralMessageContent" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageFactCheck": { "description": "A fact-check added to a message was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "fact_check": { "description": "The new fact-check", "is_optional": false, "type": "factCheck" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageInteractionInfo": { "description": "The information about interactions with a message has changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "interaction_info": { "description": "New information about interactions with the message; may be null", "is_optional": true, "type": "messageInteractionInfo" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageIsPinned": { "description": "The message pinned state was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_pinned": { "description": "True, if the message is pinned", "is_optional": false, "type": "Bool" }, "message_id": { "description": "The message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageLiveLocationViewed": { "description": "A message with a live location was viewed. When the update is received, the application is expected to update the live location", "args": { "chat_id": { "description": "Identifier of the chat with the live location message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message with live location", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageMentionRead": { "description": "A message with an unread mention was read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "unread_mention_count": { "description": "The new number of unread mention messages left in the chat", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateMessageReaction": { "description": "User changed its reactions on a message with public reactions; for bots only", "args": { "actor_id": { "description": "Identifier of the user or chat that changed reactions", "is_optional": false, "type": "MessageSender" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) when the reactions were changed", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "new_reaction_types": { "description": "New list of chosen reactions", "is_optional": false, "type": "vector\u003cReactionType\u003e" }, "old_reaction_types": { "description": "Old list of chosen reactions", "is_optional": false, "type": "vector\u003cReactionType\u003e" } }, "type": "Update" }, "updateMessageReactions": { "description": "Reactions added to a message with anonymous reactions have changed; for bots only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) when the reactions were changed", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "reactions": { "description": "The list of reactions added to the message", "is_optional": false, "type": "vector\u003cmessageReaction\u003e" } }, "type": "Update" }, "updateMessageSendAcknowledged": { "description": "A request to send a message has reached the Telegram server. This doesn't mean that the message will be sent successfully.", "args": { "chat_id": { "description": "The chat identifier of the sent message", "is_optional": false, "type": "int53" }, "message_id": { "description": "A temporary message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageSendFailed": { "description": "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", "args": { "error": { "description": "The cause of the message sending failure", "is_optional": false, "type": "error" }, "message": { "description": "The failed to send message", "is_optional": false, "type": "message" }, "old_message_id": { "description": "The previous temporary message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageSendSucceeded": { "description": "A message has been successfully sent", "args": { "message": { "description": "The sent message. Almost any field of the new message can be different from the corresponding field of the original message.", "is_optional": false, "type": "message" }, "old_message_id": { "description": "The previous temporary message identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateMessageSuggestedPostInfo": { "description": "Information about suggested post of a message was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "suggested_post_info": { "description": "The new information about the suggested post", "is_optional": false, "type": "suggestedPostInfo" } }, "type": "Update" }, "updateMessageUnreadReactions": { "description": "The list of unread reactions added to a message was changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "unread_reaction_count": { "description": "The new number of messages with unread reactions in the chat", "is_optional": false, "type": "int32" }, "unread_reactions": { "description": "The new list of unread reactions", "is_optional": false, "type": "vector\u003cunreadReaction\u003e" } }, "type": "Update" }, "updateNewBusinessCallbackQuery": { "description": "A new incoming callback query from a business message; for bots only", "args": { "chat_instance": { "description": "An identifier uniquely corresponding to the chat a message was sent to", "is_optional": false, "type": "int64" }, "connection_id": { "description": "Unique identifier of the business connection", "is_optional": false, "type": "string" }, "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "message": { "description": "The message from the business account from which the query originated", "is_optional": false, "type": "businessMessage" }, "payload": { "description": "Query payload", "is_optional": false, "type": "CallbackQueryPayload" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewBusinessMessage": { "description": "A new message was added to a business account; for bots only", "args": { "connection_id": { "description": "Unique identifier of the business connection", "is_optional": false, "type": "string" }, "message": { "description": "The new message", "is_optional": false, "type": "businessMessage" } }, "type": "Update" }, "updateNewCallSignalingData": { "description": "New call signaling data arrived", "args": { "call_id": { "description": "The call identifier", "is_optional": false, "type": "int32" }, "data": { "description": "The data", "is_optional": false, "type": "bytes" } }, "type": "Update" }, "updateNewCallbackQuery": { "description": "A new incoming callback query; for bots only", "args": { "chat_id": { "description": "Identifier of the chat where the query was sent", "is_optional": false, "type": "int53" }, "chat_instance": { "description": "Identifier that uniquely corresponds to the chat to which the message was sent", "is_optional": false, "type": "int64" }, "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "message_id": { "description": "Identifier of the message from which the query originated", "is_optional": false, "type": "int53" }, "payload": { "description": "Query payload", "is_optional": false, "type": "CallbackQueryPayload" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewChat": { "description": "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", "args": { "chat": { "description": "The chat", "is_optional": false, "type": "chat" } }, "type": "Update" }, "updateNewChatJoinRequest": { "description": "A user sent a join request to a chat; for bots only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "The invite link, which was used to send join request; may be null", "is_optional": true, "type": "chatInviteLink" }, "query_id": { "description": "Identifier of the join request query, which can be used in answerChatJoinRequestQuery; 0 if none", "is_optional": false, "type": "int64" }, "request": { "description": "Join request", "is_optional": false, "type": "chatJoinRequest" }, "user_chat_id": { "description": "Chat identifier of the private chat with the user", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewChosenInlineResult": { "description": "The user has chosen a result of an inline query; for bots only", "args": { "inline_message_id": { "description": "Identifier of the sent inline message, if known", "is_optional": false, "type": "string" }, "query": { "description": "Text of the query", "is_optional": false, "type": "string" }, "result_id": { "description": "Identifier of the chosen result", "is_optional": false, "type": "string" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" }, "user_location": { "description": "User location; may be null", "is_optional": true, "type": "location" } }, "type": "Update" }, "updateNewCustomEvent": { "description": "A new incoming event; for bots only", "args": { "event": { "description": "A JSON-serialized event", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateNewCustomQuery": { "description": "A new incoming query; for bots only", "args": { "data": { "description": "JSON-serialized query data", "is_optional": false, "type": "string" }, "id": { "description": "The query identifier", "is_optional": false, "type": "int64" }, "timeout": { "description": "Query timeout", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateNewGroupCallMessage": { "description": "A new message was received in a group call", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "message": { "description": "The message", "is_optional": false, "type": "groupCallMessage" } }, "type": "Update" }, "updateNewGroupCallPaidReaction": { "description": "A new paid reaction was received in a live story group call", "args": { "group_call_id": { "description": "Identifier of the group call", "is_optional": false, "type": "int32" }, "sender_id": { "description": "Identifier of the sender of the reaction", "is_optional": false, "type": "MessageSender" }, "star_count": { "description": "The number of Telegram Stars that were paid to send the reaction", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewGuestQuery": { "description": "A new incoming guest query; for bots only", "args": { "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "message": { "description": "The message with the query", "is_optional": false, "type": "message" }, "reference_messages": { "description": "The list of reference messages", "is_optional": false, "type": "vector\u003cmessage\u003e" } }, "type": "Update" }, "updateNewInlineCallbackQuery": { "description": "A new incoming callback query from a message sent via a bot; for bots only", "args": { "chat_instance": { "description": "An identifier uniquely corresponding to the chat a message was sent to", "is_optional": false, "type": "int64" }, "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "inline_message_id": { "description": "Identifier of the inline message from which the query originated", "is_optional": false, "type": "string" }, "payload": { "description": "Query payload", "is_optional": false, "type": "CallbackQueryPayload" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewInlineQuery": { "description": "A new incoming inline query; for bots only", "args": { "chat_type": { "description": "The type of the chat from which the query originated; may be null if unknown", "is_optional": true, "type": "ChatType" }, "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "offset": { "description": "Offset of the first entry to return", "is_optional": false, "type": "string" }, "query": { "description": "Text of the query", "is_optional": false, "type": "string" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" }, "user_location": { "description": "User location; may be null", "is_optional": true, "type": "location" } }, "type": "Update" }, "updateNewMessage": { "description": "A new message was received; can also be an outgoing message", "args": { "message": { "description": "The new message", "is_optional": false, "type": "message" } }, "type": "Update" }, "updateNewOauthRequest": { "description": "An OAuth authorization request was received", "args": { "domain": { "description": "A domain of the URL where the user authorizes", "is_optional": false, "type": "string" }, "location": { "description": "Human-readable description of a country and a region from which the authorization is performed, based on the IP address", "is_optional": false, "type": "string" }, "url": { "description": "The URL to pass to getOauthLinkInfo; the link is valid for 60 seconds", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateNewPreCheckoutQuery": { "description": "A new incoming pre-checkout query; for bots only. Contains full information about a checkout", "args": { "currency": { "description": "Currency for the product price", "is_optional": false, "type": "string" }, "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "invoice_payload": { "description": "Invoice payload", "is_optional": false, "type": "bytes" }, "order_info": { "description": "Information about the order; may be null", "is_optional": true, "type": "orderInfo" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" }, "shipping_option_id": { "description": "Identifier of a shipping option chosen by the user; may be empty if not applicable", "is_optional": true, "type": "string" }, "total_amount": { "description": "Total price for the product, in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateNewShippingQuery": { "description": "A new incoming shipping query; for bots only. Only for invoices with flexible price", "args": { "id": { "description": "Unique query identifier", "is_optional": false, "type": "int64" }, "invoice_payload": { "description": "Invoice payload", "is_optional": false, "type": "string" }, "sender_user_id": { "description": "Identifier of the user who sent the query", "is_optional": false, "type": "int53" }, "shipping_address": { "description": "User shipping address", "is_optional": false, "type": "address" } }, "type": "Update" }, "updateNotification": { "description": "A notification was changed", "args": { "notification": { "description": "Changed notification", "is_optional": false, "type": "notification" }, "notification_group_id": { "description": "Unique notification group identifier", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateNotificationGroup": { "description": "A list of active notifications in a notification group has changed", "args": { "added_notifications": { "description": "List of added group notifications, sorted by notification identifier", "is_optional": false, "type": "vector\u003cnotification\u003e" }, "chat_id": { "description": "Identifier of a chat to which all notifications in the group belong", "is_optional": false, "type": "int53" }, "notification_group_id": { "description": "Unique notification group identifier", "is_optional": false, "type": "int32" }, "notification_settings_chat_id": { "description": "Chat identifier, which notification settings must be applied to the added notifications", "is_optional": false, "type": "int53" }, "notification_sound_id": { "description": "Identifier of the notification sound to be played; 0 if sound is disabled", "is_optional": false, "type": "int64" }, "removed_notification_ids": { "description": "Identifiers of removed group notifications, sorted by notification identifier", "is_optional": false, "type": "vector\u003cint32\u003e" }, "total_count": { "description": "Total number of unread notifications in the group, can be bigger than number of active notifications", "is_optional": false, "type": "int32" }, "type": { "description": "New type of the notification group", "is_optional": false, "type": "NotificationGroupType" } }, "type": "Update" }, "updateOption": { "description": "An option changed its value", "args": { "name": { "description": "The option name", "is_optional": false, "type": "string" }, "value": { "description": "The new option value", "is_optional": false, "type": "OptionValue" } }, "type": "Update" }, "updateOwnedGramCount": { "description": "The number of TON Grams owned by the current user has changed", "args": { "gram_amount": { "description": "The new amount of owned Grams; in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateOwnedStarCount": { "description": "The number of Telegram Stars owned by the current user has changed", "args": { "star_amount": { "description": "The new amount of owned Telegram Stars", "is_optional": false, "type": "starAmount" } }, "type": "Update" }, "updatePaidMediaPurchased": { "description": "Paid media were purchased by a user; for bots only", "args": { "payload": { "description": "Bot-specified payload for the paid media", "is_optional": false, "type": "string" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updatePendingMessage": { "description": "A new pending text or rich message was received in a chat with a bot. The message must be shown in the chat for at most getOption(\"pending_text_message_period\") seconds,", "args": { "can_stop": { "description": "True, if a button that calls stopPendingMessage to stop further message generation must be shown", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "content": { "description": "Content of the message; always of the type messageText or messageRichMessage", "is_optional": false, "type": "MessageContent" }, "draft_id": { "description": "Unique identifier of the message draft within the message thread", "is_optional": false, "type": "int64" }, "forum_topic_id": { "description": "The forum topic identifier in which the message will be sent; 0 if none", "is_optional": false, "type": "int32" }, "keep_on_stop": { "description": "True, if the pending message must not be automatically deleted when the user presses the Stop button", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updatePoll": { "description": "A poll was updated; for bots only", "args": { "poll": { "description": "New data about the poll", "is_optional": false, "type": "poll" } }, "type": "Update" }, "updatePollAnswer": { "description": "A user changed the answer to a poll; for bots only", "args": { "option_ids": { "description": "Unique identifiers of answer options, that were chosen by the user", "is_optional": false, "type": "vector\u003cstring\u003e" }, "option_positions": { "description": "0-based identifiers of answer options, that were chosen by the user", "is_optional": false, "type": "vector\u003cint32\u003e" }, "poll_id": { "description": "Unique poll identifier", "is_optional": false, "type": "int64" }, "voter_id": { "description": "Identifier of the message sender that changed the answer to the poll", "is_optional": false, "type": "MessageSender" } }, "type": "Update" }, "updateProfileAccentColors": { "description": "The list of supported accent colors for user profiles has changed", "args": { "available_accent_color_ids": { "description": "The list of accent color identifiers, which can be set through setProfileAccentColor and setChatProfileAccentColor. The colors must be shown in the specified order", "is_optional": false, "type": "vector\u003cint32\u003e" }, "colors": { "description": "Information about supported colors", "is_optional": false, "type": "vector\u003cprofileAccentColor\u003e" } }, "type": "Update" }, "updateQuickReplyShortcut": { "description": "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", "args": { "shortcut": { "description": "New data about the shortcut", "is_optional": false, "type": "quickReplyShortcut" } }, "type": "Update" }, "updateQuickReplyShortcutDeleted": { "description": "A quick reply shortcut and all its messages were deleted", "args": { "shortcut_id": { "description": "The identifier of the deleted shortcut", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateQuickReplyShortcutMessages": { "description": "The list of quick reply shortcut messages has changed", "args": { "messages": { "description": "The new list of quick reply messages for the shortcut in order from the first to the last sent", "is_optional": false, "type": "vector\u003cquickReplyMessage\u003e" }, "shortcut_id": { "description": "The identifier of the shortcut", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateQuickReplyShortcuts": { "description": "The list of quick reply shortcuts has changed", "args": { "shortcut_ids": { "description": "The new list of identifiers of quick reply shortcuts", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Update" }, "updateReactionNotificationSettings": { "description": "Notification settings for reactions were updated", "args": { "notification_settings": { "description": "The new notification settings", "is_optional": false, "type": "reactionNotificationSettings" } }, "type": "Update" }, "updateRecentStickers": { "description": "The list of recently used stickers was updated", "args": { "is_attached": { "description": "True, if the list of stickers attached to photo or video files was updated; otherwise, the list of sent stickers is updated", "is_optional": false, "type": "Bool" }, "sticker_ids": { "description": "The new list of file identifiers of recently used stickers", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Update" }, "updateSavedAnimations": { "description": "The list of saved animations was updated", "args": { "animation_ids": { "description": "The new list of file identifiers of saved animations", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Update" }, "updateSavedMessagesTags": { "description": "Tags used in Saved Messages or a Saved Messages topic have changed", "args": { "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which tags were changed; 0 if tags for the whole chat has changed", "is_optional": false, "type": "int53" }, "tags": { "description": "The new tags", "is_optional": false, "type": "savedMessagesTags" } }, "type": "Update" }, "updateSavedMessagesTopic": { "description": "Basic information about a Saved Messages topic has changed. This update is guaranteed to come before the topic identifier is returned to the application", "args": { "topic": { "description": "New data about the topic", "is_optional": false, "type": "savedMessagesTopic" } }, "type": "Update" }, "updateSavedMessagesTopicCount": { "description": "Number of Saved Messages topics has changed", "args": { "topic_count": { "description": "Approximate total number of Saved Messages topics", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateSavedNotificationSounds": { "description": "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", "args": { "notification_sound_ids": { "description": "The new list of identifiers of saved notification sounds", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Update" }, "updateScopeNotificationSettings": { "description": "Notification settings for some type of chats were updated", "args": { "notification_settings": { "description": "The new notification settings", "is_optional": false, "type": "scopeNotificationSettings" }, "scope": { "description": "Types of chats for which notification settings were updated", "is_optional": false, "type": "NotificationSettingsScope" } }, "type": "Update" }, "updateSecretChat": { "description": "Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the application", "args": { "secret_chat": { "description": "New data about the secret chat", "is_optional": false, "type": "secretChat" } }, "type": "Update" }, "updateServiceNotification": { "description": "A service notification from the server was received. Upon receiving this the application must show a popup with the content of the notification", "args": { "content": { "description": "Notification content", "is_optional": false, "type": "MessageContent" }, "type": { "description": "Notification type. If type begins with \"AUTH_KEY_DROP_\", then two buttons \"Cancel\" and \"Log out\" must be shown under notification; if user presses the second, all local data must be destroyed using Destroy method", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateSpeechRecognitionTrial": { "description": "The parameters of speech recognition without Telegram Premium subscription have changed", "args": { "left_count": { "description": "Number of left speech recognition attempts this week", "is_optional": false, "type": "int32" }, "max_media_duration": { "description": "The maximum allowed duration of media for speech recognition without Telegram Premium subscription, in seconds", "is_optional": false, "type": "int32" }, "next_reset_date": { "description": "Point in time (Unix timestamp) when the weekly number of tries will reset; 0 if unknown", "is_optional": false, "type": "int32" }, "weekly_count": { "description": "The total number of allowed speech recognitions per week; 0 if none", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateSpeedLimitNotification": { "description": "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 file being downloaded or uploaded is visible to the user.", "args": { "is_upload": { "description": "True, if upload speed was limited; false, if download speed was limited", "is_optional": false, "type": "Bool" } }, "type": "Update" }, "updateStakeDiceState": { "description": "The stake dice state has changed", "args": { "state": { "description": "The new state. The state can be used only if it was received recently enough. Otherwise, a new state must be requested using getStakeDiceState", "is_optional": false, "type": "stakeDiceState" } }, "type": "Update" }, "updateStarRevenueStatus": { "description": "The Telegram Star revenue earned by a user or a chat has changed. If Telegram Star transaction screen of the chat is opened, then getStarTransactions may be called to fetch new transactions", "args": { "owner_id": { "description": "Identifier of the owner of the Telegram Stars", "is_optional": false, "type": "MessageSender" }, "status": { "description": "New Telegram Star revenue status", "is_optional": false, "type": "starRevenueStatus" } }, "type": "Update" }, "updateStickerSet": { "description": "A sticker set has changed", "args": { "sticker_set": { "description": "The sticker set", "is_optional": false, "type": "stickerSet" } }, "type": "Update" }, "updateStopMessageDraft": { "description": "A message draft generation was stopped by the user", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_id": { "description": "Identifier of the message draft within the message thread", "is_optional": false, "type": "int64" }, "forum_topic_id": { "description": "The forum topic identifier of the message draft", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateStory": { "description": "A story was changed", "args": { "story": { "description": "The new information about the story", "is_optional": false, "type": "story" } }, "type": "Update" }, "updateStoryDeleted": { "description": "A story became inaccessible", "args": { "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateStoryListChatCount": { "description": "Number of chats in a story list has changed", "args": { "chat_count": { "description": "Approximate total number of chats with active stories in the list", "is_optional": false, "type": "int32" }, "story_list": { "description": "The story list", "is_optional": false, "type": "StoryList" } }, "type": "Update" }, "updateStoryPostFailed": { "description": "A story failed to post. If the story posting is canceled, then updateStoryDeleted will be received instead of this update", "args": { "error": { "description": "The cause of the story posting failure", "is_optional": false, "type": "error" }, "error_type": { "description": "Type of the error; may be null if unknown", "is_optional": true, "type": "CanPostStoryResult" }, "story": { "description": "The failed to post story", "is_optional": false, "type": "story" } }, "type": "Update" }, "updateStoryPostSucceeded": { "description": "A story has been successfully posted", "args": { "old_story_id": { "description": "The previous temporary story identifier", "is_optional": false, "type": "int32" }, "story": { "description": "The posted story", "is_optional": false, "type": "story" } }, "type": "Update" }, "updateStoryStealthMode": { "description": "Story stealth mode settings have changed", "args": { "active_until_date": { "description": "Point in time (Unix timestamp) until stealth mode is active; 0 if it is disabled", "is_optional": false, "type": "int32" }, "cooldown_until_date": { "description": "Point in time (Unix timestamp) when stealth mode can be enabled again; 0 if there is no active cooldown", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateSuggestedActions": { "description": "The list of suggested to the user actions has changed", "args": { "added_actions": { "description": "Added suggested actions", "is_optional": false, "type": "vector\u003cSuggestedAction\u003e" }, "removed_actions": { "description": "Removed suggested actions", "is_optional": false, "type": "vector\u003cSuggestedAction\u003e" } }, "type": "Update" }, "updateSupergroup": { "description": "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", "args": { "supergroup": { "description": "New data about the supergroup", "is_optional": false, "type": "supergroup" } }, "type": "Update" }, "updateSupergroupFullInfo": { "description": "Some data in supergroupFullInfo has been changed", "args": { "supergroup_full_info": { "description": "New full information about the supergroup", "is_optional": false, "type": "supergroupFullInfo" }, "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateTermsOfService": { "description": "New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method must be called with the reason \"Decline ToS update\"", "args": { "terms_of_service": { "description": "The new terms of service", "is_optional": false, "type": "termsOfService" }, "terms_of_service_id": { "description": "Identifier of the terms of service", "is_optional": false, "type": "string" } }, "type": "Update" }, "updateTextCompositionStyles": { "description": "The styles supported for text composition have changed", "args": { "styles": { "description": "The new list of supported styles", "is_optional": false, "type": "vector\u003ctextCompositionStyle\u003e" } }, "type": "Update" }, "updateTonWalletGaslessTransfersInfo": { "description": "The information about gasless transfers has changed", "args": { "info": { "description": "The new state of the wallet", "is_optional": false, "type": "tonWalletGaslessTransfersInfo" } }, "type": "Update" }, "updateTonWalletState": { "description": "The state of the TON wallet of the current user has changed", "args": { "state": { "description": "The new state of the wallet", "is_optional": false, "type": "tonWalletState" } }, "type": "Update" }, "updateTonWalletTonConnectSession": { "description": "A session of a TON Connect has changed", "args": { "session": { "description": "The new state of the session", "is_optional": false, "type": "tonConnectSession" } }, "type": "Update" }, "updateTonWalletTonConnectSessionDisconnectRequired": { "description": "TON Connect sessions must be disconnected in a regular way", "args": { "session_ids": { "description": "Identifiers of the sessions", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Update" }, "updateTopicMessageCount": { "description": "Number of messages in a topic has changed; for Saved Messages and channel direct messages chat topics only", "args": { "chat_id": { "description": "Identifier of the chat in topic of which the number of messages has changed", "is_optional": false, "type": "int53" }, "message_count": { "description": "Approximate number of messages in the topic", "is_optional": false, "type": "int32" }, "topic_id": { "description": "Identifier of the topic", "is_optional": false, "type": "MessageTopic" } }, "type": "Update" }, "updateTrendingStickerSets": { "description": "The list of trending sticker sets was updated or some of them were viewed", "args": { "sticker_sets": { "description": "The prefix of the list of trending sticker sets with the newest trending sticker sets", "is_optional": false, "type": "trendingStickerSets" }, "sticker_type": { "description": "Type of the affected stickers", "is_optional": false, "type": "StickerType" } }, "type": "Update" }, "updateTrustedMiniAppBots": { "description": "Lists of bots which Mini Apps must be allowed to read text from clipboard and must be opened without a warning", "args": { "bot_user_ids": { "description": "List of user identifiers of the bots; the corresponding users may not be sent using updateUser updates and may not be accessible", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Update" }, "updateUnconfirmedSession": { "description": "The first unconfirmed session has changed", "args": { "session": { "description": "The unconfirmed session; may be null if none", "is_optional": true, "type": "unconfirmedSession" }, "unconfirmed_session_count": { "description": "The total number of unconfirmed sessions", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateUnreadChatCount": { "description": "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", "args": { "chat_list": { "description": "The chat list with changed number of unread messages", "is_optional": false, "type": "ChatList" }, "marked_as_unread_count": { "description": "Total number of chats marked as unread", "is_optional": false, "type": "int32" }, "marked_as_unread_unmuted_count": { "description": "Total number of unmuted chats marked as unread", "is_optional": false, "type": "int32" }, "total_count": { "description": "Approximate total number of chats in the chat list", "is_optional": false, "type": "int32" }, "unread_count": { "description": "Total number of unread chats", "is_optional": false, "type": "int32" }, "unread_unmuted_count": { "description": "Total number of unread unmuted chats", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateUnreadMessageCount": { "description": "Number of unread messages in a chat list has changed. This update is sent only if the message database is used", "args": { "chat_list": { "description": "The chat list with changed number of unread messages", "is_optional": false, "type": "ChatList" }, "unread_count": { "description": "Total number of unread messages", "is_optional": false, "type": "int32" }, "unread_unmuted_count": { "description": "Total number of unread messages in unmuted chats", "is_optional": false, "type": "int32" } }, "type": "Update" }, "updateUser": { "description": "Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the application", "args": { "user": { "description": "New data about the user", "is_optional": false, "type": "user" } }, "type": "Update" }, "updateUserFullInfo": { "description": "Some data in userFullInfo has been changed", "args": { "user_full_info": { "description": "New full information about the user", "is_optional": false, "type": "userFullInfo" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateUserPrivacySettingRules": { "description": "Some privacy setting rules have been changed", "args": { "rules": { "description": "New privacy rules", "is_optional": false, "type": "userPrivacySettingRules" }, "setting": { "description": "The privacy setting", "is_optional": false, "type": "UserPrivacySetting" } }, "type": "Update" }, "updateUserStatus": { "description": "The user went online or offline", "args": { "status": { "description": "New status of the user", "is_optional": false, "type": "UserStatus" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateUserSubscription": { "description": "Subscription of a user to the bot was changed; for bots only", "args": { "is_canceled": { "description": "True, if the subscription was canceled", "is_optional": false, "type": "Bool" }, "is_payment_failed": { "description": "True, if the payment for the subscription has failed", "is_optional": false, "type": "Bool" }, "is_restored": { "description": "True, if the subscription was restored", "is_optional": false, "type": "Bool" }, "payload": { "description": "Bot-specified subscription invoice payload", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateVideoPublished": { "description": "An automatically scheduled message with video has been successfully sent after conversion", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the sent message", "is_optional": false, "type": "int53" } }, "type": "Update" }, "updateWebAppMessageSent": { "description": "A message was sent by an opened Web App, so the Web App needs to be closed", "args": { "web_app_launch_id": { "description": "Identifier of Web App launch", "is_optional": false, "type": "int64" } }, "type": "Update" }, "updateWebBrowserSettings": { "description": "Web browser settings have been updated", "args": { "settings": { "description": "New settings", "is_optional": false, "type": "webBrowserSettings" } }, "type": "Update" }, "updates": { "description": "Contains a list of updates", "args": { "updates": { "description": "List of updates", "is_optional": false, "type": "vector\u003cUpdate\u003e" } }, "type": "Updates" } }, "functions": { "acceptCall": { "description": "Accepts an incoming call", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "int32" }, "protocol": { "description": "The call protocols supported by the application", "is_optional": false, "type": "callProtocol" } }, "type": "Ok" }, "acceptOauthRequest": { "description": "Accepts an OAuth authorization request. Returns an HTTP URL to open after successful authorization.", "args": { "allow_phone_number_access": { "description": "Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to access their phone number", "is_optional": false, "type": "Bool" }, "allow_write_access": { "description": "Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to send them messages", "is_optional": false, "type": "Bool" }, "match_code": { "description": "The matching code chosen by the user", "is_optional": false, "type": "string" }, "url": { "description": "URL of the OAuth deep link", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "acceptTermsOfService": { "description": "Accepts Telegram terms of service", "args": { "terms_of_service_id": { "description": "Terms of service identifier", "is_optional": false, "type": "string" } }, "type": "Ok" }, "activateStoryStealthMode": { "description": "Activates stealth mode for stories, which hides all views of stories from the current user in the last \"story_stealth_mode_past_period\" seconds", "args": {}, "type": "Ok" }, "addBotMediaPreview": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must be owned and must have the main Web App", "is_optional": false, "type": "int53" }, "content": { "description": "Content of the added preview", "is_optional": false, "type": "InputStoryContent" }, "language_code": { "description": "A two-letter ISO 639-1 language code for which preview is added. If empty, then the preview will be shown to all users for whose languages there are no dedicated previews.", "is_optional": false, "type": "string" } }, "type": "BotMediaPreview" }, "addBotSecondaryUsername": { "description": "Adds a secondary username to a bot. Can be called only if userTypeBot.can_be_edited, the bot has no secondary username and the current user has Telegram Premium subscription.", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "username": { "description": "The new secondary username; must be non-empty. Use checkBotUsername to check username validness", "is_optional": false, "type": "string" } }, "type": "Ok" }, "addChatFolderByInviteLink": { "description": "Adds a chat folder by an invite link", "args": { "chat_ids": { "description": "Identifiers of the chats added to the chat folder. The chats are automatically joined if they aren't joined yet", "is_optional": false, "type": "vector\u003cint53\u003e" }, "invite_link": { "description": "Invite link for the chat folder", "is_optional": false, "type": "string" } }, "type": "Ok" }, "addChatMember": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forward_limit": { "description": "The number of earlier messages from the chat to be forwarded to the new member; up to 100. Ignored for supergroups and channels, or if the added user is a bot", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "FailedToAddMembers" }, "addChatMembers": { "description": "Adds multiple new members to a chat; requires can_invite_users member right. Currently, this method is available only in supergroups and channels.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "user_ids": { "description": "Identifiers of the users to be added to the chat. The maximum number of added users is 20 for supergroups and 100 for channels", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "FailedToAddMembers" }, "addChatToList": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "chat_list": { "description": "The chat list. Use getChatListsToAddChat to get suitable chat lists", "is_optional": false, "type": "ChatList" } }, "type": "Ok" }, "addChatWelcomeMessage": { "description": "Adds a message to the list of welcome messages of a chat; requires can_send_welcome_messages administrator right in the chat. There can be up to getOption(\"welcome_message_count_max\") welcome messages in a chat", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation,", "is_optional": false, "type": "InputMessageContent" } }, "type": "Ok" }, "addChecklistTasks": { "description": "Adds tasks to a checklist in a message", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the checklist. Use messageProperties.can_add_tasks to check whether the tasks can be added", "is_optional": false, "type": "int53" }, "tasks": { "description": "List of added tasks", "is_optional": false, "type": "vector\u003cinputChecklistTask\u003e" } }, "type": "Ok" }, "addContact": { "description": "Adds a user to the contact list or edits an existing contact by their user identifier", "args": { "contact": { "description": "The contact to add or edit; phone number may be empty and needs to be specified only if known", "is_optional": true, "type": "importedContact" }, "share_phone_number": { "description": "Pass true to share the current user's phone number with the new contact. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed.", "is_optional": false, "type": "Bool" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "addCustomServerLanguagePack": { "description": "Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization", "args": { "language_pack_id": { "description": "Identifier of a language pack to be added", "is_optional": false, "type": "string" } }, "type": "Ok" }, "addFavoriteSticker": { "description": "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.", "args": { "sticker": { "description": "Sticker file to add", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "addFileToDownloads": { "description": "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.", "args": { "chat_id": { "description": "Chat identifier of the message with the file", "is_optional": false, "type": "int53" }, "file_id": { "description": "Identifier of the file to download", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "priority": { "description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first", "is_optional": false, "type": "int32" } }, "type": "File" }, "addGiftCollectionGifts": { "description": "Adds gifts to the beginning of a previously created collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection", "args": { "collection_id": { "description": "Identifier of the gift collection", "is_optional": false, "type": "int32" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" }, "received_gift_ids": { "description": "Identifier of the gifts to add to the collection; 1-getOption(\"gift_collection_size_max\") identifiers.", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "GiftCollection" }, "addLocalMessage": { "description": "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", "args": { "chat_id": { "description": "Target chat; channel direct messages chats aren't supported", "is_optional": false, "type": "int53" }, "disable_notification": { "description": "Pass true to disable notification for the message", "is_optional": false, "type": "Bool" }, "input_message_content": { "description": "The content of the message to be added", "is_optional": false, "type": "InputMessageContent" }, "reply_to": { "description": "Information about the message or story to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "sender_id": { "description": "Identifier of the sender of the message", "is_optional": false, "type": "MessageSender" } }, "type": "Message" }, "addLogMessage": { "description": "Adds a message to TDLib internal log. Can be called synchronously", "args": { "text": { "description": "Text of a message to log", "is_optional": false, "type": "string" }, "verbosity_level": { "description": "The minimum verbosity level needed for the message to be logged; 0-1023", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "addLoginPasskey": { "description": "Adds a passkey allowed to be used for the login by the current user and returns the added passkey. Call getPasskeyParameters to get parameters for creating of the passkey", "args": { "attestation_object": { "description": "Passkey attestation object", "is_optional": false, "type": "bytes" }, "client_data": { "description": "JSON-encoded client data", "is_optional": false, "type": "string" } }, "type": "Passkey" }, "addMessageReaction": { "description": "Adds a reaction or a tag to a message. Use getMessageAvailableReactions to receive the list of available reactions for the message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "is_big": { "description": "Pass true if the reaction is added with a big animation", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reaction_type": { "description": "Type of the reaction to add. Use addPendingPaidMessageReaction instead to add the paid reaction", "is_optional": false, "type": "ReactionType" }, "update_recent_reactions": { "description": "Pass true if the reaction needs to be added to recent reactions; tags are never added to the list of recent reactions", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "addNetworkStatistics": { "description": "Adds the specified data to data usage statistics. Can be called before authorization", "args": { "entry": { "description": "The network statistics entry with the data to be added to statistics", "is_optional": false, "type": "NetworkStatisticsEntry" } }, "type": "Ok" }, "addOffer": { "description": "Sends a suggested post based on a previously sent message in a channel direct messages chat. Can be also used to suggest price or time change for an existing suggested post.", "args": { "chat_id": { "description": "Identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message in the chat which will be sent as suggested post. Use messageProperties.can_add_offer to check whether an offer can be added", "is_optional": false, "type": "int53" }, "options": { "description": "Options to be used to send the message. New information about the suggested post must always be specified", "is_optional": false, "type": "messageSendOptions" } }, "type": "Message" }, "addPendingLiveStoryReaction": { "description": "Adds pending paid reaction in a live story group call. Can't be used in live stories posted by the current user.", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "star_count": { "description": "Number of Telegram Stars to be used for the reaction. The total number of pending paid reactions must not exceed getOption(\"paid_group_call_message_star_count_max\")", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "addPendingPaidMessageReaction": { "description": "Adds the paid message reaction to a message. Use getMessageAvailableReactions to check whether the reaction is available for the message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "star_count": { "description": "Number of Telegram Stars to be used for the reaction. The total number of pending paid reactions must not exceed getOption(\"paid_reaction_star_count_max\")", "is_optional": false, "type": "int53" }, "type": { "description": "Type of the paid reaction; pass null if the user didn't choose reaction type explicitly, for example, the reaction is set from the message bubble", "is_optional": true, "type": "PaidReactionType" } }, "type": "Ok" }, "addPollOption": { "description": "Adds an option to a poll", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the poll. Use messagePoll.can_add_option to check whether an option can be added", "is_optional": false, "type": "int53" }, "option": { "description": "The new option", "is_optional": false, "type": "inputPollOption" } }, "type": "Ok" }, "addProfileAudio": { "description": "Adds an audio file to the beginning of the profile audio files of the current user", "args": { "audio": { "description": "The audio to add", "is_optional": false, "type": "inputAudio" } }, "type": "Ok" }, "addProxy": { "description": "Adds a proxy server for network requests. Can be called before authorization", "args": { "comment": { "description": "Comment to set for the proxy", "is_optional": false, "type": "string" }, "enable": { "description": "Pass true to immediately enable the proxy", "is_optional": false, "type": "Bool" }, "proxy": { "description": "The proxy to add", "is_optional": false, "type": "proxy" } }, "type": "AddedProxy" }, "addQuickReplyShortcutInlineQueryResultMessage": { "description": "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.", "args": { "hide_via_bot": { "description": "Pass true to hide the bot, via which the message is sent. Can be used only for bots getOption(\"animation_search_bot_username\"), getOption(\"photo_search_bot_username\"), and getOption(\"venue_search_bot_username\")", "is_optional": false, "type": "Bool" }, "query_id": { "description": "Identifier of the inline query", "is_optional": false, "type": "int64" }, "reply_to_message_id": { "description": "Identifier of a quick reply message in the same shortcut to be replied; pass 0 if none", "is_optional": false, "type": "int53" }, "result_id": { "description": "Identifier of the inline query result", "is_optional": false, "type": "string" }, "shortcut_name": { "description": "Name of the target shortcut", "is_optional": false, "type": "string" } }, "type": "QuickReplyMessage" }, "addQuickReplyShortcutMessage": { "description": "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.", "args": { "input_message_content": { "description": "The content of the message to be added; inputMessagePaidMedia, inputMessageForwarded and inputMessageLiveLocation", "is_optional": false, "type": "InputMessageContent" }, "reply_to_message_id": { "description": "Identifier of a quick reply message in the same shortcut to be replied; pass 0 if none", "is_optional": false, "type": "int53" }, "shortcut_name": { "description": "Name of the target shortcut", "is_optional": false, "type": "string" } }, "type": "QuickReplyMessage" }, "addQuickReplyShortcutMessageAlbum": { "description": "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.", "args": { "input_message_contents": { "description": "Contents of messages to be sent. At most 10 messages can be added to an album. All messages must have the same value of show_caption_above_media", "is_optional": false, "type": "vector\u003cInputMessageContent\u003e" }, "reply_to_message_id": { "description": "Identifier of a quick reply message in the same shortcut to be replied; pass 0 if none", "is_optional": false, "type": "int53" }, "shortcut_name": { "description": "Name of the target shortcut", "is_optional": false, "type": "string" } }, "type": "QuickReplyMessages" }, "addRecentSticker": { "description": "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.", "args": { "is_attached": { "description": "Pass true to add the sticker to the list of stickers recently attached to photo or video files; pass false to add the sticker to the list of recently sent stickers", "is_optional": false, "type": "Bool" }, "sticker": { "description": "Sticker file to add", "is_optional": false, "type": "InputFile" } }, "type": "Stickers" }, "addRecentlyFoundChat": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat to add", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "addSavedAnimation": { "description": "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.", "args": { "animation": { "description": "The animation file to be added. Only animations known to the server (i.e., successfully sent via a message) can be added to the list", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "addSavedNotificationSound": { "description": "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", "args": { "sound": { "description": "Notification sound file to add", "is_optional": false, "type": "InputFile" } }, "type": "NotificationSound" }, "addStickerToSet": { "description": "Adds a new sticker to a set", "args": { "name": { "description": "Sticker set name. The sticker set must be owned by the current user, and contain less than 200 stickers for custom emoji sticker sets and less than 120 otherwise", "is_optional": false, "type": "string" }, "sticker": { "description": "Sticker to add to the set", "is_optional": false, "type": "newSticker" }, "user_id": { "description": "Sticker set owner; ignored for regular users", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "addStoryAlbumStories": { "description": "Adds stories to the beginning of a previously created story album. If the album is owned by a supergroup or a channel chat, then", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "story_album_id": { "description": "Identifier of the story album", "is_optional": false, "type": "int32" }, "story_ids": { "description": "Identifier of the stories to add to the album; 1-getOption(\"story_album_size_max\") identifiers.", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "StoryAlbum" }, "addTextCompositionStyle": { "description": "Adds a custom text composition style to the list of used by the user styles. May return an error with a message \"TONES_SAVED_TOO_MANY\"", "args": { "name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "Ok" }, "addWebBrowserSettingsException": { "description": "Adds a special handling for the opening of the specified URL", "args": { "open_external_browser": { "description": "Pass true if the specified website must be opened in an external browser; pass false to open it in the in-app browser. There can be at most 100 exceptions in each list of the exceptions", "is_optional": false, "type": "Bool" }, "url": { "description": "URL of the website", "is_optional": false, "type": "string" } }, "type": "Ok" }, "allowBotToSendMessages": { "description": "Allows the specified bot to send messages to the user", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "allowUnpaidMessagesFromUser": { "description": "Allows the specified user to send unpaid private messages to the current user by adding a rule to userPrivacySettingAllowUnpaidMessages", "args": { "refund_payments": { "description": "Pass true to refund the user previously paid messages", "is_optional": false, "type": "Bool" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "answerCallbackQuery": { "description": "Sets the result of a callback query; for bots only", "args": { "cache_time": { "description": "Time during which the result of the query can be cached, in seconds", "is_optional": false, "type": "int32" }, "callback_query_id": { "description": "Identifier of the callback query", "is_optional": false, "type": "int64" }, "show_alert": { "description": "Pass true to show an alert to the user instead of a toast notification", "is_optional": false, "type": "Bool" }, "text": { "description": "Text of the answer", "is_optional": false, "type": "string" }, "url": { "description": "URL to be opened", "is_optional": false, "type": "string" } }, "type": "Ok" }, "answerChatJoinRequestQuery": { "description": "Sets the result of a chat join query; for bots only", "args": { "query_id": { "description": "Identifier of the query", "is_optional": false, "type": "int64" }, "result": { "description": "The result; must be null if a URL is passed", "is_optional": false, "type": "ChatJoinRequestResult" }, "url": { "description": "URL of the Web App to open; must be null if a result is passed", "is_optional": false, "type": "string" } }, "type": "Ok" }, "answerCustomQuery": { "description": "Answers a custom query; for bots only", "args": { "custom_query_id": { "description": "Identifier of a custom query", "is_optional": false, "type": "int64" }, "data": { "description": "JSON-serialized answer to the query", "is_optional": false, "type": "string" } }, "type": "Ok" }, "answerGuestQuery": { "description": "Sets the result of a guest query; for bots only", "args": { "guest_query_id": { "description": "Identifier of the guest query", "is_optional": false, "type": "int64" }, "result": { "description": "The result of the query", "is_optional": false, "type": "InputInlineQueryResult" } }, "type": "InlineMessageId" }, "answerInlineQuery": { "description": "Sets the result of an inline query; for bots only", "args": { "button": { "description": "Button to be shown above inline query results; pass null if none", "is_optional": true, "type": "inlineQueryResultsButton" }, "cache_time": { "description": "Allowed time to cache the results of the query, in seconds", "is_optional": false, "type": "int32" }, "inline_query_id": { "description": "Identifier of the inline query", "is_optional": false, "type": "int64" }, "is_personal": { "description": "Pass true if results may be cached and returned only for the user who sent the query. By default, results may be returned to any user who sends the same query", "is_optional": false, "type": "Bool" }, "next_offset": { "description": "Offset for the next inline query; pass an empty string if there are no more results", "is_optional": false, "type": "string" }, "results": { "description": "The results of the query", "is_optional": false, "type": "vector\u003cInputInlineQueryResult\u003e" } }, "type": "Ok" }, "answerPreCheckoutQuery": { "description": "Sets the result of a pre-checkout query; for bots only", "args": { "error_message": { "description": "An error message, empty on success", "is_optional": false, "type": "string" }, "pre_checkout_query_id": { "description": "Identifier of the pre-checkout query", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "answerShippingQuery": { "description": "Sets the result of a shipping query; for bots only", "args": { "error_message": { "description": "An error message, empty on success", "is_optional": false, "type": "string" }, "shipping_options": { "description": "Available shipping options", "is_optional": false, "type": "vector\u003cshippingOption\u003e" }, "shipping_query_id": { "description": "Identifier of the shipping query", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "answerTonConnectRequest": { "description": "Sends an answer for a request received through TON Connect", "args": { "body": { "description": "Body of the response", "is_optional": false, "type": "bytes" }, "message_id": { "description": "Identifier of the message with the request", "is_optional": false, "type": "int53" }, "session_id": { "description": "Unique identifier of the TON Connect session", "is_optional": false, "type": "int64" }, "trace_id": { "description": "Identifier to trace the request", "is_optional": false, "type": "string" } }, "type": "Ok" }, "answerWebAppQuery": { "description": "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", "args": { "result": { "description": "The result of the query", "is_optional": false, "type": "InputInlineQueryResult" }, "web_app_query_id": { "description": "Identifier of the Web App query", "is_optional": false, "type": "string" } }, "type": "InlineMessageId" }, "applyPremiumGiftCode": { "description": "Applies a Telegram Premium gift code", "args": { "code": { "description": "The code to apply", "is_optional": false, "type": "string" } }, "type": "Ok" }, "approveSuggestedPost": { "description": "Approves a suggested post in a channel direct messages chat", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message with the suggested post. Use messageProperties.can_be_approved to check whether the suggested post can be approved", "is_optional": false, "type": "int53" }, "send_date": { "description": "Point in time (Unix timestamp) when the post is expected to be published; pass 0 if the date has already been chosen. If specified,", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "assignStoreTransaction": { "description": "Informs server about an in-store purchase. For official applications only", "args": { "purpose": { "description": "Transaction purpose", "is_optional": false, "type": "StorePaymentPurpose" }, "transaction": { "description": "Information about the transaction", "is_optional": false, "type": "StoreTransaction" } }, "type": "Ok" }, "banChatMember": { "description": "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", "args": { "banned_until_date": { "description": "Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned", "is_optional": false, "type": "int32" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "member_id": { "description": "Member identifier", "is_optional": false, "type": "MessageSender" }, "revoke_messages": { "description": "Pass true to delete all messages in the chat for the user who is being removed. Always true for supergroups and channels", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "banGroupCallParticipants": { "description": "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", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "user_ids": { "description": "Identifiers of group call participants to ban; identifiers of unknown users from the update updateGroupCallParticipants can be also passed to the method", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Ok" }, "blockMessageSenderFromReplies": { "description": "Blocks an original sender of a message in the Replies chat", "args": { "delete_all_messages": { "description": "Pass true to delete all messages from the same sender", "is_optional": false, "type": "Bool" }, "delete_message": { "description": "Pass true to delete the message", "is_optional": false, "type": "Bool" }, "message_id": { "description": "The identifier of an incoming message in the Replies chat", "is_optional": false, "type": "int53" }, "report_spam": { "description": "Pass true to report the sender to the Telegram moderators", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "boostChat": { "description": "Boosts a chat and returns the list of available chat boost slots for the current user after the boost", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "slot_ids": { "description": "Identifiers of boost slots of the current user from which to apply boosts to the chat", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "ChatBoostSlots" }, "buyGiftUpgrade": { "description": "Pays for upgrade of a regular gift that is owned by another user or channel chat", "args": { "owner_id": { "description": "Identifier of the user or the channel chat that owns the gift", "is_optional": false, "type": "MessageSender" }, "prepaid_upgrade_hash": { "description": "Prepaid upgrade hash as received along with the gift", "is_optional": false, "type": "string" }, "star_count": { "description": "The Telegram Star amount the user agreed to pay for the upgrade; must be equal to gift.upgrade_star_count", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "canBotSendMessages": { "description": "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 allowBotToSendMessages", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "canPostStory": { "description": "Checks whether the current user can post a story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats", "args": { "chat_id": { "description": "Chat identifier. Pass Saved Messages chat identifier when posting a story on behalf of the current user", "is_optional": false, "type": "int53" } }, "type": "CanPostStoryResult" }, "canPurchaseFromStore": { "description": "Checks whether an in-store purchase is possible. Must be called before any in-store purchase. For official applications only", "args": { "purpose": { "description": "Transaction purpose", "is_optional": false, "type": "StorePaymentPurpose" } }, "type": "Ok" }, "canSendGift": { "description": "Checks whether a gift with next_send_date in the future can be sent already", "args": { "gift_id": { "description": "Identifier of the gift to send", "is_optional": false, "type": "int64" } }, "type": "CanSendGiftResult" }, "canSendMessageToUser": { "description": "Checks whether the current user can message another user or try to create a chat with them", "args": { "only_local": { "description": "Pass true to get only locally available information without sending network requests", "is_optional": false, "type": "Bool" }, "user_id": { "description": "Identifier of the other user", "is_optional": false, "type": "int53" } }, "type": "CanSendMessageToUserResult" }, "canTransferOwnership": { "description": "Checks whether the current session can be used to transfer a chat ownership to another user", "args": {}, "type": "CanTransferOwnershipResult" }, "cancelDownloadFile": { "description": "Stops the downloading of a file. If a file has already been downloaded, does nothing", "args": { "file_id": { "description": "Identifier of a file to stop downloading", "is_optional": false, "type": "int32" }, "only_if_pending": { "description": "Pass true to stop downloading only if it hasn't been started, i.e. request hasn't been sent to server", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "cancelPasswordReset": { "description": "Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date \u003e 0", "args": {}, "type": "Ok" }, "cancelPreliminaryUploadFile": { "description": "Stops the preliminary uploading of a file. Supported only for files uploaded by using preliminaryUploadFile", "args": { "file_id": { "description": "Identifier of the file to stop uploading", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "cancelRecoveryEmailAddressVerification": { "description": "Cancels verification of the 2-step verification recovery email address", "args": {}, "type": "PasswordState" }, "changeImportedContacts": { "description": "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.", "args": { "contacts": { "description": "The new list of contacts to import", "is_optional": false, "type": "vector\u003cimportedContact\u003e" } }, "type": "ImportedContacts" }, "changeStickerSet": { "description": "Installs/uninstalls or activates/archives a sticker set", "args": { "is_archived": { "description": "The new value of is_archived. A sticker set can't be installed and archived simultaneously", "is_optional": false, "type": "Bool" }, "is_installed": { "description": "The new value of is_installed", "is_optional": false, "type": "Bool" }, "set_id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "changeWebBrowserSettings": { "description": "Changes web browser settings", "args": { "display_close_button": { "description": "Pass true if a close button must be shown in the in-app browser; for Android app only", "is_optional": false, "type": "Bool" }, "open_external_browser": { "description": "Pass true if links must be opened in an external browser by default", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "checkAuthenticationBotToken": { "description": "Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in", "args": { "token": { "description": "The bot token", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkAuthenticationCode": { "description": "Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode", "args": { "code": { "description": "Authentication code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkAuthenticationEmailCode": { "description": "Checks the authentication of an email address. Works only when the current authorization state is authorizationStateWaitEmailCode", "args": { "code": { "description": "Email address authentication to check", "is_optional": false, "type": "EmailAddressAuthentication" } }, "type": "Ok" }, "checkAuthenticationPasskey": { "description": "Checks a passkey to log in to the corresponding account. Call getAuthenticationPasskeyParameters to get parameters for the passkey. Works only when the current authorization state is", "args": { "authenticator_data": { "description": "Authenticator data of the application that created the credential", "is_optional": false, "type": "bytes" }, "client_data": { "description": "JSON-encoded client data", "is_optional": false, "type": "string" }, "credential_id": { "description": "Base64url-encoded identifier of the credential", "is_optional": false, "type": "string" }, "signature": { "description": "Cryptographic signature of the credential", "is_optional": false, "type": "bytes" }, "user_handle": { "description": "User handle of the passkey", "is_optional": false, "type": "bytes" } }, "type": "Ok" }, "checkAuthenticationPassword": { "description": "Checks the 2-step verification password for correctness. Works only when the current authorization state is authorizationStateWaitPassword", "args": { "password": { "description": "The 2-step verification password to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkAuthenticationPasswordRecoveryCode": { "description": "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", "args": { "recovery_code": { "description": "Recovery code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkAuthenticationPremiumPurchase": { "description": "Checks whether an in-store purchase of Telegram Premium is possible before authorization. Works only when the current authorization state is authorizationStateWaitPremiumPurchase", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "premium_day_count": { "description": "The number of days for which the Telegram Premium subscription will be granted", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "checkAuthenticationWebToken": { "description": "Checks a web token to log in to the corresponding account; for official Telegram apps only. Works only when the current authorization state is", "args": { "dc_id": { "description": "Identifier of the datacenter of the user", "is_optional": false, "type": "int32" }, "token": { "description": "The token to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkBotUsername": { "description": "Checks whether a username can be set for a new bot or assigned as a secondary username to an existing bot. Use checkChatUsername to check username for other chat types", "args": { "is_secondary": { "description": "Pass true to check whether the username is suitable as a secondary username for an existing bot; pass false to check whether the username is suitable for createBot", "is_optional": false, "type": "Bool" }, "username": { "description": "Username to be checked", "is_optional": false, "type": "string" } }, "type": "CheckChatUsernameResult" }, "checkChatFolderInviteLink": { "description": "Checks the validity of an invite link for a chat folder and returns information about the corresponding chat folder", "args": { "invite_link": { "description": "Invite link to be checked", "is_optional": false, "type": "string" } }, "type": "ChatFolderInviteLinkInfo" }, "checkChatInviteLink": { "description": "Checks the validity of an invite link for a chat and returns information about the corresponding chat", "args": { "invite_link": { "description": "Invite link to be checked", "is_optional": false, "type": "string" } }, "type": "ChatInviteLinkInfo" }, "checkChatUsername": { "description": "Checks whether a username can be set for a chat", "args": { "chat_id": { "description": "Chat identifier; must be identifier of a supergroup chat, or a channel chat, or a private chat with self, or 0 if the chat is being created", "is_optional": false, "type": "int53" }, "username": { "description": "Username to be checked", "is_optional": false, "type": "string" } }, "type": "CheckChatUsernameResult" }, "checkCreatedPublicChatsLimit": { "description": "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", "args": { "type": { "description": "Type of the public chats, for which to check the limit", "is_optional": false, "type": "PublicChatType" } }, "type": "Ok" }, "checkEmailAddressVerificationCode": { "description": "Checks the email address verification code for Telegram Passport", "args": { "code": { "description": "Verification code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkLoginEmailAddressCode": { "description": "Checks the login email address authentication", "args": { "code": { "description": "Email address authentication to check", "is_optional": false, "type": "EmailAddressAuthentication" } }, "type": "Ok" }, "checkOauthRequestMatchCode": { "description": "Checks a match-code for an OAuth authorization request. If fails, then the authorization request has failed. Otherwise,", "args": { "match_code": { "description": "The matching code chosen by the user", "is_optional": false, "type": "string" }, "url": { "description": "URL of the OAuth deep link", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkPasswordRecoveryCode": { "description": "Checks whether a 2-step verification password recovery code sent to an email address is valid", "args": { "recovery_code": { "description": "Recovery code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkPhoneNumberCode": { "description": "Checks the authentication code and completes the request for which the code was sent if appropriate", "args": { "code": { "description": "Authentication code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkPremiumGiftCode": { "description": "Returns information about a Telegram Premium gift code", "args": { "code": { "description": "The code to check", "is_optional": false, "type": "string" } }, "type": "PremiumGiftCodeInfo" }, "checkQuickReplyShortcutName": { "description": "Checks validness of a name for a quick reply shortcut. Can be called synchronously", "args": { "name": { "description": "The name of the shortcut; 1-32 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "checkRecoveryEmailAddressCode": { "description": "Checks the 2-step verification recovery email address verification code", "args": { "code": { "description": "Verification code to check", "is_optional": false, "type": "string" } }, "type": "PasswordState" }, "checkStickerSetName": { "description": "Checks whether a name can be used for a new sticker set", "args": { "name": { "description": "Name to be checked", "is_optional": false, "type": "string" } }, "type": "CheckStickerSetNameResult" }, "checkWalletBotBalance": { "description": "Returns information about balance of the current user in the bot https://t.me/walt; can be used only if getOption(\"can_use_ton_wallet\")", "args": {}, "type": "WalletBotBalance" }, "checkWebAppFileDownload": { "description": "Checks whether a file can be downloaded and saved locally by Web App request", "args": { "bot_user_id": { "description": "Identifier of the bot, providing the Web App", "is_optional": false, "type": "int53" }, "file_name": { "description": "Name of the file", "is_optional": false, "type": "string" }, "url": { "description": "URL of the file", "is_optional": false, "type": "string" } }, "type": "Ok" }, "claimTonConnectRequest": { "description": "Claims a request received through TON Connect for processing on this device", "args": { "dapp_request_id": { "description": "Identifier of the request assigned by the dApp", "is_optional": false, "type": "string" }, "is_rejected": { "description": "Pass true to reject the request", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message with the request", "is_optional": false, "type": "int53" }, "session_id": { "description": "Unique identifier of the TON Connect session", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "cleanFileName": { "description": "Removes potentially dangerous characters from the name of a file. Returns an empty string on failure. Can be called synchronously", "args": { "file_name": { "description": "File name or path to the file", "is_optional": false, "type": "string" } }, "type": "Text" }, "clearAllDraftMessages": { "description": "Clears message drafts in all chats", "args": { "exclude_secret_chats": { "description": "Pass true to keep local message drafts in secret chats", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "clearAutosaveSettingsExceptions": { "description": "Clears the list of all autosave settings exceptions. The method is guaranteed to work only after at least one call to getAutosaveSettings", "args": {}, "type": "Ok" }, "clearImportedContacts": { "description": "Clears all imported contacts, contact list remains unchanged", "args": {}, "type": "Ok" }, "clearRecentEmojiStatuses": { "description": "Clears the list of recently used emoji statuses for self status", "args": {}, "type": "Ok" }, "clearRecentReactions": { "description": "Clears the list of recently used reactions", "args": {}, "type": "Ok" }, "clearRecentStickers": { "description": "Clears the list of recently used stickers", "args": { "is_attached": { "description": "Pass true to clear the list of stickers recently attached to photo or video files; pass false to clear the list of recently sent stickers", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "clearRecentlyFoundChats": { "description": "Clears the list of recently found chats", "args": {}, "type": "Ok" }, "clearSearchedForTags": { "description": "Clears the list of recently searched for hashtags or cashtags", "args": { "clear_cashtags": { "description": "Pass true to clear the list of recently searched for cashtags; otherwise, the list of recently searched for hashtags will be cleared", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "clickAnimatedEmojiMessage": { "description": "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", "args": { "chat_id": { "description": "Chat identifier of the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the clicked message", "is_optional": false, "type": "int53" } }, "type": "Sticker" }, "clickChatSponsoredMessage": { "description": "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", "args": { "chat_id": { "description": "Chat identifier of the sponsored message", "is_optional": false, "type": "int53" }, "from_fullscreen": { "description": "Pass true if the user expanded the video from the sponsored message fullscreen before the click", "is_optional": false, "type": "Bool" }, "is_media_click": { "description": "Pass true if the media was clicked in the sponsored message", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the sponsored message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "clickPremiumSubscriptionButton": { "description": "Informs TDLib that the user clicked Premium subscription button on the Premium features screen", "args": {}, "type": "Ok" }, "clickVideoMessageAdvertisement": { "description": "Informs TDLib that the user clicked a video message advertisement", "args": { "advertisement_unique_id": { "description": "Unique identifier of the advertisement", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "close": { "description": "Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent. Can be called before initialization", "args": {}, "type": "Ok" }, "closeChat": { "description": "Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "closeGiftAuction": { "description": "Informs TDLib that a gift auction was closed by the user", "args": { "gift_id": { "description": "Identifier of the gift, which auction was closed", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "closeSecretChat": { "description": "Closes a secret chat, effectively transferring its state to secretChatStateClosed", "args": { "secret_chat_id": { "description": "Secret chat identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "closeStory": { "description": "Informs TDLib that a story is closed by the user", "args": { "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story to close", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "closeWebApp": { "description": "Informs TDLib that a previously opened Web App was closed", "args": { "web_app_launch_id": { "description": "Identifier of Web App launch, received from openWebApp", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "commitPendingLiveStoryReactions": { "description": "Applies all pending paid reactions in a live story group call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "commitPendingPaidMessageReactions": { "description": "Applies all pending paid reactions on a message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "composeRichMessageWithAi": { "description": "Changes a rich message using an AI model. May return an error with a message \"AICOMPOSE_FLOOD_PREMIUM\" if Telegram Premium is required to send further requests", "args": { "add_emojis": { "description": "Pass true to add emoji to the text", "is_optional": false, "type": "Bool" }, "custom_prompt": { "description": "Custom prompt that will be used instead of style_name; 0-getOption(\"text_composition_style_prompt_length_max\") characters", "is_optional": false, "type": "string" }, "message": { "description": "The original message", "is_optional": false, "type": "inputRichMessage" }, "style_name": { "description": "Name of the style of the resulted text; handle updateTextCompositionStyles to get the list of supported styles; pass an empty string to keep the current style of the text or if a custom prompt is used", "is_optional": false, "type": "string" }, "translate_to_language_code": { "description": "Pass a language code to which the text will be translated; pass an empty string if translation isn't needed. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" } }, "type": "RichMessage" }, "composeTextWithAi": { "description": "Changes text using an AI model; must not be used in secret chats. May return an error with a message \"AICOMPOSE_FLOOD_PREMIUM\" if Telegram Premium is required to send further requests", "args": { "add_emojis": { "description": "Pass true to add emoji to the text", "is_optional": false, "type": "Bool" }, "style_name": { "description": "Name of the style of the resulted text; handle updateTextCompositionStyles to get the list of supported styles; pass an empty string to keep the current style of the text", "is_optional": false, "type": "string" }, "text": { "description": "The original text", "is_optional": false, "type": "formattedText" }, "translate_to_language_code": { "description": "Pass a language code to which the text will be translated; pass an empty string if translation isn't needed. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "confirmBusinessConnectedBot": { "description": "Confirms an unconfirmed business connection of the current user from another device", "args": { "bot_user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "confirmQrCodeAuthentication": { "description": "Confirms QR code authentication on another device. Returns created session on success", "args": { "link": { "description": "A link from a QR code. The link must be scanned by the in-app camera", "is_optional": false, "type": "string" } }, "type": "Session" }, "confirmSession": { "description": "Confirms an unconfirmed session of the current user from another device", "args": { "session_id": { "description": "Session identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "connectAffiliateProgram": { "description": "Connects an affiliate program to the given affiliate. Returns information about the connected affiliate program", "args": { "affiliate": { "description": "The affiliate to which the affiliate program will be connected", "is_optional": false, "type": "AffiliateType" }, "bot_user_id": { "description": "Identifier of the bot, which affiliate program is connected", "is_optional": false, "type": "int53" } }, "type": "ConnectedAffiliateProgram" }, "craftGift": { "description": "Crafts a new gift from other gifts that will be permanently lost", "args": { "received_gift_ids": { "description": "Identifier of the gifts to use for crafting. In the case of a successful craft, the resulting gift will have the number of the first gift.", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "CraftGiftResult" }, "createBasicGroupChat": { "description": "Returns an existing chat corresponding to a known basic group", "args": { "basic_group_id": { "description": "Basic group identifier", "is_optional": false, "type": "int53" }, "force": { "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect", "is_optional": false, "type": "Bool" } }, "type": "Chat" }, "createBot": { "description": "Creates a bot which will be managed by another bot. Returns the created bot. May return an error with a message \"BOT_CREATE_LIMIT_EXCEEDED\"", "args": { "manager_bot_user_id": { "description": "Identifier of the bot that will manage the created bot", "is_optional": false, "type": "int53" }, "name": { "description": "Name of the bot; 1-64 characters", "is_optional": false, "type": "string" }, "username": { "description": "Username of the bot. The username must end with \"bot\" or a string from updateAllowedBotUsernamePremiumSuffixes case-insensitive.", "is_optional": false, "type": "string" }, "via_link": { "description": "Pass true if the bot is created from an internalLinkTypeRequestManagedBot link", "is_optional": false, "type": "Bool" } }, "type": "User" }, "createBusinessChatLink": { "description": "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", "args": { "link_info": { "description": "Information about the link to create", "is_optional": false, "type": "inputBusinessChatLink" } }, "type": "BusinessChatLink" }, "createCall": { "description": "Creates a new call", "args": { "is_video": { "description": "Pass true to create a video call", "is_optional": false, "type": "Bool" }, "protocol": { "description": "The call protocols supported by the application", "is_optional": false, "type": "callProtocol" }, "user_id": { "description": "Identifier of the user to be called", "is_optional": false, "type": "int53" } }, "type": "CallId" }, "createChatFolder": { "description": "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", "args": { "folder": { "description": "The new chat folder", "is_optional": false, "type": "chatFolder" } }, "type": "ChatFolderInfo" }, "createChatFolderInviteLink": { "description": "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", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" }, "chat_ids": { "description": "Identifiers of chats to be accessible by the invite link. Use getChatsForChatFolderInviteLink to get suitable chats. Basic groups will be automatically converted to supergroups before link creation", "is_optional": false, "type": "vector\u003cint53\u003e" }, "name": { "description": "Name of the link; 0-32 characters", "is_optional": false, "type": "string" } }, "type": "ChatFolderInviteLink" }, "createChatInviteLink": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "creates_join_request": { "description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0", "is_optional": false, "type": "Bool" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never", "is_optional": false, "type": "int32" }, "member_limit": { "description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited", "is_optional": false, "type": "int32" }, "name": { "description": "Invite link name; 0-32 characters", "is_optional": false, "type": "string" } }, "type": "ChatInviteLink" }, "createChatSubscriptionInviteLink": { "description": "Creates a new subscription invite link for a channel chat. Requires can_invite_users right in the chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "name": { "description": "Invite link name; 0-32 characters", "is_optional": false, "type": "string" }, "subscription_pricing": { "description": "Information about subscription plan that will be applied to the users joining the chat via the link.", "is_optional": false, "type": "starSubscriptionPricing" } }, "type": "ChatInviteLink" }, "createCommunity": { "description": "Creates a new community for the given chat. Returns identifier of the created community", "args": { "chat_id": { "description": "Identifier of the chat in the community; only chats with owned bots and owned basic group, supergroup and channel chats are allowed;", "is_optional": false, "type": "int53" }, "is_chat_hidden": { "description": "Pass true if the chat will be visible only to administrators of the community", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the new community", "is_optional": false, "type": "string" } }, "type": "CommunityId" }, "createForumTopic": { "description": "Creates a topic in a forum supergroup chat or a chat with a bot with topics; requires can_manage_topics administrator or can_create_topics member right in the supergroup", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "icon": { "description": "Icon of the topic. Icon color must be one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F. Telegram Premium users can use any custom emoji as topic icon, other users can use only a custom emoji returned by getForumTopicDefaultIcons", "is_optional": false, "type": "forumTopicIcon" }, "is_name_implicit": { "description": "Pass true if the name of the topic wasn't entered explicitly; for chats with bots only", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the topic; 1-128 characters", "is_optional": false, "type": "string" } }, "type": "ForumTopicInfo" }, "createGiftCollection": { "description": "Creates a collection from gifts on the current user's or a channel's profile page; requires can_post_messages administrator right in the channel chat.", "args": { "name": { "description": "Name of the collection; 1-12 characters", "is_optional": false, "type": "string" }, "owner_id": { "description": "Identifier of the user or the channel chat that received the gifts", "is_optional": false, "type": "MessageSender" }, "received_gift_ids": { "description": "Identifier of the gifts to add to the collection; 0-getOption(\"gift_collection_size_max\") identifiers", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "GiftCollection" }, "createGroupCall": { "description": "Creates a new group call that isn't bound to a chat", "args": { "join_parameters": { "description": "Parameters to join the call; pass null to only create call link without joining the call", "is_optional": true, "type": "groupCallJoinParameters" } }, "type": "GroupCallInfo" }, "createInvoiceLink": { "description": "Creates a link for the given invoice; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request", "is_optional": false, "type": "string" }, "invoice": { "description": "Information about the invoice of the type inputMessageInvoice", "is_optional": false, "type": "InputMessageContent" } }, "type": "HttpUrl" }, "createNewBasicGroupChat": { "description": "Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns information about the newly created chat", "args": { "message_auto_delete_time": { "description": "Message auto-delete time value, in seconds; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the new basic group; 1-128 characters", "is_optional": false, "type": "string" }, "user_ids": { "description": "Identifiers of users to be added to the basic group; may be empty to create a basic group without other members", "is_optional": true, "type": "vector\u003cint53\u003e" } }, "type": "CreatedBasicGroupChat" }, "createNewSecretChat": { "description": "Creates a new secret chat. Returns the newly created chat", "args": { "user_id": { "description": "Identifier of the target user", "is_optional": false, "type": "int53" } }, "type": "Chat" }, "createNewStickerSet": { "description": "Creates a new sticker set. Returns the newly created sticker set", "args": { "name": { "description": "Sticker set name. Can contain only English letters, digits and underscores. Must end with *\"_by_\u003cbot username\u003e\"* (*\u003cbot_username\u003e* is case insensitive) for bots; 0-64 characters.", "is_optional": false, "type": "string" }, "needs_repainting": { "description": "Pass true if stickers in the sticker set must be repainted; for custom emoji sticker sets only", "is_optional": false, "type": "Bool" }, "source": { "description": "Source of the sticker set; may be empty if unknown", "is_optional": true, "type": "string" }, "sticker_type": { "description": "Type of the stickers in the set", "is_optional": false, "type": "StickerType" }, "stickers": { "description": "List of stickers to be added to the set; 1-200 stickers for custom emoji sticker sets, and 1-120 stickers otherwise. For TGS stickers, uploadStickerFile must be used before the sticker is shown", "is_optional": false, "type": "vector\u003cnewSticker\u003e" }, "title": { "description": "Sticker set title; 1-64 characters", "is_optional": false, "type": "string" }, "user_id": { "description": "Sticker set owner; ignored for regular users", "is_optional": false, "type": "int53" } }, "type": "StickerSet" }, "createNewSupergroupChat": { "description": "Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat", "args": { "description": { "description": "Chat description; 0-255 characters", "is_optional": false, "type": "string" }, "for_import": { "description": "Pass true to create a supergroup for importing messages using importMessages", "is_optional": false, "type": "Bool" }, "is_channel": { "description": "Pass true to create a channel chat; ignored if a forum is created", "is_optional": false, "type": "Bool" }, "is_forum": { "description": "Pass true to create a forum supergroup chat", "is_optional": false, "type": "Bool" }, "location": { "description": "Chat location if a location-based supergroup is being created; pass null to create an ordinary supergroup chat", "is_optional": true, "type": "chatLocation" }, "message_auto_delete_time": { "description": "Message auto-delete time value, in seconds; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically", "is_optional": false, "type": "int32" }, "title": { "description": "Title of the new chat; 1-128 characters", "is_optional": false, "type": "string" } }, "type": "Chat" }, "createOnRampPaymentSession": { "description": "Creates a session for an on-ramp payment", "args": { "address": { "description": "Address to which the cryptocurrency will be sent", "is_optional": false, "type": "string" }, "base_currency": { "description": "ISO 4217 currency code of the currency that will be used for the purchase; pass an empty string if unknown", "is_optional": false, "type": "string" }, "base_currency_amount": { "description": "The amount of the base currency to spend; pass an empty string if the user selected cryptocurrency_amount", "is_optional": false, "type": "string" }, "cryptocurrency": { "description": "The cryptocurrency that will be bought", "is_optional": false, "type": "string" }, "cryptocurrency_amount": { "description": "The amount of the cryptocurrency to buy; pass an empty string if the user selected base_currency_amount", "is_optional": false, "type": "string" }, "fail_return_url": { "description": "The URL opened on failed payment; pass an empty string if none", "is_optional": false, "type": "string" }, "memo": { "description": "Memo for the query; pass an empty string if none", "is_optional": false, "type": "string" }, "payment_method_name": { "description": "Name of the chosen payment method; pass an empty string if none", "is_optional": false, "type": "string" }, "provider_id": { "description": "Unique identifier of the on-ramp provider", "is_optional": false, "type": "string" }, "success_return_url": { "description": "The URL opened on successful payment; pass an empty string if none", "is_optional": false, "type": "string" }, "theme": { "description": "Preferred theme for the WebView; pass \"light\" for a light theme, \"dark\" for a dark theme, or leave empty for a default theme", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentSession" }, "createPrivateChat": { "description": "Returns an existing chat corresponding to a given user", "args": { "force": { "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect", "is_optional": false, "type": "Bool" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Chat" }, "createRichMessageWithAi": { "description": "Creates a new rich message using an AI model. May return an error with a message \"AICOMPOSE_FLOOD_PREMIUM\" if Telegram Premium is required to send further requests", "args": { "add_emojis": { "description": "Pass true to add emoji to the text", "is_optional": false, "type": "Bool" }, "language_code": { "description": "Pass a language code in which the text will be created", "is_optional": false, "type": "string" }, "prompt": { "description": "Prompt that will be used to create the message; 0-getOption(\"text_composition_style_prompt_length_max\") characters", "is_optional": false, "type": "string" } }, "type": "RichMessage" }, "createSecretChat": { "description": "Returns an existing chat corresponding to a known secret chat", "args": { "secret_chat_id": { "description": "Secret chat identifier", "is_optional": false, "type": "int32" } }, "type": "Chat" }, "createStoryAlbum": { "description": "Creates an album of stories; requires can_edit_stories administrator right for supergroup and channel chats", "args": { "name": { "description": "Name of the album; 1-12 characters", "is_optional": false, "type": "string" }, "story_ids": { "description": "Identifiers of stories to add to the album; 0-getOption(\"story_album_size_max\") identifiers", "is_optional": false, "type": "vector\u003cint32\u003e" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the stories", "is_optional": false, "type": "int53" } }, "type": "StoryAlbum" }, "createSupergroupChat": { "description": "Returns an existing chat corresponding to a known supergroup or channel", "args": { "force": { "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Supergroup or channel identifier", "is_optional": false, "type": "int53" } }, "type": "Chat" }, "createTemporaryPassword": { "description": "Creates a new temporary password for processing payments", "args": { "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" }, "valid_for": { "description": "Time during which the temporary password will be valid, in seconds; must be between 60 and 86400", "is_optional": false, "type": "int32" } }, "type": "TemporaryPasswordState" }, "createTextCompositionStyle": { "description": "Creates a custom text composition style. May return an error with a message \"TONES_SAVED_TOO_MANY\" if the maximum number of added custom styles has been reached", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji corresponding to the style", "is_optional": false, "type": "int64" }, "prompt": { "description": "Prompt that will be used for text composition; 1-getOption(\"text_composition_style_prompt_length_max\") characters", "is_optional": false, "type": "string" }, "show_creator": { "description": "Pass true if the current user must be shown as the creator of the style", "is_optional": false, "type": "Bool" }, "title": { "description": "Title of the style; 1-getOption(\"text_composition_style_title_length_max\") characters", "is_optional": false, "type": "string" } }, "type": "TextCompositionStyle" }, "createTonConnectSession": { "description": "Creates a TON Connect session; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "dapp_client_id": { "description": "Hex-encoded public X25519 key of the dApp", "is_optional": false, "type": "string" }, "manifest_url": { "description": "URL of the manifest of the dApp", "is_optional": false, "type": "string" } }, "type": "TonConnectSession" }, "createUserTonWallet": { "description": "Creates a TON wallet for the specified regular user; can be used only if getOption(\"can_use_ton_wallet\"). The current user must have positive TON wallet balance", "args": { "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "UserTonWalletAddress" }, "createVideoChat": { "description": "Creates a video chat (a group call bound to a chat); for basic groups, supergroups and channels only; requires can_manage_video_chats administrator right", "args": { "chat_id": { "description": "Identifier of a chat in which the video chat will be created", "is_optional": false, "type": "int53" }, "is_rtmp_stream": { "description": "Pass true to create an RTMP stream instead of an ordinary video chat", "is_optional": false, "type": "Bool" }, "start_date": { "description": "Point in time (Unix timestamp) when the group call is expected to be started by an administrator; 0 to start the video chat immediately. The date must be at least 10 seconds and at most 8 days in the future", "is_optional": false, "type": "int32" }, "title": { "description": "Group call title; if empty, chat title will be used", "is_optional": false, "type": "string" } }, "type": "GroupCallId" }, "declineGroupCallInvitation": { "description": "Declines an invitation to an active group call via messageGroupCall. Can be called both by the sender and the receiver of the invitation", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message of the type messageGroupCall", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "declineOauthRequest": { "description": "Declines an OAuth authorization request", "args": { "url": { "description": "URL of the OAuth deep link", "is_optional": false, "type": "string" } }, "type": "Ok" }, "declineSuggestedPost": { "description": "Declines a suggested post in a channel direct messages chat", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "comment": { "description": "Comment for the creator of the suggested post; 0-128 characters", "is_optional": false, "type": "string" }, "message_id": { "description": "Identifier of the message with the suggested post. Use messageProperties.can_be_declined to check whether the suggested post can be declined", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "decryptGroupCallData": { "description": "Decrypts group call data received by tgcalls", "args": { "data": { "description": "Data to decrypt", "is_optional": false, "type": "bytes" }, "data_channel": { "description": "Data channel for which data was encrypted; pass null if unknown", "is_optional": true, "type": "GroupCallDataChannel" }, "group_call_id": { "description": "Group call identifier. The call must not be a video chat", "is_optional": false, "type": "int32" }, "participant_id": { "description": "Identifier of the group call participant, which sent the data", "is_optional": false, "type": "MessageSender" } }, "type": "Data" }, "deleteAccount": { "description": "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.", "args": { "password": { "description": "The 2-step verification password of the current user. If the current user isn't authorized, then an empty string can be passed and account deletion can be canceled within one week", "is_optional": false, "type": "string" }, "reason": { "description": "The reason why the account was deleted; optional", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteAllCallMessages": { "description": "Deletes all call messages", "args": { "revoke": { "description": "Pass true to delete the messages for all users", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteAllChatWelcomeMessages": { "description": "Deletes all welcome messages of a chat; requires can_send_welcome_messages administrator right in the chat", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteAllRecentMessageReactionsFromSender": { "description": "Deletes all recent reactions added by the specified sender in a chat. Supported only for basic groups and supergroups; requires can_delete_messages administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of reactions to delete", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "deleteAllRevokedChatInviteLinks": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "creator_user_id": { "description": "User identifier of a chat administrator, which links will be deleted. Must be an identifier of the current user for non-owner", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteBotMediaPreviews": { "description": "Deletes media previews from the list of media previews of a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must be owned and must have the main Web App", "is_optional": false, "type": "int53" }, "file_ids": { "description": "File identifiers of the media to delete", "is_optional": false, "type": "vector\u003cint32\u003e" }, "language_code": { "description": "Language code of the media previews to delete", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteBotSecondaryUsername": { "description": "Removes a secondary username from a bot. Can be called only if userTypeBot.can_be_edited == true and the bot has a secondary username", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteBusinessChatLink": { "description": "Deletes a business chat link of the current account", "args": { "link": { "description": "The link to delete", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteBusinessConnectedBot": { "description": "Deletes the business bot that is connected to the current user account", "args": { "bot_user_id": { "description": "Unique user identifier for the bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteBusinessMessages": { "description": "Deletes messages on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection through which the messages were received", "is_optional": false, "type": "string" }, "message_ids": { "description": "Identifier of the messages", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "deleteBusinessStory": { "description": "Deletes a story posted by the bot on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "story_id": { "description": "Identifier of the story to delete", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteChat": { "description": "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.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteChatBackground": { "description": "Deletes background in a specific chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "restore_previous": { "description": "Pass true to restore previously set background. Can be used only in private and secret chats with non-deleted users if userFullInfo.set_chat_background == true.", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteChatFolder": { "description": "Deletes existing chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" }, "leave_chat_ids": { "description": "Identifiers of the chats to leave. The chats must be pinned or always included in the folder", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "deleteChatFolderInviteLink": { "description": "Deletes an invite link for a chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" }, "invite_link": { "description": "Invite link to be deleted", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteChatHistory": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "remove_from_chat_list": { "description": "Pass true to remove the chat from all chat lists", "is_optional": false, "type": "Bool" }, "revoke": { "description": "Pass true to delete chat history for all users", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteChatMessagesByDate": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "max_date": { "description": "The maximum date of the messages to delete", "is_optional": false, "type": "int32" }, "min_date": { "description": "The minimum date of the messages to delete", "is_optional": false, "type": "int32" }, "revoke": { "description": "Pass true to delete chat messages for all users; private chats only", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteChatMessagesBySender": { "description": "Deletes all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of messages to delete", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "deleteChatReplyMarkup": { "description": "Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a replyMarkupForceReply reply markup has been used or dismissed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "The message identifier of the used keyboard", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteChatWelcomeMessage": { "description": "Deletes a welcome message of a chat; requires can_send_welcome_messages administrator right in the chat", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" }, "welcome_message_id": { "description": "The identifier of the welcome message", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteCommands": { "description": "Deletes commands supported by the bot for the given user scope and language; for bots only", "args": { "language_code": { "description": "A two-letter ISO 639-1 language code or an empty string", "is_optional": false, "type": "string" }, "scope": { "description": "The scope to which the commands are relevant; pass null to delete commands in the default bot command scope", "is_optional": true, "type": "BotCommandScope" } }, "type": "Ok" }, "deleteCommunity": { "description": "Deletes a community; requires owner privileges", "args": { "community_id": { "description": "Identifier of the community", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteDefaultBackground": { "description": "Deletes default background for chats", "args": { "for_dark_theme": { "description": "Pass true if the background is deleted for a dark theme", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteDirectMessagesChatTopicHistory": { "description": "Deletes all messages in the topic in a channel direct messages chat administered by the current user", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Identifier of the topic which messages will be deleted", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteDirectMessagesChatTopicMessagesByDate": { "description": "Deletes all messages between the specified dates in the topic in a channel direct messages chat administered by the current user. Messages sent in the last 30 seconds will not be deleted", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "max_date": { "description": "The maximum date of the messages to delete", "is_optional": false, "type": "int32" }, "min_date": { "description": "The minimum date of the messages to delete", "is_optional": false, "type": "int32" }, "topic_id": { "description": "Identifier of the topic which messages will be deleted", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteEphemeralMessage": { "description": "Deletes an ephemeral message; for bots only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "ephemeral_message_id": { "description": "Identifier of the message to be deleted", "is_optional": false, "type": "int32" }, "receiver_user_id": { "description": "Identifier of the user who received the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteFile": { "description": "Deletes a file from the TDLib file cache", "args": { "file_id": { "description": "Identifier of the file to delete", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteForumTopic": { "description": "Deletes all messages from a topic in a forum supergroup chat or a chat with a bot with topics; requires can_delete_messages administrator right in the supergroup", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteGiftCollection": { "description": "Deletes a gift collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat", "args": { "collection_id": { "description": "Identifier of the gift collection", "is_optional": false, "type": "int32" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "deleteGroupCallMessages": { "description": "Deletes messages in a group call; for live story calls only. Requires groupCallMessage.can_be_deleted right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "message_ids": { "description": "Identifiers of the messages to be deleted", "is_optional": false, "type": "vector\u003cint32\u003e" }, "report_spam": { "description": "Pass true to report the messages as spam", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deleteGroupCallMessagesBySender": { "description": "Deletes all messages sent by the specified message sender in a group call; for live story calls only. Requires groupCall.can_delete_messages right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "report_spam": { "description": "Pass true to report the messages as spam", "is_optional": false, "type": "Bool" }, "sender_id": { "description": "Identifier of the sender of messages to delete", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "deleteLanguagePack": { "description": "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.", "args": { "language_pack_id": { "description": "Identifier of the language pack to delete", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteMessageEphemeralContent": { "description": "Removes message ephemeral content and reverts message state to the original", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteMessageReactionsFromSender": { "description": "Deletes all reactions added by the specified sender on a message", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the reactions. Use messageProperties.can_delete_reactions to check whether the method can be used for a message", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender of reactions to delete", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "deleteMessages": { "description": "Deletes messages", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_ids": { "description": "Identifiers of the messages to be deleted. Use messageProperties.can_be_deleted_only_for_self and messageProperties.can_be_deleted_for_all_users to get suitable messages", "is_optional": false, "type": "vector\u003cint53\u003e" }, "revoke": { "description": "Pass true to delete messages for all chat members. Always true for supergroups, channels and secret chats", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "deletePassportElement": { "description": "Deletes a Telegram Passport element", "args": { "type": { "description": "Element type", "is_optional": false, "type": "PassportElementType" } }, "type": "Ok" }, "deletePollOption": { "description": "Deletes an option from a poll", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the poll", "is_optional": false, "type": "int53" }, "option_id": { "description": "Unique identifier of the option. Use pollOptionProperties.can_be_deleted to check whether the option can be deleted by the user", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteProfilePhoto": { "description": "Deletes a profile photo", "args": { "profile_photo_id": { "description": "Identifier of the profile photo to delete", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "deleteQuickReplyShortcut": { "description": "Deletes a quick reply shortcut", "args": { "shortcut_id": { "description": "Unique identifier of the quick reply shortcut", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteQuickReplyShortcutMessages": { "description": "Deletes specified quick reply messages", "args": { "message_ids": { "description": "Unique identifiers of the messages", "is_optional": false, "type": "vector\u003cint53\u003e" }, "shortcut_id": { "description": "Unique identifier of the quick reply shortcut to which the messages belong", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteRevokedChatInviteLink": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link to revoke", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteSavedCredentials": { "description": "Deletes saved credentials for all payment provider bots", "args": {}, "type": "Ok" }, "deleteSavedMessagesTopicHistory": { "description": "Deletes all messages in a Saved Messages topic", "args": { "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which messages will be deleted", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteSavedMessagesTopicMessagesByDate": { "description": "Deletes all messages between the specified dates in a Saved Messages topic. Messages sent in the last 30 seconds will not be deleted", "args": { "max_date": { "description": "The maximum date of the messages to delete", "is_optional": false, "type": "int32" }, "min_date": { "description": "The minimum date of the messages to delete", "is_optional": false, "type": "int32" }, "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which messages will be deleted", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteSavedOrderInfo": { "description": "Deletes saved order information", "args": {}, "type": "Ok" }, "deleteStickerSet": { "description": "Completely deletes a sticker set", "args": { "name": { "description": "Sticker set name. The sticker set must be owned by the current user", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteStory": { "description": "Deletes a previously posted story. Can be called only if story.can_be_deleted == true", "args": { "story_id": { "description": "Identifier of the story to delete", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "deleteStoryAlbum": { "description": "Deletes a story album. If the album is owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "story_album_id": { "description": "Identifier of the story album", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "deleteTextCompositionStyle": { "description": "Deletes a custom text composition style that was created by the current user", "args": { "name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "Ok" }, "deleteTonWallet": { "description": "Deletes the current TON wallet of the user and creates a new one; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "password": { "description": "Password of the current user; pass an empty string unless receive an error with a message \"PASSWORD_MISSING\" for a passwordless request", "is_optional": false, "type": "string" } }, "type": "Ok" }, "destroy": { "description": "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.", "args": {}, "type": "Ok" }, "disableAllSupergroupUsernames": { "description": "Disables all active non-editable usernames of a supergroup or channel, requires owner privileges in the supergroup or channel", "args": { "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "disableProxy": { "description": "Disables the currently enabled proxy. Can be called before authorization", "args": {}, "type": "Ok" }, "disableTonWalletBackup": { "description": "Disables backup of the TON wallet of the user. Works only if tonWalletState.is_backup_enabled is true", "args": { "password": { "description": "Password of the current user; pass an empty string unless receive an error with a message \"PASSWORD_MISSING\" for a passwordless request", "is_optional": false, "type": "string" } }, "type": "Ok" }, "disableTonWalletBackupWithProof": { "description": "Disables backup of the TON wallet of the user using proof of wallet ownership instead of the password. Works only if tonWalletState.is_backup_enabled is true", "args": { "proof": { "description": "Proof of the TON wallet ownership; use getTonWalletOwnershipProofChallenge to get a challenge for the proof", "is_optional": false, "type": "tonWalletOwnershipProof" } }, "type": "Ok" }, "discardCall": { "description": "Discards a call", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "int32" }, "connection_id": { "description": "Identifier of the connection used during the call", "is_optional": false, "type": "int64" }, "duration": { "description": "The call duration, in seconds", "is_optional": false, "type": "int32" }, "invite_link": { "description": "If the call was upgraded to a group call, pass invite link to the group call", "is_optional": false, "type": "string" }, "is_disconnected": { "description": "Pass true if the user was disconnected", "is_optional": false, "type": "Bool" }, "is_video": { "description": "Pass true if the call was a video call", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "disconnectAffiliateProgram": { "description": "Disconnects an affiliate program from the given affiliate and immediately deactivates its referral link. Returns updated information about the disconnected affiliate program", "args": { "affiliate": { "description": "The affiliate to which the affiliate program is connected", "is_optional": false, "type": "AffiliateType" }, "url": { "description": "The referral link of the affiliate program", "is_optional": false, "type": "string" } }, "type": "ConnectedAffiliateProgram" }, "disconnectAllWebsites": { "description": "Disconnects all websites from the current user's Telegram account", "args": {}, "type": "Ok" }, "disconnectTonConnectSession": { "description": "Closes a TON Connect session", "args": { "body": { "description": "Encrypted body of the disconnect event; may be empty if the session has already been closed. Use getTonConnectSessionNextEventId to get event identifier for the event", "is_optional": true, "type": "bytes" }, "session_id": { "description": "Unique identifier of the TON Connect session to close", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "disconnectWebsite": { "description": "Disconnects website from the current user's Telegram account", "args": { "website_id": { "description": "Website identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "dismissWebToken": { "description": "Dismissess a received web token without consumption; for official Telegram apps only", "args": { "token": { "description": "The token to dismiss", "is_optional": false, "type": "string" } }, "type": "Ok" }, "downloadFile": { "description": "Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates", "args": { "file_id": { "description": "Identifier of the file to download", "is_optional": false, "type": "int32" }, "limit": { "description": "Number of bytes which need to be downloaded starting from the \"offset\" position before the download will automatically be canceled; use 0 to download without a limit", "is_optional": false, "type": "int53" }, "offset": { "description": "The starting position from which the file needs to be downloaded", "is_optional": false, "type": "int53" }, "priority": { "description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first", "is_optional": false, "type": "int32" }, "synchronous": { "description": "Pass true to return response only after the file download has succeeded, has failed, has been canceled, or a new downloadFile request with different offset/limit parameters was sent; pass false to return file state immediately, just after the download has been started", "is_optional": false, "type": "Bool" } }, "type": "File" }, "dropGiftOriginalDetails": { "description": "Drops original details for an upgraded gift", "args": { "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" }, "star_count": { "description": "The Telegram Star amount required to pay for the operation", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "editBotMediaPreview": { "description": "Replaces media preview in the list of media previews of a bot. Returns the new preview after edit is completed server-side", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must be owned and must have the main Web App", "is_optional": false, "type": "int53" }, "content": { "description": "Content of the new preview", "is_optional": false, "type": "InputStoryContent" }, "file_id": { "description": "File identifier of the media to replace", "is_optional": false, "type": "int32" }, "language_code": { "description": "Language code of the media preview to edit", "is_optional": false, "type": "string" } }, "type": "BotMediaPreview" }, "editBusinessChatLink": { "description": "Edits a business chat link of the current account. Requires Telegram Business subscription. Returns the edited link", "args": { "link": { "description": "The link to edit", "is_optional": false, "type": "string" }, "link_info": { "description": "New description of the link", "is_optional": false, "type": "inputBusinessChatLink" } }, "type": "BusinessChatLink" }, "editBusinessMessageCaption": { "description": "Edits the caption of a message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "caption": { "description": "New message content caption; pass null to remove caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" }, "show_caption_above_media": { "description": "Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages", "is_optional": false, "type": "Bool" } }, "type": "BusinessMessage" }, "editBusinessMessageChecklist": { "description": "Edits the content of a checklist in a message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "checklist": { "description": "The new checklist. If some tasks were completed, this information will be kept", "is_optional": false, "type": "inputChecklist" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "editBusinessMessageLiveLocation": { "description": "Edits the content of a live location in a message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "location": { "description": "New live location of the message; pass null to stop sharing the live location. If the new live_period isn't set to 0x7FFFFFFF,", "is_optional": true, "type": "liveLocation" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "editBusinessMessageMedia": { "description": "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", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo", "is_optional": false, "type": "InputMessageContent" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "editBusinessMessageReplyMarkup": { "description": "Edits the reply markup of a message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "editBusinessMessageText": { "description": "Edits the text of a text or game message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "New text content of the message. Must be of type inputMessageText or inputMessageRichMessage", "is_optional": false, "type": "InputMessageContent" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "editBusinessStory": { "description": "Changes a story posted by the bot on behalf of a business account; for bots only", "args": { "areas": { "description": "New clickable rectangle areas to be shown on the story media", "is_optional": false, "type": "inputStoryAreas" }, "caption": { "description": "New story caption", "is_optional": false, "type": "formattedText" }, "content": { "description": "New content of the story", "is_optional": false, "type": "InputStoryContent" }, "privacy_settings": { "description": "The new privacy settings for the story", "is_optional": false, "type": "StoryPrivacySettings" }, "story_id": { "description": "Identifier of the story to edit", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Story" }, "editChatFolder": { "description": "Edits existing chat folder. Returns information about the edited chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" }, "folder": { "description": "The edited chat folder", "is_optional": false, "type": "chatFolder" } }, "type": "ChatFolderInfo" }, "editChatFolderInviteLink": { "description": "Edits an invite link for a chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" }, "chat_ids": { "description": "New identifiers of chats to be accessible by the invite link. Use getChatsForChatFolderInviteLink to get suitable chats. Basic groups will be automatically converted to supergroups before link editing", "is_optional": false, "type": "vector\u003cint53\u003e" }, "invite_link": { "description": "Invite link to be edited", "is_optional": false, "type": "string" }, "name": { "description": "New name of the link; 0-32 characters", "is_optional": false, "type": "string" } }, "type": "ChatFolderInviteLink" }, "editChatInviteLink": { "description": "Edits a non-primary invite link for a chat. Available in basic groups, supergroups, and channels.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "creates_join_request": { "description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0", "is_optional": false, "type": "Bool" }, "expiration_date": { "description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never", "is_optional": false, "type": "int32" }, "invite_link": { "description": "Invite link to be edited", "is_optional": false, "type": "string" }, "member_limit": { "description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited", "is_optional": false, "type": "int32" }, "name": { "description": "Invite link name; 0-32 characters", "is_optional": false, "type": "string" } }, "type": "ChatInviteLink" }, "editChatSubscriptionInviteLink": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link to be edited", "is_optional": false, "type": "string" }, "name": { "description": "Invite link name; 0-32 characters", "is_optional": false, "type": "string" } }, "type": "ChatInviteLink" }, "editChatWelcomeMessage": { "description": "Edits a welcome message of a chat; requires can_send_welcome_messages administrator right in the chat", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageText, inputMessageAnimation,", "is_optional": false, "type": "InputMessageContent" }, "welcome_message_id": { "description": "The identifier of the welcome message", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "editCustomLanguagePackInfo": { "description": "Edits information about a custom local language pack in the current localization target. Can be called before authorization", "args": { "info": { "description": "New information about the custom local language pack", "is_optional": false, "type": "languagePackInfo" } }, "type": "Ok" }, "editEphemeralMessage": { "description": "Edits the text, media, or reply markup of an ephemeral message sent by the bot; for bots only", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "ephemeral_message_id": { "description": "Identifier of the ephemeral message", "is_optional": false, "type": "int32" }, "input_message_content": { "description": "New content of the message; pass null to edit only reply markup. Must be one of the following types: inputMessageText, inputMessageAnimation,", "is_optional": true, "type": "InputMessageContent" }, "receiver_user_id": { "description": "Identifier of the user who received the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "editEphemeralMessageCaption": { "description": "Edits the caption and reply markup of an ephemeral message sent by the bot; for bots only", "args": { "caption": { "description": "New message content caption; pass null to remove caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "ephemeral_message_id": { "description": "Identifier of the ephemeral message", "is_optional": false, "type": "int32" }, "receiver_user_id": { "description": "Identifier of the user who received the message", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" }, "show_caption_above_media": { "description": "Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "editForumTopic": { "description": "Edits title and icon of a topic in a forum supergroup chat or a chat with a bot with topics; for supergroup chats requires can_manage_topics administrator right", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "edit_icon_custom_emoji": { "description": "Pass true to edit the icon of the topic. Icon of the General topic can't be edited", "is_optional": false, "type": "Bool" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" }, "icon_custom_emoji_id": { "description": "Identifier of the new custom emoji for topic icon; pass 0 to remove the custom emoji. Ignored if edit_icon_custom_emoji is false. Telegram Premium users can use any custom emoji, other users can use only a custom emoji returned by getForumTopicDefaultIcons", "is_optional": false, "type": "int64" }, "name": { "description": "New name of the topic; 0-128 characters. If empty, the previous topic name is kept", "is_optional": false, "type": "string" } }, "type": "Ok" }, "editInlineMessageCaption": { "description": "Edits the caption of an inline message sent via a bot; for bots only", "args": { "caption": { "description": "New message content caption; pass null to remove caption; 0-getOption(\"message_caption_length_max\") characters", "is_optional": true, "type": "formattedText" }, "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" }, "show_caption_above_media": { "description": "Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "editInlineMessageLiveLocation": { "description": "Edits the content of a live location in an inline message sent via a bot; for bots only", "args": { "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "location": { "description": "New live location of the message; pass null to stop sharing the live location. If the new live_period isn't set to 0x7FFFFFFF,", "is_optional": true, "type": "liveLocation" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "editInlineMessageMedia": { "description": "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", "args": { "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "editInlineMessageReplyMarkup": { "description": "Edits the reply markup of an inline message sent via a bot; for bots only", "args": { "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "editInlineMessageText": { "description": "Edits the text of an inline text or game message sent via the bot; for bots only", "args": { "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "input_message_content": { "description": "New text content of the message. Must be of type inputMessageText or inputMessageRichMessage; file upload isn't supported", "is_optional": false, "type": "InputMessageContent" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "editMessageCaption": { "description": "Edits the message content caption. Returns the edited message after the edit is completed on the server side", "args": { "caption": { "description": "New message content caption; 0-getOption(\"message_caption_length_max\") characters; pass null to remove caption", "is_optional": true, "type": "formattedText" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" }, "show_caption_above_media": { "description": "Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages", "is_optional": false, "type": "Bool" } }, "type": "Message" }, "editMessageChecklist": { "description": "Edits the message content of a checklist. Returns the edited message after the edit is completed on the server side", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "checklist": { "description": "The new checklist. If some tasks were completed, this information will be kept", "is_optional": false, "type": "inputChecklist" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Message" }, "editMessageLiveLocation": { "description": "Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location.", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "location": { "description": "New live location of the message; pass null to stop sharing the live location. If the new live_period isn't set to 0x7FFFFFFF,", "is_optional": true, "type": "liveLocation" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Message" }, "editMessageMedia": { "description": "Edits the media content of a message, including message caption. If only the caption needs to be edited, use editMessageCaption instead.", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo", "is_optional": false, "type": "InputMessageContent" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_edit_media to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Message" }, "editMessageReplyMarkup": { "description": "Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Message" }, "editMessageSchedulingState": { "description": "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", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_edit_scheduling_state to check whether the message is suitable", "is_optional": false, "type": "int53" }, "scheduling_state": { "description": "The new message scheduling state; pass null to send the message immediately. Must be null for messages in the state messageSchedulingStateSendWhenVideoProcessed", "is_optional": true, "type": "MessageSchedulingState" } }, "type": "Ok" }, "editMessageText": { "description": "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", "args": { "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "New text content of the message. Must be of type inputMessageText or inputMessageRichMessage", "is_optional": false, "type": "InputMessageContent" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Message" }, "editProxy": { "description": "Edits an existing proxy server for network requests. Can be called before authorization", "args": { "comment": { "description": "New comment for the proxy", "is_optional": false, "type": "string" }, "enable": { "description": "Pass true to immediately enable the proxy", "is_optional": false, "type": "Bool" }, "proxy": { "description": "The new information about the proxy", "is_optional": false, "type": "proxy" }, "proxy_id": { "description": "Proxy identifier", "is_optional": false, "type": "int32" } }, "type": "AddedProxy" }, "editQuickReplyMessage": { "description": "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.", "args": { "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageChecklist, inputMessageDocument, inputMessagePhoto, inputMessageRichMessage, inputMessageText, or inputMessageVideo", "is_optional": false, "type": "InputMessageContent" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "shortcut_id": { "description": "Unique identifier of the quick reply shortcut with the message", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "editStarSubscription": { "description": "Cancels or re-enables Telegram Star subscription", "args": { "is_canceled": { "description": "New value of is_canceled", "is_optional": false, "type": "Bool" }, "subscription_id": { "description": "Identifier of the subscription to change", "is_optional": false, "type": "string" } }, "type": "Ok" }, "editStory": { "description": "Changes content and caption of a story. Can be called only if story.can_be_edited == true", "args": { "areas": { "description": "New clickable rectangle areas to be shown on the story media; pass null to keep the current areas. Areas can't be edited if story content isn't changed", "is_optional": true, "type": "inputStoryAreas" }, "caption": { "description": "New story caption; pass null to keep the current caption", "is_optional": true, "type": "formattedText" }, "content": { "description": "New content of the story; pass null to keep the current content", "is_optional": true, "type": "InputStoryContent" }, "story_id": { "description": "Identifier of the story to edit", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "editStoryCover": { "description": "Changes cover of a video story. Can be called only if story.can_be_edited == true and the story isn't being edited now", "args": { "cover_frame_timestamp": { "description": "New timestamp of the frame, which will be used as video thumbnail", "is_optional": false, "type": "double" }, "story_id": { "description": "Identifier of the story to edit", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "editTextCompositionStyle": { "description": "Edits a custom text composition style that was created by the current user", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji corresponding to the style", "is_optional": false, "type": "int64" }, "name": { "description": "Name of the style", "is_optional": false, "type": "string" }, "prompt": { "description": "Prompt that will be used for text composition; 1-getOption(\"text_composition_style_prompt_length_max\") characters", "is_optional": false, "type": "string" }, "show_creator": { "description": "Pass true if the current user must be shown as the creator of the style", "is_optional": false, "type": "Bool" }, "title": { "description": "Title of the style; 1-getOption(\"text_composition_style_title_length_max\") characters", "is_optional": false, "type": "string" } }, "type": "TextCompositionStyle" }, "editUserStarSubscription": { "description": "Cancels or re-enables Telegram Star subscription for a user; for bots only", "args": { "is_canceled": { "description": "Pass true to cancel the subscription; pass false to allow the user to enable it", "is_optional": false, "type": "Bool" }, "telegram_payment_charge_id": { "description": "Telegram payment identifier of the subscription", "is_optional": false, "type": "string" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "enableProxy": { "description": "Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization", "args": { "proxy_id": { "description": "Proxy identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "enableTonWalletBackup": { "description": "Enables backup of the TON wallet of the user. Works only if tonWalletState.can_enable_backup is true", "args": { "proof": { "description": "Proof of the TON wallet ownership; use getTonWalletOwnershipProofChallenge to get a challenge for the proof", "is_optional": false, "type": "tonWalletOwnershipProof" }, "secret_phrase": { "description": "The secret phrase of the user's TON wallet as a space separated list of words", "is_optional": false, "type": "string" } }, "type": "Ok" }, "encryptGroupCallData": { "description": "Encrypts group call data before sending them over network using tgcalls", "args": { "data": { "description": "Data to encrypt", "is_optional": false, "type": "bytes" }, "data_channel": { "description": "Data channel for which data is encrypted", "is_optional": false, "type": "GroupCallDataChannel" }, "group_call_id": { "description": "Group call identifier. The call must not be a video chat", "is_optional": false, "type": "int32" }, "unencrypted_prefix_size": { "description": "Size of data prefix that must be kept unencrypted", "is_optional": false, "type": "int32" } }, "type": "Data" }, "endGroupCall": { "description": "Ends a group call. Requires groupCall.can_be_managed right for video chats and live stories or groupCall.is_owned otherwise", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "endGroupCallRecording": { "description": "Ends recording of an active group call; for video chats only. Requires groupCall.can_be_managed right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "endGroupCallScreenSharing": { "description": "Ends screen sharing in a joined group call; not supported in live stories", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "finishFileGeneration": { "description": "Finishes the file generation", "args": { "error": { "description": "If passed, the file generation has failed and must be terminated; pass null if the file generation succeeded", "is_optional": true, "type": "error" }, "generation_id": { "description": "The identifier of the generation process", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "fixRichMessageWithAi": { "description": "Fixes a rich message using an AI model. May return an error with a message \"AICOMPOSE_FLOOD_PREMIUM\" if Telegram Premium is required to send further requests", "args": { "message": { "description": "The original message", "is_optional": false, "type": "inputRichMessage" } }, "type": "RichMessage" }, "fixTextWithAi": { "description": "Fixes text using an AI model; must not be used in secret chats. May return an error with a message \"AICOMPOSE_FLOOD_PREMIUM\" if Telegram Premium is required to send further requests", "args": { "text": { "description": "The original text", "is_optional": false, "type": "formattedText" } }, "type": "FixedText" }, "forwardMessages": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat to which to forward messages", "is_optional": false, "type": "int53" }, "from_chat_id": { "description": "Identifier of the chat from which to forward messages", "is_optional": false, "type": "int53" }, "message_ids": { "description": "Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously. A message can be forwarded only if messageProperties.can_be_forwarded", "is_optional": false, "type": "vector\u003cint53\u003e" }, "options": { "description": "Options to be used to send the messages; pass null to use default options", "is_optional": true, "type": "messageSendOptions" }, "remove_caption": { "description": "Pass true to remove media captions of message copies. Ignored if send_copy is false", "is_optional": false, "type": "Bool" }, "send_copy": { "description": "Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local.", "is_optional": false, "type": "Bool" }, "topic_id": { "description": "Topic in which the messages will be forwarded; message threads aren't supported; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Messages" }, "getAccountTtl": { "description": "Returns the period of inactivity after which the account of the current user will automatically be deleted", "args": {}, "type": "AccountTtl" }, "getActiveSessions": { "description": "Returns all active sessions of the current user. Additionally, getBusinessConnectedBot must be used to show the bot on top of active sessions", "args": {}, "type": "Sessions" }, "getAddressTonWallet": { "description": "Returns information about a TON wallet with the given address; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "address": { "description": "Address in the TON blockchain", "is_optional": false, "type": "string" } }, "type": "UserTonWalletAddress" }, "getAllPassportElements": { "description": "Returns all available Telegram Passport elements", "args": { "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "PassportElements" }, "getAllStickerEmojis": { "description": "Returns unique emoji that correspond to stickers to be found by the getStickers(sticker_type, query, 1000000, chat_id)", "args": { "chat_id": { "description": "Chat identifier for which to find stickers", "is_optional": false, "type": "int53" }, "query": { "description": "Search query", "is_optional": false, "type": "string" }, "return_only_main_emoji": { "description": "Pass true if only main emoji for each found sticker must be included in the result", "is_optional": false, "type": "Bool" }, "sticker_type": { "description": "Type of the stickers to search for", "is_optional": false, "type": "StickerType" } }, "type": "Emojis" }, "getAnimatedEmoji": { "description": "Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji", "args": { "emoji": { "description": "The emoji", "is_optional": false, "type": "string" } }, "type": "AnimatedEmoji" }, "getApplicationConfig": { "description": "Returns application config, provided by the server. Can be called before authorization", "args": {}, "type": "JsonValue" }, "getApplicationDownloadLink": { "description": "Returns the link for downloading official Telegram application to be used when the current user invites friends to Telegram", "args": {}, "type": "HttpUrl" }, "getArchiveChatListSettings": { "description": "Returns settings for automatic moving of chats to and from the Archive chat lists", "args": {}, "type": "ArchiveChatListSettings" }, "getArchivedStickerSets": { "description": "Returns a list of archived sticker sets", "args": { "limit": { "description": "The maximum number of sticker sets to return; up to 100", "is_optional": false, "type": "int32" }, "offset_sticker_set_id": { "description": "Identifier of the sticker set from which to return the result; use 0 to get results from the beginning", "is_optional": false, "type": "int64" }, "sticker_type": { "description": "Type of the sticker sets to return", "is_optional": false, "type": "StickerType" } }, "type": "StickerSets" }, "getAttachedStickerSets": { "description": "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", "args": { "file_id": { "description": "File identifier", "is_optional": false, "type": "int32" } }, "type": "StickerSets" }, "getAttachmentMenuBot": { "description": "Returns information about a bot that can be added to attachment or side menu", "args": { "bot_user_id": { "description": "Bot's user identifier", "is_optional": false, "type": "int53" } }, "type": "AttachmentMenuBot" }, "getAuthenticationPasskeyParameters": { "description": "Returns parameters for authentication using a passkey as JSON-serialized string", "args": {}, "type": "Text" }, "getAuthorizationState": { "description": "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", "args": {}, "type": "AuthorizationState" }, "getAutoDownloadSettingsPresets": { "description": "Returns auto-download settings presets for the current user", "args": {}, "type": "AutoDownloadSettingsPresets" }, "getAutosaveSettings": { "description": "Returns autosave settings for the current user", "args": {}, "type": "AutosaveSettings" }, "getAvailableChatBoostSlots": { "description": "Returns the list of available chat boost slots for the current user", "args": {}, "type": "ChatBoostSlots" }, "getAvailableGifts": { "description": "Returns gifts that can be sent to other users and channel chats", "args": {}, "type": "AvailableGifts" }, "getBackgroundUrl": { "description": "Constructs a persistent HTTP URL for a background", "args": { "name": { "description": "Background name", "is_optional": false, "type": "string" }, "type": { "description": "Background type; backgroundTypeChatTheme isn't supported", "is_optional": false, "type": "BackgroundType" } }, "type": "HttpUrl" }, "getBankCardInfo": { "description": "Returns information about a bank card", "args": { "bank_card_number": { "description": "The bank card number", "is_optional": false, "type": "string" } }, "type": "BankCardInfo" }, "getBasicGroup": { "description": "Returns information about a basic group by its identifier. This is an offline method if the current user is not a bot", "args": { "basic_group_id": { "description": "Basic group identifier", "is_optional": false, "type": "int53" } }, "type": "BasicGroup" }, "getBasicGroupFullInfo": { "description": "Returns full information about a basic group by its identifier", "args": { "basic_group_id": { "description": "Basic group identifier", "is_optional": false, "type": "int53" } }, "type": "BasicGroupFullInfo" }, "getBlockedMessageSenders": { "description": "Returns users and chats that were blocked by the current user", "args": { "block_list": { "description": "Block list from which to return users", "is_optional": false, "type": "BlockList" }, "limit": { "description": "The maximum number of users and chats to return; up to 100", "is_optional": false, "type": "int32" }, "offset": { "description": "Number of users and chats to skip in the result; must be non-negative", "is_optional": false, "type": "int32" } }, "type": "MessageSenders" }, "getBotInfoDescription": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code or an empty string", "is_optional": false, "type": "string" } }, "type": "Text" }, "getBotInfoShortDescription": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code or an empty string", "is_optional": false, "type": "string" } }, "type": "Text" }, "getBotMediaPreviewInfo": { "description": "Returns the list of media previews for the given language and the list of languages for which the bot has dedicated previews", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must be owned and must have the main Web App", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code for which to get previews. If empty, then default previews are returned", "is_optional": false, "type": "string" } }, "type": "BotMediaPreviewInfo" }, "getBotMediaPreviews": { "description": "Returns the list of media previews of a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must have the main Web App", "is_optional": false, "type": "int53" } }, "type": "BotMediaPreviews" }, "getBotName": { "description": "Returns the name of a bot in the given language. Can be called only if userTypeBot.can_be_edited == true", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code or an empty string", "is_optional": false, "type": "string" } }, "type": "Text" }, "getBotSimilarBotCount": { "description": "Returns approximate number of bots similar to the given bot", "args": { "bot_user_id": { "description": "User identifier of the target bot", "is_optional": false, "type": "int53" }, "return_local": { "description": "Pass true to get the number of bots without sending network requests, or -1 if the number of bots is unknown locally", "is_optional": false, "type": "Bool" } }, "type": "Count" }, "getBotSimilarBots": { "description": "Returns a list of bots similar to the given bot", "args": { "bot_user_id": { "description": "User identifier of the target bot", "is_optional": false, "type": "int53" } }, "type": "Users" }, "getBusinessAccountStarAmount": { "description": "Returns the Telegram Star amount owned by a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" } }, "type": "StarAmount" }, "getBusinessChatLinkInfo": { "description": "Returns information about a business chat link", "args": { "link_name": { "description": "Name of the link", "is_optional": false, "type": "string" } }, "type": "BusinessChatLinkInfo" }, "getBusinessChatLinks": { "description": "Returns business chat links created for the current account", "args": {}, "type": "BusinessChatLinks" }, "getBusinessConnectedBot": { "description": "Returns information about the business bot that is connected to the current user account. Returns a 404 error if there is no connected bot", "args": {}, "type": "BusinessConnectedBotInfo" }, "getBusinessConnection": { "description": "Returns information about a business connection by its identifier; for bots only", "args": { "connection_id": { "description": "Identifier of the business connection to return", "is_optional": false, "type": "string" } }, "type": "BusinessConnection" }, "getBusinessFeatures": { "description": "Returns information about features, available to Business users", "args": { "source": { "description": "Source of the request; pass null if the method is called from settings or some non-standard source", "is_optional": true, "type": "BusinessFeature" } }, "type": "BusinessFeatures" }, "getCallbackQueryAnswer": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message from which the query originated. The message must not be scheduled", "is_optional": false, "type": "int53" }, "payload": { "description": "Query payload", "is_optional": false, "type": "CallbackQueryPayload" } }, "type": "CallbackQueryAnswer" }, "getCallbackQueryMessage": { "description": "Returns information about a message with the callback button that originated a callback query; for bots only", "args": { "callback_query_id": { "description": "Identifier of the callback query", "is_optional": false, "type": "int64" }, "chat_id": { "description": "Identifier of the chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getChat": { "description": "Returns information about a chat by its identifier. This is an offline method if the current user is not a bot", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Chat" }, "getChatActiveStories": { "description": "Returns the list of active stories posted by the given chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatActiveStories" }, "getChatAdministrators": { "description": "Returns a list of administrators of the chat with their custom titles", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatAdministrators" }, "getChatArchivedStories": { "description": "Returns the list of all stories posted by the given chat; requires can_edit_stories administrator right in the chat.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "from_story_id": { "description": "Identifier of the story starting from which stories must be returned; use 0 to get results from the last story", "is_optional": false, "type": "int32" }, "limit": { "description": "The maximum number of stories to be returned.", "is_optional": false, "type": "int32" } }, "type": "Stories" }, "getChatAvailableMessageSenders": { "description": "Returns the list of message sender identifiers, which can be used to send messages in a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatMessageSenders" }, "getChatAvailablePaidMessageReactionSenders": { "description": "Returns the list of message sender identifiers, which can be used to send a paid reaction in a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "MessageSenders" }, "getChatBoostFeatures": { "description": "Returns the list of features available for different chat boost levels. This is an offline method", "args": { "is_channel": { "description": "Pass true to get the list of features for channels; pass false to get the list of features for supergroups", "is_optional": false, "type": "Bool" } }, "type": "ChatBoostFeatures" }, "getChatBoostLevelFeatures": { "description": "Returns the list of features available on the specific chat boost level. This is an offline method", "args": { "is_channel": { "description": "Pass true to get the list of features for channels; pass false to get the list of features for supergroups", "is_optional": false, "type": "Bool" }, "level": { "description": "Chat boost level", "is_optional": false, "type": "int32" } }, "type": "ChatBoostLevelFeatures" }, "getChatBoostLink": { "description": "Returns an HTTPS link to boost the specified supergroup or channel chat", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "ChatBoostLink" }, "getChatBoostLinkInfo": { "description": "Returns information about a link to boost a chat. Can be called for any internal link of the type internalLinkTypeChatBoost", "args": { "url": { "description": "The link to boost a chat", "is_optional": false, "type": "string" } }, "type": "ChatBoostLinkInfo" }, "getChatBoostStatus": { "description": "Returns the current boost status for a supergroup or a channel chat", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "ChatBoostStatus" }, "getChatBoosts": { "description": "Returns the list of boosts applied to a chat; requires administrator rights in the chat", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of boosts to be returned; up to 100. For optimal performance, the number of returned boosts can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "only_gift_codes": { "description": "Pass true to receive only boosts received from gift codes and giveaways created by the chat", "is_optional": false, "type": "Bool" } }, "type": "FoundChatBoosts" }, "getChatEventLog": { "description": "Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only in supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i.e., in order of decreasing event_id)", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "filters": { "description": "The types of events to return; pass null to get chat events of all types", "is_optional": true, "type": "chatEventLogFilters" }, "from_event_id": { "description": "Identifier of an event from which to return results. Use 0 to get results from the latest events", "is_optional": false, "type": "int64" }, "limit": { "description": "The maximum number of events to return; up to 100", "is_optional": false, "type": "int32" }, "query": { "description": "Search query by which to filter events", "is_optional": false, "type": "string" }, "user_ids": { "description": "User identifiers by which to filter events. By default, events relating to all users will be returned", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "ChatEvents" }, "getChatFolder": { "description": "Returns information about a chat folder by its identifier", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "ChatFolder" }, "getChatFolderChatCount": { "description": "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", "args": { "folder": { "description": "The new chat folder", "is_optional": false, "type": "chatFolder" } }, "type": "Count" }, "getChatFolderChatsToLeave": { "description": "Returns identifiers of pinned or always included chats from a chat folder, which are suggested to be left when the chat folder is deleted", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getChatFolderDefaultIconName": { "description": "Returns default icon name for a folder. Can be called synchronously", "args": { "folder": { "description": "Chat folder", "is_optional": false, "type": "chatFolder" } }, "type": "ChatFolderIcon" }, "getChatFolderInviteLinks": { "description": "Returns invite links created by the current user for a shareable chat folder", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "ChatFolderInviteLinks" }, "getChatFolderNewChats": { "description": "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", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getChatHistory": { "description": "Returns messages in a chat. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id).", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "from_message_id": { "description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than or equal to -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number from -99 to -1 to get additionally -offset newer messages", "is_optional": false, "type": "int32" }, "only_local": { "description": "Pass true to get only messages that are available without sending network requests", "is_optional": false, "type": "Bool" } }, "type": "Messages" }, "getChatInviteLink": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link to get", "is_optional": false, "type": "string" } }, "type": "ChatInviteLink" }, "getChatInviteLinkCounts": { "description": "Returns the list of chat administrators with number of their invite links. Requires owner privileges in the chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatInviteLinkCounts" }, "getChatInviteLinkMembers": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link for which to return chat members", "is_optional": false, "type": "string" }, "limit": { "description": "The maximum number of chat members to return; up to 100", "is_optional": false, "type": "int32" }, "offset_member": { "description": "A chat member from which to return next chat members; pass null to get results from the beginning", "is_optional": true, "type": "chatInviteLinkMember" }, "only_with_expired_subscription": { "description": "Pass true if the link is a subscription link and only members with expired subscription must be returned", "is_optional": false, "type": "Bool" } }, "type": "ChatInviteLinkMembers" }, "getChatInviteLinks": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "creator_user_id": { "description": "User identifier of a chat administrator. Must be an identifier of the current user for non-owner", "is_optional": false, "type": "int53" }, "is_revoked": { "description": "Pass true if revoked links need to be returned instead of active or expired", "is_optional": false, "type": "Bool" }, "limit": { "description": "The maximum number of invite links to return; up to 100", "is_optional": false, "type": "int32" }, "offset_date": { "description": "Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning", "is_optional": false, "type": "int32" }, "offset_invite_link": { "description": "Invite link starting after which to return invite links; use empty string to get results from the beginning", "is_optional": false, "type": "string" } }, "type": "ChatInviteLinks" }, "getChatJoinRequests": { "description": "Returns pending join requests in a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", "is_optional": false, "type": "string" }, "limit": { "description": "The maximum number of requests to join the chat to return", "is_optional": false, "type": "int32" }, "offset_request": { "description": "A chat join request from which to return next requests; pass null to get results from the beginning", "is_optional": true, "type": "chatJoinRequest" }, "query": { "description": "A query to search for in the first names, last names and usernames of the users to return", "is_optional": false, "type": "string" } }, "type": "ChatJoinRequests" }, "getChatListsToAddChat": { "description": "Returns chat lists to which the chat can be added. This is an offline method", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatLists" }, "getChatMember": { "description": "Returns information about a single member of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "member_id": { "description": "Member identifier", "is_optional": false, "type": "MessageSender" } }, "type": "ChatMember" }, "getChatMessageByDate": { "description": "Returns the last message sent in a chat no later than the specified date. Returns a 404 error if such message doesn't exist", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) relative to which to search for messages", "is_optional": false, "type": "int32" } }, "type": "Message" }, "getChatMessageCalendar": { "description": "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\"", "args": { "chat_id": { "description": "Identifier of the chat in which to return information about messages", "is_optional": false, "type": "int53" }, "filter": { "description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction,", "is_optional": false, "type": "SearchMessagesFilter" }, "from_message_id": { "description": "The message identifier from which to return information about messages; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Pass topic identifier to get the result only in specific topic; pass null to get the result in all topics; forum topics and message threads aren't supported", "is_optional": true, "type": "MessageTopic" } }, "type": "MessageCalendar" }, "getChatMessageCount": { "description": "Returns approximate number of messages of the specified type in the chat or its topic", "args": { "chat_id": { "description": "Identifier of the chat in which to count messages", "is_optional": false, "type": "int53" }, "filter": { "description": "Filter for message content; searchMessagesFilterEmpty is unsupported in this function", "is_optional": false, "type": "SearchMessagesFilter" }, "return_local": { "description": "Pass true to get the number of messages without sending network requests, or -1 if the number of messages is unknown locally", "is_optional": false, "type": "Bool" }, "topic_id": { "description": "Pass topic identifier to get number of messages only in specific topic; pass null to get number of messages in all topics; message threads aren't supported", "is_optional": true, "type": "MessageTopic" } }, "type": "Count" }, "getChatMessagePosition": { "description": "Returns approximate 1-based position of a message among messages, which can be found by the specified filter in the chat and topic. Cannot be used in secret chats", "args": { "chat_id": { "description": "Identifier of the chat in which to find message position", "is_optional": false, "type": "int53" }, "filter": { "description": "Filter for message content; searchMessagesFilterEmpty, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterUnreadPollVote,", "is_optional": false, "type": "SearchMessagesFilter" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Pass topic identifier to get position among messages only in specific topic; pass null to get position among all chat messages; message threads aren't supported", "is_optional": true, "type": "MessageTopic" } }, "type": "Count" }, "getChatNotificationSettingsExceptions": { "description": "Returns the list of chats with non-default notification settings for new messages", "args": { "compare_sound": { "description": "Pass true to include in the response chats with only non-default sound", "is_optional": false, "type": "Bool" }, "scope": { "description": "If specified, only chats from the scope will be returned; pass null to return chats from all scopes", "is_optional": true, "type": "NotificationSettingsScope" } }, "type": "Chats" }, "getChatOwnerAfterLeaving": { "description": "Returns the user who will become the owner of the chat after 7 days if the current user does not return to the supergroup or channel during that period or immediately for basic groups;", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "User" }, "getChatPinnedMessage": { "description": "Returns information about a newest pinned message in the chat. Returns a 404 error if the message doesn't exist", "args": { "chat_id": { "description": "Identifier of the chat the message belongs to", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getChatPostedToChatPageStories": { "description": "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.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "from_story_id": { "description": "Identifier of the story starting from which stories must be returned; use 0 to get results from pinned and the newest story", "is_optional": false, "type": "int32" }, "limit": { "description": "The maximum number of stories to be returned.", "is_optional": false, "type": "int32" } }, "type": "Stories" }, "getChatRevenueStatistics": { "description": "Returns detailed revenue statistics about a chat. Currently, this method can be used only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" } }, "type": "ChatRevenueStatistics" }, "getChatRevenueTransactions": { "description": "Returns the list of revenue transactions for a chat. Currently, this method can be used only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of transactions to be returned; up to 100", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first transaction to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "ChatRevenueTransactions" }, "getChatRevenueWithdrawalUrl": { "description": "Returns a URL for chat revenue withdrawal; requires owner privileges in the channel chat or the bot. Currently, this method can be used only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "getChatScheduledMessages": { "description": "Returns all scheduled messages in a chat. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id)", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Messages" }, "getChatSimilarChatCount": { "description": "Returns approximate number of chats similar to the given chat", "args": { "chat_id": { "description": "Identifier of the target chat; must be an identifier of a channel chat", "is_optional": false, "type": "int53" }, "return_local": { "description": "Pass true to get the number of chats without sending network requests, or -1 if the number of chats is unknown locally", "is_optional": false, "type": "Bool" } }, "type": "Count" }, "getChatSimilarChats": { "description": "Returns a list of chats similar to the given chat", "args": { "chat_id": { "description": "Identifier of the target chat; must be an identifier of a channel chat", "is_optional": false, "type": "int53" } }, "type": "Chats" }, "getChatSparseMessagePositions": { "description": "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).", "args": { "chat_id": { "description": "Identifier of the chat in which to return information about message positions", "is_optional": false, "type": "int53" }, "filter": { "description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction,", "is_optional": false, "type": "SearchMessagesFilter" }, "from_message_id": { "description": "The message identifier from which to return information about message positions", "is_optional": false, "type": "int53" }, "limit": { "description": "The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages", "is_optional": false, "type": "int32" }, "saved_messages_topic_id": { "description": "If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages, or for chats other than Saved Messages", "is_optional": false, "type": "int53" } }, "type": "MessagePositions" }, "getChatSponsoredMessages": { "description": "Returns sponsored messages to be shown in a chat; for channel chats and chats with bots only", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "SponsoredMessages" }, "getChatStatistics": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" } }, "type": "ChatStatistics" }, "getChatStoryAlbums": { "description": "Returns the list of story albums owned by the given chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "StoryAlbums" }, "getChatStoryInteractions": { "description": "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", "args": { "limit": { "description": "The maximum number of story interactions to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "prefer_forwards": { "description": "Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date", "is_optional": false, "type": "Bool" }, "reaction_type": { "description": "Pass the default heart reaction or a suggested reaction type to receive only interactions with the specified reaction type; pass null to receive all interactions; reactionTypePaid isn't supported", "is_optional": true, "type": "ReactionType" }, "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story", "is_optional": false, "type": "int53" } }, "type": "StoryInteractions" }, "getChats": { "description": "Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats and updates processing instead to maintain chat lists in a consistent state", "args": { "chat_list": { "description": "The chat list in which to return chats; pass null to get chats from the main chat list", "is_optional": true, "type": "ChatList" }, "limit": { "description": "The maximum number of chats to be returned", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getChatsForChatFolderInviteLink": { "description": "Returns identifiers of chats from a chat folder, suitable for adding to a chat folder invite link", "args": { "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getChatsToPostStories": { "description": "Returns supergroup and channel chats in which the current user has the right to post stories. The chats must be rechecked with canPostStory before actually trying to post a story there", "args": {}, "type": "Chats" }, "getCloseFriends": { "description": "Returns all close friends of the current user", "args": {}, "type": "Users" }, "getCollectibleItemInfo": { "description": "Returns information about a given collectible item that was purchased at https://fragment.com", "args": { "type": { "description": "Type of the collectible item. The item must be used by a user and must be visible to the current user", "is_optional": false, "type": "CollectibleItemType" } }, "type": "CollectibleItemInfo" }, "getCommands": { "description": "Returns the list of commands supported by the bot for the given user scope and language; for bots only", "args": { "language_code": { "description": "A two-letter ISO 639-1 language code or an empty string", "is_optional": false, "type": "string" }, "scope": { "description": "The scope to which the commands are relevant; pass null to get commands in the default bot command scope", "is_optional": true, "type": "BotCommandScope" } }, "type": "BotCommands" }, "getCommunityFullInfo": { "description": "Returns full information about a community", "args": { "community_id": { "description": "Community identifier", "is_optional": false, "type": "int53" } }, "type": "CommunityFullInfo" }, "getConnectedAffiliateProgram": { "description": "Returns an affiliate program that was connected to the given affiliate by identifier of the bot that created the program", "args": { "affiliate": { "description": "The affiliate to which the affiliate program will be connected", "is_optional": false, "type": "AffiliateType" }, "bot_user_id": { "description": "Identifier of the bot that created the program", "is_optional": false, "type": "int53" } }, "type": "ConnectedAffiliateProgram" }, "getConnectedAffiliatePrograms": { "description": "Returns affiliate programs that were connected to the given affiliate", "args": { "affiliate": { "description": "The affiliate to which the affiliate programs were connected", "is_optional": false, "type": "AffiliateType" }, "limit": { "description": "The maximum number of affiliate programs to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first affiliate program to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "ConnectedAffiliatePrograms" }, "getConnectedWebsites": { "description": "Returns all website where the current user used Telegram to log in", "args": {}, "type": "ConnectedWebsites" }, "getContacts": { "description": "Returns all contacts of the user", "args": {}, "type": "Users" }, "getCountries": { "description": "Returns information about existing countries. Can be called before authorization", "args": {}, "type": "Countries" }, "getCountry": { "description": "Returns information about an existing country. Can be called before authorization", "args": { "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code", "is_optional": false, "type": "string" } }, "type": "CountryInfo" }, "getCountryCode": { "description": "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", "args": {}, "type": "Text" }, "getCountryFlagEmoji": { "description": "Returns an emoji for the flag of the given country. Returns an empty string on failure. Can be called synchronously", "args": { "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code as received from getCountries", "is_optional": false, "type": "string" } }, "type": "Text" }, "getCreatedPublicChats": { "description": "Returns a list of public chats of the specified type, owned by the user", "args": { "type": { "description": "Type of the public chats to return", "is_optional": false, "type": "PublicChatType" } }, "type": "Chats" }, "getCurrencyExchangeRates": { "description": "Returns exchange rates of currencies to USD", "args": {}, "type": "CurrencyExchangeRates" }, "getCurrentState": { "description": "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", "args": {}, "type": "Updates" }, "getCurrentWeather": { "description": "Returns the current weather in the given location", "args": { "location": { "description": "The location", "is_optional": false, "type": "location" } }, "type": "CurrentWeather" }, "getCustomEmojiReactionAnimations": { "description": "Returns TGS stickers with generic animations for custom emoji reactions", "args": {}, "type": "Stickers" }, "getCustomEmojiStickers": { "description": "Returns the list of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found stickers are returned", "args": { "custom_emoji_ids": { "description": "Identifiers of custom emoji stickers. At most 200 custom emoji stickers can be received simultaneously", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Stickers" }, "getDatabaseStatistics": { "description": "Returns database statistics", "args": {}, "type": "DatabaseStatistics" }, "getDeepLinkInfo": { "description": "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", "args": { "link": { "description": "The link", "is_optional": false, "type": "string" } }, "type": "DeepLinkInfo" }, "getDefaultBackgroundCustomEmojiStickers": { "description": "Returns default list of custom emoji stickers for reply background", "args": {}, "type": "Stickers" }, "getDefaultChatEmojiStatuses": { "description": "Returns default emoji statuses for chats", "args": {}, "type": "EmojiStatusCustomEmojis" }, "getDefaultChatPhotoCustomEmojiStickers": { "description": "Returns default list of custom emoji stickers for placing on a chat photo", "args": {}, "type": "Stickers" }, "getDefaultEmojiStatuses": { "description": "Returns default emoji statuses for self status", "args": {}, "type": "EmojiStatusCustomEmojis" }, "getDefaultMessageAutoDeleteTime": { "description": "Returns default message auto-delete time setting for new chats", "args": {}, "type": "MessageAutoDeleteTime" }, "getDefaultProfilePhotoCustomEmojiStickers": { "description": "Returns default list of custom emoji stickers for placing on a profile photo", "args": {}, "type": "Stickers" }, "getDirectMessagesChatTopic": { "description": "Returns information about the topic in a channel direct messages chat administered by the current user", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Identifier of the topic to get", "is_optional": false, "type": "int53" } }, "type": "DirectMessagesChatTopic" }, "getDirectMessagesChatTopicHistory": { "description": "Returns messages in the topic in a channel direct messages chat administered by the current user. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id)", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "from_message_id": { "description": "Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than or equal to -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number from -99 to -1 to get additionally -offset newer messages", "is_optional": false, "type": "int32" }, "topic_id": { "description": "Identifier of the topic which messages will be fetched", "is_optional": false, "type": "int53" } }, "type": "Messages" }, "getDirectMessagesChatTopicMessageByDate": { "description": "Returns the last message sent in the topic in a channel direct messages chat administered by the current user no later than the specified date", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "date": { "description": "Point in time (Unix timestamp) relative to which to search for messages", "is_optional": false, "type": "int32" }, "topic_id": { "description": "Identifier of the topic which messages will be fetched", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getDirectMessagesChatTopicRevenue": { "description": "Returns the total number of Telegram Stars received by the channel chat for direct messages from the given topic", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat administered by the current user", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Identifier of the topic", "is_optional": false, "type": "int53" } }, "type": "StarCount" }, "getDisallowedChatEmojiStatuses": { "description": "Returns the list of emoji statuses, which can't be used as chat emoji status, even if they are from a sticker set with is_allowed_as_chat_emoji_status == true", "args": {}, "type": "EmojiStatusCustomEmojis" }, "getEmojiCategories": { "description": "Returns available emoji categories", "args": { "type": { "description": "Type of emoji categories to return; pass null to get default emoji categories", "is_optional": true, "type": "EmojiCategoryType" } }, "type": "EmojiCategories" }, "getEmojiReaction": { "description": "Returns information about an emoji reaction. Returns a 404 error if the reaction is not found", "args": { "emoji": { "description": "Text representation of the reaction", "is_optional": false, "type": "string" } }, "type": "EmojiReaction" }, "getEmojiSuggestionsUrl": { "description": "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", "args": { "language_code": { "description": "Language code for which the emoji replacements will be suggested", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "getExternalLink": { "description": "Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link.", "args": { "allow_write_access": { "description": "Pass true if the current user allowed the bot that was returned in getExternalLinkInfo, to send them messages", "is_optional": false, "type": "Bool" }, "link": { "description": "The HTTP link", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "getExternalLinkInfo": { "description": "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", "args": { "link": { "description": "The link", "is_optional": false, "type": "string" } }, "type": "LoginUrlInfo" }, "getFavoriteStickers": { "description": "Returns favorite stickers", "args": {}, "type": "Stickers" }, "getFile": { "description": "Returns information about a file. This is an offline method", "args": { "file_id": { "description": "Identifier of the file to get", "is_optional": false, "type": "int32" } }, "type": "File" }, "getFileDownloadedPrefixSize": { "description": "Returns file downloaded prefix size from a given offset, in bytes", "args": { "file_id": { "description": "Identifier of the file", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset from which downloaded prefix size needs to be calculated", "is_optional": false, "type": "int53" } }, "type": "FileDownloadedPrefixSize" }, "getFileExtension": { "description": "Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. Can be called synchronously", "args": { "mime_type": { "description": "The MIME type of the file", "is_optional": false, "type": "string" } }, "type": "Text" }, "getFileMimeType": { "description": "Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. Can be called synchronously", "args": { "file_name": { "description": "The name of the file or path to the file", "is_optional": false, "type": "string" } }, "type": "Text" }, "getForumTopic": { "description": "Returns information about a topic in a forum supergroup chat or a chat with a bot with topics", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" } }, "type": "ForumTopic" }, "getForumTopicDefaultIcons": { "description": "Returns the list of custom emoji, which can be used as forum topic icon by all users", "args": {}, "type": "Stickers" }, "getForumTopicHistory": { "description": "Returns messages in a topic in a forum supergroup chat or a chat with a bot with topics. The messages are returned in reverse chronological order", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" }, "from_message_id": { "description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than or equal to -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number from -99 to -1 to get additionally -offset newer messages", "is_optional": false, "type": "int32" } }, "type": "Messages" }, "getForumTopicLink": { "description": "Returns an HTTPS link to a topic in a forum supergroup chat. This is an offline method", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" } }, "type": "MessageLink" }, "getForumTopics": { "description": "Returns found forum topics in a forum supergroup chat or a chat with a bot with topics. This is a temporary method for getting information about topic list from the server", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of forum topics to be returned; up to 100. For optimal performance, the number of returned forum topics is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset_date": { "description": "The date starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last topic", "is_optional": false, "type": "int32" }, "offset_forum_topic_id": { "description": "The forum topic identifier of the last found topic, or 0 for the first request", "is_optional": false, "type": "int32" }, "offset_message_id": { "description": "The message identifier of the last message in the last found topic, or 0 for the first request", "is_optional": false, "type": "int53" }, "query": { "description": "Query to search for in the forum topic's name", "is_optional": false, "type": "string" } }, "type": "ForumTopics" }, "getFullRichMessage": { "description": "Returns the full version of a rich message", "args": { "chat_id": { "description": "Identifier of the chat the messages belong to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "RichMessage" }, "getGameHighScores": { "description": "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", "args": { "chat_id": { "description": "The chat that contains the message with the game", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "GameHighScores" }, "getGiftAuctionAcquiredGifts": { "description": "Returns the gifts that were acquired by the current user on a gift auction", "args": { "gift_id": { "description": "Identifier of the auctioned gift", "is_optional": false, "type": "int64" } }, "type": "GiftAuctionAcquiredGifts" }, "getGiftAuctionState": { "description": "Returns auction state for a gift", "args": { "auction_id": { "description": "Unique identifier of the auction", "is_optional": false, "type": "string" } }, "type": "GiftAuctionState" }, "getGiftChatThemes": { "description": "Returns available to the current user gift chat themes", "args": { "limit": { "description": "The maximum number of chat themes to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "GiftChatThemes" }, "getGiftCollections": { "description": "Returns collections of gifts owned by the given user or chat", "args": { "owner_id": { "description": "Identifier of the user or the channel chat that received the gifts", "is_optional": false, "type": "MessageSender" } }, "type": "GiftCollections" }, "getGiftUpgradePreview": { "description": "Returns examples of possible upgraded gifts for a regular gift", "args": { "regular_gift_id": { "description": "Identifier of the regular gift", "is_optional": false, "type": "int64" } }, "type": "GiftUpgradePreview" }, "getGiftsForCrafting": { "description": "Returns upgraded gifts of the current user who can be used to craft another gifts", "args": { "limit": { "description": "The maximum number of gifts to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "regular_gift_id": { "description": "Identifier of the regular gift that will be used for crafting", "is_optional": false, "type": "int64" } }, "type": "GiftsForCrafting" }, "getGiveawayInfo": { "description": "Returns information about a giveaway", "args": { "chat_id": { "description": "Identifier of the channel chat which started the giveaway", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the giveaway or a giveaway winners message in the chat", "is_optional": false, "type": "int53" } }, "type": "GiveawayInfo" }, "getGramRevenueStatistics": { "description": "Returns detailed TON Gram revenue statistics of the current user", "args": { "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" } }, "type": "GramRevenueStatistics" }, "getGramWithdrawalUrl": { "description": "Returns a URL for TON Gram withdrawal from the current user's account. The user must have at least 10 Grams to withdraw", "args": { "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "getGreetingStickers": { "description": "Returns greeting stickers from regular sticker sets that can be used for the start page of other users", "args": {}, "type": "Stickers" }, "getGrossingWebAppBots": { "description": "Returns the most grossing Web App bots", "args": { "limit": { "description": "The maximum number of bots to be returned; up to 100", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "FoundUsers" }, "getGroupCall": { "description": "Returns information about a group call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "GroupCall" }, "getGroupCallParticipants": { "description": "Returns information about participants of a non-joined group call that is not bound to a chat", "args": { "input_group_call": { "description": "The group call which participants will be returned", "is_optional": false, "type": "InputGroupCall" }, "limit": { "description": "The maximum number of participants to return; must be positive", "is_optional": false, "type": "int32" } }, "type": "GroupCallParticipants" }, "getGroupCallStreamSegment": { "description": "Returns a file with a segment of a video chat or live story in a modified OGG format for audio or MPEG-4 format for video", "args": { "channel_id": { "description": "Identifier of an audio/video channel to get as received from tgcalls", "is_optional": false, "type": "int32" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "scale": { "description": "Segment duration scale; 0-1. Segment's duration is 1000/(2**scale) milliseconds", "is_optional": false, "type": "int32" }, "time_offset": { "description": "Point in time when the stream segment begins; Unix timestamp in milliseconds", "is_optional": false, "type": "int53" }, "video_quality": { "description": "Video quality as received from tgcalls; pass null to get the worst available quality", "is_optional": true, "type": "GroupCallVideoQuality" } }, "type": "Data" }, "getGroupCallStreams": { "description": "Returns information about available streams in a video chat or a live story", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "GroupCallStreams" }, "getGroupsInCommon": { "description": "Returns a list of common group chats with a given user. Chats are sorted by their type and creation date", "args": { "limit": { "description": "The maximum number of chats to be returned; up to 100", "is_optional": false, "type": "int32" }, "offset_chat_id": { "description": "Chat identifier starting from which to return chats; use 0 for the first request", "is_optional": false, "type": "int53" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Chats" }, "getGuardBotWebAppUrl": { "description": "Returns an HTTPS URL of a Web App of a guard bot to open after receiving chatJoinResultGuardBotApprovalRequired", "args": { "parameters": { "description": "Parameters to use to open the Web App", "is_optional": false, "type": "webAppOpenParameters" }, "query_id": { "description": "Unique identifier of the join request as received in chatJoinResultGuardBotApprovalRequired", "is_optional": false, "type": "int64" } }, "type": "WebAppUrl" }, "getImportedContactCount": { "description": "Returns the total number of imported contacts", "args": {}, "type": "Count" }, "getInactiveSupergroupChats": { "description": "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 the error \"CHANNELS_TOO_MUCH\". Also, the limit can be increased with Telegram Premium", "args": {}, "type": "Chats" }, "getInlineGameHighScores": { "description": "Returns game high scores and some part of the high score table in the range of the specified user; for bots only", "args": { "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "GameHighScores" }, "getInlineQueryResults": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat where the query was sent", "is_optional": false, "type": "int53" }, "offset": { "description": "Offset of the first entry to return; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "query": { "description": "Text of the query", "is_optional": false, "type": "string" }, "user_location": { "description": "Location of the user; pass null if unknown or the bot doesn't need user's location", "is_optional": true, "type": "location" } }, "type": "InlineQueryResults" }, "getInstalledBackgrounds": { "description": "Returns backgrounds installed by the user", "args": { "for_dark_theme": { "description": "Pass true to order returned backgrounds for a dark theme", "is_optional": false, "type": "Bool" } }, "type": "Backgrounds" }, "getInstalledStickerSets": { "description": "Returns a list of installed sticker sets", "args": { "sticker_type": { "description": "Type of the sticker sets to return", "is_optional": false, "type": "StickerType" } }, "type": "StickerSets" }, "getInternalLink": { "description": "Returns an HTTPS or a tg: link with the given type. Can be called before authorization", "args": { "is_http": { "description": "Pass true to create an HTTPS link (only available for some link types); pass false to create a tg: link", "is_optional": false, "type": "Bool" }, "type": { "description": "Expected type of the link", "is_optional": false, "type": "InternalLinkType" } }, "type": "HttpUrl" }, "getInternalLinkType": { "description": "Returns information about the type of internal link. Returns a 404 error if the link is not internal. Can be called before authorization", "args": { "link": { "description": "The link", "is_optional": false, "type": "string" } }, "type": "InternalLinkType" }, "getJsonString": { "description": "Converts a JsonValue object to corresponding JSON-serialized string. Can be called synchronously", "args": { "json_value": { "description": "The JsonValue object", "is_optional": false, "type": "JsonValue" } }, "type": "Text" }, "getJsonValue": { "description": "Converts a JSON-serialized string to corresponding JsonValue object. Can be called synchronously", "args": { "json": { "description": "The JSON-serialized string", "is_optional": false, "type": "string" } }, "type": "JsonValue" }, "getKeywordEmojis": { "description": "Returns emojis matching the keyword. Supported only if the file database is enabled. Order of results is unspecified", "args": { "input_language_codes": { "description": "List of possible IETF language tags of the user's input language; may be empty if unknown", "is_optional": true, "type": "vector\u003cstring\u003e" }, "text": { "description": "Text to search for", "is_optional": false, "type": "string" } }, "type": "Emojis" }, "getLanguagePackInfo": { "description": "Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization", "args": { "language_pack_id": { "description": "Language pack identifier", "is_optional": false, "type": "string" } }, "type": "LanguagePackInfo" }, "getLanguagePackString": { "description": "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", "args": { "key": { "description": "Language pack key of the string to be returned", "is_optional": false, "type": "string" }, "language_pack_database_path": { "description": "Path to the language pack database in which strings are stored", "is_optional": false, "type": "string" }, "language_pack_id": { "description": "Language pack identifier", "is_optional": false, "type": "string" }, "localization_target": { "description": "Localization target to which the language pack belongs", "is_optional": false, "type": "string" } }, "type": "LanguagePackStringValue" }, "getLanguagePackStrings": { "description": "Returns strings from a language pack in the current localization target by their keys. Can be called before authorization", "args": { "keys": { "description": "Language pack keys of the strings to be returned; leave empty to request all available strings", "is_optional": false, "type": "vector\u003cstring\u003e" }, "language_pack_id": { "description": "Language pack identifier of the strings to be returned", "is_optional": false, "type": "string" } }, "type": "LanguagePackStrings" }, "getLinkPreview": { "description": "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", "args": { "link_preview_options": { "description": "Options to be used for generation of the link preview; pass null to use default link preview options", "is_optional": true, "type": "linkPreviewOptions" }, "text": { "description": "Message text with formatting", "is_optional": false, "type": "formattedText" } }, "type": "LinkPreview" }, "getLinkWebBrowserType": { "description": "Returns a type of the web browser which must be used to open the link", "args": { "link": { "description": "The HTTP link", "is_optional": false, "type": "string" } }, "type": "WebBrowserType" }, "getLiveStoryAvailableMessageSenders": { "description": "Returns the list of message sender identifiers, on whose behalf messages can be sent to a live story", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "ChatMessageSenders" }, "getLiveStoryRtmpUrl": { "description": "Returns RTMP URL for streaming to a live story; requires can_post_stories administrator right for channel chats", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "RtmpUrl" }, "getLiveStoryStreamer": { "description": "Returns information about the user or the chat that streams to a live story; for live stories that aren't an RTMP stream only", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "GroupCallParticipant" }, "getLiveStoryTopDonors": { "description": "Returns the list of top live story donors", "args": { "group_call_id": { "description": "Group call identifier of the live story", "is_optional": false, "type": "int32" } }, "type": "LiveStoryDonors" }, "getLocalizationTargetInfo": { "description": "Returns information about the current localization target. This is an offline method if only_local is true. Can be called before authorization", "args": { "only_local": { "description": "Pass true to get only locally available information without sending network requests", "is_optional": false, "type": "Bool" } }, "type": "LocalizationTargetInfo" }, "getLogStream": { "description": "Returns information about currently used log stream for internal logging of TDLib. Can be called synchronously", "args": {}, "type": "LogStream" }, "getLogTagVerbosityLevel": { "description": "Returns current verbosity level for a specified TDLib internal log tag. Can be called synchronously", "args": { "tag": { "description": "Logging tag to change verbosity level", "is_optional": false, "type": "string" } }, "type": "LogVerbosityLevel" }, "getLogTags": { "description": "Returns the list of available TDLib internal log tags, for example, [\"actor\", \"binlog\", \"connections\", \"notifications\", \"proxy\"]. Can be called synchronously", "args": {}, "type": "LogTags" }, "getLogVerbosityLevel": { "description": "Returns current verbosity level of the internal logging of TDLib. Can be called synchronously", "args": {}, "type": "LogVerbosityLevel" }, "getLoginPasskeys": { "description": "Returns the list of passkeys allowed to be used for the login by the current user", "args": {}, "type": "Passkeys" }, "getLoginUrl": { "description": "Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl.", "args": { "allow_write_access": { "description": "Pass true to allow the bot to send messages to the current user. Phone number access can't be requested using the button", "is_optional": false, "type": "Bool" }, "button_id": { "description": "Button identifier", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Chat identifier of the message with the button", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier of the message with the button", "is_optional": false, "type": "int53" } }, "type": "HttpUrl" }, "getLoginUrlInfo": { "description": "Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button", "args": { "button_id": { "description": "Button identifier", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Chat identifier of the message with the button", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier of the message with the button. The message must not be scheduled", "is_optional": false, "type": "int53" } }, "type": "LoginUrlInfo" }, "getMainWebApp": { "description": "Returns information needed to open the main Web App of a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot. If the bot is restricted for the current user, then show an error instead of calling the method", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat in which the Web App is opened; pass 0 if none", "is_optional": false, "type": "int53" }, "parameters": { "description": "Parameters to use to open the Web App", "is_optional": false, "type": "webAppOpenParameters" }, "start_parameter": { "description": "Start parameter from internalLinkTypeMainWebApp", "is_optional": false, "type": "string" } }, "type": "MainWebApp" }, "getManagedBotAccessSettings": { "description": "Returns access settings of a managed bot; for bots only", "args": { "bot_user_id": { "description": "Identifier of the managed bot", "is_optional": false, "type": "int53" } }, "type": "BotAccessSettings" }, "getManagedBotToken": { "description": "Returns token of a managed bot; for bots only", "args": { "bot_user_id": { "description": "Identifier of the managed bot", "is_optional": false, "type": "int53" }, "revoke": { "description": "Pass true to revoke the current token and create a new one", "is_optional": false, "type": "Bool" } }, "type": "Text" }, "getMapThumbnailFile": { "description": "Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded", "args": { "chat_id": { "description": "Identifier of a chat in which the thumbnail will be shown. Use 0 if unknown", "is_optional": false, "type": "int53" }, "height": { "description": "Map height in pixels before applying scale; 16-1024", "is_optional": false, "type": "int32" }, "location": { "description": "Location of the map center", "is_optional": false, "type": "location" }, "scale": { "description": "Map scale; 1-3", "is_optional": false, "type": "int32" }, "width": { "description": "Map width in pixels before applying scale; 16-1024", "is_optional": false, "type": "int32" }, "zoom": { "description": "Map zoom level; 13-20", "is_optional": false, "type": "int32" } }, "type": "File" }, "getMarkdownText": { "description": "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", "args": { "text": { "description": "The text", "is_optional": false, "type": "formattedText" } }, "type": "FormattedText" }, "getMe": { "description": "Returns the current user", "args": {}, "type": "User" }, "getMenuButton": { "description": "Returns menu button set by the bot for the given user; for bots only", "args": { "user_id": { "description": "Identifier of the user or 0 to get the default menu button", "is_optional": false, "type": "int53" } }, "type": "BotMenuButton" }, "getMessage": { "description": "Returns information about a message. Returns a 404 error if the message doesn't exist", "args": { "chat_id": { "description": "Identifier of the chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message to get", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getMessageAddedReactions": { "description": "Returns reactions added for a message, along with their sender", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of reactions to be returned; must be positive and can't be greater than 100", "is_optional": false, "type": "int32" }, "message_id": { "description": "Identifier of the message. Use message.interaction_info.reactions.can_get_added_reactions to check whether added reactions can be received for the message", "is_optional": false, "type": "int53" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "reaction_type": { "description": "Type of the reactions to return; pass null to return all added reactions; reactionTypePaid isn't supported", "is_optional": true, "type": "ReactionType" } }, "type": "AddedReactions" }, "getMessageAuthor": { "description": "Returns information about actual author of a message sent on behalf of a channel. The method can be called if messageProperties.can_get_author == true", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "User" }, "getMessageAvailableReactions": { "description": "Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatAvailableReactions for the chat, or updateMessageInteractionInfo for the message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "row_size": { "description": "Number of reaction per row, 5-25", "is_optional": false, "type": "int32" } }, "type": "AvailableReactions" }, "getMessageEffect": { "description": "Returns information about a message effect. Returns a 404 error if the effect is not found", "args": { "effect_id": { "description": "Unique identifier of the effect", "is_optional": false, "type": "int64" } }, "type": "MessageEffect" }, "getMessageEmbeddingCode": { "description": "Returns an HTML code for embedding the message. Available only if messageProperties.can_get_embedding_code", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "for_album": { "description": "Pass true to return an HTML code for embedding of the whole media album", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Text" }, "getMessageFileType": { "description": "Returns information about a file with messages exported from another application", "args": { "message_file_head": { "description": "Beginning of the message file; up to 100 first lines", "is_optional": false, "type": "string" } }, "type": "MessageFileType" }, "getMessageImportConfirmationText": { "description": "Returns a confirmation text to be shown to the user before starting message import", "args": { "chat_id": { "description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info member right", "is_optional": false, "type": "int53" } }, "type": "Text" }, "getMessageLink": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "checklist_task_id": { "description": "If not 0, identifier of the checklist task in the message to be linked", "is_optional": false, "type": "int32" }, "for_album": { "description": "Pass true to create a link for the whole media album", "is_optional": false, "type": "Bool" }, "in_message_thread": { "description": "Pass true to create a link to the message as a channel post comment, in a message thread, or a forum topic", "is_optional": false, "type": "Bool" }, "media_timestamp": { "description": "If not 0, timestamp from which the video/audio/video note/voice note/story playing must start, in seconds. The media can be in the message content or in its link preview", "is_optional": false, "type": "int32" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "poll_option_id": { "description": "If not empty, identifier of the poll option in the message to be linked", "is_optional": false, "type": "string" } }, "type": "MessageLink" }, "getMessageLinkInfo": { "description": "Returns information about a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage", "args": { "url": { "description": "The message link", "is_optional": false, "type": "string" } }, "type": "MessageLinkInfo" }, "getMessageLocally": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message to get", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getMessageProperties": { "description": "Returns properties of a message. This is an offline method", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "MessageProperties" }, "getMessagePublicForwards": { "description": "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", "args": { "chat_id": { "description": "Chat identifier of the message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "PublicForwards" }, "getMessageReadDate": { "description": "Returns read date of a recent outgoing message in a private chat. The method can be called if messageProperties.can_get_read_date == true", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "MessageReadDate" }, "getMessageStatistics": { "description": "Returns detailed statistics about a message. Can be used only if messageProperties.can_get_statistics == true", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "MessageStatistics" }, "getMessageThread": { "description": "Returns information about a message thread. Can be used only if messageProperties.can_get_message_thread == true", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "MessageThreadInfo" }, "getMessageThreadHistory": { "description": "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.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "from_message_id": { "description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than or equal to -offset.", "is_optional": false, "type": "int32" }, "message_id": { "description": "Message identifier, which thread history needs to be returned", "is_optional": false, "type": "int53" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number from -99 to -1 to get additionally -offset newer messages", "is_optional": false, "type": "int32" } }, "type": "Messages" }, "getMessageViewers": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "MessageViewers" }, "getMessages": { "description": "Returns information about messages. If a message is not found, returns null on the corresponding position of the result", "args": { "chat_id": { "description": "Identifier of the chat the messages belong to", "is_optional": false, "type": "int53" }, "message_ids": { "description": "Identifiers of the messages to get", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Messages" }, "getNetworkStatistics": { "description": "Returns network data usage statistics. Can be called before authorization", "args": { "only_current": { "description": "Pass true to get statistics only for the current library launch", "is_optional": false, "type": "Bool" } }, "type": "NetworkStatistics" }, "getNewChatPrivacySettings": { "description": "Returns privacy settings for new chat creation", "args": {}, "type": "NewChatPrivacySettings" }, "getOauthLinkInfo": { "description": "Returns information about an OAuth deep link. Use checkOauthRequestMatchCode, acceptOauthRequest or declineOauthRequest to process the link", "args": { "in_app_origin": { "description": "Origin of the OAuth request if the request was received from the in-app browser; pass an empty string otherwise", "is_optional": false, "type": "string" }, "url": { "description": "URL of the link", "is_optional": false, "type": "string" } }, "type": "OauthLinkInfo" }, "getOnRampPaymentAvailability": { "description": "Returns the available on-ramp payment methods based on the current user location", "args": { "base_currency": { "description": "ISO 4217 currency code of the currency that will be used for the purchase; pass an empty string if unknown", "is_optional": false, "type": "string" }, "cryptocurrency": { "description": "The cryptocurrency that will be bought", "is_optional": false, "type": "string" }, "provider_id": { "description": "Unique identifier of the on-ramp provider", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentAvailability" }, "getOnRampPaymentLimits": { "description": "Returns the limits for an on-ramp payment; only for providers that supports limits retrieval", "args": { "base_currency": { "description": "ISO 4217 currency code of the currency that will be used for the purchase", "is_optional": false, "type": "string" }, "cryptocurrency": { "description": "The cryptocurrency that will be bought", "is_optional": false, "type": "string" }, "payment_method_name": { "description": "Name of the chosen payment method; pass an empty string if none", "is_optional": false, "type": "string" }, "provider_id": { "description": "Unique identifier of the on-ramp provider", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentLimits" }, "getOnRampPaymentQuote": { "description": "Returns a quote for an on-ramp payment; only for providers that supports quote retrieval", "args": { "base_currency": { "description": "ISO 4217 currency code of the currency that will be used for the purchase", "is_optional": false, "type": "string" }, "base_currency_amount": { "description": "The amount of the base currency to spend; pass an empty string if the user selected cryptocurrency_amount", "is_optional": false, "type": "string" }, "cryptocurrency": { "description": "The cryptocurrency that will be bought", "is_optional": false, "type": "string" }, "cryptocurrency_amount": { "description": "The amount of the cryptocurrency to buy; pass an empty string if the user selected base_currency_amount", "is_optional": false, "type": "string" }, "payment_method_name": { "description": "Name of the chosen payment method; pass an empty string if none", "is_optional": false, "type": "string" }, "provider_id": { "description": "Unique identifier of the on-ramp provider", "is_optional": false, "type": "string" } }, "type": "OnRampPaymentQuote" }, "getOnRampProviderBaseCurrencies": { "description": "Returns the list of fiat currencies supported by an on-ramp provider for the given cryptocurrency", "args": { "cryptocurrency": { "description": "The cryptocurrency that will be bought", "is_optional": false, "type": "string" }, "provider_id": { "description": "Unique identifier of the on-ramp provider; only for providers that supports base currencies", "is_optional": false, "type": "string" } }, "type": "Currencies" }, "getOnRampProviders": { "description": "Returns available on-ramp providers", "args": { "cryptocurrency": { "description": "Pass a cryptocurrency to receive only providers that support it; pass an empty string to receive all providers", "is_optional": false, "type": "string" } }, "type": "OnRampProviders" }, "getOption": { "description": "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\"", "args": { "name": { "description": "The name of the option", "is_optional": false, "type": "string" } }, "type": "OptionValue" }, "getOwnedBots": { "description": "Returns the list of bots owned by the current user", "args": {}, "type": "Users" }, "getOwnedStickerSets": { "description": "Returns sticker sets owned by the current user", "args": { "limit": { "description": "The maximum number of sticker sets to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset_sticker_set_id": { "description": "Identifier of the sticker set from which to return owned sticker sets; use 0 to get results from the beginning", "is_optional": false, "type": "int64" } }, "type": "StickerSets" }, "getPaidMessageRevenue": { "description": "Returns the total number of Telegram Stars received by the current user for paid messages from the given user", "args": { "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "StarCount" }, "getPasskeyParameters": { "description": "Returns parameters for creating of a new passkey as JSON-serialized string", "args": {}, "type": "Text" }, "getPassportAuthorizationForm": { "description": "Returns a Telegram Passport authorization form for sharing data with a service", "args": { "bot_user_id": { "description": "User identifier of the service's bot", "is_optional": false, "type": "int53" }, "nonce": { "description": "Unique request identifier provided by the service", "is_optional": false, "type": "string" }, "public_key": { "description": "Service's public key", "is_optional": false, "type": "string" }, "scope": { "description": "Telegram Passport element types requested by the service", "is_optional": false, "type": "string" } }, "type": "PassportAuthorizationForm" }, "getPassportAuthorizationFormAvailableElements": { "description": "Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form", "args": { "authorization_form_id": { "description": "Authorization form identifier", "is_optional": false, "type": "int32" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "PassportElementsWithErrors" }, "getPassportElement": { "description": "Returns one of the available Telegram Passport elements", "args": { "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" }, "type": { "description": "Telegram Passport element type", "is_optional": false, "type": "PassportElementType" } }, "type": "PassportElement" }, "getPasswordState": { "description": "Returns the current state of 2-step verification", "args": {}, "type": "PasswordState" }, "getPaymentForm": { "description": "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", "args": { "input_invoice": { "description": "The invoice", "is_optional": false, "type": "InputInvoice" }, "theme": { "description": "Preferred payment form theme; pass null to use the default theme", "is_optional": true, "type": "themeParameters" } }, "type": "PaymentForm" }, "getPaymentReceipt": { "description": "Returns information about a successful payment", "args": { "chat_id": { "description": "Chat identifier of the messagePaymentSuccessful message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" } }, "type": "PaymentReceipt" }, "getPersonalChatHistory": { "description": "Returns messages in the personal chat of a given user; for bots only", "args": { "limit": { "description": "The maximum number of messages to be returned; 1-20", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Messages" }, "getPhoneNumberInfo": { "description": "Returns information about a phone number by its prefix. Can be called before authorization", "args": { "phone_number_prefix": { "description": "The phone number prefix", "is_optional": false, "type": "string" } }, "type": "PhoneNumberInfo" }, "getPhoneNumberInfoSync": { "description": "Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after changing localization to the specified language if properly localized country information is expected. Can be called synchronously", "args": { "language_code": { "description": "A two-letter ISO 639-1 language code for country information localization", "is_optional": false, "type": "string" }, "phone_number_prefix": { "description": "The phone number prefix", "is_optional": false, "type": "string" } }, "type": "PhoneNumberInfo" }, "getPollOptionProperties": { "description": "Returns properties of a poll option. This is an offline method", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "poll_option_id": { "description": "Unique identifier of the answer option, which properties will be returned", "is_optional": false, "type": "string" } }, "type": "PollOptionProperties" }, "getPollVoteStatistics": { "description": "Returns statistics of poll votes in a poll", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message containing the poll. Use messageProperties.can_get_poll_vote_statistics to check whether the method can be used for a message", "is_optional": false, "type": "int53" } }, "type": "PollVoteStatistics" }, "getPollVoters": { "description": "Returns message senders voted for the specified option in a poll; use poll.can_get_voters to check whether the method can be used.", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of voters to be returned; must be positive and can't be greater than 50. For optimal performance, the number of returned voters is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached", "is_optional": false, "type": "int32" }, "message_id": { "description": "Identifier of the message containing the poll", "is_optional": false, "type": "int53" }, "offset": { "description": "Number of voters to skip in the result; must be non-negative", "is_optional": false, "type": "int32" }, "option_id": { "description": "0-based identifier of the answer option", "is_optional": false, "type": "int32" } }, "type": "PollVoters" }, "getPreferredCountryLanguage": { "description": "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", "args": { "country_code": { "description": "A two-letter ISO 3166-1 alpha-2 country code", "is_optional": false, "type": "string" } }, "type": "Text" }, "getPremiumFeatures": { "description": "Returns information about features, available to Premium users", "args": { "source": { "description": "Source of the request; pass null if the method is called from some non-standard source", "is_optional": true, "type": "PremiumSource" } }, "type": "PremiumFeatures" }, "getPremiumGiftPaymentOptions": { "description": "Returns available options for gifting Telegram Premium to a user", "args": {}, "type": "PremiumGiftPaymentOptions" }, "getPremiumGiveawayPaymentOptions": { "description": "Returns available options for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among chat members", "args": { "boosted_chat_id": { "description": "Identifier of the supergroup or channel chat, which will be automatically boosted by receivers of the gift codes and which is administered by the user", "is_optional": false, "type": "int53" } }, "type": "PremiumGiveawayPaymentOptions" }, "getPremiumInfoSticker": { "description": "Returns the sticker to be used as representation of the Telegram Premium subscription", "args": { "month_count": { "description": "Number of months the Telegram Premium subscription will be active", "is_optional": false, "type": "int32" } }, "type": "Sticker" }, "getPremiumLimit": { "description": "Returns information about a limit, increased for Premium users. Returns a 404 error if the limit is unknown", "args": { "limit_type": { "description": "Type of the limit", "is_optional": false, "type": "PremiumLimitType" } }, "type": "PremiumLimit" }, "getPremiumState": { "description": "Returns state of Telegram Premium subscription and promotion videos for Premium features", "args": {}, "type": "PremiumState" }, "getPremiumStickerExamples": { "description": "Returns examples of premium stickers for demonstration purposes", "args": {}, "type": "Stickers" }, "getPremiumStickers": { "description": "Returns premium stickers from regular sticker sets", "args": { "limit": { "description": "The maximum number of stickers to be returned; 0-100", "is_optional": false, "type": "int32" } }, "type": "Stickers" }, "getPreparedInlineMessage": { "description": "Saves an inline message to be sent by the given user", "args": { "bot_user_id": { "description": "Identifier of the bot that created the message", "is_optional": false, "type": "int53" }, "prepared_message_id": { "description": "Identifier of the prepared message", "is_optional": false, "type": "string" } }, "type": "PreparedInlineMessage" }, "getPreparedKeyboardButton": { "description": "Returns a keyboard button prepared by the bot for the user. The button will be of the type keyboardButtonTypeRequestUsers, keyboardButtonTypeRequestChat, or keyboardButtonTypeRequestManagedBot", "args": { "bot_user_id": { "description": "Identifier of the bot that created the button", "is_optional": false, "type": "int53" }, "prepared_button_id": { "description": "Identifier of the prepared button", "is_optional": false, "type": "string" } }, "type": "KeyboardButton" }, "getProxies": { "description": "Returns the list of proxies that are currently set up. Can be called before authorization", "args": {}, "type": "AddedProxies" }, "getPublicPostSearchLimits": { "description": "Checks public post search limits without actually performing the search", "args": { "query": { "description": "Query that will be searched for", "is_optional": false, "type": "string" } }, "type": "PublicPostSearchLimits" }, "getPushReceiverId": { "description": "Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. Can be called synchronously", "args": { "payload": { "description": "JSON-encoded push notification payload", "is_optional": false, "type": "string" } }, "type": "PushReceiverId" }, "getReadDatePrivacySettings": { "description": "Returns privacy settings for message read date", "args": {}, "type": "ReadDatePrivacySettings" }, "getReceivedGift": { "description": "Returns information about a received gift", "args": { "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" } }, "type": "ReceivedGift" }, "getReceivedGifts": { "description": "Returns gifts received by the given user or chat", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request; for bots only", "is_optional": false, "type": "string" }, "collection_id": { "description": "Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections", "is_optional": false, "type": "int32" }, "exclude_hosted": { "description": "Pass true to exclude gifts that are just hosted and are not owned by the owner", "is_optional": false, "type": "Bool" }, "exclude_non_upgradable": { "description": "Pass true to exclude gifts that can be purchased limited number of times and can't be upgraded", "is_optional": false, "type": "Bool" }, "exclude_saved": { "description": "Pass true to exclude gifts that are saved to the chat's profile page. Always false for gifts received by other users and channel chats without can_post_messages administrator right", "is_optional": false, "type": "Bool" }, "exclude_unlimited": { "description": "Pass true to exclude gifts that can be purchased unlimited number of times", "is_optional": false, "type": "Bool" }, "exclude_unsaved": { "description": "Pass true to exclude gifts that aren't saved to the chat's profile page. Always true for gifts received by other users and channel chats without can_post_messages administrator right", "is_optional": false, "type": "Bool" }, "exclude_upgradable": { "description": "Pass true to exclude gifts that can be purchased limited number of times and can be upgraded", "is_optional": false, "type": "Bool" }, "exclude_upgraded": { "description": "Pass true to exclude upgraded gifts", "is_optional": false, "type": "Bool" }, "exclude_without_colors": { "description": "Pass true to exclude gifts that can't be used in setUpgradedGiftColors", "is_optional": false, "type": "Bool" }, "limit": { "description": "The maximum number of gifts to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "owner_id": { "description": "Identifier of the gift receiver", "is_optional": false, "type": "MessageSender" }, "sort_by_price": { "description": "Pass true to sort results by gift price instead of send date", "is_optional": false, "type": "Bool" } }, "type": "ReceivedGifts" }, "getRecentEmojiStatuses": { "description": "Returns recent emoji statuses for self status", "args": {}, "type": "EmojiStatuses" }, "getRecentInlineBots": { "description": "Returns up to 20 recently used inline bots in the order of their last usage", "args": {}, "type": "Users" }, "getRecentStickers": { "description": "Returns a list of recently used stickers", "args": { "is_attached": { "description": "Pass true to return stickers and masks that were recently attached to photos or video files; pass false to return recently sent stickers", "is_optional": false, "type": "Bool" } }, "type": "Stickers" }, "getRecentlyOpenedChats": { "description": "Returns recently opened chats. This is an offline method. Returns chats in the order of last opening", "args": { "limit": { "description": "The maximum number of chats to be returned", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getRecentlyVisitedTMeUrls": { "description": "Returns t.me URLs recently visited by a newly registered user", "args": { "referrer": { "description": "Google Play referrer to identify the user", "is_optional": false, "type": "string" } }, "type": "TMeUrls" }, "getRecommendedChatFolders": { "description": "Returns recommended chat folders for the current user", "args": {}, "type": "RecommendedChatFolders" }, "getRecommendedChats": { "description": "Returns a list of channel chats recommended to the current user", "args": {}, "type": "Chats" }, "getRecoveryEmailAddress": { "description": "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", "args": { "password": { "description": "The 2-step verification password for the current user", "is_optional": false, "type": "string" } }, "type": "RecoveryEmailAddress" }, "getRemoteFile": { "description": "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 if the request succeeds, the file can be used only if it is still accessible to the user.", "args": { "file_type": { "description": "File type; pass null if unknown", "is_optional": true, "type": "FileType" }, "remote_file_id": { "description": "Remote identifier of the file to get", "is_optional": false, "type": "string" } }, "type": "File" }, "getRepliedMessage": { "description": "Returns information about a non-bundled message that is replied by a given message. Also, returns the pinned message for messagePinMessage,", "args": { "chat_id": { "description": "Identifier of the chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the reply message", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getSavedAnimations": { "description": "Returns saved animations", "args": {}, "type": "Animations" }, "getSavedMessagesTags": { "description": "Returns tags used in Saved Messages or a Saved Messages topic", "args": { "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which tags will be returned; pass 0 to get all Saved Messages tags", "is_optional": false, "type": "int53" } }, "type": "SavedMessagesTags" }, "getSavedMessagesTopicHistory": { "description": "Returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order of decreasing message_id)", "args": { "from_message_id": { "description": "Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than or equal to -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number from -99 to -1 to get additionally -offset newer messages", "is_optional": false, "type": "int32" }, "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which messages will be fetched", "is_optional": false, "type": "int53" } }, "type": "Messages" }, "getSavedMessagesTopicMessageByDate": { "description": "Returns the last message sent in a Saved Messages topic no later than the specified date", "args": { "date": { "description": "Point in time (Unix timestamp) relative to which to search for messages", "is_optional": false, "type": "int32" }, "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic which message will be returned", "is_optional": false, "type": "int53" } }, "type": "Message" }, "getSavedNotificationSound": { "description": "Returns saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with the specified identifier", "args": { "notification_sound_id": { "description": "Identifier of the notification sound", "is_optional": false, "type": "int64" } }, "type": "NotificationSound" }, "getSavedNotificationSounds": { "description": "Returns the list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used", "args": {}, "type": "NotificationSounds" }, "getSavedOrderInfo": { "description": "Returns saved order information. Returns a 404 error if there is no saved order information", "args": {}, "type": "OrderInfo" }, "getScopeNotificationSettings": { "description": "Returns the notification settings for chats of a given type", "args": { "scope": { "description": "Types of chats for which to return the notification settings information", "is_optional": false, "type": "NotificationSettingsScope" } }, "type": "ScopeNotificationSettings" }, "getSearchSponsoredChats": { "description": "Returns sponsored chats to be shown in the search results", "args": { "query": { "description": "Query the user searches for", "is_optional": false, "type": "string" } }, "type": "SponsoredChats" }, "getSearchedForTags": { "description": "Returns recently searched for hashtags or cashtags by their prefix", "args": { "limit": { "description": "The maximum number of items to be returned", "is_optional": false, "type": "int32" }, "tag_prefix": { "description": "Prefix of hashtags or cashtags to return", "is_optional": false, "type": "string" } }, "type": "Hashtags" }, "getSecretChat": { "description": "Returns information about a secret chat by its identifier. This is an offline method", "args": { "secret_chat_id": { "description": "Secret chat identifier", "is_optional": false, "type": "int32" } }, "type": "SecretChat" }, "getStakeDiceState": { "description": "Returns the current state of stake dice", "args": {}, "type": "StakeDiceState" }, "getStarAdAccountUrl": { "description": "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", "args": { "owner_id": { "description": "Identifier of the owner of the Telegram Stars; can be identifier of an owned bot, or identifier of an owned channel chat", "is_optional": false, "type": "MessageSender" } }, "type": "HttpUrl" }, "getStarGiftPaymentOptions": { "description": "Returns available options for Telegram Stars gifting", "args": { "user_id": { "description": "Identifier of the user who will receive Telegram Stars; pass 0 to get options for an unspecified user", "is_optional": false, "type": "int53" } }, "type": "StarPaymentOptions" }, "getStarGiveawayPaymentOptions": { "description": "Returns available options for Telegram Star giveaway creation", "args": {}, "type": "StarGiveawayPaymentOptions" }, "getStarPaymentOptions": { "description": "Returns available options for Telegram Stars purchase", "args": {}, "type": "StarPaymentOptions" }, "getStarRevenueStatistics": { "description": "Returns detailed Telegram Star revenue statistics", "args": { "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" }, "owner_id": { "description": "Identifier of the owner of the Telegram Stars; can be identifier of the current user, an owned bot, or a supergroup or a channel chat with supergroupFullInfo.can_get_star_revenue_statistics == true", "is_optional": false, "type": "MessageSender" } }, "type": "StarRevenueStatistics" }, "getStarSubscriptions": { "description": "Returns the list of Telegram Star subscriptions for the current user", "args": { "offset": { "description": "Offset of the first subscription to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "only_expiring": { "description": "Pass true to receive only expiring subscriptions for which there aren't enough Telegram Stars to extend", "is_optional": false, "type": "Bool" } }, "type": "StarSubscriptions" }, "getStarTransactions": { "description": "Returns the list of Telegram Star transactions for the specified owner", "args": { "direction": { "description": "Direction of the transactions to receive; pass null to get all transactions", "is_optional": true, "type": "TransactionDirection" }, "limit": { "description": "The maximum number of transactions to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first transaction to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "owner_id": { "description": "Identifier of the owner of the Telegram Stars; can be the identifier of the current user, identifier of an owned bot,", "is_optional": false, "type": "MessageSender" }, "subscription_id": { "description": "If non-empty, only transactions related to the Star Subscription will be returned", "is_optional": true, "type": "string" } }, "type": "StarTransactions" }, "getStarWithdrawalUrl": { "description": "Returns a URL for Telegram Star withdrawal", "args": { "owner_id": { "description": "Identifier of the owner of the Telegram Stars; can be identifier of the current user, an owned bot, or an owned supergroup or channel chat", "is_optional": false, "type": "MessageSender" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" }, "star_count": { "description": "The number of Telegram Stars to withdraw; must be between getOption(\"star_withdrawal_count_min\") and getOption(\"star_withdrawal_count_max\")", "is_optional": false, "type": "int53" } }, "type": "HttpUrl" }, "getStatisticalGraph": { "description": "Loads an asynchronous or a zoomed in statistical graph", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "token": { "description": "The token for graph loading", "is_optional": false, "type": "string" }, "x": { "description": "X-value for zoomed in graph or 0 otherwise", "is_optional": false, "type": "int53" } }, "type": "StatisticalGraph" }, "getStickerEmojis": { "description": "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", "args": { "sticker": { "description": "Sticker file identifier", "is_optional": false, "type": "InputFile" } }, "type": "Emojis" }, "getStickerOutline": { "description": "Returns outline of a sticker. This is an offline method. Returns a 404 error if the outline isn't known", "args": { "for_animated_emoji": { "description": "Pass true to get the outline scaled for animated emoji", "is_optional": false, "type": "Bool" }, "for_clicked_animated_emoji_message": { "description": "Pass true to get the outline scaled for clicked animated emoji message", "is_optional": false, "type": "Bool" }, "sticker_file_id": { "description": "File identifier of the sticker", "is_optional": false, "type": "int32" } }, "type": "Outline" }, "getStickerOutlineSvgPath": { "description": "Returns outline of a sticker as an SVG path. This is an offline method. Returns an empty string if the outline isn't known", "args": { "for_animated_emoji": { "description": "Pass true to get the outline scaled for animated emoji", "is_optional": false, "type": "Bool" }, "for_clicked_animated_emoji_message": { "description": "Pass true to get the outline scaled for clicked animated emoji message", "is_optional": false, "type": "Bool" }, "sticker_file_id": { "description": "File identifier of the sticker", "is_optional": false, "type": "int32" } }, "type": "Text" }, "getStickerSet": { "description": "Returns information about a sticker set by its identifier", "args": { "set_id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" } }, "type": "StickerSet" }, "getStickerSetName": { "description": "Returns name of a sticker set by its identifier", "args": { "set_id": { "description": "Identifier of the sticker set", "is_optional": false, "type": "int64" } }, "type": "Text" }, "getStickers": { "description": "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", "args": { "chat_id": { "description": "Chat identifier for which to return stickers. Available custom emoji stickers may be different for different chats", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of stickers to be returned", "is_optional": false, "type": "int32" }, "query": { "description": "Search query; a space-separated list of emojis or a keyword prefix. If empty, returns all known installed stickers", "is_optional": false, "type": "string" }, "sticker_type": { "description": "Type of the stickers to return", "is_optional": false, "type": "StickerType" } }, "type": "Stickers" }, "getStorageStatistics": { "description": "Returns storage usage statistics. Can be called before authorization", "args": { "chat_limit": { "description": "The maximum number of chats with the largest storage usage for which separate statistics need to be returned. All other chats will be grouped in entries with chat_id == 0. If the chat info database is not used, the chat_limit is ignored and is always set to 0", "is_optional": false, "type": "int32" } }, "type": "StorageStatistics" }, "getStorageStatisticsFast": { "description": "Quickly returns approximate storage usage statistics. Can be called before authorization", "args": {}, "type": "StorageStatisticsFast" }, "getStory": { "description": "Returns a story", "args": { "only_local": { "description": "Pass true to get only locally available information without sending network requests", "is_optional": false, "type": "Bool" }, "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Story" }, "getStoryAlbumStories": { "description": "Returns the list of stories added to the given story album. For optimal performance, the number of returned stories is chosen by TDLib", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of stories to be returned. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return; use 0 to get results from the first album story", "is_optional": false, "type": "int32" }, "story_album_id": { "description": "Story album identifier", "is_optional": false, "type": "int32" } }, "type": "Stories" }, "getStoryAvailableReactions": { "description": "Returns reactions, which can be chosen for a story", "args": { "row_size": { "description": "Number of reaction per row, 5-25", "is_optional": false, "type": "int32" } }, "type": "AvailableReactions" }, "getStoryInteractions": { "description": "Returns interactions with a story. The method can be called only for stories posted on behalf of the current user", "args": { "limit": { "description": "The maximum number of story interactions to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "only_contacts": { "description": "Pass true to get only interactions by contacts; pass false to get all relevant interactions", "is_optional": false, "type": "Bool" }, "prefer_forwards": { "description": "Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date", "is_optional": false, "type": "Bool" }, "prefer_with_reaction": { "description": "Pass true to get interactions with reaction first; pass false to get interactions sorted just by interaction date. Ignored if prefer_forwards == true", "is_optional": false, "type": "Bool" }, "query": { "description": "Query to search for in names, usernames and titles; may be empty to get all relevant interactions", "is_optional": true, "type": "string" }, "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" } }, "type": "StoryInteractions" }, "getStoryNotificationSettingsExceptions": { "description": "Returns the list of chats with non-default notification settings for stories", "args": {}, "type": "Chats" }, "getStoryPublicForwards": { "description": "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.", "args": { "limit": { "description": "The maximum number of messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story", "is_optional": false, "type": "int53" } }, "type": "PublicForwards" }, "getStoryStatistics": { "description": "Returns detailed statistics about a story. Can be used only if story.can_get_statistics == true", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_dark": { "description": "Pass true if a dark theme is used by the application", "is_optional": false, "type": "Bool" }, "story_id": { "description": "Story identifier", "is_optional": false, "type": "int32" } }, "type": "StoryStatistics" }, "getSuggestedFileName": { "description": "Returns suggested name for saving a file in a given directory", "args": { "directory": { "description": "Directory in which the file is expected to be saved", "is_optional": false, "type": "string" }, "file_id": { "description": "Identifier of the file", "is_optional": false, "type": "int32" } }, "type": "Text" }, "getSuggestedStickerSetName": { "description": "Returns a suggested name for a new sticker set with a given title", "args": { "title": { "description": "Sticker set title; 1-64 characters", "is_optional": false, "type": "string" } }, "type": "Text" }, "getSuitableDiscussionChats": { "description": "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.", "args": {}, "type": "Chats" }, "getSuitablePersonalChats": { "description": "Returns a list of channel chats, which can be used as a personal chat", "args": {}, "type": "Chats" }, "getSupergroup": { "description": "Returns information about a supergroup or a channel by its identifier. This is an offline method if the current user is not a bot", "args": { "supergroup_id": { "description": "Supergroup or channel identifier", "is_optional": false, "type": "int53" } }, "type": "Supergroup" }, "getSupergroupFullInfo": { "description": "Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute", "args": { "supergroup_id": { "description": "Supergroup or channel identifier", "is_optional": false, "type": "int53" } }, "type": "SupergroupFullInfo" }, "getSupergroupMembers": { "description": "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", "args": { "filter": { "description": "The type of users to return; pass null to use supergroupMembersFilterRecent", "is_optional": true, "type": "SupergroupMembersFilter" }, "limit": { "description": "The maximum number of users to be returned; up to 200", "is_optional": false, "type": "int32" }, "offset": { "description": "Number of users to skip", "is_optional": false, "type": "int32" }, "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" } }, "type": "ChatMembers" }, "getSupportName": { "description": "Returns localized name of the Telegram support user; for Telegram support only", "args": {}, "type": "Text" }, "getSupportUser": { "description": "Returns a user who can be contacted to get support", "args": {}, "type": "User" }, "getTemporaryPasswordState": { "description": "Returns information about the current temporary password", "args": {}, "type": "TemporaryPasswordState" }, "getTextCompositionStyleExample": { "description": "Returns an example of usage of a custom text composition style", "args": { "example_number": { "description": "0-based unique number of the requested example; must be non-negative and less than getOption(\"text_composition_style_example_count\")", "is_optional": false, "type": "int32" }, "name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "TextCompositionStyleExample" }, "getTextEntities": { "description": "Returns all entities (mentions, hashtags, cashtags, bot commands, bank card numbers, TON blockchain addresses, URLs, and email addresses) found in the text. Can be called synchronously", "args": { "text": { "description": "The text in which to look for entities", "is_optional": false, "type": "string" } }, "type": "TextEntities" }, "getThemeParametersJsonString": { "description": "Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously", "args": { "theme": { "description": "Theme parameters to convert to JSON", "is_optional": false, "type": "themeParameters" } }, "type": "Text" }, "getThemedChatEmojiStatuses": { "description": "Returns up to 8 emoji statuses, which must be shown in the emoji status list for chats", "args": {}, "type": "EmojiStatusCustomEmojis" }, "getThemedEmojiStatuses": { "description": "Returns up to 8 emoji statuses, which must be shown right after the default Premium Badge in the emoji status list for self status", "args": {}, "type": "EmojiStatusCustomEmojis" }, "getTimeZones": { "description": "Returns the list of supported time zones", "args": {}, "type": "TimeZones" }, "getTonCenterStreamingApiUrl": { "description": "Returns a URL for TON Center Streaming API", "args": {}, "type": "TonCenterStreamingApiUrl" }, "getTonConnectDAppPendingRequests": { "description": "Returns pending requests with a dApp through TON Connect", "args": { "dapp_client_id": { "description": "Hex-encoded public X25519 key of the dApp", "is_optional": false, "type": "string" } }, "type": "TonConnectRequests" }, "getTonConnectSessionNextEventId": { "description": "Returns the next event identifier for the given TON Connect session", "args": { "session_id": { "description": "Unique identifier of the TON Connect session", "is_optional": false, "type": "int64" } }, "type": "TonConnectSessionEventId" }, "getTonConnectSessionPendingRequests": { "description": "Returns pending requests in a TON Connect session", "args": { "session_id": { "description": "Unique identifier of the session", "is_optional": false, "type": "int64" } }, "type": "TonConnectRequests" }, "getTonConnectSessions": { "description": "Returns active TON Connect sessions; can be used only if getOption(\"can_use_ton_wallet\")", "args": {}, "type": "TonConnectSessions" }, "getTonTransactions": { "description": "Returns the list of TON Gram transactions of the current user", "args": { "direction": { "description": "Direction of the transactions to receive; pass null to get all transactions", "is_optional": true, "type": "TransactionDirection" }, "limit": { "description": "The maximum number of transactions to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first transaction to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "TonTransactions" }, "getTonWalletNfts": { "description": "Returns NFTs stored on the TON wallet of the user; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "limit": { "description": "The maximum number of NFTs to be returned; must be positive and can't be greater than 20", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "TonNfts" }, "getTonWalletOwnershipProofChallenge": { "description": "Returns a challenge which may be used to proof ownership of a TON wallet; can be used only if getOption(\"can_use_ton_wallet\")", "args": {}, "type": "TonWalletOwnershipProofChallenge" }, "getTonWalletSecretPhrase": { "description": "Returns the secret phrase of the user's TON wallet as a space separated list of words. Works only if tonWalletState.can_export_phrase is true", "args": { "password": { "description": "Password of the current user; pass an empty string unless receive an error with a message \"PASSWORD_MISSING\" for a passwordless request", "is_optional": false, "type": "string" } }, "type": "Text" }, "getTonWalletTransaction": { "description": "Returns a TON wallet transaction by their identifier", "args": { "transaction_id": { "description": "Identifier of the transaction", "is_optional": false, "type": "string" } }, "type": "TonWalletTransaction" }, "getTonWalletTransactionByMsgHash": { "description": "Returns a TON wallet transaction by their msg_hash; return an error if the transaction isn't finalized yet", "args": { "msg_hash": { "description": "Value of msg_hash of the transaction", "is_optional": false, "type": "string" } }, "type": "TonWalletTransaction" }, "getTonWalletTransactions": { "description": "Returns the list of TON wallet transactions of the current user; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "direction": { "description": "Direction of the transactions to receive; pass null to get all transactions", "is_optional": true, "type": "TransactionDirection" }, "limit": { "description": "The maximum number of transactions to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first transaction to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "TonWalletTransactions" }, "getTopChats": { "description": "Returns a list of frequently used chats", "args": { "category": { "description": "Category of chats to be returned", "is_optional": false, "type": "TopChatCategory" }, "limit": { "description": "The maximum number of chats to be returned; up to 30", "is_optional": false, "type": "int32" } }, "type": "Chats" }, "getTrendingStickerSets": { "description": "Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib", "args": { "limit": { "description": "The maximum number of sticker sets to be returned; up to 100. For optimal performance, the number of returned sticker sets is chosen by TDLib and can be smaller than the specified limit, even if the end of the list has not been reached", "is_optional": false, "type": "int32" }, "offset": { "description": "The offset from which to return the sticker sets; must be non-negative", "is_optional": false, "type": "int32" }, "sticker_type": { "description": "Type of the sticker sets to return", "is_optional": false, "type": "StickerType" } }, "type": "TrendingStickerSets" }, "getUpgradedGift": { "description": "Returns information about an upgraded gift by its name", "args": { "name": { "description": "Unique name of the upgraded gift", "is_optional": false, "type": "string" } }, "type": "UpgradedGift" }, "getUpgradedGiftEmojiStatuses": { "description": "Returns available upgraded gift emoji statuses for self status", "args": {}, "type": "EmojiStatuses" }, "getUpgradedGiftValueInfo": { "description": "Returns information about value of an upgraded gift by its name", "args": { "name": { "description": "Unique name of the upgraded gift", "is_optional": false, "type": "string" } }, "type": "UpgradedGiftValueInfo" }, "getUpgradedGiftVariants": { "description": "Returns all possible variants of upgraded gifts for a regular gift", "args": { "regular_gift_id": { "description": "Identifier of the regular gift", "is_optional": false, "type": "int64" }, "return_craft_models": { "description": "Pass true to get models that can be obtained by crafting a gift from upgraded gifts", "is_optional": false, "type": "Bool" }, "return_upgrade_models": { "description": "Pass true to get models that can be obtained by upgrading a regular gift", "is_optional": false, "type": "Bool" } }, "type": "GiftUpgradeVariants" }, "getUpgradedGiftWithdrawalUrl": { "description": "Returns a URL for upgraded gift withdrawal in the TON blockchain as an NFT; requires owner privileges for gifts owned by a chat", "args": { "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" }, "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" } }, "type": "HttpUrl" }, "getUpgradedGiftsPromotionalAnimation": { "description": "Returns promotional animation for upgraded gifts", "args": {}, "type": "Animation" }, "getUser": { "description": "Returns information about a user by their identifier. This is an offline method if the current user is not a bot", "args": { "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "User" }, "getUserChatBoosts": { "description": "Returns the list of boosts applied to a chat by a given user; requires administrator rights in the chat; for bots only", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "FoundChatBoosts" }, "getUserFullInfo": { "description": "Returns full information about a user by their identifier", "args": { "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "UserFullInfo" }, "getUserLink": { "description": "Returns an HTTPS link, which can be used to get information about the current user", "args": {}, "type": "UserLink" }, "getUserPrivacySettingRules": { "description": "Returns the current privacy settings", "args": { "setting": { "description": "The privacy setting", "is_optional": false, "type": "UserPrivacySetting" } }, "type": "UserPrivacySettingRules" }, "getUserProfileAudios": { "description": "Returns the list of profile audio files of a user", "args": { "limit": { "description": "The maximum number of audio files to be returned; up to 100", "is_optional": false, "type": "int32" }, "offset": { "description": "The number of audio files to skip; must be non-negative", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Audios" }, "getUserProfilePhotos": { "description": "Returns the profile photos of a user. Personal and public photo aren't returned", "args": { "limit": { "description": "The maximum number of photos to be returned; up to 100", "is_optional": false, "type": "int32" }, "offset": { "description": "The number of photos to skip; must be non-negative", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "ChatPhotos" }, "getUserSupportInfo": { "description": "Returns support information for the given user; for Telegram support only", "args": { "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "UserSupportInfo" }, "getUserTonWalletAddresses": { "description": "Returns TON wallet addresses of the specified users; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "user_ids": { "description": "Identifiers of the users whose wallet addresses have to be returned. If a user has no TON wallet, it will be skipped in the result", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "UserTonWalletAddresses" }, "getVideoChatAvailableParticipants": { "description": "Returns the list of participant identifiers, on whose behalf a video chat in the chat can be joined", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "MessageSenders" }, "getVideoChatInviteLink": { "description": "Returns invite link to a video chat in a public chat", "args": { "can_self_unmute": { "description": "Pass true if the invite link needs to contain an invite hash, passing which to joinVideoChat would allow the invited user to unmute themselves. Requires groupCall.can_be_managed right", "is_optional": false, "type": "Bool" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "HttpUrl" }, "getVideoChatRtmpUrl": { "description": "Returns RTMP URL for streaming to the video chat of a chat; requires can_manage_video_chats administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "RtmpUrl" }, "getVideoMessageAdvertisements": { "description": "Returns advertisements to be shown while a video from a message is watched. Available only if messageProperties.can_get_video_advertisements", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "VideoMessageAdvertisements" }, "getWebAppLinkUrl": { "description": "Returns an HTTPS URL of a Web App to open after a link of the type internalLinkTypeWebApp is clicked", "args": { "allow_write_access": { "description": "Pass true if the current user allowed the bot to send them messages", "is_optional": false, "type": "Bool" }, "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat in which the link was clicked; pass 0 if none", "is_optional": false, "type": "int53" }, "parameters": { "description": "Parameters to use to open the Web App", "is_optional": false, "type": "webAppOpenParameters" }, "start_parameter": { "description": "Start parameter from internalLinkTypeWebApp", "is_optional": false, "type": "string" }, "web_app_short_name": { "description": "Short name of the Web App", "is_optional": false, "type": "string" } }, "type": "WebAppUrl" }, "getWebAppPlaceholder": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" } }, "type": "Outline" }, "getWebAppUrl": { "description": "Returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryResultsButtonTypeWebApp button", "args": { "bot_user_id": { "description": "Identifier of the target bot. If the bot is restricted for the current user, then show an error instead of calling the method", "is_optional": false, "type": "int53" }, "parameters": { "description": "Parameters to use to open the Web App", "is_optional": false, "type": "webAppOpenParameters" }, "url": { "description": "The URL from a keyboardButtonTypeWebApp button, inlineQueryResultsButtonTypeWebApp button, or an empty string when the bot is opened from the side menu", "is_optional": false, "type": "string" } }, "type": "WebAppUrl" }, "getWebPageInstantView": { "description": "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", "args": { "only_local": { "description": "Pass true to get only locally available information without sending network requests", "is_optional": false, "type": "Bool" }, "url": { "description": "The web page URL", "is_optional": false, "type": "string" } }, "type": "WebPageInstantView" }, "giftPremiumWithStars": { "description": "Allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only", "args": { "month_count": { "description": "Number of months the Telegram Premium subscription will be active for the user", "is_optional": false, "type": "int32" }, "star_count": { "description": "The number of Telegram Stars to pay for subscription", "is_optional": false, "type": "int53" }, "text": { "description": "Text to show to the user receiving Telegram Premium; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "Identifier of the user who will receive Telegram Premium", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "hideContactCloseBirthdays": { "description": "Hides the list of contacts that have close birthdays for 24 hours", "args": {}, "type": "Ok" }, "hideSuggestedAction": { "description": "Hides a suggested action", "args": { "action": { "description": "Suggested action to hide", "is_optional": false, "type": "SuggestedAction" } }, "type": "Ok" }, "importContacts": { "description": "Adds new contacts or edits existing contacts by their phone numbers; contacts' user identifiers are ignored", "args": { "contacts": { "description": "The list of contacts to import or edit", "is_optional": false, "type": "vector\u003cimportedContact\u003e" } }, "type": "ImportedContacts" }, "importMessages": { "description": "Imports messages exported from another application", "args": { "attached_files": { "description": "Files used in the imported messages. Only inputFileLocal and inputFileGenerated are supported. The files must not be previously uploaded", "is_optional": false, "type": "vector\u003cInputFile\u003e" }, "chat_id": { "description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info member right", "is_optional": false, "type": "int53" }, "message_file": { "description": "File with messages to import. Only inputFileLocal and inputFileGenerated are supported. The file must not be previously uploaded", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "increaseGiftAuctionBid": { "description": "Increases a bid for an auction gift without changing gift text and receiver", "args": { "gift_id": { "description": "Identifier of the gift to put the bid on", "is_optional": false, "type": "int64" }, "star_count": { "description": "The number of Telegram Stars to put in the bid", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "inviteGroupCallParticipant": { "description": "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.", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_video": { "description": "Pass true if the group call is a video call", "is_optional": false, "type": "Bool" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "InviteGroupCallParticipantResult" }, "inviteVideoChatParticipants": { "description": "Invites users to an active video chat. Sends a service message of the type messageInviteVideoChatParticipants to the chat bound to the group call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "user_ids": { "description": "User identifiers. At most 10 users can be invited simultaneously", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "isLoginEmailAddressRequired": { "description": "Checks whether the current user is required to set login email address", "args": {}, "type": "Ok" }, "isProfileAudio": { "description": "Checks whether a file is in the profile audio files of the current user. Returns a 404 error if it isn't", "args": { "file_id": { "description": "Identifier of the audio file to check", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "joinChat": { "description": "Adds the current user as a new member to a chat. Private and secret chats can't be joined using this method", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatJoinResult" }, "joinChatByInviteLink": { "description": "Uses an invite link to add the current user to the chat if possible", "args": { "invite_link": { "description": "Invite link to use", "is_optional": false, "type": "string" } }, "type": "ChatJoinResult" }, "joinGroupCall": { "description": "Joins a regular group call that is not bound to a chat", "args": { "input_group_call": { "description": "The group call to join", "is_optional": false, "type": "InputGroupCall" }, "join_parameters": { "description": "Parameters to join the call", "is_optional": false, "type": "groupCallJoinParameters" } }, "type": "GroupCallInfo" }, "joinLiveStory": { "description": "Joins a group call of an active live story. Returns join response payload for tgcalls", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "join_parameters": { "description": "Parameters to join the call", "is_optional": false, "type": "groupCallJoinParameters" } }, "type": "Text" }, "joinVideoChat": { "description": "Joins an active video chat. Returns join response payload for tgcalls", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "invite_hash": { "description": "Invite hash as received from internalLinkTypeVideoChat", "is_optional": false, "type": "string" }, "join_parameters": { "description": "Parameters to join the call", "is_optional": false, "type": "groupCallJoinParameters" }, "participant_id": { "description": "Identifier of a group call participant, which will be used to join the call; pass null to join as self", "is_optional": true, "type": "MessageSender" } }, "type": "Text" }, "launchPrepaidGiveaway": { "description": "Launches a prepaid giveaway", "args": { "giveaway_id": { "description": "Unique identifier of the prepaid giveaway", "is_optional": false, "type": "int64" }, "parameters": { "description": "Giveaway parameters", "is_optional": false, "type": "giveawayParameters" }, "star_count": { "description": "The number of Telegram Stars to be distributed through the giveaway; pass 0 for Telegram Premium giveaways", "is_optional": false, "type": "int53" }, "winner_count": { "description": "The number of users to receive giveaway prize", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "leaveChat": { "description": "Removes the current user from chat members. Private and secret chats can't be left using this method", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "leaveGroupCall": { "description": "Leaves a group call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "listenToAudio": { "description": "Informs TDLib that an audio was listened by the user", "args": { "audio_file_id": { "description": "Identifier of the file with an audio", "is_optional": false, "type": "int32" }, "duration": { "description": "Duration of the listening to the audio, in seconds", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadActiveStories": { "description": "Loads more active stories from a story list. The loaded stories will be sent through updates. Active stories are sorted by", "args": { "story_list": { "description": "The story list in which to load active stories", "is_optional": false, "type": "StoryList" } }, "type": "Ok" }, "loadChatWelcomeMessages": { "description": "Loads welcome messages of a chat; requires can_send_welcome_messages administrator right in the chat. The loaded messages will be sent through updateChatWelcomeMessages", "args": { "chat_id": { "description": "The identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "loadChats": { "description": "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", "args": { "chat_list": { "description": "The chat list in which to load chats; pass null to load chats from the main chat list", "is_optional": true, "type": "ChatList" }, "limit": { "description": "The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadDirectMessagesChatTopics": { "description": "Loads more topics in a channel direct messages chat administered by the current user. The loaded topics will be sent through updateDirectMessagesChatTopic.", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of topics to be loaded. For optimal performance, the number of loaded topics is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadGroupCallParticipants": { "description": "Loads more participants of a group call; not supported in live stories. The loaded participants will be received through updates.", "args": { "group_call_id": { "description": "Group call identifier. The group call must be previously received through getGroupCall and must be joined or being joined", "is_optional": false, "type": "int32" }, "limit": { "description": "The maximum number of participants to load; up to 100", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadQuickReplyShortcutMessages": { "description": "Loads quick reply messages that can be sent by a given quick reply shortcut. The loaded messages will be sent through updateQuickReplyShortcutMessages", "args": { "shortcut_id": { "description": "Unique identifier of the quick reply shortcut", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadQuickReplyShortcuts": { "description": "Loads quick reply shortcuts created by the current user. The loaded data will be sent through updateQuickReplyShortcut and updateQuickReplyShortcuts", "args": {}, "type": "Ok" }, "loadSavedMessagesTopics": { "description": "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", "args": { "limit": { "description": "The maximum number of topics to be loaded. For optimal performance, the number of loaded topics is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "loadTonWalletGaslessTransfersInfo": { "description": "Loads or reloads the current state of gasless transfers for the current user; can be used only if getOption(\"can_use_ton_wallet\")", "args": {}, "type": "Ok" }, "loadTonWalletState": { "description": "Loads state of the TON wallet of the current user; can be used only if getOption(\"can_use_ton_wallet\")", "args": {}, "type": "Ok" }, "logOut": { "description": "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", "args": {}, "type": "Ok" }, "markChecklistTasksAsDone": { "description": "Adds tasks of a checklist in a message as done or not done", "args": { "chat_id": { "description": "Identifier of the chat with the message", "is_optional": false, "type": "int53" }, "marked_as_done_task_ids": { "description": "Identifiers of tasks that were marked as done", "is_optional": false, "type": "vector\u003cint32\u003e" }, "marked_as_not_done_task_ids": { "description": "Identifiers of tasks that were marked as not done", "is_optional": false, "type": "vector\u003cint32\u003e" }, "message_id": { "description": "Identifier of the message containing the checklist. Use messageProperties.can_mark_tasks_as_done to check whether the tasks can be marked as done or not done", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openBotSimilarBot": { "description": "Informs TDLib that a bot was opened from the list of similar bots", "args": { "bot_user_id": { "description": "Identifier of the original bot, which similar bots were requested", "is_optional": false, "type": "int53" }, "opened_bot_user_id": { "description": "Identifier of the opened bot", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openChat": { "description": "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)", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openChatSimilarChat": { "description": "Informs TDLib that a chat was opened from the list of similar chats. The method is independent of openChat and closeChat methods", "args": { "chat_id": { "description": "Identifier of the original chat, which similar chats were requested", "is_optional": false, "type": "int53" }, "opened_chat_id": { "description": "Identifier of the opened chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openGiftAuction": { "description": "Informs TDLib that a gift auction was opened by the user", "args": { "gift_id": { "description": "Identifier of the gift, which auction was opened", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "openMessageContent": { "description": "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).", "args": { "chat_id": { "description": "Chat identifier of the message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message with the opened content", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openSponsoredChat": { "description": "Informs TDLib that the user opened a sponsored chat", "args": { "sponsored_chat_unique_id": { "description": "Unique identifier of the sponsored chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openStory": { "description": "Informs TDLib that a story is opened and is being viewed by the user", "args": { "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the chat that posted the opened story", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "openWebApp": { "description": "Informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button.", "args": { "bot_user_id": { "description": "Identifier of the bot, providing the Web App. If the bot is restricted for the current user, then show an error instead of calling the method", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the chat in which the Web App is opened. The Web App can't be opened in secret chats", "is_optional": false, "type": "int53" }, "parameters": { "description": "Parameters to use to open the Web App", "is_optional": false, "type": "webAppOpenParameters" }, "reply_to": { "description": "Information about the message or story to be replied in the message sent by the Web App; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "topic_id": { "description": "Topic in which the message will be sent; pass null if none", "is_optional": true, "type": "MessageTopic" }, "url": { "description": "The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise", "is_optional": false, "type": "string" } }, "type": "WebAppInfo" }, "optimizeStorage": { "description": "Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted", "args": { "chat_ids": { "description": "If non-empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos)", "is_optional": true, "type": "vector\u003cint53\u003e" }, "chat_limit": { "description": "Same as in getStorageStatistics. Affects only returned statistics", "is_optional": false, "type": "int32" }, "count": { "description": "Limit on the total number of files after deletion. Pass -1 to use the default limit", "is_optional": false, "type": "int32" }, "exclude_chat_ids": { "description": "If non-empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos)", "is_optional": true, "type": "vector\u003cint53\u003e" }, "file_types": { "description": "If non-empty, only files with the given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted", "is_optional": true, "type": "vector\u003cFileType\u003e" }, "immunity_delay": { "description": "The amount of time after the creation of a file during which it can't be deleted, in seconds. Pass -1 to use the default value", "is_optional": false, "type": "int32" }, "return_deleted_file_statistics": { "description": "Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics. Affects only returned statistics", "is_optional": false, "type": "Bool" }, "size": { "description": "Limit on the total size of files after deletion, in bytes. Pass -1 to use the default limit", "is_optional": false, "type": "int53" }, "ttl": { "description": "Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems). Pass -1 to use the default limit", "is_optional": false, "type": "int32" } }, "type": "StorageStatistics" }, "parseMarkdown": { "description": "Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously", "args": { "text": { "description": "The text to parse. For example, \"__italic__ ~~strikethrough~~ ||spoiler|| **bold** `code` ```pre``` __[italic__ text_url](telegram.org) __italic**bold italic__bold**\"", "is_optional": false, "type": "formattedText" } }, "type": "FormattedText" }, "parseTextEntities": { "description": "Parses Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, ExpandableBlockQuote, Code, Pre, PreCode, TextUrl,", "args": { "parse_mode": { "description": "Text parse mode", "is_optional": false, "type": "TextParseMode" }, "text": { "description": "The text to parse", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "pinChatMessage": { "description": "Pins a message in a chat. A message can be pinned only if messageProperties.can_be_pinned", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "disable_notification": { "description": "Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the new pinned message", "is_optional": false, "type": "int53" }, "only_for_self": { "description": "Pass true to pin the message only for self; private chats only", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "pingProxy": { "description": "Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization", "args": { "proxy": { "description": "The proxy to test; pass null to ping a Telegram server without a proxy", "is_optional": true, "type": "proxy" } }, "type": "Seconds" }, "placeGiftAuctionBid": { "description": "Places a bid on an auction gift", "args": { "gift_id": { "description": "Identifier of the gift to place the bid on", "is_optional": false, "type": "int64" }, "is_private": { "description": "Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "star_count": { "description": "The number of Telegram Stars to place in the bid", "is_optional": false, "type": "int53" }, "text": { "description": "Text to show along with the gift; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "Identifier of the user who will receive the gift", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "postStory": { "description": "Posts a new story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats. Returns a temporary story", "args": { "active_period": { "description": "Period after which the story is moved to archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise", "is_optional": false, "type": "int32" }, "album_ids": { "description": "Identifiers of story albums to which the story will be added upon posting. An album can have up to getOption(\"story_album_size_max\") stories", "is_optional": false, "type": "vector\u003cint32\u003e" }, "areas": { "description": "Clickable rectangle areas to be shown on the story media; pass null if none", "is_optional": true, "type": "inputStoryAreas" }, "caption": { "description": "Story caption; pass null to use an empty caption; 0-getOption(\"story_caption_length_max\") characters; can have entities only if getOption(\"can_use_text_entities_in_story_caption\")", "is_optional": true, "type": "formattedText" }, "chat_id": { "description": "Identifier of the chat that will post the story. Pass Saved Messages chat identifier when posting a story on behalf of the current user", "is_optional": false, "type": "int53" }, "content": { "description": "Content of the story", "is_optional": false, "type": "InputStoryContent" }, "from_story_full_id": { "description": "Full identifier of the original story, which content was used to create the story; pass null if the story isn't repost of another story", "is_optional": true, "type": "storyFullId" }, "is_posted_to_chat_page": { "description": "Pass true to keep the story accessible after expiration", "is_optional": false, "type": "Bool" }, "privacy_settings": { "description": "The privacy settings for the story; ignored for stories posted on behalf of supergroup and channel chats", "is_optional": false, "type": "StoryPrivacySettings" }, "protect_content": { "description": "Pass true if the content of the story must be protected from forwarding and screenshotting", "is_optional": false, "type": "Bool" } }, "type": "Story" }, "preliminaryUploadFile": { "description": "Preliminarily 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.", "args": { "file": { "description": "File to upload", "is_optional": false, "type": "InputFile" }, "file_type": { "description": "File type; pass null if unknown", "is_optional": true, "type": "FileType" }, "priority": { "description": "Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first", "is_optional": false, "type": "int32" } }, "type": "File" }, "processChatFolderNewChats": { "description": "Process new chats added to a shareable chat folder by its owner", "args": { "added_chat_ids": { "description": "Identifiers of the new chats, which are added to the chat folder. The chats are automatically joined if they aren't joined yet", "is_optional": false, "type": "vector\u003cint53\u003e" }, "chat_folder_id": { "description": "Chat folder identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "processChatHasProtectedContentDisableRequest": { "description": "Processes request to disable has_protected_content in a chat", "args": { "approve": { "description": "Pass true to approve the request; pass false to reject the request", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "request_message_id": { "description": "Identifier of the message with the request. The message must be incoming and has content of the type messageChatHasProtectedContentDisableRequested", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "processChatJoinRequest": { "description": "Handles a pending join request in a chat", "args": { "approve": { "description": "Pass true to approve the request; pass false to decline it", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "user_id": { "description": "Identifier of the user who sent the request", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "processChatJoinRequests": { "description": "Handles all pending join requests for a given link in a chat", "args": { "approve": { "description": "Pass true to approve all requests; pass false to decline them", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link for which to process join requests. If empty, all join requests will be processed. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", "is_optional": false, "type": "string" } }, "type": "Ok" }, "processGiftPurchaseOffer": { "description": "Handles a pending gift purchase offer", "args": { "accept": { "description": "Pass true to accept the request; pass false to reject it", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message with the gift purchase offer", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "processPushNotification": { "description": "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", "args": { "payload": { "description": "JSON-encoded push notification payload with all fields sent by the server, and \"google.sent_time\" and \"google.notification.sound\" fields added", "is_optional": false, "type": "string" } }, "type": "Ok" }, "rateSpeechRecognition": { "description": "Rates recognized speech in a video note or a voice note message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "is_good": { "description": "Pass true if the speech recognition is good", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readAllChatMentions": { "description": "Marks all mentions in a chat as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readAllChatPollVotes": { "description": "Marks all poll votes in a chat as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readAllChatReactions": { "description": "Marks all reactions in a chat as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readAllDirectMessagesChatTopicReactions": { "description": "Removes all unread reactions in the topic in a channel direct messages chat administered by the current user", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Topic identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readAllForumTopicMentions": { "description": "Marks all mentions in a topic in a forum supergroup chat as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier in which mentions are marked as read", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "readAllForumTopicPollVotes": { "description": "Marks all poll votes in a topic in a forum supergroup chat as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier in which poll votes are marked as read", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "readAllForumTopicReactions": { "description": "Marks all reactions in a topic in a forum supergroup chat or a chat with a bot with topics as read", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier in which reactions are marked as read", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "readBusinessMessage": { "description": "Reads a message on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection through which the message was received", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "readChatList": { "description": "Traverses all chats in a chat list and marks all messages in the chats as read", "args": { "chat_list": { "description": "Chat list in which to mark all chats as read", "is_optional": false, "type": "ChatList" } }, "type": "Ok" }, "readFilePart": { "description": "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", "args": { "count": { "description": "Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position", "is_optional": false, "type": "int53" }, "file_id": { "description": "Identifier of the file. The file must be located in the TDLib file cache", "is_optional": false, "type": "int32" }, "offset": { "description": "The offset from which to read the file", "is_optional": false, "type": "int53" } }, "type": "Data" }, "readdQuickReplyShortcutMessages": { "description": "Re-adds 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.", "args": { "message_ids": { "description": "Identifiers of the quick reply messages to re-add. Message identifiers must be in a strictly increasing order", "is_optional": false, "type": "vector\u003cint53\u003e" }, "shortcut_name": { "description": "Name of the target shortcut", "is_optional": false, "type": "string" } }, "type": "QuickReplyMessages" }, "recognizeSpeech": { "description": "Recognizes speech in a video note or a voice note message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message. Use messageProperties.can_recognize_speech to check whether the message is suitable", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "recoverAuthenticationPassword": { "description": "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", "args": { "new_hint": { "description": "New password hint; may be empty", "is_optional": true, "type": "string" }, "new_password": { "description": "New 2-step verification password of the user; may be empty to remove the password", "is_optional": true, "type": "string" }, "recovery_code": { "description": "Recovery code to check", "is_optional": false, "type": "string" } }, "type": "Ok" }, "recoverPassword": { "description": "Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up", "args": { "new_hint": { "description": "New password hint; may be empty", "is_optional": true, "type": "string" }, "new_password": { "description": "New 2-step verification password of the user; may be empty to remove the password", "is_optional": true, "type": "string" }, "recovery_code": { "description": "Recovery code to check", "is_optional": false, "type": "string" } }, "type": "PasswordState" }, "refundStarPayment": { "description": "Refunds a previously done payment in Telegram Stars; for bots only", "args": { "telegram_payment_charge_id": { "description": "Telegram payment identifier", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user who did the payment", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "registerDevice": { "description": "Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription", "args": { "device_token": { "description": "Device token", "is_optional": false, "type": "DeviceToken" }, "other_user_ids": { "description": "List of user identifiers of other users currently using the application", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "PushReceiverId" }, "registerUser": { "description": "Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration", "args": { "disable_notification": { "description": "Pass true to disable notification about the current user joining Telegram for other users that added them to contact list", "is_optional": false, "type": "Bool" }, "first_name": { "description": "The first name of the user; 1-64 characters", "is_optional": false, "type": "string" }, "last_name": { "description": "The last name of the user; 0-64 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "removeAllFilesFromDownloads": { "description": "Removes all files from the file download list", "args": { "delete_from_cache": { "description": "Pass true to delete the file from the TDLib file cache", "is_optional": false, "type": "Bool" }, "only_active": { "description": "Pass true to remove only active downloads, including paused", "is_optional": false, "type": "Bool" }, "only_completed": { "description": "Pass true to remove only completed downloads", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "removeAllWebBrowserSettingsExceptions": { "description": "Removes special handling for the opening of all links", "args": {}, "type": "Ok" }, "removeBusinessConnectedBotFromChat": { "description": "Removes the connected business bot from a specific chat by adding the chat to businessRecipients.excluded_chat_ids", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "removeChatActionBar": { "description": "Removes a chat action bar without any other action", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "removeContacts": { "description": "Removes users from the contact list", "args": { "user_ids": { "description": "Identifiers of users to be deleted", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "removeFavoriteSticker": { "description": "Removes a sticker from the list of favorite stickers", "args": { "sticker": { "description": "Sticker file to delete from the list", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "removeFileFromDownloads": { "description": "Removes a file from the file download list", "args": { "delete_from_cache": { "description": "Pass true to delete the file from the TDLib file cache", "is_optional": false, "type": "Bool" }, "file_id": { "description": "Identifier of the downloaded file", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removeGiftCollectionGifts": { "description": "Removes gifts from a collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection", "args": { "collection_id": { "description": "Identifier of the gift collection", "is_optional": false, "type": "int32" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" }, "received_gift_ids": { "description": "Identifier of the gifts to remove from the collection", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "GiftCollection" }, "removeInstalledBackground": { "description": "Removes background from the list of installed backgrounds", "args": { "background_id": { "description": "The background identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "removeLoginPasskey": { "description": "Removes a passkey from the list of passkeys allowed to be used for the login by the current user", "args": { "passkey_id": { "description": "Unique identifier of the passkey to remove", "is_optional": false, "type": "string" } }, "type": "Ok" }, "removeMessageReaction": { "description": "Removes a reaction from a message. A chosen reaction can always be removed", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reaction_type": { "description": "Type of the reaction to remove. The paid reaction can't be removed", "is_optional": false, "type": "ReactionType" } }, "type": "Ok" }, "removeMessageSenderBotVerification": { "description": "Removes the verification status of a user or a chat by an owned bot", "args": { "bot_user_id": { "description": "Identifier of the owned bot, which verified the user or the chat", "is_optional": false, "type": "int53" }, "verified_id": { "description": "Identifier of the user or the supergroup or channel chat, which verification is removed", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "removeNotification": { "description": "Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user", "args": { "notification_group_id": { "description": "Identifier of notification group to which the notification belongs", "is_optional": false, "type": "int32" }, "notification_id": { "description": "Identifier of removed notification", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removeNotificationGroup": { "description": "Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user", "args": { "max_notification_id": { "description": "The maximum identifier of removed notifications", "is_optional": false, "type": "int32" }, "notification_group_id": { "description": "Notification group identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removePendingLiveStoryReactions": { "description": "Removes all pending paid reactions in a live story group call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removePendingPaidMessageReactions": { "description": "Removes all pending paid reactions on a message", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "removeProfileAudio": { "description": "Removes an audio file from the profile audio files of the current user", "args": { "file_id": { "description": "Identifier of the audio file to be removed", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removeProxy": { "description": "Removes a proxy server. Can be called before authorization", "args": { "proxy_id": { "description": "Proxy identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "removeRecentHashtag": { "description": "Removes a hashtag from the list of recently used hashtags", "args": { "hashtag": { "description": "Hashtag to delete", "is_optional": false, "type": "string" } }, "type": "Ok" }, "removeRecentSticker": { "description": "Removes a sticker from the list of recently used stickers", "args": { "is_attached": { "description": "Pass true to remove the sticker from the list of stickers recently attached to photo or video files; pass false to remove the sticker from the list of recently sent stickers", "is_optional": false, "type": "Bool" }, "sticker": { "description": "Sticker file to delete", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "removeRecentlyFoundChat": { "description": "Removes a chat from the list of recently found chats", "args": { "chat_id": { "description": "Identifier of the chat to be removed", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "removeSavedAnimation": { "description": "Removes an animation from the list of saved animations", "args": { "animation": { "description": "Animation file to be removed", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "removeSavedNotificationSound": { "description": "Removes a notification sound from the list of saved notification sounds", "args": { "notification_sound_id": { "description": "Identifier of the notification sound", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "removeSearchedForTag": { "description": "Removes a hashtag or a cashtag from the list of recently searched for hashtags or cashtags", "args": { "tag": { "description": "Hashtag or cashtag to delete", "is_optional": false, "type": "string" } }, "type": "Ok" }, "removeStickerFromSet": { "description": "Removes a sticker from the set to which it belongs. The sticker set must be owned by the current user", "args": { "sticker": { "description": "Sticker to remove from the set", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "removeStoryAlbumStories": { "description": "Removes stories from an album. If the album is owned by a supergroup or a channel chat, then", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "story_album_id": { "description": "Identifier of the story album", "is_optional": false, "type": "int32" }, "story_ids": { "description": "Identifier of the stories to remove from the album", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "StoryAlbum" }, "removeTextCompositionStyle": { "description": "Removes a custom text composition style from the list of used by the user styles. If the style was created by the current user, then it can only be deleted", "args": { "name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "Ok" }, "removeTopChat": { "description": "Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled", "args": { "category": { "description": "Category of frequently used chats", "is_optional": false, "type": "TopChatCategory" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "removeWebBrowserSettingsException": { "description": "Removes a special handling for the opening of the specified URL", "args": { "url": { "description": "URL of the website", "is_optional": false, "type": "string" } }, "type": "Ok" }, "reorderActiveUsernames": { "description": "Changes order of active usernames of the current user", "args": { "usernames": { "description": "The new order of active usernames. All currently active usernames must be specified", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Ok" }, "reorderBotActiveUsernames": { "description": "Changes order of active usernames of a bot. Can be called only if userTypeBot.can_be_edited == true", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "usernames": { "description": "The new order of active usernames. All currently active usernames must be specified", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Ok" }, "reorderBotMediaPreviews": { "description": "Changes order of media previews in the list of media previews of a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot. The bot must be owned and must have the main Web App", "is_optional": false, "type": "int53" }, "file_ids": { "description": "File identifiers of the media in the new order", "is_optional": false, "type": "vector\u003cint32\u003e" }, "language_code": { "description": "Language code of the media previews to reorder", "is_optional": false, "type": "string" } }, "type": "Ok" }, "reorderChatFolders": { "description": "Changes the order of chat folders", "args": { "chat_folder_ids": { "description": "Identifiers of chat folders in the new correct order", "is_optional": false, "type": "vector\u003cint32\u003e" }, "main_chat_list_position": { "description": "Position of the main chat list among chat folders, 0-based. Can be non-zero only for Premium users", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "reorderGiftCollectionGifts": { "description": "Changes order of gifts in a collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection", "args": { "collection_id": { "description": "Identifier of the gift collection", "is_optional": false, "type": "int32" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" }, "received_gift_ids": { "description": "Identifier of the gifts to move to the beginning of the collection. All other gifts are placed in the current order after the specified gifts", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "GiftCollection" }, "reorderGiftCollections": { "description": "Changes order of gift collections. If the collections are owned by a channel chat, then requires can_post_messages administrator right in the channel chat", "args": { "collection_ids": { "description": "New order of gift collections", "is_optional": false, "type": "vector\u003cint32\u003e" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "reorderInstalledStickerSets": { "description": "Changes the order of installed sticker sets", "args": { "sticker_set_ids": { "description": "Identifiers of installed sticker sets in the new correct order", "is_optional": false, "type": "vector\u003cint64\u003e" }, "sticker_type": { "description": "Type of the sticker sets to reorder", "is_optional": false, "type": "StickerType" } }, "type": "Ok" }, "reorderQuickReplyShortcuts": { "description": "Changes the order of quick reply shortcuts", "args": { "shortcut_ids": { "description": "The new order of quick reply shortcuts", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Ok" }, "reorderStoryAlbumStories": { "description": "Changes order of stories in an album. If the album is owned by a supergroup or a channel chat, then", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "story_album_id": { "description": "Identifier of the story album", "is_optional": false, "type": "int32" }, "story_ids": { "description": "Identifier of the stories to move to the beginning of the album. All other stories are placed in the current order after the specified stories", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "StoryAlbum" }, "reorderStoryAlbums": { "description": "Changes order of story albums. If the albums are owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "story_album_ids": { "description": "New order of story albums", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Ok" }, "reorderSupergroupActiveUsernames": { "description": "Changes order of active usernames of a supergroup or channel, requires owner privileges in the supergroup or channel", "args": { "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" }, "usernames": { "description": "The new order of active usernames. All currently active usernames must be specified", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Ok" }, "replaceLiveStoryRtmpUrl": { "description": "Replaces the current RTMP URL for streaming to a live story; requires owner privileges for channel chats", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "RtmpUrl" }, "replacePrimaryChatInviteLink": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "ChatInviteLink" }, "replaceStickerInSet": { "description": "Replaces existing sticker in a set. The function is equivalent to removeStickerFromSet, then addStickerToSet, then setStickerPositionInSet", "args": { "name": { "description": "Sticker set name. The sticker set must be owned by the current user", "is_optional": false, "type": "string" }, "new_sticker": { "description": "Sticker to add to the set", "is_optional": false, "type": "newSticker" }, "old_sticker": { "description": "Sticker to remove from the set", "is_optional": false, "type": "InputFile" }, "user_id": { "description": "Sticker set owner; ignored for regular users", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "replaceTonWallet": { "description": "Replaces the current TON wallet with another existing v6r2 wallet or changes private key of the current TON wallet; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "anchor_public_key": { "description": "Original public key of the new TON wallet", "is_optional": false, "type": "bytes" }, "password": { "description": "Password of the current user; pass an empty string unless receive an error with a message \"PASSWORD_MISSING\" for a passwordless request", "is_optional": false, "type": "string" }, "proof": { "description": "Proof of ownership of the new private key of the TON wallet; use getTonWalletOwnershipProofChallenge to get a challenge for the proof", "is_optional": false, "type": "tonWalletOwnershipProof" } }, "type": "Ok" }, "replaceVideoChatRtmpUrl": { "description": "Replaces the current RTMP URL for streaming to the video chat of a chat; requires owner privileges in the chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "RtmpUrl" }, "replyToCallbackQueryWithEphemeralMessage": { "description": "Replies to a callback query with an ephemeral message; for bots only", "args": { "callback_query_id": { "description": "Identifier of the callback query", "is_optional": false, "type": "int64" }, "input_message_content": { "description": "New content of the message. Must be one of the following types: inputMessageText, inputMessageAnimation,", "is_optional": false, "type": "InputMessageContent" }, "protect_content": { "description": "Pass true if the content of the message must be protected from forwarding and saving", "is_optional": false, "type": "Bool" }, "replace_callback_query_message": { "description": "Pass true if the ephemeral message must replace the message from which the callback query originated", "is_optional": false, "type": "Bool" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "reportAuthenticationCodeMissing": { "description": "Reports that authentication code wasn't delivered via SMS; for official mobile applications only. Works only when the current authorization state is authorizationStateWaitCode", "args": { "mobile_network_code": { "description": "Current mobile network code", "is_optional": false, "type": "string" } }, "type": "Ok" }, "reportChat": { "description": "Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, if chat.can_be_reported, or if messageProperties.can_report_chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_ids": { "description": "Identifiers of reported messages. Use messageProperties.can_report_chat to check whether the message can be reported", "is_optional": false, "type": "vector\u003cint53\u003e" }, "option_id": { "description": "Option identifier chosen by the user; leave empty for the initial request", "is_optional": false, "type": "bytes" }, "text": { "description": "Additional report details if asked by the server; 0-1024 characters; leave empty for the initial request", "is_optional": false, "type": "string" } }, "type": "ReportChatResult" }, "reportChatPhoto": { "description": "Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "file_id": { "description": "Identifier of the photo to report. Only full photos from chatPhoto can be reported", "is_optional": false, "type": "int32" }, "reason": { "description": "The reason for reporting the chat photo", "is_optional": false, "type": "ReportReason" }, "text": { "description": "Additional report details; 0-1024 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "reportChatSponsoredMessage": { "description": "Reports a sponsored message to Telegram moderators", "args": { "chat_id": { "description": "Chat identifier of the sponsored message", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the sponsored message", "is_optional": false, "type": "int53" }, "option_id": { "description": "Option identifier chosen by the user; leave empty for the initial request", "is_optional": false, "type": "bytes" } }, "type": "ReportSponsoredResult" }, "reportMessageReactions": { "description": "Reports reactions set on a message to the Telegram moderators. Reactions on a message can be reported only if messageProperties.can_report_reactions", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_id": { "description": "Message identifier", "is_optional": false, "type": "int53" }, "sender_id": { "description": "Identifier of the sender, which added the reaction", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "reportPhoneNumberCodeMissing": { "description": "Reports that authentication code wasn't delivered via SMS to the specified phone number; for official mobile applications only", "args": { "mobile_network_code": { "description": "Current mobile network code", "is_optional": false, "type": "string" } }, "type": "Ok" }, "reportSponsoredChat": { "description": "Reports a sponsored chat to Telegram moderators", "args": { "option_id": { "description": "Option identifier chosen by the user; leave empty for the initial request", "is_optional": false, "type": "bytes" }, "sponsored_chat_unique_id": { "description": "Unique identifier of the sponsored chat", "is_optional": false, "type": "int53" } }, "type": "ReportSponsoredResult" }, "reportStory": { "description": "Reports a story to the Telegram moderators", "args": { "option_id": { "description": "Option identifier chosen by the user; leave empty for the initial request", "is_optional": false, "type": "bytes" }, "story_id": { "description": "The identifier of the story to report", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story to report", "is_optional": false, "type": "int53" }, "text": { "description": "Additional report details; 0-1024 characters; leave empty for the initial request", "is_optional": false, "type": "string" } }, "type": "ReportStoryResult" }, "reportSupergroupAntiSpamFalsePositive": { "description": "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", "args": { "message_id": { "description": "Identifier of the erroneously deleted message from chatEventMessageDeleted", "is_optional": false, "type": "int53" }, "supergroup_id": { "description": "Supergroup identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "reportSupergroupSpam": { "description": "Reports messages in a supergroup as spam; requires administrator rights in the supergroup", "args": { "message_ids": { "description": "Identifiers of messages to report. Use messageProperties.can_report_supergroup_spam to check whether the message can be reported", "is_optional": false, "type": "vector\u003cint53\u003e" }, "supergroup_id": { "description": "Supergroup identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "reportVideoMessageAdvertisement": { "description": "Reports a video message advertisement to Telegram moderators", "args": { "advertisement_unique_id": { "description": "Unique identifier of the advertisement", "is_optional": false, "type": "int53" }, "option_id": { "description": "Option identifier chosen by the user; leave empty for the initial request", "is_optional": false, "type": "bytes" } }, "type": "ReportSponsoredResult" }, "requestAuthenticationPasswordRecovery": { "description": "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", "args": {}, "type": "Ok" }, "requestPasswordRecovery": { "description": "Requests to send a 2-step verification password recovery code to an email address that was previously set up", "args": {}, "type": "EmailAddressAuthenticationCodeInfo" }, "requestQrCodeAuthentication": { "description": "Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber,", "args": { "other_user_ids": { "description": "List of user identifiers of other users currently using the application", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "resendAuthenticationCode": { "description": "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", "args": { "reason": { "description": "Reason of code resending; pass null if unknown", "is_optional": true, "type": "ResendCodeReason" } }, "type": "Ok" }, "resendEmailAddressVerificationCode": { "description": "Resends the code to verify an email address to be added to a user's Telegram Passport", "args": {}, "type": "EmailAddressAuthenticationCodeInfo" }, "resendLoginEmailAddressCode": { "description": "Resends the login email address verification code", "args": {}, "type": "EmailAddressAuthenticationCodeInfo" }, "resendMessages": { "description": "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.", "args": { "chat_id": { "description": "Identifier of the chat to send messages", "is_optional": false, "type": "int53" }, "message_ids": { "description": "Identifiers of the messages to resend. Message identifiers must be in a strictly increasing order", "is_optional": false, "type": "vector\u003cint53\u003e" }, "paid_message_star_count": { "description": "The number of Telegram Stars the user agreed to pay to send the messages. Ignored if messageSendingStateFailed.required_paid_message_star_count == 0", "is_optional": false, "type": "int53" }, "quote": { "description": "New manually chosen quote from the message to be replied; pass null if none. Ignored if more than one message is re-sent, or if messageSendingStateFailed.need_another_reply_quote == false", "is_optional": true, "type": "inputTextQuote" } }, "type": "Messages" }, "resendPhoneNumberCode": { "description": "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", "args": { "reason": { "description": "Reason of code resending; pass null if unknown", "is_optional": true, "type": "ResendCodeReason" } }, "type": "AuthenticationCodeInfo" }, "resendRecoveryEmailAddressCode": { "description": "Resends the 2-step verification recovery email address verification code", "args": {}, "type": "PasswordState" }, "resetAllNotificationSettings": { "description": "Resets all chat and scope notification settings to their default values. By default, all chats are unmuted and message previews are shown", "args": {}, "type": "Ok" }, "resetAuthenticationEmailAddress": { "description": "Resets the login email address. May return an error with a message \"TASK_ALREADY_EXISTS\" if reset is still pending.", "args": {}, "type": "Ok" }, "resetInstalledBackgrounds": { "description": "Resets list of installed backgrounds to its default value", "args": {}, "type": "Ok" }, "resetNetworkStatistics": { "description": "Resets all network data usage statistics to zero. Can be called before authorization", "args": {}, "type": "Ok" }, "resetPassword": { "description": "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", "args": {}, "type": "ResetPasswordResult" }, "reuseStarSubscription": { "description": "Reuses an active Telegram Star subscription to a channel chat and joins the chat again", "args": { "subscription_id": { "description": "Identifier of the subscription", "is_optional": false, "type": "string" } }, "type": "Ok" }, "revokeChatInviteLink": { "description": "Revokes invite link for a chat. Available in 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.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "invite_link": { "description": "Invite link to be revoked", "is_optional": false, "type": "string" } }, "type": "ChatInviteLinks" }, "revokeGroupCallInviteLink": { "description": "Revokes invite link for a group call. Requires groupCall.can_be_managed right for video chats or groupCall.is_owned otherwise", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "saveApplicationLogEvent": { "description": "Saves application log event on the server. Can be called before authorization", "args": { "chat_id": { "description": "Optional chat identifier, associated with the event", "is_optional": false, "type": "int53" }, "data": { "description": "The log event data", "is_optional": false, "type": "JsonValue" }, "type": { "description": "Event type", "is_optional": false, "type": "string" } }, "type": "Ok" }, "savePreparedInlineMessage": { "description": "Saves an inline message to be sent by the given user; for bots only", "args": { "chat_types": { "description": "Types of the chats to which the message can be sent", "is_optional": false, "type": "targetChatTypes" }, "result": { "description": "The description of the message", "is_optional": false, "type": "InputInlineQueryResult" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "PreparedInlineMessageId" }, "savePreparedKeyboardButton": { "description": "Saves a keyboard button to be shown to the given user; for bots only", "args": { "button": { "description": "The button; must be of the type keyboardButtonTypeRequestUsers, keyboardButtonTypeRequestChat, or keyboardButtonTypeRequestManagedBot", "is_optional": false, "type": "keyboardButton" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "Text" }, "searchAffiliatePrograms": { "description": "Searches affiliate programs that can be connected to the given affiliate", "args": { "affiliate": { "description": "The affiliate for which affiliate programs are searched for", "is_optional": false, "type": "AffiliateType" }, "limit": { "description": "The maximum number of affiliate programs to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first affiliate program to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "sort_order": { "description": "Sort order for the results", "is_optional": false, "type": "AffiliateProgramSortOrder" } }, "type": "FoundAffiliatePrograms" }, "searchBackground": { "description": "Searches for a background by its name", "args": { "name": { "description": "The name of the background", "is_optional": false, "type": "string" } }, "type": "Background" }, "searchCallMessages": { "description": "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", "args": { "limit": { "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "only_missed": { "description": "Pass true to search only for messages with missed/declined calls", "is_optional": false, "type": "Bool" } }, "type": "FoundMessages" }, "searchChatAffiliateProgram": { "description": "Searches a chat with an affiliate program. Returns the chat if found and the program is active", "args": { "referrer": { "description": "The referrer from an internalLinkTypeChatAffiliateProgram link", "is_optional": false, "type": "string" }, "username": { "description": "Username of the chat", "is_optional": false, "type": "string" } }, "type": "Chat" }, "searchChatMembers": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "filter": { "description": "The type of users to search for; pass null to search among all chat members", "is_optional": true, "type": "ChatMembersFilter" }, "limit": { "description": "The maximum number of users to be returned; up to 200", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "ChatMembers" }, "searchChatMessages": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat in which to search messages", "is_optional": false, "type": "int53" }, "filter": { "description": "Additional filter for messages to search; pass null to search for all messages", "is_optional": true, "type": "SearchMessagesFilter" }, "from_message_id": { "description": "Identifier of the message starting from which history must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number to get the specified message and some newer messages", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "sender_id": { "description": "Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats", "is_optional": true, "type": "MessageSender" }, "topic_id": { "description": "Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics", "is_optional": true, "type": "MessageTopic" } }, "type": "FoundChatMessages" }, "searchChatRecentLocationMessages": { "description": "Returns information about the recent live locations of chat members that were sent to the chat. Returns at most one live location message per user", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned", "is_optional": false, "type": "int32" } }, "type": "Messages" }, "searchChats": { "description": "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", "args": { "limit": { "description": "The maximum number of chats to be returned", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for. If the query is empty, returns up to 50 recently found chats", "is_optional": false, "type": "string" }, "type_filter": { "description": "Additional filter for type of the chats to be returned; pass null to search for chats of all types", "is_optional": true, "type": "SearchChatTypeFilter" } }, "type": "Chats" }, "searchChatsOnServer": { "description": "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", "args": { "limit": { "description": "The maximum number of chats to be returned", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "type_filter": { "description": "Additional filter for type of the chats to be returned; pass null to search for chats of all types", "is_optional": true, "type": "SearchChatTypeFilter" } }, "type": "Chats" }, "searchContacts": { "description": "Searches for the specified query in the first names, last names and usernames of the known user contacts", "args": { "limit": { "description": "The maximum number of users to be returned", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for; may be empty to return all contacts", "is_optional": true, "type": "string" } }, "type": "Users" }, "searchEmojis": { "description": "Searches for emojis by keywords. Supported only if the file database is enabled. Order of results is unspecified", "args": { "input_language_codes": { "description": "List of possible IETF language tags of the user's input language; may be empty if unknown", "is_optional": true, "type": "vector\u003cstring\u003e" }, "text": { "description": "Text to search for", "is_optional": false, "type": "string" } }, "type": "EmojiKeywords" }, "searchFileDownloads": { "description": "Searches for files in the file download list or recently downloaded files from the list", "args": { "limit": { "description": "The maximum number of files to be returned", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "only_active": { "description": "Pass true to search only for active downloads, including paused", "is_optional": false, "type": "Bool" }, "only_completed": { "description": "Pass true to search only for completed downloads", "is_optional": false, "type": "Bool" }, "query": { "description": "Query to search for; may be empty to return all downloaded files", "is_optional": true, "type": "string" } }, "type": "FoundFileDownloads" }, "searchGiftsForResale": { "description": "Returns upgraded gifts that can be bought from other owners using sendResoldGift", "args": { "attributes": { "description": "Attributes used to filter received gifts. If multiple attributes of the same type are specified, then all of them are allowed.", "is_optional": false, "type": "vector\u003cUpgradedGiftAttributeId\u003e" }, "for_crafting": { "description": "Pass true to get only gifts suitable for crafting", "is_optional": false, "type": "Bool" }, "for_stars": { "description": "Pass true to get only gifts that can be bought using Telegram Stars", "is_optional": false, "type": "Bool" }, "gift_id": { "description": "Identifier of the regular gift that was upgraded to a unique gift", "is_optional": false, "type": "int64" }, "limit": { "description": "The maximum number of gifts to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request with the same order and attributes; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "order": { "description": "Order in which the results will be sorted", "is_optional": false, "type": "GiftForResaleOrder" } }, "type": "GiftsForResale" }, "searchHashtags": { "description": "Searches for recently used hashtags by their prefix", "args": { "limit": { "description": "The maximum number of hashtags to be returned", "is_optional": false, "type": "int32" }, "prefix": { "description": "Hashtag prefix to search for", "is_optional": false, "type": "string" } }, "type": "Hashtags" }, "searchInstalledStickerSets": { "description": "Searches for installed sticker sets by looking for specified query in their title and name", "args": { "limit": { "description": "The maximum number of sticker sets to return", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "sticker_type": { "description": "Type of the sticker sets to search for", "is_optional": false, "type": "StickerType" } }, "type": "StickerSets" }, "searchMessages": { "description": "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)).", "args": { "chat_list": { "description": "Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported", "is_optional": true, "type": "ChatList" }, "chat_type_filter": { "description": "Additional filter for type of the chat of the searched messages; pass null to search for messages in all chats", "is_optional": true, "type": "SearchMessagesChatTypeFilter" }, "filter": { "description": "Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction,", "is_optional": true, "type": "SearchMessagesFilter" }, "limit": { "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "max_date": { "description": "If not 0, the maximum date of the messages to return", "is_optional": false, "type": "int32" }, "min_date": { "description": "If not 0, the minimum date of the messages to return", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" } }, "type": "FoundMessages" }, "searchOutgoingDocumentMessages": { "description": "Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the results in reverse chronological order", "args": { "limit": { "description": "The maximum number of messages to be returned; up to 100", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for in document file name and message caption", "is_optional": false, "type": "string" } }, "type": "FoundMessages" }, "searchPublicChat": { "description": "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", "args": { "username": { "description": "Username to be resolved", "is_optional": false, "type": "string" } }, "type": "Chat" }, "searchPublicChats": { "description": "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.", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "type_filter": { "description": "Additional filter for type of the chats to be returned; pass null to search for chats of all types", "is_optional": true, "type": "SearchChatTypeFilter" } }, "type": "Chats" }, "searchPublicMessagesByTag": { "description": "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", "args": { "limit": { "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "tag": { "description": "Hashtag or cashtag to search for", "is_optional": false, "type": "string" } }, "type": "FoundMessages" }, "searchPublicPosts": { "description": "Searches for public channel posts using the given query. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "args": { "limit": { "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "star_count": { "description": "The Telegram Star amount the user agreed to pay for the search; pass 0 for free searches", "is_optional": false, "type": "int53" } }, "type": "FoundPublicPosts" }, "searchPublicStoriesByLocation": { "description": "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", "args": { "address": { "description": "Address of the location", "is_optional": false, "type": "locationAddress" }, "limit": { "description": "The maximum number of stories to be returned; up to 100. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" } }, "type": "FoundStories" }, "searchPublicStoriesByTag": { "description": "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", "args": { "limit": { "description": "The maximum number of stories to be returned; up to 100. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the stories to search for; pass 0 to search stories in all chats", "is_optional": false, "type": "int53" }, "tag": { "description": "Hashtag or cashtag to search for", "is_optional": false, "type": "string" } }, "type": "FoundStories" }, "searchPublicStoriesByVenue": { "description": "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", "args": { "limit": { "description": "The maximum number of stories to be returned; up to 100. For optimal performance, the number of returned stories is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "venue_id": { "description": "Identifier of the venue in the provider database", "is_optional": false, "type": "string" }, "venue_provider": { "description": "Provider of the venue", "is_optional": false, "type": "string" } }, "type": "FoundStories" }, "searchQuote": { "description": "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", "args": { "quote": { "description": "Quote to search for", "is_optional": false, "type": "formattedText" }, "quote_position": { "description": "Approximate quote position in UTF-16 code units", "is_optional": false, "type": "int32" }, "text": { "description": "Text in which to search for the quote", "is_optional": false, "type": "formattedText" } }, "type": "FoundPosition" }, "searchRecentlyFoundChats": { "description": "Searches for the specified query in the title and username of up to 50 recently found chats. This is an offline method", "args": { "limit": { "description": "The maximum number of chats to be returned", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "type_filter": { "description": "Additional filter for type of the chats to be returned; pass null to search for chats of all types", "is_optional": true, "type": "SearchChatTypeFilter" } }, "type": "Chats" }, "searchSavedMessages": { "description": "Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only.", "args": { "from_message_id": { "description": "Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message", "is_optional": false, "type": "int53" }, "limit": { "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, then the limit must be greater than -offset.", "is_optional": false, "type": "int32" }, "offset": { "description": "Specify 0 to get results from exactly the message from_message_id or a negative number to get the specified message and some newer messages", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "saved_messages_topic_id": { "description": "If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages", "is_optional": false, "type": "int53" }, "tag": { "description": "Tag to search for; pass null to return all suitable messages", "is_optional": true, "type": "ReactionType" } }, "type": "FoundChatMessages" }, "searchSecretMessages": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat in which to search. Specify 0 to search in all secret chats", "is_optional": false, "type": "int53" }, "filter": { "description": "Additional filter for messages to search; pass null to search for all messages", "is_optional": true, "type": "SearchMessagesFilter" }, "limit": { "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "is_optional": false, "type": "int32" }, "offset": { "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results", "is_optional": false, "type": "string" }, "query": { "description": "Query to search for. If empty, searchChatMessages must be used instead", "is_optional": false, "type": "string" } }, "type": "FoundMessages" }, "searchStickerSet": { "description": "Searches for a sticker set by its name", "args": { "ignore_cache": { "description": "Pass true to ignore local cache of sticker sets and always send a network request", "is_optional": false, "type": "Bool" }, "name": { "description": "Name of the sticker set", "is_optional": false, "type": "string" } }, "type": "StickerSet" }, "searchStickerSets": { "description": "Searches for sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results", "args": { "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "sticker_type": { "description": "Type of the sticker sets to return", "is_optional": false, "type": "StickerType" } }, "type": "StickerSets" }, "searchStickers": { "description": "Searches for stickers from public sticker sets that correspond to any of the given emoji", "args": { "emojis": { "description": "Space-separated list of emojis to search for", "is_optional": false, "type": "string" }, "input_language_codes": { "description": "List of possible IETF language tags of the user's input language; may be empty if unknown", "is_optional": true, "type": "vector\u003cstring\u003e" }, "limit": { "description": "The maximum number of stickers to be returned; 0-100", "is_optional": false, "type": "int32" }, "offset": { "description": "The offset from which to return the stickers; must be non-negative", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for; may be empty to search for emoji only", "is_optional": true, "type": "string" }, "sticker_type": { "description": "Type of the stickers to return", "is_optional": false, "type": "StickerType" } }, "type": "Stickers" }, "searchStringsByPrefix": { "description": "Searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously", "args": { "limit": { "description": "The maximum number of objects to return", "is_optional": false, "type": "int32" }, "query": { "description": "Query to search for", "is_optional": false, "type": "string" }, "return_none_for_empty_query": { "description": "Pass true to receive no results for an empty query", "is_optional": false, "type": "Bool" }, "strings": { "description": "The strings to search in for the query", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "FoundPositions" }, "searchTextCompositionStyle": { "description": "Searches a custom text composition style by its name", "args": { "name": { "description": "Name of the style", "is_optional": false, "type": "string" } }, "type": "TextCompositionStyle" }, "searchUserByPhoneNumber": { "description": "Searches a user by their phone number. Returns a 404 error if the user can't be found", "args": { "only_local": { "description": "Pass true to get only locally available information without sending network requests", "is_optional": false, "type": "Bool" }, "phone_number": { "description": "Phone number to search for", "is_optional": false, "type": "string" } }, "type": "User" }, "searchUserByToken": { "description": "Searches a user by a token from the user's link", "args": { "token": { "description": "Token to search for", "is_optional": false, "type": "string" } }, "type": "User" }, "searchWebApp": { "description": "Returns information about a Web App by its short name. Returns a 404 error if the Web App is not found", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "web_app_short_name": { "description": "Short name of the Web App", "is_optional": false, "type": "string" } }, "type": "FoundWebApp" }, "sellGift": { "description": "Sells a gift for Telegram Stars; requires owner privileges for gifts owned by a chat", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request; for bots only", "is_optional": false, "type": "string" }, "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" } }, "type": "Ok" }, "sendAuthenticationFirebaseSms": { "description": "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", "args": { "token": { "description": "Play Integrity API or SafetyNet Attestation API token for the Android application, or secret from push notification for the iOS application", "is_optional": false, "type": "string" } }, "type": "Ok" }, "sendBotStartMessage": { "description": "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.", "args": { "bot_user_id": { "description": "Identifier of the bot", "is_optional": false, "type": "int53" }, "chat_id": { "description": "Identifier of the target chat", "is_optional": false, "type": "int53" }, "parameter": { "description": "A hidden parameter sent to the bot for deep linking purposes (https://core.telegram.org/bots#deep-linking)", "is_optional": false, "type": "string" } }, "type": "Message" }, "sendBusinessMessage": { "description": "Sends a message on behalf of a business account; for bots only. Returns the message after it was sent", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request", "is_optional": false, "type": "string" }, "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "disable_notification": { "description": "Pass true to disable notification for the message", "is_optional": false, "type": "Bool" }, "effect_id": { "description": "Identifier of the effect to apply to the message", "is_optional": false, "type": "int64" }, "input_message_content": { "description": "The content of the message to be sent", "is_optional": false, "type": "InputMessageContent" }, "protect_content": { "description": "Pass true if the content of the message must be protected from forwarding and saving", "is_optional": false, "type": "Bool" }, "reply_markup": { "description": "Markup for replying to the message; pass null if none", "is_optional": true, "type": "ReplyMarkup" }, "reply_to": { "description": "Information about the message to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" } }, "type": "BusinessMessage" }, "sendBusinessMessageAlbum": { "description": "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.", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request", "is_optional": false, "type": "string" }, "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "disable_notification": { "description": "Pass true to disable notification for the message", "is_optional": false, "type": "Bool" }, "effect_id": { "description": "Identifier of the effect to apply to the message", "is_optional": false, "type": "int64" }, "input_message_contents": { "description": "Contents of messages to be sent. At most 10 messages can be added to an album. All messages must have the same value of show_caption_above_media", "is_optional": false, "type": "vector\u003cInputMessageContent\u003e" }, "protect_content": { "description": "Pass true if the content of the message must be protected from forwarding and saving", "is_optional": false, "type": "Bool" }, "reply_to": { "description": "Information about the message to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" } }, "type": "BusinessMessages" }, "sendCallDebugInformation": { "description": "Sends debug information for a call to Telegram servers", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "InputCall" }, "debug_information": { "description": "Debug information in application-specific format", "is_optional": false, "type": "string" } }, "type": "Ok" }, "sendCallLog": { "description": "Sends log file for a call to Telegram servers", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "InputCall" }, "log_file": { "description": "Call log file. Only inputFileLocal and inputFileGenerated are supported", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "sendCallRating": { "description": "Sends a call rating", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "InputCall" }, "comment": { "description": "An optional user comment if the rating is less than 5", "is_optional": false, "type": "string" }, "problems": { "description": "List of the exact types of problems with the call, specified by the user", "is_optional": false, "type": "vector\u003cCallProblem\u003e" }, "rating": { "description": "Call rating; 1-5", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "sendCallSignalingData": { "description": "Sends call signaling data", "args": { "call_id": { "description": "Call identifier", "is_optional": false, "type": "int32" }, "data": { "description": "The data", "is_optional": false, "type": "bytes" } }, "type": "Ok" }, "sendChatAction": { "description": "Sends a notification about user activity in a chat", "args": { "action": { "description": "The action description; pass null to cancel the currently active action", "is_optional": true, "type": "ChatAction" }, "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request; for bots only", "is_optional": false, "type": "string" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Identifier of the topic in which the action is performed; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Ok" }, "sendCustomRequest": { "description": "Sends a custom request; for bots only", "args": { "method": { "description": "The method name", "is_optional": false, "type": "string" }, "parameters": { "description": "JSON-serialized method parameters", "is_optional": false, "type": "string" } }, "type": "CustomRequestResult" }, "sendEmailAddressVerificationCode": { "description": "Sends a code to verify an email address to be added to a user's Telegram Passport", "args": { "email_address": { "description": "Email address", "is_optional": false, "type": "string" } }, "type": "EmailAddressAuthenticationCodeInfo" }, "sendEphemeralMessage": { "description": "Sends an ephemeral message which will be received only by one bot in a chat. Currently, only ephemeral bot commands and replies to bot ephemeral messages can be sent using the method.", "args": { "callback_query_id": { "description": "Identifier of the callback query which triggered the message; for bots only", "is_optional": false, "type": "int64" }, "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation,", "is_optional": false, "type": "InputMessageContent" }, "only_preview": { "description": "Pass true to get a fake message instead of actually sending them", "is_optional": false, "type": "Bool" }, "protect_content": { "description": "Pass true if the content of the message must be protected from forwarding and saving; for bots only", "is_optional": false, "type": "Bool" }, "receiver_user_id": { "description": "Identifier of the user who will receive the message", "is_optional": false, "type": "int53" }, "replace_callback_query_message": { "description": "Pass true if the ephemeral message must replace the message from which the callback query originated; for bots only", "is_optional": false, "type": "Bool" }, "reply_markup": { "description": "Markup for replying to the message; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" }, "reply_to": { "description": "Information about the message to be replied; pass null if none. The message can be an incoming ephemeral message", "is_optional": true, "type": "InputMessageReplyTo" }, "sending_id": { "description": "Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates", "is_optional": false, "type": "int32" }, "topic_id": { "description": "Topic in which the message will be sent; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Message" }, "sendGift": { "description": "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", "args": { "gift_id": { "description": "Identifier of the gift to send", "is_optional": false, "type": "int64" }, "is_private": { "description": "Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "owner_id": { "description": "Identifier of the user or the channel chat that will receive the gift; limited gifts can't be sent to channel chats", "is_optional": false, "type": "MessageSender" }, "pay_for_upgrade": { "description": "Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free", "is_optional": false, "type": "Bool" }, "text": { "description": "Text to show along with the gift; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.", "is_optional": false, "type": "formattedText" } }, "type": "Ok" }, "sendGiftPurchaseOffer": { "description": "Sends an offer to purchase an upgraded gift", "args": { "duration": { "description": "Duration of the offer, in seconds; must be one of 21600, 43200, 86400, 129600, 172800, or 259200. Can also be 120 if Telegram test environment is used", "is_optional": false, "type": "int32" }, "gift_name": { "description": "Name of the upgraded gift", "is_optional": false, "type": "string" }, "owner_id": { "description": "Identifier of the user or the channel chat that currently owns the gift and will receive the offer", "is_optional": false, "type": "MessageSender" }, "paid_message_star_count": { "description": "The number of Telegram Stars the user agreed to pay additionally for sending of the offer message to the current gift owner; pass userFullInfo.outgoing_paid_message_star_count for users and 0 otherwise", "is_optional": false, "type": "int53" }, "price": { "description": "The price that the user agreed to pay for the gift", "is_optional": false, "type": "GiftResalePrice" } }, "type": "Ok" }, "sendGroupCallMessage": { "description": "Sends a message to other participants of a group call. Requires groupCall.can_send_messages right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "paid_message_star_count": { "description": "The number of Telegram Stars the user agreed to pay to send the message; for live stories only; 0-getOption(\"paid_group_call_message_star_count_max\").", "is_optional": false, "type": "int53" }, "text": { "description": "Text of the message to send; 1-getOption(\"group_call_message_text_length_max\") characters for non-live-stories; see updateGroupCallMessageLevels for live story restrictions,", "is_optional": false, "type": "formattedText" } }, "type": "Ok" }, "sendInlineQueryResultMessage": { "description": "Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message", "args": { "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "hide_via_bot": { "description": "Pass true to hide the bot, via which the message is sent. Can be used only for bots getOption(\"animation_search_bot_username\"), getOption(\"photo_search_bot_username\"), and getOption(\"venue_search_bot_username\")", "is_optional": false, "type": "Bool" }, "options": { "description": "Options to be used to send the message; pass null to use default options", "is_optional": true, "type": "messageSendOptions" }, "query_id": { "description": "Identifier of the inline query", "is_optional": false, "type": "int64" }, "reply_to": { "description": "Information about the message or story to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "result_id": { "description": "Identifier of the inline query result", "is_optional": false, "type": "string" }, "topic_id": { "description": "Topic in which the message will be sent; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Message" }, "sendMessage": { "description": "Sends a message. Returns the sent message", "args": { "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "input_message_content": { "description": "The content of the message to be sent", "is_optional": false, "type": "InputMessageContent" }, "options": { "description": "Options to be used to send the message; pass null to use default options", "is_optional": true, "type": "messageSendOptions" }, "reply_markup": { "description": "Markup for replying to the message; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" }, "reply_to": { "description": "Information about the message or story to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "topic_id": { "description": "Topic in which the message will be sent; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Message" }, "sendMessageAlbum": { "description": "Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be grouped into an album.", "args": { "chat_id": { "description": "Target chat", "is_optional": false, "type": "int53" }, "input_message_contents": { "description": "Contents of messages to be sent. At most 10 messages can be added to an album. All messages must have the same value of show_caption_above_media", "is_optional": false, "type": "vector\u003cInputMessageContent\u003e" }, "options": { "description": "Options to be used to send the messages; pass null to use default options", "is_optional": true, "type": "messageSendOptions" }, "reply_to": { "description": "Information about the message or story to be replied; pass null if none", "is_optional": true, "type": "InputMessageReplyTo" }, "topic_id": { "description": "Topic in which the messages will be sent; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Messages" }, "sendMessageViewMetrics": { "description": "Informs TDLib about details of a message view by the user from a chat, a message thread or a forum topic history. The method must be called if", "args": { "active_time_in_view_ms": { "description": "The amount of time the message was seen by at least 1 pixel within 15 seconds after any action from the user; in milliseconds", "is_optional": false, "type": "int32" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "height_to_viewport_ratio_per_mille": { "description": "The ratio of the post height to the viewport height in 1/1000 fractions", "is_optional": false, "type": "int32" }, "message_id": { "description": "The identifier of the message being viewed", "is_optional": false, "type": "int53" }, "seen_range_ratio_per_mille": { "description": "The ratio of the viewed post height to the full post height in 1/1000 fractions; 0-1000", "is_optional": false, "type": "int32" }, "time_in_view_ms": { "description": "The amount of time the message was seen by at least 1 pixel; in milliseconds", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "sendPassportAuthorizationForm": { "description": "Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements are going to be reused", "args": { "authorization_form_id": { "description": "Authorization form identifier", "is_optional": false, "type": "int32" }, "types": { "description": "Types of Telegram Passport elements chosen by user to complete the authorization form", "is_optional": false, "type": "vector\u003cPassportElementType\u003e" } }, "type": "Ok" }, "sendPaymentForm": { "description": "Sends a filled-out payment form to the bot for final verification", "args": { "credentials": { "description": "The credentials chosen by user for payment; pass null for a payment in Telegram Stars", "is_optional": true, "type": "InputCredentials" }, "input_invoice": { "description": "The invoice", "is_optional": false, "type": "InputInvoice" }, "order_info_id": { "description": "Identifier returned by validateOrderInfo, or an empty string", "is_optional": false, "type": "string" }, "payment_form_id": { "description": "Payment form identifier returned by getPaymentForm", "is_optional": false, "type": "int64" }, "shipping_option_id": { "description": "Identifier of a chosen shipping option, if applicable", "is_optional": false, "type": "string" }, "tip_amount": { "description": "Chosen by the user amount of tip in the smallest units of the currency", "is_optional": false, "type": "int53" } }, "type": "PaymentResult" }, "sendPhoneNumberCode": { "description": "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", "args": { "phone_number": { "description": "The phone number, in international format", "is_optional": false, "type": "string" }, "settings": { "description": "Settings for the authentication of the user's phone number; pass null to use default settings", "is_optional": true, "type": "phoneNumberAuthenticationSettings" }, "type": { "description": "Type of the request for which the code is sent", "is_optional": false, "type": "PhoneNumberCodeType" } }, "type": "AuthenticationCodeInfo" }, "sendPhoneNumberFirebaseSms": { "description": "Sends Firebase Authentication SMS to the specified phone number. Works only when received a code of the type authenticationCodeTypeFirebaseAndroid or authenticationCodeTypeFirebaseIos", "args": { "token": { "description": "Play Integrity API or SafetyNet Attestation API token for the Android application, or secret from push notification for the iOS application", "is_optional": false, "type": "string" } }, "type": "Ok" }, "sendQuickReplyShortcutMessages": { "description": "Sends messages from a quick reply shortcut. Requires Telegram Business subscription. Can't be used to send paid messages", "args": { "chat_id": { "description": "Identifier of the chat to which to send messages. The chat must be a private chat with a regular user", "is_optional": false, "type": "int53" }, "sending_id": { "description": "Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates", "is_optional": false, "type": "int32" }, "shortcut_id": { "description": "Unique identifier of the quick reply shortcut", "is_optional": false, "type": "int32" } }, "type": "Messages" }, "sendResoldGift": { "description": "Sends an upgraded gift that is available for resale to another user or channel chat; gifts already owned by the current user", "args": { "gift_name": { "description": "Name of the upgraded gift to send", "is_optional": false, "type": "string" }, "is_private": { "description": "Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them", "is_optional": false, "type": "Bool" }, "owner_id": { "description": "Identifier of the user or the channel chat that will receive the gift", "is_optional": false, "type": "MessageSender" }, "price": { "description": "The price that the user agreed to pay for the gift", "is_optional": false, "type": "GiftResalePrice" }, "text": { "description": "Text to show along with the gift; 0-getOption(\"gift_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.", "is_optional": false, "type": "formattedText" } }, "type": "GiftResaleResult" }, "sendRichMessageDraft": { "description": "Sends a draft for a being generated rich message; for bots only", "args": { "can_stop": { "description": "Pass true to show the user a button to stop further drafts", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_id": { "description": "Unique identifier of the draft", "is_optional": false, "type": "int64" }, "forum_topic_id": { "description": "The forum topic identifier in which the message will be sent; pass 0 if none", "is_optional": false, "type": "int32" }, "keep_on_stop": { "description": "Pass true to keep the current draft when the user stops further generation", "is_optional": false, "type": "Bool" }, "message": { "description": "Draft of the message; file upload isn't supported", "is_optional": false, "type": "inputRichMessage" } }, "type": "Ok" }, "sendTextMessageDraft": { "description": "Sends a draft for a being generated text message; for bots only", "args": { "can_stop": { "description": "Pass true to show the user a button to stop further drafts", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_id": { "description": "Unique identifier of the draft", "is_optional": false, "type": "int64" }, "forum_topic_id": { "description": "The forum topic identifier in which the message will be sent; pass 0 if none", "is_optional": false, "type": "int32" }, "keep_on_stop": { "description": "Pass true to keep the current draft when the user stops further generation", "is_optional": false, "type": "Bool" }, "text": { "description": "Draft text of the message; pass null to show a \"Thinking...\" placeholder", "is_optional": true, "type": "formattedText" } }, "type": "Ok" }, "sendTonCenterApiRequest": { "description": "Sends a request to TON Center API and returns its response in JSON format", "args": { "endpoint": { "description": "The path of the requested endpoint. See https://toncenter.com/api/v3/index.html for the list of supported endpoints", "is_optional": false, "type": "string" }, "type": { "description": "Type of the request", "is_optional": false, "type": "TonCenterApiRequestType" } }, "type": "Text" }, "sendTonConnectSessionConnectResult": { "description": "Accepts or rejects a TON Connect session", "args": { "body": { "description": "Body of the result", "is_optional": false, "type": "bytes" }, "challenge_answer": { "description": "Answer to the challenge received from setTonConnectSessionWalletClientId", "is_optional": false, "type": "bytes" }, "is_error": { "description": "Pass true to reject the request; pass false to accept it", "is_optional": false, "type": "Bool" }, "session_id": { "description": "Unique identifier of the session", "is_optional": false, "type": "int64" }, "trace_id": { "description": "Identifier to trace the connection request", "is_optional": false, "type": "string" } }, "type": "Ok" }, "sendTonWalletTransfer": { "description": "Sends a cryptocurrency from the user's TON wallet; can be used only if getOption(\"can_use_ton_wallet\")", "args": { "address": { "description": "Address in the TON blockchain of the transaction peer", "is_optional": false, "type": "string" }, "amount": { "description": "The amount of the sent cryptocurrency, in the smallest units of the cryptocurrency", "is_optional": false, "type": "int53" }, "comment": { "description": "Comment added to the transaction", "is_optional": false, "type": "string" }, "gasless_transfer_data": { "description": "Serialized data for gasless cryptocurrency transfer request; pass an empty string to force a regular request.", "is_optional": false, "type": "bytes" }, "is_comment_encrypted": { "description": "Pass true if the comment is encrypted and must be decrypted using the receiver's or sender's private key", "is_optional": false, "type": "Bool" }, "regular_transfer_data": { "description": "Serialized data for regular cryptocurrency transfer request. The minimum allowed transfer amount is getOption(\"ton_wallet_transfer_amount_min\")", "is_optional": false, "type": "bytes" }, "sending_id": { "description": "Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates", "is_optional": false, "type": "int32" }, "user_id": { "description": "Identifier of the user who will receive the transfer; pass 0 if unknown", "is_optional": false, "type": "int53" } }, "type": "TonWalletTransferResult" }, "sendWebAppCustomRequest": { "description": "Sends a custom request from a Web App", "args": { "bot_user_id": { "description": "Identifier of the bot", "is_optional": false, "type": "int53" }, "method": { "description": "The method name", "is_optional": false, "type": "string" }, "parameters": { "description": "JSON-serialized method parameters", "is_optional": false, "type": "string" } }, "type": "CustomRequestResult" }, "sendWebAppData": { "description": "Sends data received from a keyboardButtonTypeWebApp Web App to a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "button_text": { "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App", "is_optional": false, "type": "string" }, "data": { "description": "The data", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setAccentColor": { "description": "Changes accent color and background custom emoji for the current user; for Telegram Premium users only", "args": { "accent_color_id": { "description": "Identifier of the accent color to use", "is_optional": false, "type": "int32" }, "background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "setAccountTtl": { "description": "Changes the period of inactivity after which the account of the current user will automatically be deleted", "args": { "ttl": { "description": "New account TTL", "is_optional": false, "type": "accountTtl" } }, "type": "Ok" }, "setAlarm": { "description": "Succeeds after a specified amount of time has passed. Can be called before initialization", "args": { "seconds": { "description": "Number of seconds before the function returns", "is_optional": false, "type": "double" } }, "type": "Ok" }, "setApplicationVerificationToken": { "description": "Informs TDLib that application or reCAPTCHA verification has been completed. Can be called before authorization", "args": { "token": { "description": "Play Integrity API token for the Android application, or secret from push notification for the iOS application for application verification, or reCAPTCHA token for reCAPTCHA verifications;", "is_optional": false, "type": "string" }, "verification_id": { "description": "Unique identifier for the verification process as received from updateApplicationVerificationRequired or updateApplicationRecaptchaVerificationRequired", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setArchiveChatListSettings": { "description": "Changes settings for automatic moving of chats to and from the Archive chat lists", "args": { "settings": { "description": "New settings", "is_optional": false, "type": "archiveChatListSettings" } }, "type": "Ok" }, "setAuthenticationEmailAddress": { "description": "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", "args": { "email_address": { "description": "The email address of the user", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setAuthenticationPhoneNumber": { "description": "Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber,", "args": { "phone_number": { "description": "The phone number of the user, in international format", "is_optional": false, "type": "string" }, "settings": { "description": "Settings for the authentication of the user's phone number; pass null to use default settings", "is_optional": true, "type": "phoneNumberAuthenticationSettings" } }, "type": "Ok" }, "setAuthenticationPremiumPurchaseTransaction": { "description": "Informs server about an in-store purchase of Telegram Premium before authorization. Works only when the current authorization state is authorizationStateWaitPremiumPurchase", "args": { "amount": { "description": "Paid amount, in the smallest units of the currency", "is_optional": false, "type": "int53" }, "currency": { "description": "ISO 4217 currency code of the payment currency", "is_optional": false, "type": "string" }, "is_restore": { "description": "Pass true if this is a restore of a Telegram Premium purchase; only for App Store", "is_optional": false, "type": "Bool" }, "premium_day_count": { "description": "The number of days for which the Telegram Premium subscription will be granted", "is_optional": false, "type": "int32" }, "transaction": { "description": "Information about the transaction", "is_optional": false, "type": "StoreTransaction" } }, "type": "Ok" }, "setAutoDownloadSettings": { "description": "Sets auto-download settings", "args": { "settings": { "description": "New user auto-download settings", "is_optional": false, "type": "autoDownloadSettings" }, "type": { "description": "Type of the network for which the new settings are relevant", "is_optional": false, "type": "NetworkType" } }, "type": "Ok" }, "setAutosaveSettings": { "description": "Sets autosave settings for the given scope. The method is guaranteed to work only after at least one call to getAutosaveSettings", "args": { "scope": { "description": "Autosave settings scope", "is_optional": false, "type": "AutosaveSettingsScope" }, "settings": { "description": "New autosave settings for the scope; pass null to set autosave settings to default", "is_optional": true, "type": "scopeAutosaveSettings" } }, "type": "Ok" }, "setBio": { "description": "Changes the bio of the current user", "args": { "bio": { "description": "The new value of the user bio; 0-getOption(\"bio_length_max\") characters without line feeds", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBirthdate": { "description": "Changes the birthdate of the current user", "args": { "birthdate": { "description": "The new value of the current user's birthdate; pass null to remove the birthdate", "is_optional": true, "type": "birthdate" } }, "type": "Ok" }, "setBotInfoDescription": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "description": { "description": "New bot's description on the specified language", "is_optional": false, "type": "string" }, "language_code": { "description": "A two-letter ISO 639-1 language code. If empty, the description will be shown to all users for whose languages there is no dedicated description", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBotInfoShortDescription": { "description": "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", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code. If empty, the short description will be shown to all users for whose languages there is no dedicated description", "is_optional": false, "type": "string" }, "short_description": { "description": "New bot's short description on the specified language", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBotName": { "description": "Sets the name of a bot. Can be called only if userTypeBot.can_be_edited == true", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "language_code": { "description": "A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose languages there is no dedicated name", "is_optional": false, "type": "string" }, "name": { "description": "New bot's name on the specified language; 0-64 characters; must be non-empty if language code is empty", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBotProfilePhoto": { "description": "Changes a profile photo for a bot", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "photo": { "description": "Profile photo to set; pass null to delete the chat photo", "is_optional": true, "type": "InputChatPhoto" } }, "type": "Ok" }, "setBotUpdatesStatus": { "description": "Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only", "args": { "error_message": { "description": "The last error message", "is_optional": false, "type": "string" }, "pending_update_count": { "description": "The number of pending updates", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setBusinessAccountBio": { "description": "Changes the bio of a business account; for bots only", "args": { "bio": { "description": "The new value of the bio; 0-getOption(\"bio_length_max\") characters without line feeds", "is_optional": false, "type": "string" }, "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBusinessAccountGiftSettings": { "description": "Changes settings for gift receiving of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "settings": { "description": "The new settings", "is_optional": false, "type": "giftSettings" } }, "type": "Ok" }, "setBusinessAccountName": { "description": "Changes the first and last name of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "first_name": { "description": "The new value of the first name for the business account; 1-64 characters", "is_optional": false, "type": "string" }, "last_name": { "description": "The new value of the optional last name for the business account; 0-64 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBusinessAccountProfilePhoto": { "description": "Changes a profile photo of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "is_public": { "description": "Pass true to set the public photo, which will be visible even if the main photo is hidden by privacy settings", "is_optional": false, "type": "Bool" }, "photo": { "description": "Profile photo to set; pass null to remove the photo", "is_optional": true, "type": "InputChatPhoto" } }, "type": "Ok" }, "setBusinessAccountUsername": { "description": "Changes the editable username of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "username": { "description": "The new value of the username", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setBusinessAwayMessageSettings": { "description": "Changes the business away message settings of the current user. Requires Telegram Business subscription", "args": { "away_message_settings": { "description": "The new settings for the away message of the business; pass null to disable the away message", "is_optional": true, "type": "businessAwayMessageSettings" } }, "type": "Ok" }, "setBusinessConnectedBot": { "description": "Adds or changes business bot that is connected to the current user account", "args": { "bot": { "description": "Connection settings for the bot", "is_optional": false, "type": "businessConnectedBot" } }, "type": "Ok" }, "setBusinessGreetingMessageSettings": { "description": "Changes the business greeting message settings of the current user. Requires Telegram Business subscription", "args": { "greeting_message_settings": { "description": "The new settings for the greeting message of the business; pass null to disable the greeting message", "is_optional": true, "type": "businessGreetingMessageSettings" } }, "type": "Ok" }, "setBusinessLocation": { "description": "Changes the business location of the current user. Requires Telegram Business subscription", "args": { "location": { "description": "The new location of the business; pass null to remove the location", "is_optional": true, "type": "businessLocation" } }, "type": "Ok" }, "setBusinessMessageIsPinned": { "description": "Pins or unpins a message sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "is_pinned": { "description": "Pass true to pin the message, pass false to unpin it", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setBusinessOpeningHours": { "description": "Changes the business opening hours of the current user. Requires Telegram Business subscription", "args": { "opening_hours": { "description": "The new opening hours of the business; pass null to remove the opening hours; up to 28 time intervals can be specified", "is_optional": true, "type": "businessOpeningHours" } }, "type": "Ok" }, "setBusinessStartPage": { "description": "Changes the business start page of the current user. Requires Telegram Business subscription", "args": { "start_page": { "description": "The new start page of the business; pass null to remove custom start page", "is_optional": true, "type": "inputBusinessStartPage" } }, "type": "Ok" }, "setChatAccentColor": { "description": "Changes accent color and background custom emoji of a channel chat. Requires can_change_info administrator right", "args": { "accent_color_id": { "description": "Identifier of the accent color to use. The chat must have at least accentColor.min_channel_chat_boost_level boost level to pass the corresponding color", "is_optional": false, "type": "int32" }, "background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none. Use chatBoostLevelFeatures.can_set_background_custom_emoji to check whether a custom emoji can be set", "is_optional": false, "type": "int64" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatActiveStoriesList": { "description": "Changes story list in which stories from the chat are shown", "args": { "chat_id": { "description": "Identifier of the chat that posted stories", "is_optional": false, "type": "int53" }, "story_list": { "description": "New list for active stories posted by the chat", "is_optional": false, "type": "StoryList" } }, "type": "Ok" }, "setChatAffiliateProgram": { "description": "Changes affiliate program for a bot", "args": { "chat_id": { "description": "Identifier of the chat with an owned bot for which affiliate program is changed", "is_optional": false, "type": "int53" }, "parameters": { "description": "Parameters of the affiliate program; pass null to close the currently active program. If there is an active program, then commission and program duration can only be increased.", "is_optional": true, "type": "affiliateProgramParameters" } }, "type": "Ok" }, "setChatAvailableReactions": { "description": "Changes reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right", "args": { "available_reactions": { "description": "Reactions available in the chat. All explicitly specified emoji reactions must be active. In channel chats up to the chat's boost level custom emoji reactions can be explicitly specified", "is_optional": false, "type": "ChatAvailableReactions" }, "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatBackground": { "description": "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", "args": { "background": { "description": "The input background to use; pass null to create a new filled or chat theme background", "is_optional": true, "type": "InputBackground" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "dark_theme_dimming": { "description": "Dimming of the background in dark themes, as a percentage; 0-100. Applied only to Wallpaper and Fill types of background", "is_optional": false, "type": "int32" }, "only_for_self": { "description": "Pass true to set background only for self; pass false to set background for all chat users. Always false for backgrounds set in boosted chats. Background can be set for both users only by Telegram Premium users and if set background isn't of the type inputBackgroundPrevious", "is_optional": false, "type": "Bool" }, "type": { "description": "Background type; pass null to use default background type for the chosen background; backgroundTypeChatTheme isn't supported for private and secret chats.", "is_optional": true, "type": "BackgroundType" } }, "type": "Ok" }, "setChatClientData": { "description": "Changes application-specific data associated with a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "client_data": { "description": "New value of client_data", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setChatDescription": { "description": "Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info member right", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "description": { "description": "New chat description; 0-255 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setChatDirectMessagesGroup": { "description": "Changes direct messages group settings for a channel chat; requires owner privileges in the chat", "args": { "chat_id": { "description": "Identifier of the channel chat", "is_optional": false, "type": "int53" }, "is_enabled": { "description": "Pass true if the direct messages group is enabled for the channel chat; pass false otherwise", "is_optional": false, "type": "Bool" }, "paid_message_star_count": { "description": "The new number of Telegram Stars that must be paid for each message that is sent to the direct messages chat unless the sender is an administrator of the channel chat; 0-getOption(\"paid_message_star_count_max\").", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatDiscussionGroup": { "description": "Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified", "args": { "chat_id": { "description": "Identifier of the channel chat. Pass 0 to remove a link from the supergroup passed in the second argument to a linked channel chat (requires can_pin_messages member right in the supergroup)", "is_optional": false, "type": "int53" }, "discussion_chat_id": { "description": "Identifier of a new channel's discussion group. Use 0 to remove the discussion group. Use the method getSuitableDiscussionChats to find all suitable groups.", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatDraftMessage": { "description": "Changes the draft message in a chat or a topic", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "draft_message": { "description": "New draft message; pass null to remove the draft", "is_optional": true, "type": "draftMessage" }, "topic_id": { "description": "Topic in which the draft will be changed; pass null to change the draft for the chat itself", "is_optional": true, "type": "MessageTopic" } }, "type": "Ok" }, "setChatEmojiStatus": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "emoji_status": { "description": "New emoji status; pass null to remove emoji status", "is_optional": true, "type": "emojiStatus" } }, "type": "Ok" }, "setChatLocation": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "location": { "description": "New location for the chat; must be valid and not null", "is_optional": false, "type": "chatLocation" } }, "type": "Ok" }, "setChatMemberStatus": { "description": "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,", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "member_id": { "description": "Member identifier. Chats can be only banned and unbanned in supergroups and channels", "is_optional": false, "type": "MessageSender" }, "status": { "description": "The new status of the member in the chat", "is_optional": false, "type": "ChatMemberStatus" } }, "type": "Ok" }, "setChatMemberTag": { "description": "Changes the tag or custom title of a chat member; requires can_manage_tags administrator right to change tag of other users; for basic groups and supergroups only", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "tag": { "description": "The new tag of the member in the chat; 0-16 characters without emoji", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user whose tag is changed. Chats can't have member tags", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatMessageAutoDeleteTime": { "description": "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.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_auto_delete_time": { "description": "New time value, in seconds; unless the chat is secret, it must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setChatMessageSender": { "description": "Selects a message sender to send messages in a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "message_sender_id": { "description": "New message sender for the chat", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "setChatNotificationSettings": { "description": "Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "notification_settings": { "description": "New notification settings for the chat. If the chat is muted for more than 366 days, it is considered to be muted forever", "is_optional": false, "type": "chatNotificationSettings" } }, "type": "Ok" }, "setChatPaidMessageStarCount": { "description": "Changes the Telegram Star amount that must be paid to send a message to a supergroup chat; requires can_restrict_members administrator right and supergroupFullInfo.can_enable_paid_messages", "args": { "chat_id": { "description": "Identifier of the supergroup chat", "is_optional": false, "type": "int53" }, "paid_message_star_count": { "description": "The new number of Telegram Stars that must be paid for each message that is sent to the supergroup chat unless the sender is an administrator of the chat; 0-getOption(\"paid_message_star_count_max\").", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setChatPermissions": { "description": "Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "permissions": { "description": "New non-administrator members permissions in the chat", "is_optional": false, "type": "chatPermissions" } }, "type": "Ok" }, "setChatPhoto": { "description": "Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info member right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "photo": { "description": "New chat photo; pass null to delete the chat photo", "is_optional": true, "type": "InputChatPhoto" } }, "type": "Ok" }, "setChatPinnedStories": { "description": "Changes the list of pinned stories on a chat page; requires can_edit_stories administrator right in the chat", "args": { "chat_id": { "description": "Identifier of the chat that posted the stories", "is_optional": false, "type": "int53" }, "story_ids": { "description": "New list of pinned stories. All stories must be posted to the chat page first. There can be up to getOption(\"pinned_story_count_max\") pinned stories on a chat page", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Ok" }, "setChatProfileAccentColor": { "description": "Changes accent color and background custom emoji for profile of a supergroup or channel chat. Requires can_change_info administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "profile_accent_color_id": { "description": "Identifier of the accent color to use for profile; pass -1 if none. The chat must have at least profileAccentColor.min_supergroup_chat_boost_level for supergroups", "is_optional": false, "type": "int32" }, "profile_background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the chat's profile photo background; 0 if none. Use chatBoostLevelFeatures.can_set_profile_background_custom_emoji to check whether a custom emoji can be set", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "setChatSlowModeDelay": { "description": "Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members administrator right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "slow_mode_delay": { "description": "New slow mode delay for the chat, in seconds; must be one of 0, 5, 10, 30, 60, 300, 900, 3600", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setChatTheme": { "description": "Changes the chat theme. Supported only in private and secret chats", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "theme": { "description": "New chat theme; pass null to return the default theme", "is_optional": true, "type": "InputChatTheme" } }, "type": "Ok" }, "setChatTitle": { "description": "Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info member right", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "title": { "description": "New title of the chat; 1-128 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setCloseFriends": { "description": "Changes the list of close friends of the current user", "args": { "user_ids": { "description": "User identifiers of close friends; the users must be contacts of the current user", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "setCommands": { "description": "Sets the list of commands supported by the bot for the given user scope and language; for bots only", "args": { "commands": { "description": "List of the bot's commands", "is_optional": false, "type": "vector\u003cbotCommand\u003e" }, "language_code": { "description": "A two-letter ISO 639-1 language code. If empty, the commands will be applied to all users from the given scope, for which language there are no dedicated commands", "is_optional": false, "type": "string" }, "scope": { "description": "The scope to which the commands are relevant; pass null to change commands in the default bot command scope", "is_optional": true, "type": "BotCommandScope" } }, "type": "Ok" }, "setCommunityName": { "description": "Changes name of the given community; requires can_change_info administrator right in the community", "args": { "community_id": { "description": "Identifier of the community", "is_optional": false, "type": "int53" }, "name": { "description": "New name of the community", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setCommunityPermissions": { "description": "Changes permissions of regular members in the given community; requires can_ban_members administrator right in the community", "args": { "community_id": { "description": "Identifier of the community", "is_optional": false, "type": "int53" }, "permissions": { "description": "New permissions of the community", "is_optional": false, "type": "communityPermissions" } }, "type": "Ok" }, "setCommunityPhoto": { "description": "Changes the photo of a community; requires can_change_info administrator right in the community", "args": { "community_id": { "description": "Identifier of the community", "is_optional": false, "type": "int53" }, "photo": { "description": "New chat photo; pass null to delete the chat photo", "is_optional": true, "type": "InputChatPhoto" } }, "type": "Ok" }, "setCustomEmojiStickerSetThumbnail": { "description": "Sets a custom emoji sticker set thumbnail", "args": { "custom_emoji_id": { "description": "Identifier of the custom emoji from the sticker set, which will be set as sticker set thumbnail; pass 0 to remove the sticker set thumbnail", "is_optional": false, "type": "int64" }, "name": { "description": "Sticker set name. The sticker set must be owned by the current user", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setCustomLanguagePack": { "description": "Adds or changes a custom local language pack to the current localization target", "args": { "info": { "description": "Information about the language pack. Language pack identifier must start with 'X', consist only of English letters, digits and hyphens, and must not exceed 64 characters. Can be called before authorization", "is_optional": false, "type": "languagePackInfo" }, "strings": { "description": "Strings of the new language pack", "is_optional": false, "type": "vector\u003clanguagePackString\u003e" } }, "type": "Ok" }, "setCustomLanguagePackString": { "description": "Adds, edits or deletes a string in a custom local language pack. Can be called before authorization", "args": { "language_pack_id": { "description": "Identifier of a previously added custom local language pack in the current localization target", "is_optional": false, "type": "string" }, "new_string": { "description": "New language pack string", "is_optional": false, "type": "languagePackString" } }, "type": "Ok" }, "setDatabaseEncryptionKey": { "description": "Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain", "args": { "new_encryption_key": { "description": "New encryption key", "is_optional": false, "type": "bytes" } }, "type": "Ok" }, "setDefaultBackground": { "description": "Sets default background for chats; adds the background to the list of installed backgrounds", "args": { "background": { "description": "The input background to use; pass null to create a new filled background", "is_optional": true, "type": "InputBackground" }, "for_dark_theme": { "description": "Pass true if the background is set for a dark theme", "is_optional": false, "type": "Bool" }, "type": { "description": "Background type; pass null to use the default type of the remote background; backgroundTypeChatTheme isn't supported", "is_optional": true, "type": "BackgroundType" } }, "type": "Background" }, "setDefaultChannelAdministratorRights": { "description": "Sets default administrator rights for adding the bot to channel chats; for bots only", "args": { "default_channel_administrator_rights": { "description": "Default administrator rights for adding the bot to channels; pass null to remove default rights", "is_optional": true, "type": "chatAdministratorRights" } }, "type": "Ok" }, "setDefaultGroupAdministratorRights": { "description": "Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only", "args": { "default_group_administrator_rights": { "description": "Default administrator rights for adding the bot to basic group and supergroup chats; pass null to remove default rights", "is_optional": true, "type": "chatAdministratorRights" } }, "type": "Ok" }, "setDefaultMessageAutoDeleteTime": { "description": "Changes the default message auto-delete time for new chats", "args": { "message_auto_delete_time": { "description": "New default message auto-delete time; must be from 0 up to 365 * 86400 and be divisible by 86400. If 0, then messages aren't deleted automatically", "is_optional": false, "type": "messageAutoDeleteTime" } }, "type": "Ok" }, "setDefaultReactionType": { "description": "Changes type of default reaction for the current user", "args": { "reaction_type": { "description": "New type of the default reaction. The paid reaction can't be set as default", "is_optional": false, "type": "ReactionType" } }, "type": "Ok" }, "setDirectMessagesChatTopicIsMarkedAsUnread": { "description": "Changes the marked as unread state of the topic in a channel direct messages chat administered by the current user", "args": { "chat_id": { "description": "Chat identifier of the channel direct messages chat", "is_optional": false, "type": "int53" }, "is_marked_as_unread": { "description": "New value of is_marked_as_unread", "is_optional": false, "type": "Bool" }, "topic_id": { "description": "Topic identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setEmojiStatus": { "description": "Changes the emoji status of the current user; for Telegram Premium users only", "args": { "emoji_status": { "description": "New emoji status; pass null to switch to the default badge", "is_optional": true, "type": "emojiStatus" } }, "type": "Ok" }, "setFileGenerationProgress": { "description": "Informs TDLib on a file generation progress", "args": { "expected_size": { "description": "Expected size of the generated file, in bytes; 0 if unknown", "is_optional": false, "type": "int53" }, "generation_id": { "description": "The identifier of the generation process", "is_optional": false, "type": "int64" }, "local_prefix_size": { "description": "The number of bytes already generated", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setForumTopicNotificationSettings": { "description": "Changes the notification settings of a forum topic in a forum supergroup chat or a chat with a bot with topics", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" }, "notification_settings": { "description": "New notification settings for the forum topic. If the topic is muted for more than 366 days, it is considered to be muted forever", "is_optional": false, "type": "chatNotificationSettings" } }, "type": "Ok" }, "setGameScore": { "description": "Updates the game score of the specified user in the game; for bots only", "args": { "chat_id": { "description": "The chat to which the message with the game belongs", "is_optional": false, "type": "int53" }, "edit_message": { "description": "Pass true to edit the game message to include the current scoreboard", "is_optional": false, "type": "Bool" }, "force": { "description": "Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "score": { "description": "The new score", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Message" }, "setGiftCollectionName": { "description": "Changes name of a gift collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection", "args": { "collection_id": { "description": "Identifier of the gift collection", "is_optional": false, "type": "int32" }, "name": { "description": "New name of the collection; 1-12 characters", "is_optional": false, "type": "string" }, "owner_id": { "description": "Identifier of the user or the channel chat that owns the collection", "is_optional": false, "type": "MessageSender" } }, "type": "GiftCollection" }, "setGiftResalePrice": { "description": "Changes resale price of a unique gift owned by the current user", "args": { "price": { "description": "The new price for the unique gift; pass null to disallow gift resale. The current user will receive", "is_optional": true, "type": "GiftResalePrice" }, "received_gift_id": { "description": "Identifier of the unique gift", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setGiftSettings": { "description": "Changes settings for gift receiving for the current user", "args": { "settings": { "description": "The new settings", "is_optional": false, "type": "giftSettings" } }, "type": "Ok" }, "setGroupCallPaidMessageStarCount": { "description": "Changes the minimum number of Telegram Stars that must be paid by general participant for each sent message to a live story call. Requires groupCall.can_be_managed right", "args": { "group_call_id": { "description": "Group call identifier; must be an identifier of a live story call", "is_optional": false, "type": "int32" }, "paid_message_star_count": { "description": "The new minimum number of Telegram Stars; 0-getOption(\"paid_group_call_message_star_count_max\")", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setGroupCallParticipantIsSpeaking": { "description": "Informs TDLib that speaking state of a participant of an active group call has changed. Returns identifier of the participant if it is found", "args": { "audio_source": { "description": "Group call participant's synchronization audio source identifier, or 0 for the current user", "is_optional": false, "type": "int32" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_speaking": { "description": "Pass true if the user is speaking", "is_optional": false, "type": "Bool" } }, "type": "MessageSender" }, "setGroupCallParticipantVolumeLevel": { "description": "Changes volume level of a participant of an active group call; not supported for live stories. If the current user can manage the group call or is the owner of the group call,", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "participant_id": { "description": "Participant identifier", "is_optional": false, "type": "MessageSender" }, "volume_level": { "description": "New participant's volume level; 1-20000 in hundreds of percents", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setInactiveSessionTtl": { "description": "Changes the period of inactivity after which sessions will automatically be terminated", "args": { "inactive_session_ttl_days": { "description": "New number of days of inactivity before sessions will be automatically terminated; 1-366 days", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setInlineGameScore": { "description": "Updates the game score of the specified user in a game; for bots only", "args": { "edit_message": { "description": "Pass true to edit the game message to include the current scoreboard", "is_optional": false, "type": "Bool" }, "force": { "description": "Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table", "is_optional": false, "type": "Bool" }, "inline_message_id": { "description": "Inline message identifier", "is_optional": false, "type": "string" }, "score": { "description": "The new score", "is_optional": false, "type": "int32" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setLiveStoryMessageSender": { "description": "Selects a message sender to send messages in a live story call", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "message_sender_id": { "description": "New message sender for the group call", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "setLogStream": { "description": "Sets new log stream for internal logging of TDLib. Can be called synchronously", "args": { "log_stream": { "description": "New log stream", "is_optional": false, "type": "LogStream" } }, "type": "Ok" }, "setLogTagVerbosityLevel": { "description": "Sets the verbosity level for a specified TDLib internal log tag. Can be called synchronously", "args": { "new_verbosity_level": { "description": "New verbosity level; 1-1024", "is_optional": false, "type": "int32" }, "tag": { "description": "Logging tag to change verbosity level", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setLogVerbosityLevel": { "description": "Sets the verbosity level of the internal logging of TDLib. Can be called synchronously", "args": { "new_verbosity_level": { "description": "New value of the verbosity level for logging. Value 0 corresponds to fatal errors, value 1 corresponds to errors, value 2 corresponds to warnings and debug warnings,", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setLoginEmailAddress": { "description": "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,", "args": { "new_login_email_address": { "description": "New login email address", "is_optional": false, "type": "string" } }, "type": "EmailAddressAuthenticationCodeInfo" }, "setMainProfileTab": { "description": "Changes the main profile tab of the current user", "args": { "main_profile_tab": { "description": "The new value of the main profile tab", "is_optional": false, "type": "ProfileTab" } }, "type": "Ok" }, "setManagedBotAccessSettings": { "description": "Sets access settings of a managed bot; for bots only", "args": { "bot_user_id": { "description": "Identifier of the managed bot", "is_optional": false, "type": "int53" }, "settings": { "description": "New access settings", "is_optional": false, "type": "botAccessSettings" } }, "type": "Ok" }, "setMenuButton": { "description": "Sets menu button for the given user or for all users; for bots only", "args": { "menu_button": { "description": "New menu button", "is_optional": false, "type": "botMenuButton" }, "user_id": { "description": "Identifier of the user or 0 to set menu button for all users", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setMessageFactCheck": { "description": "Changes the fact-check of a message. Can be only used if messageProperties.can_set_fact_check == true", "args": { "chat_id": { "description": "The channel chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "text": { "description": "New text of the fact-check; 0-getOption(\"fact_check_length_max\") characters; pass null to remove it. Only Bold, Italic, and TextUrl entities with https://t.me/ links are supported", "is_optional": true, "type": "formattedText" } }, "type": "Ok" }, "setMessageReactions": { "description": "Sets reactions on a message; for bots only", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "is_big": { "description": "Pass true if the reactions are added with a big animation", "is_optional": false, "type": "Bool" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "reaction_types": { "description": "Types of the reaction to set; pass an empty list to remove the reactions", "is_optional": false, "type": "vector\u003cReactionType\u003e" } }, "type": "Ok" }, "setMessageSenderBlockList": { "description": "Changes the block list of a message sender. Currently, only users and supergroup chats can be blocked", "args": { "block_list": { "description": "New block list for the message sender; pass null to unblock the message sender", "is_optional": true, "type": "BlockList" }, "sender_id": { "description": "Identifier of a message sender to block/unblock", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "setMessageSenderBotVerification": { "description": "Changes the verification status of a user or a chat by an owned bot", "args": { "bot_user_id": { "description": "Identifier of the owned bot, which will verify the user or the chat", "is_optional": false, "type": "int53" }, "custom_description": { "description": "Custom description of verification reason; 0-getOption(\"bot_verification_custom_description_length_max\") characters. Only TextUrl entities are supported.", "is_optional": false, "type": "formattedText" }, "verified_id": { "description": "Identifier of the user or the supergroup or channel chat, which will be verified by the bot", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "setName": { "description": "Changes the first and last name of the current user", "args": { "first_name": { "description": "The new value of the first name for the current user; 1-64 characters", "is_optional": false, "type": "string" }, "last_name": { "description": "The new value of the optional last name for the current user; 0-64 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setNetworkType": { "description": "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,", "args": { "type": { "description": "The new network type; pass null to set network type to networkTypeOther", "is_optional": true, "type": "NetworkType" } }, "type": "Ok" }, "setNewChatPrivacySettings": { "description": "Changes privacy settings for new chat creation; can be used only if getOption(\"can_set_new_chat_privacy_settings\")", "args": { "settings": { "description": "New settings", "is_optional": false, "type": "newChatPrivacySettings" } }, "type": "Ok" }, "setOption": { "description": "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", "args": { "name": { "description": "The name of the option", "is_optional": false, "type": "string" }, "value": { "description": "The new value of the option; pass null to reset option value to a default value", "is_optional": true, "type": "OptionValue" } }, "type": "Ok" }, "setPaidMessageReactionType": { "description": "Changes type of paid message reaction of the current user on a message. The message must have paid reaction added by the current user", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "type": { "description": "New type of the paid reaction", "is_optional": false, "type": "PaidReactionType" } }, "type": "Ok" }, "setPassportElement": { "description": "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", "args": { "element": { "description": "Input Telegram Passport element", "is_optional": false, "type": "InputPassportElement" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "PassportElement" }, "setPassportElementErrors": { "description": "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", "args": { "errors": { "description": "The errors", "is_optional": false, "type": "vector\u003cinputPassportElementError\u003e" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setPassword": { "description": "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", "args": { "new_hint": { "description": "New password hint; may be empty", "is_optional": true, "type": "string" }, "new_password": { "description": "New 2-step verification password of the user; may be empty to remove the password", "is_optional": true, "type": "string" }, "new_recovery_email_address": { "description": "New recovery email address; may be empty", "is_optional": true, "type": "string" }, "old_password": { "description": "Previous 2-step verification password of the user", "is_optional": false, "type": "string" }, "set_recovery_email_address": { "description": "Pass true to change also the recovery email address", "is_optional": false, "type": "Bool" } }, "type": "PasswordState" }, "setPersonalChat": { "description": "Changes the personal chat of the current user", "args": { "chat_id": { "description": "Identifier of the new personal chat; pass 0 to remove the chat. Use getSuitablePersonalChats to get suitable chats", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setPinnedChats": { "description": "Changes the order of pinned chats", "args": { "chat_ids": { "description": "The new list of pinned chats", "is_optional": false, "type": "vector\u003cint53\u003e" }, "chat_list": { "description": "Chat list in which to change the order of pinned chats", "is_optional": false, "type": "ChatList" } }, "type": "Ok" }, "setPinnedForumTopics": { "description": "Changes the order of pinned topics in a forum supergroup chat or a chat with a bot with topics; requires can_manage_topics administrator right in the supergroup", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_ids": { "description": "The new list of identifiers of the pinned forum topics", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Ok" }, "setPinnedGifts": { "description": "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", "args": { "owner_id": { "description": "Identifier of the user or the channel chat that received the gifts", "is_optional": false, "type": "MessageSender" }, "received_gift_ids": { "description": "New list of pinned gifts. All gifts must be upgraded and saved on the profile page first. There can be up to getOption(\"pinned_gift_count_max\") pinned gifts", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "Ok" }, "setPinnedSavedMessagesTopics": { "description": "Changes the order of pinned Saved Messages topics", "args": { "saved_messages_topic_ids": { "description": "Identifiers of the new pinned Saved Messages topics", "is_optional": false, "type": "vector\u003cint53\u003e" } }, "type": "Ok" }, "setPollAnswer": { "description": "Changes the user answer to a poll", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the poll", "is_optional": false, "type": "int53" }, "option_ids": { "description": "0-based identifiers of answer options, chosen by the user. User can choose more than 1 answer option only is the poll allows multiple answers", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "Ok" }, "setProfileAccentColor": { "description": "Changes accent color and background custom emoji for profile of the current user; for Telegram Premium users only", "args": { "profile_accent_color_id": { "description": "Identifier of the accent color to use for profile; pass -1 if none", "is_optional": false, "type": "int32" }, "profile_background_custom_emoji_id": { "description": "Identifier of a custom emoji to be shown on the user's profile photo background; 0 if none", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "setProfileAudioPosition": { "description": "Changes position of an audio file in the profile audio files of the current user", "args": { "after_file_id": { "description": "Identifier of the file from profile audio files after which the file will be positioned; pass 0 to move the file to the beginning of the list", "is_optional": false, "type": "int32" }, "file_id": { "description": "Identifier of the file from profile audio files, which position will be changed", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setProfilePhoto": { "description": "Changes a profile photo for the current user", "args": { "is_public": { "description": "Pass true to set the public photo, which will be visible even if the main photo is hidden by privacy settings", "is_optional": false, "type": "Bool" }, "photo": { "description": "Profile photo to set", "is_optional": false, "type": "InputChatPhoto" } }, "type": "Ok" }, "setQuickReplyShortcutName": { "description": "Changes name of a quick reply shortcut", "args": { "name": { "description": "New name for the shortcut. Use checkQuickReplyShortcutName to check its validness", "is_optional": false, "type": "string" }, "shortcut_id": { "description": "Unique identifier of the quick reply shortcut", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setReactionNotificationSettings": { "description": "Changes notification settings for reactions", "args": { "notification_settings": { "description": "The new notification settings for reactions", "is_optional": false, "type": "reactionNotificationSettings" } }, "type": "Ok" }, "setReadDatePrivacySettings": { "description": "Changes privacy settings for message read date", "args": { "settings": { "description": "New settings", "is_optional": false, "type": "readDatePrivacySettings" } }, "type": "Ok" }, "setRecoveryEmailAddress": { "description": "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.", "args": { "new_recovery_email_address": { "description": "New recovery email address", "is_optional": false, "type": "string" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" } }, "type": "PasswordState" }, "setSavedMessagesTagLabel": { "description": "Changes label of a Saved Messages tag; for Telegram Premium users only", "args": { "label": { "description": "New label for the tag; 0-12 characters", "is_optional": false, "type": "string" }, "tag": { "description": "The tag which label will be changed", "is_optional": false, "type": "ReactionType" } }, "type": "Ok" }, "setScopeNotificationSettings": { "description": "Changes notification settings for chats of a given type", "args": { "notification_settings": { "description": "The new notification settings for the given scope", "is_optional": false, "type": "scopeNotificationSettings" }, "scope": { "description": "Types of chats for which to change the notification settings", "is_optional": false, "type": "NotificationSettingsScope" } }, "type": "Ok" }, "setStickerEmojis": { "description": "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", "args": { "emojis": { "description": "New string with 1-20 emoji corresponding to the sticker", "is_optional": false, "type": "string" }, "sticker": { "description": "Sticker", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "setStickerKeywords": { "description": "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", "args": { "keywords": { "description": "List of up to 20 keywords with total length up to 64 characters, which can be used to find the sticker", "is_optional": false, "type": "vector\u003cstring\u003e" }, "sticker": { "description": "Sticker", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "setStickerMaskPosition": { "description": "Changes the mask position of a mask sticker. The sticker must belong to a mask sticker set that is owned by the current user", "args": { "mask_position": { "description": "Position where the mask is placed; pass null to remove mask position", "is_optional": true, "type": "maskPosition" }, "sticker": { "description": "Sticker", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "setStickerPositionInSet": { "description": "Changes the position of a sticker in the set to which it belongs. The sticker set must be owned by the current user", "args": { "position": { "description": "New position of the sticker in the set, 0-based", "is_optional": false, "type": "int32" }, "sticker": { "description": "Sticker", "is_optional": false, "type": "InputFile" } }, "type": "Ok" }, "setStickerSetThumbnail": { "description": "Sets a sticker set thumbnail", "args": { "format": { "description": "Format of the thumbnail; pass null if thumbnail is removed", "is_optional": true, "type": "StickerFormat" }, "name": { "description": "Sticker set name. The sticker set must be owned by the current user", "is_optional": false, "type": "string" }, "thumbnail": { "description": "Thumbnail to set; pass null to remove the sticker set thumbnail", "is_optional": true, "type": "InputFile" }, "user_id": { "description": "Sticker set owner; ignored for regular users", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setStickerSetTitle": { "description": "Sets a sticker set title", "args": { "name": { "description": "Sticker set name. The sticker set must be owned by the current user", "is_optional": false, "type": "string" }, "title": { "description": "New sticker set title", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setStoryAlbumName": { "description": "Changes name of an album of stories. If the album is owned by a supergroup or a channel chat, then requires can_edit_stories administrator right in the chat. Returns the changed album", "args": { "chat_id": { "description": "Identifier of the chat that owns the stories", "is_optional": false, "type": "int53" }, "name": { "description": "New name of the album; 1-12 characters", "is_optional": false, "type": "string" }, "story_album_id": { "description": "Identifier of the story album", "is_optional": false, "type": "int32" } }, "type": "StoryAlbum" }, "setStoryPrivacySettings": { "description": "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_set_privacy_settings == true", "args": { "privacy_settings": { "description": "The new privacy settings for the story", "is_optional": false, "type": "StoryPrivacySettings" }, "story_id": { "description": "Identifier of the story", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setStoryReaction": { "description": "Changes chosen reaction on a story that has already been sent; not supported for live stories", "args": { "reaction_type": { "description": "Type of the reaction to set; pass null to remove the reaction. Custom emoji reactions can be used only by Telegram Premium users. Paid reactions can't be set", "is_optional": true, "type": "ReactionType" }, "story_id": { "description": "The identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "The identifier of the poster of the story", "is_optional": false, "type": "int53" }, "update_recent_reactions": { "description": "Pass true if the reaction needs to be added to recent reactions", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "setSupergroupCustomEmojiStickerSet": { "description": "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", "args": { "custom_emoji_sticker_set_id": { "description": "New value of the custom emoji sticker set identifier for the supergroup. Use 0 to remove the custom emoji sticker set in the supergroup", "is_optional": false, "type": "int64" }, "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setSupergroupMainProfileTab": { "description": "Changes the main profile tab of the channel; requires can_change_info administrator right", "args": { "main_profile_tab": { "description": "The new value of the main profile tab", "is_optional": false, "type": "ProfileTab" }, "supergroup_id": { "description": "Identifier of the channel", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setSupergroupStickerSet": { "description": "Changes the sticker set of a supergroup; requires can_change_info administrator right", "args": { "sticker_set_id": { "description": "New value of the supergroup sticker set identifier. Use 0 to remove the supergroup sticker set", "is_optional": false, "type": "int64" }, "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setSupergroupUnrestrictBoostCount": { "description": "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", "args": { "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" }, "unrestrict_boost_count": { "description": "New value of the unrestrict_boost_count supergroup setting; 0-8. Use 0 to remove the setting", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "setSupergroupUsername": { "description": "Changes the editable username of a supergroup or channel, requires owner privileges in the supergroup or channel", "args": { "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" }, "username": { "description": "New value of the username. Use an empty string to remove the username. The username can't be completely removed if there is another active or disabled username", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setTdlibParameters": { "description": "Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters", "args": { "api_hash": { "description": "Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org", "is_optional": false, "type": "string" }, "api_id": { "description": "Application identifier for Telegram API access, which can be obtained at https://my.telegram.org", "is_optional": false, "type": "int32" }, "application_version": { "description": "Application version; must be non-empty", "is_optional": false, "type": "string" }, "database_directory": { "description": "The path to the directory for the persistent database; if empty, the current working directory will be used", "is_optional": false, "type": "string" }, "database_encryption_key": { "description": "Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned", "is_optional": false, "type": "bytes" }, "device_model": { "description": "Model of the device the application is being run on; must be non-empty", "is_optional": false, "type": "string" }, "files_directory": { "description": "The path to the directory for storing files; if empty, database_directory will be used", "is_optional": false, "type": "string" }, "system_language_code": { "description": "IETF language tag of the user's operating system language; must be non-empty", "is_optional": false, "type": "string" }, "system_version": { "description": "Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib", "is_optional": false, "type": "string" }, "use_chat_info_database": { "description": "Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database", "is_optional": false, "type": "Bool" }, "use_file_database": { "description": "Pass true to keep information about downloaded and uploaded files between application restarts", "is_optional": false, "type": "Bool" }, "use_message_database": { "description": "Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database", "is_optional": false, "type": "Bool" }, "use_secret_chats": { "description": "Pass true to enable support for secret chats", "is_optional": false, "type": "Bool" }, "use_test_dc": { "description": "Pass true to use Telegram test environment instead of the production environment", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "setTonConnectSessionWalletClientId": { "description": "Sets wallet_client_id for a pending TON Connect session. Then, sendTonConnectSessionConnectResult must be used to accept or reject the session", "args": { "session_id": { "description": "Unique identifier of the session", "is_optional": false, "type": "int64" }, "wallet_client_id": { "description": "Hex-encoded public X25519 key of the current user's application calculated from the TON wallet private key and session parameters", "is_optional": false, "type": "string" } }, "type": "TonConnectChallenge" }, "setUpgradedGiftColors": { "description": "Changes color scheme for the current user based on an owned or a hosted upgraded gift; for Telegram Premium users only", "args": { "upgraded_gift_colors_id": { "description": "Identifier of the upgradedGiftColors scheme to use", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "setUserEmojiStatus": { "description": "Changes the emoji status of a user; for bots only", "args": { "emoji_status": { "description": "New emoji status; pass null to switch to the default badge", "is_optional": true, "type": "emojiStatus" }, "user_id": { "description": "Identifier of the user", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setUserNote": { "description": "Changes a note of a contact user", "args": { "note": { "description": "Note to set for the user; 0-getOption(\"user_note_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setUserPersonalProfilePhoto": { "description": "Changes a personal profile photo of a contact user", "args": { "photo": { "description": "Profile photo to set; pass null to delete the photo; inputChatPhotoPrevious isn't supported in this function", "is_optional": true, "type": "InputChatPhoto" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "setUserPrivacySettingRules": { "description": "Changes user privacy settings", "args": { "rules": { "description": "The new privacy rules", "is_optional": false, "type": "userPrivacySettingRules" }, "setting": { "description": "The privacy setting", "is_optional": false, "type": "UserPrivacySetting" } }, "type": "Ok" }, "setUserSupportInfo": { "description": "Sets support information for the given user; for Telegram support only", "args": { "message": { "description": "New information message", "is_optional": false, "type": "formattedText" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "UserSupportInfo" }, "setUsername": { "description": "Changes the editable username of the current user", "args": { "username": { "description": "The new value of the username. Use an empty string to remove the username. The username can't be completely removed if there is another active or disabled username", "is_optional": false, "type": "string" } }, "type": "Ok" }, "setVideoChatDefaultParticipant": { "description": "Changes default participant identifier, on whose behalf a video chat in the chat will be joined", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "default_participant_id": { "description": "Default group call participant identifier to join the video chats in the chat", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "setVideoChatTitle": { "description": "Sets title of a video chat; requires groupCall.can_be_managed right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "title": { "description": "New group call title; 1-64 characters", "is_optional": false, "type": "string" } }, "type": "Ok" }, "shareChatWithBot": { "description": "Shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot", "args": { "button_id": { "description": "Identifier of the button", "is_optional": false, "type": "int32" }, "only_check": { "description": "Pass true to check that the chat can be shared by the button instead of actually sharing it. Doesn't check bot_is_member and bot_administrator_rights restrictions.", "is_optional": false, "type": "Bool" }, "shared_chat_id": { "description": "Identifier of the shared chat", "is_optional": false, "type": "int53" }, "source": { "description": "Source of the button", "is_optional": false, "type": "KeyboardButtonSource" } }, "type": "Ok" }, "sharePhoneNumber": { "description": "Shares the phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber", "args": { "user_id": { "description": "Identifier of the user with whom to share the phone number. The user must be a mutual contact", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "shareUsersWithBot": { "description": "Shares users after pressing a keyboardButtonTypeRequestUsers or keyboardButtonTypeRequestManagedBot button with the bot", "args": { "button_id": { "description": "Identifier of the button", "is_optional": false, "type": "int32" }, "only_check": { "description": "Pass true to check that the users can be shared by the button instead of actually sharing them", "is_optional": false, "type": "Bool" }, "shared_user_ids": { "description": "Identifiers of the shared users", "is_optional": false, "type": "vector\u003cint53\u003e" }, "source": { "description": "Source of the button", "is_optional": false, "type": "KeyboardButtonSource" } }, "type": "Ok" }, "startGroupCallRecording": { "description": "Starts recording of an active group call; for video chats only. Requires groupCall.can_be_managed right", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "record_video": { "description": "Pass true to record a video file instead of an audio file", "is_optional": false, "type": "Bool" }, "title": { "description": "Group call recording title; 0-64 characters", "is_optional": false, "type": "string" }, "use_portrait_orientation": { "description": "Pass true to use portrait orientation for video instead of landscape one", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "startGroupCallScreenSharing": { "description": "Starts screen sharing in a joined group call; not supported in live stories. Returns join response payload for tgcalls", "args": { "audio_source_id": { "description": "Screen sharing audio channel synchronization source identifier; received from tgcalls", "is_optional": false, "type": "int32" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "payload": { "description": "Group call join payload; received from tgcalls", "is_optional": false, "type": "string" } }, "type": "Text" }, "startLiveStory": { "description": "Starts a new live story on behalf of a chat; requires can_post_stories administrator right for channel chats", "args": { "chat_id": { "description": "Identifier of the chat that will start the live story. Pass Saved Messages chat identifier when starting a live story on behalf of the current user, or a channel chat identifier", "is_optional": false, "type": "int53" }, "enable_messages": { "description": "Pass true to allow viewers of the story to send messages", "is_optional": false, "type": "Bool" }, "is_rtmp_stream": { "description": "Pass true to create an RTMP stream instead of an ordinary group call", "is_optional": false, "type": "Bool" }, "paid_message_star_count": { "description": "The minimum number of Telegram Stars that must be paid by viewers for each sent message to the call; 0-getOption(\"paid_group_call_message_star_count_max\")", "is_optional": false, "type": "int53" }, "privacy_settings": { "description": "The privacy settings for the story; ignored for stories posted on behalf of channel chats", "is_optional": false, "type": "StoryPrivacySettings" }, "protect_content": { "description": "Pass true if the content of the story must be protected from screenshotting", "is_optional": false, "type": "Bool" } }, "type": "StartLiveStoryResult" }, "startScheduledVideoChat": { "description": "Starts a scheduled video chat", "args": { "group_call_id": { "description": "Group call identifier of the video chat", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "stopBusinessPoll": { "description": "Stops a poll sent on behalf of a business account; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which the message with the poll was sent", "is_optional": false, "type": "string" }, "chat_id": { "description": "The chat the message belongs to", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the poll", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none", "is_optional": true, "type": "ReplyMarkup" } }, "type": "BusinessMessage" }, "stopPendingMessage": { "description": "Stops a pending message generation by a bot", "args": { "chat_id": { "description": "Identifier of the chat with the bot", "is_optional": false, "type": "int53" }, "draft_id": { "description": "Unique identifier of the message draft within the message thread", "is_optional": false, "type": "int64" }, "topic_id": { "description": "Identifier of the topic in which the action is performed; pass null if none", "is_optional": true, "type": "MessageTopic" } }, "type": "Ok" }, "stopPoll": { "description": "Stops a poll", "args": { "chat_id": { "description": "Identifier of the chat to which the poll belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message containing the poll. Use messageProperties.can_be_edited to check whether the poll can be stopped", "is_optional": false, "type": "int53" }, "reply_markup": { "description": "The new message reply markup; pass null if none; for bots only", "is_optional": true, "type": "ReplyMarkup" } }, "type": "Ok" }, "suggestUserBirthdate": { "description": "Suggests a birthdate to another regular user with common messages and allowing non-paid messages", "args": { "birthdate": { "description": "Birthdate to suggest", "is_optional": false, "type": "birthdate" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "suggestUserProfilePhoto": { "description": "Suggests a profile photo to another regular user with common messages and allowing non-paid messages", "args": { "photo": { "description": "Profile photo to suggest; inputChatPhotoPrevious isn't supported in this function", "is_optional": false, "type": "InputChatPhoto" }, "user_id": { "description": "User identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "summarizeMessage": { "description": "Summarizes content of the message with non-empty summary_language_code", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "tone": { "description": "Tone of the summarization; see translateText.tone for the list of supported values", "is_optional": false, "type": "string" }, "translate_to_language_code": { "description": "Pass a language code to which the summary will be translated; pass an empty string if translation isn't needed. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "synchronizeLanguagePack": { "description": "Fetches the latest versions of all strings from a language pack in the current localization target from the server.", "args": { "language_pack_id": { "description": "Language pack identifier", "is_optional": false, "type": "string" } }, "type": "Ok" }, "terminateAllOtherSessions": { "description": "Terminates all other sessions of the current user. Additionally, the user must be suggested to delete the connected business bot using deleteBusinessConnectedBot if there is any", "args": {}, "type": "Ok" }, "terminateSession": { "description": "Terminates a session of the current user", "args": { "session_id": { "description": "Session identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "testCallBytes": { "description": "Returns the received bytes; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Bytes to return", "is_optional": false, "type": "bytes" } }, "type": "TestBytes" }, "testCallEmpty": { "description": "Does nothing; for testing only. This is an offline method. Can be called before authorization", "args": {}, "type": "Ok" }, "testCallString": { "description": "Returns the received string; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "String to return", "is_optional": false, "type": "string" } }, "type": "TestString" }, "testCallVectorInt": { "description": "Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Vector of numbers to return", "is_optional": false, "type": "vector\u003cint32\u003e" } }, "type": "TestVectorInt" }, "testCallVectorIntObject": { "description": "Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Vector of objects to return", "is_optional": false, "type": "vector\u003ctestInt\u003e" } }, "type": "TestVectorIntObject" }, "testCallVectorString": { "description": "Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Vector of strings to return", "is_optional": false, "type": "vector\u003cstring\u003e" } }, "type": "TestVectorString" }, "testCallVectorStringObject": { "description": "Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Vector of objects to return", "is_optional": false, "type": "vector\u003ctestString\u003e" } }, "type": "TestVectorStringObject" }, "testGetDifference": { "description": "Forces an updates.getDifference call to the Telegram servers; for testing only", "args": {}, "type": "Ok" }, "testNetwork": { "description": "Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization", "args": {}, "type": "Ok" }, "testProxy": { "description": "Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization", "args": { "dc_id": { "description": "Identifier of a datacenter with which to test connection", "is_optional": false, "type": "int32" }, "proxy": { "description": "The proxy to test", "is_optional": false, "type": "proxy" }, "timeout": { "description": "The maximum overall timeout for the request", "is_optional": false, "type": "double" } }, "type": "Ok" }, "testReturnError": { "description": "Returns the specified error and ensures that the Error object is used; for testing only. Can be called synchronously", "args": { "error": { "description": "The error to be returned", "is_optional": false, "type": "error" } }, "type": "Error" }, "testSquareInt": { "description": "Returns the squared received number; for testing only. This is an offline method. Can be called before authorization", "args": { "x": { "description": "Number to square", "is_optional": false, "type": "int32" } }, "type": "TestInt" }, "testUseUpdate": { "description": "Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called before authorization", "args": {}, "type": "Update" }, "toggleAllDownloadsArePaused": { "description": "Changes pause state of all files in the file download list", "args": { "are_paused": { "description": "Pass true to pause all downloads; pass false to unpause them", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleBotCanManageEmojiStatus": { "description": "Toggles whether the bot can manage emoji status of the current user", "args": { "bot_user_id": { "description": "User identifier of the bot", "is_optional": false, "type": "int53" }, "can_manage_emoji_status": { "description": "Pass true if the bot is allowed to change emoji status of the user; pass false otherwise", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleBotIsAddedToAttachmentMenu": { "description": "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", "args": { "allow_write_access": { "description": "Pass true if the current user allowed the bot to send them messages. Ignored if is_added is false", "is_optional": false, "type": "Bool" }, "bot_user_id": { "description": "Bot's user identifier", "is_optional": false, "type": "int53" }, "is_added": { "description": "Pass true to add the bot to attachment menu; pass false to remove the bot from attachment menu", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleBotUsernameIsActive": { "description": "Changes active state for a username of a bot. The editable username can be disabled only if there are other active usernames.", "args": { "bot_user_id": { "description": "Identifier of the target bot", "is_optional": false, "type": "int53" }, "is_active": { "description": "Pass true to activate the username; pass false to disable it", "is_optional": false, "type": "Bool" }, "username": { "description": "The username to change", "is_optional": false, "type": "string" } }, "type": "Ok" }, "toggleBusinessConnectedBotChatIsPaused": { "description": "Pauses or resumes the connected business bot in a specific chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_paused": { "description": "Pass true to pause the connected bot in the chat; pass false to resume the bot", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatDefaultDisableNotification": { "description": "Changes the value of the default disable_notification parameter, used when a message is sent to a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "default_disable_notification": { "description": "New value of default_disable_notification", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatFolderTags": { "description": "Toggles whether chat folder tags are enabled", "args": { "are_tags_enabled": { "description": "Pass true to enable folder tags; pass false to disable them", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatGiftNotifications": { "description": "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", "args": { "are_enabled": { "description": "Pass true to enable notifications about new gifts owned by the channel chat; pass false to disable the notifications", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Identifier of the channel chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleChatHasProtectedContent": { "description": "Changes the ability of users to save, forward, or copy chat content. Requires owner privileges in basic groups, supergroups and channels.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "has_protected_content": { "description": "New value of has_protected_content", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatIsMarkedAsUnread": { "description": "Changes the marked as unread state of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_marked_as_unread": { "description": "New value of is_marked_as_unread", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatIsPinned": { "description": "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", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "chat_list": { "description": "Chat list in which to change the pinned state of the chat", "is_optional": false, "type": "ChatList" }, "is_pinned": { "description": "Pass true to pin the chat; pass false to unpin it", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatIsTranslatable": { "description": "Changes the translatable state of a chat", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "is_translatable": { "description": "New value of is_translatable", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleChatViewAsTopics": { "description": "Changes the view_as_topics setting of a forum chat or Saved Messages", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "view_as_topics": { "description": "New value of view_as_topics", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleDirectMessagesChatTopicCanSendUnpaidMessages": { "description": "Allows to send unpaid messages to the given topic of the channel direct messages chat administered by the current user", "args": { "can_send_unpaid_messages": { "description": "Pass true to allow unpaid messages; pass false to disallow unpaid messages", "is_optional": false, "type": "Bool" }, "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "refund_payments": { "description": "Pass true to refund the user previously paid messages", "is_optional": false, "type": "Bool" }, "topic_id": { "description": "Identifier of the topic", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleDownloadIsPaused": { "description": "Changes pause state of a file in the file download list", "args": { "file_id": { "description": "Identifier of the downloaded file", "is_optional": false, "type": "int32" }, "is_paused": { "description": "Pass true if the download is paused", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleForumTopicIsClosed": { "description": "Toggles whether a topic is closed in a forum supergroup chat; requires can_manage_topics administrator right in the supergroup unless the user is creator of the topic", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" }, "is_closed": { "description": "Pass true to close the topic; pass false to reopen it", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleForumTopicIsPinned": { "description": "Changes the pinned state of a topic in a forum supergroup chat or a chat with a bot with topics; requires can_manage_topics administrator right in the supergroup.", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier", "is_optional": false, "type": "int32" }, "is_pinned": { "description": "Pass true to pin the topic; pass false to unpin it", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleGeneralForumTopicIsHidden": { "description": "Toggles whether a General topic is hidden in a forum supergroup chat; requires can_manage_topics administrator right in the supergroup", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "is_hidden": { "description": "Pass true to hide and close the General topic; pass false to unhide it", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleGiftIsSaved": { "description": "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", "args": { "is_saved": { "description": "Pass true to display the gift on the user's or the channel's profile page; pass false to remove it from the profile page", "is_optional": false, "type": "Bool" }, "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" } }, "type": "Ok" }, "toggleGroupCallAreMessagesAllowed": { "description": "Toggles whether participants of a group call can send messages there. Requires groupCall.can_toggle_are_messages_allowed right", "args": { "are_messages_allowed": { "description": "New value of the are_messages_allowed setting", "is_optional": false, "type": "Bool" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "toggleGroupCallIsMyVideoEnabled": { "description": "Toggles whether current user's video is enabled", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_my_video_enabled": { "description": "Pass true if the current user's video is enabled", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleGroupCallIsMyVideoPaused": { "description": "Toggles whether current user's video is paused", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_my_video_paused": { "description": "Pass true if the current user's video is paused", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleGroupCallParticipantIsHandRaised": { "description": "Toggles whether a group call participant hand is rased; for video chats only", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_hand_raised": { "description": "Pass true if the user's hand needs to be raised. Only self hand can be raised. Requires groupCall.can_be_managed right to lower other's hand", "is_optional": false, "type": "Bool" }, "participant_id": { "description": "Participant identifier", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "toggleGroupCallParticipantIsMuted": { "description": "Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves; not supported for live stories", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_muted": { "description": "Pass true to mute the user; pass false to unmute them", "is_optional": false, "type": "Bool" }, "participant_id": { "description": "Participant identifier", "is_optional": false, "type": "MessageSender" } }, "type": "Ok" }, "toggleGroupCallScreenSharingIsPaused": { "description": "Pauses or unpauses screen sharing in a joined group call; not supported in live stories", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "is_paused": { "description": "Pass true to pause screen sharing; pass false to unpause it", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleHasSponsoredMessagesEnabled": { "description": "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", "args": { "has_sponsored_messages_enabled": { "description": "Pass true to enable sponsored messages for the current user; false to disable them", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "toggleSavedMessagesTopicIsPinned": { "description": "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", "args": { "is_pinned": { "description": "Pass true to pin the topic; pass false to unpin it", "is_optional": false, "type": "Bool" }, "saved_messages_topic_id": { "description": "Identifier of Saved Messages topic to pin or unpin", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSessionCanAcceptCalls": { "description": "Toggles whether a session can accept incoming calls", "args": { "can_accept_calls": { "description": "Pass true to allow accepting incoming calls by the session; pass false otherwise", "is_optional": false, "type": "Bool" }, "session_id": { "description": "Session identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "toggleSessionCanAcceptSecretChats": { "description": "Toggles whether a session can accept incoming secret chats", "args": { "can_accept_secret_chats": { "description": "Pass true to allow accepting secret chats by the session; pass false otherwise", "is_optional": false, "type": "Bool" }, "session_id": { "description": "Session identifier", "is_optional": false, "type": "int64" } }, "type": "Ok" }, "toggleStoryIsPostedToChatPage": { "description": "Toggles whether a story is accessible after expiration. Can be called only if story.can_toggle_is_posted_to_chat_page == true", "args": { "is_posted_to_chat_page": { "description": "Pass true to make the story accessible after expiration; pass false to make it private", "is_optional": false, "type": "Bool" }, "story_id": { "description": "Identifier of the story", "is_optional": false, "type": "int32" }, "story_poster_chat_id": { "description": "Identifier of the chat that posted the story", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupCanHaveSponsoredMessages": { "description": "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", "args": { "can_have_sponsored_messages": { "description": "The new value of can_have_sponsored_messages", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "The identifier of the channel", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupHasAggressiveAntiSpamEnabled": { "description": "Toggles whether aggressive anti-spam checks are enabled in the supergroup. Can be called only if supergroupFullInfo.can_toggle_aggressive_anti_spam == true", "args": { "has_aggressive_anti_spam_enabled": { "description": "The new value of has_aggressive_anti_spam_enabled", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "The identifier of the supergroup, which isn't a broadcast group", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupHasAutomaticTranslation": { "description": "Toggles whether messages are automatically translated in the channel chat; requires can_change_info administrator right in the channel.", "args": { "has_automatic_translation": { "description": "The new value of has_automatic_translation", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "The identifier of the channel", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupHasHiddenMembers": { "description": "Toggles whether non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatMembers. Can be called only if supergroupFullInfo.can_hide_members == true", "args": { "has_hidden_members": { "description": "New value of has_hidden_members", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupIsAllHistoryAvailable": { "description": "Toggles whether the message history of a supergroup is available to new members; requires can_change_info member right", "args": { "is_all_history_available": { "description": "The new value of is_all_history_available", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "The identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupIsBroadcastGroup": { "description": "Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup", "args": { "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupIsForum": { "description": "Toggles whether the supergroup is a forum; requires owner privileges in the supergroup. Discussion supergroups can't be converted to forums", "args": { "has_forum_tabs": { "description": "New value of has_forum_tabs; ignored if is_forum is false", "is_optional": false, "type": "Bool" }, "is_forum": { "description": "New value of is_forum", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the supergroup", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupJoinByRequest": { "description": "Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right", "args": { "apply_to_invite_links": { "description": "Pass true to apply the change to the existing invite links, including primary links", "is_optional": false, "type": "Bool" }, "guard_bot_user_id": { "description": "Identifier of the bot which will be the guard bot in the group; pass 0 if none; ignored if join_by_request == false.", "is_optional": false, "type": "int53" }, "join_by_request": { "description": "New value of join_by_request", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the supergroup that isn't a broadcast group and isn't a channel direct message group", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupJoinToSendMessages": { "description": "Toggles whether joining is mandatory to send messages to a discussion supergroup; requires can_restrict_members administrator right", "args": { "join_to_send_messages": { "description": "New value of join_to_send_messages", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the supergroup that isn't a broadcast group", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupSignMessages": { "description": "Toggles whether sender signature or link to the account is added to sent messages in a channel; requires can_change_info member right", "args": { "show_message_sender": { "description": "New value of show_message_sender", "is_optional": false, "type": "Bool" }, "sign_messages": { "description": "New value of sign_messages", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the channel", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "toggleSupergroupUsernameIsActive": { "description": "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.", "args": { "is_active": { "description": "Pass true to activate the username; pass false to disable it", "is_optional": false, "type": "Bool" }, "supergroup_id": { "description": "Identifier of the supergroup or channel", "is_optional": false, "type": "int53" }, "username": { "description": "The username to change", "is_optional": false, "type": "string" } }, "type": "Ok" }, "toggleUsernameIsActive": { "description": "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", "args": { "is_active": { "description": "Pass true to activate the username; pass false to disable it", "is_optional": false, "type": "Bool" }, "username": { "description": "The username to change", "is_optional": false, "type": "string" } }, "type": "Ok" }, "toggleVideoChatEnabledStartNotification": { "description": "Toggles whether the current user will receive a notification when the video chat starts; for scheduled video chats only", "args": { "enabled_start_notification": { "description": "New value of the enabled_start_notification setting", "is_optional": false, "type": "Bool" }, "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "toggleVideoChatMuteNewParticipants": { "description": "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", "args": { "group_call_id": { "description": "Group call identifier", "is_optional": false, "type": "int32" }, "mute_new_participants": { "description": "New value of the mute_new_participants setting", "is_optional": false, "type": "Bool" } }, "type": "Ok" }, "transferBusinessAccountStars": { "description": "Transfers Telegram Stars from the business account to the business bot; for bots only", "args": { "business_connection_id": { "description": "Unique identifier of business connection", "is_optional": false, "type": "string" }, "star_count": { "description": "Number of Telegram Stars to transfer", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "transferChatOwnership": { "description": "Changes the owner of a chat; for basic groups, supergroups and channel chats only; requires owner privileges in the chat. Use the method canTransferOwnership to check whether the ownership can be transferred from the current session", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "password": { "description": "The 2-step verification password of the current user", "is_optional": false, "type": "string" }, "user_id": { "description": "Identifier of the user to which transfer the ownership. The ownership can't be transferred to a bot or to a deleted user", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "transferGift": { "description": "Sends an upgraded gift to another user or channel chat", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request; for bots only", "is_optional": false, "type": "string" }, "new_owner_id": { "description": "Identifier of the user or the channel chat that will receive the gift", "is_optional": false, "type": "MessageSender" }, "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" }, "star_count": { "description": "The Telegram Star amount required to pay for the transfer", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "translateMessageRichMessage": { "description": "Extracts rich message of the given message and translates it to the given language", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "to_language_code": { "description": "Language code of the language to which the message is translated. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" }, "tone": { "description": "Tone of the translation; see translateText.tone for the list of supported values", "is_optional": false, "type": "string" } }, "type": "RichMessage" }, "translateMessageText": { "description": "Extracts text or caption of the given message and translates it to the given language; must not be used in secret chats. If the current user is a Telegram Premium user, then text formatting is preserved", "args": { "chat_id": { "description": "Identifier of the chat to which the message belongs", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the message", "is_optional": false, "type": "int53" }, "to_language_code": { "description": "Language code of the language to which the message is translated. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" }, "tone": { "description": "Tone of the translation; see translateText.tone for the list of supported values", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "translateRichMessage": { "description": "Translates a rich message to the given language", "args": { "message": { "description": "Rich message to translate", "is_optional": false, "type": "inputRichMessage" }, "to_language_code": { "description": "Language code of the language to which the message is translated. See translateText.to_language_code for the list of supported values", "is_optional": false, "type": "string" }, "tone": { "description": "Tone of the translation; see translateText.tone for the list of supported values", "is_optional": false, "type": "string" } }, "type": "RichMessage" }, "translateText": { "description": "Translates a text to the given language; must not be used in secret chats. If the current user is a Telegram Premium user, then text formatting is preserved", "args": { "text": { "description": "Text to translate", "is_optional": false, "type": "formattedText" }, "to_language_code": { "description": "Language code of the language to which the message is translated. Must be one of", "is_optional": false, "type": "string" }, "tone": { "description": "Tone of the translation; must be one of \"\", \"formal\", \"neutral\", \"casual\"; defaults to \"neutral\"", "is_optional": false, "type": "string" } }, "type": "FormattedText" }, "unpinAllChatMessages": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "unpinAllDirectMessagesChatTopicMessages": { "description": "Removes all pinned messages from the topic in a channel direct messages chat administered by the current user", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "topic_id": { "description": "Topic identifier", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "unpinAllForumTopicMessages": { "description": "Removes all pinned messages from a topic in a forum supergroup chat or a chat with a bot with topics; requires can_pin_messages member right in the supergroup", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "forum_topic_id": { "description": "Forum topic identifier in which messages will be unpinned", "is_optional": false, "type": "int32" } }, "type": "Ok" }, "unpinChatMessage": { "description": "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", "args": { "chat_id": { "description": "Identifier of the chat", "is_optional": false, "type": "int53" }, "message_id": { "description": "Identifier of the removed pinned message", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "upgradeBasicGroupChatToSupergroupChat": { "description": "Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires owner privileges. Deactivates the original basic group", "args": { "chat_id": { "description": "Identifier of the chat to upgrade", "is_optional": false, "type": "int53" } }, "type": "Chat" }, "upgradeGift": { "description": "Upgrades a regular gift", "args": { "business_connection_id": { "description": "Unique identifier of business connection on behalf of which to send the request; for bots only", "is_optional": false, "type": "string" }, "keep_original_details": { "description": "Pass true to keep the original gift text, sender and receiver in the upgraded gift", "is_optional": false, "type": "Bool" }, "received_gift_id": { "description": "Identifier of the gift", "is_optional": false, "type": "string" }, "star_count": { "description": "The Telegram Star amount required to pay for the upgrade. If the gift has prepaid_upgrade_star_count \u003e 0, then pass 0, otherwise, pass gift.upgrade_star_count", "is_optional": false, "type": "int53" } }, "type": "UpgradeGiftResult" }, "uploadStickerFile": { "description": "Uploads a file with a sticker; returns the uploaded file", "args": { "sticker": { "description": "File to upload; must fit in a 512x512 square. For WEBP stickers the file must be in WEBP or PNG format, which will be converted to WEBP server-side.", "is_optional": false, "type": "InputFile" }, "sticker_format": { "description": "Sticker format", "is_optional": false, "type": "StickerFormat" }, "user_id": { "description": "Sticker file owner; ignored for regular users", "is_optional": false, "type": "int53" } }, "type": "File" }, "validateOrderInfo": { "description": "Validates the order information provided by a user and returns the available shipping options for a flexible invoice", "args": { "allow_save": { "description": "Pass true to save the order information", "is_optional": false, "type": "Bool" }, "input_invoice": { "description": "The invoice", "is_optional": false, "type": "InputInvoice" }, "order_info": { "description": "The order information, provided by the user; pass null if empty", "is_optional": true, "type": "orderInfo" } }, "type": "ValidatedOrderInfo" }, "viewMessages": { "description": "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).", "args": { "chat_id": { "description": "Chat identifier", "is_optional": false, "type": "int53" }, "force_read": { "description": "Pass true to mark as read the specified messages even if the chat is closed", "is_optional": false, "type": "Bool" }, "message_ids": { "description": "The identifiers of the messages being viewed", "is_optional": false, "type": "vector\u003cint53\u003e" }, "source": { "description": "Source of the message view; pass null to guess the source based on chat open state", "is_optional": true, "type": "MessageSource" } }, "type": "Ok" }, "viewPremiumFeature": { "description": "Informs TDLib that the user viewed detailed information about a Premium feature on the Premium features screen", "args": { "feature": { "description": "The viewed premium feature", "is_optional": false, "type": "PremiumFeature" } }, "type": "Ok" }, "viewSponsoredChat": { "description": "Informs TDLib that the user fully viewed a sponsored chat", "args": { "sponsored_chat_unique_id": { "description": "Unique identifier of the sponsored chat", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "viewTrendingStickerSets": { "description": "Informs the server that some trending sticker sets have been viewed by the user", "args": { "sticker_set_ids": { "description": "Identifiers of viewed trending sticker sets", "is_optional": false, "type": "vector\u003cint64\u003e" } }, "type": "Ok" }, "viewVideoMessageAdvertisement": { "description": "Informs TDLib that the user viewed a video message advertisement", "args": { "advertisement_unique_id": { "description": "Unique identifier of the advertisement", "is_optional": false, "type": "int53" } }, "type": "Ok" }, "writeGeneratedFilePart": { "description": "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", "args": { "data": { "description": "The data to write", "is_optional": false, "type": "bytes" }, "generation_id": { "description": "The identifier of the generation process", "is_optional": false, "type": "int64" }, "offset": { "description": "The offset from which to write the data to the file", "is_optional": false, "type": "int53" } }, "type": "Ok" } }, "options": { "active_story_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of active stories posted by the current user" }, "added_shareable_chat_folder_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of added shareable chat folders for the current user" }, "added_text_composition_style_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum number of added custom text composition styles" }, "affiliate_program_commission_per_mille_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.41. The maximum commission that can be used for an affiliate program" }, "affiliate_program_commission_per_mille_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.41. The minimum commission that can be used for an affiliate program" }, "always_parse_markdown": { "type": "Bool", "writable": true, "description": "If true, text entities will be automatically parsed in all inputMessageText objects" }, "animation_search_bot_username": { "type": "string", "writable": false, "description": "Username of a bot which can be used in inline mode for animations search" }, "anti_spam_bot_user_id": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. User identifier of the Telegram Anti-Spam bot" }, "authentication_token": { "type": "string", "writable": false, "description": "An authentication token to be used on subsequent authorizations" }, "authorization_date": { "type": "int64", "writable": false, "description": "Point in time (Unix timestamp) when authorization was received" }, "basic_group_size_max": { "type": "int64", "writable": false, "description": "The maximum number of members in a basic group" }, "bio_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum allowed length of the current user's bio" }, "bot_media_preview_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.34. The maximum number of media previews that can be added for a bot" }, "bot_verification_custom_description_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.42. The maximum length of custom description for verification provided by a third-party organization" }, "business_chat_link_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. The maximum number of created short chat links by a Telegram Business account" }, "business_start_page_message_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. The maximum allowed length of the start page message of a Telegram Business account" }, "business_start_page_title_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. The maximum allowed length of the start page title of a Telegram Business account" }, "call_connect_timeout_ms": { "type": "int64", "writable": false, "description": "The maximum time to wait for call connection creation to be passed to tgcalls" }, "call_packet_timeout_ms": { "type": "int64", "writable": false, "description": "The maximum time to wait for call packet delivery to be passed to tgcalls" }, "can_accept_calls": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.48. If true, the user can accept calls from this device" }, "can_archive_and_mute_new_chats_from_unknown_users": { "type": "Bool", "writable": false, "description": "If true, new chats from unknown users can be automatically archived and muted via archiveChatListSettings" }, "can_enable_paid_messages": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.46. If true, the user can enable paid messages" }, "can_gift_stars": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.34. If true, Telegram Stars can be gifted to other users" }, "can_ignore_sensitive_content_restrictions": { "type": "Bool", "writable": false, "description": "If true, the option “ignore_sensitive_content_restrictions” can be changed" }, "can_preload_weather": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.34. If true, the current weather must be preloaded before adding the media area to the story. Otherwise, weather must be loaded only after the user has chosen weather media area." }, "can_set_new_chat_privacy_settings": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.28. If true, then the current user can change privacy settings for new chats" }, "can_use_login_passkey": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.59. If true, then passkey can be used to log in and new passkeys can be added" }, "can_use_text_entities_in_story_caption": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.24. If true, then the current user can use text entities in story captions" }, "can_withdraw_chat_revenue": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.28. If true, then revenue from sponsored messages in chats can be withdrawn" }, "channel_bot_user_id": { "type": "int64", "writable": false, "description": "Identifier of the bot which is shown as the sender of messages sent on behalf of channels when viewed from an outdated client" }, "chat_available_reaction_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of manually chosen reactions for a chat" }, "chat_boost_level_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum boost level available to a chat" }, "chat_folder_chosen_chat_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of always included or excluded chats in a chat folder for the current user" }, "chat_folder_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of chat folders that the current user can have" }, "chat_folder_invite_link_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of shareable chat folders with owned invite links" }, "chat_folder_new_chats_update_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The minimum interval between calls to getChatFolderNewChats in shareable chat folders" }, "checklist_task_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.51. The maximum number of tasks in a checklist" }, "checklist_task_text_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.51. The maximum length of text of a task in a checklist" }, "checklist_title_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.51. The maximum length of title of a checklist" }, "commit_hash": { "type": "string", "writable": false, "description": "Since TDLib 1.8.24. If known, the hash of the source code commit that was used to build TDLib. Can be received synchronously." }, "community_bot_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.67. The maximum number of bots that can be added to a community" }, "community_chat_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.67. The maximum number of supergroups and channels that can be added to a community" }, "direct_channel_message_star_count_default": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.50. Default value for the price of incoming messages in direct channels" }, "disable_animated_emoji": { "type": "Bool", "writable": true, "description": "If true, animated emoji will be disabled and shown as plain emoji" }, "disable_contact_registered_notifications": { "type": "Bool", "writable": true, "description": "If true, notifications about the user's contacts who have joined Telegram will be disabled. User will still receive the corresponding message in the private chat. getOption needs to be called explicitly to fetch the latest value of the option, changed from another device" }, "disable_network_statistics": { "type": "Bool", "writable": true, "description": "Since TDLib 1.8.24. If true, then network statistics will be completely disabled" }, "disable_persistent_network_statistics": { "type": "Bool", "writable": true, "description": "If true, persistent network statistics will be disabled, which significantly reduces disk usage" }, "disable_sent_scheduled_message_notifications": { "type": "Bool", "writable": true, "description": "If true, notifications about outgoing scheduled messages that were sent will be disabled" }, "disable_time_adjustment_protection": { "type": "Bool", "writable": true, "description": "If true, protection from external time adjustment will be disabled, which significantly reduces disk usage" }, "disable_top_chats": { "type": "Bool", "writable": true, "description": "If true, support for top chats and statistics collection is disabled" }, "enabled_proxy_id": { "type": "int64", "writable": false, "description": "Identifier of the enabled proxy" }, "expect_blocking": { "type": "Bool", "writable": false, "description": "If true, access to Telegram is likely blocked for the user" }, "fact_check_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.30. The maximum allowed length of a fact-check" }, "favorite_stickers_limit": { "type": "int64", "writable": false, "description": "The maximum number of favorite stickers" }, "forwarded_message_count_max": { "type": "int64", "writable": false, "description": "The maximum number of forwarded messages per one request" }, "gift_collection_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.53. The maximum number of gift collections" }, "gift_collection_size_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.54. The maximum number of gifts in a gift collection" }, "gift_premium_from_attachment_menu": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.24. If true, then a suggestion to gift Telegram Premium needs to be shown in the attachment menu if appropriate" }, "gift_premium_from_input_field": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.24. If true, then a suggestion to gift Telegram Premium needs to be shown in the input field if appropriate" }, "gift_resale_earnings_per_mille": { "type": "int64", "writable": false, "description": "TDLib 1.8.49-1.8.52. The amount of Telegram Stars received by the user for each 1000 Telegram Stars paid for gifts bought from them" }, "gift_resale_gram_cent_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum price in 1/100 of TON Gram for a gift that is available for resale" }, "gift_resale_gram_cent_count_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The minimum price in 1/100 of TON Gram for a gift that is available for resale" }, "gift_resale_gram_earnings_per_mille": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The amount of TON Grams received by the user for each 1000 Grams paid for gifts bought from them" }, "gift_resale_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.49. The maximum price in Telegram Stars for a gift that is available for resale" }, "gift_resale_star_count_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.49. The minimum price in Telegram Stars for a gift that is available for resale" }, "gift_resale_star_earnings_per_mille": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.53. The amount of Telegram Stars received by the user for each 1000 Telegram Stars paid for gifts bought from them" }, "gift_resale_toncoin_cent_count_max": { "type": "int64", "writable": false, "description": "TDLib 1.8.53-1.8.64. The maximum price in 1/100 of TON Gram for a gift that is available for resale" }, "gift_resale_toncoin_cent_count_min": { "type": "int64", "writable": false, "description": "TDLib 1.8.53-1.8.64. The minimum price in 1/100 of TON Gram for a gift that is available for resale" }, "gift_resale_toncoin_earnings_per_mille": { "type": "int64", "writable": false, "description": "TDLib 1.8.53-1.8.64. The amount of TON Grams received by the user for each 1000 Grams paid for gifts bought from them" }, "gift_sell_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.38. The number of seconds after gift receiving for which it can be sold for Telegram Stars" }, "gift_text_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.37. The maximum length of a message added to a sent gift" }, "giveaway_additional_chat_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of additional chats that can be added to a giveaway" }, "giveaway_boost_count_per_premium": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of boosts that received by the channel for each giveaway prize" }, "giveaway_country_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of countries that can be added to a giveaway" }, "giveaway_duration_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of additional chats that can be added to a giveaway" }, "gram_top_up_url": { "type": "string", "writable": false, "description": "Since TDLib 1.8.65. The URL that can be used to top up TON Gram balance of the current user" }, "group_anonymous_bot_user_id": { "type": "int64", "writable": false, "description": "Identifier of the bot which is shown as the sender of anonymous messages in groups when viewed from an outdated client" }, "group_call_message_text_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.56. The maximum length of a message text in a group call that isn't a live story" }, "group_call_participant_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.48. The maximum number of participants in a group call that is not bound to a chat" }, "ignore_background_updates": { "type": "Bool", "writable": true, "description": "If true, allows to skip all updates received while the TDLib instance was not running. The option does nothing if the database or secret chats are used" }, "ignore_default_disable_notification": { "type": "Bool", "writable": true, "description": "If true, the disable_notification value specified in the request will be always used instead of the default value" }, "ignore_file_names": { "type": "Bool", "writable": true, "description": "Since TDLib 1.8.24. If true, document file names will be ignored and numerical names will be used instead" }, "ignore_inline_thumbnails": { "type": "Bool", "writable": true, "description": "If true, prevents file thumbnails sent by the server along with messages from being saved on the disk" }, "ignore_platform_restrictions": { "type": "Bool", "writable": true, "description": "If true, chat and message restrictions specific to the currently used operating system will be ignored" }, "ignore_sensitive_content_restrictions": { "type": "Bool", "writable": true, "description": "If true, sensitive content will be shown on all user devices. getOption needs to be called explicitly to fetch the latest value of the option, changed from another device" }, "is_paid_reaction_anonymous": { "type": "Bool", "writable": true, "description": "TDLib 1.8.36-1.8.44. If true, added paid reactions are anonymous by default. If false, they are non-anonymous." }, "is_premium": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.24. If true, then the current user subscribed to Telegram Premium" }, "is_premium_available": { "type": "Bool", "writable": false, "description": "Since TDLib 1.8.24. If true, then the current user can subscribe to Telegram Premium. Otherwise, all premium-related features must be hidden" }, "language_pack_database_path": { "type": "string", "writable": true, "description": "Path to a database for storing language pack strings, so that this database can be shared between different accounts. By default, language pack strings are stored only in memory. Changes of value of this option will be applied only after TDLib restart, so it should be set before call to setTdlibParameters." }, "language_pack_id": { "type": "string", "writable": true, "description": "Identifier of the currently used language pack from the current localization target" }, "localization_target": { "type": "string", "writable": true, "description": "Name for the current localization target (for example, “android”, “android_x”, “ios”, “macos”, “tdesktop”, “unigram”, “web”, “webz”)" }, "login_passkey_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.59. The maximum number of login passkeys that can be added" }, "message_caption_length_max": { "type": "int64", "writable": false, "description": "The maximum length of a message caption" }, "message_reply_quote_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum length of quote from the replied message" }, "message_text_length_max": { "type": "int64", "writable": false, "description": "The maximum length of a message text" }, "message_unload_delay": { "type": "int64", "writable": true, "description": "The maximum time messages are stored in memory before they are unloaded, 60-86400; in seconds. Defaults to 60 for users and 1800 for bots" }, "million_gram_to_usd_rate": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The number of US dollars that can be received by selling 1000000 TON Grams on a third-party exchange" }, "million_toncoin_to_usd_rate": { "type": "int64", "writable": false, "description": "TDLib 1.8.52-1.8.64. The number of US dollars that can be received by selling 1000000 TON Grams on a third-party exchange" }, "monthly_sent_story_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of stories that can be posted per month by the current user" }, "my_id": { "type": "int64", "writable": false, "description": "Identifier of the current user" }, "notification_group_count_max": { "type": "int64", "writable": true, "description": "The maximum number of notification groups to be shown simultaneously, 0-25" }, "notification_group_size_max": { "type": "int64", "writable": true, "description": "The maximum number of simultaneously shown notifications in a group, 1-25. Defaults to 10" }, "notification_sound_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of saved notification sounds" }, "notification_sound_duration_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum duration of an audio that can be used as a notification sound" }, "notification_sound_size_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum size of the audio file that can be used as a notification sound" }, "online": { "type": "Bool", "writable": true, "description": "Online status of the current user" }, "owned_bot_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.63. The maximum number of bots that can be owned by the current user" }, "paid_group_call_message_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.57. The maximum number of Telegram Stars that can be set as the price for paid group call messages" }, "paid_media_message_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.32. The maximum price of a paid post in Telegram Stars" }, "paid_message_earnings_per_mille": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.46. The amount of Telegram Stars received by the user or the supergroup for each 1000 Telegram Stars paid for their incoming messages" }, "paid_message_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.46. The maximum number of Telegram Stars that can be set as the price for paid messages" }, "paid_reaction_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.35. The maximum number of Telegram Stars that can be added as paid reaction to a message in one request" }, "pending_text_message_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.56. The maximum number of seconds to show a pending message from a bot" }, "photo_search_bot_username": { "type": "string", "writable": false, "description": "Username of a bot which can be used in inline mode for photos search" }, "pinned_archived_chat_count_max": { "type": "int64", "writable": false, "description": "The maximum number of pinned cloud chats in the Archive chat list for the current user. The same amount of secret chats can be pinned locally" }, "pinned_chat_count_max": { "type": "int64", "writable": false, "description": "The maximum number of pinned cloud chats in the Main chat list for the current user. The same amount of secret chats can be pinned locally" }, "pinned_forum_topic_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of pinned forum topics" }, "pinned_gift_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.46. The maximum number of pinned unique gifts" }, "pinned_saved_messages_topic_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of pinned topics in Saved Messages for the current user" }, "pinned_story_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.29. The maximum number of pinned stories on a chat page" }, "poll_answer_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.50. The maximum number of options in a poll message" }, "poll_country_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.63. The maximum number of countries for which a poll can be restricted" }, "poll_open_period_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.63. The maximum amount of time after which the poll may be automatically closed; in seconds" }, "prefer_ipv6": { "type": "Bool", "writable": true, "description": "If true, IPv6 addresses will be preferred over IPv4 addresses" }, "premium_download_speedup": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. Approximate number of times file download speed will increase if the user subscribes to Telegram Premium" }, "premium_gift_boost_count": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of boosts that is obtained by gifting Telegram Premium to another user" }, "premium_upload_speedup": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. Approximate number of times file upload speed will increase if the user subscribes to Telegram Premium" }, "process_pinned_messages_as_mentions": { "type": "Bool", "writable": true, "description": "Since TDLib 1.8.24. If true, then all pinned messages will be treated as mentions even posted without notification of chat members" }, "quick_reply_shortcut_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. The maximum number of quick reply shortcuts that can be created by a Telegram Business account" }, "quick_reply_shortcut_message_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.28. The maximum number of messages that can be added to a quick reply shortcut by a Telegram Business account" }, "replies_bot_chat_id": { "type": "int64", "writable": false, "description": "Identifier of the @replies bot" }, "rich_message_block_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum number of blocks in a rich message" }, "rich_message_depth_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum depth of nested blocks in a rich message" }, "rich_message_media_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum number of media files in a rich message" }, "rich_message_table_column_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum number of columns in a table of a rich message" }, "rich_message_text_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum length of a rich message text" }, "show_message_edit_date_by_default": { "type": "Bool", "writable": false, "description": "If true, then message edit date must be shown along the message instead of the message send date" }, "stake_dice_stake_amount_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.60. The maximum amount of TON Grams that can be staked for a roll in nanograms" }, "stake_dice_stake_amount_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.60. The minimum amount of TON Grams that can be staked for a roll in nanograms" }, "star_withdrawal_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The maximum number of Telegram Stars that can be withdrawn" }, "star_withdrawal_count_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.31. The minimum number of Telegram Stars that can be withdrawn" }, "story_album_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.53. The maximum number of story albums" }, "story_album_size_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.54. The maximum number of stories in a story album" }, "story_caption_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum length of story caption for the current user" }, "story_link_area_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.31. The maximum number of link areas that can be added to a story by Telegram Premium users" }, "story_stealth_mode_cooldown_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of seconds that must pass between before Stealth Mode can be enabled again" }, "story_stealth_mode_future_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of seconds in the future the Stealth Mode will last" }, "story_stealth_mode_past_period": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of seconds in the past during which all views of stories from the current user will be hidden if Stealth Mode is enabled" }, "story_suggested_reaction_area_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of suggested reaction areas that can be added to a story" }, "story_viewers_expiration_delay": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The number of seconds after story expiration date for which story viewers still can be received" }, "subscription_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.35. The maximum number of Telegram Stars that can be asked for monthly subscription to a chat" }, "suggested_language_pack_id": { "type": "string", "writable": false, "description": "Identifier of the language pack, suggested for the user by the server" }, "suggested_post_gram_cent_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The maximum price of a suggested post in TON Gram cents" }, "suggested_post_gram_cent_count_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The minimum price of a suggested post in TON Gram cents" }, "suggested_post_gram_earnings_per_mille": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.65. The amount of TON Grams received by a channel for each 1000 Grams paid for suggested post publication in the channel" }, "suggested_post_lifetime_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The minimum amount of time for which a suggested post must be published in a channel to receive payment for the post; in seconds" }, "suggested_post_send_delay_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The maximum delay for suggested post publish date; in seconds" }, "suggested_post_send_delay_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The minimum delay for suggested post publish date; in seconds" }, "suggested_post_star_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The maximum price of a suggested post in Telegram Stars" }, "suggested_post_star_count_min": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The minimum price of a suggested post in Telegram Stars" }, "suggested_post_star_earnings_per_mille": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.52. The amount of Telegram Stars received by a channel for each 1000 Telegram Stars paid for suggested post publication in the channel" }, "suggested_post_toncoin_cent_count_max": { "type": "int64", "writable": false, "description": "TDLib 1.8.52-1.8.64. The maximum price of a suggested post in TON Gram cents" }, "suggested_post_toncoin_cent_count_min": { "type": "int64", "writable": false, "description": "TDLib 1.8.52-1.8.64. The minimum price of a suggested post in TON Gram cents" }, "suggested_post_toncoin_earnings_per_mille": { "type": "int64", "writable": false, "description": "TDLib 1.8.52-1.8.64. The amount of TON Grams received by a channel for each 1000 Grams paid for suggested post publication in the channel" }, "suggested_video_note_audio_bitrate": { "type": "int64", "writable": false, "description": "Suggested bit rate for audio encoding in video notes, in kbit/s" }, "suggested_video_note_length": { "type": "int64", "writable": false, "description": "Suggested width and height of the video in video notes" }, "suggested_video_note_video_bitrate": { "type": "int64", "writable": false, "description": "Suggested bit rate for video encoding in video notes, in kbit/s" }, "supergroup_size_max": { "type": "int64", "writable": false, "description": "The maximum number of members in a supergroup" }, "t_me_url": { "type": "string", "writable": false, "description": "Current value of t.me URL, i.e. https://t.me/" }, "telegram_service_notifications_chat_id": { "type": "int64", "writable": false, "description": "Identifier of the Telegram Service Notifications chat" }, "test_mode": { "type": "Bool", "writable": false, "description": "If true, the test environment is being used instead of the production environment" }, "text_composition_style_example_count": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.64. The number of examples that are available for each text composition style" }, "text_composition_style_prompt_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.64. The maximum allowed length of the text composition style prompt" }, "text_composition_style_title_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.64. The maximum allowed length of the text composition style title" }, "thousand_star_to_usd_rate": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.35. The number of US dollars that can be received by withdrawing 1000 Telegram Stars" }, "ton_blockchain_explorer_url": { "type": "string", "writable": false, "description": "Since TDLib 1.8.45. A prefix of the URL that can be used to get information about a TON blockchain address" }, "toncoin_top_up_url": { "type": "string", "writable": false, "description": "TDLib 1.8.52-1.8.64. The URL that can be used to top up TON Gram balance of the current user" }, "unix_time": { "type": "int64", "writable": false, "description": "An estimation of the current Unix timestamp. The option will not be updated automatically unless the difference between the previous estimation and the locally available monotonic clocks changes significantly" }, "usd_to_thousand_star_rate": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.35. The number of US dollars needed to buy 1000 Telegram Stars" }, "use_pfs": { "type": "Bool", "writable": true, "description": "If true, Perfect Forward Secrecy will be enabled for interaction with the Telegram servers for cloud chats" }, "use_quick_ack": { "type": "Bool", "writable": true, "description": "If true, quick acknowledgement will be enabled for outgoing messages" }, "use_storage_optimizer": { "type": "Bool", "writable": true, "description": "If true, the background storage optimizer will be enabled" }, "user_note_text_length_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.56. The maximum length of text of a user note" }, "utc_time_offset": { "type": "int64", "writable": true, "description": "A UTC time offset used for splitting messages by days. The option is reset automatically on each TDLib instance launch, so it needs to be set manually only if the time offset is changed during execution." }, "venue_search_bot_username": { "type": "string", "writable": false, "description": "Username of a bot which can be used in inline mode for venues search" }, "verification_codes_bot_chat_id": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.37. Identifier of the Verification Codes chat with codes from Telegram Gateway" }, "version": { "type": "string", "writable": false, "description": "TDLib version. This options is guaranteed to come before all other updates. Can be received synchronously." }, "web_app_allowed_protocols": { "type": "string", "writable": false, "description": "Since TDLib 1.8.32. A space-separated list of URL protocols that are allowed to be open by the call to web_app_open_link from Web Apps." }, "weekly_sent_story_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.24. The maximum number of stories that can be posted per week by the current user" }, "welcome_message_count_max": { "type": "int64", "writable": false, "description": "Since TDLib 1.8.67. The maximum number of welcome messages that can be added for a chat" } } }