Poll

This object contains information about a poll.

fields

field	type	required	description
`id`	string	required	Unique poll identifier
`question`	string	required	Poll question, 1-300 characters
`question_entities`	MessageEntity[]	optional	Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions
`options`	PollOption[]	required	List of poll options
`total_voter_count`	number	required	Total number of users that voted in the poll
`is_closed`	boolean	required	True, if the poll is closed
`is_anonymous`	boolean	required	True, if the poll is anonymous
`type`	"regular" \| "quiz"	required	Poll type, currently can be “regular” or “quiz”
`allows_multiple_answers`	boolean	required	True, if the poll allows multiple answers
`allows_revoting`	boolean	required	True, if the poll allows to change the chosen answer options
`members_only`	boolean	required	True if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours
`country_codes`	string[]	optional	Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll. The country code “FT” is used for users with anonymous numbers. If omitted, then users from any country can participate in the poll.
`correct_option_ids`	number[]	optional	Optional. Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.
`explanation`	string	optional	Optional. 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
`explanation_entities`	MessageEntity[]	optional	Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
`explanation_media`	PollMedia	optional	Optional. Media added to the quiz explanation
`open_period`	number	optional	Optional. Amount of time in seconds the poll will be active after creation
`close_date`	number	optional	Optional. Point in time (Unix timestamp) when the poll will be automatically closed
`description`	string	optional	Optional. Description of the poll; for polls inside the Message object only
`description_entities`	MessageEntity[]	optional	Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description
`media`	PollMedia	optional	Optional. Media added to the poll description; for polls inside the Message object only

import

types.ts

import type { Poll } from "@yaebal/types";

Poll

fields

import

used by

methods

types