https://github.com/init-io/jalegram
Jalegram is a Java library designed to simplify the development of Telegram bots, offering a more user-friendly approach compared to other existing libraries.
https://github.com/init-io/jalegram
bot bots init jalegram java javalibrary library telegram telegram-api telegram-bot telegram-bot-api telegram-bots telegrambot telegramserver
Last synced: about 1 year ago
JSON representation
Jalegram is a Java library designed to simplify the development of Telegram bots, offering a more user-friendly approach compared to other existing libraries.
- Host: GitHub
- URL: https://github.com/init-io/jalegram
- Owner: Init-io
- License: mit
- Created: 2025-04-05T09:46:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-06T07:08:07.000Z (about 1 year ago)
- Last Synced: 2025-04-09T23:55:48.592Z (about 1 year ago)
- Topics: bot, bots, init, jalegram, java, javalibrary, library, telegram, telegram-api, telegram-bot, telegram-bot-api, telegram-bots, telegrambot, telegramserver
- Language: Java
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jalegram - A Java Telegram Bot Library
[](LICENSE)
Jalegram is a lightweight, user-friendly Java library designed to simplify the development of Telegram bots. It provides a straightforward interface to interact with the Telegram Bot API, offering a wide range of methods to handle messages, media, chat management, and more—all with minimal boilerplate code compared to other libraries.
## Features
- Easy-to-use methods for sending messages, photos, videos, and other media.
- Comprehensive chat and user information retrieval.
- Support for keyboards, inline keyboards, and polls.
- Chat management tools like banning, promoting, and restricting users.
- Built-in JSON parsing for seamless interaction with Telegram's API responses.
- Extensible and well-documented codebase.
## Prerequisites
- Java 8 or higher
- Maven or Gradle (for dependency management)
- A Telegram Bot Token (obtained from [BotFather](https://t.me/BotFather))
## Installation
### Maven
Add the following dependency to your `pom.xml`:
```xml
io.github.initio
jalegram
1.0.0
```
### Gradle
Add this line to your `build.gradle`:
```gradle
implementation 'io.github.initio:jalegram:1.0.0' // Replace with the actual version
```
*Note:* If Jalegram is not yet published to a Maven repository, you'll need to build it locally from the source and install it to your local Maven repository using:
```bash
mvn clean install
```
## Getting Started
1. **Create a Telegram Bot**: Talk to [BotFather](https://t.me/BotFather) on Telegram to create a bot and get your bot token.
2. **Initialize Jalegram**: Use your bot token to instantiate the `Jalegram` class.
```java
package io.github.initio.testproject;
import io.github.initio.jalegram.Jalegram;
import java.io.IOException;
public class Testproject {
static String CHAT_ID = "";
// Mutable variable now
public static void main(String[] args) throws IOException {
String token = "YOUR_BOT_TOKEN_HERE"; // Replace with your bot token
Jalegram bot = new Jalegram(token);
System.out.println("Bot is running...");
Thread thread = new Thread(() -> {
int offset = 0;
while (true) {
try {
String updatesResponse = bot.getUpdates(offset);
// Get the latest update ID
long updateId = bot.getUpdateId(updatesResponse);
if (updateId != -1) {
offset = (int) (updateId + 1); // Update offset properly
String response = bot.getText(updatesResponse);
System.out.println(bot.getUsername(updatesResponse) + ": " + response + " UpdateId: " + updateId);
//here inside this loop ,under this comment you can put any logic or condition to make your bot running forever .
if ("get device info".equalsIgnoreCase(response)) {
String reply = getDeviceInfo();
if (!reply.isEmpty()) {
bot.sendMessage(CHAT_ID, reply);
System.out.println("Bot: " + reply);
}
}
}
Thread.sleep(1000);
} catch (IOException | InterruptedException e) {
e.printStackTrace(); // good to keep this in now
}
}
});
thread.start();
}
private static String getDeviceInfo() {
return "Device Info: OS = " + System.getProperty("os.name") +
", Version = " + System.getProperty("os.version") +
", Architecture = " + System.getProperty("os.arch");
}
}
```
Replace `"YOUR_BOT_TOKEN_HERE"` with your actual bot token and `"CHAT_ID"` with the target chat ID.
## Available Methods
### Core Messaging
- `sendMessage(chatId, text)`: Send a text message.
- `sendReplyMessage(chatId, text, replyToMessageId)`: Reply to a specific message.
- `editMessage(chatId, messageId, newText)`: Edit an existing message.
- `deleteMessage(chatId, messageId)`: Delete a message.
- `forwardMessage(chatId, fromChatId, messageId)`: Forward a message.
### Media Sending
- `sendPhoto(chatId, photo, caption)`: Send a photo.
- `sendVideo(chatId, video, caption)`: Send a video.
- `sendAudio(chatId, audio, caption)`: Send an audio file.
- `sendFile(chatId, file, caption)`: Send any document/file.
- `sendSticker(chatId, sticker)`: Send a sticker.
- `sendVoice(chatId, voice, caption)`: Send a voice message.
- `sendAnimation(chatId, animation, caption)`: Send an animation (GIF).
### Updates and Information Retrieval
- `getUpdates(offset)`: Fetch bot updates.
- `getText(jsonResponse)`: Extract message text from updates.
- `getChatId(jsonResponse)`: Get the chat ID from updates.
- `getUserId(jsonResponse)`: Get the user ID from updates.
- `getUsername(jsonResponse)`: Get the user's username.
- `getUserFirstName(jsonResponse)`: Get the user's first name.
- `getUserLastName(jsonResponse)`: Get the user's last name.
- `getChatType(jsonResponse)`: Get the chat type (e.g., private, group).
- `getMessageId(jsonResponse)`: Get the message ID.
- `getUpdateId(jsonResponse)`: Get the update ID.
- `getDate(jsonResponse)`: Get the message timestamp.
### Keyboards
- `sendKeyboard(chatId, text, buttons)`: Send a custom keyboard.
- `sendInlineKeyboard(chatId, text, buttons, callbackData)`: Send an inline keyboard with callback data.
### Chat Management
- `banChatMember(chatId, userId)`: Ban a user from a chat.
- `unbanChatMember(chatId, userId)`: Unban a user.
- `restrictChatMember(chatId, userId, canSendMessages)`: Restrict a user's permissions.
- `promoteChatMember(chatId, userId)`: Promote a user to admin.
- `setChatTitle(chatId, title)`: Set the chat title.
- `setChatPhoto(chatId, photo)`: Set the chat photo.
- `leaveChat(chatId)`: Make the bot leave a chat.
- `pinChatMessage(chatId, messageId)`: Pin a message.
- `unpinChatMessage(chatId, messageId)`: Unpin a message (or all if `messageId` is null).
### Miscellaneous
- `sendLocation(chatId, latitude, longitude)`: Send a location.
- `sendPoll(chatId, question, options)`: Send a poll.
- `sendDice(chatId)`: Send a dice animation.
- `getChatMember(chatId, userId)`: Get chat member info.
- `getChatAdministrators(chatId)`: Get list of chat admins.
- `getChatMembersCount(chatId)`: Get the number of chat members.
- `getFile(fileId)`: Get file details by file ID.
- `setMyCommands(commands)`: Set custom bot commands.
## Example: Simple Echo Bot
```java
import io.github.initio.jalegram.Jalegram;
import java.io.IOException;
public class EchoBot {
public static void main(String[] args) throws IOException {
Jalegram bot = new Jalegram("YOUR_BOT_TOKEN_HERE");
int offset = 0;
while (true) {
String updates = bot.getUpdates(offset);
long updateId = bot.getUpdateId(updates);
if (updateId != -1) {
offset = (int) updateId + 1;
String text = bot.getText(updates);
long chatId = bot.getChatId(updates);
if (!text.isEmpty()) {
bot.sendMessage(String.valueOf(chatId), "You said: " + text);
}
}
try {
Thread.sleep(1000); // Polling delay
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
```
## Contributing
Contributions are welcome! Feel free to submit a pull request or open an issue on the [GitHub repository](https://github.com/init-io/jalegram) (replace with your actual repo link).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Built with [OkHttp](https://square.github.io/okhttp/) for HTTP requests.
- Inspired by the Telegram Bot API community.