Telegram Client icon

Telegram Client

Use Telegram Client API

Overview

This node integrates with the Telegram Client API to perform various Telegram-related operations. Specifically, the Get User Info operation retrieves detailed information about a Telegram user by their user ID or username.

Common scenarios where this node is useful include:

  • Fetching profile details of a Telegram user for display or processing.
  • Verifying user identity in workflows that involve Telegram messaging.
  • Gathering user metadata for analytics or logging purposes.

For example, you can input a Telegram username and get back the user's full profile data, which might include their name, username, status, and other public information available via the Telegram API.

Properties

Name Meaning
User ID The Telegram user ID or username whose information you want to retrieve.
Options A collection of optional parameters (not used in this operation but available generally):
- Silent: Send message silently without notification
- Caption: Caption for media messages
- Parse Mode: How to parse message text (None, Markdown, HTML)
- Limit: Maximum number of items to return

Note: For the Get User Info operation, only the User ID property is required and relevant.

Output

The output JSON contains:

  • success: Boolean indicating if the operation was successful (true).
  • user: An object representing the Telegram user entity retrieved from the API. This includes all available user information such as username, first name, last name, user ID, and possibly more depending on the Telegram API response.

Example output structure (simplified):

{
  "success": true,
  "user": {
    "id": 123456789,
    "username": "exampleuser",
    "firstName": "John",
    "lastName": "Doe",
    // ... other user properties
  }
}

No binary data is output by this operation.

Dependencies

  • Requires an active Telegram Client API credential with valid session, API ID, and API hash.
  • Uses the Telegram Client SDK internally to connect and fetch user data.
  • The node must be configured with these credentials before execution.

Troubleshooting

  • No credentials provided: The node will throw an error if the Telegram API credentials are missing or invalid. Ensure you have set up the required API authentication token/session correctly.
  • Operation not supported: If an unsupported operation value is passed, the node throws an error. Make sure to select "Get User Info" for this use case.
  • User not found or invalid user ID: If the specified user ID or username does not exist or is incorrect, the Telegram API may return an error. Verify the user identifier is correct.
  • Connection issues: Network problems or invalid API credentials can cause connection failures. Check your internet connection and credential validity.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion