Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hosein2398/node-telegram-bot-api-tutorial
node-telegram-bot-api tutorial
https://github.com/hosein2398/node-telegram-bot-api-tutorial
messenger telegram tutorial
Last synced: about 2 hours ago
JSON representation
node-telegram-bot-api tutorial
- Host: GitHub
- URL: https://github.com/hosein2398/node-telegram-bot-api-tutorial
- Owner: hosein2398
- Created: 2017-03-31T19:16:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T19:44:18.000Z (over 2 years ago)
- Last Synced: 2023-11-07T16:57:51.976Z (about 1 year ago)
- Topics: messenger, telegram, tutorial
- Homepage:
- Size: 766 KB
- Stars: 306
- Watchers: 12
- Forks: 47
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-telegram-bot-api-tutorial
This is a beginners' guide for [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) .
- [Creating new bot with BotFather](#Creating+new+bot+with+BotFather)
- [First message](#First+message)
- [Commands](#Commands)
- [Keyboards](#Keyboards)
- [User](#User)
- [Inline keyboards](#Inline+Keybords)
- [parse_mode](#parse_mode)
- [Location and Number](#Location+and+Number)
- [Interacting with groups and channels](#grpups+and+channel+interaction)
### Creating new bot with BotFather
The following steps describe how to create a new bot:
- Contact @BotFather in your Telegram messenger
- To get a token, send BotFather a message that says /newbot
- When asked for a name for your new bot choose something that ends with the word bot. For example, my_test_bot
- If your chosen name is available, BotFather will send you a token
- Save the token
Once your bot is created, you can set a Description for it. `Description` is a message in middle of the page usually describing what the bot can do.
To set Description for your bot in BotFather do the following:
- Send /setdescription to BotFather
- Select the bot for which you are writing a Description
- Change the description and send it to BotFather
There are some other useful methods in BotFather which we won't cover in this tutorial like /setcommands and other.
### First message
Ok now you're ready to go. Create a node project and install bot-api:
npm install --save node-telegram-bot-api
Create a file index.js (or any other name) and inside the file require node-telegram-bot-api:
```js
const TelegramBot = require('node-telegram-bot-api');
```
Then you need to assign your token which you got from BotFather:
```js
const token = 'YOUR_TELEGRAM_BOT_TOKEN';
```
And now create a new bot :
```js
const bot = new TelegramBot(token, {polling: true});
```
Let's try out our bot and do some real world things. We need to get messages that user sends us , to do so we would use following code:
```js
bot.on('message', (msg) => {
//anything
});
```
Let's create simple greeting here. Here's big picture of our code :
```js
const TelegramBot = require('node-telegram-bot-api');
const token = 'YOUR_TELEGRAM_BOT_TOKEN';
const bot = new TelegramBot(token, {polling: true});
bot.on('message', (msg) => {
//anything
});
```
We were trying to greet and we'll do it here:
```js
bot.on('message', (msg) => {
var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
bot.sendMessage(msg.chat.id,"Hello dear user");
}
});
```
Ok , now open up your command prompt and type:
node index.js
Go to your bot and hit on /start and then type "Hi" to it:
So now that you know how to send and receive messages in your bot you may want to put some salt on it:
```js
bot.on('message', (msg) => {
var hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(hi) === 0) {
bot.sendMessage(msg.chat.id,"Hello dear user");
}
var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
bot.sendMessage(msg.chat.id, "Hope to see you around again , Bye");
}
});
```
This time we're using "includes" method so if user sends us anything containing "bye" word we'll send him back the message:
And definitely you can use any other string method that you want.
### Commands
That's really common to send user a message describing use of bot while he taps on "/start". (these are called [commands](https://core.telegram.org/bots#commands))
To do so :
```js
bot.onText(/\/start/, (msg) => {
bot.sendMessage(msg.chat.id, "Welcome");
});
```
Let's create another command that will send a picture to user:
```js
bot.onText(/\/sendpic/, (msg) => {
bot.sendPhoto(msg.chat.id,"https://www.somesite.com/image.jpg" );
});
```
So now if you write "/sendpic" on your bot an image will be sent.
Sending audios is same and simple you can use "[sendAudio](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#TelegramBot+sendAudio)" method .
Now you might have seen some pictures containing caption with them like the following picture.
Well , How to to create these?
Answer is really simple you can send a caption with option on photo like so :
```js
bot.onText(/\/sendpic/, (msg) => {
bot.sendPhoto(msg.chat.id,"https://www.somesite.com/image.jpg",{caption : "Here we go ! \nThis is just a caption "} );
});
```
So now you know how to create captions and how to go to new line in your messages by typing `\n` .
### Keyboards
Let's go a step further and start working with [keyboards](https://core.telegram.org/bots#keyboards).
keyboards are actually the ones shown in this picture:
Keyboards are nothing but an easy way to send fixed messages. It's like you're not forcing users to write something down and send it to bot, but instead you're demonstrating them some options that they can tap on and send back as an answer.
So let's see how we can create Keyboards , we'll send a Keyboard on "/start" message:
```js
bot.onText(/\/start/, (msg) => {
bot.sendMessage(msg.chat.id, "Welcome", {
"reply_markup": {
"keyboard": [["Sample text", "Second sample"], ["Keyboard"], ["I'm robot"]]
}
});
});
```
So now if you run you will see:
As I said in fact Keyboards are not nothing but automatic type and send for user. There is no difference if you write "I'm robot" and sending on your own or you click on Keyboard. Let's do something simple when that "I'm robot" is received.So add this up to your previous on message:
```js
bot.on('message', (msg) => {
var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
bot.sendMessage(msg.chat.id, "Hello dear user");
}
var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
bot.sendMessage(msg.chat.id, "Hope to see you around again , Bye");
}
var robot = "I'm robot";
if (msg.text.indexOf(robot) === 0) {
bot.sendMessage(msg.chat.id, "Yes I'm robot but not in that way!");
}
});
```
So now if you go to your bot tap on start you see Keyboards and if you tap on I'm robot you'll see the message. Note that there is no difference if you type it or you send it by Keyboards.
### User
node-telegram-bot-api does not have any method to get users information but in case if you want to, you can get information like so:
```js
var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
bot.sendMessage(msg.from.id, "Hello " + msg.from.first_name);
}
```
And if you wanted to get user profile pictures you can use [getUserProfilePhotos](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#telegrambotgetuserprofilephotosuserid-options--promise) .
### Inline Keybords
This section is under construction...
### parse_mode
If you want to send messages with some style there, here is how it goes. parse_mode defines how you want you message to be rendered.You can define it inside in your options when sending message.
Available option are HTML and Markdown.Let's see how it works in action:
```js
bot.on('message', (msg) => {
var Hi = "hi";
if (msg.text.toString().toLowerCase().indexOf(Hi) === 0) {
bot.sendMessage(msg.chat.id,"bold \n italic \n italic with em \n inline URL \n inline fixed-width code \n
pre-formatted fixed-width code block
" ,{parse_mode : "HTML"});
}
});
```
So you get idea where parse_mode is defined.Now if we run this:
So that's how we do it with Html you can also write with Markdown.As mentioned in official api of Telegram only these tags are supported till now:
```
bold, bold
italic, italic
inline URL
inline fixed-width code
pre-formatted fixed-width code block
```
And for Markdown you can only use:
```
*bold text*
_italic text_
[text](http://www.example.com/)
`inline fixed-width code`
```
### Location and Number
There are some methods that enable you to send users location.
Here is an example:
```js
bot.on('message', (msg) => {
var location = "location";
if (msg.text.indexOf(location) === 0) {
bot.sendLocation(msg.chat.id,44.97108, -104.27719);
bot.sendMessage(msg.chat.id, "Here is the point");
}
});
```
And there is also [sendVenue](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#telegrambotsendvenuechatid-latitude-longitude-title-address-options--promise).
To send a phone number you can use [sendContact](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#TelegramBot+sendContact).
### Interacting with groups and channels
One interesting use of bots is in groups and channels.You can use bots to manage groups , receiving users messages and sending group messages. You can even send keyboards to members so that they can use the bot easier.
For better understanding of how bots can be useful in groups let's create one and add it to a group.
So we want to create a bot that says "Have a nice day _Username_" when any member of group said something containing "Bye" keyword.
Before doing anything you have to know that a bot has no accessibility to users messages unless we add it as of a administrator.
And if don't do that bot will only has access to [Commands](https://github.com/hosein2398/node-telegram-bot-api-tutorial#commands) that any user sends to group.And all of this is because of the [privacy policy](https://core.telegram.org/bots#privacy-mode) that Telegram messenger follows which I think is right.
So let's get back to creating that bot , actually we don't have to do anything different than creating bot for a single user usage , everything is similar.
```js
bot.on('message', (msg) => {
var bye = "bye";
if (msg.text.toString().toLowerCase().includes(bye)) {
bot.sendMessage(msg.chat.id, "Have a nice day " + msg.from.first_name);
}
});
```
Now that we wrote codes go ahead and add this bot to a group , after adding it set it as of a administrator of the group so that it could get users messages.
Now say something that includes "bye":
Now let's do another thing , write some codes that bot will remove a person from group if they say a specific word.For instance you can create a bot that will remove member if they curse in group.
Here we will write codes that if someone says anything containing "idiot" bot will remove that person from group.
```js
bot.on('message', (msg) => {
var what = "idiot";
if (msg.text.includes(what)) {
bot.kickChatMember(msg.chat.id, msg.from.id);
}
});
```
Here we have used [kickChatMember](https://github.com/yagop/node-telegram-bot-api/blob/58566d2df5146611a6a3e6140ca616403d24a20e/README.md#telegrambotkickchatmemberchatid-userid--promise) method to remove a member it receives two parameters , first one is id of chat and second one is id of user which you want to remove.Now if you add this bot among admins of a group and somebody says something containing "idiot":
We can't cover all methods there are some other methods related to groups and channels: [getChat](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#TelegramBot+getChat) , [getChatAdministrators](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#TelegramBot+getChatAdministrators) , [getChatMembersCount](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#telegrambotgetchatmemberscountchatid--promise) , [getChatMember](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#telegrambotgetchatmemberchatid-userid--promise) , [leaveChat](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/api.md#telegrambotleavechatchatid--promise)
### Contributing
+ If you found any typo or grammatically wrong sentence you can just make a PR.(In case you were not interested to, you can open an issue.)
+ If you have anything in mind that can improve this tutorial please make a PR.