Sticker

^{ref / types / Sticker}

This object represents a sticker.

^Source

Properties

file_id

file_id: string;

Identifier for this file, which can be used to download or reuse the file

^Source

file_unique_id

file_unique_id: string;

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.

^Source

type

type: "regular" | "mask" | "custom_emoji";

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.

^Source

width

width: number;

Sticker width

^Source

height

height: number;

Sticker height

^Source

is_animated

is_animated: boolean;

True, if the sticker is animated

^Source

is_video

is_video: boolean;

True, if the sticker is a video sticker

^Source

thumbnail

thumbnail?: PhotoSize;

Sticker thumbnail in the .WEBP or .JPG format

^Source

emoji

emoji?: string;

Emoji associated with the sticker

^Source

set_name

set_name?: string;

Name of the sticker set to which the sticker belongs

^Source

premium_animation

premium_animation?: File;

For premium regular stickers, premium animation for the sticker

^Source

mask_position

mask_position?: MaskPosition;

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

^Source

custom_emoji_id

custom_emoji_id?: string;

For custom emoji stickers, unique identifier of the custom emoji

^Source

file_size

file_size?: number;

File size in bytes

^Source