Telegram Client icon

Telegram Client

Use Telegram Client API

Overview

The "Join Chat" operation of the Telegram Client node allows a user to join a specified Telegram chat or channel by providing its ID or username. This is useful in automation workflows where you want to programmatically add the bot or client to a group, channel, or chat without manual intervention.

Common scenarios include:

  • Automatically joining a promotional or announcement channel before sending messages.
  • Joining a group chat as part of onboarding or integration processes.
  • Managing membership of chats dynamically based on workflow conditions.

Example: A workflow that monitors new users and automatically joins them to a specific Telegram channel for updates.

Properties

Name Meaning
Chat ID The unique identifier or username of the chat or channel to join (e.g., @username or -100xxxx).

Output

The output JSON object contains the following fields:

  • success: Boolean indicating if the join operation was successful.
  • joined: Boolean confirming the client has joined the chat (always true if success).
  • chatId: The ID or username of the chat/channel that was joined.

Example output:

{
  "success": true,
  "joined": true,
  "chatId": "@examplechannel"
}

No binary data is produced by this operation.

Dependencies

  • Requires valid Telegram API credentials including an API ID, API hash, and a session string.
  • The node uses the Telegram Client API via a third-party SDK bundled with the node.
  • Network connectivity to Telegram servers is necessary.
  • Proper permissions for the account/session to join the target chat or channel.

Troubleshooting

  • Error: No credentials provided
    Ensure that the Telegram API credentials are configured correctly in n8n before running the node.

  • Operation not supported error
    Verify that the operation parameter is set exactly to "joinChat".

  • Authentication failed
    Check that the API ID, API hash, and session string are valid and have not expired.

  • Permission errors when joining a chat
    The account may be restricted from joining the chat or the chat may require an invite link or admin approval.

  • Network or connection issues
    Confirm stable internet access and that Telegram servers are reachable.

If the node is set to continue on fail, errors will be returned in the output JSON under the error field.

Links and References

Discussion