Skip to main content
Version: 0.15.17

TelegramEvent

rawEvent

Underlying raw event from Telegram.

Example:

event.rawEvent;
// {
//   message: {
//     message_id: 666,
//     from: {
//       id: 427770117,
//       is_bot: false,
//       first_name: 'first',
//       last_name: 'last',
//       language_code: 'en',
//     },
//     chat: {
//       id: 427770117,
//       first_name: 'first',
//       last_name: 'last',
//       type: 'private',
//     },
//     date: 1499402829,
//     text: 'text',
//   },
// }

isMessage

Determine if the event is a message event.

Example:

event.isMessage; // true

message

The message object from Telegram raw event.

Example:

event.message;
// {
//   message_id: 666,
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'first',
//     last_name: 'last',
//     language_code: 'en',
//   },
//   chat: {
//     id: 427770117,
//     first_name: 'first',
//     last_name: 'last',
//     type: 'private',
//   },
//   date: 1499402829,
//   text: 'text',
// }

isText

Determine if the event is a message event which includes text.

Example:

event.isText; // true

text

The text string from Telegram raw event.

Example:

event.text; // 'text'

isAudio

Determine if the event is a message event which includes audio.

Example:

event.isAudio; // true

audio

The audio object from Telegram raw event.

Example:

event.audio;
// {
//   file_id: '321',
//   duration: 100,
//   title: 'audioooooooo',
// }

isDocument

Determine if the event is a message event which includes document.

Example:

event.isDocument; // true

document

The document object from Telegram raw event.

Example:

event.document;
// {
//   file_id: '234',
//   file_name: 'file',
// }

isGame

Determine if the event is a message event which includes game.

Example:

event.isGame; // true

game

The game object from Telegram raw event.

Example:

event.game;
// {
//   title: 'gammmmmmmme',
//   description: 'Description of the game',
//   photo: [
//     {
//       file_id: '112',
//       width: 100,
//       height: 100,
//     },
//     {
//       file_id: '116',
//       width: 50,
//       height: 50,
//     },
//   ],
// }

isPhoto

Determine if the event is a message event which includes photo.

Example:

event.isPhoto; // true

photo

The photo object from Telegram raw event.

Example:

event.photo;
// [
//   {
//     file_id: '112',
//     width: 100,
//     height: 100,
//   },
//   {
//     file_id: '116',
//     width: 50,
//     height: 50,
//   },
// ]

isSticker

Determine if the event is a message event which includes sticker.

Example:

event.isSticker; // true

sticker

The sticker object from Telegram raw event.

Example:

event.sticker;
// {
//   file_id: '123',
//   width: 50,
//   height: 50,
// }

isVideo

Determine if the event is a message event which includes video.

Example:

event.isVideo; // true

video

The video object from Telegram raw event.

Example:

event.video;
// {
//   file_id: '321',
//   width: 100,
//   height: 100,
//   duration: 199,
// }

isVoice

Determine if the event is a message event which includes voice.

Example:

event.isVoice; // true

voice

The voice object from Telegram raw event.

Example:

event.voice;
// {
//   file_id: '543',
//   duration: 299,
// }

isVideoNote

Determine if the event is a message event which includes video note.

Example:

event.isVideoNote; // true

videoNote

The video note object from Telegram raw event.

Example:

event.videoNote;
// {
//   file_id: '654',
//   length: 100,
//   duration: 399,
// }

isContact

Determine if the event is a message event which includes contact.

Example:

event.isContact; // true

contact

The contact object from Telegram raw event.

Example:

event.contact;
// {
//   phone_number: '123456789',
//   first_name: 'first',
// }

isLocation

Determine if the event is a message event which includes location.

Example:

event.isLocation; // true

location

The location object from Telegram raw event.

Example:

event.location;
// {
//   longitude: '111.111',
//   latitude: '99.99',
// }

isVenue

Determine if the event is a message event which includes venue.

Example:

event.isVenue; // true

venue

The venue object from Telegram raw event.

Example:

event.venue;
// {
//   location: {
//     longitude: '111.111',
//     latitude: '99.99',
//   },
//   title: 'title',
//   address: 'addressssss',
// }

isEditedMessage

Determine if the event is an edited message event.

