availableEffect

Represents a message effect ».

All long IDs except for id are document.ids from the containing messages.availableEffects constructor.

See here » for more info on how to use following fields.

Constructor schema is available as of layer 180. Switch »

Parameters

Name Type Description
flags # Flags, see TL conditional fields
premium_required flags.2?true Whether a Premium subscription is required to use this effect.
id long Unique effect ID.
emoticon string Emoji corresponding to the effect, to be used as icon for the effect if static_icon_id is not set.
static_icon_id flags.0?long ID of the document containing the static icon (WEBP) of the effect.
effect_sticker_id long Contains the preview animation (TGS format »), used for the effect selection menu.
effect_animation_id flags.1?long If set, contains the actual animated effect (TGS format »). If not set, the animated effect must be set equal to the premium animated sticker effect associated to the animated sticker specified in effect_sticker_id (always different from the preview animation, fetched thanks to the videoSize of type f as specified here »).

Type

AvailableEffect

Related pages

Telegram Premium

Telegram Premium is an optional subscription service that unlocks additional exclusive client-side and API-side features, while helping support the development of the app.

Stickers

Telegram clients support displaying static and animated stickers.

videoSize

An animated profile picture in MPEG4 format

Animated message effects

Telegram allows adding spectacular animated effects to messages you send.

document

Document

messages.availableEffects

The full list of usable animated message effects ».