external help file | Module Name | online version | schema |
---|---|---|---|
PoshGram-help.xml |
PoshGram |
2.0.0 |
Sends Telegram native poll.
Send-TelegramPoll -BotToken <String> -ChatID <String> -Question <String> -Options <String[]>
[-IsAnonymous <Boolean>] [-PollType <String>] [-MultipleAnswers <Boolean>] [-QuizAnswer <Int32>]
[-Explanation <String>] [-ExplanationParseMode <String>] [-DisableNotification] [-ProtectContent]
[<CommonParameters>]
Send-TelegramPoll -BotToken <String> -ChatID <String> -Question <String> -Options <String[]>
[-IsAnonymous <Boolean>] [-PollType <String>] [-MultipleAnswers <Boolean>] [-QuizAnswer <Int32>]
[-Explanation <String>] [-ExplanationParseMode <String>] [-OpenPeriod <Int32>] [-DisableNotification]
[-ProtectContent] [<CommonParameters>]
Send-TelegramPoll -BotToken <String> -ChatID <String> -Question <String> -Options <String[]>
[-IsAnonymous <Boolean>] [-PollType <String>] [-MultipleAnswers <Boolean>] [-QuizAnswer <Int32>]
[-Explanation <String>] [-ExplanationParseMode <String>] [-CloseDate <DateTime>] [-DisableNotification]
[-ProtectContent] [<CommonParameters>]
Uses Telegram Bot API to send a native poll with a question and several answer options.
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$question = 'What is your favorite Star Trek series?'
$opt = @(
'Star Trek: The Original Series',
'Star Trek: The Next Generation',
'Star Trek: Deep Space Nine',
'Star Trek: Voyager',
'Star Trek: Enterprise',
'Star Trek: Discovery',
'Star Trek: Picard',
'Star Trek: Lower Decks'
'Star Trek: Prodigy'
'Star Trek: Strange New Worlds'
)
Send-TelegramPoll -BotToken $botToken -ChatID $chatID -Question $question -Options $opt
Sends poll via Telegram API
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$question = 'Who is your favorite Star Fleet Captain?'
$opt = 'Jean-Luc Picard','Jean-Luc Picard','Jean-Luc Picard'
$sendTelegramPollSplat = @{
BotToken = $token
ChatID = $chatID
Question = $question
Options = $opt
DisableNotification = $true
ProtectContent = $true
IsAnonymous = $true
PollType = 'regular'
MultipleAnswers = $false
}
Send-TelegramPoll @sendTelegramPollSplat
Sends poll via Telegram API
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$question = 'Who was the best Starfleet captain?'
$opt = @(
'James Kirk',
'Jean-Luc Picard',
'Benjamin Sisko',
'Kathryn Janeway',
'Jonathan Archer'
'Michael Burnham'
'Carol Freeman'
'Christopher Pike'
)
$answer = 1
$sendTelegramPollSplat = @{
BotToken = $botToken
ChatID = $chatID
Question = $question
Options = $opt
IsAnonymous = $false
PollType = 'quiz'
QuizAnswer = $answer
}
Send-TelegramPoll @sendTelegramPollSplat
Sends quiz via Telegram API
$question = 'Which class is the largest starship constructed by Starfleet?'
$opt = @(
'Constitution class',
'Intrepid class',
'California class',
'Galaxy class',
'Invincible class',
'Sovereign class',
'Excelsior class',
'Miranda class',
'Nebula class',
'Olympic class'
)
$explanation = 'At 1,607.2 meters in length, 764.4 meters across, and 305.76 meters high, Invincible class is the largest starship class ever built by Starfleet.'
$answer = 4
$sendTelegramPollSplat = @{
BotToken = $botToken
ChatID = $chatID
Question = $question
Options = $opt
Explanation = $explanation
IsAnonymous = $false
PollType = 'quiz'
QuizAnswer = $answer
}
Send-TelegramPoll @sendTelegramPollSplat
Sends quiz via Telegram API with answer explanation.
$question = 'Which Star Trek captain has an artificial heart?'
$opt = @(
'James Kirk',
'Jean-Luc Picard',
'Benjamin Sisko',
'Kathryn Janeway',
'Jonathan Archer'
)
$explanation = 'In _2327_, Jean\-Luc Picard received an *artificial heart* after he was stabbed by a Nausicaan during a bar brawl\.'
$answer = 1
$sendTelegramPollSplat = @{
BotToken = $token
ChatID = $chatID
Question = $question
Options = $opt
Explanation = $explanation
ExplanationParseMode = 'MarkdownV2'
IsAnonymous = $false
PollType = 'quiz'
QuizAnswer = $answer
CloseDate = (Get-Date).AddDays(1)
}
Send-TelegramPoll @sendTelegramPollSplat
Sends quiz via Telegram API with answer explanation properly formatted in MarkdownV2. Quiz will be open for 24 hours (1 day).
Use this token to access the HTTP API
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Unique identifier for the target chat
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Poll question
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
String array of answer options
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
True, if the poll needs to be anonymous, defaults to True
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
Poll type, "quiz" or "regular", defaults to "regular"
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Regular
Accept pipeline input: False
Accept wildcard characters: False
True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
0-based identifier of the correct answer option, required for polls in quiz mode
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
HTML vs Markdown for explanation formatting - HTML by default - https://core.telegram.org/bots/api#formatting-options
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: False
Amount of time in seconds the poll will be active after creation, 5-600.
Type: Int32
Parameter Sets: OpenPeriod
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
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.
Type: DateTime
Parameter Sets: OpenDate
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Send the message silently. Users will receive a notification with no sound.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Protects the contents of the sent message from forwarding and saving
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
Questions on how to set up a bot, get a token, or get your channel ID? Answers on the PoshGram documentation: https://poshgram.readthedocs.io/en/latest/PoshGram-FAQ/
Telegram currently supports questions 1-300 characters Telegram currently supports 2-10 options 1-100 characters each
Quiz answers are 0-based. If the first answer is correct, the answer is 0. If the second answer is correct, the answer is 1, etc.
https://poshgram.readthedocs.io/en/latest/Send-TelegramPoll