GramIO API Reference / gramio/dist / TelegramGift
Interface: TelegramGift
Defined in: @gramio/types/out/objects.d.ts:5144
This object represents a gift that can be sent by the bot.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
background? | TelegramGiftBackground | Optional. Background of the gift | @gramio/types/out/objects.d.ts:5188 |
has_colors? | true | Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance | @gramio/types/out/objects.d.ts:5168 |
id | string | Unique identifier of the gift | @gramio/types/out/objects.d.ts:5148 |
is_premium? | true | Optional. True, if the gift can only be purchased by Telegram Premium subscribers | @gramio/types/out/objects.d.ts:5164 |
personal_remaining_count? | number | Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | @gramio/types/out/objects.d.ts:5184 |
personal_total_count? | number | Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only | @gramio/types/out/objects.d.ts:5180 |
publisher_chat? | TelegramChat | Optional. Information about the chat that published the gift | @gramio/types/out/objects.d.ts:5196 |
remaining_count? | number | Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only | @gramio/types/out/objects.d.ts:5176 |
star_count | number | The number of Telegram Stars that must be paid to send the sticker | @gramio/types/out/objects.d.ts:5156 |
sticker | TelegramSticker | The sticker that represents the gift | @gramio/types/out/objects.d.ts:5152 |
total_count? | number | Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only | @gramio/types/out/objects.d.ts:5172 |
unique_gift_variant_count? | number | Optional. The total number of different unique gifts that can be obtained by upgrading the gift | @gramio/types/out/objects.d.ts:5192 |
upgrade_star_count? | number | Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one | @gramio/types/out/objects.d.ts:5160 |