Class Bot

Primary HTTP Client for executing Telegram Bot API requests.

Inherits all domain method mixins with full autocomplete and type safety.

Example

const bot = new Bot(process.env.BOT_TOKEN!, {
  retry: {
    maxRetryAttempts: 4,
    minDelaySeconds: 1,
  },
});
await bot.sendMessage({ chat_id: 123456, text: "Hello world!" });

Hierarchy

BusinessAndEcosystemMethods
- Bot

Index

Constructors

constructor

new Bot(token: string, options?: BotOptions): Bot
Constructs a new Bot client instance.
Parameters
- token: string
  Secret token provided by BotFather.
- options: BotOptions = {}
  Custom HTTP, retry, and endpoint options.
Returns Bot

Overrides BusinessAndEcosystemMethods.constructor

Properties

`Protected` `Readonly`_fetch

_fetch: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Internal fetch adapter instance used for HTTP dispatch.

Type Declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- MDN Reference
  Parameters
  - input: URL | RequestInfo
  - Optionalinit: RequestInit
  Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
- MDN Reference
  Parameters
  - input: string | URL | Request
  - Optionalinit: RequestInit
  Returns Promise<Response>

`Readonly`apiRoot

apiRoot: string

Base endpoint URL of the Telegram Bot API server.

`Protected` `Optional` `Readonly`baseDelayMs

baseDelayMs?: number

Optional base delay in milliseconds used for retry calculations.

`Readonly`options

options: BotOptions

Client configuration options.

`Protected` `Readonly`requestTimeoutMs

requestTimeoutMs: number

Default per-request abort timeout in milliseconds.

`Readonly`token

token: string

Secret Telegram Bot API token received from BotFather.

Methods

addStickerToSet

addStickerToSet(options: AddStickerToSetOptions): Promise<boolean>
Adds a new sticker to a set created by the bot.
Parameters
- options: AddStickerToSetOptions
  Options including user_id, name, and sticker descriptor.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When adding sticker fails.

See
Telegram Bot API: addStickerToSet

Inherited from BusinessAndEcosystemMethods.addStickerToSet

answerCallbackQuery

answerCallbackQuery(options: AnswerCallbackQueryOptions): Promise<boolean>
Sends answers to callback queries sent from inline keyboards.
Parameters
- options: AnswerCallbackQueryOptions
  Options including callback_query_id, text, show_alert, url, and cache_time.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When answering callback query fails.
Example
```
await bot.answerCallbackQuery({
  callback_query_id: query.id,
  text: "Button clicked!",
  show_alert: false,
});
```
See
Telegram Bot API: answerCallbackQuery
Inherited from BusinessAndEcosystemMethods.answerCallbackQuery

answerChatJoinRequestQuery

answerChatJoinRequestQuery(
options: AnswerChatJoinRequestQueryOptions,
): Promise<boolean>
Answers a chat join request query from a user (Bot API 10.1+).
Parameters
- options: AnswerChatJoinRequestQueryOptions
  Query response options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: answerChatJoinRequestQuery

Inherited from BusinessAndEcosystemMethods.answerChatJoinRequestQuery

answerGuestQuery

answerGuestQuery(
guestQueryId: string,
result: unknown,
): Promise<{ inline_message_id?: string }>
Answers a guest query in a mini app.
Parameters
- guestQueryId: string
  Unique identifier of the query.
- result: unknown
  Result payload to return.
Returns Promise<{ inline_message_id?: string }>
Object with optional inline_message_id.

See
Telegram Bot API: answerGuestQuery

Inherited from BusinessAndEcosystemMethods.answerGuestQuery

answerInlineQuery

answerInlineQuery(options: AnswerInlineQueryOptions): Promise<boolean>
Sends answers to an inline query from users.
Parameters
- options: AnswerInlineQueryOptions
  Options including inline_query_id, results array, cache_time, is_personal, next_offset, button.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When answering inline query fails.

Remarks
Inline mode must be enabled for your bot in Telegram via BotFather (/setinline).
Example
```
await bot.answerInlineQuery({
  inline_query_id: update.inline_query!.id,
  results: [
    {
      type: "article",
      id: "1",
      title: "Result Title",
      input_message_content: { message_text: "Result content" },
    },
  ],
});
```
See
Telegram Bot API: answerInlineQuery
Inherited from BusinessAndEcosystemMethods.answerInlineQuery

answerPreCheckoutQuery

answerPreCheckoutQuery(options: AnswerPreCheckoutQueryOptions): Promise<boolean>
Replies to an incoming pre-checkout query to confirm or cancel the order.
Parameters
- options: AnswerPreCheckoutQueryOptions
  Options including pre_checkout_query_id, ok, and optional error_message.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When confirming/canceling fails.
Example
```
await bot.answerPreCheckoutQuery({
  pre_checkout_query_id: "pcq_123",
  ok: true,
});
```
See
Telegram Bot API: answerPreCheckoutQuery
Inherited from BusinessAndEcosystemMethods.answerPreCheckoutQuery

answerShippingQuery

answerShippingQuery(options: AnswerShippingQueryOptions): Promise<boolean>
Replies to an incoming shipping query.
Parameters
- options: AnswerShippingQueryOptions
  Options including shipping_query_id, ok, and optional shipping_options or error_message.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When replying fails.
Example
```
await bot.answerShippingQuery({
  shipping_query_id: "sq_123",
  ok: true,
  shipping_options: [
    { id: "express", title: "Express (1-2 days)", prices: [{ label: "Express", amount: 500 }] },
  ],
});
```
See
Telegram Bot API: answerShippingQuery
Inherited from BusinessAndEcosystemMethods.answerShippingQuery

answerWebAppQuery

answerWebAppQuery(
webAppQueryId: string,
result: unknown,
): Promise<{ inline_message_id?: string }>
Sets the result of an interaction with a Web App and sends a corresponding message on behalf of the user to the chat.
Parameters
- webAppQueryId: string
  Unique identifier for the query.
- result: unknown
  An object describing the message to be sent.
Returns Promise<{ inline_message_id?: string }>
Object with optional inline_message_id.

Throws
TelegramApiError When answering web app query fails.

See
Telegram Bot API: answerWebAppQuery

Inherited from BusinessAndEcosystemMethods.answerWebAppQuery

approveChatJoinRequest

approveChatJoinRequest(
chatId: string | number,
userId: number,
): Promise<boolean>
Approves a chat join request from a user.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When approval fails.
Example
```
await bot.approveChatJoinRequest(chatId, userId);
```
See
Telegram Bot API: approveChatJoinRequest
Inherited from BusinessAndEcosystemMethods.approveChatJoinRequest

approveSuggestedPost

approveSuggestedPost(
    chatId: string | number,
    messageId: number,
    sendDate?: number,
): Promise<boolean>
Approves a suggested post in a channel.
Parameters
- chatId: string | number
  Channel chat identifier.
- messageId: number
  Identifier of the suggested post message.
- OptionalsendDate: number
  Point in time (Unix timestamp) when the post will be published; defaults to the current date and time when omitted.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: approveSuggestedPost

Inherited from BusinessAndEcosystemMethods.approveSuggestedPost

banChatMember

banChatMember(
    chatId: string | number,
    userId: number,
    untilDate?: number,
    revokeMessages?: boolean,
): Promise<boolean>
Bans a user in a group, a supergroup or a channel.
Parameters
- chatId: string | number
  Unique identifier for the target group or channel.
- userId: number
  Unique identifier of the target user.
- OptionaluntilDate: number
  Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever.
- OptionalrevokeMessages: boolean
  Pass true to delete all messages from the chat for the user that is being banned.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When banning fails.
Example
```
await bot.banChatMember(chatId, userId, undefined, true);
```
See
Telegram Bot API: banChatMember
Inherited from BusinessAndEcosystemMethods.banChatMember

banChatSenderChat

banChatSenderChat(
chatId: string | number,
senderChatId: number,
): Promise<boolean>
Bans a channel in a chat, preventing it from sending messages.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- senderChatId: number
  Unique identifier of the target sender channel.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When banning sender chat fails.
Example
```
await bot.banChatSenderChat(chatId, channelId);
```
See
Telegram Bot API: banChatSenderChat
Inherited from BusinessAndEcosystemMethods.banChatSenderChat

close

close(): Promise<boolean>

Closes the bot instance before moving it from one local server to another.

Returns Promise<boolean>
true on success.

Throws
TelegramApiError When close fails.

See
Telegram Bot API: close

Inherited from BusinessAndEcosystemMethods.close

closeForumTopic

closeForumTopic(
chatId: string | number,
messageThreadId: number,
): Promise<boolean>
Closes an open topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- messageThreadId: number
  Unique identifier for the target message thread of the forum topic.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When closing topic fails.
Example
```
await bot.closeForumTopic(-1001234567890, 42);
```
See
Telegram Bot API: closeForumTopic
Inherited from BusinessAndEcosystemMethods.closeForumTopic

closeGeneralForumTopic

closeGeneralForumTopic(chatId: string | number): Promise<boolean>
Closes an open 'General' topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When closing General topic fails.
Example
```
await bot.closeGeneralForumTopic(-1001234567890);
```
See
Telegram Bot API: closeGeneralForumTopic
Inherited from BusinessAndEcosystemMethods.closeGeneralForumTopic

configureRetry

configureRetry(options: Partial<RetryOptions>): this
Dynamically configures or updates the auto-retry and flood control settings.
Parameters
- options: Partial<RetryOptions>
  Partial retry options to update.
Returns this
This client instance for chaining.
Example
```
bot.configureRetry({
  maxRetryAttempts: 5,
  minDelaySeconds: 2,
});
```
Inherited from BusinessAndEcosystemMethods.configureRetry

convertGiftToStars

convertGiftToStars(
businessConnectionId: string,
ownedGiftId: string,
): Promise<boolean>
Converts a regular gift owned by a managed business account to Telegram Stars.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- ownedGiftId: string
  Unique identifier of the regular gift to convert.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: convertGiftToStars

Inherited from BusinessAndEcosystemMethods.convertGiftToStars

copyMessage

copyMessage(
    options: {
        allow_paid_broadcast?: boolean;
        caption?: string;
        caption_entities?: MessageEntity[];
        chat_id: string | number;
        direct_messages_topic_id?: number;
        disable_notification?: boolean;
        from_chat_id: string | number;
        message_effect_id?: string;
        message_id: number;
        message_thread_id?: number;
        parse_mode?: ParseMode;
        protect_content?: boolean;
        reply_markup?: ReplyMarkup;
        reply_parameters?: ReplyParameters;
        show_caption_above_media?: boolean;
        suggested_post_parameters?: SuggestedPostParameters;
        video_start_timestamp?: number;
    },
): Promise<{ message_id: number }>
Copies a message of any kind, sending a new message with the same content without header links.
Parameters
- options: {
      allow_paid_broadcast?: boolean;
      caption?: string;
      caption_entities?: MessageEntity[];
      chat_id: string | number;
      direct_messages_topic_id?: number;
      disable_notification?: boolean;
      from_chat_id: string | number;
      message_effect_id?: string;
      message_id: number;
      message_thread_id?: number;
      parse_mode?: ParseMode;
      protect_content?: boolean;
      reply_markup?: ReplyMarkup;
      reply_parameters?: ReplyParameters;
      show_caption_above_media?: boolean;
      suggested_post_parameters?: SuggestedPostParameters;
      video_start_timestamp?: number;
  }
  Copy options including optional custom caption, parse_mode, and reply_markup.
Returns Promise<{ message_id: number }>
Object containing the message_id of the copied message.
Throws
TelegramApiError When copying fails.
Example
```
const result = await bot.copyMessage({
  chat_id: targetChatId,
  from_chat_id: sourceChatId,
  message_id: 123,
  caption: "Here is your copy!",
});
```
See
Telegram Bot API: copyMessage
Inherited from BusinessAndEcosystemMethods.copyMessage

copyMessages

copyMessages(options: CopyMessagesOptions): Promise<MessageId[]>
Copies multiple messages of any kind in batch.
Parameters
- options: CopyMessagesOptions
  Batch copy options including chat_id, from_chat_id, and message_ids.
Returns Promise<MessageId[]>
Array of MessageId objects containing the identifiers of copied messages.
Throws
TelegramApiError When batch copying fails.
Example
```
const copies = await bot.copyMessages({
  chat_id: targetChatId,
  from_chat_id: sourceChatId,
  message_ids: [100, 101],
  remove_caption: true,
});
console.log(`Copied ${copies.length} messages`);
```
See
Telegram Bot API: copyMessages
Inherited from BusinessAndEcosystemMethods.copyMessages

createChatInviteLink

createChatInviteLink(
chatId: string | number,
options?: CreateChatInviteLinkOptions,
): Promise<ChatInviteLink>
Creates an additional invite link for a chat with optional expiration and usage limits.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- options: CreateChatInviteLinkOptions = {}
  Options including name, expire_date, member_limit, and creates_join_request.
Returns Promise<ChatInviteLink>
The created ChatInviteLink.
Throws
TelegramApiError When creating link fails.
Example
```
const invite = await bot.createChatInviteLink(chatId, {
  name: "VIP Membership",
  member_limit: 10,
});
```
See
Telegram Bot API: createChatInviteLink
Inherited from BusinessAndEcosystemMethods.createChatInviteLink

