@@ -40,6 +40,7 @@ TelegramBot
40
40
* [ .close([ options] )] ( #TelegramBot+close ) ⇒ <code >Promise</code >
41
41
* [ .sendMessage(chatId, text, [ options] )] ( #TelegramBot+sendMessage ) ⇒ <code >Promise</code >
42
42
* [ .forwardMessage(chatId, fromChatId, messageId, [ options] )] ( #TelegramBot+forwardMessage ) ⇒ <code >Promise</code >
43
+ * [ .forwardMessages(chatId, fromChatId, messageIds, [ options] )] ( #TelegramBot+forwardMessages ) ⇒ <code >Promise</code >
43
44
* [ .copyMessage(chatId, fromChatId, messageId, [ options] )] ( #TelegramBot+copyMessage ) ⇒ <code >Promise</code >
44
45
* [ .copyMessages(chatId, fromChatId, messageIds, [ options] )] ( #TelegramBot+copyMessages ) ⇒ <code >Promise</code >
45
46
* [ .sendPhoto(chatId, photo, [ options] , [ fileOptions] )] ( #TelegramBot+sendPhoto ) ⇒ <code >Promise</code >
@@ -103,6 +104,8 @@ TelegramBot
103
104
* [ .unhideGeneralForumTopic(chatId, [ options] )] ( #TelegramBot+unhideGeneralForumTopic ) ⇒ <code >Promise</code >
104
105
* [ .unpinAllGeneralForumTopicMessages(chatId, [ options] )] ( #TelegramBot+unpinAllGeneralForumTopicMessages ) ⇒ <code >Promise</code >
105
106
* [ .answerCallbackQuery(callbackQueryId, [ options] )] ( #TelegramBot+answerCallbackQuery ) ⇒ <code >Promise</code >
107
+ * [ .getUserChatBoosts(chatId, user_id, [ options] )] ( #TelegramBot+getUserChatBoosts ) ⇒ <code >Promise</code >
108
+ * [ .getBusinessConnection(businessConnectionId, [ options] )] ( #TelegramBot+getBusinessConnection ) ⇒ <code >Promise</code >
106
109
* [ .setMyCommands(commands, [ options] )] ( #TelegramBot+setMyCommands ) ⇒ <code >Promise</code >
107
110
* [ .deleteMyCommands([ options] )] ( #TelegramBot+deleteMyCommands ) ⇒ <code >Promise</code >
108
111
* [ .getMyCommands([ options] )] ( #TelegramBot+getMyCommands ) ⇒ <code >Promise</code >
@@ -129,6 +132,7 @@ TelegramBot
129
132
* [ .addStickerToSet(userId, name, sticker, emojis, stickerType, [ options] , [ fileOptions] )] ( #TelegramBot+addStickerToSet ) ⇒ <code >Promise</code >
130
133
* [ .setStickerPositionInSet(sticker, position, [ options] )] ( #TelegramBot+setStickerPositionInSet ) ⇒ <code >Promise</code >
131
134
* [ .deleteStickerFromSet(sticker, [ options] )] ( #TelegramBot+deleteStickerFromSet ) ⇒ <code >Promise</code >
135
+ * [ .replaceStickerInSet(user_id, name, sticker, [ options] )] ( #TelegramBot+replaceStickerInSet ) ⇒ <code >Promise</code >
132
136
* [ .setStickerEmojiList(sticker, emojiList, [ options] )] ( #TelegramBot+setStickerEmojiList ) ⇒ <code >Promise</code >
133
137
* [ .setStickerKeywords(sticker, [ options] )] ( #TelegramBot+setStickerKeywords ) ⇒ <code >Promise</code >
134
138
* [ .setStickerMaskPosition(sticker, [ options] )] ( #TelegramBot+setStickerMaskPosition ) ⇒ <code >Promise</code >
@@ -547,6 +551,23 @@ Forward messages of any kind.
547
551
| messageId | <code >Number</code > \| <code >String</code > | Unique message identifier in the chat specified in fromChatId |
548
552
| [ options] | <code >Object</code > | Additional Telegram query options |
549
553
554
+ <a name =" TelegramBot+forwardMessages " ></a >
555
+
556
+ ### telegramBot.forwardMessages(chatId, fromChatId, messageIds, [ options] ) ⇒ <code >Promise</code >
557
+ Use this method to forward multiple messages of any kind.
558
+ If some of the specified messages can't be found or forwarded, they are skipped.
559
+
560
+ ** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
561
+ ** Returns** : <code >Promise</code > - An array of MessageId of the sent messages on success
562
+ ** See** : https://core.telegram.org/bots/api#forwardmessages
563
+
564
+ | Param | Type | Description |
565
+ | --- | --- | --- |
566
+ | chatId | <code >Number</code > \| <code >String</code > | Unique identifier for the target chat or username of the target channel (in the format ` @channelusername ` ) or username of the target channel (in the format ` @channelusername ` ) |
567
+ | fromChatId | <code >Number</code > \| <code >String</code > | Unique identifier for the chat where the original message was sent (or channel username in the format ` @channelusername ` ) |
568
+ | messageIds | <code >[ ' ; Array' ; ] .< ; (Number\| String)> ; </code > | Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. |
569
+ | [ options] | <code >Object</code > | Additional Telegram query options |
570
+
550
571
<a name =" TelegramBot+copyMessage " ></a >
551
572
552
573
### telegramBot.copyMessage(chatId, fromChatId, messageId, [ options] ) ⇒ <code >Promise</code >
@@ -691,7 +712,7 @@ Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without s
691
712
### telegramBot.sendVoice(chatId, voice, [ options] , [ fileOptions] ) ⇒ <code >Promise</code >
692
713
Send voice
693
714
694
- ** Your audio must be in an .OGG file encoded with OPUS** (other formats may be sent as Audio or Document)
715
+ ** Your audio must be in an .OGG file encoded with OPUS** , or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document)
695
716
696
717
** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
697
718
** Returns** : <code >Promise</code > - On success, the sent [ Message] ( https://core.telegram.org/bots/api#message ) object is returned
@@ -912,7 +933,7 @@ Use this method to change the chosen reactions on a message.
912
933
913
934
** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
914
935
** Returns** : <code >[ ' ; Promise' ; ] .< ; Boolean> ; </code > - True on success
915
- ** See** : https://core.telegram.org/bots/api#setMessageReaction
936
+ ** See** : https://core.telegram.org/bots/api#setmessagereaction
916
937
917
938
| Param | Type | Description |
918
939
| --- | --- | --- |
@@ -1344,7 +1365,7 @@ Use this method to get up to date information about the chat
1344
1365
username of a user, group or channel, etc.).
1345
1366
1346
1367
** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
1347
- ** Returns** : <code >Promise</code > - [ Chat ] ( https://core.telegram.org/bots/api#chat ) object on success
1368
+ ** Returns** : <code >Promise</code > - [ ChatFullInfo ] ( https://core.telegram.org/bots/api#chatfullinfo ) object on success
1348
1369
** See** : https://core.telegram.org/bots/api#getchat
1349
1370
1350
1371
| Param | Type | Description |
@@ -1657,6 +1678,36 @@ that are being deprecated.
1657
1678
| callbackQueryId | <code >String</code > | Unique identifier for the query to be answered |
1658
1679
| [ options] | <code >Object</code > | Additional Telegram query options |
1659
1680
1681
+ <a name =" TelegramBot+getUserChatBoosts " ></a >
1682
+
1683
+ ### telegramBot.getUserChatBoosts(chatId, user_id, [ options] ) ⇒ <code >Promise</code >
1684
+ Use this method to get the list of boosts added to a chat by a use.
1685
+ Requires administrator rights in the chat
1686
+
1687
+ ** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
1688
+ ** Returns** : <code >Promise</code > - On success, returns a [ UserChatBoosts] ( https://core.telegram.org/bots/api#userchatboosts ) object
1689
+ ** See** : https://core.telegram.org/bots/api#getuserchatboosts
1690
+
1691
+ | Param | Type | Description |
1692
+ | --- | --- | --- |
1693
+ | chatId | <code >Number</code > \| <code >String</code > | Unique identifier for the group/channel |
1694
+ | user_id | <code >Number</code > | Unique identifier of the target user |
1695
+ | [ options] | <code >Object</code > | Additional Telegram query options |
1696
+
1697
+ <a name =" TelegramBot+getBusinessConnection " ></a >
1698
+
1699
+ ### telegramBot.getBusinessConnection(businessConnectionId, [ options] ) ⇒ <code >Promise</code >
1700
+ Use this method to get information about the connection of the bot with a business account
1701
+
1702
+ ** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
1703
+ ** Returns** : <code >Promise</code > - On success, returns [ BusinessConnection] ( https://core.telegram.org/bots/api#businessconnection ) object
1704
+ ** See** : https://core.telegram.org/bots/api#getbusinessconnection
1705
+
1706
+ | Param | Type | Description |
1707
+ | --- | --- | --- |
1708
+ | businessConnectionId | <code >Number</code > \| <code >String</code > | Unique identifier for the group/channel |
1709
+ | [ options] | <code >Object</code > | Additional Telegram query options |
1710
+
1660
1711
<a name =" TelegramBot+setMyCommands " ></a >
1661
1712
1662
1713
### telegramBot.setMyCommands(commands, [ options] ) ⇒ <code >Promise</code >
@@ -2013,9 +2064,11 @@ Use this method to add a new sticker to a set created by the bot.
2013
2064
2014
2065
You must use exactly one of the fields * png_sticker* , * tgs_sticker* , or * webm_sticker*
2015
2066
2016
- Animated stickers can be added to animated sticker sets and only to them:
2017
- - Animated sticker sets can have up to 50 stickers.
2018
- - Static sticker sets can have up to 120 stickers
2067
+ Animated stickers can be added to animated sticker sets and only to them
2068
+
2069
+ Note:
2070
+ - Emoji sticker sets can have up to 200 sticker
2071
+ - Static or Animated sticker sets can have up to 120 stickers
2019
2072
2020
2073
** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
2021
2074
** Returns** : <code >Promise</code > - True on success
@@ -2064,6 +2117,26 @@ Use this method to delete a sticker from a set created by the bot.
2064
2117
| sticker | <code >String</code > | File identifier of the sticker |
2065
2118
| [ options] | <code >Object</code > | Additional Telegram query options |
2066
2119
2120
+ <a name =" TelegramBot+replaceStickerInSet " ></a >
2121
+
2122
+ ### telegramBot.replaceStickerInSet(user_id, name, sticker, [ options] ) ⇒ <code >Promise</code >
2123
+ Use this method to replace an existing sticker in a sticker set with a new one
2124
+
2125
+ ** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
2126
+ ** Returns** : <code >Promise</code > - True on success
2127
+ ** See** : https://core.telegram.org/bots/api#replacestickerinset
2128
+ ** Todo**
2129
+
2130
+ - [ ] Add tests for this method!
2131
+
2132
+
2133
+ | Param | Type | Description |
2134
+ | --- | --- | --- |
2135
+ | user_id | <code >Number</code > | User identifier of the sticker set owner |
2136
+ | name | <code >String</code > | Sticker set name |
2137
+ | sticker | <code >String</code > | File identifier of the sticker |
2138
+ | [ options] | <code >Object</code > | Additional Telegram query options |
2139
+
2067
2140
<a name =" TelegramBot+setStickerEmojiList " ></a >
2068
2141
2069
2142
### telegramBot.setStickerEmojiList(sticker, emojiList, [ options] ) ⇒ <code >Promise</code >
@@ -2366,7 +2439,7 @@ Use this method to delete multiple messages simultaneously. If some of the speci
2366
2439
2367
2440
** Kind** : instance method of [ <code >TelegramBot</code >] ( #TelegramBot )
2368
2441
** Returns** : <code >[ ' ; Promise' ; ] .< ; Boolean> ; </code > - True on success
2369
- ** See** : https://core.telegram.org/bots/api#deleteMessages
2442
+ ** See** : https://core.telegram.org/bots/api#deletemessages
2370
2443
2371
2444
| Param | Type | Description |
2372
2445
| --- | --- | --- |
0 commit comments