Send-TelegramLocalVideo¶
SYNOPSIS¶
Sends Telegram video message via Bot API from locally sourced file
SYNTAX¶
Send-TelegramLocalVideo [-BotToken] <String> [-ChatID] <String> [-Video] <String> [[-Duration] <Int32>]
[[-Width] <Int32>] [[-Height] <Int32>] [[-FileName] <String>] [[-Caption] <String>] [[-ParseMode] <String>]
[-HasSpoiler] [-Streaming] [-DisableNotification] [-ProtectContent] [<CommonParameters>]
DESCRIPTION¶
Uses Telegram Bot API to send video message to specified Telegram chat. The video will be sourced from the local device and uploaded to telegram. Several options can be specified to adjust message parameters. Telegram only supports mp4 videos.
EXAMPLES¶
EXAMPLE 1¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$file = 'C:\videos\video.mp4'
Send-TelegramLocalVideo -BotToken $botToken -ChatID $chatID -Video $video
Sends video message via Telegram API
EXAMPLE 2¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$video = 'C:\videos\video.mp4'
$sendTelegramLocalVideoSplat = @{
BotToken = $botToken
ChatID = $chatID
Video = $video
Duration = 10
Width = 250
Height = 250
FileName = 'video.mp4'
Caption = 'Check out this video'
ParseMode = 'MarkdownV2'
HasSpoiler = $true
Streaming = $true
DisableNotification = $true
ProtectContent = $true
Verbose = $true
}
Send-TelegramLocalVideo @sendTelegramLocalVideoSplat
Sends video message via Telegram API
EXAMPLE 3¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$video = 'C:\videos\video.mp4'
$sendTelegramLocalVideoSplat = @{
BotToken = $botToken
ChatID = $chatID
Video = $video
Streaming = $true
FileName = 'video.mp4'
Caption = 'Check out this __awesome__ video\.'
ParseMode = 'MarkdownV2'
}
Send-TelegramLocalVideo @sendTelegramLocalVideoSplat
Sends video message via Telegram API with properly formatted underlined word and escaped special character.
PARAMETERS¶
-BotToken¶
Use this token to access the HTTP API
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ChatID¶
Unique identifier for the target chat
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Video¶
Local path to video file
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Duration¶
Duration of sent video in seconds
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Width¶
Video width
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Height¶
Video height
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FileName¶
Original File Name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Caption¶
Brief title or explanation for media
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ParseMode¶
Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. Default is HTML.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: False
-HasSpoiler¶
Video needs to be covered with a spoiler animation
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Streaming¶
Use if the uploaded video is suitable for streaming
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DisableNotification¶
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
-ProtectContent¶
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
CommonParameters¶
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).
INPUTS¶
OUTPUTS¶
System.Management.Automation.PSCustomObject¶
NOTES¶
Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
Telegram clients support mp4 videos (other formats may be sent as Document) Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
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/
RELATED LINKS¶
https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalVideo
https://core.telegram.org/bots/api#sendvideo
https://core.telegram.org/bots/api#html-style
https://core.telegram.org/bots/api#markdownv2-style