# 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
import os
import re
import pyrogram
from pyrogram import raw, types, utils
from pyrogram.file_id import FileType
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime, timedelta
from collections.abc import Callable
log = logging.getLogger(__name__)
class SendMediaGroup:
async def send_media_group(
self: pyrogram.Client,
chat_id: int | str,
media: list[
types.InputMediaPhoto
| types.InputMediaVideo
| types.InputMediaAudio
| types.InputMediaDocument
],
disable_notification: bool | None = None,
reply_to_message_id: int | None = None,
reply_to_chat_id: int | str | None = None,
schedule_date: datetime | timedelta | None = None,
protect_content: bool | None = None,
message_thread_id: int | None = None,
direct_messages_topic_id: int | None = None,
effect_id: int | None = None,
reply_parameters: types.ReplyParameters | None = None,
allow_paid_broadcast: bool | None = None,
paid_message_star_count: int | None = None,
business_connection_id: str | None = None,
progress: Callable | None = None,
progress_args: tuple = (),
quote_text: str | None = None,
quote_entities: list[types.MessageEntity] | None = None,
show_caption_above_media: bool | None = None,
background: bool | None = None,
clear_draft: bool | None = None,
update_stickersets_order: bool | None = None,
send_as: int | str | None = None,
quick_reply_shortcut: int | None = None,
**kwargs,
) -> list[types.Message]:
"""Send a group of photos or videos as an album.
.. 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).
media (List of :obj:`~pyrogram.types.InputMediaPhoto`, :obj:`~pyrogram.types.InputMediaVideo`, :obj:`~pyrogram.types.InputMediaAudio` and :obj:`~pyrogram.types.InputMediaDocument`):
A list describing photos and videos to be sent, must include 2–10 items.
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.
progress (``Callable``, *optional*):
Pass a callback function to view the file transmission progress.
The function must take ``(current, total)`` as positional arguments.
progress_args (``tuple``, *optional*):
Arguments to pass to the progress callback function.
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*.
message_thread_id (``int``, *optional*):
Unique identifier for a message thread in a forum topic.
direct_messages_topic_id (``int``, *optional*):
Unique identifier of the topic in a channel direct messages chat administered by the current user.
For directs only only.
effect_id (``int``, *optional*):
Unique identifier of the effect to apply to the message.
reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*):
Describes reply parameters for the message that is being 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.
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.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection.
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*.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media.
background (``bool``, *optional*):
Send the message in background.
clear_draft (``bool``, *optional*):
Clear the draft of the chat.
update_stickersets_order (``bool``, *optional*):
Move the sticker set to the top of the list.
send_as (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the chat or channel to send the message as.
quick_reply_shortcut (``int``, *optional*):
Unique identifier of the quick reply shortcut the message belongs to.
Returns:
List of :obj:`~pyrogram.types.Message`: On success, a list of the sent messages is returned.
Example:
.. code-block:: python
from pyrogram.types import InputMediaPhoto, InputMediaVideo
await app.send_media_group(
"me",
[
InputMediaPhoto("photo1.jpg"),
InputMediaPhoto("photo2.jpg", caption="photo caption"),
InputMediaVideo("video.mp4", caption="video caption")
]
)
"""
if kwargs:
raise TypeError(f"Got unexpected keyword argument(s): {set(kwargs)}")
if reply_parameters is None:
if 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,
)
elif quote_text is not None:
reply_parameters = types.ReplyParameters(
message_id=None,
chat_id=reply_to_chat_id,
quote=quote_text,
quote_entities=quote_entities,
)
multi_media = []
for i in media:
if isinstance(i, types.InputMediaPhoto):
if isinstance(i.media, str):
if os.path.isfile(i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedPhoto(
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
spoiler=i.has_spoiler,
),
)
)
media = raw.types.InputMediaPhoto(
id=raw.types.InputPhoto(
id=media.photo.id,
access_hash=media.photo.access_hash,
file_reference=media.photo.file_reference,
),
spoiler=i.has_spoiler,
)
elif re.match("^https?://", i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaPhotoExternal(
url=i.media, spoiler=i.has_spoiler
),
)
)
media = raw.types.InputMediaPhoto(
id=raw.types.InputPhoto(
id=media.photo.id,
access_hash=media.photo.access_hash,
file_reference=media.photo.file_reference,
),
spoiler=i.has_spoiler,
)
else:
media = utils.get_input_media_from_file_id(
i.media, FileType.PHOTO, has_spoiler=i.has_spoiler
)
else:
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedPhoto(
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
spoiler=i.has_spoiler,
),
)
)
media = raw.types.InputMediaPhoto(
id=raw.types.InputPhoto(
id=media.photo.id,
access_hash=media.photo.access_hash,
file_reference=media.photo.file_reference,
),
spoiler=i.has_spoiler,
)
elif isinstance(i, types.InputMediaVideo):
vcover_file = None
vcover_media = None
if i.video_cover is not None:
if isinstance(i.video_cover, str):
if os.path.isfile(i.video_cover):
vcover_media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedPhoto(
file=await self.save_file(
i.video_cover,
progress=progress,
progress_args=progress_args,
)
),
)
)
elif re.match("^https?://", i.video_cover):
vcover_media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaPhotoExternal(url=i.video_cover),
)
)
else:
vcover_file = utils.get_input_media_from_file_id(
i.video_cover, FileType.PHOTO
).id
else:
vcover_media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedPhoto(
file=await self.save_file(
i.video_cover,
progress=progress,
progress_args=progress_args,
)
),
)
)
if vcover_media:
vcover_file = raw.types.InputPhoto(
id=vcover_media.photo.id,
access_hash=vcover_media.photo.access_hash,
file_reference=vcover_media.photo.file_reference,
)
if isinstance(i.media, str):
if os.path.isfile(i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
spoiler=i.has_spoiler,
mime_type=self.guess_mime_type(i.media) or "video/mp4",
nosound_video=i.no_sound,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
attributes=[
raw.types.DocumentAttributeVideo(
supports_streaming=i.supports_streaming or None,
duration=i.duration,
w=i.width,
h=i.height,
),
raw.types.DocumentAttributeFilename(
file_name=i.file_name or os.path.basename(i.media)
),
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
),
spoiler=i.has_spoiler,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
)
elif re.match("^https?://", i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaDocumentExternal(
url=i.media,
spoiler=i.has_spoiler,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
),
spoiler=i.has_spoiler,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
)
else:
media = utils.get_input_media_from_file_id(
i.media,
FileType.VIDEO,
has_spoiler=i.has_spoiler,
video_cover=vcover_file,
video_start_timestamp=i.video_start_timestamp,
)
else:
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
spoiler=i.has_spoiler,
mime_type=self.guess_mime_type(
utils.get_file_name(
i.media,
file_name=i.file_name or "",
fallback="video.mp4",
)
)
or "video/mp4",
nosound_video=i.no_sound,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
attributes=[
raw.types.DocumentAttributeVideo(
supports_streaming=i.supports_streaming or None,
duration=i.duration,
w=i.width,
h=i.height,
),
raw.types.DocumentAttributeFilename(
file_name=utils.get_file_name(
i.media,
file_name=i.file_name or "",
fallback="video.mp4",
)
),
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
),
spoiler=i.has_spoiler,
video_cover=vcover_file,
video_timestamp=i.video_start_timestamp,
)
elif isinstance(i, types.InputMediaAudio):
if isinstance(i.media, str):
if os.path.isfile(i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(i.media) or "audio/mpeg",
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
attributes=[
raw.types.DocumentAttributeAudio(
duration=i.duration,
performer=i.performer,
title=i.title,
),
raw.types.DocumentAttributeFilename(
file_name=utils.get_file_name(
i.media, file_name=i.file_name, fallback="audio.mp3"
)
),
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
elif re.match("^https?://", i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaDocumentExternal(url=i.media),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
else:
media = utils.get_input_media_from_file_id(i.media, FileType.AUDIO)
else:
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(
utils.get_file_name(
i.media,
file_name=i.file_name,
fallback="audio.mp3",
)
)
or "audio/mpeg",
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
attributes=[
raw.types.DocumentAttributeAudio(
duration=i.duration, performer=i.performer, title=i.title
),
raw.types.DocumentAttributeFilename(
file_name=utils.get_file_name(
i.media, file_name=i.file_name, fallback="audio.mp3"
)
),
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
elif isinstance(i, types.InputMediaDocument):
if isinstance(i.media, str):
if os.path.isfile(i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(i.media) or "application/zip",
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
force_file=True
if i.disable_content_type_detection is None
else i.disable_content_type_detection,
attributes=[
raw.types.DocumentAttributeFilename(
file_name=utils.get_file_name(
i.media, file_name=i.file_name, fallback="file.zip"
)
)
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
elif re.match("^https?://", i.media):
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaDocumentExternal(url=i.media),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
else:
media = utils.get_input_media_from_file_id(i.media, FileType.DOCUMENT)
else:
media = await self.invoke(
raw.functions.messages.UploadMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(
utils.get_file_name(
i.media,
file_name=i.file_name,
fallback="file.zip",
)
)
or "application/zip",
file=await self.save_file(
i.media, progress=progress, progress_args=progress_args
),
thumb=await self.save_file(
i.thumb, progress=progress, progress_args=progress_args
),
force_file=True
if i.disable_content_type_detection is None
else i.disable_content_type_detection,
attributes=[
raw.types.DocumentAttributeFilename(
file_name=utils.get_file_name(
i.media, file_name=i.file_name, fallback="file.zip"
)
)
],
),
)
)
media = raw.types.InputMediaDocument(
id=raw.types.InputDocument(
id=media.document.id,
access_hash=media.document.access_hash,
file_reference=media.document.file_reference,
)
)
else:
raise ValueError(
f"{i.__class__.__name__} is not a supported type for send_media_group"
)
multi_media.append(
raw.types.InputSingleMedia(
media=media,
random_id=self.rnd_id(),
**await utils.parse_text_entities(
self, i.caption, i.parse_mode, i.caption_entities
),
)
)
r = await self.invoke(
raw.functions.messages.SendMultiMedia(
peer=await self.resolve_peer(chat_id),
multi_media=multi_media,
silent=disable_notification if disable_notification is not None else None,
reply_to=await utils.get_reply_to(
self,
reply_parameters,
message_thread_id,
direct_messages_topic_id=direct_messages_topic_id,
),
schedule_date=utils.datetime_to_timestamp(schedule_date),
noforwards=protect_content,
effect=effect_id,
allow_paid_floodskip=allow_paid_broadcast
if allow_paid_broadcast is not None
else None,
allow_paid_stars=paid_message_star_count
if paid_message_star_count is not None
else None,
invert_media=show_caption_above_media
if show_caption_above_media is not None
else None,
background=background,
clear_draft=clear_draft,
update_stickersets_order=update_stickersets_order,
send_as=await self.resolve_peer(send_as) if send_as is not None else None,
quick_reply_shortcut=raw.types.InputQuickReplyShortcutId(
shortcut_id=quick_reply_shortcut
)
if quick_reply_shortcut is not None
else None,
),
sleep_threshold=60,
business_connection_id=business_connection_id,
)
if business_connection_id:
return await utils.parse_messages(self, r)
return await utils.parse_messages(
self,
raw.types.messages.Messages(
messages=[
m.message
for m in filter(
lambda u: isinstance(
u,
(
raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateNewScheduledMessage,
raw.types.UpdateNewEphemeralMessage,
raw.types.UpdateBotNewBusinessMessage,
),
),
r.updates,
)
],
topics=[],
users=r.users,
chats=r.chats,
),
)