Skip to content

GramIO API Reference / gramio/dist / SendMessageDraftParams

Interface: SendMessageDraftParams

Defined in: @gramio/types/out/params.d.ts:1749

Params object for sendMessageDraft method

Properties

PropertyTypeDescriptionDefined in
can_stop?booleanPass True to show the user a button to stop further drafts. The bot will receive an Update “stopped_message_generation” if the user presses the button.@gramio/types/out/params.d.ts:1777
chat_idnumberUnique identifier for the target private chat@gramio/types/out/params.d.ts:1753
draft_idnumberUnique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. Otherwise, the draft is replaced without animation.@gramio/types/out/params.d.ts:1761
entities?TelegramMessageEntity[]A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode@gramio/types/out/params.d.ts:1773
keep_on_stop?booleanPass True to keep the draft in the chat when the button is pressed. The draft will still disappear after a short time or if the bot sends a message. To fully preserve the partial draft, the bot should send it as a new message.@gramio/types/out/params.d.ts:1781
message_thread_id?numberUnique identifier for the target message thread@gramio/types/out/params.d.ts:1757
parse_mode?"HTML" | "MarkdownV2" | "Markdown"Mode for parsing entities in the message text. See formatting options for more details.@gramio/types/out/params.d.ts:1769
text?string | { toString: string; }Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.@gramio/types/out/params.d.ts:1765