@apicity/telegram

中文文档
0.26.0发布于 2026/11/05MITTypeScriptES Module近 30 天下载 4752

Telegram Bot API provider for sending messages, media, polls, and rich messages.

原始使用文档
文档目录142 节
  1. Installation
  2. Quick Start
  3. Setup
  4. API Reference
  5. addStickerToSet
  6. answerCallbackQuery
  7. answerChatJoinRequestQuery
  8. answerGuestQuery
  9. answerInlineQuery
  10. answerPreCheckoutQuery
  11. answerShippingQuery
  12. answerWebAppQuery
  13. approveChatJoinRequest
  14. approveSuggestedPost
  15. banChatMember
  16. banChatSenderChat
  17. close
  18. closeForumTopic
  19. closeGeneralForumTopic
  20. convertGiftToStars
  21. copyMessage
  22. copyMessages
  23. createChatInviteLink
  24. createChatSubscriptionInviteLink
  25. createForumTopic
  26. createInvoiceLink
  27. createNewStickerSet
  28. declineChatJoinRequest
  29. declineSuggestedPost
  30. deleteAllMessageReactions
  31. deleteBusinessMessages
  32. deleteChatPhoto
  33. deleteChatStickerSet
  34. deleteForumTopic
  35. deleteMessage
  36. deleteMessageReaction
  37. deleteMessages
  38. deleteMyCommands
  39. deleteStickerFromSet
  40. deleteStickerSet
  41. deleteStory
  42. deleteWebhook
  43. editChatInviteLink
  44. editChatSubscriptionInviteLink
  45. editForumTopic
  46. editGeneralForumTopic
  47. editMessageCaption
  48. editMessageChecklist
  49. editMessageLiveLocation
  50. editMessageMedia
  51. editMessageReplyMarkup
  52. editMessageText
  53. editStory
  54. editUserStarSubscription
  55. exportChatInviteLink
  56. forwardMessage
  57. forwardMessages
  58. getAvailableGifts
  59. getBusinessAccountGifts
  60. getBusinessAccountStarBalance
  61. getBusinessConnection
  62. getChat
  63. getChatAdministrators
  64. getChatGifts
  65. getChatMember
  66. getChatMemberCount
  67. getChatMenuButton
  68. getCustomEmojiStickers
  69. getFile
  70. getForumTopicIconStickers
  71. getGameHighScores
  72. getManagedBotAccessSettings
  73. getManagedBotToken
  74. getMe
  75. getMyCommands
  76. getMyDefaultAdministratorRights
  77. getMyDescription
  78. getMyName
  79. getMyShortDescription
  80. getMyStarBalance
  81. getStarTransactions
  82. getStickerSet
  83. getUpdates
  84. getUserChatBoosts
  85. getUserGifts
  86. getUserPersonalChatMessages
  87. getUserProfileAudios
  88. getUserProfilePhotos
  89. getWebhookInfo
  90. giftPremiumSubscription
  91. hideGeneralForumTopic
  92. leaveChat
  93. logOut
  94. pinChatMessage
  95. postStory
  96. promoteChatMember
  97. readBusinessMessage
  98. refundStarPayment
  99. removeBusinessAccountProfilePhoto
  100. removeChatVerification
  101. removeMyProfilePhoto
  102. removeUserVerification
  103. reopenForumTopic
  104. reopenGeneralForumTopic
  105. replaceManagedBotToken
  106. replaceStickerInSet
  107. repostStory
  108. restrictChatMember
  109. revokeChatInviteLink
  110. savePreparedInlineMessage
  111. savePreparedKeyboardButton
  112. sendAnimation
  113. sendAudio
  114. sendChatAction
  115. sendChatJoinRequestWebApp
  116. sendChecklist
  117. sendContact
  118. sendDice
  119. sendDocument
  120. sendGame
  121. sendGift
  122. sendInvoice
  123. sendLivePhoto
  124. sendLocation
  125. sendMediaGroup
  126. sendMessage
  127. sendMessageDraft
  128. sendPaidMedia
  129. sendPhoto
  130. sendPoll
  131. sendRichMessage
  132. sendRichMessageDraft
  133. sendSticker
  134. sendVenue
  135. sendVideo
  136. sendVideoNote
  137. sendVoice
  138. setBusinessAccountBio
  139. setBusinessAccountGiftSettings
  140. setBusinessAccountName
  141. setBusinessAccountProfilePhoto
  142. setBusinessAccountUsername

