Skip to main content

Get Channel Participants

Retrieves participants from a specified Telegram channel.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Client Id - The unique identifier of the Telegram client to use for this operation.
  • Channel Username - The username of the channel from which to retrieve participants.
  • Limit - The maximum number of participants to retrieve (must be greater than 0).
  • Offset - The offset from which to start retrieving participants (must be equal or greater than 0).

Output​

  • Participants - An array of participant objects containing participant information.

How It Works​

The Get Channel Participants node retrieves participants from a specified Telegram channel. When executed, the node:

  1. Validates the provided inputs (Client Id, Channel Username, Limit, and Offset)
  2. Resolves the channel username to get the channel entity
  3. Uses the Telegram client to fetch participants from the specified channel
  4. Processes each participant to extract relevant information:
    • ID
    • Access hash
    • First name
    • Last name
    • Username
    • Phone number
  5. Returns the list of participants as output

Requirements​

  • A valid Telegram client session with appropriate permissions
  • Valid Channel Username
  • Valid Limit and Offset values
  • Client Id must match an existing Telegram client session

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Client Id
  • Empty or invalid Channel Username
  • Limit value less than or equal to 0
  • Offset value less than 0

Usage Notes​

  • The Channel Username should be the public username of the channel (without the @ symbol)
  • The Limit parameter controls how many participants are retrieved in a single call
  • The Offset parameter allows for pagination through the participant list
  • The output contains detailed information about each participant
  • The Client Id must correspond to an active Telegram client session