Poll

^{ref / types / Poll}

This object contains information about a poll.

^Source

Properties

id

id: string;

Unique poll identifier

^Source

question

question: string;

Poll question, 1-300 characters

^Source

question_entities

question_entities?: MessageEntity[];

Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions

^Source

options

options: PollOption[];

List of poll options

^Source

total_voter_count

total_voter_count: number;

Total number of users that voted in the poll

^Source

is_closed

is_closed: boolean;

True, if the poll is closed

^Source

is_anonymous

is_anonymous: boolean;

True, if the poll is anonymous

^Source

type

type: "regular" | "quiz";

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

^Source

allows_multiple_answers

allows_multiple_answers: boolean;

True, if the poll allows multiple answers

^Source

allows_revoting

allows_revoting: boolean;

True, if the poll allows to change the chosen answer options

^Source

members_only

members_only: boolean;

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

^Source

country_codes

country_codes?: string[];

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.

^Source

correct_option_ids

correct_option_ids?: number[];

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.

^Source

explanation

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

^Source

explanation_entities

explanation_entities?: MessageEntity[];

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

^Source

explanation_media

explanation_media?: PollMedia;

Media added to the quiz explanation

^Source

open_period

open_period?: number;

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

^Source

close_date

close_date?: number;

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

^Source

description

description?: string;

Description of the poll; for polls inside the Message object only

^Source

description_entities

description_entities?: MessageEntity[];

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

^Source

media

media?: PollMedia;

Media added to the poll description; for polls inside the Message object only

^Source