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.

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. For supergroups 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.

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

  • show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

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

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, ""])