createChatSubscriptionInviteLink

createChatSubscriptionInviteLink(
chatId: string | number,
options: CreateChatSubscriptionInviteLinkOptions,
): Promise<ChatInviteLink>
Creates a subscription invite link for a channel or group.
Parameters
- chatId: string | number
  Target chat identifier.
- options: CreateChatSubscriptionInviteLinkOptions
  Subscription parameters.
Returns Promise<ChatInviteLink>
Created link object.

See
Telegram Bot API: createChatSubscriptionInviteLink

Inherited from BusinessAndEcosystemMethods.createChatSubscriptionInviteLink

createForumTopic

createForumTopic(
    options: {
        chat_id: string | number;
        icon_color?: number;
        icon_custom_emoji_id?: string;
        name: string;
    },
): Promise<ForumTopic>
Creates a topic in a forum supergroup chat.
Parameters
- options: {
      chat_id: string | number;
      icon_color?: number;
      icon_custom_emoji_id?: string;
      name: string;
  }
  Options including target chat_id, name, and optional icon_color or icon_custom_emoji_id.
Returns Promise<ForumTopic>
The created ForumTopic object on success.
Throws
TelegramApiError When creating topic fails.
Example
```
const topic = await bot.createForumTopic({
  chat_id: -1001234567890,
  name: "Announcements",
  icon_color: 0x6FB9F0,
});
console.log(`Created thread ID: ${topic.message_thread_id}`);
```
See
Telegram Bot API: createForumTopic
Inherited from BusinessAndEcosystemMethods.createForumTopic

createInvoiceLink

createInvoiceLink(options: CreateInvoiceLinkOptions): Promise<string>
Creates an HTTP link for an invoice that can be shared in messages or buttons.
Parameters
- options: CreateInvoiceLinkOptions
  Invoice link parameters matching the documented createInvoiceLink set (no chat_id).
Returns Promise<string>
The created invoice link as a string.
Throws
TelegramApiError When link creation fails.
Example
```
const link = await bot.createInvoiceLink({
  title: "Donation",
  description: "Support development",
  payload: "donation_50",
  currency: "XTR",
  prices: [{ label: "Stars", amount: 50 }],
});
```
See
Telegram Bot API: createInvoiceLink
Inherited from BusinessAndEcosystemMethods.createInvoiceLink

createNewStickerSet

createNewStickerSet(options: CreateNewStickerSetOptions): Promise<boolean>
Creates a new sticker set owned by a user.
Parameters
- options: CreateNewStickerSetOptions
  Options including user_id, name, title, stickers array, and sticker_format.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When creation fails.
Example
```
await bot.createNewStickerSet({
  user_id: 123456,
  name: "custom_pack_by_bot",
  title: "Custom Pack",
  stickers: [{ sticker: uploadedFileId, emoji_list: ["😀"] }],
  sticker_format: "static",
});
```
See
Telegram Bot API: createNewStickerSet
Inherited from BusinessAndEcosystemMethods.createNewStickerSet

declineChatJoinRequest

declineChatJoinRequest(
chatId: string | number,
userId: number,
): Promise<boolean>
Declines a chat join request from a user.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When declining fails.
Example
```
await bot.declineChatJoinRequest(chatId, userId);
```
See
Telegram Bot API: declineChatJoinRequest
Inherited from BusinessAndEcosystemMethods.declineChatJoinRequest

declineSuggestedPost

declineSuggestedPost(
    chatId: string | number,
    messageId: number,
    comment?: string,
): Promise<boolean>
Declines a suggested post in a channel.
Parameters
- chatId: string | number
  Channel chat identifier.
- messageId: number
  Identifier of the suggested post message.
- Optionalcomment: string
  Comment for the post author; pass an empty string for no comment.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: declineSuggestedPost

Inherited from BusinessAndEcosystemMethods.declineSuggestedPost

deleteAllMessageReactions

deleteAllMessageReactions(
    chatId: string | number,
    userId?: number,
    actorChatId?: number,
): Promise<boolean>
Removes all reactions on a message (this endpoint takes no message_id).
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- OptionaluserId: number
  Identifier of the target user, for business connections only.
- OptionalactorChatId: number
  Unique identifier of the business chat on behalf of which to act.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When clearing reactions fails.

See
Telegram Bot API: deleteAllMessageReactions

Inherited from BusinessAndEcosystemMethods.deleteAllMessageReactions

deleteBusinessMessages

deleteBusinessMessages(
businessConnectionId: string,
messageIds: number[],
): Promise<boolean>
Deletes messages on behalf of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- messageIds: number[]
  List of message identifiers to delete.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting messages fails.

See
Telegram Bot API: deleteBusinessMessages

Inherited from BusinessAndEcosystemMethods.deleteBusinessMessages

deleteChatPhoto

deleteChatPhoto(chatId: string | number): Promise<boolean>
Deletes a chat photo.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting chat photo fails.

See
Telegram Bot API: deleteChatPhoto

Inherited from BusinessAndEcosystemMethods.deleteChatPhoto

deleteChatStickerSet

deleteChatStickerSet(chatId: string | number): Promise<boolean>
Deletes a group sticker set from a supergroup.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting sticker set fails.

See
Telegram Bot API: deleteChatStickerSet

Inherited from BusinessAndEcosystemMethods.deleteChatStickerSet

deleteEphemeralMessage

deleteEphemeralMessage(
    optionsOrChatId: string | number | DeleteEphemeralMessageOptions,
    receiverUserId?: number,
    ephemeralMessageId?: number,
): Promise<boolean>
Deletes an ephemeral message (Bot API 10.2+).
Parameters
- optionsOrChatId: string | number | DeleteEphemeralMessageOptions
  Options object or chat identifier.
- OptionalreceiverUserId: number
  Receiver user identifier when passing positional arguments.
- OptionalephemeralMessageId: number
  Ephemeral message identifier when passing positional arguments.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: deleteEphemeralMessage

Inherited from BusinessAndEcosystemMethods.deleteEphemeralMessage

deleteForumTopic

deleteForumTopic(
chatId: string | number,
messageThreadId: number,
): Promise<boolean>
Deletes a forum topic along with all its messages in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- messageThreadId: number
  Unique identifier for the target message thread of the forum topic.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When deleting topic fails.
Example
```
await bot.deleteForumTopic(-1001234567890, 42);
```
See
Telegram Bot API: deleteForumTopic
Inherited from BusinessAndEcosystemMethods.deleteForumTopic

deleteMessage

deleteMessage(chatId: string | number, messageId: number): Promise<boolean>
Deletes a message in a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- messageId: number
  Identifier of the message to delete.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When message cannot be deleted.
Example
```
await bot.deleteMessage(chatId, messageId);
```
See
Telegram Bot API: deleteMessage
Inherited from BusinessAndEcosystemMethods.deleteMessage

deleteMessageReaction

deleteMessageReaction(
    chatId: string | number,
    messageId: number,
    userId?: number,
    actorChatId?: number,
): Promise<boolean>
Removes the calling user's or a managed business account's reaction from a message.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- messageId: number
  Identifier of the target message.
- OptionaluserId: number
  Identifier of the target user, for business connections only.
- OptionalactorChatId: number
  Unique identifier of the business chat on behalf of which to act.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When clearing reaction fails.

See
Telegram Bot API: deleteMessageReaction

Inherited from BusinessAndEcosystemMethods.deleteMessageReaction

deleteMessages

deleteMessages(chatId: string | number, messageIds: number[]): Promise<boolean>
Deletes multiple messages simultaneously in a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- messageIds: number[]
  Array of 1-100 identifiers of messages to delete.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When messages cannot be deleted.
Example
```
await bot.deleteMessages(chatId, [101, 102, 103]);
```
See
Telegram Bot API: deleteMessages
Inherited from BusinessAndEcosystemMethods.deleteMessages

deleteMyCommands

deleteMyCommands(
options?: { language_code?: string; scope?: BotCommandScope },
): Promise<boolean>
Deletes the list of the bot's commands for the given scope and user language.
Parameters
- options: { language_code?: string; scope?: BotCommandScope } = {}
  Optional scope and language_code.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When deleting commands fails.
Example
```
await bot.deleteMyCommands();
```
See
Telegram Bot API: deleteMyCommands
Inherited from BusinessAndEcosystemMethods.deleteMyCommands

deleteStickerFromSet

deleteStickerFromSet(sticker: string): Promise<boolean>
Deletes a sticker from a set created by the bot.
Parameters
- sticker: string
  File identifier of the sticker.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting sticker fails.

See
Telegram Bot API: deleteStickerFromSet

Inherited from BusinessAndEcosystemMethods.deleteStickerFromSet

deleteStickerSet

deleteStickerSet(name: string): Promise<boolean>
Deletes a sticker set that was created by the bot.
Parameters
- name: string
  Sticker set name.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting set fails.

See
Telegram Bot API: deleteStickerSet

Inherited from BusinessAndEcosystemMethods.deleteStickerSet

deleteStory

deleteStory(businessConnectionId: string, storyId: number): Promise<boolean>
Deletes a story previously posted on behalf of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- storyId: number
  Identifier of the story to delete.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When deleting story fails.

See
Telegram Bot API: deleteStory

Inherited from BusinessAndEcosystemMethods.deleteStory

deleteWebhook

deleteWebhook(dropPendingUpdates?: boolean): Promise<boolean>
Removes webhook integration, reverting to getUpdates polling.
Parameters
- OptionaldropPendingUpdates: boolean
  Pass true to discard all queued undelivered updates.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When removing webhook fails.
Example
```
await bot.deleteWebhook(true);
```
See
Telegram Bot API: deleteWebhook
Inherited from BusinessAndEcosystemMethods.deleteWebhook

doApiRequest

doApiRequest<T>(method: string, payload?: Record<string, unknown>): Promise<T>
General-purpose raw API method executor.
Type Parameters
- T
  Expected result payload type.
Parameters
- method: string
  API method name.
- payload: Record<string, unknown> = {}
  Request parameters.
Returns Promise<T>
Unwrapped API result.

Inherited from BusinessAndEcosystemMethods.doApiRequest

editChatInviteLink

editChatInviteLink(
    chatId: string | number,
    inviteLink: string,
    options?: EditChatInviteLinkOptions,
): Promise<ChatInviteLink>
Edits a non-primary invite link created by the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- inviteLink: string
  The invite link to edit.
- options: EditChatInviteLinkOptions = {}
  Updated invite link parameters.
Returns Promise<ChatInviteLink>
The edited ChatInviteLink.
Throws
TelegramApiError When editing link fails.
Example
```
const edited = await bot.editChatInviteLink(chatId, inviteLink, {
  member_limit: 20,
});
```
See
Telegram Bot API: editChatInviteLink
Inherited from BusinessAndEcosystemMethods.editChatInviteLink

editChatSubscriptionInviteLink

editChatSubscriptionInviteLink(
    chatId: string | number,
    inviteLink: string,
    options?: EditChatSubscriptionInviteLinkOptions,
): Promise<ChatInviteLink>
Edits a chat subscription invite link.
Parameters
- chatId: string | number
  Target chat identifier.
- inviteLink: string
  Invite link to edit.
- options: EditChatSubscriptionInviteLinkOptions = {}
  Updated link parameters.
Returns Promise<ChatInviteLink>
Edited link object.

See
Telegram Bot API: editChatSubscriptionInviteLink

Inherited from BusinessAndEcosystemMethods.editChatSubscriptionInviteLink

editEphemeralMessageCaption

editEphemeralMessageCaption(
options: EditEphemeralMessageCaptionOptions,
): Promise<boolean>
Edits an ephemeral message caption (Bot API 10.3+).
Parameters
- options: EditEphemeralMessageCaptionOptions
  Ephemeral message caption edit options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: editEphemeralMessageCaption

Inherited from BusinessAndEcosystemMethods.editEphemeralMessageCaption

editEphemeralMessageMedia

editEphemeralMessageMedia(
options: EditEphemeralMessageMediaOptions,
): Promise<boolean>
Edits an ephemeral message media (Bot API 10.3+).
Parameters
- options: EditEphemeralMessageMediaOptions
  Ephemeral message media edit options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: editEphemeralMessageMedia

Inherited from BusinessAndEcosystemMethods.editEphemeralMessageMedia

editEphemeralMessageReplyMarkup

editEphemeralMessageReplyMarkup(
options: EditEphemeralMessageReplyMarkupOptions,
): Promise<boolean>
Edits an ephemeral message reply markup (Bot API 10.3+).
Parameters
- options: EditEphemeralMessageReplyMarkupOptions
  Ephemeral message reply markup edit options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: editEphemeralMessageReplyMarkup

Inherited from BusinessAndEcosystemMethods.editEphemeralMessageReplyMarkup

editEphemeralMessageText

editEphemeralMessageText(
options: EditEphemeralMessageTextOptions,
): Promise<boolean>
Edits an ephemeral message text (Bot API 10.2+).
Parameters
- options: EditEphemeralMessageTextOptions
  Ephemeral message edit options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: editEphemeralMessageText

Inherited from BusinessAndEcosystemMethods.editEphemeralMessageText

editForumTopic

