Markup~ Markup

Button will open a list of suitable bots. Tapping on any bot will send their identifier to the your bot in a user_shared service message. Available in private chats only & non-inline keyboards

Adds a new text button. This button will simply send the given text as a text message back to your bot if a user clicks on it. Available for non-inline keyboard only.

Adds a new callback query button. The button contains a text and a custom payload. This payload will be sent back to your bot when the button is pressed. If you omit the payload, the display text will be sent back to your bot.

Your bot will receive an update every time a user presses any of the text buttons. You can listen to these updates like this:

// Specific buttons:
bot.action('some-payload', ctx => { ... })

// Any button of any inline keyboard:
bot.on('callback_query', ctx => { ... })

Button will open a list of suitable channels. Tapping on any group will send their identifier to the your bot in a chat_shared service message. Available in private chats only & non-inline keyboards

Adds a new contact request button. The user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

Your bot will in turn receive location updates. You can listen to contact updates like this:

bot.on('contact', ctx => { ... })

Returns a ready object for extra parameters with given additional options, equals result to Extra.markup(markupObj)

ctx.reply('<i>Banana</i>', Markup.inlineKeyboard([
  Markup.callbackButton('Yes', 'yes'),
  Markup.callbackButton('No', 'no')
]).extra({ parse_mode: 'HTML' }))

Adding force reply option to markup

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.

Adds a new game query button

Button will open a list of suitable groups. Tapping on any group will send their identifier to the your bot in a chat_shared service message. Available in private chats only & non-inline keyboards

Build inline keyboard with given buttons

// Make one-line inline keyboard
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
])

// Make two columns inline keyboard with custom function
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
  ], {
    wrap: (btn, index, currentRow) => index % 2 !== 0
  }
)

// Make fixed two columns inline keyboard with columns option
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
], { columns: 2 })

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

Build keyboard with given buttons

// Make one-line keyboard with resize
Markup.keyboard(['one', 'two', 'three', 'four']).resize()

// Make two columns keyboard with custom function
Markup.keyboard(['one', 'two', 'three', 'four'], {
  wrap: (btn, index, currentRow) => index % 2 !== 0
}).resize()

// Make fixed two columns keyboard with columns option
Markup.keyboard(['one', 'two', 'three', 'four'], { columns: 2 }).resize()

Adds a new location request button. The user's current location will be sent when the button is pressed. Available in private chats only.

Your bot will in turn receive location updates. You can listen to inline query updates like this:

bot.on('location', ctx => { ... })

Adds a new login button. This can be used as a replacement for the Telegram Login Widget. You must specify an HTTPS URL used to automatically authorize the user.

Enable / Disable hiding keyboard after click

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.

Adds a new payment button

Requests clients to always show the keyboard when the regular keyboard is hidden.

Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

Adds a new poll request button. The user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

Enable / Disable keyboard removing

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).

Enable / Disable resize for keyboard.

Keyboards are non-resized by default, use this function to enable it (without any parameters or pass true). Pass false to force the keyboard to be non-resized.

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.

Enable / Disable selective for force reply / remove keyboard

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.

Adds a new inline query button. Telegram clients will let the user pick a chat when this button is pressed. This will start an inline query. The selected chat will be prefilled with the name of your bot. You may provide a text that is specified along with it.

Your bot will in turn receive updates for inline queries. You can listen to inline query updates like this:

bot.on('inline_query', ctx => { ... })

Returns inline button that switches the current user to inline mode in a chosen chat with an optional default inline query.

Adds a new inline query button that act on the current chat. The selected chat will be prefilled with the name of your bot. You may provide a text that is specified along with it. This will start an inline query.

Your bot will in turn receive updates for inline queries. You can listen to inline query updates like this:

bot.on('inline_query', ctx => { ... })

Adds a new URL button. Telegram clients will open the provided URL when the button is pressed.

Button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a user_shared service message. Available in private chats only & non-inline keyboards

Adds a new web app button. The Web App that will be launched when the user presses the button. The Web App will be able to send a web_app_data service message. Available in private chats only.

