Documentation - v0.32.2
    Preparing search index...

    Interface ForwardMessageOptions

    interface ForwardMessageOptions {
        allowPaidFloodskip?: boolean;
        allowPaidMessages?: Long;
        clearDraft?: boolean;
        effect?: Long;
        forbidForwards?: boolean;
        fromEphemeral?: boolean;
        noAuthor?: boolean;
        noCaption?: boolean;
        quickReply?: string | number;
        schedule?: number | Date;
        scheduleRepeatPeriod?: number;
        sendAs?: InputPeerLike;
        shouldDispatch?: true;
        silent?: boolean;
        suggestedPost?: InputSuggestedPost;
        toChatId: InputPeerLike;
        toMonoforumPeer?: InputPeerLike;
        toThreadId?: number;
        videoTimestamp?: number;
    }
    Index

    Properties

    allowPaidFloodskip? allowPaidMessages? clearDraft? effect? forbidForwards? fromEphemeral? noAuthor? noCaption? quickReply? schedule? scheduleRepeatPeriod? sendAs? shouldDispatch? silent? suggestedPost? toChatId toMonoforumPeer? toThreadId? videoTimestamp?

    Properties

    allowPaidFloodskip?: boolean

    Bots only: if set, allows sending up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The Stars will be withdrawn from the bot's balance.

    allowPaidMessages?: Long

    Whether to allow payment for messages. If set, the value represents the maximum number of stars to be paid

    clearDraft?: boolean

    Whether to clear draft after sending this message (only used for caption)

    false

    effect?: Long

    ID of a message effect to use when forwarding a single message to a private chat (see TelegramClient.getAvailableMessageEffects)

    forbidForwards?: boolean

    Whether to disallow further forwards of this message.

    Only for bots, works even if the target chat does not have content protection.

    fromEphemeral?: boolean

    Whether the messages being forwarded are ephemeral messages

    noAuthor?: boolean

    Whether to forward without author

    noCaption?: boolean

    Whether to forward without caption (implies noAuthor)

    quickReply?: string | number

    If passed, instead of sending the message, it will be saved into the given quick reply shortcut (either its ID or its shortcut string).

    schedule?: number | Date

    If set, the forwarding will be scheduled to this date (also applies to caption message). When passing a number, a UNIX time in ms is expected.

    You can also pass 0x7FFFFFFE, this will send the message once the peer is online

    scheduleRepeatPeriod?: number

    Period (in seconds) after which a scheduled message will be sent again. Only used together with schedule when forwarding a single message, requires Telegram Premium.

    Must be one of 86400, 7 * 86400, 14 * 86400, 30 * 86400, 91 * 86400, 182 * 86400, 365 * 86400 (or additionally 60, 300 on test servers)

    sendAs?: InputPeerLike

    Peer to use when sending the message.

    shouldDispatch?: true

    Whether to dispatch the forwarded messages to the client's update handler.

    silent?: boolean

    Whether to forward silently (also applies to caption message).

    suggestedPost?: InputSuggestedPost

    When forwarding to a channel direct messages chat, information about the post suggested to the channel

    toChatId: InputPeerLike

    Destination chat ID, username, phone, "me" or "self"

    toMonoforumPeer?: InputPeerLike

    When forwarding to a monoforum you are an admin of, you must pass an ID of a peer you are sending the message to.

    toThreadId?: number

    When forwarding to forums, ID of the thread to forward to

    videoTimestamp?: number

    Video timestamp to use for the forwarded video

    Settings

    Member Visibility

    On This Page

    Properties