grammY

Appearance

Context ​

ref / core / Context

When your bot receives a message, Telegram sends an update object to your bot. The update contains information about the chat, the user, and of course the message itself. There are numerous other updates, too: https://core.telegram.org/bots/api#update

When grammY receives an update, it wraps this update into a context object for you. Context objects are commonly named ctx. A context object does two things:

  1. ctx.update holds the update object that you can use to process the message. This includes providing useful shortcuts for the update, for instance, ctx.msg is a shortcut that gives you the message object from the update—no matter whether it is contained in ctx.update.message, or ctx.update.edited_message, or ctx.update.channel_post, or ctx.update.edited_channel_post.
  2. ctx.api gives you access to the full Telegram Bot API so that you can directly call any method, such as responding via ctx.api.sendMessage. Also here, the context objects has some useful shortcuts for you. For instance, if you want to send a message to the same chat that a message comes from (i.e. just respond to a user) you can call ctx.reply. This is nothing but a wrapper for ctx.api.sendMessage with the right chat_id pre-filled for you. Almost all methods of the Telegram Bot API have their own shortcut directly on the context object, so you probably never really have to use ctx.api at all.

This context object is then passed to all of the listeners (called middleware) that you register on your bot. Because this is so useful, the context object is often used to hold more information. One example are sessions (a chat-specific data storage that is stored in a database), and another example is ctx.match that is used by bot.command and other methods to keep information about how a regular expression was matched.

Read up about middleware on the website if you want to know more about the powerful opportunities that lie in context objects, and about how grammY implements them.

Source

Implements ​

ts
RenamedUpdate

Constructors ​

ts
Context(
  update: Update,
  api: Api,
  me: UserFromGetMe,
);

Source

Properties ​

match ​

ts
match: string | RegExpMatchArray | undefined;

Used by some middleware to store information about how a certain string or regular expression was matched.

Source

has ​

ts
static has;

Context.has is an object that contains a number of useful functions for probing context objects. Each of these functions can generate a predicate function, to which you can pass context objects in order to check if a condition holds for the respective context object.

For example, you can call Context.has.filterQuery(":text") to generate a predicate function that tests context objects for containing text:

ts
const hasText = Context.has.filterQuery(":text");

if (hasText(ctx0)) {} // `ctx0` matches the filter query `:text`
if (hasText(ctx1)) {} // `ctx1` matches the filter query `:text`
if (hasText(ctx2)) {} // `ctx2` matches the filter query `:text`

These predicate functions are used internally by the has-methods that are installed on every context object. This means that calling ctx.has(":text") is equivalent to Context.has.filterQuery(":text")(ctx).

Source

update ​

ts
readonly update: Update;

Source

api ​

ts
readonly api: Api;

Source

me ​

ts
readonly me: UserFromGetMe;

Source

Methods ​

message (getter) ​

ts
get message();

Alias for ctx.update.message

Source

editedMessage (getter) ​

ts
get editedMessage();

Alias for ctx.update.edited_message

Source

channelPost (getter) ​

ts
get channelPost();

Alias for ctx.update.channel_post

Source

editedChannelPost (getter) ​

ts
get editedChannelPost();

Alias for ctx.update.edited_channel_post

Source

businessConnection (getter) ​

ts
get businessConnection();

Alias for ctx.update.business_connection

Source

businessMessage (getter) ​

ts
get businessMessage();

Alias for ctx.update.business_message

Source

editedBusinessMessage (getter) ​

ts
get editedBusinessMessage();

Alias for ctx.update.edited_business_message

Source

deletedBusinessMessages (getter) ​

ts
get deletedBusinessMessages();

Alias for ctx.update.deleted_business_messages

Source

messageReaction (getter) ​

ts
get messageReaction();

Alias for ctx.update.message_reaction

Source

messageReactionCount (getter) ​

ts
get messageReactionCount();

Alias for ctx.update.message_reaction_count

Source

inlineQuery (getter) ​

ts
get inlineQuery();

Alias for ctx.update.inline_query

Source

chosenInlineResult (getter) ​

ts
get chosenInlineResult();

Alias for ctx.update.chosen_inline_result

