72 lines
2.1 KiB
Markdown
72 lines
2.1 KiB
Markdown
Telegram Bots
|
|
=============
|
|
Create and control [Telegram bots](https://core.telegram.org/bots) easily
|
|
using the new [Telegram API](https://core.telegram.org/bots/api).
|
|
|
|
```
|
|
npm install telegram-api
|
|
```
|
|
|
|
telegram-api is in beta, your feedback is appreciated, please [fill an issue](https://github.com/mdibaiee/node-telegram-api/issues)
|
|
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](https://github.com/mdibaiee/webdevrobot).
|
|
|
|
[Documentation](https://github.com/mdibaiee/node-telegram-api/wiki)
|
|
==============
|
|
|
|
Example
|
|
=======
|
|
```javascript
|
|
// 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](https://telegram.me/webdevrobot) => [mdibaiee/webdevrobot](https://github.com/mdibaiee/webdevrobot)
|
|
[@metagon_bot](https://telegram.me/metagon_bot) => [austinhuang0131/metagon](https://github.com/austinhuang0131/metagon)
|
|
|
|
Todo
|
|
====
|
|
- [x] Webhook support (not tested, see [#4](https://github.com/mdibaiee/node-telegram-api/issues/4))
|
|
- [x] Forward Type
|
|
- [x] BulkMessage Type
|
|
- [x] File Type
|
|
- [ ] Sticker Type
|
|
- [ ] Location Type
|
|
- [ ] Contact Type
|
|
- [ ] Allow remote control of bots (TCP maybe)
|
|
- [ ] YOUR IDEAS! [Fill an issue](https://github.com/mdibaiee/node-telegram-api/issues)
|