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

# InlineQueryResultGif

class telegram.InlineQueryResultGif(id, gif_url, thumbnail_url, gif_width=None, gif_height=None, title=None, caption=None, reply_markup=None, input_message_content=None, gif_duration=None, parse_mode=None, caption_entities=None, thumbnail_mime_type=None, *, api_kwargs=None)

  Bases: `telegram.InlineQueryResult`

  Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use `input_message_content` to send a message with the specified content instead of the animation.

  Use In

  - `telegram.Bot.answer_inline_query()`

  - `telegram.Bot.answer_web_app_query()`

  See also

  Working with Files and Media

  Changed in version 20.5: Removed the deprecated arguments and attributes `thumb_*`.

  Parameters:

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

    - gif_url (`str`) – A valid URL for the GIF file. File size must not exceed 1MB.

    - gif_width (`int`, optional) – Width of the GIF.

    - gif_height (`int`, optional) – Height of the GIF.

    - gif_duration (`int`, optional) – Duration of the GIF in seconds.

    - thumbnail_url (`str`, optional) –

      URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.

      Warning

      The Bot API does not define this as an optional argument. It is formally optional for backwards compatibility with the deprecated `thumb_url`. If you pass neither `thumbnail_url` nor `thumb_url`, `ValueError` will be raised.

      New in version 20.2.

    - thumbnail_mime_type (`str`, optional) –

      MIME type of the thumbnail, must be one of `'image/jpeg'`, `'image/gif'`, or `'video/mp4'`. Defaults to `'image/jpeg'`.

      New in version 20.2.

    - title (`str`, optional) – Title for the result.

    - caption (`str`, optional) – Caption of the GIF file to be sent, 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.

    - 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 GIF animation.

  Raises:

    ValueError – If neither `thumbnail_url` nor `thumb_url` is supplied or if both are supplied and are not equal.

  type

    `'gif'`.

    Type:

      `str`

  id

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

    Type:

      `str`

  gif_url

    A valid URL for the GIF file. File size must not exceed 1MB.

    Type:

      `str`

  gif_width

    Optional. Width of the GIF.

    Type:

      `int`

  gif_height

    Optional. Height of the GIF.

    Type:

      `int`

  gif_duration

    Optional. Duration of the GIF in seconds.

    Type:

      `int`

  thumbnail_url

    URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.

    New in version 20.2.

    Type:

      `str`

  thumbnail_mime_type

    Optional. MIME type of the thumbnail, must be one of `'image/jpeg'`, `'image/gif'`, or `'video/mp4'`. Defaults to `'image/jpeg'`.

    New in version 20.2.

    Type:

      `str`

  title

    Optional. Title for the result.

    Type:

      `str`

  caption

    Optional. Caption of the GIF file to be sent, 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`]

  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 GIF animation.

    Type:

      `telegram.InputMessageContent`