Interface InputMediaAnimation<F>

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

interface InputMediaAnimation<F> {
    caption?: string;
    caption_entities?: MessageEntity[];
    duration?: number;
    has_spoiler?: boolean;
    height?: number;
    media: string | F;
    parse_mode?: ParseMode;
    show_caption_above_media?: boolean;
    thumbnail?: F;
    type: "animation";
    width?: number;
}

Type Parameters

  • F

Properties

caption?: string

Caption of the animation to be sent, 0-1024 characters after entities parsing

caption_entities?: MessageEntity[]

List of special entities that appear in the caption, which can be specified instead of parse_mode

duration?: number

Animation duration in seconds

has_spoiler?: boolean

Pass True if the photo needs to be covered with a spoiler animation

height?: number

Animation height

media: string | F

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name.

parse_mode?: ParseMode

Mode for parsing entities in the animation caption. See formatting options for more details.

show_caption_above_media?: boolean

Pass True, if the caption must be shown above the message media

thumbnail?: F

Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under .

type: "animation"

Type of the result, must be animation

width?: number

Animation width