Body Required

• inline_query_id string Required

  Unique identifier for the answered query

• results array[object] Required

  Any of:

  InlineQueryResultCachedAudio array[object] InlineQueryResultCachedDocument array[object] InlineQueryResultCachedGif array[object] InlineQueryResultCachedMpeg4Gif array[object] InlineQueryResultCachedPhoto array[object] InlineQueryResultCachedSticker array[object] InlineQueryResultCachedVideo array[object] InlineQueryResultCachedVoice array[object] InlineQueryResultArticle array[object] InlineQueryResultAudio array[object] InlineQueryResultContact array[object] InlineQueryResultGame array[object] InlineQueryResultDocument array[object] InlineQueryResultGif array[object] InlineQueryResultLocation array[object] InlineQueryResultMpeg4Gif array[object] InlineQueryResultPhoto array[object] InlineQueryResultVenue array[object] InlineQueryResultVideo array[object] InlineQueryResultVoice array[object]

  Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be audio

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • audio_file_id string Required

    A valid file identifier for the audio file

  • caption string

    Optional. Caption, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be document

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • title string Required

    Title for the result

  • document_file_id string Required

    A valid file identifier for the file

  • description string

    Optional. Short description of the result

  • caption string

    Optional. Caption of the document to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the document caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

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

  Hide attributes Show attributes

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • type string Required

    Type of the result, must be gif

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • gif_file_id string Required

    A valid file identifier for the GIF file

  • title string

    Optional. Title for the result

  • caption string

    Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be mpeg4_gif

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • mpeg4_file_id string Required

    A valid file identifier for the MP4 file

  • title string

    Optional. Title for the result

  • caption string

    Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be photo

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • photo_file_id string Required

    A valid file identifier of the photo

  • title string

    Optional. Title for the result

  • description string

    Optional. Short description of the result

  • caption string

    Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be sticker

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • sticker_file_id string Required

    A valid file identifier of the sticker

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be video

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • video_file_id string Required

    A valid file identifier for the video file

  • title string Required

    Title for the result

  • description string

    Optional. Short description of the result

  • caption string

    Optional. Caption of the video to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the video caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a voice message stored on the Telegram servers. By default, this voice message 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.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be voice

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • voice_file_id string Required

    A valid file identifier for the voice message

  • title string Required

    Voice message title

  • caption string

    Optional. Caption, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to an article or web page.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be article

  • id string Required

    Unique identifier for this result, 1-64 Bytes

  • title string Required

    Title of the result

  • input_message_content object Required

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • url string

    Optional. URL of the result

  • hide_url boolean

    Optional. Pass True, if you don't want the URL to be shown in the message

  • description string

    Optional. Short description of the result

  • thumb_url string

    Optional. Url of the thumbnail for the result

  • thumb_width integer

    Optional. Thumbnail width

  • thumb_height integer

    Optional. Thumbnail height

  Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be audio

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • audio_url string Required

    A valid URL for the audio file

  • title string Required

    Title

  • caption string

    Optional. Caption, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • performer string

    Optional. Performer

  • audio_duration integer

    Optional. Audio duration in seconds

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

  Hide attributes Show attributes

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • type string Required

    Type of the result, must be contact

  • id string Required

    Unique identifier for this result, 1-64 Bytes

  • phone_number string Required

    Contact's phone number

  • first_name string Required

    Contact's first name

  • last_name string

    Optional. Contact's last name

  • vcard string

    Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • thumb_url string

    Optional. Url of the thumbnail for the result

  • thumb_width integer

    Optional. Thumbnail width

  • thumb_height integer

    Optional. Thumbnail height

  Represents a Game.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be game

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • game_short_name string Required

    Short name of the game

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

  Hide attributes Show attributes

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • type string Required

    Type of the result, must be document

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • title string Required

    Title for the result

  • caption string

    Optional. Caption of the document to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the document caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • document_url string Required

    A valid URL for the file

  • mime_type string Required

    Mime type of the content of the file, either “application/pdf” or “application/zip”

    Values are application/pdf or application/zip.

  • description string

    Optional. Short description of the result

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • thumb_url string

    Optional. URL of the thumbnail (jpeg only) for the file

  • thumb_width integer

    Optional. Thumbnail width

  • thumb_height integer

    Optional. Thumbnail height

  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.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be gif

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • gif_url string Required

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

  • gif_width integer

    Optional. Width of the GIF

  • gif_height integer

    Optional. Height of the GIF

  • gif_duration integer

    Optional. Duration of the GIF

  • thumb_url string Required

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

  • thumb_mime_type string

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

    Values are image/jpeg, image/gif, or video/mp4. Default value is image/jpeg.

  • title string

    Optional. Title for the result

  • caption string

    Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

  Hide attributes Show attributes

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • type string Required

    Type of the result, must be location

  • id string Required

    Unique identifier for this result, 1-64 Bytes

  • latitude number Required

    Location latitude in degrees

  • longitude number Required

    Location longitude in degrees

  • title string Required

    Location title

  • horizontal_accuracy number

    Optional. The radius of uncertainty for the location, measured in meters; 0-1500

  • live_period integer

    Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

  • heading integer

    Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

  • proximity_alert_radius integer

    Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • thumb_url string

    Optional. Url of the thumbnail for the result

  • thumb_width integer

    Optional. Thumbnail width

  • thumb_height integer

    Optional. Thumbnail height

  Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 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.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be mpeg4_gif

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • mpeg4_url string Required

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

  • mpeg4_width integer

    Optional. Video width

  • mpeg4_height integer

    Optional. Video height

  • mpeg4_duration integer

    Optional. Video duration

  • thumb_url string Required

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

  • thumb_mime_type string

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

    Values are image/jpeg, image/gif, or video/mp4. Default value is image/jpeg.

  • title string

    Optional. Title for the result

  • caption string

    Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a link to a photo. By default, this photo 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 photo.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be photo

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • photo_url string Required

    A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB

  • thumb_url string Required

    URL of the thumbnail for the photo

  • photo_width integer

    Optional. Width of the photo

  • photo_height integer

    Optional. Height of the photo

  • title string

    Optional. Title for the result

  • description string

    Optional. Short description of the result

  • caption string

    Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be venue

  • id string Required

    Unique identifier for this result, 1-64 Bytes

  • latitude number Required

    Latitude of the venue location in degrees

  • longitude number Required

    Longitude of the venue location in degrees

  • title string Required

    Title of the venue

  • address string Required

    Address of the venue

  • foursquare_id string

    Optional. Foursquare identifier of the venue if known

  • foursquare_type string

    Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

  • google_place_id string

    Optional. Google Places identifier of the venue

  • google_place_type string

    Optional. Google Places type of the venue. (See supported types.)

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  • thumb_url string

    Optional. Url of the thumbnail for the result

  • thumb_width integer

    Optional. Thumbnail width

  • thumb_height integer

    Optional. Thumbnail height

  Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

  If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be video

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • video_url string Required

    A valid URL for the embedded video player or video file

  • mime_type string Required

    Mime type of the content of video url, “text/html” or “video/mp4”

  • thumb_url string Required

    URL of the thumbnail (jpeg only) for the video

  • title string Required

    Title for the result

  • caption string

    Optional. Caption of the video to be sent, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the video caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • video_width integer

    Optional. Video width

  • video_height integer

    Optional. Video height

  • video_duration integer

    Optional. Video duration in seconds

  • description string

    Optional. Short description of the result

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the venue in degrees

    • longitude number Required

      Longitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • phone_number string Required

      Contact's phone number

    • first_name string Required

      Contact's first name

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

  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 the voice message.

  Hide attributes Show attributes

  • type string Required

    Type of the result, must be voice

  • id string Required

    Unique identifier for this result, 1-64 bytes

  • voice_url string Required

    A valid URL for the voice recording

  • title string Required

    Recording title

  • caption string

    Optional. Caption, 0-1024 characters after entities parsing

  • parse_mode string

    Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

  • caption_entities array[object]

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    Hide caption_entities attributes Show caption_entities attributes array[object]

    • type string Required

      Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

      Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

    • offset integer Required

      Offset in UTF-16 code units to the start of the entity

    • length integer Required

      Length of the entity in UTF-16 code units

    • url string

      Optional. For “text_link” only, url that will be opened after user taps on the text

    • user object

      This object represents a Telegram user or bot.

      Hide user attributes Show user attributes object

      • id integer Required

        Unique identifier for this user or bot

      • is_bot boolean Required

        True, if this user is a bot

      • first_name string Required

        User's or bot's first name

      • last_name string

        Optional. User's or bot's last name

      • username string

        Optional. User's or bot's username

      • language_code string

        Optional. IETF language tag of the user's language

      • can_join_groups boolean

        Optional. True, if the bot can be invited to groups. Returned only in getMe.

      • can_read_all_group_messages boolean

        Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

      • supports_inline_queries boolean

        Optional. True, if the bot supports inline queries. Returned only in getMe.

    • language string

      Optional. For “pre” only, the programming language of the entity text

  • voice_duration integer

    Optional. Recording duration in seconds

  • reply_markup object

    This object represents an inline keyboard that appears right next to the message it belongs to.

    Hide reply_markup attribute Show reply_markup attribute object

    • Array of button rows, each represented by an Array of InlineKeyboardButton objects

  • input_message_content object

    Any of:

    InputTextMessageContent object InputLocationMessageContent object InputVenueMessageContent object InputContactMessageContent object

    Represents the content of a text message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • message_text string Required

      Text of the message to be sent, 1-4096 characters

    • parse_mode string

      Optional. Mode for parsing entities in the message text. See formatting options for more details.

    • entities array[object]

      This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

      Hide entities attributes Show entities attributes array[object]

      • type string Required

        Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

        Values are mention, hashtag, cashtag, bot_command, url, email, phone_number, bold, italic, underline, strikethrough, code, pre, text_link, or text_mention.

      • offset integer Required

        Offset in UTF-16 code units to the start of the entity

      • length integer Required

        Length of the entity in UTF-16 code units

      • url string

        Optional. For “text_link” only, url that will be opened after user taps on the text

      • user object

        This object represents a Telegram user or bot.

        Hide user attributes Show user attributes object

        • id integer Required

          Unique identifier for this user or bot

        • is_bot boolean Required

          True, if this user is a bot

        • first_name string Required

          User's or bot's first name

        • last_name string

          Optional. User's or bot's last name

        • username string

          Optional. User's or bot's username

        • language_code string

          Optional. IETF language tag of the user's language

        • can_join_groups boolean

          Optional. True, if the bot can be invited to groups. Returned only in getMe.

        • can_read_all_group_messages boolean

          Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

        • supports_inline_queries boolean

          Optional. True, if the bot supports inline queries. Returned only in getMe.

      • language string

        Optional. For “pre” only, the programming language of the entity text

    • disable_web_page_preview boolean

      Optional. Disables link previews for links in the sent message

    Represents the content of a location message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • latitude number Required

      Latitude of the location in degrees

    • longitude number Required

      Longitude of the location in degrees

    • horizontal_accuracy number

      Optional. The radius of uncertainty for the location, measured in meters; 0-1500

    • live_period integer

      Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

    • heading integer

      Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

    • proximity_alert_radius integer

      Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

    Represents the content of a venue message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • longitude number Required

      Longitude of the venue in degrees

    • latitude number Required

      Latitude of the venue in degrees

    • title string Required

      Name of the venue

    • address string Required

      Address of the venue

    • foursquare_id string

      Optional. Foursquare identifier of the venue, if known

    • foursquare_type string

      Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

    • google_place_id string

      Optional. Google Places identifier of the venue

    • google_place_type string

      Optional. Google Places type of the venue. (See supported types.)

    Represents the content of a contact message to be sent as the result of an inline query.

    Hide attributes Show attributes

    • first_name string Required

      Contact's first name

    • phone_number string Required

      Contact's phone number

    • last_name string

      Optional. Contact's last name

    • vcard string

      Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

• cache_time integer

  The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

  Default value is 300.

• is_personal boolean

  Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query

• next_offset string

  Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.

• switch_pm_text string

  If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter

• switch_pm_parameter string

  Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.

  Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.