@apicity/telegram

npm dependencies TypeScript docs

Telegram Bot API provider for sending messages, media, polls, and rich messages.

Runtime dependencies:

  • zod@^4.6.6 — request schemas attached to every POST endpoint as .schema

Installation

npm install @apicity/telegram
# or
pnpm add @apicity/telegram

Quick Start

import { createTelegram } from "@apicity/telegram";

const telegram = createTelegram({ botToken: process.env.TELEGRAM_BOT_KEY! });

Setup

This package uses a Telegram Bot API token. In this repo, TELEGRAM_BOT_KEY resolves from 1Password for @apicitylogbot.

import { createTelegram } from "@apicity/telegram";

const telegram = createTelegram({
  botToken: process.env.TELEGRAM_BOT_KEY!,
});

await telegram.sendMessage({
  chat_id: "@your_channel_or_chat_id",
  text: "hello from @apicity/telegram",
});

const photo = new Blob(["image bytes"], { type: "image/png" });
await telegram.sendPhoto({
  chat_id: "@your_channel_or_chat_id",
  photo,
  caption: "uploaded from @apicitylogbot",
});

Notes

  • chat_id can be a numeric chat id or a username such as @channelname.
  • photo, video, audio, thumbnail, and cover accept a Telegram file_id, an HTTP URL, an attach://... reference, or a Blob.
  • Blob payloads are sent as multipart/form-data; string payloads use application/json.
  • Recorded examples redact bot tokens, webhook secret tokens, payment payloads, passport data, Telegram file identifiers, and Blob bytes.

API Reference

180 endpoints across 180 groups. Each method mirrors an upstream URL path.

addStickerToSet

POST telegram.addStickerToSet

POST https://api.telegram.org/bot{token}/addStickerToSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.addStickerToSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerCallbackQuery

POST telegram.answerCallbackQuery

POST https://api.telegram.org/bot{token}/answerCallbackQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerCallbackQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerChatJoinRequestQuery

POST telegram.answerChatJoinRequestQuery

POST https://api.telegram.org/bot{token}/answerChatJoinRequestQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerChatJoinRequestQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerGuestQuery

POST telegram.answerGuestQuery

POST https://api.telegram.org/bot{token}/answerGuestQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerGuestQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerInlineQuery

POST telegram.answerInlineQuery

POST https://api.telegram.org/bot{token}/answerInlineQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerInlineQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerPreCheckoutQuery

POST telegram.answerPreCheckoutQuery

POST https://api.telegram.org/bot{token}/answerPreCheckoutQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerPreCheckoutQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerShippingQuery

POST telegram.answerShippingQuery

POST https://api.telegram.org/bot{token}/answerShippingQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerShippingQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

answerWebAppQuery

POST telegram.answerWebAppQuery

POST https://api.telegram.org/bot{token}/answerWebAppQuery

Cost tier: cheap

Upstream docs ↗