editForumTopic(
    options: {
        chat_id: string | number;
        icon_custom_emoji_id?: string;
        message_thread_id: number;
        name?: string;
    },
): Promise<boolean>
Edits the name and icon of a topic in a forum supergroup chat.
Parameters
- options: {
      chat_id: string | number;
      icon_custom_emoji_id?: string;
      message_thread_id: number;
      name?: string;
  }
  Options including chat_id, message_thread_id, and updated name or icon_custom_emoji_id.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When editing topic fails.
Example
```
await bot.editForumTopic({
  chat_id: -1001234567890,
  message_thread_id: 42,
  name: "Updated Announcements",
});
```
See
Telegram Bot API: editForumTopic
Inherited from BusinessAndEcosystemMethods.editForumTopic

editGeneralForumTopic

editGeneralForumTopic(chatId: string | number, name: string): Promise<boolean>
Edits the name of the 'General' topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- name: string
  New name of the topic (1-128 characters).
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When editing General topic fails.
Example
```
await bot.editGeneralForumTopic(-1001234567890, "General Chat");
```
See
Telegram Bot API: editGeneralForumTopic
Inherited from BusinessAndEcosystemMethods.editGeneralForumTopic

editMessageCaption

editMessageCaption(
options: EditMessageCaptionOptions,
): Promise<boolean | Message>
Edits the caption of a media message previously sent by the bot.
Parameters
- options: EditMessageCaptionOptions
  Options including optional caption, parse_mode, and reply_markup.
Returns Promise<boolean | Message>
The edited Message or true if inline message.
Throws
TelegramApiError When editing caption fails.
Example
```
await bot.editMessageCaption({
  chat_id: 123456,
  message_id: 789,
  caption: "Updated caption description",
});
```
See
Telegram Bot API: editMessageCaption
Inherited from BusinessAndEcosystemMethods.editMessageCaption

editMessageChecklist

editMessageChecklist(
options: EditMessageChecklistOptions,
): Promise<boolean | Message>
Edits an interactive checklist message.
Parameters
- options: EditMessageChecklistOptions
  Checklist modification options.
Returns Promise<boolean | Message>
Edited Message or boolean.

Throws
TelegramApiError When editing the checklist fails.

See
Telegram Bot API: editMessageChecklist

Inherited from BusinessAndEcosystemMethods.editMessageChecklist

editMessageLiveLocation

editMessageLiveLocation(
options: EditMessageLiveLocationOptions,
): Promise<boolean | Message>
Edits a live location message previously sent by the bot.
Parameters
- options: EditMessageLiveLocationOptions
  Options including latitude, longitude, and either chat_id+message_id or inline_message_id.
Returns Promise<boolean | Message>
The edited Message or true if inline message.
Throws
TelegramApiError When editing live location fails.
Example
```
await bot.editMessageLiveLocation({
  chat_id: 123456,
  message_id: 456,
  latitude: 37.7750,
  longitude: -122.4195,
});
```
See
Telegram Bot API: editMessageLiveLocation
Inherited from BusinessAndEcosystemMethods.editMessageLiveLocation

editMessageMedia

editMessageMedia(options: EditMessageMediaOptions): Promise<boolean | Message>
Edits the animation, audio, document, photo, or video content of a message.
Parameters
- options: EditMessageMediaOptions
  Options including new media descriptor and target message ID.
Returns Promise<boolean | Message>
The edited Message or true if inline message.
Throws
TelegramApiError When editing media fails.
Example
```
await bot.editMessageMedia({
  chat_id: 123456,
  message_id: 789,
  media: { type: "photo", media: "https://example.com/new_photo.jpg" },
});
```
See
Telegram Bot API: editMessageMedia
Inherited from BusinessAndEcosystemMethods.editMessageMedia

editMessageReplyMarkup

editMessageReplyMarkup(
options: EditMessageReplyMarkupOptions,
): Promise<boolean | Message>
Edits only the inline keyboard reply markup of a message.
Parameters
- options: EditMessageReplyMarkupOptions
  Target message options with optional new reply_markup.
Returns Promise<boolean | Message>
The edited Message or true if inline message.
Throws
TelegramApiError When editing reply markup fails.
Example
```
await bot.editMessageReplyMarkup({
  chat_id: 123456,
  message_id: 789,
  reply_markup: new InlineKeyboard().text("Done", "done").build(),
});
```
See
Telegram Bot API: editMessageReplyMarkup
Inherited from BusinessAndEcosystemMethods.editMessageReplyMarkup

editMessageText

editMessageText(options: EditMessageTextOptions): Promise<boolean | Message>
Edits the text of a message previously sent by the bot or via inline queries.
Parameters
- options: EditMessageTextOptions
  Options including text, chat_id+message_id or inline_message_id, reply_markup, and the optional business_connection_id.
Returns Promise<boolean | Message>
The edited Message or true if inline message.
Throws
TelegramApiError When editing text fails.
Example
```
await bot.editMessageText({
  chat_id: 123456,
  message_id: 789,
  text: "Updated text content",
});
```
See
Telegram Bot API: editMessageText
Inherited from BusinessAndEcosystemMethods.editMessageText

editStory

editStory(
    businessConnectionId: string,
    storyId: number,
    content: unknown,
    options?: EditStoryOptions,
): Promise<Story>
Edits a story previously posted by the bot on behalf of a business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- storyId: number
  Unique identifier of the story to edit.
- content: unknown
  New content for the story.
- options: EditStoryOptions = {}
  Additional edit parameters.
Returns Promise<Story>
The edited Story object.

Throws
TelegramApiError When editing story fails.

See
Telegram Bot API: editStory

Inherited from BusinessAndEcosystemMethods.editStory

editUserStarSubscription

editUserStarSubscription(
    userId: number,
    telegramPaymentChargeId: string,
    isCanceled: boolean,
): Promise<boolean>
Allows the bot to cancel or re-enable a subscription paid with Telegram Stars for a user.
Parameters
- userId: number
  Identifier of the user whose subscription will be edited.
- telegramPaymentChargeId: string
  Telegram payment identifier for the subscription charge.
- isCanceled: boolean
  Pass true to cancel the subscription, or false to re-enable.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When updating subscription status fails.
Example
```
await bot.editUserStarSubscription(123456, "sub_charge_123", true);
```
See
Telegram Bot API: editUserStarSubscription
Inherited from BusinessAndEcosystemMethods.editUserStarSubscription

exportChatInviteLink

exportChatInviteLink(chatId: string | number): Promise<string>
Generates a new primary invite link for a chat; any previously generated primary link is revoked.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<string>
The new invite link as a string.
Throws
TelegramApiError When exporting link fails.
Example
```
const link = await bot.exportChatInviteLink(chatId);
console.log(`Primary invite link: ${link}`);
```
See
Telegram Bot API: exportChatInviteLink
Inherited from BusinessAndEcosystemMethods.exportChatInviteLink

forwardMessage

forwardMessage(
    options: {
        chat_id: string | number;
        direct_messages_topic_id?: number;
        disable_notification?: boolean;
        from_chat_id: string | number;
        message_effect_id?: string;
        message_id: number;
        message_thread_id?: number;
        protect_content?: boolean;
        suggested_post_parameters?: SuggestedPostParameters;
        video_start_timestamp?: number;
    },
): Promise<Message>
Forwards a message of any kind.
Parameters
- options: {
      chat_id: string | number;
      direct_messages_topic_id?: number;
      disable_notification?: boolean;
      from_chat_id: string | number;
      message_effect_id?: string;
      message_id: number;
      message_thread_id?: number;
      protect_content?: boolean;
      suggested_post_parameters?: SuggestedPostParameters;
      video_start_timestamp?: number;
  }
  Forward options including chat_id, from_chat_id, and message_id.
Returns Promise<Message>
The forwarded Message.
Throws
TelegramApiError When forwarding fails.
Example
```
await bot.forwardMessage({
  chat_id: targetChatId,
  from_chat_id: sourceChatId,
  message_id: 123,
});
```
See
Telegram Bot API: forwardMessage
Inherited from BusinessAndEcosystemMethods.forwardMessage

forwardMessages

forwardMessages(options: ForwardMessagesOptions): Promise<MessageId[]>
Forwards multiple messages of any kind in batch.
Parameters
- options: ForwardMessagesOptions
  Forward batch options including chat_id, from_chat_id, and message_ids.
Returns Promise<MessageId[]>
Array of MessageId objects containing the identifiers of forwarded messages.
Throws
TelegramApiError When batch forwarding fails.
Example
```
const sent = await bot.forwardMessages({
  chat_id: targetChatId,
  from_chat_id: sourceChatId,
  message_ids: [100, 101],
});
console.log(`Forwarded ${sent.length} messages`);
```
See
Telegram Bot API: forwardMessages
Inherited from BusinessAndEcosystemMethods.forwardMessages

getAvailableGifts

getAvailableGifts(): Promise<Gifts>
Returns the list of gifts that can be sent by the bot to users and channel chats.

Returns Promise<Gifts>
A Gifts object containing the available gifts.
Throws
TelegramApiError When retrieving gifts fails.
Example
```
const gifts = await bot.getAvailableGifts();
console.log(`Available gifts count: ${gifts.gifts.length}`);
```
See
Telegram Bot API: getAvailableGifts
Inherited from BusinessAndEcosystemMethods.getAvailableGifts

getBusinessAccountGifts

getBusinessAccountGifts(
businessConnectionId: string,
options?: GetBusinessAccountGiftsOptions,
): Promise<unknown>
Retrieves the gifts received and owned by a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- options: GetBusinessAccountGiftsOptions = {}
  Optional exclusion, sorting and pagination filters.
Returns Promise<unknown>
Owned gifts of the business account.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: getBusinessAccountGifts

Inherited from BusinessAndEcosystemMethods.getBusinessAccountGifts

getBusinessAccountStarBalance

getBusinessAccountStarBalance(
businessConnectionId: string,
): Promise<{ amount: number }>
Retrieves the Telegram Star balance of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
Returns Promise<{ amount: number }>
Object containing the star amount.

See
Telegram Bot API: getBusinessAccountStarBalance

Inherited from BusinessAndEcosystemMethods.getBusinessAccountStarBalance

getBusinessConnection

getBusinessConnection(businessConnectionId: string): Promise<BusinessConnection>
Retrieves information about the connection of the bot with a business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
Returns Promise<BusinessConnection>
A BusinessConnection object.

Throws
TelegramApiError When connection is not found.

See
Telegram Bot API: getBusinessConnection

Inherited from BusinessAndEcosystemMethods.getBusinessConnection

getChat

getChat(chatId: string | number): Promise<ChatFullInfo>
Retrieves up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.).
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
Returns Promise<ChatFullInfo>
A ChatFullInfo object.
Throws
TelegramApiError When chat is not found or bot lacks access.

Remarks
The docs declare the return type as ChatFullInfo, not Chat. Because ChatFullInfo extends Chat, callers that annotated the result as a Chat keep compiling and additionally gain access to the documented full-info fields (max_reaction_count, parent_chat, accepted_gift_types, rating, community, guard_bot, …).
Example
```
const chat = await bot.getChat(chatId);
console.log(`Chat title: ${chat.title}, max reactions: ${chat.max_reaction_count}`);
```
See
Telegram Bot API: getChat
Inherited from BusinessAndEcosystemMethods.getChat

getChatAdministrators

getChatAdministrators(
chatId: string | number,
options?: { return_bots?: boolean },
): Promise<ChatMember[]>
Retrieves a list of administrators in a chat, which includes the chat creator and all promoted admins.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- options: { return_bots?: boolean } = {}
Returns Promise<ChatMember[]>
Array of ChatMember objects.
Throws
TelegramApiError When retrieving administrators fails.
Example
```
const admins = await bot.getChatAdministrators(chatId);
console.log(`Found ${admins.length} administrators`);
```
See
Telegram Bot API: getChatAdministrators
Inherited from BusinessAndEcosystemMethods.getChatAdministrators

getChatGifts

getChatGifts(
chatId: string | number,
options?: GetChatGiftsOptions,
): Promise<unknown>
Retrieves the gifts owned by a chat.
Parameters
- chatId: string | number
  Target chat identifier or channel @username.
- options: GetChatGiftsOptions = {}
  Optional exclusion (including saved/unsaved), sorting and pagination filters.
Returns Promise<unknown>
List of chat gifts.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: getChatGifts

Inherited from BusinessAndEcosystemMethods.getChatGifts

getChatMember

getChatMember(chatId: string | number, userId: number): Promise<ChatMember>
Retrieves information about a specific member of a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
Returns Promise<ChatMember>
A ChatMember object.
Throws
TelegramApiError When user is not found.
Example
```
const member = await bot.getChatMember(chatId, userId);
console.log(`User status: ${member.status}`);
```
See
Telegram Bot API: getChatMember
Inherited from BusinessAndEcosystemMethods.getChatMember

getChatMemberCount

getChatMemberCount(chatId: string | number): Promise<number>
Retrieves the number of members in a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<number>
Total member count as a number.
Throws
TelegramApiError When retrieving count fails.
Example
```
const count = await bot.getChatMemberCount(chatId);
console.log(`Chat members: ${count}`);
```
See
Telegram Bot API: getChatMemberCount
Inherited from BusinessAndEcosystemMethods.getChatMemberCount

