Package Exports
- node-telegram-bot-api
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-telegram-bot-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Class: TelegramBot
NodeJS class for Telegram Bot API.
Support for WebHooks and long polling. Emits message when message arrives.
TelegramBot.getMe()
Returns basic information about the bot in form of a User object.
Returns: Promise
TelegramBot.setWebHook(url)
Specify a url to receive incoming updates via an outgoing webHook.
Parameters
url: String, URL
TelegramBot.getUpdates(timeout, limit, offset)
Use this method to receive incoming updates using long polling
Parameters
timeout: Number | String, Timeout in seconds for long polling.
limit: Number | String, Limits the number of updates to be retrieved.
offset: Number | String, Identifier of the first update to be returned.
Returns: Promise, Updates
TelegramBot.sendMessage(chatId, text, options)
Send text message.
Parameters
chatId: Number | String, Unique identifier for the message recipient
text: Sting, Text of the message to be sent
options: Object, Additional Telegram query options
Returns: Promise
TelegramBot.forwardMessage(chatId, fromChatId, messageId)
Forward messages of any kind.
Parameters
chatId: Number | String, Unique identifier for the message recipient
fromChatId: Number | String, Unique identifier for the chat where the
original message was sent
messageId: Number | String, Unique message identifier
Returns: Promise
TelegramBot.sendPhoto(chatId, photo, options)
Send photo
Parameters
chatId: Number | String, Unique identifier for the message recipient
photo: String | stream.Stream, A file path or a Stream. Can
also be a file_id previously uploaded
options: Object, Additional Telegram query options
Returns: Promise
TelegramBot.sendAudio(chatId, audio, options)
Send audio
Parameters
chatId: Number | String, Unique identifier for the message recipient
audio: String | stream.Stream, A file path or a Stream. Can
also be a file_id previously uploaded.
options: Object, Additional Telegram query options
Returns: Promise