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

# ForceReply

class telegram.ForceReply(selective=None, input_field_placeholder=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot’s message and tapped ‘Reply’). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `selective` is equal.

  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()`

  Changed in version 20.0: The (undocumented) argument `force_reply` was removed and instead `force_reply` is now always set to `True` as expected by the Bot API.

  Parameters:

    - selective (`bool`, optional) –

      Use this parameter if you want to force reply from 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.

    - input_field_placeholder (`str`, optional) –

      The placeholder to be shown in the input field when the reply is active; `1`- `64` characters.

      New in version 13.7.

  force_reply

    Shows reply interface to the user, as if they manually selected the bots message and tapped ‘Reply’.

    Type:

      `True`

  selective

    Optional. Force reply from 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`

  input_field_placeholder

    Optional. The placeholder to be shown in the input field when the reply is active; `1`- `64` characters.

    New in version 13.7.

    Type:

      `str`

  MAX_INPUT_FIELD_PLACEHOLDER = 64

    `telegram.constants.ReplyLimit.MAX_INPUT_FIELD_PLACEHOLDER`

    New in version 20.0.

  MIN_INPUT_FIELD_PLACEHOLDER = 1

    `telegram.constants.ReplyLimit.MIN_INPUT_FIELD_PLACEHOLDER`

    New in version 20.0.