GramIO API Reference / gramio/dist / SendPhotoParams
Interface: SendPhotoParams
Defined in: @gramio/types/out/params.d.ts:365
Params object for sendPhoto 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:417 |
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:369 |
caption? | string | { toString: string; } | Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:389 |
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:397 |
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:373 |
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:381 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:409 |
has_spoiler? | boolean | Pass True if the photo needs to be covered with a spoiler animation | @gramio/types/out/params.d.ts:405 |
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:421 |
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:377 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the photo caption. See formatting options for more details. | @gramio/types/out/params.d.ts:393 |
photo | string | Blob | Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » | @gramio/types/out/params.d.ts:385 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:413 |
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:433 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | @gramio/types/out/params.d.ts:429 |
show_caption_above_media? | boolean | Pass True, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:401 |
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:425 |