Module

x/grammy_types/message.ts>Poll

Type declarations of the Telegram Bot API.
grammyjs/types
Popular
Latest
interface Poll
import { type Poll } from "https://dotland.deno.dev/x/grammy_types@v3.15.0/message.ts";

This object contains information about a poll.

Properties

id: string

Unique poll identifier

question: string

Poll question, 1-300 characters

optional
question_entities: MessageEntity[]

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

options: PollOption[]

List of poll options

total_voter_count: number

Total number of users that voted in the poll

is_closed: boolean

True, if the poll is closed

is_anonymous: boolean

True, if the poll is anonymous

type: "regular" | "quiz"

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

allows_multiple_answers: boolean

True, if the poll allows multiple answers

optional
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: 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: MessageEntity[]

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

optional
open_period: number

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

optional
close_date: number

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