Interface InputMessageAnimation

An animation message (GIF-style). Subtype of InputMessageContent.

interface InputMessageAnimation {
    @type: "inputMessageAnimation";
    added_sticker_file_ids: number[];
    animation: InputFile;
    caption: FormattedText;
    duration: number;
    has_spoiler?: boolean;
    height: number;
    show_caption_above_media?: boolean;
    thumbnail: InputThumbnail;
    width: number;
}

Properties

@type: "inputMessageAnimation"
added_sticker_file_ids: number[]

File identifiers of the stickers added to the animation, if applicable.

animation: InputFile

Animation file to be sent.

caption: FormattedText

Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.

duration: number

Duration of the animation, in seconds.

has_spoiler?: boolean

True, if the animation preview must be covered by a spoiler animation; not supported in secret chats.

height: number

Height of the animation; may be replaced by the server.

show_caption_above_media?: boolean

True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats.

thumbnail: InputThumbnail

Animation thumbnail; pass null to skip thumbnail uploading.

width: number

Width of the animation; may be replaced by the server.