Interface SendCopyParams

interface SendCopyParams {
    businessConnectionId?: string;
    caption?: InputText;
    clearDraft?: boolean;
    commentTo?: number | Message;
    effect?: Long;
    forbidForwards?: boolean;
    mustReply?: boolean;
    quickReply?: string | number;
    quote?: TextWithEntities;
    quoteOffset?: number;
    replyMarkup?: ReplyMarkup;
    replyTo?: number | Message;
    replyToStory?: number;
    schedule?: number | Date | "online";
    sendAs?: InputPeerLike;
    shouldDispatch?: true;
    silent?: boolean;
    toChatId: InputPeerLike;
}

Hierarchy

  • CommonSendParams
    • SendCopyParams

Properties

businessConnectionId? caption? clearDraft? commentTo? effect? forbidForwards? mustReply? quickReply? quote? quoteOffset? replyMarkup? replyTo? replyToStory? schedule? sendAs? shouldDispatch? silent? toChatId

Properties

OptionalbusinessConnectionId

businessConnectionId?: string

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

Optionalcaption

caption?: InputText

New message caption (only used for media)

OptionalclearDraft

clearDraft?: boolean

Whether to clear draft after sending this message.

Default

false

OptionalcommentTo

commentTo?: number | Message

Message to comment to. Either a message object or message ID.

This overwrites replyTo if it was passed

Optionaleffect

effect?: Long

ID of a message effect to use when sending the message (see TelegramClient.getAvailableMessageEffects)

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.

OptionalmustReply

mustReply?: boolean

Whether to throw an error if replyTo message does not exist.

If that message was not found, NotFoundError is thrown, with text set to MESSAGE_NOT_FOUND.

Incurs an additional request, so only use when really needed.

Default

false

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

Optionalquote

quote?: TextWithEntities

Quoted text. Must be exactly contained in the message being quoted to be accepted by the server (as well as entities)

OptionalquoteOffset

quoteOffset?: number

Offset of the start of the quote in the message.

OptionalreplyMarkup

replyMarkup?: ReplyMarkup

For bots: inline or reply markup or an instruction to hide a reply keyboard or to force a reply.

OptionalreplyTo

replyTo?: number | Message

Message to reply to. Either a message object or message ID.

For forums - can also be an ID of the topic (i.e. its top message ID)

Can also be a message from another chat, in which case a quote will be sent.

OptionalreplyToStory

replyToStory?: number

Story to reply to.

Must be the story sent by the peer you are sending the message to.

Can't be used together with replyTo or commentTo.

Optionalschedule

schedule?: number | Date | "online"

If set, the message will be scheduled to this date. When passing a number, a UNIX time in ms is expected.

You can also pass online - this will send the message once the peer is online. Note that this requires that peer's online status to be visible to you.

OptionalsendAs

sendAs?: InputPeerLike

Peer to use when sending the message.

OptionalshouldDispatch

shouldDispatch?: true

Whether to dispatch the returned message to the client's update handler. Doesn't follow disableNoDispatch

Optionalsilent

silent?: boolean

Whether to send this message silently.

toChatId

toChatId: InputPeerLike

Target chat ID

Settings

Member Visibility

On This Page

Properties