You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
3.7 KiB
87 lines
3.7 KiB
# Node.js Telegram Bot API
|
|
|
|
[](https://core.telegram.org/bots/api)
|
|
[](https://travis-ci.org/yagop/node-telegram-bot-api)
|
|
[](https://ci.appveyor.com/project/yagop/node-telegram-bot-api/branch/master)
|
|
[](https://coveralls.io/r/yagop/node-telegram-bot-api?branch=master)
|
|
[](https://www.bithound.io/github/yagop/node-telegram-bot-api)
|
|
[](https://telegram.me/node_telegram_bot_api)
|
|
[](https://telegram.me/Yago_Perez)
|
|
|
|
Node.js module to interact with official [Telegram Bot API](https://core.telegram.org/bots/api). A bot token is needed, to obtain one, talk to [@botfather](https://telegram.me/BotFather) and create a new bot.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install --save node-telegram-bot-api
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const TelegramBot = require('node-telegram-bot-api');
|
|
|
|
// replace the value below with the Telegram token you receive from @BotFather
|
|
const token = 'YOUR_TELEGRAM_BOT_TOKEN';
|
|
|
|
// Create a bot that uses 'polling' to fetch new updates
|
|
const bot = new TelegramBot(token, {polling: true});
|
|
|
|
// Matches "/echo [whatever]"
|
|
bot.onText(/\/echo (.+)/, (msg, match) => {
|
|
// 'msg' is the received Message from Telegram
|
|
// 'match' is the result of executing the regexp above on the text content
|
|
// of the message
|
|
|
|
const chatId = msg.chat.id;
|
|
const resp = match[1]; // the captured "whatever"
|
|
|
|
// send back the matched "whatever" to the chat
|
|
bot.sendMessage(chatId, resp);
|
|
});
|
|
|
|
// Listen for any kind of message. There are different kinds of
|
|
// messages.
|
|
bot.on('message', (msg) => {
|
|
const chatId = msg.chat.id;
|
|
|
|
// send a message to the chat acknowledging receipt of their message
|
|
bot.sendMessage(chatId, 'Received your message');
|
|
});
|
|
```
|
|
|
|
## Documentation
|
|
|
|
* [Usage][usage]
|
|
* [Examples][examples]
|
|
* [Help Information][help]
|
|
* API Reference ([release][api-release] / [development][api-dev])
|
|
* [Contributing to the Project][contributing]
|
|
|
|
_**Note**: Development is done against the **master** branch. Code for the latest release
|
|
resides on the **release** branch._
|
|
|
|
## Community
|
|
|
|
We have a [Telegram channel][tg-channel] where we post updates on
|
|
the Project. Head over and subscribe!
|
|
|
|
Some things built using this library, and might interest you:
|
|
|
|
* [tgfancy](https://github.com/GochoMugo/tgfancy): A Fancy, Higher-Level Wrapper for Telegram Bot API
|
|
* [node-telegram-bot-api-middleware](https://github.com/idchlife/node-telegram-bot-api-middleware): Middleware for node-telegram-bot-api
|
|
* [teleirc](https://github.com/FruitieX/teleirc): A simple Telegram ↔ IRC gateway
|
|
|
|
## License
|
|
|
|
**The MIT License (MIT)**
|
|
|
|
Copyright (c) 2017 Yago
|
|
|
|
[usage]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/usage.md
|
|
[examples]:https://github.com/yagop/node-telegram-bot-api/tree/master/examples
|
|
[help]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/help.md
|
|
[api-dev]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/api.md
|
|
[api-release]:https://github.com/yagop/node-telegram-bot-api/tree/release/doc/api.md
|
|
[contributing]:https://github.com/yagop/node-telegram-bot-api/tree/master/CONTRIBUTING.md
|
|
[tg-channel]:https://telegram.me/node_telegram_bot_api
|
|
|