getChatMenuButton

getChatMenuButton(chatId?: string | number): Promise<MenuButton>
Retrieves the current value of the bot's menu button in a private chat, or the default menu button.
Parameters
- OptionalchatId: string | number
  Unique identifier for the target private chat. If not specified, default menu button is returned.
Returns Promise<MenuButton>
A MenuButton object.
Throws
TelegramApiError When retrieving menu button fails.
Example
```
const menu = await bot.getChatMenuButton(123456);
console.log(menu.type);
```
See
Telegram Bot API: getChatMenuButton
Inherited from BusinessAndEcosystemMethods.getChatMenuButton

getCustomEmojiStickers

getCustomEmojiStickers(customEmojiIds: string[]): Promise<Sticker[]>
Retrieves information about custom emoji stickers by their identifiers.
Parameters
- customEmojiIds: string[]
  List of custom emoji identifiers (up to 200).
Returns Promise<Sticker[]>
Array of Sticker objects.
Throws
TelegramApiError When retrieval fails.
Example
```
const emojis = await bot.getCustomEmojiStickers(["5368324170671202286"]);
```
See
Telegram Bot API: getCustomEmojiStickers
Inherited from BusinessAndEcosystemMethods.getCustomEmojiStickers

getFile

getFile(fileId: string): Promise<File>
Retrieves basic info about a file and prepares it for downloading.
Parameters
- fileId: string
  File identifier to get info about.
