Source code for pyrogram.methods.invite_links.create_chat_invite_link
# 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 pyrogram
from pyrogram import raw, types, utils
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime, timedelta
class CreateChatInviteLink:
async def create_chat_invite_link(
self: pyrogram.Client,
chat_id: int | str,
name: str | None = None,
expire_date: datetime | timedelta | None = None,
member_limit: int | None = None,
creates_join_request: bool | None = None,
subscription_period: int | None = None,
subscription_price: int | None = None,
) -> types.ChatInviteLink:
"""Create an additional invite link for a chat.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
The link can be revoked using the method :meth:`~pyrogram.Client.revoke_chat_invite_link`.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier for the target chat or username of the target channel/supergroup
(in the format @username).
name (``str``, *optional*):
Invite link name.
expire_date (:py:obj:`~datetime.datetime`, *optional*):
Point in time when the link will expire.
Defaults to None (no expiration date).
member_limit (``int``, *optional*):
Maximum number of users that can be members of the chat simultaneously after joining the chat via
this invite link; 1-99999.
Defaults to None (no member limit).
creates_join_request (``bool``, *optional*):
True, if users joining the chat via the link need to be approved by chat administrators.
If True, member_limit can't be specified.
subscription_period (``int``, *optional*):
Number of seconds a subscription bought through this link lasts.
Currently must always be 2592000 (30 days).
subscription_price (``int``, *optional*):
Number of Telegram Stars a subscription through this link costs.
Returns:
:obj:`~pyrogram.types.ChatInviteLink`: On success, the new invite link is returned.
Example:
.. code-block:: python
# Create a new link without limits
link = await app.create_chat_invite_link(chat_id)
# Create a new link for up to 3 new users
link = await app.create_chat_invite_link(chat_id, member_limit=3)
"""
r = await self.invoke(
raw.functions.messages.ExportChatInvite(
subscription_pricing=raw.types.StarsSubscriptionPricing(
period=subscription_period, amount=subscription_price
)
if subscription_period is not None and subscription_price is not None
else None,
peer=await self.resolve_peer(chat_id),
expire_date=utils.datetime_to_timestamp(expire_date),
usage_limit=member_limit,
title=name,
request_needed=creates_join_request,
)
)
link = types.ChatInviteLink._parse(self, r)
if link:
link.creator = self.me
return link