telegram api constructor · layer 229 · #313a9547

starGift

Represents a star gift, see here » for more info.

definition

starGift#313a9547 flags:# limited:flags.0?true sold_out:flags.1?true birthday:flags.2?true require_premium:flags.7?true limited_per_user:flags.8?true peer_color_available:flags.10?true auction:flags.11?true id:long sticker:Document stars:long availability_remains:flags.0?int availability_total:flags.0?int availability_resale:flags.4?long convert_stars:long first_sale_date:flags.1?int last_sale_date:flags.1?int upgrade_stars:flags.3?long resell_min_stars:flags.4?long title:flags.5?string released_by:flags.6?Peer per_user_total:flags.8?int per_user_remains:flags.8?int locked_until_date:flags.9?int auction_slug:flags.11?string gifts_per_round:flags.11?int auction_start_date:flags.11?int upgrade_variants:flags.12?int background:flags.13?StarGiftBackground = StarGift;

parameters

nametypedescription
flags#Flags, see TL conditional fields
limitedflags.0?trueWhether this is a limited-supply gift.
sold_outflags.1?trueWhether this gift sold out and cannot be bought anymore.
birthdayflags.2?trueWhether this is a birthday-themed gift
require_premiumflags.7?trueThis gift can only be bought by users with a Premium subscription.
limited_per_userflags.8?trueIf set, the maximum number of gifts of this type that can be owned by a single user is limited and specified in per_user_total, and the remaining slots for the current user in per_user_remains.
peer_color_availableflags.10?true
auctionflags.11?true
idlongIdentifier of the gift
stickerDocumentSticker that represents the gift.
starslongPrice of the gift in Telegram Stars.
availability_remainsflags.0?intFor limited-supply gifts: the remaining number of gifts that may be bought.
availability_totalflags.0?intFor limited-supply gifts: the total number of gifts that was available in the initial supply.
availability_resaleflags.4?longThe total number of (upgraded to collectibles) gifts of this type currently on resale
convert_starslongThe receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars.
first_sale_dateflags.1?intFor sold out gifts only: when was the gift first bought.
last_sale_dateflags.1?intFor sold out gifts only: when was the gift last bought.
upgrade_starsflags.3?longThe number of Telegram Stars the user can pay to convert the gift into a collectible gift ».
resell_min_starsflags.4?longThe minimum price in Stars for gifts of this type currently on resale.
titleflags.5?stringTitle of the gift
released_byflags.6?PeerThis gift was released by the specified peer.
per_user_totalflags.8?intMaximum number of gifts of this type that can be owned by any user.
per_user_remainsflags.8?intRemaining number of gifts of this type that can be owned by the current user.
locked_until_dateflags.9?intIf set, the specified gift possibly cannot be sent until the specified date, see here » for the full flow.
auction_slugflags.11?string
gifts_per_roundflags.11?int
auction_start_dateflags.11?int
upgrade_variantsflags.12?int
backgroundflags.13?StarGiftBackground

type

StarGift · other constructors: starGiftUnique

history

present in layers 189–229 · constructor id changed 8×

idlayers
#aea174ee189–190
#49c577cd191–195
#02cc73c8196–202
#c62aca28203–206
#7f853c12207–209
#00bcff5b210–212
#80ac53c3213–217
#1b9a4d7f218–219
#313a9547220–229