Returns Promise<File>
A File object with file_path.
Throws
TelegramApiError When file is not found or exceeds 20MB bot limit.
Example
```
const file = await bot.getFile(photoFileId);
const downloadUrl = `https://api.telegram.org/file/bot${bot.token}/${file.file_path}`;
```
See
Telegram Bot API: getFile
Inherited from BusinessAndEcosystemMethods.getFile

getForumTopicIconStickers

getForumTopicIconStickers(): Promise<unknown[]>

Retrieves custom emoji stickers that can be used as forum topic icons.

Returns Promise<unknown[]>
Array of sticker objects.

Throws
TelegramApiError When retrieval fails.

See
Telegram Bot API: getForumTopicIconStickers

Inherited from BusinessAndEcosystemMethods.getForumTopicIconStickers

getGameHighScores

getGameHighScores(
    userId: number,
    options?: {
        chat_id?: string | number;
        inline_message_id?: string;
        message_id?: number;
    },
): Promise<GameHighScore[]>
Retrieves high score tables for a game.
Parameters
- userId: number
  Target user identifier.
- options: { chat_id?: string | number; inline_message_id?: string; message_id?: number } = {}
  Target message coordinates.
Returns Promise<GameHighScore[]>
Array of GameHighScore objects.

Throws
TelegramApiError When retrieving scores fails.

See
Telegram Bot API: getGameHighScores

Inherited from BusinessAndEcosystemMethods.getGameHighScores

getManagedBotAccessSettings

getManagedBotAccessSettings(userId: number): Promise<unknown>
Retrieves access settings for a managed bot.
Parameters
- userId: number
  Unique identifier of the target user that owns the managed bot.
Returns Promise<unknown>
Access settings.

See
Telegram Bot API: getManagedBotAccessSettings

Inherited from BusinessAndEcosystemMethods.getManagedBotAccessSettings

getManagedBotToken

getManagedBotToken(userId: number): Promise<{ token: string }>
Retrieves the token of a managed bot.
Parameters
- userId: number
  Unique identifier of the target user that owns the managed bot.
Returns Promise<{ token: string }>
Object containing the bot token.

See
Telegram Bot API: getManagedBotToken

Inherited from BusinessAndEcosystemMethods.getManagedBotToken

getMe

getMe(): Promise<User>
Basic information about the bot in form of a User object.

Returns Promise<User>
The User object representing the bot.
Throws
TelegramApiError When token is invalid or request fails.
Example
```
const me = await bot.getMe();
console.log(`Logged in as @${me.username} (${me.id})`);
```
See
Telegram Bot API: getMe
Inherited from BusinessAndEcosystemMethods.getMe

getMyCommands

getMyCommands(
options?: { language_code?: string; scope?: BotCommandScope },
): Promise<BotCommand[]>
Retrieves the current list of the bot's commands for the given scope and user language.
Parameters
- options: { language_code?: string; scope?: BotCommandScope } = {}
  Optional scope and language_code.
Returns Promise<BotCommand[]>
Array of BotCommand objects.
Throws
TelegramApiError When retrieving commands fails.
Example
```
const commands = await bot.getMyCommands();
console.log(commands);
```
See
Telegram Bot API: getMyCommands
Inherited from BusinessAndEcosystemMethods.getMyCommands

getMyDefaultAdministratorRights

getMyDefaultAdministratorRights(
forChannels?: boolean,
): Promise<ChatAdministratorRights>
Retrieves the current default administrator rights of the bot.
Parameters
- OptionalforChannels: boolean
  Pass true to get default rights for channels, or false for groups/supergroups.
Returns Promise<ChatAdministratorRights>
A ChatAdministratorRights object.
Throws
TelegramApiError When retrieving administrator rights fails.
Example
```
const rights = await bot.getMyDefaultAdministratorRights();
console.log(rights);
```
See
Telegram Bot API: getMyDefaultAdministratorRights
Inherited from BusinessAndEcosystemMethods.getMyDefaultAdministratorRights

getMyDescription

getMyDescription(languageCode?: string): Promise<BotDescription>
Retrieves the current bot description for the given user language.
Parameters
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<BotDescription>
A BotDescription object.
Throws
TelegramApiError When retrieving description fails.
Example
```
const { description } = await bot.getMyDescription("en");
console.log(description);
```
See
Telegram Bot API: getMyDescription
Inherited from BusinessAndEcosystemMethods.getMyDescription

getMyName

getMyName(languageCode?: string): Promise<BotName>
Retrieves the current bot name for the given user language.
Parameters
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<BotName>
A BotName object.
Throws
TelegramApiError When retrieving bot name fails.
Example
```
const { name } = await bot.getMyName("en");
console.log(`Bot Name: ${name}`);
```
See
Telegram Bot API: getMyName
Inherited from BusinessAndEcosystemMethods.getMyName

getMyShortDescription

getMyShortDescription(languageCode?: string): Promise<BotShortDescription>
Retrieves the current bot short description for the given user language.
Parameters
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<BotShortDescription>
A BotShortDescription object.
Throws
TelegramApiError When retrieving short description fails.
Example
```
const { short_description } = await bot.getMyShortDescription("en");
console.log(short_description);
```
See
Telegram Bot API: getMyShortDescription
Inherited from BusinessAndEcosystemMethods.getMyShortDescription

getMyStarBalance

getMyStarBalance(): Promise<StarAmount>
Retrieves the bot's current balance in Telegram Stars.

Returns Promise<StarAmount>
A StarAmount object containing amount and optional nanostar_amount.
Throws
TelegramApiError When retrieving balance fails.
Example
```
const balance = await bot.getMyStarBalance();
console.log(`Current Stars: ${balance.amount}`);
```
See
Telegram Bot API: getMyStarBalance
Inherited from BusinessAndEcosystemMethods.getMyStarBalance

getStarTransactions

getStarTransactions(offset?: number, limit?: number): Promise<StarTransactions>
Retrieves the bot's Telegram Star transactions in chronological order.
Parameters
- Optionaloffset: number
  Number of transactions to skip in the response.
- Optionallimit: number
  The maximum number of transactions to retrieve (1-100).
Returns Promise<StarTransactions>
A StarTransactions object.
Throws
TelegramApiError When retrieving transactions fails.
Example
```
const txs = await bot.getStarTransactions(0, 20);
console.log(`Total transactions returned: ${txs.transactions.length}`);
```
See
Telegram Bot API: getStarTransactions
Inherited from BusinessAndEcosystemMethods.getStarTransactions

getStickerSet

getStickerSet(name: string): Promise<StickerSet>
Retrieves a sticker set by its short name.
Parameters
- name: string
  Short name of the sticker set.
Returns Promise<StickerSet>
A StickerSet object.
Throws
TelegramApiError When sticker set is not found.
Example
```
const set = await bot.getStickerSet("animals");
console.log(`Sticker set title: ${set.title}, stickers: ${set.stickers.length}`);
```
See
Telegram Bot API: getStickerSet
Inherited from BusinessAndEcosystemMethods.getStickerSet

getUpdates

getUpdates(options?: GetUpdatesOptions): Promise<RawUpdate[]>
Retrieves incoming updates using long polling.
Parameters
- options: GetUpdatesOptions = {}
  Polling options such as offset, limit, timeout, and allowed_updates.
Returns Promise<RawUpdate[]>
Array of RawUpdate objects.
Throws
TelegramApiError When retrieving updates fails.
Example
```
const updates = await bot.getUpdates({ timeout: 10, offset: 0 });
console.log(`Received ${updates.length} updates`);
```
See
Telegram Bot API: getUpdates
Inherited from BusinessAndEcosystemMethods.getUpdates

getUserChatBoosts

getUserChatBoosts(
chatId: string | number,
userId: number,
): Promise<UserChatBoosts>
Retrieves the list of boosts added to a chat by a user.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- userId: number
  Unique identifier of the target user.
Returns Promise<UserChatBoosts>
A UserChatBoosts object containing the list of boosts.
Throws
TelegramApiError When retrieving boosts fails.
Example
```
const boosts = await bot.getUserChatBoosts(chatId, 123456);
console.log(`Total boosts: ${boosts.boosts.length}`);
```
See
Telegram Bot API: getUserChatBoosts
Inherited from BusinessAndEcosystemMethods.getUserChatBoosts

getUserGifts

getUserGifts(userId: number, options?: GetUserGiftsOptions): Promise<unknown>
Retrieves the gifts owned and hosted by a user.
Parameters
- userId: number
  Target user identifier.
- options: GetUserGiftsOptions = {}
  Optional exclusion, sorting and pagination filters.
Returns Promise<unknown>
List of user gifts.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: getUserGifts

Inherited from BusinessAndEcosystemMethods.getUserGifts

getUserPersonalChatMessages

getUserPersonalChatMessages(userId: number, limit: number): Promise<Message[]>
Retrieves messages from a user's personal chat with the bot.
Parameters
- userId: number
  Unique identifier of the target user.
- limit: number
  Maximum number of messages to be returned; 1-100.
Returns Promise<Message[]>
Array of Message objects.

Throws
TelegramApiError When retrieving messages fails.

See
Telegram Bot API: getUserPersonalChatMessages

Inherited from BusinessAndEcosystemMethods.getUserPersonalChatMessages

getUserProfileAudios

getUserProfileAudios(
    userId: number,
    offset?: number,
    limit?: number,
): Promise<unknown>
Retrieves profile audio files for a user.
Parameters
- userId: number
  Target user identifier.
- Optionaloffset: number
  Query offset.
- Optionallimit: number
  Maximum items to retrieve.
Returns Promise<unknown>
Profile audio objects.

See
Telegram Bot API: getUserProfileAudios

Inherited from BusinessAndEcosystemMethods.getUserProfileAudios

getUserProfilePhotos

getUserProfilePhotos(
    userId: number,
    offset?: number,
    limit?: number,
): Promise<UserProfilePhotos>
Retrieves a list of profile pictures for a user.
Parameters
- userId: number
  Unique identifier of the target user.
- Optionaloffset: number
  Sequential number of first photo to return (default 0).
- Optionallimit: number
  Limits the number of photos to be retrieved (1-100, default 100).
Returns Promise<UserProfilePhotos>
A UserProfilePhotos object.
Throws
TelegramApiError When retrieving photos fails.
Example
```
const photos = await bot.getUserProfilePhotos(123456, 0, 1);
console.log(`User has ${photos.total_count} total photos`);
```
See
Telegram Bot API: getUserProfilePhotos
Inherited from BusinessAndEcosystemMethods.getUserProfilePhotos

getWebhookInfo

getWebhookInfo(): Promise<WebhookInfo>
Retrieves current webhook status information.

Returns Promise<WebhookInfo>
A WebhookInfo object.
Throws
TelegramApiError When retrieving webhook info fails.
Example
```
const info = await bot.getWebhookInfo();
console.log(`Webhook URL: ${info.url}, Pending updates: ${info.pending_update_count}`);
```
See
Telegram Bot API: getWebhookInfo
Inherited from BusinessAndEcosystemMethods.getWebhookInfo

giftPremiumSubscription

giftPremiumSubscription(
options: GiftPremiumSubscriptionOptions,
): Promise<boolean>
Gifts a Telegram Premium subscription to a user.
Parameters
- options: GiftPremiumSubscriptionOptions
  Premium gift parameters.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: giftPremiumSubscription

Inherited from BusinessAndEcosystemMethods.giftPremiumSubscription

hideGeneralForumTopic

hideGeneralForumTopic(chatId: string | number): Promise<boolean>
Hides the 'General' topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When hiding General topic fails.
Example
```
await bot.hideGeneralForumTopic(-1001234567890);
```
See
Telegram Bot API: hideGeneralForumTopic
Inherited from BusinessAndEcosystemMethods.hideGeneralForumTopic

initialize

initialize(): Promise<void>

Initializes client state and verifies credentials via getMe.

Returns Promise<void>

Inherited from BusinessAndEcosystemMethods.initialize

leaveChat

leaveChat(chatId: string | number): Promise<boolean>
Leaves a group, supergroup or channel.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When leaving chat fails.

See
Telegram Bot API: leaveChat

Inherited from BusinessAndEcosystemMethods.leaveChat

logOut

logOut(): Promise<boolean>

Logs out from the cloud Bot API server before launching a local Bot API server.

Returns Promise<boolean>
true on success.

Throws
TelegramApiError When logout fails.

See
Telegram Bot API: logOut

Inherited from BusinessAndEcosystemMethods.logOut

onApiError

onApiError(hook: ApiErrorHookFn, tag?: string): this
Registers an observer invoked whenever a Bot API request finally fails.

Hooks run in registration order right before the TelegramApiError is thrown, after retries are exhausted. Observers cannot alter the error; exceptions inside a hook are swallowed and logged. Useful for alerting and metrics plugins.
Parameters
- hook: ApiErrorHookFn
  Callback receiving the method name and the final error.
- Optionaltag: string
  Optional owner tag for grouped removal via BaseBotClient.removeHooksByTag.
Returns this
This client instance for chaining.
Example
```
bot.onApiError((method, error) => {
  console.error(`${method} failed: ${error.description}`);
});
```
Inherited from BusinessAndEcosystemMethods.onApiError

pinChatMessage

pinChatMessage(
    chatId: string | number,
    messageId: number,
    disableNotification?: boolean,
    businessConnectionId?: string,
): Promise<boolean>
Pins a message in a group, a supergroup, or a channel.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- messageId: number
  Identifier of a message to pin.
- OptionaldisableNotification: boolean
  Pass true if it is not necessary to send a notification to all chat members.
- OptionalbusinessConnectionId: string
  Unique identifier of the business connection on behalf of which the message will be pinned.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When pinning message fails.

See
Telegram Bot API: pinChatMessage

Inherited from BusinessAndEcosystemMethods.pinChatMessage

postStory

postStory(
    businessConnectionId: string,
    content: unknown,
    options: PostStoryOptions,
): Promise<Story>
Posts a story on behalf of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- content: unknown
  Content of the story.
- options: PostStoryOptions
  Additional story options.
Returns Promise<Story>
The posted Story object.

Throws
TelegramApiError When posting story fails.

See
Telegram Bot API: postStory

Inherited from BusinessAndEcosystemMethods.postStory

promoteChatMember

promoteChatMember(
    chatId: string | number,
    userId: number,
    options?: PromoteChatMemberOptions,
): Promise<boolean>
Promotes or demotes a user in a supergroup or a channel.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
- options: PromoteChatMemberOptions = {}
  Admin rights flags (e.g. can_manage_chat, can_delete_messages, can_invite_users).
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When promotion fails.
Example
```
await bot.promoteChatMember(chatId, userId, {
  can_delete_messages: true,
  can_invite_users: true,
});
```
See
Telegram Bot API: promoteChatMember
Inherited from BusinessAndEcosystemMethods.promoteChatMember

readBusinessMessage

readBusinessMessage(
    businessConnectionId: string,
    chatId: number,
    messageId: number,
): Promise<boolean>
Marks incoming messages in a business account as read.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- chatId: number
  Unique identifier of the chat in which the message was received.
- messageId: number
  Identifier of the message to mark as read.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When marking message fails.

See
Telegram Bot API: readBusinessMessage

Inherited from BusinessAndEcosystemMethods.readBusinessMessage

refundStarPayment

refundStarPayment(
userId: number,
telegramPaymentChargeId: string,
): Promise<boolean>
Refunds a successful payment in Telegram Stars.
Parameters
- userId: number
  Identifier of the user who made the payment.
- telegramPaymentChargeId: string
  Telegram payment identifier.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When refund fails.
Example
```
await bot.refundStarPayment(123456, "tx_charge_123");
```
See
Telegram Bot API: refundStarPayment
Inherited from BusinessAndEcosystemMethods.refundStarPayment

removeBusinessAccountProfilePhoto

removeBusinessAccountProfilePhoto(
businessConnectionId: string,
options?: RemoveBusinessAccountProfilePhotoOptions,
): Promise<boolean>
Removes the profile photo of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- options: RemoveBusinessAccountProfilePhotoOptions = {}
  Optional is_public flag; pass True to remove the public photo.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: removeBusinessAccountProfilePhoto

Inherited from BusinessAndEcosystemMethods.removeBusinessAccountProfilePhoto

removeChatVerification

removeChatVerification(chatId: string | number): Promise<boolean>
Removes verification from a chat that was previously verified by the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When removing verification fails.
Example
```
await bot.removeChatVerification(chatId);
```
See
Telegram Bot API: removeChatVerification
Inherited from BusinessAndEcosystemMethods.removeChatVerification

removeHooksByTag

removeHooksByTag(tag: string): number
Removes every request transform, response transform, and API error hook registered with the given owner tag.
Parameters
- tag: string
  Owner tag previously passed when registering hooks.
Returns number
The number of hooks removed.
Example
```
bot.removeHooksByTag("my-plugin");
```
Inherited from BusinessAndEcosystemMethods.removeHooksByTag

removeMyProfilePhoto

removeMyProfilePhoto(): Promise<boolean>

Removes the profile photo of the bot.

Returns Promise<boolean>
true on success.

See
Telegram Bot API: removeMyProfilePhoto

Inherited from BusinessAndEcosystemMethods.removeMyProfilePhoto

removeUserVerification

removeUserVerification(userId: number): Promise<boolean>
Removes verification from a user that was previously verified by the bot.
Parameters
- userId: number
  Unique identifier of the target user.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When removing verification fails.
Example
```
await bot.removeUserVerification(123456);
```
See
Telegram Bot API: removeUserVerification
Inherited from BusinessAndEcosystemMethods.removeUserVerification

reopenForumTopic

reopenForumTopic(
chatId: string | number,
messageThreadId: number,
): Promise<boolean>
Reopens a closed topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- messageThreadId: number
  Unique identifier for the target message thread of the forum topic.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When reopening topic fails.
Example
```
await bot.reopenForumTopic(-1001234567890, 42);
```
See
Telegram Bot API: reopenForumTopic
Inherited from BusinessAndEcosystemMethods.reopenForumTopic

reopenGeneralForumTopic

reopenGeneralForumTopic(chatId: string | number): Promise<boolean>
Reopens a closed 'General' topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When reopening General topic fails.
Example
```
await bot.reopenGeneralForumTopic(-1001234567890);
```
See
Telegram Bot API: reopenGeneralForumTopic
Inherited from BusinessAndEcosystemMethods.reopenGeneralForumTopic

replaceManagedBotToken

replaceManagedBotToken(userId: number): Promise<{ token: string }>
Generates a replacement token for a managed bot.
Parameters
- userId: number
  Unique identifier of the target user that owns the managed bot.
Returns Promise<{ token: string }>
Object containing the new bot token.

See
Telegram Bot API: replaceManagedBotToken

Inherited from BusinessAndEcosystemMethods.replaceManagedBotToken

replaceStickerInSet

replaceStickerInSet(options: ReplaceStickerInSetOptions): Promise<boolean>
Replaces an existing sticker in a sticker set with a new one.
Parameters
- options: ReplaceStickerInSetOptions
  Options including user_id, name, old_sticker, and sticker descriptor.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When replacing sticker fails.

See
Telegram Bot API: replaceStickerInSet

Inherited from BusinessAndEcosystemMethods.replaceStickerInSet

repostStory

repostStory(options: RepostStoryOptions): Promise<Story>
Reposts a story to a channel or story feed.
Parameters
- options: RepostStoryOptions
  Repost parameters.
Returns Promise<Story>
Repost result.

See
Telegram Bot API: repostStory

Inherited from BusinessAndEcosystemMethods.repostStory

request

request<T>(method: string, payload?: Record<string, unknown>): Promise<T>
Core request dispatcher to execute any raw Telegram Bot API endpoint.

Automatically serializes JSON objects or multipart FormData when file buffers / InputFile are present. Handles HTTP 429 rate-limiting (honoring retry_after) and HTTP 5xx retries with exponential backoff, sharing a single retry budget across both so that repeated 429s cannot retry forever or starve genuine 5xx retries.
Type Parameters
- T
  The expected return payload type from Telegram.
Parameters
- method: string
  The Bot API method name (e.g. "sendMessage", "getMe", "setWebhook").
- payload: Record<string, unknown> = {}
  Key-value parameters corresponding to the API method fields.
Returns Promise<T>
Resolves with the unwrapped result field returned by Telegram.
Throws
TelegramApiError When Telegram returns ok: false, HTTP 4xx, or after retry exhaustion on 429/5xx/network errors.
Example
```
const user = await bot.request<User>("getMe");
console.log(`Bot username: @${user.username}`);
```
Inherited from BusinessAndEcosystemMethods.request

restrictChatMember

restrictChatMember(
    chatId: string | number,
    userId: number,
    permissions: ChatPermissions,
    useIndependentChatPermissions?: boolean,
    untilDate?: number,
): Promise<boolean>
Restricts a user in a supergroup.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
- permissions: ChatPermissions
  Object for new user permissions (e.g. can_send_messages).
- OptionaluseIndependentChatPermissions: boolean
  Pass true if chat permissions are set independently.
- OptionaluntilDate: number
  Date when restrictions will be lifted; Unix time.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When restriction fails.
Example
```
await bot.restrictChatMember(chatId, userId, {
  can_send_messages: false,
});
```
See
Telegram Bot API: restrictChatMember
Inherited from BusinessAndEcosystemMethods.restrictChatMember

revokeChatInviteLink

revokeChatInviteLink(
chatId: string | number,
inviteLink: string,
): Promise<ChatInviteLink>
Revokes an invite link created by the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- inviteLink: string
  The invite link to revoke.
Returns Promise<ChatInviteLink>
The revoked ChatInviteLink.
Throws
TelegramApiError When revoking fails.
Example
```
await bot.revokeChatInviteLink(chatId, inviteLink);
```
See
Telegram Bot API: revokeChatInviteLink
Inherited from BusinessAndEcosystemMethods.revokeChatInviteLink

savePreparedInlineMessage

savePreparedInlineMessage(
options: SavePreparedInlineMessageOptions,
): Promise<PreparedInlineMessage>
Stores a message that can be sent by a user of a Mini App.
Parameters
- options: SavePreparedInlineMessageOptions
  Prepared inline message options including user_id and result.
Returns Promise<PreparedInlineMessage>
A PreparedInlineMessage object containing the id and expiration_date.
Throws
TelegramApiError When saving the prepared message fails.
Example
```
const prepared = await bot.savePreparedInlineMessage({
  user_id: 123456,
  result: {
    type: "article",
    id: "art_1",
    title: "Shareable Result",
    input_message_content: { message_text: "Shared via Mini App!" },
  },
  allow_user_chats: true,
  allow_group_chats: true,
});
console.log(`Prepared message ID: ${prepared.id}`);
```
See
Telegram Bot API: savePreparedInlineMessage
Inherited from BusinessAndEcosystemMethods.savePreparedInlineMessage

savePreparedKeyboardButton

savePreparedKeyboardButton(
options: SavePreparedKeyboardButtonOptions,
): Promise<unknown>
Saves a prepared keyboard button for a Mini App.
Parameters
- options: SavePreparedKeyboardButtonOptions
  Button options.
Returns Promise<unknown>
Prepared button result.

See
Telegram Bot API: savePreparedKeyboardButton

Inherited from BusinessAndEcosystemMethods.savePreparedKeyboardButton

sendAnimation

sendAnimation(options: SendAnimationOptions): Promise<Message>
Sends an animation (GIF or H.264/MPEG-4 AVC video without sound).
Parameters
- options: SendAnimationOptions
  Options including chat_id, animation, and optional caption.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendAnimation({
  chat_id: 123456,
  animation: "https://example.com/clip.gif",
});
```
See
Telegram Bot API: sendAnimation
Inherited from BusinessAndEcosystemMethods.sendAnimation

sendAudio

sendAudio(options: SendAudioOptions): Promise<Message>
Sends an audio file (.MP3 or .M4A format).
Parameters
- options: SendAudioOptions
  Options including chat_id, audio, performer, title, and optional duration.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendAudio({
  chat_id: 123456,
  audio: audioFileId,
  performer: "Artist",
  title: "Track Title",
});
```
See
Telegram Bot API: sendAudio
Inherited from BusinessAndEcosystemMethods.sendAudio

sendChatAction

sendChatAction(options: SendChatActionOptions): Promise<boolean>
Broadcasts a chat status action (e.g. typing, uploading photo) to chat members.
Parameters
- options: SendChatActionOptions
  Options including chat_id and action (from ChatAction).
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When sending action fails.
Example
```
await bot.sendChatAction({ chat_id: 123456, action: ChatAction.TYPING });
```
See
Telegram Bot API: sendChatAction
Inherited from BusinessAndEcosystemMethods.sendChatAction

sendChatJoinRequestWebApp

sendChatJoinRequestWebApp(
options: SendChatJoinRequestWebAppOptions,
): Promise<boolean>
Sends a Web App for a chat join request (Bot API 10.1+).
Parameters
- options: SendChatJoinRequestWebAppOptions
  Join request Web App options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: sendChatJoinRequestWebApp

Inherited from BusinessAndEcosystemMethods.sendChatJoinRequestWebApp

sendChecklist

sendChecklist(options: SendChecklistOptions): Promise<Message>
Sends an interactive checklist message.
Parameters
- options: SendChecklistOptions
  Checklist configuration options.
Returns Promise<Message>
Sent Message.

Throws
TelegramApiError When sending the checklist fails.

See
Telegram Bot API: sendChecklist

Inherited from BusinessAndEcosystemMethods.sendChecklist

sendContact

sendContact(options: SendContactOptions): Promise<Message>
Sends a phone contact card to a chat.
Parameters
- options: SendContactOptions
  Options including chat_id, phone_number, first_name, and optional last_name.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendContact({
  chat_id: 123456,
  phone_number: "+1234567890",
  first_name: "Alice",
});
```
See
Telegram Bot API: sendContact
Inherited from BusinessAndEcosystemMethods.sendContact

