Skip to main content

messageActionStarGift

You received a gift, see here » for more info.

type tg.MessageActionStarGift struct { /* ... */ }

Implements MessageAction.

Fields

NameTypeRequiredDescription
NameHiddenboolIf set, the name of the sender of the gift will be hidden if the destination user decides to display the gift on their profile
SavedboolWhether this gift was added to the destination user's profile (may be toggled using payments.saveStarGift and fetched using payments.getSavedStarGifts)
ConvertedboolWhether this gift was converted to Telegram Stars and cannot be displayed on the profile anymore.
UpgradedboolThis gift was upgraded to a collectible gift ».
RefundedboolThis gift is not available anymore because a request to refund the payment related to this gift was made, and the money was returned.
CanUpgradeboolIf set, this gift can be upgraded to a collectible gift; can only be set for the receiver of a gift.
PrepaidUpgradeboolThe sender has already pre-paid for the upgrade of this gift to a collectible gift.
UpgradeSeparateboolThis service message is the notification of a separate pre-payment for the upgrade of a gift we own.
AuctionAcquiredboolIf set, this gift was acquired in a collectible gifts auction ».
GiftStarGiftClassyesInfo about the gift
MessageTextWithEntitiesAdditional message from the sender of the gift
ConvertStarsint64The 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.
UpgradeMsgIDintIf set, this gift was upgraded to a collectible gift, and the corresponding messageActionStarGiftUnique is available at the specified message ID.
UpgradeStarsint64The number of Telegram Stars the user can pay to convert the gift into a collectible gift ».
FromIDPeerClassSender of the gift (unset for anonymous gifts).
PeerPeerClassReceiver of the gift.
SavedIDint64For channel gifts, ID to use in inputSavedStarGiftChat constructors.
PrepaidUpgradeHashstringHash to prepay for a gift upgrade separately ».
GiftMsgIDintFor separate upgrades, the identifier of the message with the gift whose upgrade was prepaid (only valid for the receiver of the service message).
ToIDPeerClassToID field of MessageActionStarGift.
GiftNumintGiftNum field of MessageActionStarGift.

References