telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface SendPaidMediaOptions

    Options for Bot.sendPaidMedia.

    media holds up to 10 InputPaidMedia objects (InputPaidMediaPhoto / InputPaidMediaVideo / InputPaidMediaLivePhoto). The JSON-only client can't attach new files, so pass a file_id or an HTTP URL.

    Telegram Bot API: sendPaidMedia

    interface SendPaidMediaOptions {
        allow_paid_broadcast?: boolean;
        business_connection_id?: string;
        caption?: string;
        caption_entities?: MessageEntity[];
        chat_id: string | number;
        direct_messages_topic_id?: number;
        disable_notification?: boolean;
        media: InputPaidMedia[];
        message_thread_id?: number;
        parse_mode?: string;
        payload?: string;
        protect_content?: boolean;
        reply_markup?: ReplyMarkup;
        reply_parameters?: ReplyParameters;
        show_caption_above_media?: boolean;
        star_count: number;
        suggested_post_parameters?: SuggestedPostParameters;
    }
    Index
    allow_paid_broadcast? business_connection_id? caption? caption_entities? chat_id direct_messages_topic_id? disable_notification? media message_thread_id? parse_mode? payload? protect_content? reply_markup? reply_parameters? show_caption_above_media? star_count suggested_post_parameters?
    allow_paid_broadcast?: boolean

    Pass True to allow paid broadcast of the message.

    business_connection_id?: string

    Unique identifier of the business connection on behalf of which the message will be sent.

    caption?: string

    Media caption, 0-1024 characters after entities parsing.

    caption_entities?: MessageEntity[]

    A list of special entities that appear in the caption.

    chat_id: string | number

    Unique identifier for the target chat or username of the target channel.

    direct_messages_topic_id?: number

    Identifier of the topic the message will be sent to in a direct messages chat.

    disable_notification?: boolean

    Sends the message silently. Users will receive a notification with no sound.

    media: InputPaidMedia[]

    Array describing the media to send; up to 10 items.

    message_thread_id?: number

    Unique identifier for the target message thread (topic) of the forum.

    parse_mode?: string

    Mode for parsing entities in the media caption.

    payload?: string

    Bot-defined paid media payload, 0-128 bytes. Not shown to the user.

    Optionalprotect_content

    protect_content?: boolean

    Protects the contents of the sent message from forwarding and saving.

    reply_markup?: ReplyMarkup

    Additional interface options.

    reply_parameters?: ReplyParameters

    Description of the message to reply to.

    show_caption_above_media?: boolean

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

    star_count: number

    Number of Telegram Stars that must be paid to buy access to the media; 1-25000.

    Optionalsuggested_post_parameters

    suggested_post_parameters?: SuggestedPostParameters

    Parameters of the suggested post to send in a business chat.

    Settings
    Member Visibility

    On This Page
    Properties