Source

callbackQuery (getter) ​

ts
get callbackQuery();

Alias for ctx.update.callback_query

Source

shippingQuery (getter) ​

ts
get shippingQuery();

Alias for ctx.update.shipping_query

Source

preCheckoutQuery (getter) ​

ts
get preCheckoutQuery();

Alias for ctx.update.pre_checkout_query

Source

poll (getter) ​

ts
get poll();

Alias for ctx.update.poll

Source

pollAnswer (getter) ​

ts
get pollAnswer();

Alias for ctx.update.poll_answer

Source

myChatMember (getter) ​

ts
get myChatMember();

Alias for ctx.update.my_chat_member

Source

chatMember (getter) ​

ts
get chatMember();

Alias for ctx.update.chat_member

Source

chatJoinRequest (getter) ​

ts
get chatJoinRequest();

Alias for ctx.update.chat_join_request

Source

chatBoost (getter) ​

ts
get chatBoost();

Alias for ctx.update.chat_boost

Source

removedChatBoost (getter) ​

ts
get removedChatBoost();

Alias for ctx.update.removed_chat_boost

Source

msg (getter) ​

ts
get msg(): Message | undefined;

Get the message object from wherever possible. Alias for this.message ?? this.editedMessage ?? this.channelPost ?? this.editedChannelPost ?? this.businessMessage ?? this.editedBusinessMessage ?? this.callbackQuery?.message.

Source

chat (getter) ​

ts
get chat(): Chat | undefined;

Get the chat object from wherever possible. Alias for (this.msg ?? this.deletedBusinessMessages ?? this.messageReaction ?? this.messageReactionCount ?? this.myChatMember ?? this.chatMember ?? this.chatJoinRequest ?? this.chatBoost ?? this.removedChatBoost)?.chat.

Source

senderChat (getter) ​

ts
get senderChat(): Chat | undefined;

Get the sender chat object from wherever possible. Alias for ctx.msg?.sender_chat.

Source

from (getter) ​

ts
get from(): User | undefined;

Get the user object from wherever possible. Alias for (this.businessConnection ?? this.messageReaction ?? (this.chatBoost?.boost ?? this.removedChatBoost)?.source)?.user ?? (this.callbackQuery ?? this.msg ?? this.inlineQuery ?? this.chosenInlineResult ?? this.shippingQuery ?? this.preCheckoutQuery ?? this.myChatMember ?? this.chatMember ?? this.chatJoinRequest)?.from.

Source

msgId (getter) ​

ts
get msgId(): number | undefined;

Get the message identifier from wherever possible. Alias for this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id.

Source

chatId (getter) ​

ts
get chatId(): number | undefined;

Gets the chat identifier from wherever possible. Alias for this.chat?.id ?? this.businessConnection?.user_chat_id.

Source

inlineMessageId (getter) ​

ts
get inlineMessageId(): string | undefined;

Get the inline message identifier from wherever possible. Alias for (ctx.callbackQuery ?? ctx.chosenInlineResult)?.inline_message_id.

Source

businessConnectionId (getter) ​

ts
get businessConnectionId(): string | undefined;

Get the business connection identifier from wherever possible. Alias for this.msg?.business_connection_id ?? this.businessConnection?.id ?? this.deletedBusinessMessages?.business_connection_id.

Source

entities ​

ts
// Overload 1
entities(): Array<MessageEntity & { text: string }>;
// Overload 2
entities<T extends MessageEntity["type"]>(types: MaybeArray<T>): Array<MessageEntity & { type: T; text: string }>;

Get entities and their text. Extracts the text from ctx.msg.text or ctx.msg.caption. Returns an empty array if one of ctx.msg, ctx.msg.text or ctx.msg.entities is undefined.

You can filter specific entity types by passing the types parameter. Example:

ts
ctx.entities() // Returns all entity types
ctx.entities('url') // Returns only url entities
ctx.enttities(['url', 'email']) // Returns url and email entities

Source

reactions ​

