Skip to content

GramIO API Reference / gramio/dist / SendMessageParams

Interface: SendMessageParams

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

Params object for sendMessage method

Properties

PropertyTypeDescriptionDefined in
allow_paid_broadcast?booleanPass 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:135
business_connection_id?stringUnique identifier of the business connection on behalf of which the message will be sent@gramio/types/out/params.d.ts:95
chat_idstring | numberUnique identifier for the target chat or username of the target channel (in the format @channelusername)@gramio/types/out/params.d.ts:99
direct_messages_topic_id?numberIdentifier 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:107
disable_notification?booleanSends the message silently. Users will receive a notification with no sound.@gramio/types/out/params.d.ts:127
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:119
link_preview_options?TelegramLinkPreviewOptionsLink preview generation options for the message@gramio/types/out/params.d.ts:123
message_effect_id?stringUnique identifier of the message effect to be added to the message; for private chats only@gramio/types/out/params.d.ts:139
message_thread_id?numberUnique 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:103
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:115
protect_content?booleanProtects the contents of the sent message from forwarding and saving@gramio/types/out/params.d.ts:131
reply_markup?TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; } | TelegramReplyKeyboardMarkup | { toJSON: TelegramReplyKeyboardMarkup; } | TelegramReplyKeyboardRemove | { toJSON: TelegramReplyKeyboardRemove; } | TelegramForceReply | { 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:151
reply_parameters?TelegramReplyParametersDescription of the message to reply to@gramio/types/out/params.d.ts:147
suggested_post_parameters?TelegramSuggestedPostParametersA 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:143
textstring | { toString: string; }Text of the message to be sent, 1-4096 characters after entities parsing@gramio/types/out/params.d.ts:111