GramIO API Reference / gramio/dist / TelegramGiftInfo
Interface: TelegramGiftInfo
Defined in: @gramio/types/out/objects.d.ts:4984
Describes a service message about a regular gift that was sent or received.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
can_be_upgraded? | true | Optional. True, if the gift can be upgraded to a unique gift | @gramio/types/out/objects.d.ts:5008 |
convert_star_count? | number | Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible | @gramio/types/out/objects.d.ts:4996 |
entities? | TelegramMessageEntity[] | Optional. Special entities that appear in the text | @gramio/types/out/objects.d.ts:5016 |
gift | TelegramGift | Information about the gift | @gramio/types/out/objects.d.ts:4988 |
is_private? | true | Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | @gramio/types/out/objects.d.ts:5020 |
is_upgrade_separate? | true | Optional. True, if the gift's upgrade was purchased after the gift was sent | @gramio/types/out/objects.d.ts:5004 |
owned_gift_id? | string | Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | @gramio/types/out/objects.d.ts:4992 |
prepaid_upgrade_star_count? | number | Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift | @gramio/types/out/objects.d.ts:5000 |
text? | string | Optional. Text of the message that was added to the gift | @gramio/types/out/objects.d.ts:5012 |
unique_gift_number? | number | Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift | @gramio/types/out/objects.d.ts:5024 |