Example:

event.isEditedMessage; // true

editedMessage

The edited message from Telegram raw event.

Example:

event.editedMessage;
// {
//   message_id: 229,
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'user_first',
//     last_name: 'user_last',
//     language_code: 'en',
//   },
//   chat: {
//     id: 427770117,
//     first_name: 'user_first',
//     last_name: 'user_last',
//     language_code: 'en',
//   },
//   date: 1515736358,
//   edit_date: 1515758017,
//   text: 'hiiiii',
// }

isChannelPost

Determine if the event is a channel post event.

Example:

event.isChannelPost; // true

channelPost

The channel post from Telegram raw event.

Example:

event.channelPost;
// {
//   message_id: 2,
//   chat: {
//     id: -1001305240521,
//     title: 'channel_12345',
//     type: 'channel',
//   },
//   date: 1515760382,
//   text: 'post~~~',
// }

isEditedChannelPost

Determine if the event is an edited channel post event.

Example:

event.isEditedChannelPost; // true

editedChannelPost

The edited channel post from Telegram raw event.

Example:

event.editedChannelPost;
// {
//   message_id: 2,
//   chat: {
//     id: -1001305240521,
//     title: 'channel_12345',
//     type: 'channel',
//   },
//   date: 1515760382,
//   edit_date: 1515760478,
//   text: 'post~~~edited',
// }

isInlineQuery

Determine if the event is an inline query event.

Example:

event.isInlineQuery; // true

inlineQuery

The inline query from Telegram raw event.

Example:

event.inlineQuery;
// {
//   id: '1837258670654537434',
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'user_first',
//     last_name: 'user_last',
//     language_code: 'en',
//   },
//   query: '123',
//   offset: '',
// }

isChosenInlineResult

Determine if the event is a chosen inline result event.

Example:

event.isChosenInlineResult; // true

chosenInlineResult

The chosen inline result from Telegram raw event.

Example:

event.chosenInlineResult;
// {
//   result_id: '2837258670654537434',
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'user_first',
//     last_name: 'user_last',
//     language_code: 'en',
//   },
//   inline_message_id: '1837258670654537434',
//   query: '123',
// }

isCallbackQuery

Determine if the event is a callback query event.

Example:

event.isCallbackQuery; // true

callbackQuery

The callback query from Telegram raw event.

Example:

event.callbackQuery;
// {
//   id: '123',
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'user_first',
//     last_name: 'user_last',
//     language_code: 'en',
//   },
//   message: {
//     message_id: 666,
//     from: {
//       id: 313534466,
//       is_bot: true,
//       first_name: 'bot_first',
//       username: 'bot_name',
//     },
//     chat: {
//       id: 427770117,
//       first_name: 'first',
//       last_name: 'last',
//       type: 'private',
//     },
//     date: 1499402829,
//     text: 'text',
//   },
//   chat_instance: '-1828607021492040088',
//   data: 'DEVELOPER_DEFINED_PAYLOAD',
// }

isPayload

Determine if the event is a callback query event.

Example:

event.isPayload; // true

payload

The payload string from Telegram raw event.

Example:

event.payload; // 'DEVELOPER_DEFINED_PAYLOAD'

isShippingQuery

Determine if the event is a shipping query event.

Example:

event.isShippingQuery; // true

shippingQuery

The shipping query from Telegram raw event.

Example:

event.shippingQuery;
// {
//   id: '123',
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'first',
//     last_name: 'last',
//     language_code: 'en',
//   },
//   invoice_payload: 'payload',
//   shipping_address: {
//     country_code: '...',
//     state: '...',
//     city: '...',
//     street_line1: '...',
//     street_line2: '...',
//     post_code: '...',
//   },
// }

isPreCheckoutQuery

Determine if the event is a pre checkout query event.

Example:

event.isPreCheckoutQuery; // true

preCheckoutQuery

The pre checkout query from Telegram raw event.

Example:

event.preCheckoutQuery;
// {
//   id: '123',
//   from: {
//     id: 427770117,
//     is_bot: false,
//     first_name: 'first',
//     last_name: 'last',
//     language_code: 'en',
//   },
//   currency: 'USD',
//   total_amount: 100,
//   invoice_payload: 'payload',
// }