Skip to content

OwnedGiftRegular

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

15 fields, 3 required.

Fields

type "regular" Required
Type of the gift, always “regular”.

gift Gift Required
Information about the regular gift.

send_date number Required
Date the gift was sent in Unix time.

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

sender_user User
Sender of the gift if it is a known user.

text string
Text of the message that was added to the gift.

entities MessageEntity[]
Special entities that appear in the text.

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

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

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

was_refunded boolean
True, if the gift was refunded and isn’t available anymore.

convert_star_count number
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_count number
Number of Telegram Stars that were paid for the ability to upgrade the gift.

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

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