sendRichMessageDraft

Returns: True📎 Accepts filesOfficial docs ↗

Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendRichMessage with the complete message to persist it in the user's chat. Returns True on success.

Parameters

chat_idIntegerRequired

Unique identifier for the target private chat

message_thread_idIntegerOptional

Unique identifier for the target message thread

draft_idIntegerRequired

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

rich_messageInputRichMessageRequired

The partial message to be streamed. Direct upload of new files and explicit upload of files by a URL isn't supported.

can_stopBooleanOptional

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

keep_on_stopBooleanOptional

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

Returns

On success, True is returned.

GramIO Usage

Errors

Tips & Gotchas

See Also