typescript-telegram-bot-api/dist/types/InputMediaPhoto.d.ts

Telegram Bot API wrapper for Node.js written in TypeScript

import { Attachment, MessageEntity, ParseMode } from './';
/**
 * ## InputMediaPhoto
 * Represents a photo to be sent.
 * @see https://core.telegram.org/bots/api#inputmediaphoto
 */
export type InputMediaPhoto = {
    /**
     * Type of the result, must be photo
     */
    type: 'photo';
    /**
     * 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://<file_attach_name>” to upload a new one using
     * multipart/form-data under <file_attach_name> name. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
     */
    media: string | Attachment;
    /**
     * Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
     */
    caption?: string;
    /**
     * Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
     */
    parse_mode?: ParseMode;
    /**
     * Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
     */
    caption_entities?: MessageEntity[];
    /**
     * Optional. Pass True, if the caption must be shown above the message media
     */
    show_caption_above_media?: boolean;
    /**
     * Optional. Pass True if the photo needs to be covered with a spoiler animation
     */
    has_spoiler?: boolean;
};