GramIO API Reference / gramio/dist / SendDocumentParams
Interface: SendDocumentParams
Defined in: @gramio/types/out/params.d.ts:537
Params object for sendDocument method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allow_paid_broadcast? | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | @gramio/types/out/params.d.ts:589 |
business_connection_id? | string | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:541 |
caption? | string | { toString: string; } | Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:565 |
caption_entities? | TelegramMessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | @gramio/types/out/params.d.ts:573 |
chat_id | string | number | Unique identifier for the target chat or username of the target channel (in the format @channelusername) | @gramio/types/out/params.d.ts:545 |
direct_messages_topic_id? | number | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | @gramio/types/out/params.d.ts:553 |
disable_content_type_detection? | boolean | Disables automatic server-side content type detection for files uploaded using multipart/form-data | @gramio/types/out/params.d.ts:577 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:581 |
document | string | Blob | File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | @gramio/types/out/params.d.ts:557 |
message_effect_id? | string | Unique identifier of the message effect to be added to the message; for private chats only | @gramio/types/out/params.d.ts:593 |
message_thread_id? | number | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | @gramio/types/out/params.d.ts:549 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the document caption. See formatting options for more details. | @gramio/types/out/params.d.ts:569 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:585 |
reply_markup? | TelegramInlineKeyboardMarkup | TelegramReplyKeyboardMarkup | TelegramReplyKeyboardRemove | TelegramForceReply | { toJSON: TelegramInlineKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardRemove; } | { toJSON: TelegramForceReply; } | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user | @gramio/types/out/params.d.ts:605 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | @gramio/types/out/params.d.ts:601 |
suggested_post_parameters? | TelegramSuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | @gramio/types/out/params.d.ts:597 |
thumbnail? | string | Blob | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | @gramio/types/out/params.d.ts:561 |