Constructor
new BaseTelegramBot(token, optionsopt, defaultParseModeopt) → {module:base_telegram_bot.BaseTelegramBot}
This object provide access to methods to communicate with
the Telegram
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token |
string | Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11 | |||||||||||||||||||||||||||||||||||||||||||
options |
Object |
<optional> |
some optional parameters to pass to
Properties
|
||||||||||||||||||||||||||||||||||||||||||
defaultParseMode |
module:enums.ParseModes |
<optional> |
Default value mode for parsing messages wchich send by the bot | ||||||||||||||||||||||||||||||||||||||||||
options.sender |
Object |
<optional> |
Params for the bot's sender which will send
data to Telegram by using sending queue of messages
Properties
|
Properties:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
id |
integer | Read only. Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier | |||||||||
firstName |
string | Read only. User's or bot's first name | |||||||||
username |
string |
<optional> |
Read only. User's or bot's username | ||||||||
lastName |
string |
<optional> |
Read only. User's or bot's last name | ||||||||
languageCode |
string |
<optional> |
Read only. ETF language tag of the user's language | ||||||||
canJoinGroups |
boolean |
<optional> |
Read only. True, if the bot can be invited to groups | ||||||||
canReadAllGroupMessages |
boolean |
<optional> |
Read only. True, if privacy mode is disabled for the bot | ||||||||
supportsInlineQueries |
boolean |
<optional> |
Read only. True, if the bot supports inline queries | ||||||||
defaultParseMode |
module:enums.ParseModes |
<optional> |
Default value mode for parsing messages wchich send by the bot | ||||||||
logger |
Object |
<optional> |
Object implemented multilevel logging routines. If not specified, will use default logger | ||||||||
sender |
Worker | Read only. The bot's sender which will send data to Telegram by using sending queue of messages | |||||||||
sendByQueue |
boolean |
<optional> |
If True the bot will send data to Telegram by using sending queue of messages | ||||||||
lastMessageId |
integer | Read only. ID of the last sent message | |||||||||
maxConnections |
integer |
<optional> |
The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput | ||||||||
secretToken |
string |
<optional> |
A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you | ||||||||
certificate |
Object |
<optional> |
Upload your public key certificate so
that the root certificate in use can be checked. See our self-signed
guide for details
Properties
|
||||||||
allowedUpdates |
Array.<string> |
<optional> |
A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time | ||||||||
dropPendingUpdates |
boolean |
<optional> |
Pass True to drop all pending updates | ||||||||
ipAddress |
string |
<optional> |
The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS |
Returns:
Instance of the
BaseTelegramBot class
Methods
setWebhook(urlopt, optionsopt) → {Object}
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
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url |
string |
<optional> |
HTTPS URL to send updates to. Use an empty string to remove webhook integration. Default value is empty string | ||||||||||||||||||||||||||||||||||||||
options |
Object |
<optional> |
some optional parameters to pass to
Properties
|
Returns:
Response with method executing result
- Type
- Object