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

  • reply_to_chat_id (int, 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.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

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

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

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