get_chat_join_requests()

Client.get_chat_join_requests()

Get the pending join requests of a chat.

Usable by Users Bots
Parameters:
  • chat_id (``int`` | ``str``) – Unique identifier for the target chat or username of the target channel/supergroup (in the format @username).

  • limit (``int``, *optional*) – Limits the number of invite links to be retrieved. By default, no limit is applied and all invite links are returned.

  • query (``str``, *optional*) – Query to search for a user.

Returns:

``Generator`` (A generator yielding ChatJoiner objects.)

Yields:

ChatJoiner objects.