Represents a collectible star gift, see here » for more info.
The sticker that represents the gift is contained in a starGiftAttributeModel object in attributes.
Constructor schema is available as of layer 197. Switch »| Name | Type | Description |
|---|---|---|
| flags | # | Flags, see TL conditional fields |
| require_premium | flags.6?true | This gift can only be bought by users with a Premium subscription. |
| resale_ton_only | flags.7?true | Whether the gift can be bought only using Toncoins. |
| theme_available | flags.9?true | A chat theme associated to this gift is available, see here » for more info on how to use it. |
| burned | flags.14?true | This gift was already used as an ingredient for crafting another collectible gift ». |
| crafted | flags.15?true | This collectible gift was obtained by crafting », not by upgrading a regular gift. |
| id | long | Unique identifier of this collectible gift. |
| gift_id | long | ID of the regular gift from which this gift was upgraded (all collectible gifts upgraded from the same gift will have the same gift_id, with different attributes). |
| title | string | Collectible title. |
| slug | string | Slug that can be used to create a collectible gift deep link », or elsewhere in the API where a collectible slug is accepted. |
| num | int | Unique identifier of this collectible gift among all (already upgraded) collectible gifts of the same type. |
| owner_id | flags.0?Peer | The owner of the gift. |
| owner_name | flags.1?string | The name of the owner if neither owner_id nor owner_address are set. |
| owner_address | flags.2?string | For NFTs on the TON blockchain, contains the address of the owner (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address). |
| attributes | Vector<StarGiftAttribute> | Collectible attributes |
| availability_issued | int | Total number of gifts of the same type that were upgraded to a collectible gift. |
| availability_total | int | Total number of gifts of the same type that can be upgraded or were already upgraded to a collectible gift. |
| gift_address | flags.3?string | For NFTs on the TON blockchain, contains the address of the NFT (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address). |
| resell_amount | flags.4?Vector<StarsAmount> | Resale price of the gift. |
| released_by | flags.5?Peer | This gift was released by the specified peer. |
| value_amount | flags.8?long | Estimated price of the gift. |
| value_currency | flags.8?string | Currency for the gift's estimated price. |
| value_usd_amount | flags.8?long | Estimated price of the gift in USD cents. |
| theme_peer | flags.10?Peer | The current chat where the associated chat theme is installed, if any (gift-based themes can only be installed in one chat at a time). |
| peer_color | flags.11?PeerColor | Can contain a collectible message palette ». |
| host_id | flags.12?Peer | If set, the gift is currently hosted on the specified user or channel profile even though ownership belongs to a TON wallet. The owner may transfer, resell or export the gift, while the host or owner may show it on the profile, use it as a theme/status and add it to a collection. |
| offer_min_stars | flags.13?int | If set, you can send a purchase offer for this gift »: the minimum offer price is specified in this flag. |
| craft_chance_permille | flags.16?int | Success probability, per 1000, contributed by this gift when it is used for crafting ». |
Telegram Premium is an optional subscription service that unlocks additional exclusive client-side and API-side features, while helping support the development of the app.
Telegram apps support generating, sharing and synchronizing app themes.
Users can send Gifts to their friends. The recipients of gifts can display them on their profile pages or turn them into Telegram Stars ». Telegram Stars can be used for many things, including supporting creators and buying services in mini apps.
Telegram clients must handle special tg:// and t.me deep links encountered in messages, link entities and in other apps by registering OS handlers.
The MTProto API has multiple configuration parameters that can be fetched with the appropriate methods.
Telegram users and channels can change the accent color and background pattern of their profile page and their messages!
The model of a collectible gift ».