OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-26 22:40:24 +01:00
Code Issues Projects Releases Packages Wiki Activity
Page: Frequently Asked Questions
Pages
Adding defaults to your bot Arbitrary callback_data Architecture Ask Right Ask Support Avoiding flood limits Bot API Forward Compatibility Bots built with PTB Builder Pattern Code snippets Concurrency Emoji Examples Exception Handling Exceptions, Warnings and Logging Extensions Advanced Filters Extensions JobQueue Extensions Your first Bot Extensions – Advanced Filters Extensions – JobQueue Extensions – Your first Bot Frequently Asked Questions Frequently requested design patterns Handling network errors Home Hosting your bot InlineKeyboard Example Internal test bots Introduction to the API Local Bot API Server MWE Making your bot persistent Notes about GAE Google App Engine PTB test writing knowledge base Performance Optimizations Press Project Bots, Groups and Channels Related Projects Storing bot, user and chat related data Storing user and chat related data Telegram Passport Transition guide to Version 12.0 Transition guide to Version 13.0 Transition guide to Version 20.0 Transition guide to Version 4.0 Transition guide to Version 5.0 Type Checking Types of Handlers Webhooks Where to host Telegram Bots Working Behind a Proxy Working with Files and Media Writing Tests
81 Frequently Asked Questions
Aditya Yadav edited this page 2024-02-17 14:43:26 +00:00
Table of Contents

Frequently Asked Questions

Note: You may also want to check the official Telegram Bot FAQ.

What messages can my Bot see?

From the official Telegram Bot FAQ:

All bots, regardless of settings, will receive:

  • All service messages.
  • All messages from private chats with users.
  • All messages from channels where they are a member.

Bot admins and bots with privacy mode disabled will receive all messages except messages sent by other bots.

Bots with privacy mode enabled will receive:

  • Commands explicitly meant for them (e.g., /command@this_bot).
  • General commands from users (e.g. /start) if the bot was the last bot to send a message to the group.
  • Messages sent via this bot.
  • Replies to any messages implicitly or explicitly meant for this bot.

Note that each particular message can only be available to one privacy-enabled bot at a time, i.e., a reply to bot A containing an explicit command for bot B or sent via bot C will only be available to bot A. Replies have the highest priority.

⚠️🚨 Note: 🚨⚠️

Turning off the privacy mode has no effect for groups the bot is already in (because obviously that would be a security issue). You need to re-add your bot to those groups.

What about messages from other Bots?

From the official Telegram Bot FAQ:

Bots talking to each other could potentially get stuck in unwelcome loops. To avoid this, we decided that bots will not be able to see messages from other bots regardless of mode.

Although, It is still possible to see a bot message if bot is replied to, with reply_to_message but you can't do any actions(forward etc) except delete on this message.

Can my bot delete messages from the user in a private chat?

Yes, but only within the first 48 hours.

How can I get a list of all chats/users/channels my bot is interacting with?

There is no method for that. You'll need to keep track. See e.g. the chatmemberbot.py example.

Does my bot get an update, when someone joins my channel?

Yes. We receive ChatMemberUpdated update.

My bot doesn't receive messages from groups. Why?

See here. TL;DR: Disable group privacy with @BotFather ⚠️🚨 and re-add your bot to the group 🚨⚠️

Can you add [feature] to PTB? Can I do [thing] with my bot?

Please note that python-telegram-bot is only a wrapper for the Telegram Bot API, i.e. PTB can only provide methods that are available through the API. You can find a full list of all available methods in the official docs. Anything not listed there can not be done with bots. Here is a short list of frequently requested tasks, that can not be done with the Bot API:

  • Getting a list of all members of a group. You'll need to keep track, e.g. using approaches displayed in chatmemberbot.py
  • Adding members to a group/channel (note that you can just send an invite link, which is also less likely to be seen as spam)
  • Clearing the chat history for a user
  • Getting a message by its message_id (For the interested reader: see here)
  • Getting the last sent message in a chat (you can keep track of that by using chat_data)
  • Getting a users user_id via their @username (only userbots can do that - you may be interested in ptbcontrib/username_to_chat_api)

