Skip to content

Main Navigation Documentation Guidebook

Appearance

Sidebar Navigation

Introduction

classes

ActionsManager

AllowedUpdatesOptions

Animation

Audio

Auxiliary

BaseChat

BaseClient

BaseGroupChat

CallbackCollector

CallbackQuery

ChannelChat

ChatAdministratorRights

ChatBase

ChatBoost

ChatInviteLinksManager

ChatJoinRequest

ChatMemberUpdated

ChatPermissions

ChatRequestsManager

ChatsManager

ChosenInlineResult

Client

ClientUser

Collector

Command

CommandsBuilder

CommandsManager

CommandsScopeBuilder

Document

Event

Extension

ExtensionsManager

File

ForceReply

FormDataBuilder

ForumTopic

GroupChat

InlineKeyboardMarkup

InlineQuery

InlineQueryResults

InputPaidMediaBuilder

Invoice

InvoicesManager

LabeledPrices

Logger

Member

MembersManager

MenuButtonBuilder

Message

MessageCollector

MessageEntities

MessageEntitiesStore

MessageReaction

MessageReactionCount

MessagesManager

PaymentsManager

PhotoSize

Poll

PollAnswer

PollAnswers

PollOptions

PollsManager

PreCheckoutQuery

PrivateChat

Reactions

ReplyKeyboardMarkup

ReplyKeyboardRemove

Rest

ShippingOptions

ShippingQuery

Sticker

SuccessfulPayment

SuperGroupChat

TopicsManager

User

UsersManager

Video

VideoNote

Voice

WebhookManager

enumerations

AdministratorRight

AllowedUpdates

Auxiliaries

ChatAction

ChatHold

ClientAction

ClientEvent

CommandScopeType

Endpoint

EntityType

EnvironmentVariables

LogLevel

MessagePayloadMethod

MessageService

Parseables

PartialTypes

Permission

RequestMethod

Routes

functions

classExtends

defaults

has

isClass

isJson

nest

interfaces

ActionsOptions

AnimationFilePacket

AnimationPayload

AudioFilePacket

AudioPayload

AuxiliariesRegistryOptions

AuxiliaryMeta

BaseChatInviteLinkEditPayload

BaseGroupChatPacket

BaseMessagePayload

Birthdate

BotCommand

BusinessIntro

BusinessLocation

BusinessOpeningHours

BusinessOpeningHoursInterval

CallbackCollectorOptions

CallbackQueryPacket

ChatActionPayload

ChatInviteLink

ChatInviteLinkCreatePayload

ChatInviteLinkSubscriptionEditPayload

ChatInviteLinkSubscriptionPayload

ChatJoinRequestPacket

ChatLocation

ChatMemberAdministrator

ChatMemberBanned

ChatMemberLeft

ChatMemberMember

ChatMemberOwner

ChatMemberRestricted

ChatMemberUpdatedPacket

ChatPacket

ChatPhoto

ChatShared

ChosenInlineResultPacket

ClientOptions

CommandMeta

CommandsChatMenuButton

CommandScope

CommandsPayload

CommandsRegistryOptions

ContactPayload

CopyMessagePayload

CopyText

CreateInvoiceLinkPayload

CustomEmoji

DefaultChatMenuButton

DicePayload

DocumentFilePacket

DocumentPayload

Emoji

EncryptedPassportElement

EndpointHandlingOptions

EventMeta

EventsRegistryOptions

ExtensionMetadata

ExtensionsManagerOptions

ExternalReplyInfo

FilePacket

ForumTopicPacket

ForwardPayload

GamePacket

InaccessibleMessage

InlineQueryAnswer

InlineQueryPacket

InputContactMessageContentPayload

InputInvoiceMessageContentPayload

InputLocationMessageContentPayload

InputMediaAnimationPayload

InputMediaAudioPayload

InputMediaDocumentPayload

InputMediaPhotoPayload

InputMediaVideoPayload

InputPaidMediaPhotoPayload

InputPaidMediaPreviewPayload

InputPaidMediaVideoPayload

InputTextMessageContentPayload

InputVenueMessageContentPayload

InvoicePacket

KeyboardButtonPayload

LabeledPrice

LinkPreviewOptions

LocationPacket

LocationPayload

LoggerOptions

LoginUrl

MaskPosition

MediaFilePacket

MediaGroupPayload

MessageAutoDeleteTimerChanged

MessagecaptionEditPayload

MessageCollectorOptions

MessageEditPayload

MessageEntityPayload

MessageMediaEditPayload

MessageOriginChannel

MessageOriginChat