const res = await telegram.answerWebAppQuery({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

approveChatJoinRequest

POST telegram.approveChatJoinRequest

POST https://api.telegram.org/bot{token}/approveChatJoinRequest

Cost tier: cheap

Upstream docs ↗

const res = await telegram.approveChatJoinRequest({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

approveSuggestedPost

POST telegram.approveSuggestedPost

POST https://api.telegram.org/bot{token}/approveSuggestedPost

Cost tier: cheap

Upstream docs ↗

const res = await telegram.approveSuggestedPost({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

banChatMember

POST telegram.banChatMember

POST https://api.telegram.org/bot{token}/banChatMember

Cost tier: cheap

Upstream docs ↗

const res = await telegram.banChatMember({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

banChatSenderChat

POST telegram.banChatSenderChat

POST https://api.telegram.org/bot{token}/banChatSenderChat

Cost tier: cheap

Upstream docs ↗

const res = await telegram.banChatSenderChat({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

close

POST telegram.close

POST https://api.telegram.org/bot{token}/close

Cost tier: cheap

Upstream docs ↗

const res = await telegram.close({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

closeForumTopic

POST telegram.closeForumTopic

POST https://api.telegram.org/bot{token}/closeForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.closeForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

closeGeneralForumTopic

POST telegram.closeGeneralForumTopic

POST https://api.telegram.org/bot{token}/closeGeneralForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.closeGeneralForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

convertGiftToStars

POST telegram.convertGiftToStars

POST https://api.telegram.org/bot{token}/convertGiftToStars

Cost tier: cheap

Upstream docs ↗

const res = await telegram.convertGiftToStars({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

copyMessage

POST telegram.copyMessage

POST https://api.telegram.org/bot{token}/copyMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.copyMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

copyMessages

POST telegram.copyMessages

POST https://api.telegram.org/bot{token}/copyMessages

Cost tier: cheap

Upstream docs ↗

const res = await telegram.copyMessages({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.createChatInviteLink

POST https://api.telegram.org/bot{token}/createChatInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.createChatInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.createChatSubscriptionInviteLink

POST https://api.telegram.org/bot{token}/createChatSubscriptionInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.createChatSubscriptionInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

createForumTopic

POST telegram.createForumTopic

POST https://api.telegram.org/bot{token}/createForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.createForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.createInvoiceLink

POST https://api.telegram.org/bot{token}/createInvoiceLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.createInvoiceLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

createNewStickerSet

POST telegram.createNewStickerSet

POST https://api.telegram.org/bot{token}/createNewStickerSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.createNewStickerSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

declineChatJoinRequest

POST telegram.declineChatJoinRequest

POST https://api.telegram.org/bot{token}/declineChatJoinRequest

Cost tier: cheap

Upstream docs ↗

const res = await telegram.declineChatJoinRequest({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

declineSuggestedPost

POST telegram.declineSuggestedPost

POST https://api.telegram.org/bot{token}/declineSuggestedPost

Cost tier: cheap

Upstream docs ↗

const res = await telegram.declineSuggestedPost({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteAllMessageReactions

POST telegram.deleteAllMessageReactions

POST https://api.telegram.org/bot{token}/deleteAllMessageReactions

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteAllMessageReactions({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteBusinessMessages

POST telegram.deleteBusinessMessages

POST https://api.telegram.org/bot{token}/deleteBusinessMessages

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteBusinessMessages({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteChatPhoto

POST telegram.deleteChatPhoto

POST https://api.telegram.org/bot{token}/deleteChatPhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteChatPhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteChatStickerSet

POST telegram.deleteChatStickerSet

POST https://api.telegram.org/bot{token}/deleteChatStickerSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteChatStickerSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteForumTopic

POST telegram.deleteForumTopic

POST https://api.telegram.org/bot{token}/deleteForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteMessage

POST telegram.deleteMessage

POST https://api.telegram.org/bot{token}/deleteMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteMessageReaction

POST telegram.deleteMessageReaction

POST https://api.telegram.org/bot{token}/deleteMessageReaction

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteMessageReaction({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteMessages

POST telegram.deleteMessages

POST https://api.telegram.org/bot{token}/deleteMessages

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteMessages({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteMyCommands

POST telegram.deleteMyCommands

POST https://api.telegram.org/bot{token}/deleteMyCommands

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteMyCommands({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteStickerFromSet

POST telegram.deleteStickerFromSet

POST https://api.telegram.org/bot{token}/deleteStickerFromSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteStickerFromSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteStickerSet

POST telegram.deleteStickerSet

POST https://api.telegram.org/bot{token}/deleteStickerSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteStickerSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteStory

POST telegram.deleteStory

POST https://api.telegram.org/bot{token}/deleteStory

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteStory({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

deleteWebhook

POST telegram.deleteWebhook

POST https://api.telegram.org/bot{token}/deleteWebhook

Cost tier: cheap

Upstream docs ↗

const res = await telegram.deleteWebhook({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.editChatInviteLink

POST https://api.telegram.org/bot{token}/editChatInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editChatInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.editChatSubscriptionInviteLink

POST https://api.telegram.org/bot{token}/editChatSubscriptionInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editChatSubscriptionInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editForumTopic

POST telegram.editForumTopic

POST https://api.telegram.org/bot{token}/editForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editGeneralForumTopic

POST telegram.editGeneralForumTopic

POST https://api.telegram.org/bot{token}/editGeneralForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editGeneralForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageCaption

POST telegram.editMessageCaption

POST https://api.telegram.org/bot{token}/editMessageCaption

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageCaption({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageChecklist

POST telegram.editMessageChecklist

POST https://api.telegram.org/bot{token}/editMessageChecklist

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageChecklist({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageLiveLocation

POST telegram.editMessageLiveLocation

POST https://api.telegram.org/bot{token}/editMessageLiveLocation

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageLiveLocation({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageMedia

POST telegram.editMessageMedia

POST https://api.telegram.org/bot{token}/editMessageMedia

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageMedia({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageReplyMarkup

POST telegram.editMessageReplyMarkup

POST https://api.telegram.org/bot{token}/editMessageReplyMarkup

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageReplyMarkup({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editMessageText

POST telegram.editMessageText

POST https://api.telegram.org/bot{token}/editMessageText

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editMessageText({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editStory

POST telegram.editStory

POST https://api.telegram.org/bot{token}/editStory

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editStory({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

editUserStarSubscription

POST telegram.editUserStarSubscription

POST https://api.telegram.org/bot{token}/editUserStarSubscription

Cost tier: cheap

Upstream docs ↗

const res = await telegram.editUserStarSubscription({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.exportChatInviteLink

POST https://api.telegram.org/bot{token}/exportChatInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.exportChatInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

forwardMessage

POST telegram.forwardMessage

POST https://api.telegram.org/bot{token}/forwardMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.forwardMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

forwardMessages

POST telegram.forwardMessages

POST https://api.telegram.org/bot{token}/forwardMessages

Cost tier: cheap

Upstream docs ↗

const res = await telegram.forwardMessages({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getAvailableGifts

POST telegram.getAvailableGifts

POST https://api.telegram.org/bot{token}/getAvailableGifts

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getAvailableGifts({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getBusinessAccountGifts

POST telegram.getBusinessAccountGifts

POST https://api.telegram.org/bot{token}/getBusinessAccountGifts

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getBusinessAccountGifts({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getBusinessAccountStarBalance

POST telegram.getBusinessAccountStarBalance

POST https://api.telegram.org/bot{token}/getBusinessAccountStarBalance

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getBusinessAccountStarBalance({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getBusinessConnection

POST telegram.getBusinessConnection

POST https://api.telegram.org/bot{token}/getBusinessConnection

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getBusinessConnection({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChat

POST telegram.getChat

POST https://api.telegram.org/bot{token}/getChat

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChat({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChatAdministrators

POST telegram.getChatAdministrators

POST https://api.telegram.org/bot{token}/getChatAdministrators

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChatAdministrators({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChatGifts

POST telegram.getChatGifts

POST https://api.telegram.org/bot{token}/getChatGifts

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChatGifts({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChatMember

POST telegram.getChatMember

POST https://api.telegram.org/bot{token}/getChatMember

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChatMember({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChatMemberCount

POST telegram.getChatMemberCount

POST https://api.telegram.org/bot{token}/getChatMemberCount

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChatMemberCount({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getChatMenuButton

POST telegram.getChatMenuButton

POST https://api.telegram.org/bot{token}/getChatMenuButton

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getChatMenuButton({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getCustomEmojiStickers

POST telegram.getCustomEmojiStickers

POST https://api.telegram.org/bot{token}/getCustomEmojiStickers

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getCustomEmojiStickers({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getFile

POST telegram.getFile

POST https://api.telegram.org/bot{token}/getFile

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getFile({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getForumTopicIconStickers

POST telegram.getForumTopicIconStickers

POST https://api.telegram.org/bot{token}/getForumTopicIconStickers

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getForumTopicIconStickers({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getGameHighScores

POST telegram.getGameHighScores

POST https://api.telegram.org/bot{token}/getGameHighScores

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getGameHighScores({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getManagedBotAccessSettings

POST telegram.getManagedBotAccessSettings

POST https://api.telegram.org/bot{token}/getManagedBotAccessSettings

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getManagedBotAccessSettings({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getManagedBotToken

POST telegram.getManagedBotToken

POST https://api.telegram.org/bot{token}/getManagedBotToken

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getManagedBotToken({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMe

POST telegram.getMe

POST https://api.telegram.org/bot{token}/getMe

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMe({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyCommands

POST telegram.getMyCommands

POST https://api.telegram.org/bot{token}/getMyCommands

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyCommands({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyDefaultAdministratorRights

POST telegram.getMyDefaultAdministratorRights

POST https://api.telegram.org/bot{token}/getMyDefaultAdministratorRights

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyDefaultAdministratorRights({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyDescription

POST telegram.getMyDescription

POST https://api.telegram.org/bot{token}/getMyDescription

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyDescription({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyName

POST telegram.getMyName

POST https://api.telegram.org/bot{token}/getMyName

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyName({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyShortDescription

POST telegram.getMyShortDescription

POST https://api.telegram.org/bot{token}/getMyShortDescription

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyShortDescription({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getMyStarBalance

POST telegram.getMyStarBalance

POST https://api.telegram.org/bot{token}/getMyStarBalance

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getMyStarBalance({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getStarTransactions

POST telegram.getStarTransactions

POST https://api.telegram.org/bot{token}/getStarTransactions

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getStarTransactions({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getStickerSet

POST telegram.getStickerSet

POST https://api.telegram.org/bot{token}/getStickerSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getStickerSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUpdates

POST telegram.getUpdates

POST https://api.telegram.org/bot{token}/getUpdates

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUpdates({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUserChatBoosts

POST telegram.getUserChatBoosts

POST https://api.telegram.org/bot{token}/getUserChatBoosts

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUserChatBoosts({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUserGifts

POST telegram.getUserGifts

POST https://api.telegram.org/bot{token}/getUserGifts

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUserGifts({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUserPersonalChatMessages

POST telegram.getUserPersonalChatMessages

POST https://api.telegram.org/bot{token}/getUserPersonalChatMessages

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUserPersonalChatMessages({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUserProfileAudios

POST telegram.getUserProfileAudios

POST https://api.telegram.org/bot{token}/getUserProfileAudios

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUserProfileAudios({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getUserProfilePhotos

POST telegram.getUserProfilePhotos

POST https://api.telegram.org/bot{token}/getUserProfilePhotos

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getUserProfilePhotos({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

getWebhookInfo

POST telegram.getWebhookInfo

POST https://api.telegram.org/bot{token}/getWebhookInfo

Cost tier: cheap

Upstream docs ↗

const res = await telegram.getWebhookInfo({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

giftPremiumSubscription

POST telegram.giftPremiumSubscription

POST https://api.telegram.org/bot{token}/giftPremiumSubscription

Cost tier: cheap

Upstream docs ↗

const res = await telegram.giftPremiumSubscription({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

hideGeneralForumTopic

POST telegram.hideGeneralForumTopic

POST https://api.telegram.org/bot{token}/hideGeneralForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.hideGeneralForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

leaveChat

POST telegram.leaveChat

POST https://api.telegram.org/bot{token}/leaveChat

Cost tier: cheap

Upstream docs ↗

const res = await telegram.leaveChat({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

logOut

POST telegram.logOut

POST https://api.telegram.org/bot{token}/logOut

Cost tier: cheap

Upstream docs ↗

const res = await telegram.logOut({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

pinChatMessage

POST telegram.pinChatMessage

POST https://api.telegram.org/bot{token}/pinChatMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.pinChatMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

postStory

POST telegram.postStory

POST https://api.telegram.org/bot{token}/postStory

Cost tier: cheap

Upstream docs ↗

const res = await telegram.postStory({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

promoteChatMember

POST telegram.promoteChatMember

POST https://api.telegram.org/bot{token}/promoteChatMember

Cost tier: cheap

Upstream docs ↗

const res = await telegram.promoteChatMember({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

readBusinessMessage

POST telegram.readBusinessMessage

POST https://api.telegram.org/bot{token}/readBusinessMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.readBusinessMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

refundStarPayment

POST telegram.refundStarPayment

POST https://api.telegram.org/bot{token}/refundStarPayment

Cost tier: cheap

Upstream docs ↗

const res = await telegram.refundStarPayment({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

removeBusinessAccountProfilePhoto

POST telegram.removeBusinessAccountProfilePhoto

POST https://api.telegram.org/bot{token}/removeBusinessAccountProfilePhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.removeBusinessAccountProfilePhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

removeChatVerification

POST telegram.removeChatVerification

POST https://api.telegram.org/bot{token}/removeChatVerification

Cost tier: cheap

Upstream docs ↗

const res = await telegram.removeChatVerification({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

removeMyProfilePhoto

POST telegram.removeMyProfilePhoto

POST https://api.telegram.org/bot{token}/removeMyProfilePhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.removeMyProfilePhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

removeUserVerification

POST telegram.removeUserVerification

POST https://api.telegram.org/bot{token}/removeUserVerification

Cost tier: cheap

Upstream docs ↗

const res = await telegram.removeUserVerification({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

reopenForumTopic

POST telegram.reopenForumTopic

POST https://api.telegram.org/bot{token}/reopenForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.reopenForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

reopenGeneralForumTopic

POST telegram.reopenGeneralForumTopic

POST https://api.telegram.org/bot{token}/reopenGeneralForumTopic

Cost tier: cheap

Upstream docs ↗

const res = await telegram.reopenGeneralForumTopic({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

replaceManagedBotToken

POST telegram.replaceManagedBotToken

POST https://api.telegram.org/bot{token}/replaceManagedBotToken

Cost tier: cheap

Upstream docs ↗

const res = await telegram.replaceManagedBotToken({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

replaceStickerInSet

POST telegram.replaceStickerInSet

POST https://api.telegram.org/bot{token}/replaceStickerInSet

Cost tier: cheap

Upstream docs ↗

const res = await telegram.replaceStickerInSet({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

repostStory

POST telegram.repostStory

POST https://api.telegram.org/bot{token}/repostStory

Cost tier: cheap

Upstream docs ↗

const res = await telegram.repostStory({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

restrictChatMember

POST telegram.restrictChatMember

POST https://api.telegram.org/bot{token}/restrictChatMember

Cost tier: cheap

Upstream docs ↗

const res = await telegram.restrictChatMember({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

POST telegram.revokeChatInviteLink

POST https://api.telegram.org/bot{token}/revokeChatInviteLink

Cost tier: cheap

Upstream docs ↗

const res = await telegram.revokeChatInviteLink({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

savePreparedInlineMessage

POST telegram.savePreparedInlineMessage

POST https://api.telegram.org/bot{token}/savePreparedInlineMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.savePreparedInlineMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

savePreparedKeyboardButton

POST telegram.savePreparedKeyboardButton

POST https://api.telegram.org/bot{token}/savePreparedKeyboardButton

Cost tier: cheap

Upstream docs ↗

const res = await telegram.savePreparedKeyboardButton({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendAnimation

POST telegram.sendAnimation

POST https://api.telegram.org/bot{token}/sendAnimation

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendAnimation({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendAudio

POST telegram.sendAudio

POST https://api.telegram.org/bot{token}/sendAudio

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendAudio({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendChatAction

POST telegram.sendChatAction

POST https://api.telegram.org/bot{token}/sendChatAction

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendChatAction({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendChatJoinRequestWebApp

POST telegram.sendChatJoinRequestWebApp

POST https://api.telegram.org/bot{token}/sendChatJoinRequestWebApp

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendChatJoinRequestWebApp({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendChecklist

POST telegram.sendChecklist

POST https://api.telegram.org/bot{token}/sendChecklist

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendChecklist({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendContact

POST telegram.sendContact

POST https://api.telegram.org/bot{token}/sendContact

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendContact({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendDice

POST telegram.sendDice

POST https://api.telegram.org/bot{token}/sendDice

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendDice({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendDocument

POST telegram.sendDocument

POST https://api.telegram.org/bot{token}/sendDocument

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendDocument({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendGame

POST telegram.sendGame

POST https://api.telegram.org/bot{token}/sendGame

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendGame({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendGift

POST telegram.sendGift

POST https://api.telegram.org/bot{token}/sendGift

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendGift({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendInvoice

POST telegram.sendInvoice

POST https://api.telegram.org/bot{token}/sendInvoice

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendInvoice({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendLivePhoto

POST telegram.sendLivePhoto

POST https://api.telegram.org/bot{token}/sendLivePhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendLivePhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendLocation

POST telegram.sendLocation

POST https://api.telegram.org/bot{token}/sendLocation

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendLocation({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendMediaGroup

POST telegram.sendMediaGroup

POST https://api.telegram.org/bot{token}/sendMediaGroup

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendMediaGroup({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendMessage

POST telegram.sendMessage

POST https://api.telegram.org/bot{token}/sendMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendMessageDraft

POST telegram.sendMessageDraft

POST https://api.telegram.org/bot{token}/sendMessageDraft

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendMessageDraft({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendPaidMedia

POST telegram.sendPaidMedia

POST https://api.telegram.org/bot{token}/sendPaidMedia

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendPaidMedia({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendPhoto

POST telegram.sendPhoto

POST https://api.telegram.org/bot{token}/sendPhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendPhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendPoll

POST telegram.sendPoll

POST https://api.telegram.org/bot{token}/sendPoll

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendPoll({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendRichMessage

POST telegram.sendRichMessage

POST https://api.telegram.org/bot{token}/sendRichMessage

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendRichMessage({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendRichMessageDraft

POST telegram.sendRichMessageDraft

POST https://api.telegram.org/bot{token}/sendRichMessageDraft

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendRichMessageDraft({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendSticker

POST telegram.sendSticker

POST https://api.telegram.org/bot{token}/sendSticker

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendSticker({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendVenue

POST telegram.sendVenue

POST https://api.telegram.org/bot{token}/sendVenue

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendVenue({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendVideo

POST telegram.sendVideo

POST https://api.telegram.org/bot{token}/sendVideo

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendVideo({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendVideoNote

POST telegram.sendVideoNote

POST https://api.telegram.org/bot{token}/sendVideoNote

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendVideoNote({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

sendVoice

POST telegram.sendVoice

POST https://api.telegram.org/bot{token}/sendVoice

Cost tier: cheap

Upstream docs ↗

const res = await telegram.sendVoice({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

setBusinessAccountBio

POST telegram.setBusinessAccountBio

POST https://api.telegram.org/bot{token}/setBusinessAccountBio

Cost tier: cheap

Upstream docs ↗

const res = await telegram.setBusinessAccountBio({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

setBusinessAccountGiftSettings

POST telegram.setBusinessAccountGiftSettings

POST https://api.telegram.org/bot{token}/setBusinessAccountGiftSettings

Cost tier: cheap

Upstream docs ↗

const res = await telegram.setBusinessAccountGiftSettings({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

setBusinessAccountName

POST telegram.setBusinessAccountName

POST https://api.telegram.org/bot{token}/setBusinessAccountName

Cost tier: cheap

Upstream docs ↗

const res = await telegram.setBusinessAccountName({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

setBusinessAccountProfilePhoto

POST telegram.setBusinessAccountProfilePhoto

POST https://api.telegram.org/bot{token}/setBusinessAccountProfilePhoto

Cost tier: cheap

Upstream docs ↗

const res = await telegram.setBusinessAccountProfilePhoto({ /* ... */ });

Source: packages/provider/telegram/src/telegram.ts

setBusinessAccountUsername

POST telegram.setBusinessAccountUsername

POST https://api.telegram.org/bot{token}/setBusinessAccountUsername

Cost tier: cheap

Upstream docs ↗

const res = await telegram.setBusinessAccountUsername({ /* ... */ });

Source: [`packages/p

版本与发布记录

@apicity/telegram 共发布 81 个版本,首次发布于 2026/06/07;过去 12 个月发布了 81 个版本。

版本发布日期距今
0.26.0latest2026/11/051 天前
0.25.02026/11/033 天前
0.24.12026/11/024 天前
0.24.02026/11/014 天前
0.23.12026/11/015 天前
0.23.02026/11/015 天前

关于 @apicity/telegram 的常见问题

@apicity/telegram 是什么?

Telegram Bot API provider for sending messages, media, polls, and rich messages.

如何安装 @apicity/telegram?

在项目目录运行 npm install @apicity/telegram,或使用 pnpm add / yarn add / bun add。

@apicity/telegram 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@apicity/telegram 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@apicity/telegram 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@apicity/telegram 可以商用吗?

@apicity/telegram 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@apicity/telegram 的下载量有多少?

根据 npm 官方下载统计,@apicity/telegram 在 2026/10/06 – 2026/11/04 这 30 天内被下载 4,752 次,日均约 158 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@apicity/telegram 还在维护吗?

最新版本 0.26.0 发布于 2026/11/05(1 天前);至今共发布 81 个版本,其中过去 12 个月发布了 81 个;首次发布于 2026/06/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。