sendDice

sendDice(options: SendDiceOptions): Promise<Message>
Sends an animated dice, dart, basketball, football, slot machine, or bowling pin.
Parameters
- options: SendDiceOptions
  Options including chat_id and optional emoji (default 🎲).
Returns Promise<Message>
The sent Message with dice result value.
Throws
TelegramApiError When sending dice fails.
Example
```
const msg = await bot.sendDice({ chat_id: 123456, emoji: "🎯" });
console.log(`Dart score: ${msg.dice?.value}`);
```
See
Telegram Bot API: sendDice
Inherited from BusinessAndEcosystemMethods.sendDice

sendDocument

sendDocument(options: SendDocumentOptions): Promise<Message>
Sends a general file/document of any type.
Parameters
- options: SendDocumentOptions
  Options including chat_id, document, and optional caption.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendDocument({
  chat_id: 123456,
  document: { data: fileBuffer, filename: "report.pdf" },
  caption: "Monthly report",
});
```
See
Telegram Bot API: sendDocument
Inherited from BusinessAndEcosystemMethods.sendDocument

sendGame

sendGame(
    chatId: string | number,
    gameShortName: string,
    options?: {
        allow_paid_broadcast?: boolean;
        business_connection_id?: string;
        disable_notification?: boolean;
        message_effect_id?: string;
        message_thread_id?: number;
        protect_content?: boolean;
        reply_markup?: InlineKeyboardMarkup;
        reply_parameters?: ReplyParameters;
    },
): Promise<Message>
Sends a game to a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- gameShortName: string
  Short name of the game, serves as the unique identifier for the game. Set up via BotFather.
- options: {
      allow_paid_broadcast?: boolean;
      business_connection_id?: string;
      disable_notification?: boolean;
      message_effect_id?: string;
      message_thread_id?: number;
      protect_content?: boolean;
      reply_markup?: InlineKeyboardMarkup;
      reply_parameters?: ReplyParameters;
  } = {}
  Additional parameters for sending game.
Returns Promise<Message>
The sent Message.

Throws
TelegramApiError When sending game fails.

See
Telegram Bot API: sendGame

Inherited from BusinessAndEcosystemMethods.sendGame

sendGift

sendGift(options: SendGiftOptions): Promise<boolean>
Sends a gift to the given user or channel chat.
Parameters
- options: SendGiftOptions
  Options including gift_id and either user_id or chat_id, plus optional message text, text_parse_mode, text_entities and pay_for_upgrade.
Returns Promise<boolean>
true on success.
Remarks
Exactly one of user_id and chat_id must be provided. The gift can't be converted to Telegram Stars by the receiver.

Throws
TelegramApiError When sending gift fails.
Example
```
await bot.sendGift({
  user_id: 123456,
  gift_id: "gift_abc123",
  text: "Enjoy your gift!",
  pay_for_upgrade: true,
});
```
Example
```
// Send to a channel chat instead of a user
await bot.sendGift({ chat_id: "@my_channel", gift_id: "gift_abc123" });
```
See
Telegram Bot API: sendGift
Inherited from BusinessAndEcosystemMethods.sendGift

sendInvoice

sendInvoice(options: SendInvoiceOptions): Promise<Message>
Sends an invoice to a user or channel.
Parameters
- options: SendInvoiceOptions
  Options including chat_id, title, description, payload, currency, and prices.
Returns Promise<Message>
The sent Message containing the invoice.
Throws
TelegramApiError When sending invoice fails.
Example
```
await bot.sendInvoice({
  chat_id: 123456,
  title: "Premium Subscription",
  description: "1-month access",
  payload: "sub_premium_1m",
  currency: "XTR",
  prices: [{ label: "1 Month", amount: 100 }],
});
```
See
Telegram Bot API: sendInvoice
Inherited from BusinessAndEcosystemMethods.sendInvoice

sendLivePhoto

sendLivePhoto(options: SendLivePhotoOptions): Promise<Message>
Sends an animated Live Photo message.
Parameters
- options: SendLivePhotoOptions
  Live photo options.
Returns Promise<Message>
Sent Message.

See
Telegram Bot API: sendLivePhoto

Inherited from BusinessAndEcosystemMethods.sendLivePhoto

sendLocation

sendLocation(options: SendLocationOptions): Promise<Message>
Sends a geographic location point on a map.
Parameters
- options: SendLocationOptions
  Options including chat_id, latitude, longitude, and optional live_period.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendLocation({
  chat_id: 123456,
  latitude: 37.7749,
  longitude: -122.4194,
});
```
See
Telegram Bot API: sendLocation
Inherited from BusinessAndEcosystemMethods.sendLocation

sendMediaGroup

sendMediaGroup(options: SendMediaGroupOptions): Promise<Message[]>
Sends a group of 2-10 photos, videos, documents, or audios as an album.
Parameters
- options: SendMediaGroupOptions
  Options including chat_id and media array of InputMedia.
Returns Promise<Message[]>
Array of sent Message objects.
Throws
TelegramApiError When sending media group fails.
Example
```
await bot.sendMediaGroup({
  chat_id: 123456,
  media: [
    { type: "photo", media: "https://example.com/1.jpg" },
    { type: "photo", media: "https://example.com/2.jpg" },
  ],
});
```
See
Telegram Bot API: sendMediaGroup
Inherited from BusinessAndEcosystemMethods.sendMediaGroup

sendMessage

sendMessage(options: SendMessageOptions): Promise<Message>
Sends a text message to a specific chat or user.
Parameters
- options: SendMessageOptions
  Message options including chat_id, text, parse_mode, reply_markup, and reply_parameters.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendMessage({
  chat_id: 123456,
  text: "Hello *world*!",
  parse_mode: ParseMode.MARKDOWN_V2,
});
```
See
Telegram Bot API: sendMessage
Inherited from BusinessAndEcosystemMethods.sendMessage

sendMessageDraft

sendMessageDraft(options: SendMessageDraftOptions): Promise<boolean>
Sets a message draft in a personal chat.
Parameters
- options: SendMessageDraftOptions
  Options including chat_id and draft content.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: sendMessageDraft

Inherited from BusinessAndEcosystemMethods.sendMessageDraft

sendPaidMedia

sendPaidMedia(options: SendPaidMediaOptions): Promise<Message>
Sends paid media (photos/videos purchased with Telegram Stars).
Parameters
- options: SendPaidMediaOptions
  Paid media parameters including chat_id, star_count, and media array.
Returns Promise<Message>
The sent Message.

See
Telegram Bot API: sendPaidMedia

Inherited from BusinessAndEcosystemMethods.sendPaidMedia

sendPhoto

sendPhoto(options: SendPhotoOptions): Promise<Message>
Sends a photo to a chat.
Parameters
- options: SendPhotoOptions
  Options including chat_id, photo (file_id, URL, or InputFile), and optional caption.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendPhoto({
  chat_id: 123456,
  photo: "https://example.com/image.jpg",
  caption: "Example image",
});
```
See
Telegram Bot API: sendPhoto
Inherited from BusinessAndEcosystemMethods.sendPhoto

sendPoll

sendPoll(options: SendPollOptions): Promise<Message>
Sends a native Telegram poll or quiz.
Parameters
- options: SendPollOptions
  Options including chat_id, question, options array, type, and is_anonymous.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending poll fails.
Example
```
await bot.sendPoll({
  chat_id: 123456,
  question: "What is your favorite language?",
  options: [{ text: "TypeScript" }, { text: "Rust" }, { text: "Go" }],
  is_anonymous: false,
});
```
See
Telegram Bot API: sendPoll
Inherited from BusinessAndEcosystemMethods.sendPoll

sendRichMessage

sendRichMessage(options: SendRichMessageOptions): Promise<Message>
Sends a structured rich formatted message (Bot API 10.1+).
Parameters
- options: SendRichMessageOptions
  Rich message options including chat_id and rich_message.
Returns Promise<Message>
The sent Message.

See
Telegram Bot API: sendRichMessage

Inherited from BusinessAndEcosystemMethods.sendRichMessage

sendRichMessageDraft

sendRichMessageDraft(options: SendRichMessageDraftOptions): Promise<boolean>
Streams a draft of a rich formatted message (Bot API 10.1+).
Parameters
- options: SendRichMessageDraftOptions
  Rich message draft options.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: sendRichMessageDraft

Inherited from BusinessAndEcosystemMethods.sendRichMessageDraft

sendSticker

sendSticker(options: SendStickerOptions): Promise<Message>
Sends a static, animated (.TGS), or video (.WEBM) sticker.
Parameters
- options: SendStickerOptions
  Options including chat_id and sticker (file ID, URL, or InputFile).
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending sticker fails.
Example
```
await bot.sendSticker({
  chat_id: 123456,
  sticker: stickerFileId,
});
```
See
Telegram Bot API: sendSticker
Inherited from BusinessAndEcosystemMethods.sendSticker

sendVenue

sendVenue(options: SendVenueOptions): Promise<Message>
Sends information about a venue / location with title and address.
Parameters
- options: SendVenueOptions
  Options including chat_id, latitude, longitude, title, and address.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendVenue({
  chat_id: 123456,
  latitude: 40.758896,
  longitude: -73.985130,
  title: "Times Square",
  address: "Manhattan, NY 10036",
});
```
See
Telegram Bot API: sendVenue
Inherited from BusinessAndEcosystemMethods.sendVenue

sendVideo

sendVideo(options: SendVideoOptions): Promise<Message>
Sends a video file.
Parameters
- options: SendVideoOptions
  Options including chat_id, video, duration, width, height, and optional caption.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendVideo({
  chat_id: 123456,
  video: "https://example.com/video.mp4",
  caption: "Watch this video",
});
```
See
Telegram Bot API: sendVideo
Inherited from BusinessAndEcosystemMethods.sendVideo

sendVideoNote

