copy_media_group()

async 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_to_message_id (int, optional) – If the message is a reply, ID of the 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.

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

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

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

  • message_thread_id (int, optional) – Unique identifier of a message thread to which the message belongs.

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

  • allow_paid_broadcast (bool, optional) – If True, you will be allowed to send up to 1000 messages per second.

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

  • background (bool, optional) – Pass True if the message is a background message.

  • clear_draft (bool, optional) – Pass True if the message draft should be cleared.

  • update_stickersets_order (bool, optional) – Pass True if the stickersets order should be updated.

  • send_as (int | str, optional) – Unique identifier (int) or username (str) of the chat to send the message as.

  • quick_reply_shortcut (int, optional) – Unique identifier of the quick reply shortcut.

  • has_spoilers (bool, optional) – Pass True to cover the copied media with a spoiler animation.

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