Skip to content

GiftInfo

Describes a service message about a regular gift that was sent or received.

10 fields, 1 required.

Fields

gift Gift Required
Information about the gift.

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

convert_star_count number
Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible.

prepaid_upgrade_star_count number
Number of Telegram Stars that were prepaid for the ability to upgrade the gift.

is_upgrade_separate boolean
True, if the gift’s upgrade was purchased after the gift was sent.

can_be_upgraded boolean
True, if the gift can be upgraded to a unique gift.

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.

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