TgKit library and website are still in early development!

PollMessageSendOptions Interface

Properties

allowSendingWithoutReplyallowsMultipleAnswersbusinessConnectionIdcloseDatecorrectOptionIddisableNotificationexplanationexplanationEntitiesexplanationParseModeforumTopicIdisAnonymousisClosedopenPeriodprotectContentreplyMarkupreplyToMessageIdtype

Properties

allowSendingWithoutReply boolean

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

See the code

allowsMultipleAnswers boolean

*true*, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to false

See the code

businessConnectionId string

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

See the code

closeDate Date

Point in time 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

See the code

correctOptionId number

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

See the code

disableNotification boolean

Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.

See the code

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

See the code

explanationEntities

List of special entities that appear in the poll explanation, which can be specified instead of parseMode

See the code

explanationParseMode ParseMode

Mode for parsing entities in the explanation

See the code

forumTopicId number

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

See the code

isAnonymous boolean

*true*, if the poll needs to be anonymous, defaults to *true*

See the code

isClosed boolean

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

See the code

openPeriod number

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

See the code

protectContent boolean

Protects the contents of the sent message from forwarding and saving

See the code

replyMarkup

Additional export 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.

See the code

replyToMessageId number

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

See the code

type PollType

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

See the code