MessageOriginHiddenUser

MessageOriginUser

MessagePacket

MessageReactionCountPacket

MessageReactionPacket

MessageReactionPayload

MessageReplyMarkupEditPayload

Nesting

OptionalBaseMessagePayload

OrderInfo

PaidEmoji

PaidMediaInfo

PaidMediaPayload

PaidMediaPurchasedPacket

PassportData

PhotoPayload

PhotoSizeFilePacket

PollAnswerPacket

PollEndpointOptions

PollOption

PollPacket

PollPayload

PreCheckoutQueryPacket

PrivateChatPacket

ProximityAlertTriggered

QueryResultArticlePayload

QueryResultAudioPayload

QueryResultButtonPayload

QueryResultCachedAudioPayload

QueryResultCachedDocumentPayload

QueryResultCachedGifPayload

QueryResultCachedMpeg4GifPayload

QueryResultCachedPhotoPayload

QueryResultCachedStickerPayload

QueryResultCachedVideoPayload

QueryResultCachedVoicePayload

QueryResultContactPayload

QueryResultDocumentPayload

QueryResultGamePayload

QueryResultGifPayload

QueryResultLocationPayload

QueryResultMpeg4GifPayload

QueryResultPhotoPayload

QueryResultVenuePayload

QueryResultVideoPayload

QueryResultVoicePayload

ReactionTypeCustomEmoji

ReactionTypeEmoji

ReactionTypePaid

RefundedPaymentPacket

RegistriesOptions

ReplyButtonPayload

ReplyParameters

RequestChat

RequestUsers

RestOptions

RestRequestOptions

RouteParameters

SendInvoicePayload

SerializedForumTopicPacket

SerializedSuccessfulPayment

SharedUserPacket

ShippingAddress

ShippingOptionPayload

ShippingQueryPacket

StickerFilePacket

StoredInvoice

StoryPacket

SuccessfulPaymentPacket

SwitchInlineQueryChosenChat

TextPayload

TextQuote

UpdateEndpointOptions

UpdatePacket

UserPacket

UserProfilePhotos

UsersShared

VenuePayload

VideoFilePacket

VideoNoteFilePacket

VideoNotePayload

VoiceFilePacket

VoicePayload

WebappChatMenuButton

WebAppData

WebAppInfo

WebhookEndpointOptions

WebhookInfo

WriteAccessAllowed

namespaces

Emoji

Introduction

functions

Custom

Emoji

Paid

InlineQueryResultButton

Introduction

classes

Start

WebApp

InputMessage

Introduction

functions

Contact

Invoice

Location

Text

Venue

KeyboardButton

Introduction

functions

CallbackData

CallbackGame

CopyText

LoginUrl

Pay

SwitchInlineQuery

SwitchInlineQueryChosenChat

SwitchInlineQueryCurrentChat

Text

Url

WebAppInfo

Media

Introduction

functions

Animation

Audio

Document

Photo

Video

MessageEntity

Introduction

functions

Blockquote

Bold

BotCommand

Cashtag

Code

CustomEmoji

Email

ExpandableBlockquote

Hashtag

Italic

Mention

PhoneNumber

Pre

Spoiler

Strikethrough

TextLink

TextMention

Underline

Url

PaidMedia

Introduction

functions

Photo

Video

QueryResult

Introduction

functions

Article

Audio

Button

CachedAudio

CachedDocument

CachedGif

CachedMpeg4Gif

CachedPhoto

CachedSticker

CachedVideo

CachedVoice

Contact

Document

Game

Gif

Location

Mpeg4Gif

Photo

Venue

Video

Voice

ReplyButton

Introduction

functions

Chats

Contact

Location

Poll

Text

Users

WebApp

type-aliases

AbstractConstructor

AcceptedEmoji

Chat

ChatMember

ChatMemberPacket

ChatMemberStatus

ChatMenuButton

Constructor

Emojis

EndpointOptions

ErrorCode

FormAppendData

InlineKeyboardButton

InlineQueryResult

InlineQueryResultButtonType

InputFile

InputMedia

InputMessageContent

InputPaidMedia

LogMethods

MessageEntitiesType

MessageOrigin

MessagePayload

NestCallback

ReactionType

ReplyKeyboardButton

variables

ErrorCodes

ErrorMessage

Extensions

TGXError

TGXRangeError

TGXTypeError

On this page

export Interface

ProximityAlertTriggered

Properties

distance : `number`

traveler : `UserPacket`

watcher : `UserPacket`

A modern, powerful library for building your Telegram bots, with seamless support for both JavaScript and Typescript.