Class TelegramBot<C>

Type Parameters

C extends Context = Context

Hierarchy (View Summary)

Composer<C>
- TelegramBot

Index

Constructors

Methods

_setClient action addStickerToSet answerCallbackQuery answerGuestQuery answerInlineQuery answerPreCheckoutQuery answerShippingQuery answerWebAppQuery approveChatJoinRequest approveSuggestedPost banChatMember banChatSenderChat catch close closeForumTopic closeGeneralForumTopic command convertGiftToStars copyMessage copyMessages createChatInviteLink createChatSubscriptionInviteLink createForumTopic createInvoiceLink createNewStickerSet declineChatJoinRequest declineSuggestedPost deleteAllMessageReactions deleteBusinessMessages deleteChatPhoto deleteChatStickerSet deleteForumTopic deleteMessage deleteMessageReaction deleteMessages deleteMyCommands deleteStickerFromSet deleteStickerSet deleteStory deleteWebhook editChatInviteLink editChatSubscriptionInviteLink editForumTopic editGeneralForumTopic editMessageCaption editMessageChecklist editMessageLiveLocation editMessageMedia editMessageReplyMarkup editMessageText editStory editUserStarSubscription exportChatInviteLink forwardMessage forwardMessages getAvailableGifts getBusinessAccountGifts getBusinessAccountStarBalance getBusinessConnection getChat getChatAdministrators getChatGifts getChatMember getChatMemberCount getChatMenuButton getCustomEmojiStickers getFile getForumTopicIconStickers getGameHighScores getManagedBotAccessSettings getManagedBotToken getMe getMyCommands getMyDefaultAdministratorRights getMyDescription getMyName getMyShortDescription getMyStarBalance getStarTransactions getStickerSet getUpdates getUserChatBoosts getUserGifts getUserPersonalChatMessages getUserProfileAudios getUserProfilePhotos getWebhookInfo giftPremiumSubscription handleUpdate hideGeneralForumTopic launch leaveChat logOut middleware on pinChatMessage postStory promoteChatMember readBusinessMessage refundStarPayment removeBusinessAccountProfilePhoto removeChatVerification removeMyProfilePhoto removeUserVerification reopenForumTopic reopenGeneralForumTopic replaceManagedBotToken replaceStickerInSet repostStory restrictChatMember revokeChatInviteLink savePreparedInlineMessage savePreparedKeyboardButton sendAnimation sendAudio sendChatAction sendChecklist sendContact sendDice sendDocument sendGame sendGift sendInvoice sendLivePhoto sendLocation sendMediaGroup sendMessage sendMessageDraft sendPaidMedia sendPhoto sendPoll sendSticker sendVenue sendVideo sendVideoNote sendVoice setBusinessAccountBio setBusinessAccountGiftSettings setBusinessAccountName setBusinessAccountProfilePhoto setBusinessAccountUsername setChatAdministratorCustomTitle setChatDescription setChatMemberTag setChatMenuButton setChatPermissions setChatPhoto setChatStickerSet setChatTitle setCustomEmojiStickerSetThumbnail setGameScore setManagedBotAccessSettings setMessageReaction setMyCommands setMyDefaultAdministratorRights setMyDescription setMyName setMyProfilePhoto setMyShortDescription setStickerEmojiList setStickerKeywords setStickerMaskPosition setStickerPositionInSet setStickerSetThumbnail setStickerSetTitle setUserEmojiStatus setWebhook stopMessageLiveLocation stopPoll transferBusinessAccountStars transferGift unbanChatMember unbanChatSenderChat unhideGeneralForumTopic unpinAllChatMessages unpinAllForumTopicMessages unpinAllGeneralForumTopicMessages unpinChatMessage upgradeGift uploadStickerFile use verifyChat verifyUser compose

Constructors

constructor

new TelegramBot<C extends Context = Context>(
client: BaseTelegramClient,
): TelegramBot<C>
Type Parameters
- C extends Context = Context
Parameters
- client: BaseTelegramClient
Returns TelegramBot<C>
Overrides Composer.constructor
- Defined in core/bot.ts:23

Methods

_setClient

_setClient(newClient: BaseTelegramClient): void
Internal method used by the utf-build CLI to dynamically inject the GAS API client at runtime. Do not use manually.
Parameters
- newClient: BaseTelegramClient
Returns void
- Defined in core/bot.ts:33

action

action(actionName: string | RegExp, ...middlewares: Middleware<C>[]): this
Registers a handler for inline button clicks (callback_query).
Parameters
- actionName: string | RegExp
  String or regular expression to check callback_data
- ...middlewares: Middleware<C>[]
  Functions that will be executed on a match
Returns this
Inherited from Composer.action
- Defined in core/composer.ts:133

addStickerToSet

addStickerToSet(
    user_id: number,
    name: string,
    sticker: InputSticker,
): Promise<boolean>
Use this method to add a new sticker to a sticker set. Returns True on success.
Parameters
- user_id: number
  User identifier creating the sticker set.
- name: string
  Sticker set name.
- sticker: InputSticker
  Sticker to add. Must be an InputSticker object.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2646

answerCallbackQuery

answerCallbackQuery(
callback_query_id: string,
options?: Omit<AnswerCallbackQueryParams, "callback_query_id">,
): Promise<boolean>
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. Returns True on success.

Alternatively, the user can be redirected to a 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 can use links like t.me/your_bot?start=XXXX which open your bot with a parameter.
Parameters
- callback_query_id: string
  Unique query identifier
- Optionaloptions: Omit<AnswerCallbackQueryParams, "callback_query_id">
  Additional response parameters (text, show_alert, url, etc.)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1497

answerGuestQuery

answerGuestQuery(
guest_query_id: string,
result: InlineQueryResult,
): Promise<SentGuestMessage>
Use this method to reply to a received guest query. On success, a SentGuestMessage object is returned.
Parameters
- guest_query_id: string
  Unique query identifier
- result: InlineQueryResult
  Serialized JSON object describing the message to be sent.
Returns Promise<SentGuestMessage>
SentGuestMessage
- Defined in core/bot.ts:1512

answerInlineQuery

answerInlineQuery(
    inline_query_id: string,
    results: InlineQueryResult[],
    options?: Omit<AnswerInlineQueryParams, "inline_query_id" | "results">,
): Promise<boolean>
Use this method to send answers to an inline query. Returns True on success. No more than 50 results per query are allowed.
Parameters
- inline_query_id: string
  Inline query identifier.
- results: InlineQueryResult[]
  Array of results.
- Optionaloptions: Omit<AnswerInlineQueryParams, "inline_query_id" | "results">
  Additional parameters.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2822

answerPreCheckoutQuery

answerPreCheckoutQuery(
    pre_checkout_query_id: string,
    ok: boolean,
    options?: Omit<
        AnswerPreCheckoutQueryParams,
        "ok"
        | "pre_checkout_query_id",
    >,
): Promise<boolean>
After a user has confirmed their payment and shipping data, the Bot API sends a final confirmation as an update with the pre_checkout_query field. Use this method to answer such pre-checkout queries. Returns True on success.

Note: The Bot API must receive a response within 10 seconds after sending a pre-checkout query.
Parameters
- pre_checkout_query_id: string
  Pre-checkout query identifier.
- ok: boolean
  Whether the response is successful.
- Optionaloptions: Omit<AnswerPreCheckoutQueryParams, "ok" | "pre_checkout_query_id">
  Additional parameters (error_message)
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2908

answerShippingQuery

answerShippingQuery(
    shipping_query_id: string,
    ok: boolean,
    shipping_options?: ShippingOption[],
): Promise<boolean>
If you sent an invoice with a shipping address request and the is_flexible parameter was specified, the Bot API will send the bot an update with the shipping_query field. Use this method to answer shipping queries. Returns True on success.
Parameters
- shipping_query_id: string
  Shipping query identifier.
- ok: boolean
  Whether the response is successful.
- Optionalshipping_options: ShippingOption[]
  Array of shipping options.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2888

answerWebAppQuery

answerWebAppQuery(
web_app_query_id: string,
result: InlineQueryResult,
): Promise<SentWebAppMessage>
Use this method to set the result of an interaction with a web application and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
Parameters
- web_app_query_id: string
  Web App query identifier.
- result: InlineQueryResult
  Web application interaction result.
Returns Promise<SentWebAppMessage>
SentWebAppMessage.
- Defined in core/bot.ts:2268

approveChatJoinRequest

approveChatJoinRequest(
chat_id: string | number,
user_id: number,
): Promise<boolean>
Use this method to approve a chat join request. For this to work, the bot must be a chat administrator and have the can_invite_users administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique user identifier
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:1016

approveSuggestedPost

approveSuggestedPost(
    chat_id: number,
    message_id: number,
    options?: Omit<ApproveSuggestedPostParams, "chat_id" | "message_id">,
): Promise<boolean>
Use this method to approve a suggested post in a direct message chat. The bot must have the can_post_messages administrator right in the corresponding channel chat. Returns True on success.
Parameters
- chat_id: number
  Chat identifier or username.
- message_id: number
  Suggested post identifier.
- Optionaloptions: Omit<ApproveSuggestedPostParams, "chat_id" | "message_id">
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2497

banChatMember

