Interface ForwardMessageOptions

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

Properties

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

Properties

OptionalallowPaidFloodskip

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.

OptionalallowPaidMessages

allowPaidMessages?: Long

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

OptionalclearDraft

clearDraft?: boolean

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

Default

false

OptionalforbidForwards

forbidForwards?: boolean

Whether to disallow further forwards of this message.

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

OptionalnoAuthor

noAuthor?: boolean

Whether to forward without author

OptionalnoCaption

noCaption?: boolean

Whether to forward without caption (implies noAuthor)

OptionalquickReply

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).

Optionalschedule

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

OptionalsendAs

sendAs?: InputPeerLike

Peer to use when sending the message.

OptionalshouldDispatch

shouldDispatch?: true

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

Optionalsilent

silent?: boolean

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

toChatId

toChatId: InputPeerLike

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

OptionaltoMonoforumPeer

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.

OptionaltoThreadId

toThreadId?: number

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

OptionalvideoTimestamp

videoTimestamp?: number

Video timestamp to use for the forwarded video

Settings

Member Visibility

On This Page

Properties