logo

Opengram

Telegram Bot API framework for Node.js based on Telegraf 3.38

Bot API VersionCIcodecovnpmdownloadsjavascript style guideCodacy BadgeLicense: MITFOSSA Status

Introduction

Bots are special Telegram accounts designed to handle messages automatically. Users can interact with bots by sending them command messages in private or group chats. These accounts serve as an interface for code running somewhere on your server.

Opengram is a library that makes it simple for you to develop your own Telegram bots using JavaScript.

Features

Quickstart

If you are new to Telegram bots, read the official Introduction for Developers written by the Telegram team.

  • Visit @BotFather and create a new bot. You will obtain a bot token.
  • Install opengram:
    • pnpm: pnpm install opengram
    • yarn: yarn add opengram
    • npm: npm i opengram
  • Create bot.js file and paste code
    const { Opengram, isTelegramError } = require('opengram')

if (process.env.BOT_TOKEN === undefined) {
  throw new TypeError('BOT_TOKEN must be provided!')
}

// Create Opengram instance with BOT TOKEN given by http://t.me/BotFather
const bot = new Opengram(process.env.BOT_TOKEN)

// Add handler for text messages
bot.on('text', async ctx => {
  await ctx.reply(ctx.message.text)
})

// Register error handler, for preventing bot crashes
bot.catch((error, ctx) => {
  if (isTelegramError(error)) {
    console.error(error, ctx) // Print error and context
    return
  }
  throw error
})

// Start bot using long-polling
bot.launch()
  .then(() => console.log(`Bot started`))

// Enable graceful stop
process.once('SIGINT', () => bot.stop())
process.once('SIGTERM', () => bot.stop())
  • Run node bot.js
  • Congrats! You just wrote a Telegram bot 🥳

For more examples, check docs/examples in repository

Resources

License

FOSSA Status