banChatMember(
    chat_id: string | number,
    user_id: number,
    options?: Omit<BanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
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. For this to work, the bot must be an administrator in the chat and have the appropriate administrator rights. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<BanChatMemberParams, "chat_id" | "user_id">
  Additional ban parameters
Returns Promise<boolean>
true on success
- Defined in core/bot.ts:750

banChatSenderChat

banChatSenderChat(
chat_id: string | number,
sender_chat_id: number,
): Promise<boolean>
Use this method to ban a channel chat in a supergroup or channel. Until the chat is unbanned, the owner of the banned chat will not be able to send messages on behalf of any of their channels. For this to work, the bot must be a supergroup or channel administrator and have appropriate administrator rights. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- sender_chat_id: number
  Unique identifier of the sender
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:865

catch

catch(handler: ErrorHandler<C>): this
Parameters
- handler: ErrorHandler<C>
Returns this
Inherited from Composer.catch
- Defined in core/composer.ts:73

close

close(): Promise<boolean>
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method so that the bot doesn't start again after a server restart. The method will return a 429 error during the first 10 minutes after the bot starts. Returns True on success.

Returns Promise<boolean>
True on success
- Defined in core/bot.ts:186

closeForumTopic

closeForumTopic(
chat_id: string | number,
message_thread_id: number,
): Promise<boolean>
Use this method to close an open topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right, unless it is the topic author. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_thread_id: number
  Forum topic identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1341

closeGeneralForumTopic

closeGeneralForumTopic(chat_id: string | number): Promise<boolean>
Use this method to close an open "General" topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1420

command

command(command: string | string[], ...middlewares: Middleware<C>[]): this
Registers a handler for a specific command (or an array of commands).
Parameters
- command: string | string[]
  Command name without the slash (e.g., 'start' or ['start', 'help'])
- ...middlewares: Middleware<C>[]
  Functions that will be executed if the command matches
Returns this
Inherited from Composer.command
- Defined in core/composer.ts:99

convertGiftToStars

convertGiftToStars(
business_connection_id: string,
owned_gift_id: string,
): Promise<boolean>
Converts a regular gift into Telegram Stars. Requires the business bot right can_convert_gifts_to_stars. On success, returns True.
Parameters
- business_connection_id: string
  Business account identifier
- owned_gift_id: string
  Gift identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2135

copyMessage

copyMessage(
    chat_id: string | number,
    from_chat_id: string | number,
    message_id: number,
    options?: Omit<
        CopyMessageParams,
        "chat_id"
        | "message_id"
        | "from_chat_id",
    >,
): Promise<MessageId>
Use this method to copy messages of any type. Service messages and messages with protected content cannot be forwarded. On success, the MessageId of the sent message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- from_chat_id: string | number
  Unique identifier for the chat from which messages are forwarded
- message_id: number
  Identifier of the message in the chat_id chat
- Optionaloptions: Omit<CopyMessageParams, "chat_id" | "message_id" | "from_chat_id">
  Additional copying parameters
Returns Promise<MessageId>
MessageId on success
- Defined in core/bot.ts:274

copyMessages

copyMessages(
    chat_id: string | number,
    from_chat_id: string | number,
    message_ids: number[],
    options?: Omit<
        CopyMessagesParams,
        "chat_id"
        | "from_chat_id"
        | "message_ids",
    >,
): Promise<MessageId[]>
Use this method to copy multiple messages of any type. If some of the specified messages cannot be found or copied, they are skipped. Service messages and messages with protected content cannot be copied. Grouping by albums is preserved for copied messages. On success, an array of MessageId of the copied messages is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- from_chat_id: string | number
  Unique identifier for the chat from which messages are forwarded
- message_ids: number[]
  Message identifiers in the chat_id chat
- Optionaloptions: Omit<CopyMessagesParams, "chat_id" | "from_chat_id" | "message_ids">
  Additional copying parameters
Returns Promise<MessageId[]>
MessageId[] on success
- Defined in core/bot.ts:296

createChatInviteLink

createChatInviteLink(
chat_id: string | number,
options?: Omit<CreateChatInviteLinkParams, "chat_id">,
): Promise<ChatInviteLink>
Use this method to create an additional invite link for a chat. For this to work, the bot must be a chat administrator and have appropriate administrator rights. The link can be revoked using the revokeChatInviteLink method. On success, returns the new invite link as a ChatInviteLink object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaloptions: Omit<CreateChatInviteLinkParams, "chat_id">
Returns Promise<ChatInviteLink>
ChatInviteLink on success
- Defined in core/bot.ts:928

createChatSubscriptionInviteLink

createChatSubscriptionInviteLink(
    chat_id: string | number,
    subscription_period: number,
    subscription_price: number,
    options?: Omit<
        CreateChatSubscriptionInviteLinkParams,
        "chat_id"
        | "subscription_period"
        | "subscription_price",
    >,
): Promise<ChatInviteLink>
Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator right. The link can be edited using the editChatSubscriptionInviteLink method or revoked using the revokeChatInviteLink method. Returns the new invite link as a ChatInviteLink object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- subscription_period: number
- subscription_price: number
- Optionaloptions: Omit<
      CreateChatSubscriptionInviteLinkParams,
      "chat_id"
      | "subscription_period"
      | "subscription_price",
  >
  Parameters for creating the invite link
Returns Promise<ChatInviteLink>
ChatInviteLink on success
- Defined in core/bot.ts:963

createForumTopic

createForumTopic(
    chat_id: string | number,
    name: string,
    options?: Omit<CreateForumTopicParams, "chat_id" | "name">,
): Promise<ForumTopic>
Use this method to create a topic in a forum supergroup chat or in a private chat with a user. In the case of a supergroup chat, the bot must be a chat administrator for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- name: string
  Forum topic name
- Optionaloptions: Omit<CreateForumTopicParams, "chat_id" | "name">
  Additional parameters (icon_custom_emoji_id, etc.)
Returns Promise<ForumTopic>
ForumTopic on success
- Defined in core/bot.ts:1306

createInvoiceLink

createInvoiceLink(
    title: string,
    description: string,
    payload: string,
    currency: string,
    prices: LabeledPrice[],
    options?: Omit<
        CreateInvoiceLinkParams,
        "title"
        | "description"
        | "payload"
        | "currency"
        | "prices",
    >,
): Promise<string>
Use this method to create an invoice link. On success, returns the created invoice link as a string.
Parameters
- title: string
  Invoice title.
- description: string
  Invoice description.
- payload: string
  Internal invoice information.
- currency: string
  Invoice currency.
- prices: LabeledPrice[]
  Invoice prices.
- Optionaloptions: Omit<
      CreateInvoiceLinkParams,
      "title"
      | "description"
      | "payload"
      | "currency"
      | "prices",
  >
  Additional parameters.
Returns Promise<string>
Created invoice link.
- Defined in core/bot.ts:2867

createNewStickerSet

createNewStickerSet(
    user_id: number,
    name: string,
    title: string,
    stickers: InputSticker[],
    options?: Omit<CreateNewStickerSetParams, "title" | "name" | "stickers">,
): Promise<boolean>
Use this method to create a new sticker set belonging to a user. The bot will be able to edit a sticker set created this way. Returns True on success.
Parameters
- user_id: number
  User identifier.
- name: string
  Sticker set name. Must start with a-z, A-Z, or 0-9, and can contain _ and consist of no more than 64 characters.
- title: string
  Sticker set title. Must consist of no more than 64 characters.
- stickers: InputSticker[]
  Array of stickers to add. At least one sticker must be passed.
- Optionaloptions: Omit<CreateNewStickerSetParams, "title" | "name" | "stickers">
  Additional parameters.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2627

declineChatJoinRequest

declineChatJoinRequest(
chat_id: string | number,
user_id: number,
): Promise<boolean>
Use this method to decline a chat join request. For this to work, the bot must be a chat administrator and have the can_invite_users administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique user identifier
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:1032

declineSuggestedPost

declineSuggestedPost(
    chat_id: number,
    message_id: number,
    options?: Omit<DeclineSuggestedPostParams, "chat_id" | "message_id">,
): Promise<boolean>
Use this method to decline a suggested post in a direct message chat. The bot must have the can_manage_direct_messages administrator right in the corresponding channel chat. Returns True on success.
Parameters
- chat_id: number
  Chat identifier.
- message_id: number
  Suggested post identifier.
- Optionaloptions: Omit<DeclineSuggestedPostParams, "chat_id" | "message_id">
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2514

deleteAllMessageReactions

deleteAllMessageReactions(
chat_id: string | number,
options?: Omit<DeleteAllMessageReactionsParams, "chat_id">,
): Promise<boolean>
Use this method to delete up to 10000 recent reactions in a group or supergroup chat added by a specific user or chat. The bot must have the can_delete_messages administrator right in the chat. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaloptions: Omit<DeleteAllMessageReactionsParams, "chat_id">
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1279

deleteBusinessMessages

deleteBusinessMessages(
business_connection_id: string,
message_ids: number[],
): Promise<boolean>
Deletes messages on behalf of a business account. Requires the business bot right can_delete_sent_messages to delete messages sent by the bot itself, or can_delete_all_messages to delete any message. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- message_ids: number[]
  Message identifiers
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1942

deleteChatPhoto

deleteChatPhoto(chat_id: string | number): Promise<boolean>
Use this method to delete a chat profile photo. For this to work, the bot must be a chat administrator. Returns true on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:1062

deleteChatStickerSet

deleteChatStickerSet(chat_id: string | number): Promise<boolean>
Use this method to delete a set of group stickers from a supergroup. For this to work, the bot must be a chat administrator and have appropriate administrator rights. Use the can_set_sticker_set field, which is optionally returned in getChat requests, to check if the bot can use this method. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1246

deleteForumTopic

deleteForumTopic(
chat_id: string | number,
message_thread_id: number,
): Promise<boolean>
Use this method to delete a forum topic along with all its messages in a forum supergroup chat or in a private chat with a user. In the case of a supergroup chat, the bot must be a chat administrator for this to work and must have the can_delete_messages administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_thread_id: number
  Forum topic identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1373

deleteMessage

deleteMessage(chat_id: string | number, message_id: number): Promise<boolean>
Use this method to delete a message, including service messages, with the following restrictions:
- A message can only be deleted if it was sent less than 48 hours ago.
- Service messages about creating a supergroup, channel, or forum topic cannot be deleted.
- 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 the can_post_messages permission can delete outgoing messages in channels.
- If the bot is a group administrator, it can delete any message there.
- If the bot has the can_delete_messages administrator right in a supergroup or channel, it can delete any message there.
- If the bot has the can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct message chat. Returns True on success.
Parameters
- chat_id: string | number
  Chat identifier or username.
- message_id: number
  Message identifier.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2539

deleteMessageReaction

deleteMessageReaction(
    chat_id: string | number,
    message_id: number,
    options?: Omit<DeleteMessageReactionParams, "chat_id" | "message_id">,
): Promise<boolean>
Use this method to delete a reaction from a message in a group or supergroup chat. The bot must have the can_delete_messages administrator right in the chat. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_id: number
  Message identifier
- Optionaloptions: Omit<DeleteMessageReactionParams, "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1262

deleteMessages

deleteMessages(
chat_id: string | number,
message_ids: number[],
): Promise<boolean>
Use this method to delete multiple messages at once. If some of the specified messages cannot be found, they are skipped. Returns True on success.
Parameters
- chat_id: string | number
  Chat identifier or username.
- message_ids: number[]
  Message identifiers.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2555

deleteMyCommands

deleteMyCommands(options?: DeleteMyCommandsParams): Promise<boolean>
Use this method to delete the list of bot commands for a given scope and user language. After deletion, higher-level commands will be shown to affected users. Returns True on success.
Parameters
- Optionaloptions: DeleteMyCommandsParams
  Additional parameters (scope, language_code)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1642

deleteStickerFromSet

deleteStickerFromSet(sticker: string): Promise<boolean>
Use this method to delete a sticker from a sticker set. Returns True on success.
Parameters
- sticker: string
  Sticker identifier.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2676

deleteStickerSet

deleteStickerSet(name: string): Promise<boolean>
Use this method to delete a sticker set created by the bot. Returns True on success.
Parameters
- name: string
  Sticker set name.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2806

deleteStory

deleteStory(business_connection_id: string, story_id: number): Promise<boolean>
Deletes a story previously published by the bot on behalf of a managed business account. Requires the business bot right can_manage_stories. On success, returns True.
Parameters
- business_connection_id: string
  Unique business connection identifier
- story_id: number
  Story identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2253

deleteWebhook

deleteWebhook(options?: DeleteWebhookParams): Promise<boolean>
Use this method to stop using the webhook and start working in long polling mode. Returns True on success.
Parameters
- Optionaloptions: DeleteWebhookParams
  Additional parameters for deleting the webhook
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:145

editChatInviteLink

editChatInviteLink(
    chat_id: string | number,
    invite_link: string,
    options?: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">,
): Promise<ChatInviteLink>
Use this method to edit a non-primary invite link created by the bot. For this to work, the bot must be a chat administrator and have appropriate administrator rights. On success, returns the edited invite link as a ChatInviteLink object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- invite_link: string
  Chat invite link
- Optionaloptions: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">
  Parameters for changing the invite link
Returns Promise<ChatInviteLink>
ChatInviteLink on success
- Defined in core/bot.ts:945

editChatSubscriptionInviteLink

editChatSubscriptionInviteLink(
    chat_id: string | number,
    invite_link: string,
    options?: Omit<
        EditChatSubscriptionInviteLinkParams,
        "chat_id"
        | "invite_link",
    >,
): Promise<ChatInviteLink>
Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator right. On success, returns the edited invite link as a ChatInviteLink object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- invite_link: string
  Chat invite link
- Optionaloptions: Omit<EditChatSubscriptionInviteLinkParams, "chat_id" | "invite_link">
  Parameters for editing the invite link
Returns Promise<ChatInviteLink>
ChatInviteLink on success
- Defined in core/bot.ts:982

editForumTopic

editForumTopic(
    chat_id: string | number,
    message_thread_id: number,
    options?: Omit<EditForumTopicParams, "chat_id" | "message_thread_id">,
): Promise<boolean>
Use this method to edit the name and icon of a topic in a forum supergroup chat or in a private chat with a user. In the case of a supergroup chat, the bot must be a chat administrator for this to work and must have the can_manage_topics administrator right, unless it is the topic author. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_thread_id: number
  Forum topic identifier
- Optionaloptions: Omit<EditForumTopicParams, "chat_id" | "message_thread_id">
  Additional parameters (name, icon_custom_emoji_id)
Returns Promise<boolean>
true on success
- Defined in core/bot.ts:1324

editGeneralForumTopic

editGeneralForumTopic(chat_id: string | number, name: string): Promise<boolean>
Use this method to edit the name of the "General" topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- name: string
  New forum topic name
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1405

editMessageCaption

editMessageCaption(
    id: EditMessageIds,
    options?: Omit<
        EditMessageCaptionParams,
        "chat_id"
        | "message_id"
        | "inline_message_id",
    >,
): Promise<boolean | Message>
Use this method to edit message captions. 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 of being sent.
Parameters
- id: EditMessageIds
  Message identifier (either chat_id and message_id, or inline_message_id)
- Optionaloptions: Omit<EditMessageCaptionParams, "chat_id" | "message_id" | "inline_message_id">
  Additional parameters (caption, parse_mode, etc.)
Returns Promise<boolean | Message>
Edited message or True if editing was successful
- Defined in core/bot.ts:2348

editMessageChecklist

editMessageChecklist(
    business_connection_id: string,
    chat_id: number,
    message_id: number,
    checklist: InputChecklist,
    options?: Omit<
        EditMessageChecklistParams,
        "chat_id"
        | "business_connection_id"
        | "message_id"
        | "checklist",
    >,
): Promise<Message>
Use this method to edit a checklist on behalf of a connected business account. On success, the edited message is returned.
Parameters
- business_connection_id: string
  Business connection identifier.
- chat_id: number
  Chat identifier.
- message_id: number
  Message identifier.
- checklist: InputChecklist
  New checklist.
- Optionaloptions: Omit<
      EditMessageChecklistParams,
      "chat_id"
      | "business_connection_id"
      | "message_id"
      | "checklist",
  >
  Additional parameters
Returns Promise<Message>
Edited message on success.
- Defined in core/bot.ts:2436

editMessageLiveLocation

editMessageLiveLocation(
    id: EditMessageIds,
    latitude: number,
    longitude: number,
    options?: Omit<
        EditMessageLiveLocationParams,
        "chat_id"
        | "message_id"
        | "inline_message_id"
        | "latitude"
        | "longitude",
    >,
): Promise<boolean | Message>
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly prohibited by calling stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Parameters
- id: EditMessageIds
  Message identifier. Can be an object with chat_id and message_id or an inline_message_id string.
- latitude: number
  New location latitude
- longitude: number
  New location longitude
- Optionaloptions: Omit<
      EditMessageLiveLocationParams,
      "chat_id"
      | "message_id"
      | "inline_message_id"
      | "latitude"
      | "longitude",
  >
  Additional parameters
Returns Promise<boolean | Message>
Edited message or True on success.
- Defined in core/bot.ts:2392

editMessageMedia

editMessageMedia(
    id: EditMessageIds,
    media: InputMedia,
    options?: Omit<
        EditMessageMediaParams,
        "chat_id"
        | "message_id"
        | "inline_message_id"
        | "media",
    >,
): Promise<boolean | Message>
Use this method to edit animation, audio, document, photo, or video messages, or to add media files to text messages. If a message is part of a message album, it can only be edited as audio for audio albums, only as a document for document albums, and as a photo or video in other cases. When editing an inline message, a new file cannot 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 of being sent.
Parameters
- id: EditMessageIds
  Message identifier. Can be an object with chat_id and message_id or an inline_message_id string.
- media: InputMedia
- Optionaloptions: Omit<
      EditMessageMediaParams,
      "chat_id"
      | "message_id"
      | "inline_message_id"
      | "media",
  >
  Media message editing parameters. Must include media (InputMediaVideo/InputMediaAnimation/InputMediaAudio/InputMediaPhoto).
Returns Promise<boolean | Message>
Edited message or True on success.
- Defined in core/bot.ts:2369

editMessageReplyMarkup

editMessageReplyMarkup(
    id: EditMessageIds,
    options?: Omit<
        EditMessageReplyMarkupParams,
        "chat_id"
        | "message_id"
        | "inline_message_id",
    >,
): Promise<boolean | Message>
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 of being sent.
Parameters
- id: EditMessageIds
  Message identifier. Can be an object with chat_id and message_id or an inline_message_id string.
- Optionaloptions: Omit<
      EditMessageReplyMarkupParams,
      "chat_id"
      | "message_id"
      | "inline_message_id",
  >
  Additional parameters.
Returns Promise<boolean | Message>
Edited message or True on success.
- Defined in core/bot.ts:2461

editMessageText

editMessageText(
    id: EditMessageIds,
    text: string,
    options?: Omit<
        EditMessageTextParams,
        "text"
        | "chat_id"
        | "message_id"
        | "inline_message_id",
    >,
): Promise<boolean | Message>
Edits a text message or inline message text.
Parameters
- id: EditMessageIds
  Message identifier (either chat_id and message_id, or inline_message_id)
- text: string
  New message text
- Optionaloptions: Omit<
      EditMessageTextParams,
      "text"
      | "chat_id"
      | "message_id"
      | "inline_message_id",
  >
  Additional parameters
Returns Promise<boolean | Message>
Edited message
- Defined in core/bot.ts:2327

editStory

editStory(
    business_connection_id: string,
    story_id: number,
    content: InputStoryContent,
    options?: Omit<
        EditStoryParams,
        "business_connection_id"
        | "content"
        | "story_id",
    >,
): Promise<Story>
Edits a story previously published by the bot on behalf of a managed business account. Requires the business bot right can_manage_stories. Returns Story on success.
Parameters
- business_connection_id: string
  Unique business connection identifier
- story_id: number
  Story identifier
- content: InputStoryContent
  Story content
- Optionaloptions: Omit<EditStoryParams, "business_connection_id" | "content" | "story_id">
  Additional parameters
Returns Promise<Story>
Story on success
- Defined in core/bot.ts:2235

editUserStarSubscription

editUserStarSubscription(
    user_id: number,
    telegram_payment_charge_id: string,
    is_canceled: boolean,
): Promise<boolean>
Allows the bot to cancel or re-enable the renewal of a subscription paid in Telegram Stars. Returns True on success.
Parameters
- user_id: number
  User identifier.
- telegram_payment_charge_id: string
  Telegram payment identifier for the subscription.
- is_canceled: boolean
  Whether the subscription is canceled.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2961

exportChatInviteLink

exportChatInviteLink(chat_id: string | number): Promise<string>
Use this method to create a new primary invite link for a chat; any previously created primary link will be revoked. For this to work, the bot must be a chat administrator and have appropriate administrator rights. On success, returns the new invite link as a string.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<string>
string on success
- Defined in core/bot.ts:913

forwardMessage

forwardMessage(
    chat_id: string | number,
    from_chat_id: string | number,
    message_id: number,
    options?: Omit<
        ForwardMessageParams,
        "chat_id"
        | "message_id"
        | "from_chat_id",
    >,
): Promise<Message>
Use this method to forward messages of any type. Service messages and messages with protected content cannot be forwarded. On success, the sent message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- from_chat_id: string | number
  Unique identifier for the chat from which the message is forwarded
- message_id: number
  Identifier of the message in the from_chat_id chat
- Optionaloptions: Omit<ForwardMessageParams, "chat_id" | "message_id" | "from_chat_id">
  Additional forwarding parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:222

forwardMessages

forwardMessages(
    chat_id: string | number,
    from_chat_id: string | number,
    message_ids: number[],
    options?: Omit<
        ForwardMessagesParams,
        "chat_id"
        | "from_chat_id"
        | "message_ids",
    >,
): Promise<MessageId[]>
Use this method to forward multiple messages of any type. If some of the specified messages cannot be found or forwarded, they are skipped. Service messages and messages with protected content cannot be forwarded. Grouping by albums is preserved for forwarded messages. On success, an array of MessageId of the sent messages is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- from_chat_id: string | number
  Unique identifier for the chat from which messages are forwarded
- message_ids: number[]
  Array of message identifiers in the chat_id chat
- Optionaloptions: Omit<ForwardMessagesParams, "chat_id" | "from_chat_id" | "message_ids">
  Additional forwarding parameters
Returns Promise<MessageId[]>
MessageId[] on success
- Defined in core/bot.ts:249

getAvailableGifts

getAvailableGifts(): Promise<Gifts>
Returns a list of gifts that the bot can send to users and channel chats. No parameters required. Returns a Gifts object on success.

Returns Promise<Gifts>
Gifts object on success
- Defined in core/bot.ts:1823

getBusinessAccountGifts

getBusinessAccountGifts(
business_connection_id: string,
options?: Omit<GetBusinessAccountGiftsParams, "business_connection_id">,
): Promise<OwnedGifts>
Returns received gifts belonging to a managed business account. Requires the business bot right can_view_gifts_and_stars. Returns OwnedGifts on success.
Parameters
- business_connection_id: string
  Business account identifier
- Optionaloptions: Omit<GetBusinessAccountGiftsParams, "business_connection_id">
  Additional parameters
Returns Promise<OwnedGifts>
Received gifts
- Defined in core/bot.ts:2089

getBusinessAccountStarBalance

getBusinessAccountStarBalance(
business_connection_id: string,
): Promise<StarAmount>
Returns the number of Telegram Stars belonging to a managed business account. Requires the business bot right can_view_gifts_and_stars. Returns StarAmount on success.
Parameters
- business_connection_id: string
  Business account identifier
Returns Promise<StarAmount>
Number of stars
- Defined in core/bot.ts:2058

getBusinessConnection

getBusinessConnection(
business_connection_id: string,
): Promise<BusinessConnection>
Use this method to get information about the bot's connection to a business account. Returns a BusinessConnection object on success.
Parameters
- business_connection_id: string
  Unique business connection identifier
Returns Promise<BusinessConnection>
BusinessConnection with connection information
- Defined in core/bot.ts:1541

getChat

getChat(chat_id: string | number): Promise<ChatFullInfo>
Use this method to get up-to-date information about the chat. On success, returns a ChatFullInfo object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<ChatFullInfo>
ChatFullInfo on success
- Defined in core/bot.ts:1170

getChatAdministrators

getChatAdministrators(
chat_id: string | number,
options?: Omit<GetChatAdministratorsParams, "chat_id">,
): Promise<ChatMember[]>
Use this method to get a list of administrators in a chat who are not bots. On success, returns an array of ChatMember objects.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaloptions: Omit<GetChatAdministratorsParams, "chat_id">
  Additional parameters
Returns Promise<ChatMember[]>
ChatMember[] on success
- Defined in core/bot.ts:1184

getChatGifts

getChatGifts(
chat_id: string | number,
options?: Omit<GetChatGiftsParams, "chat_id">,
): Promise<OwnedGifts>
Returns gifts belonging to a chat. Returns OwnedGifts on success.
Parameters
- chat_id: string | number
  Chat identifier with the user
- Optionaloptions: Omit<GetChatGiftsParams, "chat_id">
  Additional parameters
Returns Promise<OwnedGifts>
Received gifts
- Defined in core/bot.ts:2119

getChatMember

getChatMember(chat_id: string | number, user_id: number): Promise<ChatMember>
Use this method to get information about a chat member. The method is guaranteed to work for other users only if the bot is a chat administrator. On success, returns a ChatMember object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  User identifier
Returns Promise<ChatMember>
ChatMember on success
- Defined in core/bot.ts:1213

getChatMemberCount

getChatMemberCount(chat_id: string | number): Promise<number>
Use this method to get the number of members in a chat. Returns int on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<number>
number on success
- Defined in core/bot.ts:1198

getChatMenuButton

getChatMenuButton(chat_id?: number): Promise<MenuButton>
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.
Parameters
- Optionalchat_id: number
  Chat identifier
Returns Promise<MenuButton>
MenuButton object on success
- Defined in core/bot.ts:1783

getCustomEmojiStickers

getCustomEmojiStickers(custom_emoji_ids: string[]): Promise<Sticker[]>
Use this method to get information about custom emoji stickers by their identifiers. Returns an array of Sticker objects.
Parameters
- custom_emoji_ids: string[]
  Sticker identifiers.
Returns Promise<Sticker[]>
Array of Sticker objects.
- Defined in core/bot.ts:2598

getFile

getFile(file_id: string): Promise<File>
Use this method to get basic information about a file and prepare it for downloading. Currently, bots can download files of up to 20 MB in size. On success, a TelegramFile object is returned. The file can be downloaded via the link https://api.telegram.org/file/bot<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.
Parameters
- file_id: string
  Unique file identifier
Returns Promise<File>
TelegramFile with file information
- Defined in core/bot.ts:735

getForumTopicIconStickers

getForumTopicIconStickers(): Promise<Sticker[]>
Use this method to get custom emoji stickers that any user can use as a forum topic icon. Requires no parameters. Returns an array of Sticker objects.

Returns Promise<Sticker[]>
Sticker[] on success
- Defined in core/bot.ts:1292

getGameHighScores

getGameHighScores(
user_id: number,
options?: Omit<GetGameHighScoresParams, "user_id">,
): Promise<GameHighScore[]>
Use this method to get data for high score tables. Returns the score of the specified user and several of their neighbors in the game. Returns an array of GameHighScore objects.

This method will currently return scores for the target user, as well as two of their closest neighbors on each side. It will also return the top three users if the user and their neighbors are not among them. Note that this behavior is subject to change.
Parameters
- user_id: number
  User identifier.
- Optionaloptions: Omit<GetGameHighScoresParams, "user_id">
  Additional parameters.
Returns Promise<GameHighScore[]>
Array of GameHighScore objects with user score information.
- Defined in core/bot.ts:3013

getManagedBotAccessSettings

getManagedBotAccessSettings(user_id: number): Promise<BotAccessSettings>
Use this method to get managed bot access settings. Returns a BotAccessSettings object on success.
Parameters
- user_id: number
  Unique user identifier (managed bot)
Returns Promise<BotAccessSettings>
BotAccessSettings with access settings
- Defined in core/bot.ts:1580

getManagedBotToken

getManagedBotToken(user_id: number): Promise<string>
Use this method to get a managed bot token. Returns the token as a string on success.
Parameters
- user_id: number
  Unique user identifier (managed bot)
Returns Promise<string>
string token as a string
- Defined in core/bot.ts:1554

getMe

getMe(): Promise<User>
Use this method to get information about the bot. Returns User.

Returns Promise<User>
User on success
- Defined in core/bot.ts:164

getMyCommands

getMyCommands(options?: GetMyCommandsParams): Promise<BotCommand[]>
Use this method to get the current list of bot commands for a given scope and user language. Returns an array of BotCommand objects. If commands are not set, an empty list is returned.
Parameters
- Optionaloptions: GetMyCommandsParams
  Additional parameters (scope, language_code)
Returns Promise<BotCommand[]>
Array of BotCommand objects
- Defined in core/bot.ts:1656

getMyDefaultAdministratorRights

getMyDefaultAdministratorRights(
options?: GetMyDefaultAdministratorRightsParams,
): Promise<ChatAdministratorRights>
Use this method to get the bot's current default administrator rights. Returns ChatAdministratorRights on success.
Parameters
- Optionaloptions: GetMyDefaultAdministratorRightsParams
  Additional parameters (for_channels)
Returns Promise<ChatAdministratorRights>
ChatAdministratorRights object on success
- Defined in core/bot.ts:1810

getMyDescription

getMyDescription(options?: GetMyDescriptionParams): Promise<BotDescription>
Use this method to get the current bot description for a given user language. Returns BotDescription on success.
Parameters
- Optionaloptions: GetMyDescriptionParams
  Additional parameters (language_code)
Returns Promise<BotDescription>
BotDescription object on success
- Defined in core/bot.ts:1708

getMyName

getMyName(options?: GetMyNameParams): Promise<BotName>
Use this method to get the current bot name for a given user language. Returns BotName on success.
Parameters
- Optionaloptions: GetMyNameParams
  Additional parameters (language_code)
Returns Promise<BotName>
BotName object on success
- Defined in core/bot.ts:1682

getMyShortDescription

getMyShortDescription(
options?: GetMyShortDescriptionParams,
): Promise<BotShortDescription>
Use this method to get the current bot short description for a given user language. Returns BotShortDescription on success.
Parameters
- Optionaloptions: GetMyShortDescriptionParams
  Additional parameters (language_code)
Returns Promise<BotShortDescription>
BotShortDescription object on success
- Defined in core/bot.ts:1734

getMyStarBalance

getMyStarBalance(): Promise<StarAmount>
Method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

Returns Promise<StarAmount>
StarAmount object.
- Defined in core/bot.ts:2923

getStarTransactions

getStarTransactions(
options?: GetStarTransactionsParams,
): Promise<StarTransactions>
Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
Parameters
- Optionaloptions: GetStarTransactionsParams
  Parameters for filtering transactions.
Returns Promise<StarTransactions>
StarTransactions object with transaction information.
- Defined in core/bot.ts:2934

getStickerSet

getStickerSet(name: string): Promise<StickerSet>
Use this method to get a sticker set. On success, a StickerSet object is returned.
Parameters
- name: string
  Sticker set name.
Returns Promise<StickerSet>
StickerSet.
- Defined in core/bot.ts:2586

getUpdates

getUpdates(options?: GetUpdatesParams): Promise<Update[]>
Use this method to receive incoming updates using long polling. Returns an array of Update objects.
Parameters
- options: GetUpdatesParams = {}
  Additional parameters for receiving updates
Returns Promise<Update[]>
Update[] on success
- Defined in core/bot.ts:114

getUserChatBoosts

getUserChatBoosts(
chat_id: string | number,
user_id: number,
): Promise<UserChatBoosts>
Use this method to get information about boosts provided by a chat user. Returns UserChatBoosts on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique user identifier
Returns Promise<UserChatBoosts>
UserChatBoosts
- Defined in core/bot.ts:1527

getUserGifts

getUserGifts(
user_id: number,
options?: Omit<GetUserGiftsParams, "user_id">,
): Promise<OwnedGifts>
Returns gifts owned and displayed by a user. Returns OwnedGifts on success.
Parameters
- user_id: number
  User identifier
- Optionaloptions: Omit<GetUserGiftsParams, "user_id">
  Additional parameters
Returns Promise<OwnedGifts>
Received gifts
- Defined in core/bot.ts:2104

getUserPersonalChatMessages

getUserPersonalChatMessages(user_id: number, limit: number): Promise<Message[]>
Use this method to get recent messages from a given user's personal chat. Returns an array of Message objects on success.
Parameters
- user_id: number
  Unique user identifier
- limit: number
  Maximum number of messages to return; 1-20
Returns Promise<Message[]>
Array of Message objects
- Defined in core/bot.ts:1611

getUserProfileAudios

getUserProfileAudios(
user_id: number,
options?: Omit<GetUserProfileAudiosParams, "user_id">,
): Promise<UserProfileAudios>
Use this method to get a list of user profile audio. Returns a UserProfileAudios object.
Parameters
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<GetUserProfileAudiosParams, "user_id">
  Additional profile audio parameters
Returns Promise<UserProfileAudios>
UserProfileAudios on success
- Defined in core/bot.ts:702

getUserProfilePhotos

getUserProfilePhotos(
user_id: number,
options?: Omit<GetUserProfilePhotosParams, "user_id">,
): Promise<UserProfilePhotos>
Use this method to get a list of user profile photos. Returns a UserProfilePhotos object with user photos, starting from the newest.
Parameters
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<GetUserProfilePhotosParams, "user_id">
  Additional profile photo parameters
Returns Promise<UserProfilePhotos>
UserProfilePhotos on success
- Defined in core/bot.ts:687

getWebhookInfo

getWebhookInfo(): Promise<WebhookInfo>
Use this method to get current information about the webhook set for your bot. Returns WebhookInfo.

Returns Promise<WebhookInfo>
WebhookInfo on success
- Defined in core/bot.ts:154

giftPremiumSubscription

giftPremiumSubscription(
    user_id: number,
    month_count: number,
    star_count: number,
    options?: Omit<
        GiftPremiumSubscriptionParams,
        "user_id"
        | "star_count"
        | "month_count",
    >,
): Promise<boolean>
Gifts a Telegram Premium subscription to a specified user. Returns True on success.
Parameters
- user_id: number
  User identifier
- month_count: number
  Number of subscription months
- star_count: number
  Number of stars
- Optionaloptions: Omit<GiftPremiumSubscriptionParams, "user_id" | "star_count" | "month_count">
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1852

handleUpdate

handleUpdate(update: Update): Promise<void>
Main method for processing incoming Updates from Telegram. It automatically creates a base Context object and starts the middleware chain.
- ⚠️ Architectural note regarding custom context (Generic C): This library uses the approach of extending context through interfaces and middlewares (so-called hydration), rather than through class inheritance. Under the hood, a base instance of Context is always created, which is forcibly cast to your type C.
- To add your own fields (e.g., sessions, DB connections, etc.), describe them in an interface and initialize them in your first middleware:
Parameters
- update: Update
  Incoming update from Telegram
Returns Promise<void>
Promise<void>
Example
```
interface MyContext extends Context {
db: CustomDatabase;
session: { step: number };
}
const bot = new TelegramBot<MyContext>(client);
* // Context hydration
bot.use(async (ctx, next) => {
ctx.db = new CustomDatabase();
ctx.session = { step: 0 };
await next();
});
```
- Defined in core/bot.ts:61

hideGeneralForumTopic

hideGeneralForumTopic(chat_id: string | number): Promise<boolean>
Use this method to hide the "General" topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right. The topic will be automatically closed if it was open. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1450

launch

launch(
    options?: {
        allowed_updates?: string[];
        drop_pending_updates?: boolean;
        timeout?: number;
    },
): Promise<void>
Parameters
- options: { allowed_updates?: string[]; drop_pending_updates?: boolean; timeout?: number } = {}
Returns Promise<void>
- Defined in core/bot.ts:72

leaveChat

leaveChat(chat_id: string | number): Promise<boolean>
Use this method for your bot to leave a group, supergroup, or channel. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1157

logOut

logOut(): Promise<boolean>
Use this method to log out the bot. Returns boolean.

Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:174

middleware

middleware(): Middleware<C>
Returns all handlers registered in this class as one large function. Wrapped in try...catch to intercept errors.

Returns Middleware<C>
Inherited from Composer.middleware
- Defined in core/composer.ts:236

on

on<F extends UpdateFilter>(
filter: F | F[],
...middlewares: Middleware<NarrowedContext<C, F>>[],
): this
Registers a handler that will trigger under certain conditions (update type, presence of a field or entity).
Type Parameters
- F extends UpdateFilter
Parameters
- filter: F | F[]
  Field name or array of names (e.g., 'photo', 'document', 'callback_query')
- ...middlewares: Middleware<NarrowedContext<C, F>>[]
  Handler functions that will be executed on a match
Returns this
Inherited from Composer.on
- Defined in core/composer.ts:163

pinChatMessage

pinChatMessage(
    chat_id: string | number,
    message_id: number,
    options?: Omit<PinChatMessageParams, "chat_id" | "message_id">,
): Promise<boolean>
Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct message chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the can_pin_messages or can_edit_messages right to pin messages in groups and channels respectively. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_id: number
  Identifier of the message to pin
- Optionaloptions: Omit<PinChatMessageParams, "chat_id" | "message_id">
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1110

postStory

postStory(
    business_connection_id: string,
    content: InputStoryContent,
    active_period: number,
    options?: Omit<
        PostStoryParams,
        "business_connection_id"
        | "content"
        | "active_period",
    >,
): Promise<Story>
Posts a story on behalf of a managed business account. Requires the business bot right can_manage_stories. Returns Story on success.
Parameters
- business_connection_id: string
  Unique business connection identifier
- content: InputStoryContent
  Story content
- active_period: number
  Story duration (from 1 to 72 hours)
- Optionaloptions: Omit<PostStoryParams, "business_connection_id" | "content" | "active_period">
  Additional parameters
Returns Promise<Story>
Story on success
- Defined in core/bot.ts:2192

promoteChatMember

promoteChatMember(
    chat_id: string | number,
    user_id: number,
    options?: Omit<PromoteChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Use this method to promote or demote a user in a supergroup or a channel. For this to work, the bot must be a chat administrator and have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the chat or username of the target bot
- user_id: number
  Unique user identifier
- Optionaloptions: Omit<PromoteChatMemberParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:811

readBusinessMessage

readBusinessMessage(
    business_connection_id: string,
    chat_id: number,
    message_id: number,
): Promise<boolean>
Marks an incoming message as read on behalf of a business account. Requires the business bot right can_read_messages. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- chat_id: number
  Chat identifier
- message_id: number
  Message identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1925

refundStarPayment

refundStarPayment(
user_id: number,
telegram_payment_charge_id: string,
): Promise<boolean>
Refunds a successful payment in Telegram Stars. Returns True on success.
Parameters
- user_id: number
  User identifier.
- telegram_payment_charge_id: string
  Telegram payment transaction identifier.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2948

removeBusinessAccountProfilePhoto

removeBusinessAccountProfilePhoto(
    business_connection_id: string,
    options?: Omit<
        RemoveBusinessAccountProfilePhotoParams,
        "business_connection_id",
    >,
): Promise<boolean>
Deletes the current profile photo of a managed business account. Requires the business bot right can_edit_profile_photo. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- Optionaloptions: Omit<RemoveBusinessAccountProfilePhotoParams, "business_connection_id">
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2025

removeChatVerification

removeChatVerification(chat_id: string | number): Promise<boolean>
Revokes a chat verification established by the bot on behalf of an organization. Returns True on success.
Parameters
- chat_id: string | number
  Chat identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1909

removeMyProfilePhoto

removeMyProfilePhoto(): Promise<boolean>
Use this method to delete the bot's profile photo. Returns True on success.

Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1759

removeUserVerification

removeUserVerification(user_id: number): Promise<boolean>
Revokes a user verification established by the bot on behalf of an organization. Returns True on success.
Parameters
- user_id: number
  User identifier
Returns Promise<boolean>
true on success
- Defined in core/bot.ts:1898

reopenForumTopic

reopenForumTopic(
chat_id: string | number,
message_thread_id: number,
): Promise<boolean>
Use this method to reopen a closed topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right, unless it is the topic author. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_thread_id: number
  Forum topic identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1357

reopenGeneralForumTopic

reopenGeneralForumTopic(chat_id: string | number): Promise<boolean>
Use this method to reopen a closed "General" topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right. The topic will be automatically shown if it was hidden. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1435

replaceManagedBotToken

replaceManagedBotToken(user_id: number): Promise<string>
Use this method to revoke the current managed bot token and generate a new one. Returns the new token as a string on success.
Parameters
- user_id: number
  Unique user identifier (managed bot)
Returns Promise<string>
New token as a string
- Defined in core/bot.ts:1567

replaceStickerInSet

replaceStickerInSet(
    user_id: number,
    name: string,
    old_sticker: string,
    sticker: InputSticker,
): Promise<boolean>
Use this method to replace a sticker in a sticker set. Returns True on success.
Parameters
- user_id: number
  User identifier creating the sticker set.
- name: string
  Sticker set name.
- old_sticker: string
  Identifier of the sticker to be replaced.
- sticker: InputSticker
  New sticker. Must be an InputSticker object.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2692

repostStory

repostStory(
    business_connection_id: string,
    from_chat_id: number,
    from_story_id: number,
    active_period: number,
    options?: Omit<
        RepostStoryParams,
        | "business_connection_id"
        | "from_chat_id"
        | "active_period"
        | "from_story_id",
    >,
): Promise<Story>
Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story in the source account must be published (or reposted) by the bot. Requires the business bot right can_manage_stories for both business accounts. Returns Story on success.
Parameters
- business_connection_id: string
  Business account identifier.
- from_chat_id: number
  Source chat identifier.
- from_story_id: number
  Source story identifier.
- active_period: number
  Story duration.
- Optionaloptions: Omit<
      RepostStoryParams,
      | "business_connection_id"
      | "from_chat_id"
      | "active_period"
      | "from_story_id",
  >
  Additional parameters.
Returns Promise<Story>
Story on success.
- Defined in core/bot.ts:2214

restrictChatMember

restrictChatMember(
    chat_id: string | number,
    user_id: number,
    permissions: ChatPermissions,
    options?: Omit<
        RestrictChatMemberParams,
        "chat_id"
        | "user_id"
        | "permissions",
    >,
): Promise<boolean>
Use this method to restrict a user in a supergroup. For this to work, the bot must be a supergroup administrator and have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user.
Parameters
- chat_id: string | number
  Unique identifier for the chat or username of the target bot
- user_id: number
  Unique user identifier
- permissions: ChatPermissions
  New status of user rights
- Optionaloptions: Omit<RestrictChatMemberParams, "chat_id" | "user_id" | "permissions">
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:791

revokeChatInviteLink

revokeChatInviteLink(
chat_id: string | number,
invite_link: string,
): Promise<ChatInviteLink>
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. For this to work, the bot must be a chat administrator and have appropriate administrator rights. On success, returns the revoked invite link as a ChatInviteLink object.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- invite_link: string
  Chat invite link
Returns Promise<ChatInviteLink>
ChatInviteLink on success
- Defined in core/bot.ts:1000

savePreparedInlineMessage

savePreparedInlineMessage(
    user_id: number,
    result: InlineQueryResult,
    options?: Omit<SavePreparedInlineMessageParams, "user_id" | "result">,
): Promise<PreparedInlineMessage>
Saves a message that can be sent by a mini-app user. Returns a PreparedInlineMessage object.
Parameters
- user_id: number
  User identifier
- result: InlineQueryResult
  Inline query result
- Optionaloptions: Omit<SavePreparedInlineMessageParams, "user_id" | "result">
Returns Promise<PreparedInlineMessage>
PreparedInlineMessage with the prepared message ID
- Defined in core/bot.ts:2284

savePreparedKeyboardButton

savePreparedKeyboardButton(
user_id: number,
button: KeyboardButton,
): Promise<PreparedKeyboardButton>
Saves a keyboard button that can be used by a mini-app user. Returns a PreparedKeyboardButton object.
Parameters
- user_id: number
  User identifier
- button: KeyboardButton
  Keyboard button
Returns Promise<PreparedKeyboardButton>
PreparedKeyboardButton with the prepared button ID
- Defined in core/bot.ts:2301

sendAnimation

sendAnimation(
    chat_id: string | number,
    animation: string | InputFile,
    options?: Omit<SendAnimationParams, "chat_id" | "animation">,
): Promise<Message>
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 up to 50 MB, this limit may be changed in the future.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- animation: string | InputFile
  Animation to send (File ID, URL or file object)
- Optionaloptions: Omit<SendAnimationParams, "chat_id" | "animation">
  Additional animation parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:413

sendAudio

sendAudio(
    chat_id: string | number,
    audio: string | InputFile,
    options?: Omit<SendAudioParams, "chat_id" | "audio">,
): Promise<Message>
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio file must be in the .MP3 or .M4A format. On success, the sent message is returned. Bots can currently send audio files up to 50 MB, this limit may be changed in the future. For sending voice messages, use the sendVoice method.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- audio: string | InputFile
  Audio to send (File ID, URL or file object)
- Optionaloptions: Omit<SendAudioParams, "chat_id" | "audio">
  Additional audio parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:358

sendChatAction

sendChatAction(
    chat_id: string | number,
    action: ChatAction,
    options?: Omit<SendChatActionParams, "chat_id" | "action">,
): Promise<boolean>
Use this method when you need to inform 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: ImageBot needs some time to process the request and upload the image. Instead of sending a text message like "Getting image, please wait...", the bot can use sendChatAction with action = 'upload_photo'. The user will see the bot status "uploading photo".
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- action: ChatAction
  Type of action to broadcast
- Optionaloptions: Omit<SendChatActionParams, "chat_id" | "action">
  Additional action parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:651

sendChecklist

sendChecklist(
    business_connection_id: string,
    chat_id: number,
    checklist: InputChecklist,
    options?: Omit<
        SendChecklistParams,
        "chat_id"
        | "business_connection_id"
        | "checklist",
    >,
): Promise<Message>
Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
Parameters
- business_connection_id: string
  Business account identifier
- chat_id: number
  Unique identifier for the target chat
- checklist: InputChecklist
  Checklist to send
- Optionaloptions: Omit<SendChecklistParams, "chat_id" | "business_connection_id" | "checklist">
  Additional checklist parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:594

sendContact

sendContact(
    chat_id: string | number,
    phone_number: string,
    first_name: string,
    options?: Omit<
        SendContactParams,
        "chat_id"
        | "phone_number"
        | "first_name",
    >,
): Promise<Message>
Use this method to send user contact information. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- phone_number: string
  Phone number
- first_name: string
  Contact first name
- Optionaloptions: Omit<SendContactParams, "chat_id" | "phone_number" | "first_name">
  Additional contact parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:551

sendDice

sendDice(
chat_id: string | number,
options?: Omit<SendDiceParams, "chat_id">,
): Promise<Message>
Use this method to send an animated emoji that will display a random value. Returns Message on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaloptions: Omit<SendDiceParams, "chat_id">
  Additional animated emoji parameters (emoji, etc.)
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:611

sendDocument

sendDocument(
    chat_id: string | number,
    document: string | InputFile,
    options?: Omit<SendDocumentParams, "chat_id" | "document">,
): Promise<Message>
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type up to 50 MB, this limit may be changed in the future.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- document: string | InputFile
  File to send (File ID, URL or file object)
- Optionaloptions: Omit<SendDocumentParams, "chat_id" | "document">
  Additional file parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:376

sendGame

sendGame(
    chat_id: number,
    game_short_name: string,
    options?: Omit<SendGameParams, "chat_id" | "game_short_name">,
): Promise<Message>
Use this method to send a game. On success, the sent message is returned.
Parameters
- chat_id: number
  Chat identifier.
- game_short_name: string
  Game short name.
- Optionaloptions: Omit<SendGameParams, "chat_id" | "game_short_name">
  Additional parameters.
Returns Promise<Message>
Message object.
- Defined in core/bot.ts:2974

sendGift

sendGift(
gift_id: string,
options: Omit<SendGiftParams, "gift_id">,
): Promise<boolean>
Sends a gift to a specified user or channel chat. The recipient cannot convert the gift into Telegram Stars. Returns True on success.
Parameters
- gift_id: string
  Unique gift identifier
- options: Omit<SendGiftParams, "gift_id">
  Additional parameters (chat_id, gift_item_name, user_id)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1836

sendInvoice

sendInvoice(
    chat_id: string | number,
    title: string,
    description: string,
    payload: string,
    currency: string,
    prices: LabeledPrice[],
    options?: Omit<
        SendInvoiceParams,
        "chat_id"
        | "title"
        | "description"
        | "payload"
        | "currency"
        | "prices",
    >,
): Promise<Message>
Use this method to send invoices. On success, the sent message is returned.
Parameters
- chat_id: string | number
  Chat identifier.
- title: string
  Invoice title.
- description: string
  Invoice description.
- payload: string
  Internal invoice information.
- currency: string
  Invoice currency.
- prices: LabeledPrice[]
  Invoice prices.
- Optionaloptions: Omit<
      SendInvoiceParams,
      "chat_id"
      | "title"
      | "description"
      | "payload"
      | "currency"
      | "prices",
  >
  Additional parameters.
Returns Promise<Message>
Sent message.
- Defined in core/bot.ts:2843

sendLivePhoto

sendLivePhoto(
    chat_id: string | number,
    live_photo: string | InputFile,
    photo: string | InputFile,
    options?: Omit<SendLivePhotoParams, "chat_id" | "photo" | "live_photo">,
): Promise<Message>
Use this method to send photos in real time. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- live_photo: string | InputFile
  Video part of a live photo (URL or InputFile)
- photo: string | InputFile
  Photo (URL or InputFile)
- Optionaloptions: Omit<SendLivePhotoParams, "chat_id" | "photo" | "live_photo">
  Additional sending parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/bot.ts:315

sendLocation

sendLocation(
    chat_id: string | number,
    latitude: number,
    longitude: number,
    options?: Omit<SendLocationParams, "chat_id" | "latitude" | "longitude">,
): Promise<Message>
Use this method to send a point on the map. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- latitude: number
  Latitude
- longitude: number
  Longitude
- Optionaloptions: Omit<SendLocationParams, "chat_id" | "latitude" | "longitude">
  Additional geolocation parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:509

sendMediaGroup

sendMediaGroup(
    chat_id: string | number,
    media:
        | InputMediaAudio[]
        | InputMediaDocument[]
        | (InputMediaLivePhoto | InputMediaPhoto | InputMediaVideo)[],
    options?: Omit<SendMediaGroupParams, "chat_id" | "media">,
): Promise<Message[]>
Use this method to send a group of photos, videos, documents, or audio as an album. Documents and audio files can only be grouped in an album with messages of the same type. On success, an array of the sent Message objects is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- media:
      | InputMediaAudio[]
      | InputMediaDocument[]
      | (InputMediaLivePhoto | InputMediaPhoto | InputMediaVideo)[]
  Array of media files to send
- Optionaloptions: Omit<SendMediaGroupParams, "chat_id" | "media">
  Additional media file parameters
Returns Promise<Message[]>
Message[] on success
- Defined in core/bot.ts:488

sendMessage

sendMessage(
    chat_id: string | number,
    text: string,
    options?: Omit<SendMessageParams, "text" | "chat_id">,
): Promise<Message>
Use this method to send a text message. Returns Message.
Parameters
- chat_id: string | number
  Unique identifier for the target chat or channel username (in the format @channelusername)
- text: string
  Message text to send (1-4096 characters after entity parsing)
- Optionaloptions: Omit<SendMessageParams, "text" | "chat_id">
  Additional message parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:199

sendMessageDraft

sendMessageDraft(
    chat_id: number,
    draft_id: number,
    text: string,
    options?: Omit<SendMessageDraftParams, "text" | "chat_id" | "draft_id">,
): Promise<boolean>
Use this method to stream a part of a message to the user during its generation. Returns boolean on success.
Parameters
- chat_id: number
  Unique identifier for the target chat
- draft_id: number
  Unique draft identifier
- text: string
  Message text
- Optionaloptions: Omit<SendMessageDraftParams, "text" | "chat_id" | "draft_id">
  Additional draft parameters
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:628

sendPaidMedia

sendPaidMedia(
    chat_id: string | number,
    star_count: number,
    media: InputPaidMedia[],
    options?: Omit<SendPaidMediaParams, "chat_id" | "media" | "star_count">,
): Promise<Message>
Use this method to send paid media files. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- star_count: number
  Number of stars to send
- media: InputPaidMedia[]
  Array of paid media files
- Optionaloptions: Omit<SendPaidMediaParams, "chat_id" | "media" | "star_count">
  Additional paid media parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:469

sendPhoto

sendPhoto(
    chat_id: string | number,
    photo: string | InputFile,
    options?: Omit<SendPhotoParams, "chat_id" | "photo">,
): Promise<Message>
Use this method to send photos. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- photo: string | InputFile
  Photo to send (File ID, URL or file object)
- Optionaloptions: Omit<SendPhotoParams, "chat_id" | "photo">
  Additional photo parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:338

sendPoll

sendPoll(
    chat_id: string | number,
    question: string,
    poll_options: InputPollOption[],
    options?: Omit<SendPollParams, "chat_id" | "question" | "options">,
): Promise<Message>
Use this method to send a poll. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- question: string
  Poll text
- poll_options: InputPollOption[]
  Array of answer options
- Optionaloptions: Omit<SendPollParams, "chat_id" | "question" | "options">
  Additional poll parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:570

sendSticker

sendSticker(
    chat_id: string | number,
    sticker: string | InputFile,
    options?: Omit<SendStickerParams, "chat_id" | "sticker">,
): Promise<Message>
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent message is returned.
Parameters
- chat_id: string | number
  Chat identifier or username.
- sticker: string | InputFile
  Sticker to send. Can be file_id, url, or InputFile.
- Optionaloptions: Omit<SendStickerParams, "chat_id" | "sticker">
  Additional parameters.
Returns Promise<Message>
Sent message.
- Defined in core/bot.ts:2571

sendVenue

sendVenue(
    chat_id: string | number,
    latitude: number,
    longitude: number,
    title: string,
    address: string,
    options?: Omit<
        SendVenueParams,
        "chat_id"
        | "title"
        | "latitude"
        | "longitude"
        | "address",
    >,
): Promise<Message>
Use this method to send venue information. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- latitude: number
  Latitude
- longitude: number
  Longitude
- title: string
  Venue name
- address: string
  Address
- Optionaloptions: Omit<
      SendVenueParams,
      "chat_id"
      | "title"
      | "latitude"
      | "longitude"
      | "address",
  >
  Additional venue parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:530

sendVideo

sendVideo(
    chat_id: string | number,
    video: string | InputFile,
    options?: Omit<SendVideoParams, "chat_id" | "video">,
): Promise<Message>
Use this method to send video files. Telegram clients support MPEG4 video (other formats can be sent as a document). On success, the sent Message is returned. Bots can currently send video files up to 50 MB, this limit may be changed in the future.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- video: string | InputFile
  Video to send (File ID, URL or file object)
- Optionaloptions: Omit<SendVideoParams, "chat_id" | "video">
  Additional video parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:395

sendVideoNote

sendVideoNote(
    chat_id: string | number,
    video_note: string | InputFile,
    options?: Omit<SendVideoNoteParams, "chat_id" | "video_note">,
): Promise<Message>
Use this method to send video messages (videos up to 60 seconds long). Currently, video message duration is limited to 60 seconds, but this limit may be changed in the future. Bots can currently send video messages up to 50 MB, this limit may be changed in the future. On success, the sent Message is returned.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- video_note: string | InputFile
  Video message to send (File ID, URL or file object)
- Optionaloptions: Omit<SendVideoNoteParams, "chat_id" | "video_note">
  Additional video message parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:451

sendVoice

sendVoice(
    chat_id: string | number,
    voice: string | InputFile,
    options?: Omit<SendVoiceParams, "chat_id" | "voice">,
): Promise<Message>
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, or in .MP3 or .M4A format (other formats may be sent as audio or document). On success, the sent message is returned. Bots can currently send voice messages up to 50 MB, this limit may be changed in the future.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- voice: string | InputFile
  Audio to send (File ID, URL or file object)
- Optionaloptions: Omit<SendVoiceParams, "chat_id" | "voice">
  Additional audio parameters
Returns Promise<Message>
Message on success
- Defined in core/bot.ts:432

setBusinessAccountBio

setBusinessAccountBio(
business_connection_id: string,
options?: Omit<SetBusinessAccountBioParams, "business_connection_id">,
): Promise<boolean>
Changes the bio of a managed business account. Requires the business bot right can_change_bio. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- Optionaloptions: Omit<SetBusinessAccountBioParams, "business_connection_id">
  Additional parameters (bio)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1992

setBusinessAccountGiftSettings

setBusinessAccountGiftSettings(
    business_connection_id: string,
    show_gift_button: boolean,
    accepted_gift_types: AcceptedGiftTypes,
): Promise<boolean>
Changes the privacy settings regarding incoming gifts in a managed business account. Requires the business bot right can_change_gift_settings. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- show_gift_button: boolean
  Show gift button
- accepted_gift_types: AcceptedGiftTypes
  Accepted gift types
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2042

setBusinessAccountName

setBusinessAccountName(
    business_connection_id: string,
    first_name: string,
    options?: Omit<
        SetBusinessAccountNameParams,
        "business_connection_id"
        | "first_name",
    >,
): Promise<boolean>
Changes the first and last name of a managed business account. Requires the business bot right can_change_name. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- first_name: string
  New first name of the managed business account
- Optionaloptions: Omit<SetBusinessAccountNameParams, "business_connection_id" | "first_name">
  Additional parameters (last_name)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1959

setBusinessAccountProfilePhoto

setBusinessAccountProfilePhoto(
    business_connection_id: string,
    photo: InputProfilePhoto,
    options?: Omit<
        SetBusinessAccountProfilePhotoParams,
        "business_connection_id"
        | "photo",
    >,
): Promise<boolean>
Changes the profile photo of a managed business account. Requires the business bot right can_edit_profile_photo. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- photo: InputProfilePhoto
  Managed business account photo
- Optionaloptions: Omit<SetBusinessAccountProfilePhotoParams, "business_connection_id" | "photo">
  Additional parameters (photo)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2009

setBusinessAccountUsername

setBusinessAccountUsername(
business_connection_id: string,
options?: Omit<SetBusinessAccountUsernameParams, "business_connection_id">,
): Promise<boolean>
Changes the username of a managed business account. Requires the business bot right can_change_username. On success, returns True.
Parameters
- business_connection_id: string
  Business account identifier
- Optionaloptions: Omit<SetBusinessAccountUsernameParams, "business_connection_id">
  Additional parameters (username)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1976

setChatAdministratorCustomTitle

setChatAdministratorCustomTitle(
    chat_id: string | number,
    user_id: number,
    custom_title: string,
): Promise<boolean>
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. For this to work, the bot must be a chat administrator and have appropriate administrator rights. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique identifier for the target user
- custom_title: string
  Custom title for the chat administrator
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:829

setChatDescription

setChatDescription(
chat_id: string | number,
description?: string,
): Promise<boolean>
Use this method to change the description of a group, supergroup, or channel. For this to work, the bot must be a chat administrator and have appropriate administrator rights. Returns true on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaldescription: string
  New chat description
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1093

setChatMemberTag

setChatMemberTag(
    chat_id: string | number,
    user_id: number,
    options?: Omit<SetChatMemberTagParams, "chat_id" | "user_id">,
): Promise<boolean>
Use this method to set a tag for a regular group or supergroup member. For this to work, the bot must be a chat administrator and have the can_manage_tags administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<SetChatMemberTagParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:847

setChatMenuButton

setChatMenuButton(options?: SetChatMenuButtonParams): Promise<boolean>
Use this method to change the bot's menu button in a private chat or the default menu button. Returns True on success.
Parameters
- Optionaloptions: SetChatMenuButtonParams
  Additional parameters (chat_id, menu_button)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1770

setChatPermissions

setChatPermissions(
    chat_id: string | number,
    permissions: ChatPermissions,
    options?: Omit<SetChatPermissionsParams, "chat_id" | "permissions">,
): Promise<boolean>
Use this method to set default chat permissions for all participants. For this to work, the bot must be a group or supergroup administrator and have the can_restrict_members administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- permissions: ChatPermissions
  New status of user rights
- Optionaloptions: Omit<SetChatPermissionsParams, "chat_id" | "permissions">
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:897

setChatPhoto

setChatPhoto(chat_id: string | number, photo: InputFile): Promise<boolean>
Use this method to upload a new profile photo for a chat. For this to work, the bot must be a chat administrator.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- photo: InputFile
  Photo to upload.
Returns Promise<boolean>
true on success
- Defined in core/bot.ts:1047

setChatStickerSet

setChatStickerSet(
chat_id: string | number,
sticker_set_name: string,
): Promise<boolean>
Use this method to set a new set of group stickers for a supergroup. For this to work, the bot must be a chat administrator and have appropriate administrator rights. Use the can_set_sticker_set field, which is optionally returned in getChat requests, to check if the bot can use this method. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- sticker_set_name: string
  Sticker set name
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1230

setChatTitle

setChatTitle(chat_id: string | number, title: string): Promise<boolean>
Use this method to change the chat title. Titles cannot be changed for private chats. For this to work, the bot must be a chat administrator and have appropriate administrator rights. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- title: string
  New chat title
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1077

setCustomEmojiStickerSetThumbnail

setCustomEmojiStickerSetThumbnail(
name: string,
custom_emoji_id: string,
): Promise<boolean>
Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
Parameters
- name: string
  Sticker set name.
- custom_emoji_id: string
  Emoji identifier.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2792

setGameScore

setGameScore(
    user_id: number,
    score: number,
    options?: Omit<SetGameScoreParams, "user_id" | "score">,
): Promise<boolean | Message>
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error if the new score is not greater than the user's current score in the chat and force is False.
Parameters
- user_id: number
  User identifier.
- score: number
  Player's score.
- Optionaloptions: Omit<SetGameScoreParams, "user_id" | "score">
  Additional parameters.
Returns Promise<boolean | Message>
Message object or True.
- Defined in core/bot.ts:2992

setManagedBotAccessSettings

setManagedBotAccessSettings(
    user_id: number,
    is_access_restricted: boolean,
    options?: Omit<
        SetManagedBotAccessSettingsParams,
        "user_id"
        | "is_access_restricted",
    >,
): Promise<boolean>
Use this method to change managed bot access settings. Returns True on success.
Parameters
- user_id: number
  Unique user identifier (managed bot)
- is_access_restricted: boolean
  True if only selected users have access to the bot. The bot owner always has access.
- Optionaloptions: Omit<SetManagedBotAccessSettingsParams, "user_id" | "is_access_restricted">
  Additional parameters (see SetManagedBotAccessSettingsParams)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1595

setMessageReaction

setMessageReaction(
    chat_id: string | number,
    message_id: number,
    reaction: ReactionType[],
): Promise<boolean>
Use this method to change chosen reactions on a message. Service messages of some types cannot be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots cannot use paid reactions. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_id: number
  Unique identifier for the message
- reaction: ReactionType[]
  Array of reactions to set
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:671

setMyCommands

setMyCommands(
commands: BotCommand[],
options?: Omit<SetMyCommandsParams, "commands">,
): Promise<boolean>
Use this method to change the list of bot commands. See this guide for more information about bot commands. Returns True on success.
Parameters
- commands: BotCommand[]
  List of commands for the bot (max 100)
- Optionaloptions: Omit<SetMyCommandsParams, "commands">
  Additional parameters (scope, language_code)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1627

setMyDefaultAdministratorRights

setMyDefaultAdministratorRights(
options?: SetMyDefaultAdministratorRightsParams,
): Promise<boolean>
Use this method to change the default administrator rights requested by the bot when it is added as an administrator to groups or channels. These rights will be proposed to users, but they can change the list before adding the bot. Returns True on success.
Parameters
- Optionaloptions: SetMyDefaultAdministratorRightsParams
  Additional parameters (rights, for_channels)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1797

setMyDescription

setMyDescription(options?: SetMyDescriptionParams): Promise<boolean>
Use this method to change the bot's description, which is displayed in the chat with the bot if the chat is empty. Returns True on success.
Parameters
- Optionaloptions: SetMyDescriptionParams
  Additional parameters (description, language_code)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1695

setMyName

setMyName(options?: SetMyNameParams): Promise<boolean>
Use this method to change the bot's name. Returns True on success.
Parameters
- Optionaloptions: SetMyNameParams
  Additional parameters (name, language_code)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1669

setMyProfilePhoto

setMyProfilePhoto(photo: InputProfilePhoto): Promise<boolean>
Use this method to change the bot's profile photo. Returns True on success.
Parameters
- photo: InputProfilePhoto
  Bot profile photo
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1747

setMyShortDescription

setMyShortDescription(options?: SetMyShortDescriptionParams): Promise<boolean>
Use this method to change the bot's short description, which is displayed on the bot's profile page and sent with a link when users share the bot. Returns True on success.
Parameters
- Optionaloptions: SetMyShortDescriptionParams
  Additional parameters (short_description, language_code)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1721

setStickerEmojiList

setStickerEmojiList(sticker: string, emoji_list: string[]): Promise<boolean>
Use this method to change the list of emojis assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
Parameters
- sticker: string
  Sticker identifier.
- emoji_list: string[]
  List of emojis.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2710

setStickerKeywords

setStickerKeywords(sticker: string, keywords: string[]): Promise<boolean>
Use this method to change the list of keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
Parameters
- sticker: string
  Sticker identifier.
- keywords: string[]
  List of keywords.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2726

setStickerMaskPosition

setStickerMaskPosition(
sticker: string,
options?: Omit<SetStickerMaskPositionParams, "sticker">,
): Promise<boolean>
Use this method to change the mask position of a sticker. The sticker must belong to a set created by the bot. Returns True on success.
Parameters
- sticker: string
  Sticker identifier.
- Optionaloptions: Omit<SetStickerMaskPositionParams, "sticker">
  Additional parameters.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2742

setStickerPositionInSet

setStickerPositionInSet(sticker: string, position: number): Promise<boolean>
Use this method to move a sticker from a set created by the bot to a specific position. Returns True on success.
Parameters
- sticker: string
  Sticker identifier.
- position: number
  New sticker position.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2662

setStickerSetThumbnail

setStickerSetThumbnail(
    name: string,
    user_id: number,
    format: string,
    options?: Omit<SetStickerSetThumbnailParams, "user_id" | "name" | "format">,
): Promise<boolean>
Use this method to set the thumbnail of a regular sticker set or a mask set. The thumbnail file format must match the format of the stickers in the set. Returns True on success.
Parameters
- name: string
  Sticker set name.
- user_id: number
  User identifier creating the sticker set.
- format: string
  Thumbnail file format.
- Optionaloptions: Omit<SetStickerSetThumbnailParams, "user_id" | "name" | "format">
  Additional parameters.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2775

setStickerSetTitle

setStickerSetTitle(name: string, title: string): Promise<boolean>
Use this method to set the title of a created sticker set. Returns True on success.
Parameters
- name: string
  Sticker set name.
- title: string
  New sticker set title.
Returns Promise<boolean>
True on success.
- Defined in core/bot.ts:2757

setUserEmojiStatus

setUserEmojiStatus(
user_id: number,
options?: Omit<SetUserEmojiStatusParams, "user_id">,
): Promise<boolean>
Use this method to set a user's emoji status. Returns True on success.
Parameters
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<SetUserEmojiStatusParams, "user_id">
  Additional emoji status parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:717

setWebhook

setWebhook(
url: string,
options?: Omit<SetWebhookParams, "url">,
): Promise<boolean>
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL containing a serialized JSON update. In case of a failed request (a request with an HTTP response status code other than 2XY), we will retry the request and stop its execution after a sufficient number of attempts. Returns True on success.

If you want to ensure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain an "X-Telegram-Bot-Api-Secret-Token" header with the secret token as its content.

Important: Ensure that your URL uses a valid SSL certificate. Requests with invalid certificates will be ignored. For testing in a local environment, you can use ngrok or similar services.
Parameters
- url: string
  Webhook URL
- Optionaloptions: Omit<SetWebhookParams, "url">
  Additional webhook parameters
Returns Promise<boolean>
boolean on success
- Defined in core/bot.ts:134

stopMessageLiveLocation

stopMessageLiveLocation(
    id: EditMessageIds,
    options?: Omit<
        StopMessageLiveLocationParams,
        "chat_id"
        | "message_id"
        | "inline_message_id",
    >,
): Promise<boolean | Message>
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.
Parameters
- id: EditMessageIds
  Message identifier. Can be an object with chat_id and message_id or an inline_message_id string.
- Optionaloptions: Omit<
      StopMessageLiveLocationParams,
      "chat_id"
      | "message_id"
      | "inline_message_id",
  >
  Additional parameters
Returns Promise<boolean | Message>
Edited message or True on success.
- Defined in core/bot.ts:2415

stopPoll

stopPoll(
    chat_id: string | number,
    message_id: number,
    options?: Omit<StopPollParams, "chat_id" | "message_id">,
): Promise<Poll>
Use this method to stop a poll. On success, the updated poll is returned.
Parameters
- chat_id: string | number
  Chat identifier or username.
- message_id: number
  Message identifier with the poll.
- Optionaloptions: Omit<StopPollParams, "chat_id" | "message_id">
  Additional parameters.
Returns Promise<Poll>
Updated poll.
- Defined in core/bot.ts:2480

transferBusinessAccountStars

transferBusinessAccountStars(
business_connection_id: string,
star_count: number,
): Promise<boolean>
Transfers Telegram Stars from a business account balance to the bot balance. Requires the business bot right can_transfer_stars. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- star_count: number
  Number of stars to transfer
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2073

transferGift

transferGift(
    business_connection_id: string,
    owned_gift_id: string,
    new_owner_chat_id: number,
    options?: Omit<
        TransferGiftParams,
        "business_connection_id"
        | "owned_gift_id"
        | "new_owner_chat_id",
    >,
): Promise<boolean>
Transfers an owned unique gift to another user. Requires the business bot right can_transfer_and_upgrade_gifts. Requires the business bot right can_transfer_stars if the transfer is paid. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- owned_gift_id: string
  Gift identifier
- new_owner_chat_id: number
  New owner's chat identifier
- Optionaloptions: Omit<
      TransferGiftParams,
      "business_connection_id"
      | "owned_gift_id"
      | "new_owner_chat_id",
  >
  Additional parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2172

unbanChatMember

unbanChatMember(
    chat_id: string | number,
    user_id: number,
    options?: Omit<UnbanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
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 an invite link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user will not be 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 only_if_banned parameter. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- user_id: number
  Unique identifier for the target user
- Optionaloptions: Omit<UnbanChatMemberParams, "chat_id" | "user_id">
  Additional unban parameters
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:772

unbanChatSenderChat

unbanChatSenderChat(
chat_id: string | number,
sender_chat_id: number,
): Promise<boolean>
Use this method to unban a previously blocked channel chat in a supergroup or channel. For this to work, the bot must be an administrator and have appropriate administrator rights. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- sender_chat_id: number
  Unique identifier of the sender
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:881

unhideGeneralForumTopic

unhideGeneralForumTopic(chat_id: string | number): Promise<boolean>
Use this method to unhide the "General" topic in a forum supergroup chat. For this to work, the bot must be a chat administrator and have the can_manage_topics administrator right. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1464

unpinAllChatMessages

unpinAllChatMessages(chat_id: string | number): Promise<boolean>
Use this method to clear the list of pinned messages in a chat. In private chats and channel direct message chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the can_pin_messages or can_edit_messages right to unpin all pinned messages in groups and channels respectively. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1144

unpinAllForumTopicMessages

unpinAllForumTopicMessages(
chat_id: string | number,
message_thread_id: number,
): Promise<boolean>
Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or in a private chat with a user. In the case of a supergroup chat, the bot must be a chat administrator for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- message_thread_id: number
  Forum topic identifier
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1389

unpinAllGeneralForumTopicMessages

unpinAllGeneralForumTopicMessages(chat_id: string | number): Promise<boolean>
Use this method to clear the list of pinned messages in a General forum topic. For this to work, the bot must be a chat administrator and have the can_pin_messages administrator right in the supergroup. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1478

unpinChatMessage

unpinChatMessage(
chat_id: string | number,
options?: Omit<UnpinChatMessageParams, "chat_id">,
): Promise<boolean>
Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct message chats, all messages can be unpinned. Conversely, the bot must be an administrator with the can_pin_messages or can_edit_messages right to unpin messages in groups and channels respectively. Returns True on success.
Parameters
- chat_id: string | number
  Unique identifier for the target chat
- Optionaloptions: Omit<UnpinChatMessageParams, "chat_id">
  Additional parameters (message_id, etc.)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1128

upgradeGift

upgradeGift(
    business_connection_id: string,
    owned_gift_id: string,
    options?: Omit<
        UpgradeGiftParams,
        "business_connection_id"
        | "owned_gift_id",
    >,
): Promise<boolean>
Upgrades a regular gift to a unique one. Requires the business bot right can_transfer_and_upgrade_gifts. Additionally requires the business bot right can_transfer_stars if the upgrade is paid. Returns True on success.
Parameters
- business_connection_id: string
  Business account identifier
- owned_gift_id: string
  Gift identifier
- Optionaloptions: Omit<UpgradeGiftParams, "business_connection_id" | "owned_gift_id">
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:2152

uploadStickerFile

uploadStickerFile(
    user_id: number,
    sticker: string | InputFile,
    sticker_format: "video" | "static" | "animated",
): Promise<File>
Use this method to upload a sticker file for subsequent use in createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded file on success.
Parameters
- user_id: number
  User identifier.
- sticker: string | InputFile
  Sticker to upload. Can be a string (file_id) or InputFile.
- sticker_format: "video" | "static" | "animated"
  Sticker format. Can be 'static', 'animated', or 'video'.
Returns Promise<File>
File object.
- Defined in core/bot.ts:2611

use

use(...middlewares: (Composer<C> | Middleware<C>)[]): this
Adds a general handler or an ENTIRE MODULE (another Composer).
Parameters
- ...middlewares: (Composer<C> | Middleware<C>)[]
Returns this
Inherited from Composer.use
- Defined in core/composer.ts:80

verifyChat

verifyChat(
chat_id: number,
options?: Omit<VerifyChatParams, "chat_id">,
): Promise<boolean>
Verifies a chat on behalf of an organization represented by the bot. Returns True on success.
Parameters
- chat_id: number
  Chat identifier
- Optionaloptions: Omit<VerifyChatParams, "chat_id">
  Additional parameters (custom_description)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1884

verifyUser

verifyUser(
user_id: number,
options?: Omit<VerifyUserParams, "user_id">,
): Promise<boolean>
Verifies a user on behalf of an organization represented by the bot. Returns True on success.
Parameters
- user_id: number
  User identifier
- Optionaloptions: Omit<VerifyUserParams, "user_id">
  Additional parameters (status, comment)
Returns Promise<boolean>
True on success
- Defined in core/bot.ts:1869

`Static`compose

compose<C extends Context>(middlewares: Middleware<C>[]): Middleware<C>
Magic engine: collects an array of middlewares into a single execution chain. When one middleware calls next(), this function triggers the next one.
Type Parameters
- C extends Context
Parameters
- middlewares: Middleware<C>[]
Returns Middleware<C>
Inherited from Composer.compose
- Defined in core/composer.ts:210

Class TelegramBot<C>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TelegramBot<C>

Methods

_setClient

Parameters

Returns void

action

Parameters

Returns this

addStickerToSet

Parameters

Returns Promise<boolean>

answerCallbackQuery

Parameters

Returns Promise<boolean>

answerGuestQuery

Parameters

Returns Promise<SentGuestMessage>

answerInlineQuery

Parameters

Returns Promise<boolean>

answerPreCheckoutQuery

Parameters

Returns Promise<boolean>

answerShippingQuery

Parameters

Returns Promise<boolean>

answerWebAppQuery

Parameters

Returns Promise<SentWebAppMessage>

approveChatJoinRequest

Parameters

Returns Promise<boolean>

approveSuggestedPost

Parameters

Returns Promise<boolean>

banChatMember

Parameters

Returns Promise<boolean>

banChatSenderChat

Parameters

Returns Promise<boolean>

catch

Parameters

Returns this

close

Returns Promise<boolean>

closeForumTopic

Parameters

Returns Promise<boolean>

closeGeneralForumTopic

Parameters

Returns Promise<boolean>

command

Parameters

Returns this

convertGiftToStars

Parameters

Returns Promise<boolean>

copyMessage

Parameters

Returns Promise<MessageId>

copyMessages

Parameters

Returns Promise<MessageId[]>

createChatInviteLink

Parameters

Returns Promise<ChatInviteLink>

createChatSubscriptionInviteLink

Parameters

Returns Promise<ChatInviteLink>