sendPoll

suspend fun TelegramBotApiClient.sendPoll(requestBody: SendPollRequest): TelegramResponse<Message>

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

suspend fun TelegramBotApiClient.sendPoll(chatId: Int, question: String, options: List<String> = emptyList(), isAnonymous: Boolean = false, type: String? = null, allowsMultipleAnswers: Boolean = false, correctOptionId: Int? = null, explanation: String? = null, explanationParseMode: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, isClosed: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): TelegramResponse<Message>

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

Parameters

chatId

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

question

Poll question, 1-300 characters

options

A JSON-serialized list of answer options, 2-10 strings 1-100 characters each

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

List of special entities that appear in the poll explanation, which can be specified instead of 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.

replyToMessageId

If the message is a reply, ID of the original message

allowSendingWithoutReply

Pass True, if the message should be sent even if the specified replied-to message is not found

replyMarkup

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.