Body Required

• chat_id integer | string Required

  Any of:

  integer-1 integer string-2 string

  Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  Unique identifier for the target chat or username of the target channel (in the format @channelusername)

• from_chat_id integer | string Required

  Any of:

  integer-1 integer string-2 string

  Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

  Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

• message_id integer Required

  Message identifier in the chat specified in from_chat_id

• caption string

  New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept

• parse_mode string

  Mode for parsing entities in the new 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

• disable_notification boolean

  Sends the message silently. Users will receive a notification with no sound.

• reply_to_message_id integer

  If the message is a reply, ID of the original message

• allow_sending_without_reply boolean

  Pass True, if the message should be sent even if the specified replied-to message is not found

• reply_markup object

  Any of:

  InlineKeyboardMarkup object ReplyKeyboardMarkup object ReplyKeyboardRemove object ForceReply object

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

  Hide attribute Show attribute

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

  This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

  Hide attributes Show attributes

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

  • resize_keyboard boolean

    Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

    Default value is false.

  • one_time_keyboard boolean

    Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

    Default value is false.

  • selective boolean

    Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

    Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

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

  Hide attributes Show attributes

  • remove_keyboard boolean Required

    Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)

  • selective boolean

    Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

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

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

  Hide attributes Show attributes

  • force_reply boolean Required

    Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'

  • selective boolean

    Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.