Hide navigation sidebar
Hide table of contents sidebar
PTB has undergone significant changes in v20. Please read the documentation carefully and also check out the transition guide in the wiki.
Back to top
Toggle table of contents sidebar

# Examples

In this section we display small examples to show what a bot written with `python-telegram-bot` looks like. Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the rawapibot.py example, they all use the high-level framework this library provides with the `telegram.ext` submodule.

All examples are licensed under the CC0 License and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights.

Do note that we ignore one pythonic convention. Best practice would dictate, in many handler callbacks function signatures, to replace the argument `context` with an underscore, since `context` is an unused local variable in those callbacks. However, since these are examples and not having a name for that argument confuses beginners, we decided to have it present.

## echobot.py

This is probably the base for most of the bots made with `python-telegram-bot`. It simply replies to each text message with a message that contains the same text.

## timerbot.py

This bot uses the `telegram.ext.JobQueue` class to send timed messages. The user sets a timer by using `/set` command with a specific time, for example `/set 30`. The bot then sets up a job to send a message to that user after 30 seconds. The user can also cancel the timer by sending `/unset`. To learn more about the `JobQueue`, read this wiki article. Note: To use `JobQueue`, you must install PTB via `pip install "python-telegram-bot[job-queue]"`

## conversationbot.py

A common task for a bot is to ask information from the user. In v5.0 of this library, we introduced the `telegram.ext.ConversationHandler` for that exact purpose. This example uses it to retrieve user-information in a conversation-like style. To get a better understanding, take a look at the state diagram.

## conversationbot2.py

A more complex example of a bot that uses the `ConversationHandler`. It is also more confusing. Good thing there is a fancy state diagram. for this one, too!

## nestedconversationbot.py

A even more complex example of a bot that uses the nested `ConversationHandler`s. While it’s certainly not that complex that you couldn’t built it without nested `ConversationHanldler`s, it gives a good impression on how to work with them. Of course, there is a fancy state diagram for this example, too!

## persistentconversationbot.py

A basic example of a bot store conversation state and user_data over multiple restarts.

## inlinekeyboard.py

This example sheds some light on inline keyboards, callback queries and message editing. A wiki site explaining this examples lives here.

## inlinekeyboard2.py

A more complex example about inline keyboards, callback queries and message editing. This example showcases how an interactive menu could be build using inline keyboards.

## deeplinking.py

A basic example on how to use deeplinking with inline keyboards.

## inlinebot.py

A basic example of an inline bot. Don’t forget to enable inline mode with @BotFather.

## pollbot.py

This example sheds some light on polls, poll answers and the corresponding handlers.

## passportbot.py

A basic example of a bot that can accept passports. Use in combination with the HTML page. Don’t forget to enable and configure payments with @BotFather. Check out this guide on Telegram passports in PTB. Note: To use Telegram Passport, you must install PTB via `pip install "python-telegram-bot[passport]"`

## paymentbot.py

A basic example of a bot that can accept payments. Don’t forget to enable and configure payments with @BotFather.

## errorhandlerbot.py

A basic example on how to set up a custom error handler.

## chatmemberbot.py

A basic example on how `(my_)chat_member` updates can be used.

## webappbot.py

A basic example of how Telegram WebApps can be used. Use in combination with the HTML page. For your convenience, this file is hosted by the PTB team such that you don’t need to host it yourself. Uses the iro.js JavaScript library to showcase a user interface that is hard to achieve with native Telegram functionality.

## contexttypesbot.py

This example showcases how `telegram.ext.ContextTypes` can be used to customize the `context` argument of handler and job callbacks.

## customwebhookbot.py

This example showcases how a custom webhook setup can be used in combination with `telegram.ext.Application`.

## arbitrarycallbackdatabot.py

This example showcases how PTBs “arbitrary callback data” feature can be used. Note: To use arbitrary callback data, you must install PTB via `pip install "python-telegram-bot[callback-data]"`

## Pure API

The rawapibot.py example example uses only the pure, “bare-metal” API wrapper.