Readonly
botReadonly
stateReadonly
telegramReadonly
updateRest
...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]Rest
https://core.telegram.org/bots/api#banchatmember
since API 5.3. Use Context.banChatMember
Shorthand for any message
object present in the current update. One of
message
, edited_message
, channel_post
, edited_channel_post
or
callback_query.message
Shorthand for any message_id present in the current update.
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.
Context-aware shorthand for Telegram.copyMessages
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
Optional
extra: Omit<{}, "chat_id" | "from_chat_id" | "message_ids">Optional
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.
Rest
...args: [name: string, extra?: Omit<{}, "chat_id" | "name">]Rest
Context-aware shorthand for Telegram.deleteMessages
Identifiers of 1-100 messages to delete. See deleteMessage for limitations on which messages can be deleted
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
Optional
extra: Omit<{}, "caption" | "chat_id" | "message_id" | "inline_message_id">Optional
Optional
extra: Omit<{}, "chat_id" | "message_id" | "inline_message_id" | "media">Optional
Optional
extra: Omit<{}, "text" | "chat_id" | "message_id" | "inline_message_id">Optional
Rest
...types: EntityTypesRest
Shorthand for Telegram.forwardMessages
Optional
extra: Omit<{}, "chat_id" | "from_chat_id" | "message_ids">Optional
Shorthand for Telegram.getUserChatBoosts
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.
chat action type.
a function to run along with the chat action.
extra parameters for sendChatAction.
https://core.telegram.org/bots/api#sendchataction
Sends the sendChatAction request repeatedly, with a delay between requests, as long as the provided callback function is being processed.
The sendChatAction errors should be ignored, because the goal is the actual long process completing and performing an action.
Shorthand for Telegram.setMessageReaction
Optional
reaction: MaybeArray<ReactionType | TelegramEmoji | `0${string}` | `1${string}` | `2${string}` | `3${string}` | `4${string}` | `5${string}` | `6${string}` | `7${string}` | `8${string}` | `9${string}`>An emoji or custom_emoji_id to set as reaction to current message. Leave empty to remove reactions.
Optional
Optional
is_big: booleanPass True to set the reaction with a big animation
Optional
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.
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.
Rest
...args: [text: string | FmtString<string>, extra?: Omit<{}, "text" | "chat_id">]Rest
Rest
...args: [animation: string | InputFile, extra?: { Rest
Rest
...args: [audio: string | InputFile, extra?: { Rest
Rest
...args: [action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", extra?: Omit<{}, "action" | "chat_id">]Rest
Rest
...args: [document: string | InputFile, extra?: { Rest
Rest
...args: [invoice: Omit<{}, "chat_id" | "message_thread_id" | "disable_notification" | "reply_parameters" | "reply_markup">, extra?: Omit<{}, "chat_id" | "protect_content" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter">]Rest
Rest
...args: [media: MediaGroup, extra?: Omit<{}, "chat_id" | "media">]Rest
Rest
...args: [photo: string | InputFile, extra?: { Rest
Rest
...args: [video: string | InputFile, extra?: { Rest
Rest
...args: [voice: string | InputFile, extra?: { Rest
Optional
extra: Omit<{}, "action" | "chat_id">Optional
Optional
extra: Omit<{}, "chat_id" | "protect_content" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter">Optional
Optional
extra: Omit<{}, "chat_id" | "media">Optional
Optional
extra: Omit<{}, "text" | "chat_id">Optional
Generated using TypeDoc
See
https://core.telegram.org/bots/api#banchatmember