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 against DEV branch. 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 with one of these options:

Using Maven Central Repository:

    <dependency>
        <groupId>org.telegram</groupId>
        <artifactId>telegrambots</artifactId>
        <version>5.6.0</version>
    </dependency>

Using Gradle:

    implementation 'org.telegram:telegrambots:5.6.0'

Using Jitpack from here
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.meta.TelegramBotsApiand register your bots:


    // Example taken from https://github.com/rubenlagus/TelegramBotsExample
    public class Main {
        public static void main(String[] args) {
            try {
                TelegramBotsApi telegramBotsApi = new TelegramBotsApi(DefaultBotSession.class);
                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();
            }
        }
    }

For detailed explanation, visite our How To (thanks Clevero)

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)

https://telegram.me/SnowcrashBot (Webhook 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

Powered by Intellij

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

5.1 KiB Raw Blame History