Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PollMessageEvent

Message is a native poll.

guides

Check official reference.

eventcategory

'message'

eventtype

'poll'

Hierarchy

  • EventObject<"message", "poll">
  • EventBase
  • Message
  • MessageDetail
  • MessagePoll
  • PollDetail
    • PollMessageEvent

Index

Properties

allowsMultipleAnswers: boolean

True, if the poll allows multiple answers

authorSignature?: string

Signature of the post author for messages in channels

botId: number
category: "message"
channel: TelegramChat
chat: RawChat

Conversation the message belongs to

closeDate?: number

Point in time (Unix timestamp) when the poll will be automatically closed

connectedWebsite?: string

The domain name of the website on which the user has logged in.

correctOptionId?: number

0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

date?: number

Date the message was sent in Unix time

editDate?: number

Date the message was last edited in Unix time

explanation?: string

Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters

explanationEntities?: any[]

Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

forwardDate?: number

For forwarded messages, date the original message was sent in Unix time

forwardFrom?: RawUser

For forwarded messages, sender of the original message

forwardFromChat?: RawChat

For messages forwarded from channels, information about the original channel

forwardFromMessageId?: number

For messages forwarded from channels, identifier of the original message in the channel

forwardSenderName?: string

Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages

forwardSignature?: string

For messages forwarded from channels, signature of the post author if present

from?: RawUser

Raw user object represent the sender, empty for messages sent to channels

isAnonymous: boolean

True, if the poll is anonymous

isClosed: boolean

True, if the poll is closed

mediaGroupId?: string

The unique identifier of a media message group this message belongs to

message: any
messageId: number

Unique message identifier inside this chat

openPeriod?: number

Amount of time in seconds the poll will be active after creation

options: any[]

List of poll options

passportData?: any

Telegram Passport data

platform: "telegram"
poll: any

Poll object.

pollId: string

Unique poll identifier

pollType: string

Poll type, currently can be “regular” or “quiz”

question: string

Poll question, 1-255 characters

replyMarkup?: any

Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.

replyToMessage?: any

For replies, the original message. Note that the Message object in this field will not contain furth

totalVoterCount: number

Total number of users that voted in the poll

type: "poll"
updateId: string

The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

user: TelegramUser | TelegramChatSender
viaBot?: RawUser

Bot through which the message was sent

Generated using TypeDoc