Telegram Bot Java Library

A simple to use library to create Telegram Bots in Java

Contributions

Feel free to fork this project, work on it and then make a pull request. Most of the times I will accept them if they add something valuable to the code.

Please, DO NOT PUSH ANY TOKEN OR API KEY, I will never accept a pull request with that content.

Webhooks vs GetUpdates

Both ways are supported, but I recommend long polling method.

Usage

Just import add the library to your project using Maven, Gradly, ... or download the jar(including all dependencies) from here

In order to use Long Polling mode, just create your own bot extending org.telegram.telegrambots.bots.TelegramLongPollingBot.

If you like to use Webhook, extend org.telegram.telegrambots.bots.TelegramWebhookBot

Once done, you just need to create a org.telegram.telegrambots.TelegramBotsApiand register your bots:


    // Example taken from https://github.com/rubenlagus/TelegramBotsExample
    public class Main {
        public static void main(String[] args) {
    
            TelegramBotsApi telegramBotsApi = new TelegramBotsApi();
            try {
                telegramBotsApi.registerBot(new ChannelHandlers());
                telegramBotsApi.registerBot(new DirectionsHandlers());
                telegramBotsApi.registerBot(new RaeHandlers());
                telegramBotsApi.registerBot(new WeatherHandlers());
                telegramBotsApi.registerBot(new TransifexHandlers());
                telegramBotsApi.registerBot(new FilesHandlers());
            } catch (TelegramApiException e) {
                e.printStackTrace();
            }
        }
    }

Command Bot

In order to make commands work for your bot by using the org.telegram.telegrambots.bots.TelegramLongPollingCommandBot you can just make your Bot extend this class instead of the org.telegram.telegrambots.bots.TelegramLongPollingBot.

Since this bot inherits from org.telegram.telegrambots.bots.commands.ICommandRegistry it is capable of register- and deregistering commands to your bot.

Here is an example:


    public class Main {

        private static final String LOGTAG = "MAIN";

        public static void main(String[] args) {
           TelegramBotsApi telegramBotsApi = new TelegramBotsApi();
           try {
               telegramBotsApi.registerBot(new MySuperSpecialBotHandler());
           } catch (TelegramApiException e) {
               BotLogger.error(LOGTAG, e);
           }
        }
    }


    public class MySuperSpecialBotHandler extends TelegramLongPollingCommandBot {

        private static final String LOGTAG = "MY_SUPER_SPECIAL_BOT_HANDLER";

        public MySuperSpecialBotHandler() {
            register(new BotCommand("mycommand", "This command just demonstrates the use of commands") {
                @Override
                public void execute(AbsSender absSender, Chat chat, String[] arguments) {
                    SendMessage sendMessage = new SendMessage();
                    sendMessage.setText("Wow you finally used that command " + chat.getUserName());
                    sendMessage.setChatId(chat.getId().toString());
                    try {
                        absSender.sendMessage(sendMessage);
                    } catch (TelegramApiException e) {
                        BotLogger.error(LOGTAG, e);
                    }
                }
            });
        }

        @Override
        public void processNonCommandUpdate(Update update) {
            //All non command updates are passed to this method
        }

        .
        .
        .
    }

Example bots

Open them and send them /help command to get some information about their capabilities:

https://telegram.me/weatherbot (Use custom keyboards)

https://telegram.me/directionsbot (Basic messages)

https://telegram.me/filesbot (Send files by file_id)

https://telegram.me/TGlanguagesbot (Send files uploding them)

https://telegram.me/RaeBot (Inline support)

You can see code for those bots at TelegramBotsExample project.

Telegram Bot API

This library use Telegram bot API, you can find more information following the link.

Questions or Suggestions

Feel free to create issues here as you need or join the chat

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

5.3 KiB Raw Blame History