GiftCode¶

class pyrogram.types.GiftCode¶

Contains gift code data.

Parameters:¶

• via_giveaway (``bool``) – True if the gift code is received via giveaway.

• is_unclaimed (``bool``) – True, if the winner for the corresponding Telegram Premium subscription wasn’t chosen. The code is received by creator of a chat, which started the giveaway that had less winners than planned.

• boosted_chat (:obj:`~pyrogram.types.Chat`) – The channel where the gift code was won.

• premium_subscription_month_count (``int``) – Number of months of subscription.

• slug (``str``) – Identifier of gift code. You can combine it with t.me/giftcode/{slug} to get link for this gift.

• currency (``str``) – Currency for the paid amount

• amount (``int``) – The paid amount, in the smallest units of the currency

• cryptocurrency (``str``) – Cryptocurrency used to pay for the gift; may be empty if none

• cryptocurrency_amount (``int``) – The paid amount, in the smallest units of the cryptocurrency; 0 if none

• caption (``str``, *optional*) – Text message chosen by the sender.

• caption_entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*) – Entities of the text message.

• link (``str``, *property*) – Generate a link to this gift code.