Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Telegram Bot API with Spring Boot and Spring WebFlux
License
Orgyflame/SpringTelegramBotAPI
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
Telegram Bot API Spring Boot starter
A simple to use library to create Telegram Bots using Spring
Just import add the library to your project with one of these options:
dependency> groupId>io.github.orgyflamegroupId> artifactId>telegram-bot-api-spring-boot-starterartifactId> version>5.2.0version> dependency>
implementation 'io.github.orgyflame:telegram-bot-api-spring-boot-starter:5.2.0' Add these properties to your application.properties file:
telegram.bot.host-url=https://example.com telegram.bot.token=1234567890:Aa0Bb1Cc2Dd3Ee4 telegram.bot.callback-mapping=/callback/1234567890:Aa0Bb1Cc2Dd3Ee4 package com.orgyflame.demotelegrambot.controller; import com.orgyflame.springtelegrambotapi.api.method.BotApiMethod; import com.orgyflame.springtelegrambotapi.api.method.send.SendMessage; import com.orgyflame.springtelegrambotapi.api.object.Chat; import com.orgyflame.springtelegrambotapi.api.object.User; import com.orgyflame.springtelegrambotapi.api.service.TelegramApiService; import com.orgyflame.springtelegrambotapi.bot.mapping.BotController; import com.orgyflame.springtelegrambotapi.bot.mapping.BotMapping; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.ChatParam; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.FromParam; import com.orgyflame.springtelegrambotapi.exceptions.TelegramApiValidationException; @BotController public class DemoController < private final TelegramApiService telegramApiService; public DemoController(TelegramApiService telegramApiService) < this.telegramApiService = telegramApiService; > private void send(BotApiMethod botApiMethod) < try < telegramApiService.sendApiMethod(botApiMethod).subscribe(); > catch (TelegramApiValidationException e) < e.printStackTrace(); > > @BotMapping(value = "/hello", description = "Greets the user") public void hello(@FromParam User user, @ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("Hello," + user.getFirstName()); send(sendMessage); > >
All bot commands are handled by controllers. These components are identified by @BotController annotation.
The @BotMapping annotation ensures that all messages that start with /hello command are mapped to hello() method.
The @FromParam annotation gets the user who send the message. The @ChatParam annotation gets the chat where the user sent the message.
The SendMessage object is a Telegram Bot API request.
The TelegramApiService is a spring component that provides the ability to send Telegram Bot API requests.
Add inline keyboard command
package com.orgyflame.demotelegrambot.controller; import com.orgyflame.springtelegrambotapi.api.method.AnswerCallbackQuery; import com.orgyflame.springtelegrambotapi.api.method.BotApiMethod; import com.orgyflame.springtelegrambotapi.api.method.send.SendMessage; import com.orgyflame.springtelegrambotapi.api.object.Chat; import com.orgyflame.springtelegrambotapi.api.object.Update; import com.orgyflame.springtelegrambotapi.api.object.User; import com.orgyflame.springtelegrambotapi.api.service.TelegramApiService; import com.orgyflame.springtelegrambotapi.bot.container.BotCallbackQueryContainer; import com.orgyflame.springtelegrambotapi.bot.inline.menu.InlineMenu; import com.orgyflame.springtelegrambotapi.bot.inline.menu.InlineMenuButton; import com.orgyflame.springtelegrambotapi.bot.mapping.BotController; import com.orgyflame.springtelegrambotapi.bot.mapping.BotMapping; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.ChatParam; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.FromParam; import com.orgyflame.springtelegrambotapi.exceptions.TelegramApiValidationException; @BotController public class DemoController < private final TelegramApiService telegramApiService; private final BotCallbackQueryContainer botCallbackQueryContainer; public DemoController(TelegramApiService telegramApiService, BotCallbackQueryContainer botCallbackQueryContainer) < this.telegramApiService = telegramApiService; this.botCallbackQueryContainer = botCallbackQueryContainer; > private void send(BotApiMethod botApiMethod) < try < telegramApiService.sendApiMethod(botApiMethod).subscribe(); > catch (TelegramApiValidationException e) < e.printStackTrace(); > > @BotMapping(value = "/hello", description = "Greets the user") public void hello(@FromParam User user, @ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("Hello," + user.getFirstName()); send(sendMessage); > @BotMapping(value = "/inline", description = "Show inline keyboard") public void inlineKeyboard(@ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("keyboard:"); InlineMenu inlineMenu = InlineMenu.builder() .button( InlineMenuButton.builder() .text("button 1") .onQueryCallback(this::button1Callback) .build() ) .row() .button( InlineMenuButton.builder() .text("button 2") .onQueryCallback(this::button2Callback) .build() ) .build(botCallbackQueryContainer); sendMessage.setReplyMarkup(inlineMenu); send(sendMessage); > public AnswerCallbackQuery button1Callback(Update update) < AnswerCallbackQuery answerCallbackQuery = new AnswerCallbackQuery(); answerCallbackQuery.setCallbackQueryId(update.getCallbackQuery().getId()); answerCallbackQuery.setText("Clicked on button 1"); return answerCallbackQuery; > private AnswerCallbackQuery button2Callback(Update update) < AnswerCallbackQuery answerCallbackQuery = new AnswerCallbackQuery(); answerCallbackQuery.setCallbackQueryId(update.getCallbackQuery().getId()); answerCallbackQuery.setText("Clicked on button 2"); return answerCallbackQuery; > >
The InlineMenuButtonBuilder.text() method adds a text for the inline button. The InlineMenuButtonBuilder.onQueryCallback() method adds a callback method for the button.
The InlineMenuBuilder.button() method adds new inline button for the current row. The InlineMenuBuilder.row() method adds new row for the inline keyboard.
The BotCallbackQueryContainer is a spring component that provides the ability to build inline keyboard with callbacks.
package com.orgyflame.demotelegrambot.controller; import com.orgyflame.springtelegrambotapi.api.method.AnswerCallbackQuery; import com.orgyflame.springtelegrambotapi.api.method.BotApiMethod; import com.orgyflame.springtelegrambotapi.api.method.send.SendMessage; import com.orgyflame.springtelegrambotapi.api.object.Chat; import com.orgyflame.springtelegrambotapi.api.object.Update; import com.orgyflame.springtelegrambotapi.api.object.User; import com.orgyflame.springtelegrambotapi.api.service.TelegramApiService; import com.orgyflame.springtelegrambotapi.bot.container.BotCallbackQueryContainer; import com.orgyflame.springtelegrambotapi.bot.inline.menu.InlineMenu; import com.orgyflame.springtelegrambotapi.bot.inline.menu.InlineMenuButton; import com.orgyflame.springtelegrambotapi.bot.mapping.BotController; import com.orgyflame.springtelegrambotapi.bot.mapping.BotMapping; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.ChatParam; import com.orgyflame.springtelegrambotapi.bot.mapping.parameter.FromParam; import com.orgyflame.springtelegrambotapi.exceptions.TelegramApiValidationException; @BotController public class DemoController < private final TelegramApiService telegramApiService; private final BotCallbackQueryContainer botCallbackQueryContainer; public DemoController(TelegramApiService telegramApiService, BotCallbackQueryContainer botCallbackQueryContainer) < this.telegramApiService = telegramApiService; this.botCallbackQueryContainer = botCallbackQueryContainer; > private void send(BotApiMethod botApiMethod) < try < telegramApiService.sendApiMethod(botApiMethod).subscribe(); > catch (TelegramApiValidationException e) < e.printStackTrace(); > > @BotMapping(value = "/hello", description = "Greets the user") public void hello(@FromParam User user, @ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("Hello," + user.getFirstName()); send(sendMessage); > @BotMapping(value = "/inline", description = "Show inline keyboard") public void inlineKeyboard(@ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("keyboard:"); InlineMenu inlineMenu = InlineMenu.builder() .button( InlineMenuButton.builder() .text("button 1") .onQueryCallback(this::button1Callback) .build() ) .row() .button( InlineMenuButton.builder() .text("button 2") .onQueryCallback(this::button2Callback) .build() ) .build(botCallbackQueryContainer); sendMessage.setReplyMarkup(inlineMenu); send(sendMessage); > public AnswerCallbackQuery button1Callback(Update update) < AnswerCallbackQuery answerCallbackQuery = new AnswerCallbackQuery(); answerCallbackQuery.setCallbackQueryId(update.getCallbackQuery().getId()); answerCallbackQuery.setText("Clicked on button 1"); return answerCallbackQuery; > private AnswerCallbackQuery button2Callback(Update update) < AnswerCallbackQuery answerCallbackQuery = new AnswerCallbackQuery(); answerCallbackQuery.setCallbackQueryId(update.getCallbackQuery().getId()); answerCallbackQuery.setText("Clicked on button 2"); return answerCallbackQuery; > @BotMapping public void defaultMapping(@ChatParam Chat chat) < SendMessage sendMessage = new SendMessage(); sendMessage.setChatId(String.valueOf(chat.getId())); sendMessage.setText("default"); send(sendMessage); > >
The @BotMapping annotation with empty value ensures that all messages with unsupported commands are mapped to defaultMapping() method.
Send Telegram Bot API requests
To send requests you must inject TelegramApiService to your spring component, like this:
import com.orgyflame.springtelegrambotapi.api.object.ApiResponse; import com.orgyflame.springtelegrambotapi.api.service.TelegramApiService; import org.springframework.stereotype.Component; import reactor.core.publisher.Mono; @Component public class MySpringComponent < private final TelegramApiService telegramApiService; public MySpringComponent(TelegramApiService telegramApiService) < this.telegramApiService = telegramApiService; > >
import com.orgyflame.springtelegrambotapi.api.service.TelegramApiService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; @Component public class MySpringComponent < @Autowired private TelegramApiService telegramApiService; >
Requests are sent like this:
Mono response = telegramApiService.sendApiMethod(someBotApiMethod);