In some cases, using a userbot can help overcome restrictions of the Bot API. Please have a look at this article about userbots. Note that userbots are not what python-telegram-bot is for.

Please also note that some methods marked in the Telegram API (aka MTProto) are marked as "usable for bots". This does not necessarily mean that they can be used directly via the Bot API. See this GitHub thread and this discussion for more info on that.

I'm using ConversationHandler and want one handler to be run multiple times. How do I do that?

If your handlers callback returns None instead of the next state, you will stay in the current state. That means the next incoming update can be handled by the same callback.

I want to handle updates from an external service in addition to the Telegram updates. How do I do that?

Receiving updates from an external service, e.g. updates about your GitHub repo, is a common use case. Once you have such an update, you can put them in your bots update queue via await application.update_queue.put(your_update). The update_queue is also available as context.update_queue. Note that your_update should not need to be an instance of telegram.Update, as it does not represent an update sent by Telegram. On the contrary, your_update can be any type of a Python object. You can e.g. write your own custom class to represent an update from your external service. To actually do something with the update, you can register a TypeHandler. StringCommandHandler and StringRegexHandler might also be interesting for some use cases.

But how to get the updates into your bot process? For many cases a simple approach is to check for updates every x seconds. You can use the JobQueue for that. If you can get the updates via a webhook, you can implement a custom webhook that handles both the Telegram and your custom updates. Please have a look at customwebhookbot.py example that showcases how that can be done. If your third-party service requires some other setup for fetching updates, that surely also be combined with PTB. Keep in mind that you basically only need access to the (application/context).update_queue.

Why am I getting ImportError: cannot import name 'XY' from 'telegram'?

There are three common reasons for this kind of exception:

  1. You installed pip install telegram instead of pip install python-telegram-bot. Run pip uninstall telegram to uninstall the telegram library and then run pip install python-telegram-bot again.
  2. You have a file named telegram.py or a directory/module named telegram in your working directory. This leads to namespace issues. Rename them to something else.
  3. You have misconfigured your python path/environment. Please check that the location listed in pip show python-telegram-bot is in your PYTHONPATH, or your sys.path. If not, then you may for e.g. append it to PYTHONPATH with export PYTHONPATH=$PYTHONPATH:/path/to/python-telegram-bot, or append it to sys.path with sys.path.append('/path/to/python-telegram-bot').

What do the per_* settings in ConversationHandler do?

ConversationHandler needs to decide somehow to which conversation an update belongs. The default setting (per_user=True and per_chat=True) means that in each chat each user can have its own conversation - even in groups. If you set per_user=False and you start a conversation in a group chat, the ConversationHandler will also accept input from other users. Conversely, if per_user=True, but per_chat=False, its possible to start a conversation in one chat and continue with it in another.

per_message is slightly more complicated: Imagine two different conversations, in each of which the user is presented with an inline keyboard with the buttons yes and no. The user now starts both conversations and sees two such keyboards. Now, which conversation should handle the update? In order to clear this issue up, if you set per_message=True, the ConversationHandler will use the message_id of the message with the keyboard. Note that this approach can only work, if all the handlers in the conversation are CallbackQueryHandlers. This is useful for building interactive menus.

Note: If you have a CallbackQueryHandler in your ConversationHandler, you will see a warning If 'per_message=True/False', …. It is a warning, not an error. If you're sure that you set per_message to the correct value, you can just ignore it. If you like it better, you can even mute with something like

from warnings import filterwarnings
from telegram.warnings import PTBUserWarning

filterwarnings(action="ignore", message=r".*CallbackQueryHandler", category=PTBUserWarning)

See this page for more info.

Can I check, if a ConversationHandler is currently active for a user?

There is no built-in way to do that. You can however easily set a flag as e.g. context.user_data['in_conversation'] = True in your entry_pointss and set it to False before returning ConversationHandler.END.

How can I list all messages of a particular chat or search through them based on a search query?

There is no API method for that (see here). If you really need this functionality, you'll need to save all the messages send to the chat manually. Keep in mind that

  1. In group chats your bot doesn't receive all messages, if privacy mode is enabled (see here)
  2. Messages may be edited (in which case your bot will receive a corresponding update)
  3. Messages may be deleted (and there are no updates for "message deleted"!)

