send_message()

Client.send_message()

Send text messages.

Usable by Users Bots

Parameters:

• chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

• text (str) – Text of the message to be sent.

• parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

• entities (List of MessageEntity) – List of special entities that appear in message text, which can be specified instead of parse_mode.

• link_preview_options (LinkPreviewOptions, optional) – Options used for link preview generation for the message.

• disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

• message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. For forums only.

• direct_messages_topic_id (int, optional) – Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only.

• effect_id (int, optional) – Unique identifier of the message effect. For private chats only.

• reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

• schedule_date (datetime, optional) – Date when the message will be automatically sent.

• repeat_period (int, optional) – Period after which the message will be sent again in seconds.

• protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

• business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be sent.

• allow_paid_broadcast (bool, optional) – If True, you will be allowed to send 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. For bots only.

• paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

• suggested_post_parameters (SuggestedPostParameters, optional) – Information about the suggested post.

• reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Returns:

Message – On success, the sent text message is returned.

Example

# Simple example
await app.send_message("me", "Message sent with **Pyrogram**!")

# Disable web page previews
from pyrogram import types

await app.send_message(
    "me",
    "https://docs.pyrogram.org",
    link_preview_options=types.LinkPreviewOptions(is_disabled=True)
)

# Reply to a message using its id
from pyrogram import types

await app.send_message(
    "me",
    "this is a reply",
    reply_parameters=types.ReplyParameters(message_id=123)
)

# Simple web page preview
from pyrogram import types

await app.send_message(
    "me",
    "Look at this preview!",
    link_preview_options=types.LinkPreviewOptions(url="https://docs.pyrogram.org")
)

# For bots only, send messages with keyboards attached

from pyrogram.types import (
    ReplyKeyboardMarkup, InlineKeyboardMarkup, InlineKeyboardButton)

# Send a normal keyboard
await app.send_message(
    chat_id, "Look at that button!",
    reply_markup=ReplyKeyboardMarkup([["Nice!"]]))

# Send an inline keyboard
await app.send_message(
    chat_id, "These are inline buttons",
    reply_markup=InlineKeyboardMarkup(
        [
            [InlineKeyboardButton("Data", callback_data="callback_data")],
            [InlineKeyboardButton("Docs", url="https://docs.pyrogram.org")]
        ]))