Skip to content
Back to top
View this page

# StickerSet

class telegram.StickerSet(name, title, stickers, sticker_type, thumbnail=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object represents a sticker set.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `name` 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.

  Returned In

  `telegram.Bot.get_sticker_set()`

  Changed in version 20.0: The parameter `contains_masks` has been removed. Use `sticker_type` instead.

  Changed in version 21.1: The parameters `is_video` and `is_animated` are deprecated and now made optional. Thus, the order of the arguments had to be changed.

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

  Removed in version 21.2: Removed the deprecated arguments and attributes `is_animated` and `is_video`.

  Parameters:

    - name (`str`) – Sticker set name.

    - title (`str`) – Sticker set title.

    - stickers (Sequence[`telegram.Sticker`]) –

      List of all set stickers.

      Changed in version 20.0: Accepts any `collections.abc.Sequence` as input instead of just a list. The input is converted to a tuple.

    - sticker_type (`str`) –

      Type of stickers in the set, currently one of `telegram.Sticker.REGULAR`, `telegram.Sticker.MASK`, `telegram.Sticker.CUSTOM_EMOJI`.

      Added in version 20.0.

    - thumbnail (`telegram.PhotoSize`, optional) –

      Sticker set thumbnail in the `.WEBP`, `.TGS`, or `.WEBM` format.

      Added in version 20.2.

  name

    Sticker set name.

    Type:

      `str`

  title

    Sticker set title.

    Type:

      `str`

  stickers

    List of all set stickers.

    Changed in version 20.0: This attribute is now an immutable tuple.

    Type:

      tuple[`telegram.Sticker`]

  sticker_type

    Type of stickers in the set, currently one of `telegram.Sticker.REGULAR`, `telegram.Sticker.MASK`, `telegram.Sticker.CUSTOM_EMOJI`.

    Added in version 20.0.

    Type:

      `str`

  thumbnail

    Optional. Sticker set thumbnail in the `.WEBP`, `.TGS`, or `.WEBM` format.

    Added in version 20.2.

    Type:

      `telegram.PhotoSize`

  classmethod de_json(data, bot=None)

    See `telegram.TelegramObject.de_json()`.