https://github.com/fonbah/tdlnode
Telegram nodejs client
https://github.com/fonbah/tdlnode
tdlib telegram telegram-api telegram-nodejs
Last synced: 5 months ago
JSON representation
Telegram nodejs client
- Host: GitHub
- URL: https://github.com/fonbah/tdlnode
- Owner: fonbah
- Created: 2019-03-05T09:55:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T18:28:28.000Z (over 2 years ago)
- Last Synced: 2025-10-30T21:02:49.680Z (8 months ago)
- Topics: tdlib, telegram, telegram-api, telegram-nodejs
- Language: JavaScript
- Homepage:
- Size: 31.3 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### tdlnode
Telegram nodejs client https://github.com/tdlib/td
- [Getting started](#getting-started)
- [Handling events](#events)
- [Options](#options)
- [Handling input](#client-input)
- [Handling errors](#client-errors)
- [TDLib](#tdlib)
### Requirements
1. Node.js >= 10 preferred (minimum >= 9.0.0)
2. TDLib binary https://github.com/tdlib/td
### Getting started
- Build TDLib binary https://tdlib.github.io/td/build.html?language=JavaScript
- `npm i tdlnode`
- Execute any of TDLib API methods https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html
```js
const path = require('path')
const { Client } = require('tdlnode')
const api_id = 'your api_id'
const api_hash = 'your api_hash'
const phone_number = '+12345679021' // or const token = 'your token'
const configuration = {
path_to_binary_file: path.resolve(__dirname, '../lib/libtdjson'),
database_directory: path.resolve(__dirname, '../storage'),
files_directory: path.resolve(__dirname, '../downloads'),
log_file_path: path.resolve(__dirname, '../logs/tdl.log'),
}
const up = async () => {
const client = new Client({ api_id, api_hash, phone_number }, configuration)
await client.init()
const chats = await client.fetch({
'@type': 'getChats',
'offset_order': '9223372036854775807',
'offset_chat_id': 0,
'limit': 100,
})
console.log(chats)
client.stop()
}
up()
```
### Events
Subscribe to:
- updates https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_update.html
- any of TDLib API return object type https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html
```js
const callback = msg => {console.log('event', msg)}
client.on('updateOption', callback)
client.once('updateOption', callback)
client.off('updateOption', callback)
```
### More examples
https://github.com/fonbah/tdlnode/tree/master/examples
### Options
```js
const conf = {
path_to_binary_file: path.resolve(__dirname, '../lib/libtdjson'), //default 'libtdjson'
enable_storage_optimizer: true, //default true
use_message_database: true, //default true
use_secret_chats: false, //default false
system_language_code: 'en', //default 'en'
application_version: version, //default pacage.json version
device_model: 'nodejs', //default 'nodejs'
system_version: '10', //default 10
database_directory: path.resolve(__dirname, '../storage'), //default './storage'
files_directory: path.resolve(__dirname, '../downloads'), //default './downloads'
log_file_path: path.resolve(__dirname, '../logs/tdl.log'), //default './logs/tdl.log'
use_test_dc: true, //default false If set to true, the Telegram test environment will be used instead of the production environment.
verbosity_level: 10, //default 2
fatal_error_callback: e => { console.log(e) }, //default console.log
}
```
### Client input handling
```js
const types = client.input.getTypes()
const verificationCodeHandler = resolve => {
const code = 'get somehow your code here'
resolve(code)
}
const inputHandler = (type, resolve) => {
switch (type) {
case 'code':
verificationCodeHandler(resolve)
break
}
}
const unsubscribe = client.input.subscribe(inputHandler)
```
full example https://github.com/fonbah/tdlnode/blob/master/examples/input.js
### Errors handling
```js
client.on('error', update => {
console.log('client error', update)
if (update.code == 429) {
client.stop()
}
})
```
### Getting started with telegram TDLib
- api_id and api_hash https://my.telegram.org/
- documentation https://core.telegram.org/tdlib/getting-started
- TDLib API updates objects https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_update.html
- list of all available TDLib API methods https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html
- building instructions https://tdlib.github.io/td/build.html?language=JavaScript