Documentation

Fields

• invite_link :: Maybe Text

  Chat invite link

• name :: Maybe Text

  Name of the link

• creator_user_id :: Maybe Int

  User identifier of an administrator created the link

• date :: Maybe Int

  Point in time (Unix timestamp) when the link was created

• edit_date :: Maybe Int

  Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown

• expiration_date :: Maybe Int

  Point in time (Unix timestamp) when the link will expire; 0 if never

• subscription_pricing :: Maybe StarSubscriptionPricing

  Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription

• member_limit :: Maybe Int

  The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval

• member_count :: Maybe Int

  Number of chat members, which joined the chat using the link

• expired_member_count :: Maybe Int

  Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only

• pending_join_request_count :: Maybe Int

  Number of pending join requests created using this link

• creates_join_request :: Maybe Bool

  True, if the link only creates join request. If true, total number of joining members will be unlimited

• is_primary :: Maybe Bool

  True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. Primary link can create join requests only if this is set up using toggleSupergroupJoinByRequest. There is exactly one primary invite link for each administrator with can_invite_users right at a given time

• is_revoked :: Maybe Bool

  True, if the link was revoked