GramIO API Reference / gramio/dist / TelegramPoll
Interface: TelegramPoll
Defined in: @gramio/types/out/objects.d.ts:2153
This object contains information about a poll.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allows_multiple_answers | boolean | True, if the poll allows multiple answers | @gramio/types/out/objects.d.ts:2189 |
allows_revoting | boolean | True, if the poll allows to change the chosen answer options | @gramio/types/out/objects.d.ts:2193 |
close_date? | number | Optional. Point in time (Unix timestamp) when the poll will be automatically closed | @gramio/types/out/objects.d.ts:2225 |
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. | @gramio/types/out/objects.d.ts:2205 |
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. | @gramio/types/out/objects.d.ts:2201 |
description? | string | Optional. Description of the poll; for polls inside the Message object only | @gramio/types/out/objects.d.ts:2229 |
description_entities? | TelegramMessageEntity[] | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description | @gramio/types/out/objects.d.ts:2233 |
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 | @gramio/types/out/objects.d.ts:2209 |
explanation_entities? | TelegramMessageEntity[] | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation | @gramio/types/out/objects.d.ts:2213 |
explanation_media? | TelegramPollMedia | Optional. Media added to the quiz explanation | @gramio/types/out/objects.d.ts:2217 |
id | string | Unique poll identifier | @gramio/types/out/objects.d.ts:2157 |
is_anonymous | boolean | True, if the poll is anonymous | @gramio/types/out/objects.d.ts:2181 |
is_closed | boolean | True, if the poll is closed | @gramio/types/out/objects.d.ts:2177 |
media? | TelegramPollMedia | Optional. Media added to the poll description; for polls inside the Message object only | @gramio/types/out/objects.d.ts:2237 |
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 | @gramio/types/out/objects.d.ts:2197 |
open_period? | number | Optional. Amount of time in seconds the poll will be active after creation | @gramio/types/out/objects.d.ts:2221 |
options | TelegramPollOption[] | List of poll options | @gramio/types/out/objects.d.ts:2169 |
question | string | Poll question, 1-300 characters | @gramio/types/out/objects.d.ts:2161 |
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:2165 |
total_voter_count | number | Total number of users that voted in the poll | @gramio/types/out/objects.d.ts:2173 |
type | TelegramPollType | Poll type, currently can be “regular” or “quiz” | @gramio/types/out/objects.d.ts:2185 |