Deprecated: A simple API to create and control Telegram bots
Go to file
2017-09-12 18:39:09 +04:30
src fix: move optional argument to end 2017-09-12 18:39:09 +04:30
.babelrc refactor: remove grunt and babel 2016-03-28 12:26:07 +04:30
.eslintrc chore(lint): update eslint configuration, re-lint 2016-03-28 20:40:59 +04:30
.gitignore chore(lint): update eslint configuration, re-lint 2016-03-28 20:40:59 +04:30
demo.gif smaller GIF 2015-06-27 04:50:25 +04:30
demo.js feat(API): add previous API 2016-03-28 12:35:56 +04:30
esdoc.json V2 - Big update 2015-06-29 03:12:48 +04:30
Gruntfile.js feat(API): add previous API 2016-03-28 12:35:56 +04:30
hand-glow.jpg Fix #8 2015-07-27 09:25:27 +04:30
LICENSE Initial commit 2015-06-26 03:04:01 +04:30
package.json chore: bump version 2017-09-12 12:52:50 +04:30
README.md An AD (Since I contributed some) 2017-07-21 15:07:51 -04:00

Telegram Bots

Create and control Telegram bots easily using the new Telegram API.

npm install telegram-api

telegram-api is in beta, your feedback is appreciated, please fill an issue for any bugs you find or any suggestions you have.

If you are cloning this repository, remember to run npm install to install dependencies.

If you are looking for a real-life example of a bot written using this module, see mdibaiee/webdevrobot.

Documentation

Example

// ES6:
import Bot, { Message, File } from 'telegram-api';

// ES5:
var Bot = require('telegram-api').default;
var Message = require('telegram-api/types/Message');
var File = require('telegram-api/types/File');

var bot = new Bot({
  token: 'YOUR_TOKEN'
});

bot.start();

bot.get(/Hi|Hey|Hello|Yo/, function(message) {
  var answer = new Message().text('Hello, Sir').to(message.chat.id);

  bot.send(answer);
});

bot.command('start', function(message) {
  var welcome = new File().file('./some_photo.png').caption('Welcome').to(message.chat.id);

  bot.send(welcome);
});

// Arguments, see: https://github.com/mdibaiee/node-telegram-api/wiki/Commands
bot.command('weather <city> [date]', function(message) {
  console.log(message.args.city, message.args.date);
})

Bots using this module

@webdevrobot => mdibaiee/webdevrobot @metagon_bot => austinhuang0131/metagon

Todo

  • Webhook support (not tested, see #4)
  • Forward Type
  • BulkMessage Type
  • File Type
  • Sticker Type
  • Location Type
  • Contact Type
  • Allow remote control of bots (TCP maybe)
  • YOUR IDEAS! Fill an issue