telegram.Sticker

class telegram.Sticker(*args, **kwargs)[source]

Bases: telegram.TelegramObject

This object represents a sticker.

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

Note

As of v13.11 is_video is a required argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.

Parameters
  • file_id (str) – Identifier for this file, which can be used to download or reuse the file.

  • file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

  • width (int) – Sticker width.

  • height (int) – Sticker height.

  • is_animated (bool) – True, if the sticker is animated.

  • is_video (bool) –

    True, if the sticker is a video sticker.

    New in version 13.11.

  • type (str) –

    Type of the sticker. Currently one of REGULAR, MASK, CUSTOM_EMOJI. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

    New in version 20.0.

  • thumb (telegram.PhotoSize, optional) – Sticker thumbnail in the .WEBP or .JPG format.

  • emoji (str, optional) – Emoji associated with the sticker

  • set_name (str, optional) – Name of the sticker set to which the sticker belongs.

  • mask_position (telegram.MaskPosition, optional) – For mask stickers, the position where the mask should be placed.

  • file_size (int, optional) – File size in bytes.

  • bot (telegram.Bot, optional) – The Bot to use for instance methods.

  • premium_animation (telegram.File, optional) –

    For premium regular stickers, premium animation for the sticker.

    New in version 20.0.

  • custom_emoji (str, optional) –

    For custom emoji stickers, unique identifier of the custom emoji.

    New in version 20.0.

  • _kwargs (dict) – Arbitrary keyword arguments.

file_id[source]

Identifier for this file.

Type

str

file_unique_id[source]

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Type

str

width[source]

Sticker width.

Type

int

height[source]

Sticker height.

Type

int

is_animated[source]

True, if the sticker is animated.

Type

bool

is_video[source]

True, if the sticker is a video sticker.

New in version 13.11.

Type

bool

type[source]

Type of the sticker. Currently one of REGULAR, MASK, CUSTOM_EMOJI. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

New in version 20.0.

Type

str

thumb[source]

Optional. Sticker thumbnail in the .WEBP or .JPG format.

Type

telegram.PhotoSize

emoji[source]

Optional. Emoji associated with the sticker.

Type

str

set_name[source]

Optional. Name of the sticker set to which the sticker belongs.

Type

str

mask_position[source]

Optional. For mask stickers, the position where the mask should be placed.

Type

telegram.MaskPosition

file_size[source]

Optional. File size in bytes.

Type

int

bot[source]

Optional. The Bot to use for instance methods.

Type

telegram.Bot

premium_animation[source]

Optional. For premium regular stickers, premium animation for the sticker.

New in version 20.0.

Type

telegram.File

custom_emoji[source]

Optional. For custom emoji stickers, unique identifier of the custom emoji.

New in version 20.0.

Type

str

CUSTOM_EMOJI = 'custom_emoji'[source]

telegram.constants.StickerType.CUSTOM_EMOJI

MASK = 'mask'[source]

telegram.constants.StickerType.MASK

REGULAR = 'regular'[source]

telegram.constants.StickerType.REGULAR

classmethod de_json(data, bot)[source]

See telegram.TelegramObject.de_json().

async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]

Convenience wrapper over telegram.Bot.get_file

For the documentation of the arguments, please see telegram.Bot.get_file().

Returns

telegram.File

Raises

telegram.error.TelegramError