sendVideoNote(options: SendVideoNoteOptions): Promise<Message>
Sends a round video note (up to 1 minute, square 1:1 aspect ratio).
Parameters
- options: SendVideoNoteOptions
  Options including chat_id, video_note, and optional length and duration.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendVideoNote({
  chat_id: 123456,
  video_note: videoNoteId,
});
```
See
Telegram Bot API: sendVideoNote
Inherited from BusinessAndEcosystemMethods.sendVideoNote

sendVoice

sendVoice(options: SendVoiceOptions): Promise<Message>
Sends an audio voice note (.OGG format encoded with OPUS).
Parameters
- options: SendVoiceOptions
  Options including chat_id, voice, and optional duration and caption.
Returns Promise<Message>
The sent Message.
Throws
TelegramApiError When sending fails.
Example
```
await bot.sendVoice({
  chat_id: 123456,
  voice: voiceFileId,
});
```
See
Telegram Bot API: sendVoice
Inherited from BusinessAndEcosystemMethods.sendVoice

setBusinessAccountBio

setBusinessAccountBio(
businessConnectionId: string,
bio?: string,
): Promise<boolean>
Changes the bio description of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- Optionalbio: string
  New bio text.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: setBusinessAccountBio

Inherited from BusinessAndEcosystemMethods.setBusinessAccountBio

setBusinessAccountGiftSettings

setBusinessAccountGiftSettings(
businessConnectionId: string,
options: SetBusinessAccountGiftSettingsOptions,
): Promise<boolean>
Configures gift settings for a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- options: SetBusinessAccountGiftSettingsOptions
  Gift settings parameters: the required show_gift_button flag and an AcceptedGiftTypes object in accepted_gift_types.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: setBusinessAccountGiftSettings

Inherited from BusinessAndEcosystemMethods.setBusinessAccountGiftSettings

setBusinessAccountName

setBusinessAccountName(
    businessConnectionId: string,
    firstName: string,
    lastName?: string,
): Promise<boolean>
Changes the first and last name of a managed business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- firstName: string
  New first name of the business account; 1-64 characters.
- OptionallastName: string
  New last name of the business account; 0-64 characters.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: setBusinessAccountName

Inherited from BusinessAndEcosystemMethods.setBusinessAccountName

setBusinessAccountProfilePhoto

setBusinessAccountProfilePhoto(
    businessConnectionId: string,
    photo: unknown,
    options?: SetBusinessAccountProfilePhotoOptions,
): Promise<boolean>
Sets the profile photo for a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- photo: unknown
  The new profile photo to set.
- options: SetBusinessAccountProfilePhotoOptions = {}
  Optional is_public flag.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: setBusinessAccountProfilePhoto

Inherited from BusinessAndEcosystemMethods.setBusinessAccountProfilePhoto

setBusinessAccountUsername

setBusinessAccountUsername(
businessConnectionId: string,
username?: string,
): Promise<boolean>
Changes the username of a connected business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- Optionalusername: string
  New username.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: setBusinessAccountUsername

Inherited from BusinessAndEcosystemMethods.setBusinessAccountUsername

setChatAdministratorCustomTitle

setChatAdministratorCustomTitle(
    chatId: string | number,
    userId: number,
    customTitle: string,
): Promise<boolean>
Sets a custom title for an administrator in a supergroup promoted by the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- userId: number
  Unique identifier of the target user.
- customTitle: string
  New custom title for the administrator; 0-16 characters.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting title fails.
Example
```
await bot.setChatAdministratorCustomTitle(chatId, userId, "Moderator");
```
See
Telegram Bot API: setChatAdministratorCustomTitle
Inherited from BusinessAndEcosystemMethods.setChatAdministratorCustomTitle

setChatDescription

setChatDescription(
chatId: string | number,
description?: string,
): Promise<boolean>
Changes the description of a group, a supergroup or a channel.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- Optionaldescription: string
  New chat description, 0-255 characters.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting description fails.

See
Telegram Bot API: setChatDescription

Inherited from BusinessAndEcosystemMethods.setChatDescription

setChatMemberTag

setChatMemberTag(
    chatId: string | number,
    userId: number,
    tag?: string,
): Promise<boolean>
Sets a custom tag for a chat member.
Parameters
- chatId: string | number
  Target chat identifier.
- userId: number
  Target user identifier.
- Optionaltag: string
  Tag name to set.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: setChatMemberTag

Inherited from BusinessAndEcosystemMethods.setChatMemberTag

setChatMenuButton

setChatMenuButton(
chatId?: string | number,
menuButton?: MenuButton,
): Promise<boolean>
Changes the bot's menu button in a private chat, or the default menu button.
Parameters
- OptionalchatId: string | number
  Unique identifier for the target private chat. If not specified, default menu button is changed.
- OptionalmenuButton: MenuButton
  An object for the new bot menu button.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When changing menu button fails.
Example
```
await bot.setChatMenuButton(123456, {
  type: "web_app",
  text: "Open App",
  web_app: { url: "https://example.com/app" },
});
```
See
Telegram Bot API: setChatMenuButton
Inherited from BusinessAndEcosystemMethods.setChatMenuButton

setChatPermissions

setChatPermissions(
    chatId: string | number,
    permissions: ChatPermissions,
    useIndependentChatPermissions?: boolean,
): Promise<boolean>
Sets default chat permissions for all members.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- permissions: ChatPermissions
  Object for new default chat permissions.
- OptionaluseIndependentChatPermissions: boolean
  Pass true if chat permissions are set independently.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting permissions fails.
Example
```
await bot.setChatPermissions(chatId, {
  can_send_messages: true,
  can_send_photos: false,
});
```
See
Telegram Bot API: setChatPermissions
Inherited from BusinessAndEcosystemMethods.setChatPermissions

setChatPhoto

setChatPhoto(
chatId: string | number,
photo: string | InputFile,
): Promise<boolean>
Sets a new profile photo for the chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- photo: string | InputFile
  File ID, URL, or InputFile object.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting chat photo fails.

See
Telegram Bot API: setChatPhoto

Inherited from BusinessAndEcosystemMethods.setChatPhoto

setChatStickerSet

setChatStickerSet(
chatId: string | number,
stickerSetName: string,
): Promise<boolean>
Sets a new group sticker set for a supergroup.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- stickerSetName: string
  Name of the sticker set to be set as the group sticker set.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting sticker set fails.

See
Telegram Bot API: setChatStickerSet

Inherited from BusinessAndEcosystemMethods.setChatStickerSet

setChatTitle

setChatTitle(chatId: string | number, title: string): Promise<boolean>
Changes the title of a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- title: string
  New chat title, 1-128 characters.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting title fails.

See
Telegram Bot API: setChatTitle

Inherited from BusinessAndEcosystemMethods.setChatTitle

setCustomEmojiStickerSetThumbnail

setCustomEmojiStickerSetThumbnail(
name: string,
customEmojiId?: string,
): Promise<boolean>
Sets the thumbnail of a custom emoji sticker set.
Parameters
- name: string
  Sticker set name.
- OptionalcustomEmojiId: string
  Custom emoji identifier of a sticker from the set.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting thumbnail fails.
Example
```
await bot.setCustomEmojiStickerSetThumbnail("custom_emojis", "5368324170671202286");
```
See
Telegram Bot API: setCustomEmojiStickerSetThumbnail
Inherited from BusinessAndEcosystemMethods.setCustomEmojiStickerSetThumbnail

setGameScore

setGameScore(
    userId: number,
    score: number,
    options?: {
        chat_id?: string | number;
        disable_edit_message?: boolean;
        force?: boolean;
        inline_message_id?: string;
        message_id?: number;
    },
): Promise<boolean | Message>
Sets the score of the specified user in a game.
Parameters
- userId: number
  User identifier.
- score: number
  New score, must be non-negative.
- options: {
      chat_id?: string | number;
      disable_edit_message?: boolean;
      force?: boolean;
      inline_message_id?: string;
      message_id?: number;
  } = {}
  Additional parameters including target message coordinates.
Returns Promise<boolean | Message>
The edited Message or true.

Throws
TelegramApiError When setting score fails.

See
Telegram Bot API: setGameScore

Inherited from BusinessAndEcosystemMethods.setGameScore

setManagedBotAccessSettings

setManagedBotAccessSettings(
userId: number,
options: SetManagedBotAccessSettingsOptions,
): Promise<boolean>
Updates access settings for a managed bot.
Parameters
- userId: number
  Unique identifier of the target user that owns the managed bot.
- options: SetManagedBotAccessSettingsOptions
  Updated access options including the required is_access_restricted flag.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: setManagedBotAccessSettings

Inherited from BusinessAndEcosystemMethods.setManagedBotAccessSettings

setMessageReaction

setMessageReaction(options: SetMessageReactionOptions): Promise<boolean>
Sets emoji or custom emoji reactions on a message.
Parameters
- options: SetMessageReactionOptions
  Reaction options including chat_id, message_id, and reaction array/string.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting reaction fails.
Example
```
await bot.setMessageReaction({
  chat_id: 123456,
  message_id: 789,
  reaction: "👍",
});
```
See
Telegram Bot API: setMessageReaction
Inherited from BusinessAndEcosystemMethods.setMessageReaction

setMyCommands

setMyCommands(
    options: {
        commands: BotCommand[];
        language_code?: string;
        scope?: BotCommandScope;
    },
): Promise<boolean>
Changes the list of the bot's commands for the given scope and user language.
Parameters
- options: { commands: BotCommand[]; language_code?: string; scope?: BotCommandScope }
  Options including commands array, and optional scope and language_code.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting commands fails.
Example
```
await bot.setMyCommands({
  commands: [{ command: "start", description: "Start the bot" }],
});
```
See
Telegram Bot API: setMyCommands
Inherited from BusinessAndEcosystemMethods.setMyCommands

setMyDefaultAdministratorRights

setMyDefaultAdministratorRights(
rights?: ChatAdministratorRights,
forChannels?: boolean,
): Promise<boolean>
Changes the default administrator rights requested by the bot when added as administrator.
Parameters
- Optionalrights: ChatAdministratorRights
  An object describing new default administrator rights.
- OptionalforChannels: boolean
  Pass true to change default rights for channels, or false for groups/supergroups.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When changing administrator rights fails.
Example
```
await bot.setMyDefaultAdministratorRights({
  is_anonymous: false,
  can_manage_chat: true,
  can_delete_messages: true,
  can_manage_video_chats: false,
  can_restrict_members: true,
  can_promote_members: false,
  can_change_info: true,
  can_invite_users: true,
});
```
See
Telegram Bot API: setMyDefaultAdministratorRights
Inherited from BusinessAndEcosystemMethods.setMyDefaultAdministratorRights

setMyDescription

setMyDescription(description?: string, languageCode?: string): Promise<boolean>
Changes the bot's description, which is shown on the chat with the bot when empty.
Parameters
- Optionaldescription: string
  New bot description (0-512 characters). Pass undefined to remove description.
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When changing description fails.
Example
```
await bot.setMyDescription("An awesome assistant bot.", "en");
```
See
Telegram Bot API: setMyDescription
Inherited from BusinessAndEcosystemMethods.setMyDescription

setMyName

setMyName(name?: string, languageCode?: string): Promise<boolean>
Changes the bot's name.
Parameters
- Optionalname: string
  New bot name (0-64 characters). Pass empty or undefined to remove the name.
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When changing bot name fails.
Example
```
await bot.setMyName("CoolBot", "en");
```
See
Telegram Bot API: setMyName
Inherited from BusinessAndEcosystemMethods.setMyName

setMyProfilePhoto

setMyProfilePhoto(photo: unknown): Promise<boolean>
Sets the profile photo for the bot.
Parameters
- photo: unknown
  Photo file to set.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: setMyProfilePhoto

Inherited from BusinessAndEcosystemMethods.setMyProfilePhoto

setMyShortDescription

setMyShortDescription(
shortDescription?: string,
languageCode?: string,
): Promise<boolean>
Changes the bot's short description, which is shown on the bot's profile page and sent with links.
Parameters
- OptionalshortDescription: string
  New short description (0-120 characters). Pass undefined to remove.
- OptionallanguageCode: string
  Two-letter ISO 639-1 language code.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When changing short description fails.
Example
```
await bot.setMyShortDescription("Fast and powerful Telegram Bot", "en");
```
See
Telegram Bot API: setMyShortDescription
Inherited from BusinessAndEcosystemMethods.setMyShortDescription

setPassportDataErrors

setPassportDataErrors(
userId: number,
errors: PassportElementError[],
): Promise<boolean>
Informs a user that some of the Telegram Passport elements they provided contains errors.
Parameters
- userId: number
  User identifier.
- errors: PassportElementError[]
  Array describing the errors in the elements.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When reporting errors fails.

See
Telegram Bot API: setPassportDataErrors

Inherited from BusinessAndEcosystemMethods.setPassportDataErrors

setStickerEmojiList

setStickerEmojiList(sticker: string, emojiList: string[]): Promise<boolean>
Changes the list of emoji assigned to a regular or custom emoji sticker.
Parameters
- sticker: string
  File identifier of the sticker.
- emojiList: string[]
  List of 1-20 emoji associated with the sticker.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting emoji list fails.

See
Telegram Bot API: setStickerEmojiList

Inherited from BusinessAndEcosystemMethods.setStickerEmojiList

setStickerKeywords

setStickerKeywords(sticker: string, keywords?: string[]): Promise<boolean>
Changes search keywords for a sticker.
Parameters
- sticker: string
  File identifier of the sticker.
- Optionalkeywords: string[]
  List of 0-20 search keywords for the sticker.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting keywords fails.

See
Telegram Bot API: setStickerKeywords

Inherited from BusinessAndEcosystemMethods.setStickerKeywords

setStickerMaskPosition

setStickerMaskPosition(
sticker: string,
maskPosition?: MaskPosition,
): Promise<boolean>
Changes the mask position of a mask sticker.
Parameters
- sticker: string
  File identifier of the sticker.
- OptionalmaskPosition: MaskPosition
  Object with the position where the mask should be placed.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting mask position fails.

See
Telegram Bot API: setStickerMaskPosition

Inherited from BusinessAndEcosystemMethods.setStickerMaskPosition

setStickerPositionInSet

setStickerPositionInSet(sticker: string, position: number): Promise<boolean>
Moves a sticker in a set created by the bot to a specific position.
Parameters
- sticker: string
  File identifier of the sticker.
- position: number
  New 0-based position of the sticker in the set.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When moving position fails.

See
Telegram Bot API: setStickerPositionInSet

Inherited from BusinessAndEcosystemMethods.setStickerPositionInSet

setStickerSetThumbnail

setStickerSetThumbnail(
    name: string,
    userId: number,
    format: "static" | "animated" | "video",
    thumbnail?: string | InputFile,
): Promise<boolean>
Sets the thumbnail of a regular or custom emoji sticker set.
Parameters
- name: string
  Sticker set name.
- userId: number
  User identifier of the sticker set owner.
- format: "static" | "animated" | "video"
  Format of the thumbnail ("static", "animated", or "video").
- Optionalthumbnail: string | InputFile
  Thumbnail file identifier, URL, or InputFile.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When setting thumbnail fails.

See
Telegram Bot API: setStickerSetThumbnail

Inherited from BusinessAndEcosystemMethods.setStickerSetThumbnail

setStickerSetTitle

setStickerSetTitle(name: string, title: string): Promise<boolean>
Sets the title of a created sticker set.
Parameters
- name: string
  Sticker set name.
- title: string
  Sticker set title, 1-64 characters.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting title fails.
Example
```
await bot.setStickerSetTitle("my_pack", "My Awesome Sticker Pack");
```
See
Telegram Bot API: setStickerSetTitle
Inherited from BusinessAndEcosystemMethods.setStickerSetTitle

setUserEmojiStatus

setUserEmojiStatus(
    userId: number,
    emojiStatusCustomEmojiId?: string,
    options?: { emoji_status_expiration_date?: number },
): Promise<boolean>
Changes the emoji status for a given user that granted permission to the bot.
Parameters
- userId: number
  Unique identifier of the target user.
- OptionalemojiStatusCustomEmojiId: string
  Custom emoji identifier of the emoji status to set; pass an empty string to remove the status.
- options: { emoji_status_expiration_date?: number } = {}
  Optional emoji_status_expiration_date.
Returns Promise<boolean>
true on success.

Remarks
Serialized as the documented emoji_status_custom_emoji_id and emoji_status_expiration_date fields.

Throws
TelegramApiError When setting emoji status fails.

See
Telegram Bot API: setUserEmojiStatus

Inherited from BusinessAndEcosystemMethods.setUserEmojiStatus

setWebhook

setWebhook(options: SetWebhookOptions): Promise<boolean>
Configures a webhook URL to receive incoming updates via HTTPS POST requests.
Parameters
- options: SetWebhookOptions
  Webhook settings including url, optional secret_token, allowed_updates, and certificate.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When setting webhook fails.
Example
```
await bot.setWebhook({
  url: "https://bot.example.com/webhook",
  secret_token: "my-secret-token",
  allowed_updates: ["message", "callback_query"],
});
```
See
Telegram Bot API: setWebhook
Inherited from BusinessAndEcosystemMethods.setWebhook

shutdown

shutdown(): Promise<void>

Gracefully shuts down active client sessions and connections.

Returns Promise<void>

Inherited from BusinessAndEcosystemMethods.shutdown

sleep

sleep(seconds: number): Promise<void>
Helper utility to pause asynchronous execution for a given number of seconds.

Used internally during retry delays and rate-limit backoff.
Parameters
- seconds: number
  Duration in seconds to pause execution.
Returns Promise<void>
Promise that resolves once the specified duration elapses.
Example
```
await bot.sleep(2); // Pauses execution for 2 seconds
```
Inherited from BusinessAndEcosystemMethods.sleep

stopMessageLiveLocation

stopMessageLiveLocation(
options: StopMessageLiveLocationOptions,
): Promise<boolean | Message>
Stops updating a live location message before live_period expires.
Parameters
- options: StopMessageLiveLocationOptions
  Target message identifier options.
Returns Promise<boolean | Message>
The stopped Message or true if inline message.
Throws
TelegramApiError When stopping fails.
Example
```
await bot.stopMessageLiveLocation({
  chat_id: 123456,
  message_id: 456,
});
```
See
Telegram Bot API: stopMessageLiveLocation
Inherited from BusinessAndEcosystemMethods.stopMessageLiveLocation

stopPoll

stopPoll(
    chatId: string | number,
    messageId: number,
    options?: StopPollOptions,
): Promise<Poll>
Stops a poll which was sent by the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat or channel.
- messageId: number
  Identifier of the original message with the poll.
- options: StopPollOptions = {}
  Additional stop options.
Returns Promise<Poll>
The final stopped Poll state.
Throws
TelegramApiError When stopping poll fails.
Example
```
const poll = await bot.stopPoll(chatId, messageId);
console.log(`Total voters: ${poll.total_voter_count}`);
```
See
Telegram Bot API: stopPoll
Inherited from BusinessAndEcosystemMethods.stopPoll

transferBusinessAccountStars

transferBusinessAccountStars(
businessConnectionId: string,
starCount: number,
): Promise<boolean>
Transfers Telegram Stars from a business account.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- starCount: number
  Number of stars to transfer.
Returns Promise<boolean>
true on success.

See
Telegram Bot API: transferBusinessAccountStars

Inherited from BusinessAndEcosystemMethods.transferBusinessAccountStars

transferGift

transferGift(
    businessConnectionId: string,
    ownedGiftId: string,
    newOwnerChatId: number,
    options?: TransferGiftOptions,
): Promise<boolean>
Transfers an owned unique gift to another user or chat.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- ownedGiftId: string
  Unique identifier of the gift to transfer.
- newOwnerChatId: number
  Unique identifier of the chat which will own the gift.
- options: TransferGiftOptions = {}
  Optional star_count paid for the transfer from the business account balance.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: transferGift

Inherited from BusinessAndEcosystemMethods.transferGift

transformRequest

transformRequest(hook: RequestTransformFn, tag?: string): this
Registers a hook invoked before every outgoing Bot API request.

Hooks run in registration order and may mutate the payload. Intended for plugins that need to observe or decorate all API traffic (logging, metrics, throttling signals, test mocks).
Parameters
- hook: RequestTransformFn
  Callback receiving the method name and the mutable payload.
- Optionaltag: string
  Optional owner tag; all hooks sharing a tag can be removed together via BaseBotClient.removeHooksByTag.
Returns this
This client instance for chaining.
Example
```
bot.transformRequest((method, payload) => {
  console.log(`Calling ${method}`);
  payload["protect_content"] = true;
});
```
Inherited from BusinessAndEcosystemMethods.transformRequest

transformResponse

transformResponse(hook: ResponseTransformFn, tag?: string): this
Registers a hook invoked with every successful Bot API response.

Hooks run in registration order. Returning a value replaces the result for subsequent hooks and the caller; returning undefined keeps it unchanged. Useful for response logging, caching, or normalization plugins.
Parameters
- hook: ResponseTransformFn
  Callback receiving the method name and the unwrapped result.
- Optionaltag: string
  Optional owner tag for grouped removal via BaseBotClient.removeHooksByTag.
Returns this
This client instance for chaining.
Example
```
bot.transformResponse((method, result) => {
  console.log(`${method} succeeded`);
});
```
Inherited from BusinessAndEcosystemMethods.transformResponse

unbanChatMember

unbanChatMember(
    chatId: string | number,
    userId: number,
    onlyIfBanned?: boolean,
): Promise<boolean>
Unbans a previously banned user in a supergroup or channel.
Parameters
- chatId: string | number
  Unique identifier for the target group or channel.
- userId: number
  Unique identifier of the target user.
- OptionalonlyIfBanned: boolean
  Do nothing if the user is not banned.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When unbanning fails.
Example
```
await bot.unbanChatMember(chatId, userId);
```
See
Telegram Bot API: unbanChatMember
Inherited from BusinessAndEcosystemMethods.unbanChatMember

unbanChatSenderChat

unbanChatSenderChat(
chatId: string | number,
senderChatId: number,
): Promise<boolean>
Unbans a previously banned channel in a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- senderChatId: number
  Unique identifier of the target sender channel.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When unbanning sender chat fails.
Example
```
await bot.unbanChatSenderChat(chatId, channelId);
```
See
Telegram Bot API: unbanChatSenderChat
Inherited from BusinessAndEcosystemMethods.unbanChatSenderChat

unhideGeneralForumTopic

unhideGeneralForumTopic(chatId: string | number): Promise<boolean>
Unhides the 'General' topic in a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When unhiding General topic fails.
Example
```
await bot.unhideGeneralForumTopic(-1001234567890);
```
See
Telegram Bot API: unhideGeneralForumTopic
Inherited from BusinessAndEcosystemMethods.unhideGeneralForumTopic

unpinAllChatMessages

unpinAllChatMessages(chatId: string | number): Promise<boolean>
Clears the list of pinned messages in a chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When clearing pinned messages fails.

See
Telegram Bot API: unpinAllChatMessages

Inherited from BusinessAndEcosystemMethods.unpinAllChatMessages

unpinAllForumTopicMessages

unpinAllForumTopicMessages(
chatId: string | number,
messageThreadId: number,
): Promise<boolean>
Clears the list of pinned messages in a forum topic.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- messageThreadId: number
  Unique identifier for the target message thread of the forum topic.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When unpinning messages fails.
Example
```
await bot.unpinAllForumTopicMessages(-1001234567890, 42);
```
See
Telegram Bot API: unpinAllForumTopicMessages
Inherited from BusinessAndEcosystemMethods.unpinAllForumTopicMessages

unpinAllGeneralForumTopicMessages

unpinAllGeneralForumTopicMessages(chatId: string | number): Promise<boolean>
Clears the list of pinned messages in the 'General' topic of a forum supergroup chat.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When unpinning General topic messages fails.
Example
```
await bot.unpinAllGeneralForumTopicMessages(-1001234567890);
```
See
Telegram Bot API: unpinAllGeneralForumTopicMessages
Inherited from BusinessAndEcosystemMethods.unpinAllGeneralForumTopicMessages

unpinChatMessage

unpinChatMessage(
    chatId: string | number,
    messageId?: number,
    businessConnectionId?: string,
): Promise<boolean>
Unpins a message in a group, a supergroup, or a channel.
Parameters
- chatId: string | number
  Unique identifier for the target chat.
- OptionalmessageId: number
  Identifier of a message to unpin. If not specified, the most recent pinned message is unpinned.
- OptionalbusinessConnectionId: string
  Unique identifier of the business connection on behalf of which the message will be unpinned.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When unpinning fails.

See
Telegram Bot API: unpinChatMessage

Inherited from BusinessAndEcosystemMethods.unpinChatMessage

upgradeGift

upgradeGift(
    businessConnectionId: string,
    ownedGiftId: string,
    options?: UpgradeGiftOptions,
): Promise<boolean>
Upgrades a regular gift owned by a managed business account to a unique gift.
Parameters
- businessConnectionId: string
  Unique identifier of the business connection.
- ownedGiftId: string
  Unique identifier of the regular gift to upgrade.
- options: UpgradeGiftOptions = {}
  Optional keep_original_details and star_count parameters.
Returns Promise<boolean>
true on success.

Throws
TelegramApiError When the request fails.

See
Telegram Bot API: upgradeGift

Inherited from BusinessAndEcosystemMethods.upgradeGift

uploadStickerFile

uploadStickerFile(
    userId: number,
    sticker: string | InputFile,
    stickerFormat: "static" | "animated" | "video",
): Promise<File>
Uploads a file with a sticker for later use in createNewStickerSet and addStickerToSet methods.
Parameters
- userId: number
  User identifier of sticker file owner.
- sticker: string | InputFile
  A file with the sticker (.PNG, .WEBP, .TGS, or .WEBM).
- stickerFormat: "static" | "animated" | "video"
  Format of the sticker: "static", "animated", or "video".
Returns Promise<File>
The uploaded File object.
Throws
TelegramApiError When upload fails.
Example
```
const file = await bot.uploadStickerFile(userId, stickerInputFile, "static");
```
See
Telegram Bot API: uploadStickerFile
Inherited from BusinessAndEcosystemMethods.uploadStickerFile

verifyChat

verifyChat(
chatId: string | number,
customDescription?: string,
): Promise<boolean>
Verifies a chat on behalf of the organization which owns the bot.
Parameters
- chatId: string | number
  Unique identifier for the target chat or username of the target channel.
- OptionalcustomDescription: string
  Custom description for the verification status; 0-70 characters.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When verification fails.
Example
```
await bot.verifyChat(chatId, "Verified Community");
```
See
Telegram Bot API: verifyChat
Inherited from BusinessAndEcosystemMethods.verifyChat

verifyUser

verifyUser(userId: number, customDescription?: string): Promise<boolean>
Verifies a user on behalf of the organization which owns the bot.
Parameters
- userId: number
  Unique identifier of the target user.
- OptionalcustomDescription: string
  Custom description for the verification status; 0-70 characters.
Returns Promise<boolean>
true on success.
Throws
TelegramApiError When verification fails.
Example
```
await bot.verifyUser(123456, "Official Staff");
```
See
Telegram Bot API: verifyUser
Inherited from BusinessAndEcosystemMethods.verifyUser

Class Bot

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Bot

Properties

Protected Readonly_fetch

Type Declaration

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

ReadonlyapiRoot

Protected Optional ReadonlybaseDelayMs

Readonlyoptions

Protected ReadonlyrequestTimeoutMs

Readonlytoken

Methods

addStickerToSet

Parameters

Returns Promise<boolean>

Throws

See

answerCallbackQuery

Parameters

Returns Promise<boolean>

Throws

Example

See

answerChatJoinRequestQuery

Parameters

Returns Promise<boolean>

See

answerGuestQuery

Parameters

Returns Promise<{ inline_message_id?: string }>

See

answerInlineQuery

Parameters

Returns Promise<boolean>

Throws

Remarks

Example

See

answerPreCheckoutQuery

Parameters

Returns Promise<boolean>

Throws

Example

See

answerShippingQuery

Parameters

Returns Promise<boolean>

Throws

Example

See

answerWebAppQuery

Parameters

Returns Promise<{ inline_message_id?: string }>

Throws

See

approveChatJoinRequest

Parameters

Returns Promise<boolean>

Throws

Example

See

approveSuggestedPost

Parameters

Returns Promise<boolean>

Throws

See

banChatMember

Parameters

`Protected` `Readonly`_fetch

`Readonly`apiRoot

`Protected` `Optional` `Readonly`baseDelayMs

`Readonly`options

`Protected` `Readonly`requestTimeoutMs

`Readonly`token