ts
reactions(): {
emoji: ReactionTypeEmoji["emoji"][]; emojiAdded: ReactionTypeEmoji["emoji"][]; emojiKept: ReactionTypeEmoji["emoji"][]; emojiRemoved: ReactionTypeEmoji["emoji"][]; customEmoji: string[]; customEmojiAdded: string[]; customEmojiKept: string[]; customEmojiRemoved: string[]
};

Find out which reactions were added and removed in a message_reaction update. This method looks at ctx.messageReaction and computes the difference between the old reaction and the new reaction. It also groups the reactions by emoji reactions and custom emoji reactions. For example, the resulting object could look like this:

ts
{
  emoji: ['👍', '🎉']
  emojiAdded: ['🎉'],
  emojiKept: ['👍'],
  emojiRemoved: [],
  customEmoji: [],
  customEmojiAdded: [],
  customEmojiKept: [],
  customEmojiRemoved: ['id0123'],
}

In the above example, a tada reaction was added by the user, and a custom emoji reaction with the custom emoji ‘id0123’ was removed in the same update. The user had already reacted with a thumbs up reaction, which they left unchanged. As a result, the current reaction by the user is thumbs up and tada. Note that the current reaction (both emoji and custom emoji in one list) can also be obtained from ctx.messageReaction.new_reaction.

Remember that reaction updates only include information about the reaction of a specific user. The respective message may have many more reactions by other people which will not be included in this update.

Source

has ​

ts
has<Q extends FilterQuery>(filter: Q | Q[]): this is FilterCore<Q>;

Returns true if this context object matches the given filter query, and false otherwise. This uses the same logic as bot.on.

Source

hasText ​

ts
hasText(trigger: MaybeArray<string | RegExp>): this is HearsContextCore;

Returns true if this context object contains the given text, or if it contains text that matches the given regular expression. It returns false otherwise. This uses the same logic as bot.hears.

Source

hasCommand ​

ts
hasCommand(command: MaybeArray<StringWithCommandSuggestions>): this is CommandContextCore;

Returns true if this context object contains the given command, and false otherwise. This uses the same logic as bot.command.

Source

hasReaction ​

ts
hasReaction(reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>): this is ReactionContextCore;

Source

hasChatType ​

ts
hasChatType<T extends Chat["type"]>(chatType: MaybeArray<T>): this is ChatTypeContextCore<T>;

Returns true if this context object belongs to a chat with the given chat type, and false otherwise. This uses the same logic as bot.chatType.

Source

hasCallbackQuery ​

ts
hasCallbackQuery(trigger: MaybeArray<string | RegExp>): this is CallbackQueryContextCore;

Returns true if this context object contains the given callback query, or if the contained callback query data matches the given regular expression. It returns false otherwise. This uses the same logic as bot.callbackQuery.

Source

hasGameQuery ​

ts
hasGameQuery(trigger: MaybeArray<string | RegExp>): this is GameQueryContextCore;

Returns true if this context object contains the given game query, or if the contained game query matches the given regular expression. It returns false otherwise. This uses the same logic as bot.gameQuery.

Source

hasInlineQuery ​

ts
hasInlineQuery(trigger: MaybeArray<string | RegExp>): this is InlineQueryContextCore;

Returns true if this context object contains the given inline query, or if the contained inline query matches the given regular expression. It returns false otherwise. This uses the same logic as bot.inlineQuery.

Source

hasChosenInlineResult ​

ts
hasChosenInlineResult(trigger: MaybeArray<string | RegExp>): this is ChosenInlineResultContextCore;

Returns true if this context object contains the chosen inline result, or if the contained chosen inline result matches the given regular expression. It returns false otherwise. This uses the same logic as bot.chosenInlineResult.

Source

hasPreCheckoutQuery ​

ts
hasPreCheckoutQuery(trigger: MaybeArray<string | RegExp>): this is PreCheckoutQueryContextCore;

Returns true if this context object contains the given pre-checkout query, or if the contained pre-checkout query matches the given regular expression. It returns false otherwise. This uses the same logic as bot.preCheckoutQuery.

Source

hasShippingQuery ​

ts
hasShippingQuery(trigger: MaybeArray<string | RegExp>): this is ShippingQueryContextCore;

Returns true if this context object contains the given shipping query, or if the contained shipping query matches the given regular expression. It returns false otherwise. This uses the same logic as bot.shippingQuery.

