Gift
This object represents a gift that can be sent by the bot.
fields
| field | type | required | description |
|---|---|---|---|
id | string | required | Unique identifier of the gift |
sticker | Sticker | required | The sticker that represents the gift |
star_count | number | required | The number of Telegram Stars that must be paid to send the sticker |
upgrade_star_count | number | optional | Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one |
is_premium | boolean | optional | Optional. True, if the gift can only be purchased by Telegram Premium subscribers |
has_colors | boolean | optional | Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance |
total_count | number | optional | Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only |
remaining_count | number | optional | Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only |
personal_total_count | number | optional | Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only |
personal_remaining_count | number | optional | Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only |
background | GiftBackground | optional | Optional. Background of the gift |
unique_gift_variant_count | number | optional | Optional. The total number of different unique gifts that can be obtained by upgrading the gift |
publisher_chat | Chat | optional | Optional. Information about the chat that published the gift |
import
import type { Gift } from "@yaebal/types";used by
types
official Bot API docs: https://core.telegram.org/bots/api/#gift