poll

inline fun poll(question: String, options: List<InputPollOption>): SendPollAction

Use this method to send a native poll. On success, the sent Message is returned.

Api reference

Parameters

businessConnectionId

Unique identifier of the business connection on behalf of which the message will be sent

chatId

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

messageThreadId

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

question

Poll question, 1-300 characters

questionParseMode

Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed

questionEntities

A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode

options

A JSON-serialized list of 2-10 answer options

isAnonymous

True, if the poll needs to be anonymous, defaults to True

type

Poll type, "quiz" or "regular", defaults to "regular"

allowsMultipleAnswers

True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

correctOptionId

0-based identifier of the correct answer option, required for polls in quiz mode

explanation

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

explanationParseMode

Mode for parsing entities in the explanation. See formatting options for more details.

explanationEntities

A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode

openPeriod

Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.

closeDate

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.

isClosed

Pass True if the poll needs to be immediately closed. This can be useful for poll preview.

disableNotification

Sends the message silently. Users will receive a notification with no sound.

protectContent

Protects the contents of the sent message from forwarding and saving

allowPaidBroadcast

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

messageEffectId

Unique identifier of the message effect to be added to the message; for private chats only

replyParameters

Description of the message to reply to

replyMarkup

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


fun poll(question: String, options: PollOptionsBuilder.() -> Unit): SendPollAction
inline fun poll(question: String, vararg options: InputPollOption): SendPollAction