Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy/core/api.ts>Api

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
class Api
import { Api } from "https://deno.land/x/grammy@v1.30.1/core/api.ts";

This class provides access to the full Telegram Bot API. All methods of the API have an equivalent on this class, with the most important parameters pulled up into the function signature, and the other parameters captured by an object.

In addition, this class has a property raw that provides raw access to the complete Telegram API, with the method signatures 1:1 represented as documented on the website (https://core.telegram.org/bots/api).

Every method takes an optional AbortSignal object that allows you to cancel the request if desired.

In advanced use cases, this class allows to install transformers that can modify the method and payload on the fly before sending it to the Telegram servers. Confer the config property for this.

Constructors

new
Api(
token: string,
options?: ApiClientOptions,
webhookReplyEnvelope?: WebhookReplyEnvelope,
)

Constructs a new instance of Api. It is independent from all other instances of this class. For example, this lets you install a custom set if transformers.

Type Parameters

optional
R extends RawApi = RawApi

Properties

readonly
config: { readonly use: TransformerConsumer<R>; readonly installedTransformers: () => Transformer<R>[]; }

Configuration object for the API instance, used as a namespace to separate those API operations that are related to grammY from methods of the Telegram Bot API. Contains advanced options!

readonly
raw: R

Provides access to all methods of the Telegram Bot API exactly as documented on the website (https://core.telegram.org/bots/api). No arguments are pulled up in the function signature for convenience.

If you suppress compiler warnings, this also allows for raw api calls to undocumented methods with arbitrary parameters—use only if you know what you are doing.

Methods

addStickerToSet(
user_id: number,
name: string,
sticker: InputSticker,
signal?: AbortSignal,
)

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

answerCallbackQuery(
callback_query_id: string,
other?: Other<R, "answerCallbackQuery", "callback_query_id">,
signal?: AbortSignal,
)

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

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

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

Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.

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

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

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

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

answerWebAppQuery(
web_app_query_id: string,
signal?: AbortSignal,
)

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

approveChatJoinRequest(
chat_id: number | string,
user_id: number,
signal?: AbortSignal,
)

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

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

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

banChatSenderChat(
chat_id: number | string,
sender_chat_id: number,
signal?: AbortSignal,
)

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

close(signal?: AbortSignal)

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

closeForumTopic(
chat_id: number | string,
message_thread_id: number,
signal?: AbortSignal,
)

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

closeGeneralForumTopic(chat_id: number | string, signal?: AbortSignal)

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

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

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

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

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

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

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

createNewStickerSet(
user_id: number,
name: string,
title: string,
stickers: InputSticker[],
other?: Other<R, "createNewStickerSet",
| "user_id"
| "name"
| "title"
| "sticker_format"
| "stickers"
>,
signal?: AbortSignal,
)

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

declineChatJoinRequest(
chat_id: number | string,
user_id: number,
signal?: AbortSignal,
)

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

deleteChatPhoto(chat_id: number | string, signal?: AbortSignal)

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

deleteChatStickerSet(chat_id: number | string, signal?: AbortSignal)

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

deleteForumTopic(
chat_id: number | string,
message_thread_id: number,
signal?: AbortSignal,
)

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

deleteMessage(
chat_id: number | string,
message_id: number,
signal?: AbortSignal,
)

Use this method to delete a message, including service messages, with the following limitations:

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

Use this method to delete multiple messages simultaneously. Returns True on success.

deleteMyCommands(other?: Other<R, "deleteMyCommands">, signal?: AbortSignal)

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

deleteStickerFromSet(sticker: string, signal?: AbortSignal)

Use this method to delete a sticker from a set created by the bot. Returns True on success.

deleteStickerSet(name: string, signal?: AbortSignal)

Use this method to delete a sticker set that was created by the bot. Returns True on success.

deleteWebhook(other?: Other<R, "deleteWebhook">, signal?: AbortSignal)

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

editForumTopic(
chat_id: number | string,
message_thread_id: number,
other?: Other<R, "editForumTopic", "chat_id" | "message_thread_id">,
signal?: AbortSignal,
)

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

editGeneralForumTopic(
chat_id: number | string,
name: string,
signal?: AbortSignal,
)

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

editMessageCaption(
chat_id: number | string,
message_id: number,
other?: Other<R, "editMessageCaption", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

editMessageCaptionInline(
inline_message_id: string,
other?: Other<R, "editMessageCaption", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

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

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

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

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

editMessageMedia(
chat_id: number | string,
message_id: number,
media: InputMedia,
other?: Other<R, "editMessageMedia",
| "chat_id"
| "message_id"
| "inline_message_id"
| "media"
>,
signal?: AbortSignal,
)

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

editMessageMediaInline(
inline_message_id: string,
media: InputMedia,
other?: Other<R, "editMessageMedia",
| "chat_id"
| "message_id"
| "inline_message_id"
| "media"
>,
signal?: AbortSignal,
)

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

editMessageReplyMarkup(
chat_id: number | string,
message_id: number,
other?: Other<R, "editMessageReplyMarkup", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

editMessageReplyMarkupInline(
inline_message_id: string,
other?: Other<R, "editMessageReplyMarkup", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

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

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

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

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

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

Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

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

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

getBusinessConnection(business_connection_id: string, signal?: AbortSignal)

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

getChat(chat_id: number | string, signal?: AbortSignal)

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

getChatAdministrators(chat_id: number | string, signal?: AbortSignal)

Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

getChatMember(
chat_id: number | string,
user_id: number,
signal?: AbortSignal,
)

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

getChatMemberCount(chat_id: number | string, signal?: AbortSignal)

Use this method to get the number of members in a chat. Returns Int on success.

deprecated
getChatMembersCount(...args: Parameters<Api["getChatMemberCount"]>)
getChatMenuButton(other?: Other<R, "getChatMenuButton">, signal?: AbortSignal)

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

getCustomEmojiStickers(custom_emoji_ids: string[], signal?: AbortSignal)

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

getFile(file_id: string, signal?: AbortSignal)

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

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

getForumTopicIconStickers(signal?: AbortSignal)

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

getGameHighScores(
chat_id: number,
message_id: number,
user_id: number,
signal?: AbortSignal,
)

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.

getGameHighScoresInline(
inline_message_id: string,
user_id: number,
signal?: AbortSignal,
)

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in an inline game. On success, returns an Array of GameHighScore objects.

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.

getMe(signal?: AbortSignal)

A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

getMyCommands(other?: Other<R, "getMyCommands">, signal?: AbortSignal)

Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

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

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

getMyDescription(other?: Other<R, "getMyDescription">, signal?: AbortSignal)

Use this method to get the current bot description for the given user language. Returns BotDescription on success.

getMyName(other?: Other<R, "getMyName">, signal?: AbortSignal)

Use this method to get the current bot name for the given user language. Returns BotName on success.

getMyShortDescription(other?: Other<R, "getMyShortDescription">, signal?: AbortSignal)

Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

getStarTransactions(other?: Other<R, "getStarTransactions">, signal?: AbortSignal)

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

getStickerSet(name: string, signal?: AbortSignal)

Use this method to get a sticker set. On success, a StickerSet object is returned.

getUpdates(other?: Other<R, "getUpdates">, signal?: AbortSignal)

Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Notes

  1. This method will not work if an outgoing webhook is set up.
  2. In order to avoid getting duplicate updates, recalculate offset after each server response.
getUserChatBoosts(
chat_id: number | string,
user_id: number,
signal?: AbortSignal,
)

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

getUserProfilePhotos(
user_id: number,
other?: Other<R, "getUserProfilePhotos", "user_id">,
signal?: AbortSignal,
)

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

getWebhookInfo(signal?: AbortSignal)

Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

hideGeneralForumTopic(chat_id: number | string, signal?: AbortSignal)

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

deprecated
kickChatMember(...args: Parameters<Api["banChatMember"]>)
leaveChat(chat_id: number | string, signal?: AbortSignal)

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

logOut(signal?: AbortSignal)

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

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

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

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

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

refundStarPayment(
user_id: number,
telegram_payment_charge_id: string,
signal?: AbortSignal,
)

Refunds a successful payment in Telegram Stars.

reopenForumTopic(
chat_id: number | string,
message_thread_id: number,
signal?: AbortSignal,
)

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

reopenGeneralForumTopic(chat_id: number | string, signal?: AbortSignal)

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

replaceStickerInSet(
user_id: number,
name: string,
old_sticker: string,
sticker: InputSticker,
signal?: AbortSignal,
)

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

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

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

sendAnimation(
chat_id: number | string,
animation: InputFile | string,
other?: Other<R, "sendAnimation", "chat_id" | "animation">,
signal?: AbortSignal,
)

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

sendAudio(
chat_id: number | string,
audio: InputFile | string,
other?: Other<R, "sendAudio", "chat_id" | "audio">,
signal?: AbortSignal,
)

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

For sending voice messages, use the sendVoice method instead.

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

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

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

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

sendContact(
chat_id: number | string,
phone_number: string,
first_name: string,
other?: Other<R, "sendContact", "chat_id" | "phone_number" | "first_name">,
signal?: AbortSignal,
)

Use this method to send phone contacts. On success, the sent Message is returned.

sendDice(
chat_id: number | string,
emoji:
| (string & Record<never, never>)
| "🎲"
| "🎯"
| "🏀"
| "⚽"
| "🎳"
| "🎰"
,
other?: Other<R, "sendDice", "chat_id" | "emoji">,
signal?: AbortSignal,
)

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

sendDocument(
chat_id: number | string,
document: InputFile | string,
other?: Other<R, "sendDocument", "chat_id" | "document">,
signal?: AbortSignal,
)

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

sendGame(
chat_id: number,
game_short_name: string,
other?: Other<R, "sendGame", "chat_id" | "game_short_name">,
signal?: AbortSignal,
)

Use this method to send a game. On success, the sent Message is returned.

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

Use this method to send invoices. On success, the sent Message is returned.

sendLocation(
chat_id: number | string,
latitude: number,
longitude: number,
other?: Other<R, "sendLocation", "chat_id" | "latitude" | "longitude">,
signal?: AbortSignal,
)

Use this method to send point on the map. On success, the sent Message is returned.

sendMediaGroup(
chat_id: number | string,
other?: Other<R, "sendMediaGroup", "chat_id" | "media">,
signal?: AbortSignal,
)

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

sendMessage(
chat_id: number | string,
text: string,
other?: Other<R, "sendMessage", "chat_id" | "text">,
signal?: AbortSignal,
)

Use this method to send text messages. On success, the sent Message is returned.

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

Use this method to send paid media. On success, the sent Message is returned.

sendPhoto(
chat_id: number | string,
photo: InputFile | string,
other?: Other<R, "sendPhoto", "chat_id" | "photo">,
signal?: AbortSignal,
)

Use this method to send photos. On success, the sent Message is returned.

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

Use this method to send a native poll. On success, the sent Message is returned.

sendSticker(
chat_id: number | string,
sticker: InputFile | string,
other?: Other<R, "sendSticker", "chat_id" | "sticker">,
signal?: AbortSignal,
)

Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

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

Use this method to send information about a venue. On success, the sent Message is returned.

sendVideo(
chat_id: number | string,
video: InputFile | string,
other?: Other<R, "sendVideo", "chat_id" | "video">,
signal?: AbortSignal,
)

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

sendVideoNote(
chat_id: number | string,
video_note: InputFile | string,
other?: Other<R, "sendVideoNote", "chat_id" | "video_note">,
signal?: AbortSignal,
)

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

sendVoice(
chat_id: number | string,
voice: InputFile | string,
other?: Other<R, "sendVoice", "chat_id" | "voice">,
signal?: AbortSignal,
)

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

setChatAdministratorCustomTitle(
chat_id: number | string,
user_id: number,
custom_title: string,
signal?: AbortSignal,
)

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

setChatDescription(
chat_id: number | string,
description?: string,
signal?: AbortSignal,
)

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

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

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

setChatPermissions(
chat_id: number | string,
permissions: ChatPermissions,
other?: Other<R, "setChatPermissions", "chat_id" | "permissions">,
signal?: AbortSignal,
)

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

setChatPhoto(
chat_id: number | string,
photo: InputFile,
signal?: AbortSignal,
)

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

setChatStickerSet(
chat_id: number | string,
sticker_set_name: string,
signal?: AbortSignal,
)

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

setChatTitle(
chat_id: number | string,
title: string,
signal?: AbortSignal,
)

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

setCustomEmojiStickerSetThumbnail(
name: string,
custom_emoji_id: string,
signal?: AbortSignal,
)

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

setGameScore(
chat_id: number,
message_id: number,
user_id: number,
score: number,
other?: Other<R, "setGameScore",
| "chat_id"
| "message_id"
| "inline_message_id"
| "user_id"
| "score"
>,
signal?: AbortSignal,
)

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

setGameScoreInline(
inline_message_id: string,
user_id: number,
score: number,
other?: Other<R, "setGameScore",
| "chat_id"
| "message_id"
| "inline_message_id"
| "user_id"
| "score"
>,
signal?: AbortSignal,
)

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

setMessageReaction(
chat_id: number | string,
message_id: number,
reaction: ReactionType[],
other?: Other<R, "setMessageReaction", "chat_id" | "message_id" | "reaction">,
signal?: AbortSignal,
)

Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.

setMyCommands(
commands: readonly BotCommand[],
other?: Other<R, "setMyCommands", "commands">,
signal?: AbortSignal,
)

Use this method to change the list of the bot's commands. See https://core.telegram.org/bots/features#commands for more details about bot commands. Returns True on success.

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

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

setMyDescription(
description: string,
other?: Other<R, "setMyDescription", "description">,
signal?: AbortSignal,
)

Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

setMyName(
name: string,
other?: Other<R, "setMyName", "name">,
signal?: AbortSignal,
)

Use this method to change the bot's name. Returns True on success.

setMyShortDescription(
short_description: string,
other?: Other<R, "setMyShortDescription", "short_description">,
signal?: AbortSignal,
)

Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.

setPassportDataErrors(
user_id: number,
errors: readonly PassportElementError[],
signal?: AbortSignal,
)

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

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

setStickerEmojiList(
sticker: string,
emoji_list: string[],
signal?: AbortSignal,
)

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

setStickerKeywords(
sticker: string,
keywords: string[],
signal?: AbortSignal,
)

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

setStickerMaskPosition(
sticker: string,
mask_position?: MaskPosition,
signal?: AbortSignal,
)

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

setStickerPositionInSet(
sticker: string,
position: number,
signal?: AbortSignal,
)

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

setStickerSetThumbnail(
name: string,
user_id: number,
thumbnail: InputFile | string | undefined,
format: "static" | "animated" | "video",
signal?: AbortSignal,
)

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

setStickerSetTitle(
name: string,
title: string,
signal?: AbortSignal,
)

Use this method to set the title of a created sticker set. Returns True on success.

setWebhook(
url: string,
other?: Other<R, "setWebhook", "url">,
signal?: AbortSignal,
)

Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

Notes

  1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
  2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
  3. Ports currently supported for Webhooks: 443, 80, 88, 8443.

If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

stopMessageLiveLocation(
chat_id: number | string,
message_id: number,
other?: Other<R, "stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

stopMessageLiveLocationInline(
inline_message_id: string,
other?: Other<R, "stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">,
signal?: AbortSignal,
)

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

stopPoll(
chat_id: number | string,
message_id: number,
other?: Other<R, "stopPoll", "chat_id" | "message_id">,
signal?: AbortSignal,
)

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

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

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

unbanChatSenderChat(
chat_id: number | string,
sender_chat_id: number,
signal?: AbortSignal,
)

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

unhideGeneralForumTopic(chat_id: number | string, signal?: AbortSignal)

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

unpinAllChatMessages(chat_id: number | string, signal?: AbortSignal)

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

unpinAllForumTopicMessages(
chat_id: number | string,
message_thread_id: number,
signal?: AbortSignal,
)

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

unpinAllGeneralForumTopicMessages(chat_id: number | string, signal?: AbortSignal)

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

unpinChatMessage(
chat_id: number | string,
message_id?: number,
signal?: AbortSignal,
)

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

uploadStickerFile(
user_id: number,
sticker_format: "static" | "animated" | "video",
sticker: InputFile,
signal?: AbortSignal,
)

Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.