sendMessage()

Use this method to send text messages. On success, the sent Message is returned.

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the message will be sent
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format `@username`
`message_thread_id`	number	optional	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
`direct_messages_topic_id`	number	optional	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
`text`	string	required	Text of the message to be sent, 1-4096 characters after entities parsing
`parse_mode`	string	optional	Mode for parsing entities in the message text. See formatting options for more details.
`entities`	MessageEntity[]	optional	A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
`link_preview_options`	LinkPreviewOptions	optional	Link preview generation options for the message
`disable_notification`	boolean	optional	Sends the message silently. Users will receive a notification with no sound.
`protect_content`	boolean	optional	Protects the contents of the sent message from forwarding and saving
`allow_paid_broadcast`	boolean	optional	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.
`message_effect_id`	string	optional	Unique identifier of the message effect to be added to the message; for private chats only
`suggested_post_parameters`	SuggestedPostParameters	optional	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.
`reply_parameters`	ReplyParameters	optional	Description of the message to reply to
`reply_markup`	InlineKeyboardMarkup \| ReplyKeyboardMarkup \| ReplyKeyboardRemove \| ForceReply	optional	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.

returns

Message

usage in yaebal

sendMessage is directly typed on Api — call it straight off bot.api.

bot.ts

import type { SendMessageParams } from "@yaebal/types";

await bot.api.sendMessage({
  chat_id: 123456789,
  text: "hello from yaebal!",
} satisfies SendMessageParams);

context shortcut

also available as ctx.send() on 24 context types — see @yaebal/contexts.

context shortcut

/** send a message to the current chat. accepts a plain string or a `format` result. */
ctx.send(text: SendText, extra: Record<string, unknown> = {})

official Bot API docs: https://core.telegram.org/bots/api/#sendmessage