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

# ReplyKeyboardRemove

class telegram.ReplyKeyboardRemove(selective=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see `telegram.ReplyKeyboardMarkup`).

  Note

  User will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use `telegram.ReplyKeyboardMarkup.one_time_keyboard`.

  Examples

  - Example usage: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven’t voted yet.

  - Conversation Bot

  - Conversation Bot 2

  Parameters:

    selective (`bool`, optional) –

    Use this parameter if you want to remove the keyboard for specific users only. Targets:

    1. Users that are @mentioned in the text of the `telegram.Message` object.

    2. If the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message.

  remove_keyboard

    Requests clients to remove the custom keyboard.

    Type:

      `True`

  selective

    Optional. Remove the keyboard for specific users only. Targets:

    1. Users that are @mentioned in the text of the `telegram.Message` object.

    2. If the bot’s message is a reply to a message in the same chat and forum topic,

         sender of the original message.

    Type:

      `bool`

  Use In

  - `telegram.Bot.copy_message()`

  - `telegram.Bot.send_animation()`

  - `telegram.Bot.send_audio()`

  - `telegram.Bot.send_contact()`

  - `telegram.Bot.send_dice()`

  - `telegram.Bot.send_document()`

  - `telegram.Bot.send_location()`

  - `telegram.Bot.send_message()`

  - `telegram.Bot.send_photo()`

  - `telegram.Bot.send_poll()`

  - `telegram.Bot.send_sticker()`

  - `telegram.Bot.send_venue()`

  - `telegram.Bot.send_video_note()`

  - `telegram.Bot.send_video()`

  - `telegram.Bot.send_voice()`