sendPoll
Use this method to send a native poll.
Required: chat_id, question, options · Optional: 20 parameters
Limits:
- question: 1-300 characters
- explanation: 0-200 characters
- allow_paid_broadcast: up to 1000 messages
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("send_poll", { chat_id: "YOUR_CHAT_ID", question: "...", options: []})Parameters
chat_id number | string Required
Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can’t be sent to channel direct messages chats.
question string Required
Poll question, 1-300 characters.
options InputPollOption[] Required
A JSON-serialized list of 2-12 answer options.
business_connection_id string
Unique identifier of the business connection on behalf of which the message will be sent.
message_thread_id number
Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
question_parse_mode "HTML" | "MarkdownV2"
Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
question_entities MessageEntity[]
A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
is_anonymous boolean
True, if the poll needs to be anonymous, defaults to True.
type string
Poll type, “quiz” or “regular”, defaults to “regular”.
allows_multiple_answers boolean
True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False.
correct_option_id number
0-based identifier of the correct answer option, required for polls in quiz mode.
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 with at most 2 line feeds after entities parsing.
explanation_parse_mode "HTML" | "MarkdownV2"
Mode for parsing entities in the explanation. See formatting options for more details.
explanation_entities MessageEntity[]
A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode.
open_period number
Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date.
close_date number
Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can’t be used together with open_period.
is_closed boolean
Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
disable_notification boolean
Sends the message silently. Users will receive a notification with no sound.
protect_content boolean
Protects the contents of the sent message from forwarding and saving.
allow_paid_broadcast boolean
Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance.
message_effect_id string
Unique identifier of the message effect to be added to the message; for private chats only.
reply_parameters ReplyParameters
Description of the message to reply to.
reply_markup InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply
Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
Related methods
sendAnimation · sendAudio · sendChatAction · sendChecklist · sendContact · sendDice · sendDocument · sendGame · sendGift · sendInvoice · sendLocation · sendMediaGroup · sendMessage · sendMessageDraft · sendPaidMedia · sendPhoto · sendSticker · sendVenue · sendVideo · sendVideoNote · sendVoice