Poll

interface

This object contains information about a poll.

Declaration

interface Poll

Properties

allows_multiple_answersproperty#

allows_multiple_answers: boolean;

True, if the poll allows multiple answers

allows_revotingproperty#

allows_revoting: boolean;

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

close_dateproperty#

close_date?: number;

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

correct_option_idsproperty#

correct_option_ids?: number[];

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.

country_codesproperty#

country_codes?: string[];

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.

description_entitiesproperty#

description_entities?: MessageEntity[];

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

descriptionproperty#

description?: string;

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

explanation_entitiesproperty#

explanation_entities?: MessageEntity[];

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

explanation_mediaproperty#

explanation_media?: PollMedia;

Optional. Media added to the quiz explanation

explanationproperty#

explanation?: string;

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

idproperty#

id: string;

Unique poll identifier

is_anonymousproperty#

is_anonymous: boolean;

True, if the poll is anonymous

is_closedproperty#

is_closed: boolean;

True, if the poll is closed

mediaproperty#

media?: PollMedia;

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

members_onlyproperty#

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

open_periodproperty#

open_period?: number;

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

optionsproperty#

options: PollOption[];

List of poll options

question_entitiesproperty#

question_entities?: MessageEntity[];

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

questionproperty#

question: string;

Poll question, 1-300 characters

total_voter_countproperty#

total_voter_count: number;

Total number of users that voted in the poll

typeproperty#

type: string;

Poll type, currently can be "regular" or "quiz"