ReceivedGift¶
Represents a gift received by a user or a chat
ReceivedGift(
received_gift_id: string,
sender_id: MessageSender,
text: FormattedText,
unique_gift_number: int32,
is_private: Bool,
is_saved: Bool,
is_pinned: Bool,
can_be_upgraded: Bool,
can_be_transferred: Bool,
was_refunded: Bool,
date: int32,
gift: SentGift,
collection_ids: list of int32,
sell_star_count: int53,
prepaid_upgrade_star_count: int53,
is_upgrade_separate: Bool,
transfer_star_count: int53,
drop_original_details_star_count: int53,
next_transfer_date: int32,
next_resale_date: int32,
export_date: int32,
prepaid_upgrade_hash: string,
craft_date: int32
) → ReceivedGift
received_gift_id¶
string
Unique identifier of the received gift for the current user; only for the receiver of the gift
sender_id¶
Identifier of a user or a chat that sent the gift; may be null if unknown
text¶
Message added to the gift
unique_gift_number¶
int32
Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned
is_private¶
Bool
True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone are able to see them
is_saved¶
Bool
True, if the gift is displayed on the chat's profile page; only for the receiver of the gift
is_pinned¶
Bool
True, if the gift is pinned to the top of the chat's profile page
can_be_upgraded¶
Bool
True, if the gift is a regular gift that can be upgraded to a unique gift; only for the receiver of the gift
can_be_transferred¶
Bool
True, if the gift is an upgraded gift that can be transferred to another owner; only for the receiver of the gift
was_refunded¶
Bool
True, if the gift was refunded and isn't available anymore
date¶
int32
Point in time (Unix timestamp) when the gift was sent
gift¶
The gift
collection_ids¶
list of int32
Identifiers of collections to which the gift is added; only for the receiver of the gift
sell_star_count¶
int53
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
prepaid_upgrade_star_count¶
int53
Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift
is_upgrade_separate¶
Bool
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
transfer_star_count¶
int53
Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift
drop_original_details_star_count¶
int53
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
next_transfer_date¶
int32
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
next_resale_date¶
int32
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
export_date¶
int32
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
prepaid_upgrade_hash¶
string
If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade
craft_date¶
int32
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