Source

reply ​

ts
reply(
  text: string,
  other?: Other<"sendMessage", "chat_id" | "text">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendMessage. Use this method to send text messages. On success, the sent Message is returned.

Source

forwardMessage ​

ts
forwardMessage(
  chat_id: number | string,
  other?: Other<"forwardMessage", "chat_id" | "from_chat_id" | "message_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.forwardMessage. Use this method to forward messages of any kind. Service messages and messages with protected content can’t be forwarded. On success, the sent Message is returned.

Source

forwardMessages ​

ts
forwardMessages(
  chat_id: number | string,
  message_ids: number[],
  other?: Other<"forwardMessages", "chat_id" | "from_chat_id" | "message_ids">,
  signal?: AbortSignal,
);

Context-aware alias for api.forwardMessages. Use this method to forward multiple messages of any kind. If some of the specified messages can’t be found or forwarded, they are skipped. Service messages and messages with protected content can’t be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Source

copyMessage ​

ts
copyMessage(
  chat_id: number | string,
  other?: Other<"copyMessage", "chat_id" | "from_chat_id" | "message_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.copyMessage. Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn’t have a link to the original message. Returns the MessageId of the sent message on success.

Source

copyMessages ​

ts
copyMessages(
  chat_id: number | string,
  message_ids: number[],
  other?: Other<"copyMessages", "chat_id" | "from_chat_id" | "message_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.copyMessages. Use this method to copy messages of any kind. If some of the specified messages can’t be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don’t have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Source

replyWithPhoto ​

ts
replyWithPhoto(
  photo: InputFile | string,
  other?: Other<"sendPhoto", "chat_id" | "photo">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendPhoto. Use this method to send photos. On success, the sent Message is returned.

Source

replyWithAudio ​

ts
replyWithAudio(
  audio: InputFile | string,
  other?: Other<"sendAudio", "chat_id" | "audio">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendAudio. Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the sendVoice method instead.

Source

replyWithDocument ​

ts
replyWithDocument(
  document: InputFile | string,
  other?: Other<"sendDocument", "chat_id" | "document">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendDocument. Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Source

replyWithVideo ​

ts
replyWithVideo(
  video: InputFile | string,
  other?: Other<"sendVideo", "chat_id" | "video">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendVideo. Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Source

replyWithAnimation ​

ts
replyWithAnimation(
  animation: InputFile | string,
  other?: Other<"sendAnimation", "chat_id" | "animation">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendAnimation. Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Source

replyWithVoice ​

ts
replyWithVoice(
  voice: InputFile | string,
  other?: Other<"sendVoice", "chat_id" | "voice">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendVoice. Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Source

replyWithVideoNote ​

ts
replyWithVideoNote(
  video_note: InputFile | string,
  other?: Other<"sendVideoNote", "chat_id" | "video_note">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendVideoNote. Use this method to send video messages. On success, the sent Message is returned. As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long.

Source

replyWithMediaGroup ​

ts
replyWithMediaGroup(
  media: ReadonlyArray<InputMediaAudio | InputMediaDocument | InputMediaPhoto | InputMediaVideo>,
  other?: Other<"sendMediaGroup", "chat_id" | "media">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendMediaGroup. Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Source

replyWithLocation ​

ts
replyWithLocation(
  latitude: number,
  longitude: number,
  other?: Other<"sendLocation", "chat_id" | "latitude" | "longitude">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendLocation. Use this method to send point on the map. On success, the sent Message is returned.

Source

editMessageLiveLocation ​

ts
editMessageLiveLocation(
  latitude: number,
  longitude: number,
  other?: Other<"editMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude">,
  signal?: AbortSignal,
);

Context-aware alias for api.editMessageLiveLocation. Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Source

stopMessageLiveLocation ​

ts
stopMessageLiveLocation(other?: Other<"stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal);

Context-aware alias for api.stopMessageLiveLocation. Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Source

sendPaidMedia ​

ts
sendPaidMedia(
  star_count: number,
  media: InputPaidMedia[],
  other?: Other<"sendPaidMedia", "chat_id" | "star_count" | "media">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendPaidMedia. Use this method to send paid media to channel chats. On success, the sent Message is returned.

Source

replyWithVenue ​

ts
replyWithVenue(
  latitude: number,
  longitude: number,
  title: string,
  address: string,
  other?: Other<"sendVenue", "chat_id" | "latitude" | "longitude" | "title" | "address">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendVenue. Use this method to send information about a venue. On success, the sent Message is returned.

Source

replyWithContact ​

ts
replyWithContact(
  phone_number: string,
  first_name: string,
  other?: Other<"sendContact", "chat_id" | "phone_number" | "first_name">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendContact. Use this method to send phone contacts. On success, the sent Message is returned.

Source

replyWithPoll ​

ts
replyWithPoll(
  question: string,
  options: InputPollOption[],
  other?: Other<"sendPoll", "chat_id" | "question" | "options">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendPoll. Use this method to send a native poll. On success, the sent Message is returned.

Source

replyWithDice ​

ts
replyWithDice(
  emoji: string,
  other?: Other<"sendDice", "chat_id" | "emoji">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendDice. Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Source

replyWithChatAction ​

ts
replyWithChatAction(
  action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note",
  other?: Other<"sendChatAction", "chat_id" | "action">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendChatAction. Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.

Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Source

react ​

ts
react(
  reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>,
  other?: Other<"setMessageReaction", "chat_id" | "message_id" | "reaction">,
  signal?: AbortSignal,
);

Context-aware alias for api.setMessageReaction. Use this method to change the chosen reactions on a message. Service messages can’t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success.

Source

getUserProfilePhotos ​

ts
getUserProfilePhotos(other?: Other<"getUserProfilePhotos", "user_id">, signal?: AbortSignal);

Context-aware alias for api.getUserProfilePhotos. Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Source

getUserChatBoosts ​

ts
getUserChatBoosts(chat_id: number | string, signal?: AbortSignal);

Context-aware alias for api.getUserChatBoosts. Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Source

getBusinessConnection ​

ts
getBusinessConnection(signal?: AbortSignal);

Context-aware alias for api.getBusinessConnection. Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Source

getFile ​

ts
getFile(signal?: AbortSignal);

Context-aware alias for api.getFile. Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot&lt;token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.

Note: This function may not preserve the original file name and MIME type. You should save the file’s MIME type and name (if available) when the File object is received.

Source

kickAuthor ​

ts
kickAuthor(...args: Parameters<Context["banAuthor"]>);

Source

banAuthor ​

ts
banAuthor(other?: Other<"banChatMember", "chat_id" | "user_id">, signal?: AbortSignal);

Context-aware alias for api.banChatMember. Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

kickChatMember ​

ts
kickChatMember(...args: Parameters<Context["banChatMember"]>);

Source

banChatMember ​

ts
banChatMember(
  user_id: number,
  other?: Other<"banChatMember", "chat_id" | "user_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.banChatMember. Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

unbanChatMember ​

ts
unbanChatMember(
  user_id: number,
  other?: Other<"unbanChatMember", "chat_id" | "user_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.unbanChatMember. Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don’t want this, use the parameter only_if_banned. Returns True on success.

Source

restrictAuthor ​

ts
restrictAuthor(
  permissions: ChatPermissions,
  other?: Other<"restrictChatMember", "chat_id" | "user_id" | "permissions">,
  signal?: AbortSignal,
);

Context-aware alias for api.restrictChatMember. Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Source

restrictChatMember ​

ts
restrictChatMember(
  user_id: number,
  permissions: ChatPermissions,
  other?: Other<"restrictChatMember", "chat_id" | "user_id" | "permissions">,
  signal?: AbortSignal,
);

Context-aware alias for api.restrictChatMember. Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Source

promoteAuthor ​

ts
promoteAuthor(other?: Other<"promoteChatMember", "chat_id" | "user_id">, signal?: AbortSignal);

Context-aware alias for api.promoteChatMember. Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Source

promoteChatMember ​

ts
promoteChatMember(
  user_id: number,
  other?: Other<"promoteChatMember", "chat_id" | "user_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.promoteChatMember. Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Source

setChatAdministratorAuthorCustomTitle ​

ts
setChatAdministratorAuthorCustomTitle(custom_title: string, signal?: AbortSignal);

Context-aware alias for api.setChatAdministratorCustomTitle. Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Source

setChatAdministratorCustomTitle ​

ts
setChatAdministratorCustomTitle(
  user_id: number,
  custom_title: string,
  signal?: AbortSignal,
);

Context-aware alias for api.setChatAdministratorCustomTitle. Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Source

banChatSenderChat ​

ts
banChatSenderChat(sender_chat_id: number, signal?: AbortSignal);

Context-aware alias for api.banChatSenderChat. Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Source

unbanChatSenderChat ​

ts
unbanChatSenderChat(sender_chat_id: number, signal?: AbortSignal);

Context-aware alias for api.unbanChatSenderChat. Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Source

setChatPermissions ​

ts
setChatPermissions(
  permissions: ChatPermissions,
  other?: Other<"setChatPermissions", "chat_id" | "permissions">,
  signal?: AbortSignal,
);

Context-aware alias for api.setChatPermissions. Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

Source

ts
exportChatInviteLink(signal?: AbortSignal);

Context-aware alias for api.exportChatInviteLink. Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Note: Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.

Source

ts
createChatInviteLink(other?: Other<"createChatInviteLink", "chat_id">, signal?: AbortSignal);

Context-aware alias for api.createChatInviteLink. Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Source

ts
editChatInviteLink(
  invite_link: string,
  other?: Other<"editChatInviteLink", "chat_id" | "invite_link">,
  signal?: AbortSignal,
);

Context-aware alias for api.editChatInviteLink. Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Source

ts
revokeChatInviteLink(invite_link: string, signal?: AbortSignal);

Context-aware alias for api.revokeChatInviteLink. Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Source

approveChatJoinRequest ​

ts
approveChatJoinRequest(user_id: number, signal?: AbortSignal);

Context-aware alias for api.approveChatJoinRequest. Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Source

declineChatJoinRequest ​

ts
declineChatJoinRequest(user_id: number, signal?: AbortSignal);

Context-aware alias for api.declineChatJoinRequest. Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Source

setChatPhoto ​

ts
setChatPhoto(photo: InputFile, signal?: AbortSignal);

Context-aware alias for api.setChatPhoto. Use this method to set a new profile photo for the chat. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

deleteChatPhoto ​

ts
deleteChatPhoto(signal?: AbortSignal);

Context-aware alias for api.deleteChatPhoto. Use this method to delete a chat photo. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

setChatTitle ​

ts
setChatTitle(title: string, signal?: AbortSignal);

Context-aware alias for api.setChatTitle. Use this method to change the title of a chat. Titles can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

setChatDescription ​

ts
setChatDescription(description: string | undefined, signal?: AbortSignal);

Context-aware alias for api.setChatDescription. Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source

pinChatMessage ​

ts
pinChatMessage(
  message_id: number,
  other?: Other<"pinChatMessage", "chat_id" | "message_id">,
  signal?: AbortSignal,
);

Context-aware alias for api.pinChatMessage. Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source

unpinChatMessage ​

ts
unpinChatMessage(message_id?: number, signal?: AbortSignal);

Context-aware alias for api.unpinChatMessage. Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source

unpinAllChatMessages ​

ts
unpinAllChatMessages(signal?: AbortSignal);

Context-aware alias for api.unpinAllChatMessages. Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source

leaveChat ​

ts
leaveChat(signal?: AbortSignal);

Context-aware alias for api.leaveChat. Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Source

getChat ​

ts
getChat(signal?: AbortSignal);

Context-aware alias for api.getChat. Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.

Source

getChatAdministrators ​

ts
getChatAdministrators(signal?: AbortSignal);

Context-aware alias for api.getChatAdministrators. Use this method to get a list of administrators in a chat, which aren’t bots. Returns an Array of ChatMember objects.

Source

getChatMembersCount ​

ts
getChatMembersCount(...args: Parameters<Context["getChatMemberCount"]>);

Source

getChatMemberCount ​

ts
getChatMemberCount(signal?: AbortSignal);

Context-aware alias for api.getChatMemberCount. Use this method to get the number of members in a chat. Returns Int on success.

Source

getAuthor ​

ts
getAuthor(signal?: AbortSignal);

Context-aware alias for api.getChatMember. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.

Source

getChatMember ​

ts
getChatMember(user_id: number, signal?: AbortSignal);

Context-aware alias for api.getChatMember. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.

Source

setChatStickerSet ​

ts
setChatStickerSet(sticker_set_name: string, signal?: AbortSignal);

Context-aware alias for api.setChatStickerSet. Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success.

Source

deleteChatStickerSet ​

ts
deleteChatStickerSet(signal?: AbortSignal);

Context-aware alias for api.deleteChatStickerSet. Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success.

Source

createForumTopic ​

ts
createForumTopic(
  name: string,
  other?: Other<"createForumTopic", "chat_id" | "name">,
  signal?: AbortSignal,
);

Context-aware alias for api.createForumTopic. Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Source

editForumTopic ​

ts
editForumTopic(other?: Other<"editForumTopic", "chat_id" | "message_thread_id">, signal?: AbortSignal);

Context-aware alias for api.editForumTopic. Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Source

closeForumTopic ​

ts
closeForumTopic(signal?: AbortSignal);

Context-aware alias for api.closeForumTopic. Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Source

reopenForumTopic ​

ts
reopenForumTopic(signal?: AbortSignal);

Context-aware alias for api.reopenForumTopic. Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Source

deleteForumTopic ​

ts
deleteForumTopic(signal?: AbortSignal);

Context-aware alias for api.deleteForumTopic. Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Source

unpinAllForumTopicMessages ​

ts
unpinAllForumTopicMessages(signal?: AbortSignal);

Context-aware alias for api.unpinAllForumTopicMessages. Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Source

editGeneralForumTopic ​

ts
editGeneralForumTopic(name: string, signal?: AbortSignal);

Context-aware alias for api.editGeneralForumTopic. Use this method to edit the name of the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Source

closeGeneralForumTopic ​

ts
closeGeneralForumTopic(signal?: AbortSignal);

Context-aware alias for api.closeGeneralForumTopic. Use this method to close an open ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Source

reopenGeneralForumTopic ​

ts
reopenGeneralForumTopic(signal?: AbortSignal);

Context-aware alias for api.reopenGeneralForumTopic. Use this method to reopen a closed ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success. *

Source

hideGeneralForumTopic ​

ts
hideGeneralForumTopic(signal?: AbortSignal);

Context-aware alias for api.hideGeneralForumTopic. Use this method to hide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Source

unhideGeneralForumTopic ​

ts
unhideGeneralForumTopic(signal?: AbortSignal);

Context-aware alias for api.unhideGeneralForumTopic. Use this method to unhide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Source

unpinAllGeneralForumTopicMessages ​

ts
unpinAllGeneralForumTopicMessages(signal?: AbortSignal);

Context-aware alias for api.unpinAllGeneralForumTopicMessages. Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Source

answerCallbackQuery ​

ts
answerCallbackQuery(other?: string | Other<"answerCallbackQuery", "callback_query_id">, signal?: AbortSignal);

Context-aware alias for api.answerCallbackQuery. Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

Source

setChatMenuButton ​

ts
setChatMenuButton(other?: Other<"setChatMenuButton">, signal?: AbortSignal);

Context-aware alias for api.setChatMenuButton. Use this method to change the bot’s menu button in a private chat, or the default menu button. Returns True on success.

Source

getChatMenuButton ​

ts
getChatMenuButton(other?: Other<"getChatMenuButton">, signal?: AbortSignal);

Context-aware alias for api.getChatMenuButton. Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button. Returns MenuButton on success.

Source

setMyDefaultAdministratorRights ​

ts
setMyDefaultAdministratorRights(other?: Other<"setMyDefaultAdministratorRights">, signal?: AbortSignal);

Context-aware alias for api.setMyDefaultAdministratorRights. Use this method to the change the default administrator rights requested by the bot when it’s added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

Source

getMyDefaultAdministratorRights ​

ts
getMyDefaultAdministratorRights(other?: Other<"getMyDefaultAdministratorRights">, signal?: AbortSignal);

Context-aware alias for api.getMyDefaultAdministratorRights. Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Source

editMessageText ​

ts
editMessageText(
  text: string,
  other?: Other<"editMessageText", "chat_id" | "message_id" | "inline_message_id" | "text">,
  signal?: AbortSignal,
);

Context-aware alias for api.editMessageText. Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Source

editMessageCaption ​

ts
editMessageCaption(other?: Other<"editMessageCaption", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal);

Context-aware alias for api.editMessageCaption. Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Source

editMessageMedia ​

ts
editMessageMedia(
  media: InputMedia,
  other?: Other<"editMessageMedia", "chat_id" | "message_id" | "inline_message_id" | "media">,
  signal?: AbortSignal,
);

Context-aware alias for api.editMessageMedia. Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Source

editMessageReplyMarkup ​

ts
editMessageReplyMarkup(other?: Other<"editMessageReplyMarkup", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal);

Context-aware alias for api.editMessageReplyMarkup. Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Source

stopPoll ​

ts
stopPoll(other?: Other<"stopPoll", "chat_id" | "message_id">, signal?: AbortSignal);

Context-aware alias for api.stopPoll. Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

Source

deleteMessage ​

ts
deleteMessage(signal?: AbortSignal);

Context-aware alias for api.deleteMessage. Use this method to delete a message, including service messages, with the following limitations:

  • A message can only be deleted if it was sent less than 48 hours ago.
  • A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
  • Bots can delete outgoing messages in private chats, groups, and supergroups.
  • Bots can delete incoming messages in private chats.
  • Bots granted can_post_messages permissions can delete outgoing messages in channels.
  • If the bot is an administrator of a group, it can delete any message there.
  • If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.

Source

deleteMessages ​

ts
deleteMessages(message_ids: number[], signal?: AbortSignal);

Context-aware alias for api.deleteMessages. Use this method to delete multiple messages simultaneously. Returns True on success.

Source

replyWithSticker ​

ts
replyWithSticker(
  sticker: InputFile | string,
  other?: Other<"sendSticker", "chat_id" | "sticker">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendSticker. Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

Source

getCustomEmojiStickers ​

ts
getCustomEmojiStickers(signal?: AbortSignal);

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Source

answerInlineQuery ​

ts
answerInlineQuery(
  results: readonly InlineQueryResult[],
  other?: Other<"answerInlineQuery", "inline_query_id" | "results">,
  signal?: AbortSignal,
);

Context-aware alias for api.answerInlineQuery. Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query 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.

Source

replyWithInvoice ​

ts
replyWithInvoice(
  title: string,
  description: string,
  payload: string,
  currency: string,
  prices: readonly LabeledPrice[],
  other?: Other<"sendInvoice", "chat_id" | "title" | "description" | "payload" | "currency" | "prices">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendInvoice. Use this method to send invoices. On success, the sent Message is returned.

Source

answerShippingQuery ​

ts
answerShippingQuery(
  ok: boolean,
  other?: Other<"answerShippingQuery", "shipping_query_id" | "ok">,
  signal?: AbortSignal,
);

Context-aware alias for api.answerShippingQuery. If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Source

answerPreCheckoutQuery ​

ts
answerPreCheckoutQuery(
  ok: boolean,
  other?: string | Other<"answerPreCheckoutQuery", "pre_checkout_query_id" | "ok">,
  signal?: AbortSignal,
);

Context-aware alias for api.answerPreCheckoutQuery. Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Source

refundStarPayment ​

ts
refundStarPayment(signal?: AbortSignal);

Context-aware alias for api.refundStarPayment. Refunds a successful payment in Telegram Stars.

Source

setPassportDataErrors ​

ts
setPassportDataErrors(errors: readonly PassportElementError[], signal?: AbortSignal);

Context-aware alias for api.setPassportDataErrors. Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.

Use this if the data submitted by the user doesn’t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Source

replyWithGame ​

ts
replyWithGame(
  game_short_name: string,
  other?: Other<"sendGame", "chat_id" | "game_short_name">,
  signal?: AbortSignal,
);

Context-aware alias for api.sendGame. Use this method to send a game. On success, the sent Message is returned.

Source