teloxide-core
versions less that0.4.5
(teloxide
versions less than 0.7.3) have a low-severity security vulnerability, learn more >>
A full-featured framework that empowers you to easily build Telegram bots using the async
/.await
syntax in Rust. It handles all the difficult stuff so you can focus only on your business logic.
Highlights
- Declarative design. teloxide is based upon
dptree
, a functional-style chain of responsibility pattern that allows you to express pipelines of message processing in a highly declarative and extensible style.
- 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.
- 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 instructopt
.
Setting up your environment
- Download Rust.
- Create a new bot using @Botfather to get a token in the format
123456789:blablabla
. - Initialise the
TELOXIDE_TOKEN
environmental variable to your token:
# Unix-like
# Windows command line
# Windows PowerShell
- Make sure that your Rust compiler is up to date:
# If you're using stable
# If you're using nightly
- Run
cargo new my_bot
, enter the directory and put these lines into yourCargo.toml
:
[]
= { = "0.8", = ["macros", "auto-send"] }
= "0.4"
= "0.4"
= { = "1.8", = ["rt-multi-thread", "macros"] }
API overview
The dices bot
This bot replies with a dice throw to each received message:
(Full)
use *;
async
Commands
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
(Full)
use ;
use Error;
async
async
Dialogues management
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.
Below is a bot that asks you three questions and then sends the answers back to you:
(Full)
use ;
type MyDialogue = ;
type HandlerResult = ;
async
async
async
async
async
FAQ
Q: Where I can ask questions?
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.
Q: Do you support the Telegram API for clients?
A: No, only the bots API.
Q: Can I use webhooks?
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
and examples/heroku_ping_pong_bot
.
Associated links:
Community bots
Feel free to propose your own bot to our collection!
- WaffleLapkin/crate_upd_bot -- A bot that notifies about crate updates.
- mxseev/logram -- Utility that takes logs from anywhere and sends them to Telegram.
- alexkonovalov/PedigreeBot -- A Telegram bot for building family trees.
- Hermitter/tepe -- A CLI to command a bot to send messages and files over Telegram.
- mattrighetti/GroupActivityBot -- Telegram bot that keeps track of user activity in groups.
- mattrighetti/libgen-bot-rs -- Telgram bot to interface with libgen
- dracarys18/grpmr-rs -- A Telegram group manager bot with variety of extra features.
- steadylearner/subreddit_reader -- A bot that shows the latest posts at Rust subreddit.
- myblackbeard/basketball-betting-bot -- The bot lets you bet on NBA games against your buddies.
- ArtHome12/vzmuinebot -- Telegram bot for food menu navigate.
- ArtHome12/cognito_bot -- The bot is designed to anonymize messages to a group.
- pro-vim/tg-vimhelpbot -- Link
:help
for Vim in Telegram. - sschiz/janitor-bot -- A bot that removes users trying to join to a chat that is designed for comments.
- slondr/BeerHolderBot -- A bot that holds your beer.
- MustafaSalih1993/Miss-Vodka-Telegram-Bot -- A Telegram bot written in rust using "Teloxide" library.
- x13a/tg-prompt -- Telegram prompt.
- magnickolas/remindee-bot -- Telegram bot for managing reminders.
- cyberknight777/knight-bot -- A Telegram bot with variety of fun features.
- wa7sa34cx/the-black-box-bot -- This is the Black Box Telegram bot. You can hold any items in it.
- crapstone/hsctt -- A Telegram bot that searches for HTTP status codes in all messages and replies with the text form.
- alenpaul2001/AurSearchBot -- Telegram bot for searching AUR in inline mode.
Contributing
See CONRIBUTING.md
.