Sticker

This object represents a sticker. ↗

15 fields, 7 required.

Used by

• getCustomEmojiStickers
• getForumTopicIconStickers

Fields

file_id string Required
Identifier for this file, which can be used to download or reuse the file.

file_unique_id string Required
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 "regular" | "mask" | "custom_emoji" Required
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.

width number Required
Sticker width.

height number Required
Sticker height.

is_animated boolean Required
True, if the sticker is animated.

is_video boolean Required
True, if the sticker is a video sticker.

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

emoji string
Emoji associated with the sticker.

set_name string
Name of the sticker set to which the sticker belongs.

premium_animation File
For premium regular stickers, premium animation for the sticker.

mask_position MaskPosition
For mask stickers, the position where the mask should be placed.

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

needs_repainting boolean
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.

file_size number
File size in bytes.