telegram.Sticker

class telegram.Sticker(file_id, file_unique_id, width, height, is_animated, is_video, type, thumb=None, emoji=None, file_size=None, set_name=None, mask_position=None, bot=None, premium_animation=None, custom_emoji_id=None, **_kwargs)

Bases: telegram.base.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 13.14.

  • 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.

  • 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 13.13.

  • custom_emoji (str, optional) –

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

    New in version 13.14.

  • (obj (**kwargs) – dict): Arbitrary keyword arguments.

file_id

Identifier for this file.

Type

str

file_unique_id

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

Sticker width.

Type

int

height

Sticker height.

Type

int

is_animated

True, if the sticker is animated.

Type

bool

is_video

True, if the sticker is a video sticker.

New in version 13.11.

Type

bool

type

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 13.14.

Type

str

thumb

Optional. Sticker thumbnail in the .webp or .jpg format.

Type

telegram.PhotoSize

emoji

Optional. Emoji associated with the sticker.

Type

str

set_name

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

Type

str

mask_position

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

Type

telegram.MaskPosition

file_size

Optional. File size.

Type

int

premium_animation

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

New in version 13.13.

Type

telegram.File

custom_emoji

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

New in version 13.14.

Type

str

bot

Optional. The Bot to use for instance methods.

Type

telegram.Bot

CUSTOM_EMOJI: ClassVar[str] = 'custom_emoji'

telegram.constants.STICKER_CUSTOM_EMOJI

New in version 13.14.

MASK: ClassVar[str] = 'mask'

telegram.constants.STICKER_MASK

New in version 13.14.

REGULAR: ClassVar[str] = 'regular'

telegram.constants.STICKER_REGULAR

New in version 13.14.

classmethod de_json(data, bot)

See telegram.TelegramObject.de_json().

get_file(timeout=None, api_kwargs=None)

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