OwnedGiftRegular

Official docs ↗

Describes a regular gift owned by a user or a chat.

Fields

typeString = regularRequired

Type of the gift, always "regular"

giftGiftRequired

Information about the regular gift

owned_gift_idStringOptional

Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only

sender_userUserOptional

Optional. Sender of the gift if it is a known user

send_dateIntegerRequired

Date the gift was sent in Unix time

textStringOptional

Optional. Text of the message that was added to the gift

entitiesMessageEntity[]Optional

Optional. Special entities that appear in the text

is_privateTrueOptional

Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

is_savedTrueOptional

Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only

can_be_upgradedTrueOptional

Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only

was_refundedTrueOptional

Optional. True, if the gift was refunded and isn't available anymore

convert_star_countIntegerOptional

Optional. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only

prepaid_upgrade_star_countIntegerOptional

Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift

is_upgrade_separateTrueOptional

Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only

unique_gift_numberIntegerOptional

Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift

GramIO Usage

See Also