InputSticker¶

class telegram.InputSticker(sticker, emoji_list, format, mask_position=None, keywords=None, *, api_kwargs=None)[source]¶

Bases: telegram.TelegramObject

This object describes a sticker to be added to a sticker set.

Use In

Added in version 20.2.

Changed in version 21.1: As of Bot API 7.2, the new argument format is a required argument, and thus the order of the arguments has changed.

Parameters:

sticker (str | file object | InputFile | bytes | pathlib.Path) – The added sticker. To upload a file, you can either pass a file object (e.g. open("filename", "rb")) or the file contents as bytes. If the bot is running in local_mode, passing the path of the file (as string or pathlib.Path object) is supported as well. Animated and video stickers can’t be uploaded via HTTP URL.
emoji_list (Sequence[str]) – Sequence of 1 - 20 emoji associated with the sticker.
mask_position (telegram.MaskPosition, optional) – Position where the mask should be placed on faces. For “'mask'” stickers only.
keywords (Sequence[str], optional) – Sequence of 0-20 search keywords for the sticker with the total length of up to 64 characters. For “'regular'” and “'custom_emoji'” stickers only.
format (str) –
Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a WEBM video.

Added in version 21.1.

sticker[source]¶

The added sticker.

Type:: str | telegram.InputFile

emoji_list[source]¶

Tuple of 1 - 20 emoji associated with the sticker.

Type:: tuple[str]

mask_position[source]¶

Optional. Position where the mask should be placed on faces. For “'mask'” stickers only.

Type:: telegram.MaskPosition

keywords[source]¶

Optional. Tuple of 0-20 search keywords for the sticker with the total length of up to 64 characters. For “'regular'” and “'custom_emoji'” stickers only. “'custom_emoji'” stickers only.

Type:: tuple[str]

format[source]¶

Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a WEBM video.

Added in version 21.1.

Type:: str