duagram
Advanced tools
Readme
Telegram Framework for userbot and or bot api, using nodejs.
Use at Your Own Risk.
I don't take any responsibility from actions made by you or on your account.
npm i duagram
or
yarn add duagram
or
pnpm add duagram
const { duaGram } = require("duagram");
const bot = new duaGram({
api_id: 1,
api_hash: 'your-api-hash',
// Fill in the session here if you have one, or leave it blank
session: '',
});
bot.cmd('ping', (ctx) => {
console.log(ctx);
// bot.sendMessage(ctx, 'pong'); // or:
// bot.sendMessage(ctx.chat.id, 'pong'); // or:
return ctx.reply('pong!');
});
bot.start();
To use the duaGram, you first have to get API ID dan API HASH.
Get it from https://my.telegram.org
If you connect use Bot API, get a bot account by chatting with BotFather.
BotFather will give you a token, something like 123456789:AbCdfGhIJKlmNoQQRsTUVwxyZ.
Do you need more example? Check this page.
const { duaGram, terminal } = require("duagram");
const bot = new duaGram({
api_id: 1,
api_hash: 'your-api-hash',
logLevel: 1, // 0 false, 1 event, 2 detail
logDetail: "none", // none, error, warn, info, debug
// Fill in the session here if you have one, or leave it blank
session: '',
// The most common error is the FloodWait error which is caused by calling a method multiple times in a short period and acts as a spam filter from telegram. So:
floodSleepThreshold: 120,
// Mark message history as read
markRead: false
});
bot.on('message', (ctx, _ctx) => {
terminal.debug('Ctx Duagram');
console.log(ctx);
});
bot.cmd('ping', (ctx) => {
bot.sendMessage(ctx, 'Pong!', { replyToMsgId: ctx.id });
});
bot.cmd('upload', async (ctx) => {
terminal.info('Starting upload...');
let file = './photo.jpg';
return bot.sendFile(ctx.chat.id, file);
});
bot.cmd('version', (ctx) => {
return bot.sendMessage(ctx, `<code>${JSON.stringify(bot.version, null, 2)}<code>`, { parse_mode: 'HTML' });
});
bot.start();
Login with Bot API Token
const { duaGram, terminal, Helper } = require("duagram");
const bot = new duaGram({
api_id: 1,
api_hash: 'your-api-hash',
as_bot_api: true,
bot_token: 'your-token-bot'
});
// event all new message
bot.on('message', async (ctx) => {
terminal.debug('Ctx Duagram');
console.log(ctx);
});
bot.cmd('ping', (ctx) => {
return ctx.reply('Pong!', { replyToMsgId: ctx.id });
});
bot.cmd('upload', async (ctx) => {
terminal.info('Starting upload...');
let file = './photo.jpg';
return await bot.sendFile(ctx.chat.id, file);
});
// bot API
bot.cmd('start', async (ctx) => {
// message in only
if (ctx.out) return false;
if (!bot.asBotApi) {
return bot.sendMessage(ctx, "I'm not bot api 😅")
}
let chat_id = ctx.chat.id;
if (ctx.chat.type == 'channel') {
chat_id = bot.Helper.chat.to_api(chat_id);
}
// if Bot API, send with Bot API can too
let reply_markup = JSON.stringify({
inline_keyboard: [
[
bot.Helper.Button.url('👥 uBotIndonesia', 'https://t.me/ubotindonesia')
], [
bot.Helper.Button.text('One', 'cb1'),
bot.Helper.Button.text('Two', 'cb2')
]
]
});
let more = {
parse_mode: 'html',
reply_markup
}
return bot.BotApi.sendMessage(chat_id, 'This message from <b>Bot Api</b>', more)
.then(result => {
terminal.log('Result: BotApi sendMessage')
console.log(result);
})
.catch(error => terminal.error(error.message));
});
bot.cmd('version', (ctx) => {
return bot.sendMessage(ctx, `<code>${JSON.stringify(bot.version, null, 2)}<code>`, { parse_mode: 'HTML' });
});
bot.start();
const bot = new duaGram(options);
| Item | Description | Default |
|---|---|---|
| api_id | get it from https://my.telegram.org | |
| api_hash | get it from https://my.telegram.org | |
| session | session string | |
| session_name | Session name | - |
| local | with local database | false |
| logLevel | Show log level 0 off, 1 event name, 2 detail | 1 |
| logDetail | Event Detail (none, error, warn, info, debug) | info |
| as_bot_api | Login as bot API? 0 false / 1 true | 0 |
| bot_token | Token Bot API @botfahter | |
| connectionRetries | Connection Retry | 3 |
| floodSleepThreshold | FloodWait error ? Set this | 120 |
| markRead | Mark message history as read | TRUE |
| cmdPrefix | prefix for command trigger | !/. |
Available :
updateType, stop=true)string, callback, stop=true)regex|string, callback, stop=true)regex|string, callback, stop=true) alias hearcmdExample:
bot.cmd('ping', callback);
bot.hear('hello', callback);
bot.hear(/^!time$/i, callback);
bot.hear(/coffee/i, callback, false); // if found stopable? false. So, catch condition anatoher again bellow
bot.hear(/tea/i, callback);
Example:
bot.on('message', (ctx, _ctx) => terminal.less(ctx) );
Available:
You can see on
ctx.eventmessage too.
Class name event example:
Result object raw without middleware effect.
Method or Accessors of duaGram.
| method | description |
|---|---|
| telegram | collection function duagram |
| Api | access for API Telegram |
| client | client connecton |
| BotApi | wrapper for Bot Api Telegram |
| terminal | console replacement for colorful and bettermore |
| lessLog | better thanconsole.log function, less prefix _ field |
| asBotApi | true/false |
| version | duagrams version info |
| cmdPrefix | default is.!/ |
| Helper | Go to helper doc |
Example:
const bot = new duaGram({...});
bot.cmdPrefix = '~'; // bot.cmd('ping', ..) => ~ping
console.log(bot.version);
telegram)params)peer, text, more)params)ctx)peer, text, more)peer, id, text, more)peer, ids, more)peerFrom, peerTo, ids, more)peer, ids)peer, id, more)peer)peer, more)peer, more)peer)peerChatId, peerUserId, more = {})peerChatId, peerUserId, more = {})peer)peer)id)peer, more)channelId, userId)Middleware is an essential part of any modern framework. It allows you to modify requests and responses as they pass between the Telegram and your bot.
You can imagine middleware as a chain of logic connection your bot to the Telegram request.
Middleware normally takes two parameters (ctx, next), ctx is the context for one Telegram update, next is a function that is invoked to execute the downstream middleware. It returns a Promise with a then function for running code after completion.
bot.middleware((ctx, next) => {
ctx.additional = 'message test from middleware';
next();
});
bot.cmd('plus', async (ctx) => {
if (!ctx.out)
return bot.sendMessage(ctx.chat.id, `Hooked: ${ctx.additional}`);
})
Middleware more information: click here.
If you are Indonesian, let's join the @ubotindonesia telegram group.
see you again ^^
FAQs
Telegram Framework for userbot or bot api
The npm package duagram receives a total of 22 weekly downloads. As such, duagram popularity was classified as not popular.
We found that duagram demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.