add three more methods for phone calls. (#37)

 * temporary workaround https://t.me/c/1220993104/1379063

Author: z44d

compiler/docs/compiler.py

@@ -345,8 +345,12 @@ def get_title_list(s: str) -> list:
  """,
  phone="""
  Phone
+ create_video_chat
+ discard_group_call
+ get_video_chat_rtmp_url
  invite_group_call_participants
  load_group_call_participants
+
  """,
  stickers="""
  Stickers
@@ -608,6 +612,7 @@ def get_title_list(s: str) -> list:
  VideoChatParticipantsInvited
  VideoChatScheduled
  VideoChatStarted
+ RtmpUrl
  """,
  )
 

docs/source/releases/changes-in-this-fork.rst

@@ -14,6 +14,7 @@ If you found any issue or have any suggestions, feel free to make `an issue <htt
 | Scheme layer used: 181 |
 +------------------------+
 
+- Added the methods :meth:`~pyrogram.Client.create_video_chat`, :meth:`~pyrogram.Client.discard_group_call`, :meth:`~pyrogram.Client.get_video_chat_rtmp_url` and the type :obj:`~pyrogram.types.RtmpUrl` (`#37 <https://github.com/TelegramPlayGround/pyrogram/pull/37>`_).
 - Added :meth:`~Client.on_story` to listen to story updates.
 - Ability to run in `replit` environment without creating `a deployment <https://ask.replit.com/t/pyrogram-network-issue/33679/46>`_. Set the environment variable ``PYROGRAM_REPLIT_NWTRAFIK_PORT`` value to ``5222`` if you want to connect to Production Telegram Servers, **OR** Set the environment variable ``PYROGRAM_REPLIT_WNTRAFIK_PORT`` value to ``5223`` if you want to connect to Test Telegram Servers, before starting the :obj:`~pyrogram.Client`.
 - Added the :meth:`~pyrogram.Client.invite_group_call_participants` (`#35 <https://github.com/TelegramPlayGround/pyrogram/pull/35>`_).

pyrogram/methods/phone/__init__.py

@@ -19,10 +19,16 @@
 
 from .load_group_call_participants import LoadGroupCallParticipants
 from .invite_group_call_participants import InviteGroupCallParticipants
+from .create_video_chat import CreateVideoChat
+from .discard_group_call import DiscardGroupCall
+from .get_video_chat_rtmp_url import GetVideoChatRtmpUrl
 
 
 class Phone(
  InviteGroupCallParticipants,
  LoadGroupCallParticipants,
+ CreateVideoChat,
+ DiscardGroupCall,
+ GetVideoChatRtmpUrl,
 ):
  pass

pyrogram/methods/phone/create_video_chat.py

@@ -0,0 +1,96 @@
+# 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 typing import Union
+
+from datetime import datetime
+
+import pyrogram
+from pyrogram import types, raw, utils
+
+
+class CreateVideoChat:
+ async def create_video_chat(
+ self: "pyrogram.Client",
+ chat_id: Union[int, str],
+ title: str = None,
+ start_date: datetime = utils.zero_datetime(),
+ is_rtmp_stream: bool = None
+ ) -> "types.Message":
+ """Creates a video chat (a group call bound to a chat).
+ 
+ Available only for basic groups, supergroups and channels; requires can_manage_video_chats administrator right.
+
+ .. include:: /_includes/usable-by/users.rst
+
+ Parameters:
+ chat_id (``int`` | ``str``):
+ Unique identifier (int) or username (str) of the target chat in which the video chat will be created. A chat can be either a basic group, supergroup or a channel.
+
+ title (``str``, *optional*):
+ Group call title; if empty, chat title will be used.
+
+ start_date (:py:obj:`~datetime.datetime`, *optional*):
+ Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 to start the video chat immediately. The date must be at least 10 seconds and at most 8 days in the future.
+
+ is_rtmp_stream (``bool``, *optional*):
+ Pass true to create an RTMP stream instead of an ordinary video chat; requires owner privileges.
+
+ Returns:
+ :obj:`~pyrogram.types.Message`: On success, the sent service message is returned.
+
+ Example:
+ .. code-block:: python
+
+ await app.create_video_chat(chat_id)
+
+ """
+ peer = await self.resolve_peer(chat_id)
+
+ if not isinstance(peer, (raw.types.InputPeerChat, raw.types.InputPeerChannel)):
+ raise ValueError(
+ "Target chat should be group, supergroup or channel."
+ )
+
+ r = await self.invoke(
+ raw.functions.phone.CreateGroupCall(
+ rtmp_stream=is_rtmp_stream,
+ peer=peer,
+ # TODO: temp. workaround
+ random_id=self.rnd_id() >> 32,
+ title=title,
+ schedule_date=utils.datetime_to_timestamp(start_date),
+ )
+ )
+
+ for i in r.updates:
+ if isinstance(
+ i,
+ (
+ raw.types.UpdateNewChannelMessage,
+ raw.types.UpdateNewMessage,
+ raw.types.UpdateNewScheduledMessage,
+ ),
+ ):
+ return await types.Message._parse(
+ self,
+ i.message,
+ {i.id: i for i in r.users},
+ {i.id: i for i in r.chats},
+ is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage),
+ )

pyrogram/methods/phone/discard_group_call.py

@@ -0,0 +1,85 @@
+# 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 typing import Union
+
+import pyrogram
+from pyrogram import types, raw
+
+
+class DiscardGroupCall:
+ async def discard_group_call(
+ # TODO
+ self: "pyrogram.Client",
+ chat_id: Union[int, str],
+ ) -> "types.Message":
+ """Terminate a group/channel call or livestream
+
+ .. include:: /_includes/usable-by/users.rst
+
+ Parameters:
+ chat_id (``int`` | ``str``):
+ Unique identifier (int) or username (str) of the target chat. A chat can be either a basic group, supergroup or a channel.
+
+ Returns:
+ :obj:`~pyrogram.types.Message`: On success, the sent service message is returned.
+
+ Example:
+ .. code-block:: python
+
+ await app.discard_group_call(chat_id)
+
+ """
+ peer = await self.resolve_peer(chat_id)
+
+ if isinstance(peer, raw.types.InputPeerChannel):
+ r = await self.invoke(raw.functions.channels.GetFullChannel(channel=peer))
+ elif isinstance(peer, raw.types.InputPeerChat):
+ r = await self.invoke(
+ raw.functions.messages.GetFullChat(chat_id=peer.chat_id)
+ )
+ else:
+ raise ValueError("Target chat should be group, supergroup or channel.")
+
+ call = r.full_chat.call
+
+ if call is None:
+ raise ValueError("No active group call at this chat.")
+
+ r = await self.invoke(
+ raw.functions.phone.DiscardGroupCall(
+ call=call
+ )
+ )
+
+ for i in r.updates:
+ if isinstance(
+ i,
+ (
+ raw.types.UpdateNewChannelMessage,
+ raw.types.UpdateNewMessage,
+ raw.types.UpdateNewScheduledMessage,
+ ),
+ ):
+ return await types.Message._parse(
+ self,
+ i.message,
+ {i.id: i for i in r.users},
+ {i.id: i for i in r.chats},
+ is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage),
+ )

pyrogram/methods/phone/get_video_chat_rtmp_url.py

@@ -0,0 +1,63 @@
+# 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 typing import Union
+
+import pyrogram
+from pyrogram import types, raw
+
+
+class GetVideoChatRtmpUrl:
+ async def get_video_chat_rtmp_url(
+ self: "pyrogram.Client",
+ chat_id: Union[int, str],
+ replace: bool = False
+ ) -> "types.RtmpUrl":
+ """Returns RTMP URL for streaming to the chat; requires owner privileges.
+
+ .. include:: /_includes/usable-by/users.rst
+
+ Parameters:
+ chat_id (``int`` | ``str``):
+ Unique identifier (int) or username (str) of the target chat. A chat can be either a basic group, supergroup or a channel.
+
+ replace (``bool``, *optional*):
+ Whether to replace the previous stream key or simply return the existing one. Defaults to False, i.e., return the existing one.
+
+ Returns:
+ :obj:`~pyrogram.types.RtmpUrl`: On success, the RTMP URL and stream key is returned.
+
+ Example:
+ .. code-block:: python
+
+ await app.get_stream_rtmp_url(chat_id)
+
+ """
+ peer = await self.resolve_peer(chat_id)
+
+ if not isinstance(peer, (raw.types.InputPeerChat, raw.types.InputPeerChannel)):
+ raise ValueError("Target chat should be group, supergroup or channel.")
+
+ r = await self.invoke(
+ raw.functions.phone.GetGroupCallStreamRtmpUrl(
+ peer=peer,
+ revoke=replace
+ )
+ )
+
+ return types.RtmpUrl._parse(r)

pyrogram/methods/phone/invite_group_call_participants.py

@@ -19,7 +19,7 @@
 from typing import Union, List
 
 import pyrogram
-from pyrogram import types, raw, utils
+from pyrogram import types, raw
 
 
 class InviteGroupCallParticipants:

pyrogram/types/user_and_chats/__init__.py

@@ -44,6 +44,7 @@
 from .video_chat_participants_invited import VideoChatParticipantsInvited
 from .video_chat_scheduled import VideoChatScheduled
 from .video_chat_started import VideoChatStarted
+from .rtmp_url import RtmpUrl
 
 __all__ = [
  "Birthdate",
@@ -74,4 +75,5 @@
  "VideoChatParticipantsInvited",
  "VideoChatScheduled",
  "VideoChatStarted",
+ "RtmpUrl",
 ]

pyrogram/types/user_and_chats/rtmp_url.py

@@ -0,0 +1,46 @@
+# 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 pyrogram import raw
+from ..object import Object
+
+
+class RtmpUrl(Object):
+ """Represents an RTMP URL and stream key to be used in streaming software.
+
+ Parameters:
+ url (``str``):
+ The URL.
+
+ stream_key (``str``):
+ Stream key.
+
+ """
+
+ def __init__(self, *, url: str, stream_key: str):
+ super().__init__(None)
+
+ self.url = url
+ self.stream_key = stream_key
+
+ @staticmethod
+ def _parse(rtmp_url: "raw.types.GroupCallStreamRtmpUrl") -> "RtmpUrl":
+ return RtmpUrl(
+ url=rtmp_url.url,
+ stream_key=rtmp_url.key
+ )