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

# InlineQueryResultVoice

class telegram.InlineQueryResultVoice(id, voice_url, title, voice_duration=None, caption=None, reply_markup=None, input_message_content=None, parse_mode=None, caption_entities=None, *, api_kwargs=None)

  Bases: `telegram.InlineQueryResult`

  Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use `input_message_content` to send a message with the specified content instead of the voice message.

  Use In

  - `telegram.Bot.answer_inline_query()`

  - `telegram.Bot.answer_web_app_query()`

  See also

  Working with Files and Media

  Parameters:

    - id (`str`) – Unique identifier for this result, `1`- `64` Bytes.

    - voice_url (`str`) – A valid URL for the voice recording.

    - title (`str`) – Recording title.

    - caption (`str`, optional) – Caption, 0-`1024` characters after entities parsing.

    - parse_mode (`str`, optional) – Mode for parsing entities. See `telegram.constants.ParseMode` and formatting options for more details.

    - caption_entities (Sequence[`telegram.MessageEntity`], optional) –

      Sequence of special entities that appear in the caption, which can be specified instead of `parse_mode`.

      Changed in version 20.0: Accepts any `collections.abc.Sequence` as input instead of just a list. The input is converted to a tuple.

    - voice_duration (`int`, optional) – Recording duration in seconds.

    - reply_markup (`telegram.InlineKeyboardMarkup`, optional) – Inline keyboard attached to the message.

    - input_message_content (`telegram.InputMessageContent`, optional) – Content of the message to be sent instead of the voice recording.

  type

    `'voice'`.

    Type:

      `str`

  id

    Unique identifier for this result, `1`- `64` Bytes.

    Type:

      `str`

  voice_url

    A valid URL for the voice recording.

    Type:

      `str`

  title

    Recording title.

    Type:

      `str`

  caption

    Optional. Caption, 0-`1024` characters after entities parsing.

    Type:

      `str`

  parse_mode

    Optional. Mode for parsing entities. See `telegram.constants.ParseMode` and formatting options for more details.

    Type:

      `str`

  caption_entities

    Optional. Tuple of special entities that appear in the caption, which can be specified instead of `parse_mode`.

    Changed in version 20.0:

    - This attribute is now an immutable tuple.

    - This attribute is now always a tuple, that may be empty.

    Type:

      Tuple[`telegram.MessageEntity`]

  voice_duration

    Optional. Recording duration in seconds.

    Type:

      `int`

  reply_markup

    Optional. Inline keyboard attached to the message.

    Type:

      `telegram.InlineKeyboardMarkup`

  input_message_content

    Optional. Content of the message to be sent instead of the voice recording.

    Type:

      `telegram.InputMessageContent`