# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import logging
from typing import BinaryIO, TYPE_CHECKING
import pyrogram
from pyrogram import enums, types
if TYPE_CHECKING:
from datetime import datetime, timedelta
log = logging.getLogger(__name__)
class CopyMessage:
async def copy_message(
self: pyrogram.Client,
chat_id: int | str,
from_chat_id: int | str,
message_id: int,
caption: str | None = None,
parse_mode: enums.ParseMode | None = None,
caption_entities: list[types.MessageEntity] | None = None,
video_cover: str | BinaryIO | None = None,
video_start_timestamp: int | None = None,
disable_notification: bool | None = None,
message_thread_id: int | None = None,
reply_to_message_id: int | None = None,
reply_to_chat_id: int | str | None = None,
quote_text: str | None = None,
quote_entities: list[types.MessageEntity] | None = None,
schedule_date: datetime | timedelta | None = None,
protect_content: bool | None = None,
has_spoiler: bool | None = None,
show_caption_above_media: bool | None = None,
business_connection_id: str | None = None,
allow_paid_broadcast: bool | None = None,
paid_message_star_count: int | None = None,
reply_markup: types.InlineKeyboardMarkup
| types.ReplyKeyboardMarkup
| types.ReplyKeyboardRemove
| types.ForceReply
| None = object,
reply_parameters: types.ReplyParameters | None = None,
direct_messages_topic_id: int | None = None,
effect_id: int | None = None,
suggested_post_parameters: types.SuggestedPostParameters | None = None,
) -> types.Message:
"""Copy messages of any kind.
The method is analogous to the method :meth:`~Client.forward_messages`, but the copied message doesn't have a
link to the original message.
.. include:: /_includes/usable-by/users-bots.rst
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).
from_chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the source chat where the original message was sent.
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).
message_id (``int``):
Message identifier in the chat specified in *from_chat_id*.
caption (``string``, *optional*):
New caption for media, 0-1024 characters after entities parsing.
If not specified, the original caption is kept.
Pass "" (empty string) to remove the caption.
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
caption_entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in the new caption, which can be specified instead of *parse_mode*.
video_cover (``str`` | ``BinaryIO``, *optional*):
New cover for the copied video in the message. Pass None to skip cover uploading and use the existing cover.
video_start_timestamp (``int``, *optional*):
New start timestamp, from which the video playing must start, in seconds for the copied video in the message.
disable_notification (``bool``, *optional*):
Sends the message silently.
Users will receive a notification with no sound.
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
schedule_date (:py:obj:`~datetime.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.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.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.
If not specified, the original inline keyboard markup is kept (reply keyboards are not copied by default).
Pass None to remove the reply markup.
message_thread_id (``int``, *optional*):
Unique identifier for the target message thread (topic) of the forum.
For supergroups only.
reply_to_chat_id (``int`` | ``str``, *optional*):
Unique identifier for the chat to which the replied message belongs.
Only applicable in combination with *reply_to_message_id*.
quote_text (``str``, *optional*):
Text of the quote to reply to.
quote_entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in *quote_text*, which can be specified instead of *parse_mode*.
has_spoiler (``bool``, *optional*):
Pass True if the message needs to be covered with a spoiler animation.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media.
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.
For bots only.
paid_message_star_count (``int``, *optional*):
The number of Telegram Stars the user agreed to pay to send the messages.
reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*):
Description of the message to reply to. Takes precedence over
*reply_to_message_id* and the quote arguments.
direct_messages_topic_id (``int``, *optional*):
Unique identifier of the direct messages topic to copy into.
effect_id (``int``, *optional*):
Unique identifier of the message effect to add to the message.
suggested_post_parameters (:obj:`~pyrogram.types.SuggestedPostParameters`, *optional*):
Parameters of the suggested post.
Returns:
:obj:`~pyrogram.types.Message`: On success, the copied message is returned.
Example:
.. code-block:: python
# Copy a message
await app.copy_message(to_chat, from_chat, 123)
"""
message: types.Message = await self.get_messages(from_chat_id, message_id)
if reply_parameters is None and reply_to_message_id is not None:
reply_parameters = types.ReplyParameters(
message_id=reply_to_message_id,
chat_id=reply_to_chat_id,
quote=quote_text,
quote_entities=quote_entities,
)
return await message.copy(
chat_id=chat_id,
caption=caption,
parse_mode=parse_mode,
caption_entities=caption_entities,
video_cover=video_cover,
video_start_timestamp=video_start_timestamp,
disable_notification=disable_notification,
message_thread_id=message_thread_id,
reply_parameters=reply_parameters,
schedule_date=schedule_date,
protect_content=protect_content,
has_spoiler=has_spoiler,
show_caption_above_media=show_caption_above_media,
business_connection_id=business_connection_id,
allow_paid_broadcast=allow_paid_broadcast,
paid_message_star_count=paid_message_star_count,
direct_messages_topic_id=direct_messages_topic_id,
effect_id=effect_id,
suggested_post_parameters=suggested_post_parameters,
reply_markup=reply_markup,
)