Interface Poll

This object contains information about a poll.

interface Poll {
    allows_multiple_answers: boolean;
    close_date?: number;
    correct_option_id?: number;
    explanation?: string;
    explanation_entities?: MessageEntity[];
    id: string;
    is_anonymous: boolean;
    is_closed: boolean;
    open_period?: number;
    options: PollOption[];
    question: string;
    question_entities?: MessageEntity[];
    total_voter_count: number;
    type: "quiz" | "regular";
}

Properties

allows_multiple_answers close_date? correct_option_id? explanation? explanation_entities? id is_anonymous is_closed open_period? options question question_entities? total_voter_count type

Properties

allows_multiple_answers

allows_multiple_answers: boolean

True, if the poll allows multiple answers

Optional close_date

close_date?: number

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

Optional correct_option_id

correct_option_id?: 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.

Optional 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

Optional explanation_entities

explanation_entities?: MessageEntity[]

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

id

id: string

Unique poll identifier

is_anonymous

is_anonymous: boolean

True, if the poll is anonymous

is_closed

is_closed: boolean

True, if the poll is closed

Optional open_period

open_period?: number

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

options

options: PollOption[]

List of poll options

question

question: string

Poll question, 1-300 characters

Optional question_entities

question_entities?: MessageEntity[]

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

total_voter_count

total_voter_count: number

Total number of users that voted in the poll

type

type: "quiz" | "regular"

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

Settings

Member Visibility

Theme

On This Page

allows_multiple_answersclose_datecorrect_option_idexplanationexplanation_entitiesidis_anonymousis_closedopen_periodoptionsquestionquestion_entitiestotal_voter_counttype