Gift

class telegram.Gift(id, sticker, star_count, total_count=None, remaining_count=None, upgrade_star_count=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object represents a gift that can be sent by the bot.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal if their id is equal.

Use In

telegram.Bot.send_gift()

Available In

Added in version 21.8.

Parameters:

  • id (str) – Unique identifier of the gift

  • sticker (Sticker) – The sticker that represents the gift

  • star_count (int) – The number of Telegram Stars that must be paid to send the sticker

  • total_count (int, optional) – The total number of the gifts of this type that can be sent; for limited gifts only

  • remaining_count (int, optional) – The number of remaining gifts of this type that can be sent; for limited gifts only

  • upgrade_star_count (int, optional) –

    The number of Telegram Stars that must be paid to upgrade the gift to a unique one

    Added in version 21.10.

id[source]

Unique identifier of the gift

Type:

str

sticker[source]

The sticker that represents the gift

Type:

Sticker

star_count[source]

The number of Telegram Stars that must be paid to send the sticker

Type:

int

total_count[source]

Optional. The total number of the gifts of this type that can be sent; for limited gifts only

Type:

int

remaining_count[source]

Optional. The number of remaining gifts of this type that can be sent; for limited gifts only

Type:

int

upgrade_star_count[source]

Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one

Added in version 21.10.

Type:

int

classmethod de_json(data, bot=None)[source]

See telegram.TelegramObject.de_json().