grammY

Appearance

Message ​

ref / types / Message

This object represents a message.

Source

Extends ​

ts
[Message.MediaMessage]

Properties ​

text ​

ts
text?: string;

For text messages, the actual UTF-8 text of the message

Source

entities ​

ts
entities?: MessageEntity[];

For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text

Source

animation ​

ts
animation?: Animation;

Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set

Source

audio ​

ts
audio?: Audio;

Message is an audio file, information about the file

Source

document ​

ts
document?: Document;

Message is a general file, information about the file

Source

photo ​

ts
photo?: PhotoSize[];

Message is a photo, available sizes of the photo

Source

sticker ​

ts
sticker?: Sticker;

Message is a sticker, information about the sticker

Source

story ​

ts
story?: Story;

Message is a forwarded story

Source

video ​

ts
video?: Video;

Message is a video, information about the video

Source

video_note ​

ts
video_note?: VideoNote;

Message is a video note, information about the video message

Source

voice ​

ts
voice?: Voice;

Message is a voice message, information about the file

Source

contact ​

ts
contact?: Contact;

Message is a shared contact, information about the contact

Source

dice ​

ts
dice?: Dice;

Message is a dice with random value

Source

game ​

ts
game?: Game;

Message is a game, information about the game. More about games »

Source

poll ​

ts
poll?: Poll;

Message is a native poll, information about the poll

Source

venue ​

ts
venue?: Venue;

Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set

Source

location ​

ts
location?: Location;

Message is a shared location, information about the location

Source

ts
paid_media?: PaidMediaInfo;

Message contains paid media; information about the paid media

Source

new_chat_members ​

ts
new_chat_members?: User[];

New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

Source

left_chat_member ​

ts
left_chat_member?: User;

A member was removed from the group, information about them (this member may be the bot itself)

Source

new_chat_title ​

ts
new_chat_title?: string;

A chat title was changed to this value

Source

new_chat_photo ​

ts
new_chat_photo?: PhotoSize[];

A chat photo was change to this value

Source

delete_chat_photo ​

ts
delete_chat_photo?: true;

Service message: the chat photo was deleted

Source

group_chat_created ​

ts
group_chat_created?: true;

Service message: the group has been created

Source

supergroup_chat_created ​

ts
supergroup_chat_created?: true;

Service message: the supergroup has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

Source

channel_chat_created ​

ts
channel_chat_created?: true;

Service message: the channel has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.

Source

message_auto_delete_timer_changed ​

ts
message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged;

Service message: auto-delete timer settings changed in the chat

Source

migrate_to_chat_id ​

ts
migrate_to_chat_id?: number;

The group has been migrated to a supergroup with the specified identifier.

Source

migrate_from_chat_id ​

ts
migrate_from_chat_id?: number;

The supergroup has been migrated from a group with the specified identifier.

Source

pinned_message ​

ts
pinned_message?: MaybeInaccessibleMessage;

Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

Source

invoice ​

ts
invoice?: Invoice;

Message is an invoice for a payment, information about the invoice. More about payments »

Source

successful_payment ​

ts
successful_payment?: SuccessfulPayment;

Message is a service message about a successful payment, information about the payment. More about payments »

Source

refunded_payment ​

ts
refunded_payment?: RefundedPayment;

Message is a service message about a refunded payment, information about the payment. More about payments »

Source

users_shared ​

ts
users_shared?: UsersShared;

Service message: users were shared with the bot

Source

chat_shared ​

ts
chat_shared?: ChatShared;

Service message: a chat was shared with the bot

Source

connected_website ​

ts
connected_website?: string;

The domain name of the website on which the user has logged in. More about Telegram Login »

Source

write_access_allowed ​

ts
write_access_allowed?: WriteAccessAllowed;

Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess

Source

passport_data ​

ts
passport_data?: PassportData;

Telegram Passport data

Source

proximity_alert_triggered ​

ts
proximity_alert_triggered?: ProximityAlertTriggered;

Service message. A user in the chat triggered another user’s proximity alert while sharing Live Location.

Source

boost_added ​

ts
boost_added?: ChatBoostAdded;

Service message: user boosted the chat

Source

chat_background_set ​

ts
chat_background_set?: ChatBackground;

Source

forum_topic_created ​

ts
forum_topic_created?: ForumTopicCreated;

Service message: forum topic created

Source

forum_topic_edited ​

ts
forum_topic_edited?: ForumTopicEdited;

Service message: forum topic edited

Source

forum_topic_closed ​

ts
forum_topic_closed?: ForumTopicClosed;

Service message: forum topic closed

Source

forum_topic_reopened ​

ts
forum_topic_reopened?: ForumTopicReopened;

Service message: forum topic reopened

Source

general_forum_topic_hidden ​

ts
general_forum_topic_hidden?: GeneralForumTopicHidden;

Service message: the ‘General’ forum topic hidden

Source

general_forum_topic_unhidden ​

ts
general_forum_topic_unhidden?: GeneralForumTopicUnhidden;

Service message: the ‘General’ forum topic unhidden

Source

giveaway_created ​

ts
giveaway_created?: GiveawayCreated;

Service message: a scheduled giveaway was created

Source

giveaway ​

ts
giveaway?: Giveaway;

The message is a scheduled giveaway message

Source

giveaway_winners ​

ts
giveaway_winners?: GiveawayWinners;

A giveaway with public winners was completed

Source

giveaway_completed ​

ts
giveaway_completed?: GiveawayCompleted;

Service message: a giveaway without public winners was completed

Source

video_chat_scheduled ​

ts
video_chat_scheduled?: VideoChatScheduled;

Service message: video chat scheduled

Source

video_chat_started ​

ts
video_chat_started?: VideoChatStarted;

Service message: video chat started

Source

video_chat_ended ​

ts
video_chat_ended?: VideoChatEnded;

Service message: video chat ended

Source

video_chat_participants_invited ​

ts
video_chat_participants_invited?: VideoChatParticipantsInvited;

Service message: new participants invited to a video chat

Source

web_app_data ​

ts
web_app_data?: WebAppData;

Service message: data sent by a Web App

Source

Interfaces ​

Type Aliases ​