send_web_page()#

Client.send_web_page()#

Send Web Page Preview.

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, optional) – Text of the message to be sent.

  • url (str, optional) – Link that will be previewed. If url not specified, the first URL found in the text will be used.

  • 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.

  • prefer_large_media (bool, optional) – If True, media in the link preview will be larger. Ignored if the URL isn’t explicitly specified or media size change isn’t supported for the preview.

  • prefer_small_media (bool, optional) – If True, media in the link preview will be smaller. Ignored if the URL isn’t explicitly specified or media size change isn’t supported for the preview.

  • show_above_text (bool, optional) – If True, link preview will be shown above the message text. Otherwise, the link preview will be shown below the message text.

  • 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 forum supergroups only.

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

  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

  • reply_to_chat_id (int | str, optional) – If the message is a reply, ID of the original chat.

  • reply_to_story_id (int, optional) – Unique identifier for the target story.

  • quote_text (str, optional) – Text of the quote to be sent.

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

  • quote_offset (int, optional) – Offset for quote in original message.

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

  • 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.

  • 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 message is returned.

Example

# Simple example
await app.send_web_page("me", "https://docs.pyrogram.org")

# Make web preview image larger
await app.send_web_page("me", "https://docs.pyrogram.org", prefer_large_media=True)