Skip to content

GramIO API Reference / gramio/dist / TelegramPoll

Interface: TelegramPoll

Defined in: @gramio/types/out/objects.d.ts:1835

This object contains information about a poll.

Documentation

Properties

PropertyTypeDescriptionDefined in
allows_multiple_answersbooleanTrue, if the poll allows multiple answers@gramio/types/out/objects.d.ts:1871
close_date?numberOptional. Point in time (Unix timestamp) when the poll will be automatically closed@gramio/types/out/objects.d.ts:1891
correct_option_id?numberOptional. 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.@gramio/types/out/objects.d.ts:1875
explanation?stringOptional. 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@gramio/types/out/objects.d.ts:1879
explanation_entities?TelegramMessageEntity[]Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation@gramio/types/out/objects.d.ts:1883
idstringUnique poll identifier@gramio/types/out/objects.d.ts:1839
is_anonymousbooleanTrue, if the poll is anonymous@gramio/types/out/objects.d.ts:1863
is_closedbooleanTrue, if the poll is closed@gramio/types/out/objects.d.ts:1859
open_period?numberOptional. Amount of time in seconds the poll will be active after creation@gramio/types/out/objects.d.ts:1887
optionsTelegramPollOption[]List of poll options@gramio/types/out/objects.d.ts:1851
questionstringPoll question, 1-300 characters@gramio/types/out/objects.d.ts:1843
question_entities?TelegramMessageEntity[]Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions@gramio/types/out/objects.d.ts:1847
total_voter_countnumberTotal number of users that voted in the poll@gramio/types/out/objects.d.ts:1855
typeTelegramPollTypePoll type, currently can be “regular” or “quiz”@gramio/types/out/objects.d.ts:1867