Skip to content

Unlimited message size #997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Unlimited message size #997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5fec3a
Added a new function for send message larger than 4096 characters
Daniel-97 Aug 12, 2022
4d6bd7e
Updated documentation
Daniel-97 Aug 12, 2022
f904da1
Fixed error in function documentation
Daniel-97 Aug 18, 2022
066bf54
code formatting and fixing eslint issue
Daniel-97 Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ TelegramBot
* [.logOut([options])](#TelegramBot+logOut) ⇒ <code>Promise</code>
* [.close([options])](#TelegramBot+close) ⇒ <code>Promise</code>
* [.sendMessage(chatId, text, [options])](#TelegramBot+sendMessage) ⇒ <code>Promise</code>
* [.sendLargeMessage(chatId, text, form)](#TelegramBot+sendLargeMessage) ⇒ <code>Promise</code>
* [.forwardMessage(chatId, fromChatId, messageId, [options])](#TelegramBot+forwardMessage) ⇒ <code>Promise</code>
* [.copyMessage(chatId, fromChatId, messageId, [options])](#TelegramBot+copyMessage) ⇒ <code>Promise</code>
* [.sendPhoto(chatId, photo, [options], [fileOptions])](#TelegramBot+sendPhoto) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -120,7 +121,7 @@ TelegramBot
* [.getGameHighScores(userId, [options])](#TelegramBot+getGameHighScores) ⇒ <code>Promise</code>
* _static_
* [.errors](#TelegramBot.errors) : <code>Object</code>
* [.messageTypes](#TelegramBot.messageTypes) : <code>[ &#x27;Array&#x27; ].&lt;String&gt;</code>
* [.messageTypes](#TelegramBot.messageTypes) : <code>Array.&lt;String&gt;</code>

<a name="new_TelegramBot_new"></a>

Expand Down Expand Up @@ -501,6 +502,20 @@ Send text message.
| text | <code>String</code> | Text of the message to be sent |
| [options] | <code>Object</code> | Additional Telegram query options |

<a name="TelegramBot+sendLargeMessage"></a>

### telegramBot.sendLargeMessage(chatId, text, form) ⇒ <code>Promise</code>
Send text message larger than 4096 characters.

**Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Promise</code> - On success all the sent messages are returned as an array

| Param | Type | Description |
| --- | --- | --- |
| chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) |
| text | <code>String</code> | Text of the message to be sent |
| form | <code>Object</code> | Additional Telegram query options |

<a name="TelegramBot+forwardMessage"></a>

### telegramBot.forwardMessage(chatId, fromChatId, messageId, [options]) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -1677,7 +1692,7 @@ Animated stickers can be added to animated sticker sets and only to them:
| --- | --- | --- | --- |
| userId | <code>Number</code> | | User identifier of sticker set owner |
| name | <code>String</code> | | Sticker set name |
| sticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | | Png image with the sticker (must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px), [TGS animation](https://core.telegram.org/stickers#animated-sticker-requirements) with the sticker or [WEBM video](https://core.telegram.org/stickers#video-sticker-requirements) with the sticker. |
| sticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | | Png image with the sticker (must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px, [TGS animation](https://core.telegram.org/stickers#animated-sticker-requirements) with the sticker or [WEBM video](https://core.telegram.org/stickers#video-sticker-requirements) with the sticker. |
| emojis | <code>String</code> | | One or more emoji corresponding to the sticker |
| stickerType | <code>String</code> | <code>png_sticker</code> | Allow values: `png_sticker`, `tgs_sticker`, or `webm_sticker`. |
| [options] | <code>Object</code> | | Additional Telegram query options |
Expand Down Expand Up @@ -1749,7 +1764,7 @@ Note: No more than 50 results per query are allowed.
| Param | Type | Description |
| --- | --- | --- |
| inlineQueryId | <code>String</code> | Unique identifier of the query |
| results | <code>[ &#x27;Array&#x27; ].&lt;InlineQueryResult&gt;</code> | An array of results for the inline query |
| results | <code>Array.&lt;InlineQueryResult&gt;</code> | An array of results for the inline query |
| [options] | <code>Object</code> | Additional Telegram query options |

<a name="TelegramBot+answerWebAppQuery"></a>
Expand Down Expand Up @@ -1899,7 +1914,7 @@ The different errors the library uses.
**Kind**: static property of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot.messageTypes"></a>

### TelegramBot.messageTypes : <code>[ &#x27;Array&#x27; ].&lt;String&gt;</code>
### TelegramBot.messageTypes : <code>Array.&lt;String&gt;</code>
The types of message updates the library handles.

**Kind**: static property of [<code>TelegramBot</code>](#TelegramBot)
Expand Down
38 changes: 38 additions & 0 deletions src/telegram.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const URL = require('url');
const fs = require('fs');
const pump = require('pump');
const deprecate = require('./utils').deprecate;
const MAX_MESSAGE_SIZE = 4096;

const _messageTypes = [
'text',
Expand Down Expand Up @@ -74,6 +75,21 @@ function stringify(data) {
return JSON.stringify(data);
}

/**
* Slice an array in sub-array of the same size
* @private
* @param arr array
* @param chunkSize number
* @return Array[]
*/
function sliceIntoChunks(arr, chunkSize) {
const res = [];
for (let i = 0; i < arr.length; i += chunkSize) {
const chunk = arr.slice(i, i + chunkSize);
res.push(chunk);
}
return res;
}

class TelegramBot extends EventEmitter {
/**
Expand Down Expand Up @@ -869,6 +885,28 @@ class TelegramBot extends EventEmitter {
return this._request('sendMessage', { form });
}

/**
* Send text message larger than 4096 characters.
* @param {Number|String} chatId Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
* @param {String} text Text of the message to be sent
* @param {Object} form Additional Telegram query options
* @return {Promise} On success all the sent messages are returned as an array
*/
sendLargeMessage(chatId, text, form = {}) {
form.chat_id = chatId;

const subMessages = sliceIntoChunks(text, MAX_MESSAGE_SIZE);
const responses = [];

for (const message of subMessages) {
form.text = message;
const resPromise = this._request('sendMessage', { form });
responses.push(resPromise);
}

return Promise.all(responses);
}

/**
* Forward messages of any kind.
* @param {Number|String} chatId Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
Expand Down