Sticker¶

class telegram.Sticker(file_id, file_unique_id, width, height, is_animated, is_video, type, emoji=None, file_size=None, set_name=None, mask_position=None, premium_animation=None, custom_emoji_id=None, thumbnail=None, needs_repainting=None, *, api_kwargs=None)[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.

Use In

Available In

Changed in version 20.5: Removed the deprecated argument and attribute thumb.

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.

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

Added in version 20.0.
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.
premium_animation (telegram.File, optional) –
For premium regular stickers, premium animation for the sticker.

Added in version 20.0.
custom_emoji_id (str, optional) –
For custom emoji stickers, unique identifier of the custom emoji.

Added in version 20.0.
thumbnail (telegram.PhotoSize, optional) –
Sticker thumbnail in the .WEBP or .JPG format.

Added in version 20.2.
needs_repainting (bool, optional) –
True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places.

Added in version 20.2.

file_id[source]¶

Identifier for this file, which can be used to download or reuse the 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.

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

Added in version 20.0.

Type:: str

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

premium_animation[source]¶

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

Added in version 20.0.

Type:: telegram.File

custom_emoji_id[source]¶

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

Added in version 20.0.

Type:: str

thumbnail[source]¶

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

Added in version 20.2.

Type:: telegram.PhotoSize

needs_repainting[source]¶

Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places.

Added in version 20.2.

Type:: bool

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=None)[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 –