copy_media_group()#

Client.copy_media_group()#

Copy a media group by providing one of the message ids.

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

  • from_chat_id (int | str) – Unique identifier (int) or username (str) of the source chat where the original media group 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.

  • captions (str | List of str , optional) – New caption for media, 0-1024 characters after entities parsing for each media. If not specified, the original caption is kept. Pass “” (empty string) to remove the caption.

    If a string is passed, it becomes a caption only for the first media. If a list of string passed, each element becomes caption for each media element. You can pass None in list to keep the original caption (see examples below).

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

  • reply_parameters (ReplyParameters, optional) – Description of the message to reply to

  • message_thread_id (int, optional) – If the message is in a thread, ID of the original message.

  • send_as (int | str) – Unique identifier (int) or username (str) of the chat or channel to send the message as. You can use this to send the message on behalf of a chat or channel where you have appropriate permissions. Use the get_send_as_chats() to return the list of message sender identifiers, which can be used to send messages in the chat, This setting applies to the current message and will remain effective for future messages unless explicitly changed. To set this behavior permanently for all messages, use set_send_as_chat().

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

  • protect_content (bool, optional) – Pass True if the content of the message must be protected from forwarding and saving; for bots only.

  • allow_paid_broadcast (bool, optional) – Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only

  • message_effect_id (int 64-bit, optional) – Unique identifier of the message effect to be added to the message; for private chats only.

Returns:

List of Message – On success, a list of copied messages is returned.

Example

# Copy a media group
await app.copy_media_group(to_chat, from_chat, 123)

await app.copy_media_group(to_chat, from_chat, 123, captions="single caption")

await app.copy_media_group(to_chat, from_chat, 123,
    captions=["caption 1", None, ""])