teloxide/README.md

370 lines
14 KiB
Markdown
Raw Normal View History

2022-04-18 12:32:46 +02:00
> [v0.7 -> v0.8 migration guide >>](MIGRATION_GUIDE.md#07---08)
2022-02-05 09:26:05 +01:00
> `teloxide-core` versions less that `0.4.5` (`teloxide` versions less than 0.7.3) have a low-severity security vulnerability, [learn more >>](https://github.com/teloxide/teloxide/discussions/574)
2022-04-03 14:19:17 +02:00
2019-09-02 09:28:56 +02:00
<div align="center">
<img src="../../raw/master/ICON.png" width="250"/>
2019-12-07 20:30:15 +01:00
<h1>teloxide</h1>
<a href="https://docs.rs/teloxide/">
2020-08-25 16:45:16 +02:00
<img src="https://docs.rs/teloxide/badge.svg">
2019-10-14 19:07:58 +02:00
</a>
2019-12-08 07:57:53 +01:00
<a href="https://github.com/teloxide/teloxide/actions">
<img src="https://github.com/teloxide/teloxide/workflows/Continuous%20integration/badge.svg">
2019-09-02 09:28:56 +02:00
</a>
2019-12-07 20:30:15 +01:00
<a href="https://crates.io/crates/teloxide">
2020-08-25 16:45:16 +02:00
<img src="https://img.shields.io/crates/v/teloxide.svg">
2019-10-14 19:04:55 +02:00
</a>
<a href="https://core.telegram.org/bots/api">
<img src="https://img.shields.io/badge/API%20coverage-Up%20to%206.0%20(inclusively)-green.svg">
</a>
2020-02-19 02:41:59 +01:00
<a href="https://t.me/teloxide">
2022-04-27 23:08:25 +02:00
<img src="https://img.shields.io/badge/support-t.me%2Fteloxide-blueviolet">
2020-02-19 02:41:59 +01:00
</a>
2020-08-21 12:24:09 +02:00
2022-04-27 23:08:25 +02:00
A full-featured framework that empowers you to easily build [Telegram bots](https://telegram.org/blog/bot-revolution) using [Rust](https://www.rust-lang.org/). It handles all the difficult stuff so you can focus only on your business logic.
2019-09-02 09:28:56 +02:00
</div>
2020-01-26 22:36:36 +01:00
## Highlights
2020-04-17 10:31:10 +02:00
2022-04-27 23:08:25 +02:00
- **Declarative design.** teloxide is based upon [`dptree`], a functional [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style.
2020-07-04 15:45:19 +02:00
2022-02-04 04:47:15 +01:00
[`dptree`]: https://github.com/p0lunin/dptree
[chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern
2020-07-04 15:45:19 +02:00
2022-02-04 04:47:15 +01:00
- **Dialogues management subsystem.** Our dialogues management subsystem is simple and easy-to-use, and, furthermore, is agnostic of how/where dialogues are stored. For example, you can just replace a one line to achieve [persistence]. Out-of-the-box storages include [Redis] and [Sqlite].
2020-02-18 23:54:41 +01:00
[persistence]: https://en.wikipedia.org/wiki/Persistence_(computer_science)
[Redis]: https://redis.io/
2020-10-24 19:05:48 +02:00
[Sqlite]: https://www.sqlite.org
2020-04-17 10:31:10 +02:00
2022-02-04 04:47:15 +01:00
- **Strongly typed commands.** You can describe bot commands as enumerations, and then they'll be automatically constructed from strings — just like JSON structures in [`serde-json`] and command-line arguments in [`structopt`].
2020-04-17 10:31:10 +02:00
2022-02-04 04:47:15 +01:00
[`structopt`]: https://github.com/TeXitoi/structopt
[`serde-json`]: https://github.com/serde-rs/json
2020-07-04 15:45:19 +02:00
2020-05-26 13:03:24 +02:00
## Setting up your environment
2022-02-04 04:47:15 +01:00
2020-05-26 13:03:24 +02:00
1. [Download Rust](http://rustup.rs/).
2. Create a new bot using [@Botfather](https://t.me/botfather) to get a token in the format `123456789:blablabla`.
3. Initialise the `TELOXIDE_TOKEN` environmental variable to your token:
2020-02-12 11:47:51 +01:00
```bash
2020-05-25 22:53:12 +02:00
# Unix-like
$ export TELOXIDE_TOKEN=<Your token here>
2020-02-14 11:28:35 +01:00
2021-08-25 20:48:08 +02:00
# Windows command line
$ set TELOXIDE_TOKEN=<Your token here>
2021-08-25 20:48:08 +02:00
# Windows PowerShell
$ $env:TELOXIDE_TOKEN=<Your token here>
2020-02-12 11:47:51 +01:00
```
2022-04-20 21:33:44 +02:00
4. Make sure that your Rust compiler is up to date (teloxide currently requires rustc at least version 1.58):
2020-02-12 11:09:53 +01:00
```bash
2020-02-24 22:35:15 +01:00
# If you're using stable
2020-02-12 11:09:53 +01:00
$ rustup update stable
2020-02-24 22:35:15 +01:00
$ rustup override set stable
# If you're using nightly
$ rustup update nightly
$ rustup override set nightly
2020-01-26 22:36:36 +01:00
```
2020-02-12 11:09:53 +01:00
2020-10-08 05:46:30 +02:00
5. Run `cargo new my_bot`, enter the directory and put these lines into your `Cargo.toml`:
2020-01-26 22:36:36 +01:00
```toml
2020-02-12 11:09:53 +01:00
[dependencies]
2022-04-27 12:10:33 +02:00
teloxide = { version = "0.9", features = ["macros", "auto-send"] }
2021-09-11 20:30:34 +02:00
log = "0.4"
2022-03-22 06:40:53 +01:00
pretty_env_logger = "0.4"
2021-09-11 20:30:34 +02:00
tokio = { version = "1.8", features = ["rt-multi-thread", "macros"] }
2020-01-26 22:36:36 +01:00
```
2020-05-26 13:03:24 +02:00
## API overview
### The dices bot
2022-02-04 04:40:15 +01:00
2020-10-08 05:46:30 +02:00
This bot replies with a dice throw to each received message:
2020-02-13 18:07:28 +01:00
2022-04-27 23:08:25 +02:00
[[`examples/throw_dice.rs`](examples/throw_dice.rs)]
```rust,no_run
2022-03-24 12:25:42 +01:00
use teloxide::prelude::*;
2020-01-26 22:36:36 +01:00
#[tokio::main]
async fn main() {
pretty_env_logger::init();
log::info!("Starting throw dice bot...");
2020-02-12 11:17:20 +01:00
2021-03-13 18:35:48 +01:00
let bot = Bot::from_env().auto_send();
2020-02-13 18:07:28 +01:00
2022-03-24 12:25:42 +01:00
teloxide::repl(bot, |message: Message, bot: AutoSend<Bot>| async move {
2022-02-04 04:40:15 +01:00
bot.send_dice(message.chat.id).await?;
2021-03-13 18:35:48 +01:00
respond(())
2020-07-30 15:07:58 +02:00
})
.await;
2020-01-26 22:36:36 +01:00
}
```
2020-02-13 21:19:08 +01:00
2020-02-14 13:17:57 +01:00
<div align="center">
2020-02-19 01:45:03 +01:00
<kbd>
2022-04-27 17:40:27 +02:00
<img src=../../raw/master/media/throw-dice.gif width="420px" />
2020-02-19 01:45:03 +01:00
</kbd>
2020-02-14 13:17:57 +01:00
</div>
2020-05-26 13:03:24 +02:00
### Commands
2022-02-04 04:40:15 +01:00
2020-07-25 15:40:58 +02:00
Commands are strongly typed and defined declaratively, similar to how we define CLI using [structopt] and JSON structures in [serde-json]. The following bot accepts these commands:
- `/username <your username>`
- `/usernameandage <your username> <your age>`
- `/help`
2020-07-08 01:35:45 +02:00
[structopt]: https://docs.rs/structopt/0.3.9/structopt/
[serde-json]: https://github.com/serde-rs/json
2020-02-13 22:49:49 +01:00
2022-04-27 23:08:25 +02:00
[[`examples/command.rs`](examples/command.rs)]
2022-02-04 04:40:15 +01:00
```rust,no_run
2022-04-02 11:51:59 +02:00
use teloxide::{prelude::*, utils::command::BotCommands};
use std::error::Error;
2020-02-13 22:49:49 +01:00
2022-03-24 12:25:42 +01:00
#[tokio::main]
async fn main() {
pretty_env_logger::init();
log::info!("Starting command bot...");
2022-03-24 12:25:42 +01:00
let bot = Bot::from_env().auto_send();
teloxide::commands_repl(bot, answer, Command::ty()).await;
}
2022-04-02 11:51:59 +02:00
#[derive(BotCommands, Clone)]
2020-02-13 22:49:49 +01:00
#[command(rename = "lowercase", description = "These commands are supported:")]
enum Command {
#[command(description = "display this text.")]
Help,
2020-07-08 01:35:45 +02:00
#[command(description = "handle a username.")]
Username(String),
#[command(description = "handle a username and an age.", parse_with = "split")]
2020-07-08 01:35:45 +02:00
UsernameAndAge { username: String, age: u8 },
2020-02-18 23:54:41 +01:00
}
2020-02-13 22:49:49 +01:00
async fn answer(
2022-02-04 04:40:15 +01:00
bot: AutoSend<Bot>,
message: Message,
command: Command,
) -> Result<(), Box<dyn Error + Send + Sync>> {
2020-02-13 22:49:49 +01:00
match command {
2022-04-02 11:51:59 +02:00
Command::Help => {
bot.send_message(message.chat.id, Command::descriptions().to_string()).await?
}
2020-07-08 01:35:45 +02:00
Command::Username(username) => {
bot.send_message(message.chat.id, format!("Your username is @{username}.")).await?
2020-07-08 01:35:45 +02:00
}
Command::UsernameAndAge { username, age } => {
2022-02-04 04:40:15 +01:00
bot.send_message(
message.chat.id,
format!("Your username is @{username} and age is {age}."),
2022-02-04 04:40:15 +01:00
)
.await?
2020-07-08 01:35:45 +02:00
}
2020-02-13 22:49:49 +01:00
};
Ok(())
}
```
2020-07-25 15:29:10 +02:00
<div align="center">
<kbd>
2022-04-27 17:40:27 +02:00
<img src=../../raw/master/media/command.gif width="420px" />
2020-07-25 15:29:10 +02:00
</kbd>
</div>
2020-07-26 13:11:55 +02:00
### Dialogues management
2020-02-13 21:19:08 +01:00
2022-02-23 19:13:24 +01:00
A dialogue is typically described by an enumeration where each variant is one possible state of the dialogue. There are also _state handler functions_, which may turn a dialogue from one state to another, thereby forming an [FSM].
2020-07-26 19:37:56 +02:00
2022-02-04 04:40:15 +01:00
[FSM]: https://en.wikipedia.org/wiki/Finite-state_machine
2022-02-04 04:40:15 +01:00
Below is a bot that asks you three questions and then sends the answers back to you:
2020-07-28 18:02:48 +02:00
2022-04-27 23:08:25 +02:00
[[`examples/dialogue.rs`](examples/dialogue.rs)]
2020-07-28 18:02:48 +02:00
```rust,ignore
use teloxide::{dispatching::dialogue::InMemStorage, prelude::*};
2022-02-04 04:40:15 +01:00
type MyDialogue = Dialogue<State, InMemStorage<State>>;
type HandlerResult = Result<(), Box<dyn std::error::Error + Send + Sync>>;
2020-07-28 18:02:48 +02:00
#[derive(Clone)]
2022-02-04 04:40:15 +01:00
pub enum State {
Start,
ReceiveFullName,
ReceiveAge { full_name: String },
ReceiveLocation { full_name: String, age: u8 },
2020-02-13 21:19:08 +01:00
}
2020-02-14 10:57:14 +01:00
2022-02-04 04:40:15 +01:00
impl Default for State {
fn default() -> Self {
Self::Start
}
2020-05-26 13:03:24 +02:00
}
2022-02-04 04:40:15 +01:00
#[tokio::main]
async fn main() {
pretty_env_logger::init();
2022-04-26 21:00:08 +02:00
log::info!("Starting dialogue bot...");
2020-02-13 21:19:08 +01:00
2022-02-04 04:40:15 +01:00
let bot = Bot::from_env().auto_send();
Dispatcher::builder(
2022-02-04 04:40:15 +01:00
bot,
Update::filter_message()
.enter_dialogue::<Message, InMemStorage<State>, State>()
.branch(dptree::case![State::Start].endpoint(start))
.branch(dptree::case![State::ReceiveFullName].endpoint(receive_full_name))
.branch(dptree::case![State::ReceiveAge { full_name }].endpoint(receive_age))
.branch(
dptree::case![State::ReceiveLocation { full_name, age }].endpoint(receive_location),
),
2022-02-04 04:40:15 +01:00
)
.dependencies(dptree::deps![InMemStorage::<State>::new()])
.build()
.setup_ctrlc_handler()
.dispatch()
.await;
2020-03-09 09:01:45 +01:00
}
async fn start(bot: AutoSend<Bot>, msg: Message, dialogue: MyDialogue) -> HandlerResult {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "Let's start! What's your full name?").await?;
2022-02-04 04:40:15 +01:00
dialogue.update(State::ReceiveFullName).await?;
Ok(())
}
2020-07-25 15:40:58 +02:00
async fn receive_full_name(
2022-02-04 04:40:15 +01:00
bot: AutoSend<Bot>,
msg: Message,
dialogue: MyDialogue,
) -> HandlerResult {
2022-02-04 04:40:15 +01:00
match msg.text() {
Some(text) => {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "How old are you?").await?;
2022-02-04 04:40:15 +01:00
dialogue.update(State::ReceiveAge { full_name: text.into() }).await?;
}
None => {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "Send me plain text.").await?;
2022-02-04 04:40:15 +01:00
}
}
2020-02-18 23:59:44 +01:00
2022-02-04 04:40:15 +01:00
Ok(())
}
2020-05-26 13:03:24 +02:00
async fn receive_age(
2022-02-04 04:40:15 +01:00
bot: AutoSend<Bot>,
msg: Message,
dialogue: MyDialogue,
full_name: String, // Available from `State::ReceiveAge`.
) -> HandlerResult {
2022-02-04 04:58:56 +01:00
match msg.text().map(|text| text.parse::<u8>()) {
Some(Ok(age)) => {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "What's your location?").await?;
2022-02-04 04:58:56 +01:00
dialogue.update(State::ReceiveLocation { full_name, age }).await?;
}
_ => {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "Send me a number.").await?;
2022-02-04 04:40:15 +01:00
}
}
2020-05-26 13:03:24 +02:00
2022-02-04 04:40:15 +01:00
Ok(())
2020-05-26 13:03:24 +02:00
}
async fn receive_location(
2022-02-04 04:40:15 +01:00
bot: AutoSend<Bot>,
msg: Message,
dialogue: MyDialogue,
(full_name, age): (String, u8), // Available from `State::ReceiveLocation`.
) -> HandlerResult {
2022-02-04 04:40:15 +01:00
match msg.text() {
Some(location) => {
let message = format!("Full name: {full_name}\nAge: {age}\nLocation: {location}");
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, message).await?;
2022-02-04 04:40:15 +01:00
dialogue.exit().await?;
}
None => {
2022-02-04 14:45:35 +01:00
bot.send_message(msg.chat.id, "Send me plain text.").await?;
}
}
2022-02-04 04:40:15 +01:00
Ok(())
}
2020-05-26 13:03:24 +02:00
```
2020-02-19 00:10:10 +01:00
2020-07-25 15:29:10 +02:00
<div align="center">
<kbd>
2022-04-27 17:40:27 +02:00
<img src=../../raw/master/media/dialogue.gif width="420px" />
2020-07-25 15:29:10 +02:00
</kbd>
</div>
[More examples >>](examples/)
2020-02-14 00:01:40 +01:00
2020-02-19 02:41:59 +01:00
## FAQ
2020-07-28 20:43:09 +02:00
2022-02-04 04:47:15 +01:00
**Q: Where I can ask questions?**
2020-07-28 20:43:09 +02:00
2022-02-04 14:40:39 +01:00
A:
- [Issues] is a good place for well-formed questions about the library design, enhancements, and bug reports.
- [GitHub Discussions] is a place where you can ask us for help in a less formal manner.
- If you need quick help in real-time, you should ask a question in [our official Telegram group].
[Issues]: https://github.com/teloxide/teloxide/issues
[our official Telegram group]: https://t.me/teloxide
[GitHub Discussions]: https://github.com/teloxide/teloxide/discussions
2020-02-19 02:41:59 +01:00
2020-11-01 12:45:59 +01:00
**Q: Do you support the Telegram API for clients?**
A: No, only the bots API.
2020-11-01 12:45:59 +01:00
**Q: Can I use webhooks?**
2020-06-26 14:35:43 +02:00
2022-02-23 19:13:24 +01:00
A: teloxide doesn't provide a special API for working with webhooks due to their nature with lots of subtle settings. Instead, you should setup your webhook by yourself, as shown in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs).
2020-03-30 21:07:33 +02:00
2020-05-08 17:32:39 +02:00
Associated links:
- [Marvin's Marvellous Guide to All Things Webhook](https://core.telegram.org/bots/webhooks)
- [Using self-signed certificates](https://core.telegram.org/bots/self-signed)
2022-04-22 19:50:19 +02:00
**Q: Can I handle both callback queries and messages within a single dialogue?**
A: Yes, see [`examples/purchase.rs`](examples/purchase.rs).
2020-02-19 02:41:59 +01:00
## Community bots
2022-02-04 04:47:15 +01:00
2021-05-25 05:00:52 +02:00
Feel free to propose your own bot to our collection!
2022-04-27 23:08:25 +02:00
- [WaffleLapkin/crate_upd_bot](https://github.com/WaffleLapkin/crate_upd_bot) — A bot that notifies about crate updates.
- [mxseev/logram](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram.
- [alexkonovalov/PedigreeBot](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees.
- [Hermitter/tepe](https://github.com/Hermitter/tepe) — A CLI to command a bot to send messages and files over Telegram.
- [mattrighetti/GroupActivityBot](https://github.com/mattrighetti/group-activity-bot-rs) — Telegram bot that keeps track of user activity in groups.
- [mattrighetti/libgen-bot-rs](https://github.com/mattrighetti/libgen-bot-rs) — Telgram bot to interface with libgen
- [dracarys18/grpmr-rs](https://github.com/dracarys18/grpmr-rs) — A Telegram group manager bot with variety of extra features.
- [steadylearner/subreddit_reader](https://github.com/steadylearner/Rust-Full-Stack/tree/master/commits/teloxide/subreddit_reader) — A bot that shows the latest posts at Rust subreddit.
- [myblackbeard/basketball-betting-bot](https://github.com/myblackbeard/basketball-betting-bot) — The bot lets you bet on NBA games against your buddies.
- [ArtHome12/vzmuinebot](https://github.com/ArtHome12/vzmuinebot) — Telegram bot for food menu navigate.
- [ArtHome12/cognito_bot](https://github.com/ArtHome12/cognito_bot) — The bot is designed to anonymize messages to a group.
- [pro-vim/tg-vimhelpbot](https://github.com/pro-vim/tg-vimhelpbot) — Link `:help` for Vim in Telegram.
- [sschiz/janitor-bot](https://github.com/sschiz/janitor-bot) — A bot that removes users trying to join to a chat that is designed for comments.
- [slondr/BeerHolderBot](https://gitlab.com/slondr/BeerHolderBot) — A bot that holds your beer.
- [MustafaSalih1993/Miss-Vodka-Telegram-Bot](https://github.com/MustafaSalih1993/Miss-Vodka-Telegram-Bot) — A Telegram bot written in rust using "Teloxide" library.
- [x13a/tg-prompt](https://github.com/x13a/tg-prompt) — Telegram prompt.
- [magnickolas/remindee-bot](https://github.com/magnickolas/remindee-bot) — Telegram bot for managing reminders.
- [cyberknight777/knight-bot](https://gitlab.com/cyberknight777/knight-bot) — A Telegram bot with variety of fun features.
- [wa7sa34cx/the-black-box-bot](https://github.com/wa7sa34cx/the-black-box-bot) — This is the Black Box Telegram bot. You can hold any items in it.
- [crapstone/hsctt](https://codeberg.org/crapstones-bots/hsctt) — A Telegram bot that searches for HTTP status codes in all messages and replies with the text form.
- [alenpaul2001/AurSearchBot](https://gitlab.com/alenpaul2001/aursearchbot) — Telegram bot for searching AUR in inline mode.
- [studiedlist/EddieBot](https://gitlab.com/studiedlist/eddie-bot) — Chatting bot with several entertainment features.
2021-10-12 09:01:12 +02:00
2020-02-14 09:45:12 +01:00
## Contributing
2022-02-04 04:47:15 +01:00
See [`CONRIBUTING.md`](CONTRIBUTING.md).