Telematic icon

Telematic

Use Telegram Client API

Overview

This node integrates with the Telegram Client API to perform various chat-related operations. Specifically, the "Join Chat" operation allows the user to join a Telegram chat or channel by providing its identifier. This is useful in automation workflows where joining a chat programmatically is required, such as subscribing a bot or user to a channel before sending messages or monitoring content.

Practical examples:

  • Automatically joining a public Telegram channel when triggered by an event.
  • Adding a user or bot to a group chat as part of onboarding or notification setup.
  • Joining multiple chats sequentially in bulk automation tasks.

Properties

Name Meaning
Chat ID The unique identifier or username of the chat or channel to join (e.g., @username or -100xxxx).
Options Additional optional settings (not used specifically for Join Chat 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 "Join Chat" operation, only the Chat ID property is required and relevant.

Output

The output JSON object for the "Join Chat" operation contains:

  • success: Boolean indicating if the join operation was successful.
  • joined: Boolean confirming that the chat was joined (always true on success).
  • chatId: The chat identifier that was joined.

Example output:

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

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential with access to the Telegram Client API.
  • The node uses the Telegram Client SDK internally to connect and perform actions.
  • Network connectivity to Telegram servers is necessary.
  • Proper API credentials (API ID and API Hash) must be configured in n8n credentials.

Troubleshooting

  • Missing or invalid credentials: The node will throw an error if no valid API credentials are provided. Ensure the API ID and API Hash are correctly set up.
  • Invalid Chat ID: If the chat/channel identifier is incorrect or inaccessible, the join operation may fail. Verify the chat ID format and permissions.
  • Connection issues: Network problems or Telegram server downtime can cause connection failures. Check internet connectivity and retry later.
  • Permission errors: Some channels or groups may require invitations or admin approval to join. The node cannot bypass these restrictions.
  • Error messages: Errors thrown include descriptive messages from the Telegram client. Use these messages to diagnose issues like authentication failure or invalid parameters.

Links and References

Discussion