Button will open a list of suitable bots. Tapping on any bot will send their identifier to the your bot in a user_shared service message. Available in private chats only & non-inline keyboards

Adds a new text button. This button will simply send the given text as a text message back to your bot if a user clicks on it. Available for non-inline keyboard only.

Adds a new callback query button. The button contains a text and a custom payload. This payload will be sent back to your bot when the button is pressed. If you omit the payload, the display text will be sent back to your bot.

Your bot will receive an update every time a user presses any of the text buttons. You can listen to these updates like this:

// Specific buttons:
bot.action('some-payload', ctx => { ... })

// Any button of any inline keyboard:
bot.on('callback_query', ctx => { ... })

Button will open a list of suitable channels. Tapping on any group will send their identifier to the your bot in a chat_shared service message. Available in private chats only & non-inline keyboards

Adds a new contact request button. The user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

Your bot will in turn receive location updates. You can listen to contact updates like this:

bot.on('contact', ctx => { ... })

Escape string for HTML

Escape string for Markdown

Escape string for Markdown V2

Adding force reply option to markup

Returns build HTML given text and entities object

Adds a new game query button

Button will open a list of suitable groups. Tapping on any group will send their identifier to the your bot in a chat_shared service message. Available in private chats only & non-inline keyboards

Build inline keyboard with given buttons

// Make one-line inline keyboard
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
])

// Make two columns inline keyboard with custom function
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
  ], {
    wrap: (btn, index, currentRow) => index % 2 !== 0
  }
)

// Make fixed two columns inline keyboard with columns option
Markup.inlineKeyboard([
  Markup.urlButton('one', 'https://example.com'),
  Markup.urlButton('two', 'https://example.com'),
  Markup.urlButton('three', 'https://example.com'),
  Markup.urlButton('four', 'https://example.com')
], { columns: 2 })

Changing input field placeholder when reply is active, used with forceReply

Build keyboard with given buttons

// Make one-line keyboard with resize
Markup.keyboard(['one', 'two', 'three', 'four']).resize()

// Make two columns keyboard with custom function
Markup.keyboard(['one', 'two', 'three', 'four'], {
  wrap: (btn, index, currentRow) => index % 2 !== 0
}).resize()

// Make fixed two columns keyboard with columns option
Markup.keyboard(['one', 'two', 'three', 'four'], { columns: 2 }).resize()

Adds a new location request button. The user's current location will be sent when the button is pressed. Available in private chats only.

Your bot will in turn receive location updates. You can listen to inline query updates like this:

bot.on('location', ctx => { ... })

Adds a new login button. This can be used as a replacement for the Telegram Login Widget. You must specify an HTTPS URL used to automatically authorize the user.

Enable / Disable hiding keyboard after click

Adds a new payment button

Adds a new poll request button. The user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

Enable / Disable keyboard removing

Enable / Disable resize for keyboard.

Keyboards are non-resized by default, use this function to enable it (without any parameters or pass true). Pass false to force the keyboard to be non-resized.

Enable / Disable selective for force reply / remove keyboard

Keyboards are non-selective by default, use this function to enable it (without any parameters or pass true). Pass false to force the keyboard to be non-selective.

Adds a new inline query button. Telegram clients will let the user pick a chat when this button is pressed. This will start an inline query. The selected chat will be prefilled with the name of your bot. You may provide a text that is specified along with it.

Your bot will in turn receive updates for inline queries. You can listen to inline query updates like this:

bot.on('inline_query', ctx => { ... })

Returns inline button that switches the current user to inline mode in a chosen chat with an optional default inline query.

Adds a new inline query button that act on the current chat. The selected chat will be prefilled with the name of your bot. You may provide a text that is specified along with it. This will start an inline query.

Your bot will in turn receive updates for inline queries. You can listen to inline query updates like this:

bot.on('inline_query', ctx => { ... })

Adds a new URL button. Telegram clients will open the provided URL when the button is pressed.

Button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a user_shared service message. Available in private chats only & non-inline keyboards

Adds a new web app button. The Web App that will be launched when the user presses the button. The Web App will be able to send a web_app_data service message. Available in private chats only.