telegram-bot-api-ts
v1.1.2
Published
This library is a full wrapper of [Telegram Bot API](https://core.telegram.org/bots/api). It's main purpose is to provide support for all available API calls. Last supported version of [Telegram Bot API](https://core.telegram.org/bots/api) currently is [B
Downloads
2
Readme
Telegram Bot API TypeScript
This library is a full wrapper of Telegram Bot API. It's main purpose is to provide support for all available API calls. Last supported version of Telegram Bot API currently is Bot API 5.7.
Table of Contents
Usage
Main class you need to get access to all available API calls (methods) of Telegram Bot API is a TelegramBotAPI
class.
import { TelegramBotAPI } from 'telegram-bot-api-ts';
After that you need to pass your bot token to the constructor. It is required, because, all Telegram Bot API calls need to be authorized with bot token. You can learn more about that in the official document.
const BOT_TOKEN = "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11";
const bot = new TelegramBotAPI(BOT_TOKEN);
Also there is some predefined classes for bot developping:
TelegramBotAPI
This is a base class for all other predefined bot classes and main wrapper around Telegram Bot API.
TelegramUpdateEmmiterBot
This is a base class for building your custom bot classes that emmits events on updates received from Telegram.
TelegramPollingBot
This bot based on
TelegramUpdateEmmiterBot
, so it will continuously poll updates from Telegram and pass all updates to your code.TelegramUpdateListener
This is a standalone class that can store your event listener functions. This can be passed to any
TelegramUpdateEmmiterBot
.
Events
Your bot can listen for events emmited when there is some update from Telegram. For now there are 14 types of updates:
message
- New incoming message of any kind - text, photo, sticker, etc.edited_message
- Message that is known to the bot was editedchannel_post
- New incoming channel post of any kind - text, photo, sticker, etc.edited_channel_post
- Channel post that is known to the bot was editedinline_query
- New incomming inline querychosen_inline_query
callback_query
shipping_query
pre_checkout_query
poll
poll_answer
my_chat_member
chat_member
chat_join_request