@inite/n8n-nodes-telepilot
v0.6.4
Published
Your personal Telegram CoPilot
Maintainers
Readme
n8n-nodes-telepilot
This is an n8n community node that provides native Telegram integration using GramJS - a powerful JavaScript/TypeScript implementation of the Telegram API.
n8n is a fair-code licensed workflow automation platform.
Installation
Operations
Credentials
Compatibility
Usage
Resources
Version
Installation
Follow the installation guide in the n8n community nodes documentation.
npm
npm install @inite/n8n-nodes-telepilotn8n
In n8n, navigate to Settings > Community Nodes and install:
@inite/n8n-nodes-telepilotOperations
TelePilot Node
Main node for interacting with Telegram API:
User Operations
- Get Me - Get information about the current user
- Get User - Get user information by ID
- Get User Full Info - Get detailed user information
- Create Private Chat - Create a private chat with a user
- Create Secret Chat - Create an end-to-end encrypted chat
Contact Operations
- Get Contacts - Retrieve your contact list
Chat Operations
- Get Chat History - Retrieve message history from a chat
- Get Chats - List available chats/dialogs
- Get Chat - Get specific chat information
- Search Public Chat - Find public chats by username
- Search Public Chats - Search for public chats by query
- Join Chat - Join a channel or group
- Open Chat - Mark chat as opened
- Close Chat - Mark chat as closed
- Toggle Chat Mark as Unread - Mark/unmark chat as unread
- Create Supergroup - Create a new supergroup or channel
- Delete Chat - Delete a chat/dialog
- Add Chat Members - Add users to a channel
- Send Chat Action - Send typing/uploading status
Message Operations
- Get Message - Retrieve a specific message
- Send Message - Send a text message
- Send Audio - Send audio files or voice messages
- Send File - Send any file type
- Send Photo - Send images
- Edit Message - Edit message text
- Delete Messages - Delete one or multiple messages
- Forward Messages - Forward messages between chats
File Operations
- Get Remote File - Get remote file information
- Download File - Download files from Telegram
Group Operations
- Get Supergroup - Get supergroup/channel information
- Get Supergroup Full Info - Get detailed supergroup information
Login Operations
- Login - Interactive authentication with phone number
- Help - Show available commands
- Status - Check authentication status
- Clear - Clear local session
- Stop - Terminate current session
TelePilot Trigger Node
Trigger node for listening to Telegram events:
Supported Events
- New Message - Triggered when new messages arrive
- Message Edited - Triggered when messages are edited
- Message Deleted - Triggered when messages are deleted
- User Status - Triggered on user status changes
- Chat Action - Triggered on typing indicators and other actions
- * - Listen to all events
Credentials
To use this node, you need Telegram API credentials:
Get API credentials:
- Go to https://my.telegram.org
- Log in with your phone number
- Navigate to "API development tools"
- Create a new application
- Copy your
api_idandapi_hash
Configure in n8n:
- Create new credentials of type "TelePilot API"
- Enter your
api_id - Enter your
api_hash - Enter your phone number (with country code, e.g., +1234567890)
Authenticate:
- Use the Login operation in the TelePilot node
- Follow the interactive authentication flow
- Enter the code sent to your Telegram app
- If 2FA is enabled, enter your password
Compatibility
- Minimum n8n version: 0.199.0
- Tested with n8n: 0.220.0+
- Node.js: 18.x or higher
Usage
Basic Message Sending
// 1. Create TelePilot credentials with your API credentials
// 2. Add TelePilot node to your workflow
// 3. Select operation: Message > Send Message
// 4. Enter chat_id (can be user ID or chat ID)
// 5. Enter your message textListening to New Messages
// 1. Add TelePilot Trigger node
// 2. Select events: "New Message"
// 3. Activate workflow
// 4. New messages will trigger the workflowAuthentication Flow
The node uses GramJS with StringSession-based authentication:
- First login: Uses interactive authentication with phone number and code
- Session storage: Saves encrypted session to
.sessionfiles - Subsequent logins: Automatically restores session from file
- 2FA support: Prompts for password if two-factor authentication is enabled
Working with Audio/Voice Messages
// Send as voice message:
// - Set "Send as Voice" to true
// - Provide audio file path or binary data
// - Voice messages work best with .ogg format
// Send as audio file:
// - Set "Send as Voice" to false
// - Any audio format supportedResources
- n8n community nodes documentation
- GramJS Documentation
- Telegram API Documentation
- TelePilot Setup Guide
Version History
0.6.3 (Current)
- Migrated from telepilot-tdl to native GramJS
- Improved performance and reliability
- Better session management with StringSession
- Fixed client initialization issues
- Enhanced error handling with NodeOperationError
- Optimized object serialization
0.5.x
- Legacy version using telepilot-tdl wrapper
- TDLib-based implementation
Support
For issues, questions, or contributions:
- GitHub: inite-ai/n8n-nodes-telepilot
- Documentation: telepilot.co
