Telegram API JS (MTProto) client library for Node.js
npm install mtproto-nodejs-clientTelegram API (MTProto) client for Node.js.
Written in TypeScript for typings. Use Node.js native API for crypto and hashing. Simple and more reliable thanks to removing browser support.
* Actual. 195 layer in the API scheme
* Fast. Uses the TCP and node:crypto.
* Easy. Cryptography is hidden. Work with the API at a high level
* Smart. Automatically sync authorization on all DCs
* 2FA. Use the library's built-in function to calculate 2FA parameters
* Secure. Complies with Telegram security guidelines
* Typescript. Typescript + Typing for updates and API methods
* ECMAScript. ECMAScript modules are the official standard for JavaScript packages.
``
npm install mtproto-nodejs-client
Connect to Telegram servers
`js
const api_id = 12345678;
const api_hash = "abcdef1234567890abcdef1234567890”;
const storage = createLocalStorage({ path: "storage.json" })
const mtproto = new MTProto({
api_id: api_id,
api_hash: api_hash,
storage: storage
})
`
Sign in to your account
`js
const phone_number = "+1234567890"
const phone_code_hash = "will_be_returned_on_sendCode"
const code = "can_be_found_in_the_telegram_app_after_calling_sendCode"
// step 1
sendCode().then(function(resp) {
console.log("phone_code_hash", resp.phone_code_hash)
})
// step 2
signIn(phone_code_hash, code).then(function(resp) {
console.log("phone_code_hash", resp.phone_code_hash)
})
function sendCode() {
return mtproto.call("auth.sendCode", {
api_hash,
api_id,
phone_number,
settings: {
_: "codeSettings"
}
})
}
function signIn(phone_code_hash: string, phone_code: string) {
return mtproto.call("auth.signIn", {
phone_number,
phone_code_hash,
phone_code,
})
}
`
Set updates listener
`js
mtproto.updates.on("updateShort", console.log)
mtproto.updates.on("updateShortChatMessage", console.log)
mtproto.updates.on("updateShortMessage", console.log)
mtproto.updates.on("updateShortSentMessage", console.log)
mtproto.updates.on("updates", console.log)
mtproto.updates.on("updatesCombined", console.log)
mtproto.updates.on("updatesTooLong", console.log)
// call getState to start receiving updates
mtproto.call("updates.getState").then(function(state) {
console.log("state", state)
})
`
The library was initially created by @alik0211.
The mtproto.json is well described here (detailed schema in JSON).
The api.json` is well desctibed here (detailed schema in JSON).
GPLv3