Search
Preparing search index...
The search index is not available
telegraf.js
Options
All
Public
Public/Protected
All
Inherited
Menu
telegraf.js
Scenes
WizardContext
Interface WizardContext<D>
Type parameters
D
:
WizardSessionData
=
WizardSessionData
Hierarchy
Context
WizardContext
Index
Properties
bot
Info
scene
session
state
tg
update
wizard
Accessors
callback
Query
channel
Post
chat
chosen
Inline
Result
edited
Channel
Post
edited
Message
from
inline
Message
Id
inline
Query
me
message
passport
Data
poll
poll
Answer
pre
Checkout
Query
sender
Chat
shipping
Query
telegram
update
Type
webhook
Reply
Methods
add
Sticker
ToSet
answer
CbQuery
answer
Game
Query
answer
Inline
Query
answer
Pre
Checkout
Query
answer
Shipping
Query
copy
Message
create
New
Sticker
Set
delete
Chat
Photo
delete
Chat
Sticker
Set
delete
Message
delete
Sticker
From
Set
edit
Message
Caption
edit
Message
Live
Location
edit
Message
Media
edit
Message
Reply
Markup
edit
Message
Text
export
Chat
Invite
Link
forward
Message
get
Chat
get
Chat
Administrators
get
Chat
Member
get
Chat
Members
Count
get
MyCommands
get
Sticker
Set
kick
Chat
Member
leave
Chat
pin
Chat
Message
promote
Chat
Member
reply
reply
With
Animation
reply
With
Audio
reply
With
Chat
Action
reply
With
Contact
reply
With
Dice
reply
With
Document
reply
With
Game
reply
WithHTML
reply
With
Invoice
reply
With
Location
reply
With
Markdown
reply
With
Markdown
V2
reply
With
Media
Group
reply
With
Photo
reply
With
Poll
reply
With
Quiz
reply
With
Sticker
reply
With
Venue
reply
With
Video
reply
With
Video
Note
reply
With
Voice
restrict
Chat
Member
set
Chat
Administrator
Custom
Title
set
Chat
Description
set
Chat
Permissions
set
Chat
Photo
set
Chat
Sticker
Set
set
Chat
Title
set
MyCommands
set
Passport
Data
Errors
set
Sticker
Position
InSet
set
Sticker
Set
Thumb
stop
Message
Live
Location
stop
Poll
unban
Chat
Member
unpin
All
Chat
Messages
unpin
Chat
Message
upload
Sticker
File
Properties
Readonly
bot
Info
bot
Info
:
UserFromGetMe
scene
scene
:
SceneContextScene
<
WizardContext
<
D
>
,
D
>
session
session
:
WizardSession
<
D
>
Readonly
state
state
:
Record
<
string
|
symbol
,
any
>
= ...
Readonly
tg
tg
:
Telegram
Readonly
update
update
:
Update
wizard
wizard
:
WizardContextWizard
<
WizardContext
<
D
>
>
Accessors
callback
Query
get
callbackQuery
(
)
:
undefined
|
DataCallbackQuery
|
GameShortGameCallbackQuery
Returns
undefined
|
DataCallbackQuery
|
GameShortGameCallbackQuery
channel
Post
get
channelPost
(
)
:
undefined
|
(
New
&
Channel
&
TextMessage
)
|
(
New
&
Channel
&
DocumentMessage
)
|
(
New
&
Channel
&
AudioMessage
)
|
(
New
&
Channel
&
ChannelChatCreatedMessage
)
|
(
New
&
Channel
&
ConnectedWebsiteMessage
)
|
(
New
&
Channel
&
ContactMessage
)
|
(
New
&
Channel
&
DeleteChatPhotoMessage
)
|
(
New
&
Channel
&
DiceMessage
)
|
(
New
&
Channel
&
GameMessage
)
|
(
New
&
Channel
&
GroupChatCreatedMessage
)
|
(
New
&
Channel
&
InvoiceMessage
)
|
(
New
&
Channel
&
LeftChatMemberMessage
)
|
(
New
&
Channel
&
LocationMessage
)
|
(
New
&
Channel
&
MigrateFromChatIdMessage
)
|
(
New
&
Channel
&
MigrateToChatIdMessage
)
|
(
New
&
Channel
&
NewChatMembersMessage
)
|
(
New
&
Channel
&
NewChatPhotoMessage
)
|
(
New
&
Channel
&
NewChatTitleMessage
)
|
(
New
&
Channel
&
PassportDataMessage
)
|
(
New
&
Channel
&
ProximityAlertTriggeredMessage
)
|
(
New
&
Channel
&
PhotoMessage
)
|
(
New
&
Channel
&
PinnedMessageMessage
)
|
(
New
&
Channel
&
PollMessage
)
|
(
New
&
Channel
&
StickerMessage
)
|
(
New
&
Channel
&
SuccessfulPaymentMessage
)
|
(
New
&
Channel
&
SupergroupChatCreated
)
|
(
New
&
Channel
&
VideoMessage
)
|
(
New
&
Channel
&
VideoNoteMessage
)
|
(
New
&
Channel
&
VoiceMessage
)
Returns
undefined
|
(
New
&
Channel
&
TextMessage
)
|
(
New
&
Channel
&
DocumentMessage
)
|
(
New
&
Channel
&
AudioMessage
)
|
(
New
&
Channel
&
ChannelChatCreatedMessage
)
|
(
New
&
Channel
&
ConnectedWebsiteMessage
)
|
(
New
&
Channel
&
ContactMessage
)
|
(
New
&
Channel
&
DeleteChatPhotoMessage
)
|
(
New
&
Channel
&
DiceMessage
)
|
(
New
&
Channel
&
GameMessage
)
|
(
New
&
Channel
&
GroupChatCreatedMessage
)
|
(
New
&
Channel
&
InvoiceMessage
)
|
(
New
&
Channel
&
LeftChatMemberMessage
)
|
(
New
&
Channel
&
LocationMessage
)
|
(
New
&
Channel
&
MigrateFromChatIdMessage
)
|
(
New
&
Channel
&
MigrateToChatIdMessage
)
|
(
New
&
Channel
&
NewChatMembersMessage
)
|
(
New
&
Channel
&
NewChatPhotoMessage
)
|
(
New
&
Channel
&
NewChatTitleMessage
)
|
(
New
&
Channel
&
PassportDataMessage
)
|
(
New
&
Channel
&
ProximityAlertTriggeredMessage
)
|
(
New
&
Channel
&
PhotoMessage
)
|
(
New
&
Channel
&
PinnedMessageMessage
)
|
(
New
&
Channel
&
PollMessage
)
|
(
New
&
Channel
&
StickerMessage
)
|
(
New
&
Channel
&
SuccessfulPaymentMessage
)
|
(
New
&
Channel
&
SupergroupChatCreated
)
|
(
New
&
Channel
&
VideoMessage
)
|
(
New
&
Channel
&
VideoNoteMessage
)
|
(
New
&
Channel
&
VoiceMessage
)
chat
get
chat
(
)
:
undefined
|
PrivateChat
|
GroupChat
|
SupergroupChat
|
ChannelChat
Returns
undefined
|
PrivateChat
|
GroupChat
|
SupergroupChat
|
ChannelChat
chosen
Inline
Result
get
chosenInlineResult
(
)
:
undefined
|
ChosenInlineResult
Returns
undefined
|
ChosenInlineResult
edited
Channel
Post
get
editedChannelPost
(
)
:
undefined
|
(
Edited
&
Channel
&
TextMessage
)
|
(
Edited
&
Channel
&
DocumentMessage
)
|
(
Edited
&
Channel
&
AudioMessage
)
|
(
Edited
&
Channel
&
ChannelChatCreatedMessage
)
|
(
Edited
&
Channel
&
ConnectedWebsiteMessage
)
|
(
Edited
&
Channel
&
ContactMessage
)
|
(
Edited
&
Channel
&
DeleteChatPhotoMessage
)
|
(
Edited
&
Channel
&
DiceMessage
)
|
(
Edited
&
Channel
&
GameMessage
)
|
(
Edited
&
Channel
&
GroupChatCreatedMessage
)
|
(
Edited
&
Channel
&
InvoiceMessage
)
|
(
Edited
&
Channel
&
LeftChatMemberMessage
)
|
(
Edited
&
Channel
&
LocationMessage
)
|
(
Edited
&
Channel
&
MigrateFromChatIdMessage
)
|
(
Edited
&
Channel
&
MigrateToChatIdMessage
)
|
(
Edited
&
Channel
&
NewChatMembersMessage
)
|
(
Edited
&
Channel
&
NewChatPhotoMessage
)
|
(
Edited
&
Channel
&
NewChatTitleMessage
)
|
(
Edited
&
Channel
&
PassportDataMessage
)
|
(
Edited
&
Channel
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
Channel
&
PhotoMessage
)
|
(
Edited
&
Channel
&
PinnedMessageMessage
)
|
(
Edited
&
Channel
&
PollMessage
)
|
(
Edited
&
Channel
&
StickerMessage
)
|
(
Edited
&
Channel
&
SuccessfulPaymentMessage
)
|
(
Edited
&
Channel
&
SupergroupChatCreated
)
|
(
Edited
&
Channel
&
VideoMessage
)
|
(
Edited
&
Channel
&
VideoNoteMessage
)
|
(
Edited
&
Channel
&
VoiceMessage
)
Returns
undefined
|
(
Edited
&
Channel
&
TextMessage
)
|
(
Edited
&
Channel
&
DocumentMessage
)
|
(
Edited
&
Channel
&
AudioMessage
)
|
(
Edited
&
Channel
&
ChannelChatCreatedMessage
)
|
(
Edited
&
Channel
&
ConnectedWebsiteMessage
)
|
(
Edited
&
Channel
&
ContactMessage
)
|
(
Edited
&
Channel
&
DeleteChatPhotoMessage
)
|
(
Edited
&
Channel
&
DiceMessage
)
|
(
Edited
&
Channel
&
GameMessage
)
|
(
Edited
&
Channel
&
GroupChatCreatedMessage
)
|
(
Edited
&
Channel
&
InvoiceMessage
)
|
(
Edited
&
Channel
&
LeftChatMemberMessage
)
|
(
Edited
&
Channel
&
LocationMessage
)
|
(
Edited
&
Channel
&
MigrateFromChatIdMessage
)
|
(
Edited
&
Channel
&
MigrateToChatIdMessage
)
|
(
Edited
&
Channel
&
NewChatMembersMessage
)
|
(
Edited
&
Channel
&
NewChatPhotoMessage
)
|
(
Edited
&
Channel
&
NewChatTitleMessage
)
|
(
Edited
&
Channel
&
PassportDataMessage
)
|
(
Edited
&
Channel
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
Channel
&
PhotoMessage
)
|
(
Edited
&
Channel
&
PinnedMessageMessage
)
|
(
Edited
&
Channel
&
PollMessage
)
|
(
Edited
&
Channel
&
StickerMessage
)
|
(
Edited
&
Channel
&
SuccessfulPaymentMessage
)
|
(
Edited
&
Channel
&
SupergroupChatCreated
)
|
(
Edited
&
Channel
&
VideoMessage
)
|
(
Edited
&
Channel
&
VideoNoteMessage
)
|
(
Edited
&
Channel
&
VoiceMessage
)
edited
Message
get
editedMessage
(
)
:
undefined
|
(
Edited
&
NonChannel
&
TextMessage
)
|
(
Edited
&
NonChannel
&
DocumentMessage
)
|
(
Edited
&
NonChannel
&
AudioMessage
)
|
(
Edited
&
NonChannel
&
ChannelChatCreatedMessage
)
|
(
Edited
&
NonChannel
&
ConnectedWebsiteMessage
)
|
(
Edited
&
NonChannel
&
ContactMessage
)
|
(
Edited
&
NonChannel
&
DeleteChatPhotoMessage
)
|
(
Edited
&
NonChannel
&
DiceMessage
)
|
(
Edited
&
NonChannel
&
GameMessage
)
|
(
Edited
&
NonChannel
&
GroupChatCreatedMessage
)
|
(
Edited
&
NonChannel
&
InvoiceMessage
)
|
(
Edited
&
NonChannel
&
LeftChatMemberMessage
)
|
(
Edited
&
NonChannel
&
LocationMessage
)
|
(
Edited
&
NonChannel
&
MigrateFromChatIdMessage
)
|
(
Edited
&
NonChannel
&
MigrateToChatIdMessage
)
|
(
Edited
&
NonChannel
&
NewChatMembersMessage
)
|
(
Edited
&
NonChannel
&
NewChatPhotoMessage
)
|
(
Edited
&
NonChannel
&
NewChatTitleMessage
)
|
(
Edited
&
NonChannel
&
PassportDataMessage
)
|
(
Edited
&
NonChannel
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
NonChannel
&
PhotoMessage
)
|
(
Edited
&
NonChannel
&
PinnedMessageMessage
)
|
(
Edited
&
NonChannel
&
PollMessage
)
|
(
Edited
&
NonChannel
&
StickerMessage
)
|
(
Edited
&
NonChannel
&
SuccessfulPaymentMessage
)
|
(
Edited
&
NonChannel
&
SupergroupChatCreated
)
|
(
Edited
&
NonChannel
&
VideoMessage
)
|
(
Edited
&
NonChannel
&
VideoNoteMessage
)
|
(
Edited
&
NonChannel
&
VoiceMessage
)
Returns
undefined
|
(
Edited
&
NonChannel
&
TextMessage
)
|
(
Edited
&
NonChannel
&
DocumentMessage
)
|
(
Edited
&
NonChannel
&
AudioMessage
)
|
(
Edited
&
NonChannel
&
ChannelChatCreatedMessage
)
|
(
Edited
&
NonChannel
&
ConnectedWebsiteMessage
)
|
(
Edited
&
NonChannel
&
ContactMessage
)
|
(
Edited
&
NonChannel
&
DeleteChatPhotoMessage
)
|
(
Edited
&
NonChannel
&
DiceMessage
)
|
(
Edited
&
NonChannel
&
GameMessage
)
|
(
Edited
&
NonChannel
&
GroupChatCreatedMessage
)
|
(
Edited
&
NonChannel
&
InvoiceMessage
)
|
(
Edited
&
NonChannel
&
LeftChatMemberMessage
)
|
(
Edited
&
NonChannel
&
LocationMessage
)
|
(
Edited
&
NonChannel
&
MigrateFromChatIdMessage
)
|
(
Edited
&
NonChannel
&
MigrateToChatIdMessage
)
|
(
Edited
&
NonChannel
&
NewChatMembersMessage
)
|
(
Edited
&
NonChannel
&
NewChatPhotoMessage
)
|
(
Edited
&
NonChannel
&
NewChatTitleMessage
)
|
(
Edited
&
NonChannel
&
PassportDataMessage
)
|
(
Edited
&
NonChannel
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
NonChannel
&
PhotoMessage
)
|
(
Edited
&
NonChannel
&
PinnedMessageMessage
)
|
(
Edited
&
NonChannel
&
PollMessage
)
|
(
Edited
&
NonChannel
&
StickerMessage
)
|
(
Edited
&
NonChannel
&
SuccessfulPaymentMessage
)
|
(
Edited
&
NonChannel
&
SupergroupChatCreated
)
|
(
Edited
&
NonChannel
&
VideoMessage
)
|
(
Edited
&
NonChannel
&
VideoNoteMessage
)
|
(
Edited
&
NonChannel
&
VoiceMessage
)
from
get
from
(
)
:
undefined
|
User
Returns
undefined
|
User
inline
Message
Id
get
inlineMessageId
(
)
:
undefined
|
string
Returns
undefined
|
string
inline
Query
get
inlineQuery
(
)
:
undefined
|
InlineQuery
Returns
undefined
|
InlineQuery
me
get
me
(
)
:
string
Returns
string
message
get
message
(
)
:
undefined
|
(
New
&
NonChannel
&
TextMessage
)
|
(
New
&
NonChannel
&
DocumentMessage
)
|
(
New
&
NonChannel
&
AudioMessage
)
|
(
New
&
NonChannel
&
ChannelChatCreatedMessage
)
|
(
New
&
NonChannel
&
ConnectedWebsiteMessage
)
|
(
New
&
NonChannel
&
ContactMessage
)
|
(
New
&
NonChannel
&
DeleteChatPhotoMessage
)
|
(
New
&
NonChannel
&
DiceMessage
)
|
(
New
&
NonChannel
&
GameMessage
)
|
(
New
&
NonChannel
&
GroupChatCreatedMessage
)
|
(
New
&
NonChannel
&
InvoiceMessage
)
|
(
New
&
NonChannel
&
LeftChatMemberMessage
)
|
(
New
&
NonChannel
&
LocationMessage
)
|
(
New
&
NonChannel
&
MigrateFromChatIdMessage
)
|
(
New
&
NonChannel
&
MigrateToChatIdMessage
)
|
(
New
&
NonChannel
&
NewChatMembersMessage
)
|
(
New
&
NonChannel
&
NewChatPhotoMessage
)
|
(
New
&
NonChannel
&
NewChatTitleMessage
)
|
(
New
&
NonChannel
&
PassportDataMessage
)
|
(
New
&
NonChannel
&
ProximityAlertTriggeredMessage
)
|
(
New
&
NonChannel
&
PhotoMessage
)
|
(
New
&
NonChannel
&
PinnedMessageMessage
)
|
(
New
&
NonChannel
&
PollMessage
)
|
(
New
&
NonChannel
&
StickerMessage
)
|
(
New
&
NonChannel
&
SuccessfulPaymentMessage
)
|
(
New
&
NonChannel
&
SupergroupChatCreated
)
|
(
New
&
NonChannel
&
VideoMessage
)
|
(
New
&
NonChannel
&
VideoNoteMessage
)
|
(
New
&
NonChannel
&
VoiceMessage
)
Returns
undefined
|
(
New
&
NonChannel
&
TextMessage
)
|
(
New
&
NonChannel
&
DocumentMessage
)
|
(
New
&
NonChannel
&
AudioMessage
)
|
(
New
&
NonChannel
&
ChannelChatCreatedMessage
)
|
(
New
&
NonChannel
&
ConnectedWebsiteMessage
)
|
(
New
&
NonChannel
&
ContactMessage
)
|
(
New
&
NonChannel
&
DeleteChatPhotoMessage
)
|
(
New
&
NonChannel
&
DiceMessage
)
|
(
New
&
NonChannel
&
GameMessage
)
|
(
New
&
NonChannel
&
GroupChatCreatedMessage
)
|
(
New
&
NonChannel
&
InvoiceMessage
)
|
(
New
&
NonChannel
&
LeftChatMemberMessage
)
|
(
New
&
NonChannel
&
LocationMessage
)
|
(
New
&
NonChannel
&
MigrateFromChatIdMessage
)
|
(
New
&
NonChannel
&
MigrateToChatIdMessage
)
|
(
New
&
NonChannel
&
NewChatMembersMessage
)
|
(
New
&
NonChannel
&
NewChatPhotoMessage
)
|
(
New
&
NonChannel
&
NewChatTitleMessage
)
|
(
New
&
NonChannel
&
PassportDataMessage
)
|
(
New
&
NonChannel
&
ProximityAlertTriggeredMessage
)
|
(
New
&
NonChannel
&
PhotoMessage
)
|
(
New
&
NonChannel
&
PinnedMessageMessage
)
|
(
New
&
NonChannel
&
PollMessage
)
|
(
New
&
NonChannel
&
StickerMessage
)
|
(
New
&
NonChannel
&
SuccessfulPaymentMessage
)
|
(
New
&
NonChannel
&
SupergroupChatCreated
)
|
(
New
&
NonChannel
&
VideoMessage
)
|
(
New
&
NonChannel
&
VideoNoteMessage
)
|
(
New
&
NonChannel
&
VoiceMessage
)
passport
Data
get
passportData
(
)
:
undefined
|
PassportData
Returns
undefined
|
PassportData
poll
get
poll
(
)
:
undefined
|
Poll
Returns
undefined
|
Poll
poll
Answer
get
pollAnswer
(
)
:
undefined
|
PollAnswer
Returns
undefined
|
PollAnswer
pre
Checkout
Query
get
preCheckoutQuery
(
)
:
undefined
|
PreCheckoutQuery
Returns
undefined
|
PreCheckoutQuery
sender
Chat
get
senderChat
(
)
:
undefined
|
PrivateChat
|
GroupChat
|
SupergroupChat
|
ChannelChat
Returns
undefined
|
PrivateChat
|
GroupChat
|
SupergroupChat
|
ChannelChat
shipping
Query
get
shippingQuery
(
)
:
undefined
|
ShippingQuery
Returns
undefined
|
ShippingQuery
telegram
get
telegram
(
)
:
Telegram
Returns
Telegram
update
Type
get
updateType
(
)
:
undefined
|
"callback_query"
|
"channel_post"
|
"chosen_inline_result"
|
"edited_channel_post"
|
"edited_message"
|
"inline_query"
|
"message"
|
"pre_checkout_query"
|
"shipping_query"
|
"poll"
|
"poll_answer"
Returns
undefined
|
"callback_query"
|
"channel_post"
|
"chosen_inline_result"
|
"edited_channel_post"
|
"edited_message"
|
"inline_query"
|
"message"
|
"pre_checkout_query"
|
"shipping_query"
|
"poll"
|
"poll_answer"
webhook
Reply
get
webhookReply
(
)
:
boolean
set
webhookReply
(
enable
:
boolean
)
:
void
deprecated
use
ctx.telegram.webhookReply
Returns
boolean
Parameters
enable:
boolean
Returns
void
Methods
add
Sticker
ToSet
add
Sticker
ToSet
(
...
args
:
[
name
:
string
,
stickerData
:
Pick
<
{}
,
"png_sticker"
|
"tgs_sticker"
|
"emojis"
|
"mask_position"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
name
:
string
,
stickerData
:
Pick
<
{}
,
"png_sticker"
|
"tgs_sticker"
|
"emojis"
|
"mask_position"
>
]
Returns
Promise
<
true
>
answer
CbQuery
answer
CbQuery
(
...
args
:
[
text
?:
string
,
extra
?:
Pick
<
{}
,
"cache_time"
|
"show_alert"
|
"url"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
text
?:
string
,
extra
?:
Pick
<
{}
,
"cache_time"
|
"show_alert"
|
"url"
>
]
Returns
Promise
<
true
>
answer
Game
Query
answer
Game
Query
(
...
args
:
[
url
:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
url
:
string
]
Returns
Promise
<
true
>
answer
Inline
Query
answer
Inline
Query
(
...
args
:
[
results
:
readonly
InlineQueryResult
[]
,
extra
?:
Pick
<
{}
,
"cache_time"
|
"is_personal"
|
"next_offset"
|
"switch_pm_text"
|
"switch_pm_parameter"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
results
:
readonly
InlineQueryResult
[]
,
extra
?:
Pick
<
{}
,
"cache_time"
|
"is_personal"
|
"next_offset"
|
"switch_pm_text"
|
"switch_pm_parameter"
>
]
Returns
Promise
<
true
>
answer
Pre
Checkout
Query
answer
Pre
Checkout
Query
(
...
args
:
[
ok
:
boolean
,
errorMessage
?:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
ok
:
boolean
,
errorMessage
?:
string
]
Returns
Promise
<
true
>
answer
Shipping
Query
answer
Shipping
Query
(
...
args
:
[
ok
:
boolean
,
shippingOptions
:
readonly
ShippingOption
[]
,
errorMessage
:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
ok
:
boolean
,
shippingOptions
:
readonly
ShippingOption
[]
,
errorMessage
:
string
]
Returns
Promise
<
true
>
copy
Message
copy
Message
(
chatId
:
string
|
number
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
>
)
:
Promise
<
MessageId
>
Parameters
chatId:
string
|
number
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
>
Returns
Promise
<
MessageId
>
create
New
Sticker
Set
create
New
Sticker
Set
(
...
args
:
[
name
:
string
,
title
:
string
,
stickerData
:
Pick
<
{}
,
"png_sticker"
|
"tgs_sticker"
|
"emojis"
|
"contains_masks"
|
"mask_position"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
name
:
string
,
title
:
string
,
stickerData
:
Pick
<
{}
,
"png_sticker"
|
"tgs_sticker"
|
"emojis"
|
"contains_masks"
|
"mask_position"
>
]
Returns
Promise
<
true
>
delete
Chat
Photo
delete
Chat
Photo
(
...
args
:
[
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
true
>
delete
Chat
Sticker
Set
delete
Chat
Sticker
Set
(
)
:
Promise
<
true
>
Returns
Promise
<
true
>
delete
Message
delete
Message
(
messageId
?:
number
)
:
Promise
<
true
>
Parameters
Optional
messageId:
number
Returns
Promise
<
true
>
delete
Sticker
From
Set
delete
Sticker
From
Set
(
sticker
:
string
)
:
Promise
<
true
>
Parameters
sticker:
string
Returns
Promise
<
true
>
edit
Message
Caption
edit
Message
Caption
(
caption
:
undefined
|
string
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"reply_markup"
>
)
:
Promise
<
true
|
(
Edited
&
CaptionableMessage
)
>
Parameters
caption:
undefined
|
string
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"reply_markup"
>
Returns
Promise
<
true
|
(
Edited
&
CaptionableMessage
)
>
edit
Message
Live
Location
edit
Message
Live
Location
(
latitude
:
number
, longitude
:
number
, extra
?:
Pick
<
{}
,
"reply_markup"
|
"horizontal_accuracy"
|
"heading"
|
"proximity_alert_radius"
>
)
:
Promise
<
true
|
(
Edited
&
LocationMessage
)
>
Parameters
latitude:
number
longitude:
number
Optional
extra:
Pick
<
{}
,
"reply_markup"
|
"horizontal_accuracy"
|
"heading"
|
"proximity_alert_radius"
>
Returns
Promise
<
true
|
(
Edited
&
LocationMessage
)
>
edit
Message
Media
edit
Message
Media
(
media
:
{}
|
{}
|
{}
|
{}
|
{}
, extra
?:
Pick
<
{}
,
"reply_markup"
>
)
:
Promise
<
true
|
(
Edited
&
AnimationMessage
)
|
(
Edited
&
AudioMessage
)
|
(
Edited
&
DocumentMessage
)
|
(
Edited
&
PhotoMessage
)
|
(
Edited
&
VideoMessage
)
>
Parameters
media:
{}
|
{}
|
{}
|
{}
|
{}
Optional
extra:
Pick
<
{}
,
"reply_markup"
>
Returns
Promise
<
true
|
(
Edited
&
AnimationMessage
)
|
(
Edited
&
AudioMessage
)
|
(
Edited
&
DocumentMessage
)
|
(
Edited
&
PhotoMessage
)
|
(
Edited
&
VideoMessage
)
>
edit
Message
Reply
Markup
edit
Message
Reply
Markup
(
markup
:
undefined
|
InlineKeyboardMarkup
)
:
Promise
<
true
|
(
Edited
&
LocationMessage
)
|
(
Edited
&
TextMessage
)
|
(
Edited
&
AnimationMessage
)
|
(
Edited
&
AudioMessage
)
|
(
Edited
&
DocumentMessage
)
|
(
Edited
&
PhotoMessage
)
|
(
Edited
&
VideoMessage
)
|
(
Edited
&
ChannelChatCreatedMessage
)
|
(
Edited
&
ConnectedWebsiteMessage
)
|
(
Edited
&
ContactMessage
)
|
(
Edited
&
DeleteChatPhotoMessage
)
|
(
Edited
&
DiceMessage
)
|
(
Edited
&
GameMessage
)
|
(
Edited
&
GroupChatCreatedMessage
)
|
(
Edited
&
InvoiceMessage
)
|
(
Edited
&
LeftChatMemberMessage
)
|
(
Edited
&
MigrateFromChatIdMessage
)
|
(
Edited
&
MigrateToChatIdMessage
)
|
(
Edited
&
NewChatMembersMessage
)
|
(
Edited
&
NewChatPhotoMessage
)
|
(
Edited
&
NewChatTitleMessage
)
|
(
Edited
&
PassportDataMessage
)
|
(
Edited
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
PinnedMessageMessage
)
|
(
Edited
&
PollMessage
)
|
(
Edited
&
StickerMessage
)
|
(
Edited
&
SuccessfulPaymentMessage
)
|
(
Edited
&
SupergroupChatCreated
)
|
(
Edited
&
VenueMessage
)
|
(
Edited
&
VideoNoteMessage
)
|
(
Edited
&
VoiceMessage
)
>
Parameters
markup:
undefined
|
InlineKeyboardMarkup
Returns
Promise
<
true
|
(
Edited
&
LocationMessage
)
|
(
Edited
&
TextMessage
)
|
(
Edited
&
AnimationMessage
)
|
(
Edited
&
AudioMessage
)
|
(
Edited
&
DocumentMessage
)
|
(
Edited
&
PhotoMessage
)
|
(
Edited
&
VideoMessage
)
|
(
Edited
&
ChannelChatCreatedMessage
)
|
(
Edited
&
ConnectedWebsiteMessage
)
|
(
Edited
&
ContactMessage
)
|
(
Edited
&
DeleteChatPhotoMessage
)
|
(
Edited
&
DiceMessage
)
|
(
Edited
&
GameMessage
)
|
(
Edited
&
GroupChatCreatedMessage
)
|
(
Edited
&
InvoiceMessage
)
|
(
Edited
&
LeftChatMemberMessage
)
|
(
Edited
&
MigrateFromChatIdMessage
)
|
(
Edited
&
MigrateToChatIdMessage
)
|
(
Edited
&
NewChatMembersMessage
)
|
(
Edited
&
NewChatPhotoMessage
)
|
(
Edited
&
NewChatTitleMessage
)
|
(
Edited
&
PassportDataMessage
)
|
(
Edited
&
ProximityAlertTriggeredMessage
)
|
(
Edited
&
PinnedMessageMessage
)
|
(
Edited
&
PollMessage
)
|
(
Edited
&
StickerMessage
)
|
(
Edited
&
SuccessfulPaymentMessage
)
|
(
Edited
&
SupergroupChatCreated
)
|
(
Edited
&
VenueMessage
)
|
(
Edited
&
VideoNoteMessage
)
|
(
Edited
&
VoiceMessage
)
>
edit
Message
Text
edit
Message
Text
(
text
:
string
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"reply_markup"
>
)
:
Promise
<
true
|
(
Edited
&
TextMessage
)
>
Parameters
text:
string
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"reply_markup"
>
Returns
Promise
<
true
|
(
Edited
&
TextMessage
)
>
export
Chat
Invite
Link
export
Chat
Invite
Link
(
...
args
:
[
]
)
:
Promise
<
string
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
string
>
forward
Message
forward
Message
(
chatId
:
string
|
number
, extra
?:
{
disable_notification
?:
undefined
|
boolean
}
)
:
Promise
<
Message
>
Parameters
chatId:
string
|
number
Optional
extra:
{
disable_notification
?:
undefined
|
boolean
}
Optional
disable_
notification
?:
undefined
|
boolean
Returns
Promise
<
Message
>
get
Chat
get
Chat
(
...
args
:
[
]
)
:
Promise
<
ChatFromGetChat
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
ChatFromGetChat
>
get
Chat
Administrators
get
Chat
Administrators
(
...
args
:
[
]
)
:
Promise
<
ChatMember
[]
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
ChatMember
[]
>
get
Chat
Member
get
Chat
Member
(
...
args
:
[
userId
:
number
]
)
:
Promise
<
ChatMember
>
Parameters
Rest
...
args:
[
userId
:
number
]
Returns
Promise
<
ChatMember
>
get
Chat
Members
Count
get
Chat
Members
Count
(
...
args
:
[
]
)
:
Promise
<
number
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
number
>
get
MyCommands
get
MyCommands
(
)
:
Promise
<
BotCommand
[]
>
Returns
Promise
<
BotCommand
[]
>
get
Sticker
Set
get
Sticker
Set
(
setName
:
string
)
:
Promise
<
StickerSet
>
Parameters
setName:
string
Returns
Promise
<
StickerSet
>
kick
Chat
Member
kick
Chat
Member
(
...
args
:
[
userId
:
number
,
untilDate
?:
number
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
userId
:
number
,
untilDate
?:
number
]
Returns
Promise
<
true
>
leave
Chat
leave
Chat
(
...
args
:
[
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
true
>
pin
Chat
Message
pin
Chat
Message
(
...
args
:
[
messageId
:
number
,
extra
?:
{
disable_notification
?:
undefined
|
boolean
}
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
messageId
:
number
,
extra
?:
{
disable_notification
?:
undefined
|
boolean
}
]
Returns
Promise
<
true
>
promote
Chat
Member
promote
Chat
Member
(
...
args
:
[
userId
:
number
,
extra
:
Pick
<
{}
,
"is_anonymous"
|
"can_change_info"
|
"can_post_messages"
|
"can_edit_messages"
|
"can_delete_messages"
|
"can_invite_users"
|
"can_restrict_members"
|
"can_pin_messages"
|
"can_promote_members"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
userId
:
number
,
extra
:
Pick
<
{}
,
"is_anonymous"
|
"can_change_info"
|
"can_post_messages"
|
"can_edit_messages"
|
"can_delete_messages"
|
"can_invite_users"
|
"can_restrict_members"
|
"can_pin_messages"
|
"can_promote_members"
>
]
Returns
Promise
<
true
>
reply
reply
(
...
args
:
[
text
:
string
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
)
:
Promise
<
TextMessage
>
Parameters
Rest
...
args:
[
text
:
string
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
Returns
Promise
<
TextMessage
>
reply
With
Animation
reply
With
Animation
(
...
args
:
[
animation
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"thumb"
|
"width"
|
"height"
>
]
)
:
Promise
<
AnimationMessage
>
Parameters
Rest
...
args:
[
animation
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"thumb"
|
"width"
|
"height"
>
]
Returns
Promise
<
AnimationMessage
>
reply
With
Audio
reply
With
Audio
(
...
args
:
[
audio
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"performer"
|
"title"
|
"thumb"
>
]
)
:
Promise
<
AudioMessage
>
Parameters
Rest
...
args:
[
audio
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"performer"
|
"title"
|
"thumb"
>
]
Returns
Promise
<
AudioMessage
>
reply
With
Chat
Action
reply
With
Chat
Action
(
...
args
:
[
action
:
"typing"
|
"upload_photo"
|
"record_video"
|
"upload_video"
|
"record_voice"
|
"upload_voice"
|
"upload_document"
|
"find_location"
|
"record_video_note"
|
"upload_video_note"
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
action
:
"typing"
|
"upload_photo"
|
"record_video"
|
"upload_video"
|
"record_voice"
|
"upload_voice"
|
"upload_document"
|
"find_location"
|
"record_video_note"
|
"upload_video_note"
]
Returns
Promise
<
true
>
reply
With
Contact
reply
With
Contact
(
...
args
:
[
phoneNumber
:
string
,
firstName
:
string
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"last_name"
|
"vcard"
>
]
)
:
Promise
<
ContactMessage
>
Parameters
Rest
...
args:
[
phoneNumber
:
string
,
firstName
:
string
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"last_name"
|
"vcard"
>
]
Returns
Promise
<
ContactMessage
>
reply
With
Dice
reply
With
Dice
(
...
args
:
[
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"emoji"
>
]
)
:
Promise
<
DiceMessage
>
Parameters
Rest
...
args:
[
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"emoji"
>
]
Returns
Promise
<
DiceMessage
>
reply
With
Document
reply
With
Document
(
...
args
:
[
document
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"thumb"
|
"disable_content_type_detection"
>
]
)
:
Promise
<
DocumentMessage
>
Parameters
Rest
...
args:
[
document
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"thumb"
|
"disable_content_type_detection"
>
]
Returns
Promise
<
DocumentMessage
>
reply
With
Game
reply
With
Game
(
...
args
:
[
gameName
:
string
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
)
:
Promise
<
GameMessage
>
Parameters
Rest
...
args:
[
gameName
:
string
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
Returns
Promise
<
GameMessage
>
reply
WithHTML
reply
WithHTML
(
html
:
string
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
)
:
Promise
<
TextMessage
>
Parameters
html:
string
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
Returns
Promise
<
TextMessage
>
reply
With
Invoice
reply
With
Invoice
(
...
args
:
[
invoice
:
Pick
<
{}
,
"title"
|
"description"
|
"payload"
|
"provider_token"
|
"start_parameter"
|
"currency"
|
"prices"
|
"provider_data"
|
"photo_url"
|
"photo_size"
|
"photo_width"
|
"photo_height"
|
"need_name"
|
"need_phone_number"
|
"need_email"
|
"need_shipping_address"
|
"send_phone_number_to_provider"
|
"send_email_to_provider"
|
"is_flexible"
>
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
)
:
Promise
<
InvoiceMessage
>
Parameters
Rest
...
args:
[
invoice
:
Pick
<
{}
,
"title"
|
"description"
|
"payload"
|
"provider_token"
|
"start_parameter"
|
"currency"
|
"prices"
|
"provider_data"
|
"photo_url"
|
"photo_size"
|
"photo_width"
|
"photo_height"
|
"need_name"
|
"need_phone_number"
|
"need_email"
|
"need_shipping_address"
|
"send_phone_number_to_provider"
|
"send_email_to_provider"
|
"is_flexible"
>
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
Returns
Promise
<
InvoiceMessage
>
reply
With
Location
reply
With
Location
(
...
args
:
[
latitude
:
number
,
longitude
:
number
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"horizontal_accuracy"
|
"heading"
|
"proximity_alert_radius"
|
"live_period"
>
]
)
:
Promise
<
LocationMessage
>
Parameters
Rest
...
args:
[
latitude
:
number
,
longitude
:
number
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"horizontal_accuracy"
|
"heading"
|
"proximity_alert_radius"
|
"live_period"
>
]
Returns
Promise
<
LocationMessage
>
reply
With
Markdown
reply
With
Markdown
(
markdown
:
string
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
)
:
Promise
<
TextMessage
>
Parameters
markdown:
string
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
Returns
Promise
<
TextMessage
>
reply
With
Markdown
V2
reply
With
Markdown
V2
(
markdown
:
string
, extra
?:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
)
:
Promise
<
TextMessage
>
Parameters
markdown:
string
Optional
extra:
Pick
<
{}
,
"parse_mode"
|
"entities"
|
"disable_web_page_preview"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
Returns
Promise
<
TextMessage
>
reply
With
Media
Group
reply
With
Media
Group
(
...
args
:
[
media
:
readonly
(
{}
|
{}
)
[]
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
>
]
)
:
Promise
<
(
DocumentMessage
|
AudioMessage
|
PhotoMessage
|
VideoMessage
)
[]
>
Parameters
Rest
...
args:
[
media
:
readonly
(
{}
|
{}
)
[]
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
>
]
Returns
Promise
<
(
DocumentMessage
|
AudioMessage
|
PhotoMessage
|
VideoMessage
)
[]
>
reply
With
Photo
reply
With
Photo
(
...
args
:
[
photo
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
>
]
)
:
Promise
<
PhotoMessage
>
Parameters
Rest
...
args:
[
photo
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
>
]
Returns
Promise
<
PhotoMessage
>
reply
With
Poll
reply
With
Poll
(
...
args
:
[
question
:
string
,
options
:
readonly
string
[]
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"is_anonymous"
|
"allows_multiple_answers"
|
"correct_option_id"
|
"explanation"
|
"explanation_parse_mode"
|
"explanation_entities"
|
"open_period"
|
"close_date"
|
"is_closed"
>
]
)
:
Promise
<
PollMessage
>
Parameters
Rest
...
args:
[
question
:
string
,
options
:
readonly
string
[]
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"is_anonymous"
|
"allows_multiple_answers"
|
"correct_option_id"
|
"explanation"
|
"explanation_parse_mode"
|
"explanation_entities"
|
"open_period"
|
"close_date"
|
"is_closed"
>
]
Returns
Promise
<
PollMessage
>
reply
With
Quiz
reply
With
Quiz
(
...
args
:
[
question
:
string
,
options
:
readonly
string
[]
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"is_anonymous"
|
"allows_multiple_answers"
|
"correct_option_id"
|
"explanation"
|
"explanation_parse_mode"
|
"explanation_entities"
|
"open_period"
|
"close_date"
|
"is_closed"
>
]
)
:
Promise
<
PollMessage
>
Parameters
Rest
...
args:
[
question
:
string
,
options
:
readonly
string
[]
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"is_anonymous"
|
"allows_multiple_answers"
|
"correct_option_id"
|
"explanation"
|
"explanation_parse_mode"
|
"explanation_entities"
|
"open_period"
|
"close_date"
|
"is_closed"
>
]
Returns
Promise
<
PollMessage
>
reply
With
Sticker
reply
With
Sticker
(
...
args
:
[
sticker
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
)
:
Promise
<
StickerMessage
>
Parameters
Rest
...
args:
[
sticker
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
>
]
Returns
Promise
<
StickerMessage
>
reply
With
Venue
reply
With
Venue
(
...
args
:
[
latitude
:
number
,
longitude
:
number
,
title
:
string
,
address
:
string
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"foursquare_id"
|
"foursquare_type"
|
"google_place_id"
|
"google_place_type"
>
]
)
:
Promise
<
VenueMessage
>
Parameters
Rest
...
args:
[
latitude
:
number
,
longitude
:
number
,
title
:
string
,
address
:
string
,
extra
:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"foursquare_id"
|
"foursquare_type"
|
"google_place_id"
|
"google_place_type"
>
]
Returns
Promise
<
VenueMessage
>
reply
With
Video
reply
With
Video
(
...
args
:
[
video
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"thumb"
|
"width"
|
"height"
|
"supports_streaming"
>
]
)
:
Promise
<
VideoMessage
>
Parameters
Rest
...
args:
[
video
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
|
"thumb"
|
"width"
|
"height"
|
"supports_streaming"
>
]
Returns
Promise
<
VideoMessage
>
reply
With
Video
Note
reply
With
Video
Note
(
...
args
:
[
videoNote
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"duration"
|
"thumb"
|
"length"
>
]
)
:
Promise
<
VideoNoteMessage
>
Parameters
Rest
...
args:
[
videoNote
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
,
extra
?:
Pick
<
{}
,
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"duration"
|
"thumb"
|
"length"
>
]
Returns
Promise
<
VideoNoteMessage
>
reply
With
Voice
reply
With
Voice
(
...
args
:
[
voice
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
>
]
)
:
Promise
<
VoiceMessage
>
Parameters
Rest
...
args:
[
voice
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
,
extra
?:
Pick
<
{}
,
"parse_mode"
|
"disable_notification"
|
"reply_to_message_id"
|
"allow_sending_without_reply"
|
"reply_markup"
|
"caption"
|
"caption_entities"
|
"duration"
>
]
Returns
Promise
<
VoiceMessage
>
restrict
Chat
Member
restrict
Chat
Member
(
...
args
:
[
userId
:
number
,
extra
:
Pick
<
{}
,
"permissions"
|
"until_date"
>
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
userId
:
number
,
extra
:
Pick
<
{}
,
"permissions"
|
"until_date"
>
]
Returns
Promise
<
true
>
set
Chat
Administrator
Custom
Title
set
Chat
Administrator
Custom
Title
(
...
args
:
[
userId
:
number
,
title
:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
userId
:
number
,
title
:
string
]
Returns
Promise
<
true
>
set
Chat
Description
set
Chat
Description
(
...
args
:
[
description
?:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
description
?:
string
]
Returns
Promise
<
true
>
set
Chat
Permissions
set
Chat
Permissions
(
...
args
:
[
permissions
:
ChatPermissions
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
permissions
:
ChatPermissions
]
Returns
Promise
<
true
>
set
Chat
Photo
set
Chat
Photo
(
...
args
:
[
photo
:
InputFile
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
photo
:
InputFile
]
Returns
Promise
<
true
>
set
Chat
Sticker
Set
set
Chat
Sticker
Set
(
setName
:
string
)
:
Promise
<
true
>
Parameters
setName:
string
Returns
Promise
<
true
>
set
Chat
Title
set
Chat
Title
(
...
args
:
[
title
:
string
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
title
:
string
]
Returns
Promise
<
true
>
set
MyCommands
set
MyCommands
(
commands
:
readonly
BotCommand
[]
)
:
Promise
<
true
>
Parameters
commands:
readonly
BotCommand
[]
Returns
Promise
<
true
>
set
Passport
Data
Errors
set
Passport
Data
Errors
(
errors
:
readonly
PassportElementError
[]
)
:
Promise
<
true
>
Parameters
errors:
readonly
PassportElementError
[]
Returns
Promise
<
true
>
set
Sticker
Position
InSet
set
Sticker
Position
InSet
(
sticker
:
string
, position
:
number
)
:
Promise
<
true
>
Parameters
sticker:
string
position:
number
Returns
Promise
<
true
>
set
Sticker
Set
Thumb
set
Sticker
Set
Thumb
(
...
args
:
[
name
:
string
,
userId
:
number
,
thumb
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
name
:
string
,
userId
:
number
,
thumb
:
string
|
InputFileByPath
|
InputFileByReadableStream
|
InputFileByBuffer
|
InputFileByURL
]
Returns
Promise
<
true
>
stop
Message
Live
Location
stop
Message
Live
Location
(
markup
?:
InlineKeyboardMarkup
)
:
Promise
<
true
|
(
Edited
&
LocationMessage
)
>
Parameters
Optional
markup:
InlineKeyboardMarkup
Returns
Promise
<
true
|
(
Edited
&
LocationMessage
)
>
stop
Poll
stop
Poll
(
...
args
:
[
messageId
:
number
,
extra
:
Pick
<
{}
,
"reply_markup"
>
]
)
:
Promise
<
Poll
>
Parameters
Rest
...
args:
[
messageId
:
number
,
extra
:
Pick
<
{}
,
"reply_markup"
>
]
Returns
Promise
<
Poll
>
unban
Chat
Member
unban
Chat
Member
(
...
args
:
[
userId
:
number
,
extra
?:
{
only_if_banned
?:
undefined
|
boolean
}
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
userId
:
number
,
extra
?:
{
only_if_banned
?:
undefined
|
boolean
}
]
Returns
Promise
<
true
>
unpin
All
Chat
Messages
unpin
All
Chat
Messages
(
...
args
:
[
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
]
Returns
Promise
<
true
>
unpin
Chat
Message
unpin
Chat
Message
(
...
args
:
[
messageId
?:
number
]
)
:
Promise
<
true
>
Parameters
Rest
...
args:
[
messageId
?:
number
]
Returns
Promise
<
true
>
upload
Sticker
File
upload
Sticker
File
(
...
args
:
[
stickerFile
:
InputFile
]
)
:
Promise
<
File
>
Parameters
Rest
...
args:
[
stickerFile
:
InputFile
]
Returns
Promise
<
File
>
Exports
Markup
Markup.button
Scenes
Base
Scene
Scene
Context
Scene
Stage
Wizard
Context
Wizard
Wizard
Scene
Scene
Context
Scene
Session
Scene
Session
Data
Wizard
Context
bot
Info
scene
session
state
tg
update
wizard
callback
Query
channel
Post
chat
chosen
Inline
Result
edited
Channel
Post
edited
Message
from
inline
Message
Id
inline
Query
me
message
passport
Data
poll
poll
Answer
pre
Checkout
Query
sender
Chat
shipping
Query
telegram
update
Type
webhook
Reply
add
Sticker
ToSet
answer
CbQuery
answer
Game
Query
answer
Inline
Query
answer
Pre
Checkout
Query
answer
Shipping
Query
copy
Message
create
New
Sticker
Set
delete
Chat
Photo
delete
Chat
Sticker
Set
delete
Message
delete
Sticker
From
Set
edit
Message
Caption
edit
Message
Live
Location
edit
Message
Media
edit
Message
Reply
Markup
edit
Message
Text
export
Chat
Invite
Link
forward
Message
get
Chat
get
Chat
Administrators
get
Chat
Member
get
Chat
Members
Count
get
MyCommands
get
Sticker
Set
kick
Chat
Member
leave
Chat
pin
Chat
Message
promote
Chat
Member
reply
reply
With
Animation
reply
With
Audio
reply
With
Chat
Action
reply
With
Contact
reply
With
Dice
reply
With
Document
reply
With
Game
reply
WithHTML
reply
With
Invoice
reply
With
Location
reply
With
Markdown
reply
With
Markdown
V2
reply
With
Media
Group
reply
With
Photo
reply
With
Poll
reply
With
Quiz
reply
With
Sticker
reply
With
Venue
reply
With
Video
reply
With
Video
Note
reply
With
Voice
restrict
Chat
Member
set
Chat
Administrator
Custom
Title
set
Chat
Description
set
Chat
Permissions
set
Chat
Photo
set
Chat
Sticker
Set
set
Chat
Title
set
MyCommands
set
Passport
Data
Errors
set
Sticker
Position
InSet
set
Sticker
Set
Thumb
stop
Message
Live
Location
stop
Poll
unban
Chat
Member
unpin
All
Chat
Messages
unpin
Chat
Message
upload
Sticker
File
Wizard
Session
Wizard
Session
Data
Generated using
TypeDoc
use
ctx.telegram.webhookReply