Why am I getting an error The following arguments have not been supplied?

The callback method you pass to JobQueue.run_* takes exactly one argument, which is of type CallbackContext. This is, because jobs are triggered by a schedule and not by an update from Telegram. If you want to access data in the callback that changes at runtime (e.g. because you schedule jobs on demand), you can:

  1. Access context.bot_data.
  2. Pass {user, chat}_id to any of the run_*(...) methods so you can access them in your callback as context.{user, chat}_data
  3. Use run_*(…, data=additional_data). It can then be accessed within the callback as context.job.data.

Note that context.{user, chat}_data will be None, if you don't pass the arguments {user, chat}_id to any of the run_*(...) methods.

How can I check the version of PTB I am using?

There are three easy ways to do this. Two work from the command line: pip show python-telegram-bot or python -m telegram. One you run inside a python script (or the python console): import telegram, then call print(telegram.__version__).

How do I access info about the message my bot sent?

All bot methods have a return value. For example to get the message_id of a text message sent by your bot, you can do

message = await bot.send_message(…)
message_id = message.message_id

Please check the docs for details about the return value of each bot method.

How can I print a table in a Telegram message? Is it a lost cause?

Long story short: yes, it's a lost cause. Telegram formatting doesn't support tables and even if you try to get everything aligned with whitespaces and tabs, there WILL be a client that has a different max-widths for the text bubbles or a different font/font size and everything will be messed up. If it's important to you to send a nicely formatted table, send a picture or a pdf.

Can an InlineKeyboardButton have both a URL and callback-data?

No, exactly one of the optional arguments of InlineKeyboardButton must be set. The closest that you can get to having both a URL and callback_data in the button is:

  1. have a custom server (e.g. my.tld) where you can create redirect-links on the fly - something similar to bitly or all the other link shortening services
  2. each time you want to have both a URL and a callback_data, create a new link my.tld/some_token
    1. Make my.tld/some_token redirect to the actual URL
    2. Configure your server such that it sends a notification to your bot telling it that the my.tld/some_token was accessed
  3. Make your bot process that information similar to how you'd process a CallbackQuery. See also this FAQ entry

Why am I suddenly getting so many log entries from httpx?

Starting with v.0.24.1, httpx logs all async requests at INFO level, which may be annoying for you as a PTB user.

You can explicitly set logging level for httpx to WARNING to get rid of these messages:

import logging

logging.getLogger("httpx").setLevel(logging.WARNING)

How can my bot use premium features?

Currently, Bot API allows only limited premium features to be used by bots, particularly sending custom emojis. Custom emoji entities can only be used by bots that purchased additional usernames on Fragment in any chat. Additionally, bots can send custom emojis in specific groups without buying additional usernames if that group has sufficient amount of boosts to allow non premium members to send custom emojis from the groups emoji pack. See formatting options to know how to send custom emojis if your bot fulfills the necessary conditions.

Must read

  1. Introduction to the API
  2. Tutorial: Your first bot
  3. FAQ
  4. How to ask good questions
  5. How to write an MWE

Concepts & Important Elements

  1. Architecture Overview
  2. Builder Pattern for Application
  3. Types of Handlers
  4. Working with Files and Media
  5. Exceptions, Warnings and Logging
  6. Concurrency in PTB

Notable Features

  1. Advanced Filters
  2. Storing data
  3. Making your bot persistent
  4. Adding Defaults
  5. Job Queue
  6. Arbitrary callback_data
  7. Avoiding flood limits
  8. Webhooks
  9. Bot API Forward Compatiblity

Code Resources

  1. Frequently requested design patterns
  2. Code snippets
  3. Performance Optimizations
  4. Telegram Passport
  5. Bots built with PTB
  6. Automated Bot Tests

Examples explained

  1. InlineKeyboard Example

Networking

  1. Working Behind a Proxy
  2. Handling network errors

Other resources

  1. Where to host Telegram Bots
  2. How to host your bot
  3. Local API Server
  4. Type Checking with PTB
  5. Press
  6. Notes on GAE
  7. Related Projects
  8. Emoji

Transition Guides

Administration