Poll

Official docs ↗

This object contains information about a poll.

Fields

idStringRequired

Unique poll identifier

questionStringRequiredminLen 1maxLen 300

Poll question, 1-300 characters

question_entitiesMessageEntity[]Optional

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

optionsPollOption[]Required

List of poll options

total_voter_countIntegerRequired

Total number of users that voted in the poll

is_closedBooleanRequired

True, if the poll is closed

is_anonymousBooleanRequired

True, if the poll is anonymous

typeStringRequired

Values:regularquiz

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

allows_multiple_answersBooleanRequired

True, if the poll allows multiple answers

allows_revotingBooleanRequired

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

members_onlyBooleanRequired

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_codesString[]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_idsInteger[]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.

explanationStringOptionalminLen 0maxLen 200

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_entitiesMessageEntity[]Optional

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

explanation_mediaPollMediaOptional

Optional. Media added to the quiz explanation

open_periodIntegerOptional

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

close_dateIntegerOptional

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

descriptionStringOptional

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

description_entitiesMessageEntity[]Optional

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

mediaPollMediaOptional

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

GramIO Usage

See Also