external help file | Module Name | online version | schema |
---|---|---|---|
PoshGram-help.xml |
PoshGram |
2.0.0 |
Sends Telegram audio message via Bot API from locally sourced file
Send-TelegramLocalAudio [-BotToken] <String> [-ChatID] <String> [-Audio] <String> [[-Caption] <String>]
[[-ParseMode] <String>] [[-Duration] <Int32>] [[-Performer] <String>] [[-Title] <String>]
[[-FileName] <String>] [-DisableNotification] [-ProtectContent] [<CommonParameters>]
Uses Telegram Bot API to send audio message to specified Telegram chat. The audio will be sourced from the local device and uploaded to telegram. Several options can be specified to adjust message parameters. Telegram only supports mp3 audio.
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$audio = 'C:\audio\halo_on_fire.mp3'
Send-TelegramLocalAudio -BotToken $botToken -ChatID $chatID -Audio $audio
Sends audio message via Telegram API
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$audio = 'C:\audio\halo_on_fire.mp3'
$sendTelegramLocalAudioSplat = @{
BotToken = $botToken
ChatID = $chatID
Audio = $audio
Caption = 'Check out this audio track'
ParseMode = 'MarkdownV2'
Duration = 495
Performer = 'Metallica'
Title = 'Halo On Fire'
FileName = 'halo_on_fire.mp3'
DisableNotification = $true
ProtectContent = $true
Verbose = $true
}
Send-TelegramLocalAudio @sendTelegramLocalAudioSplat
Sends audio message via Telegram API
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$audio = 'C:\audio\halo_on_fire.mp3'
$sendTelegramLocalAudioSplat = @{
BotToken = $botToken
ChatID = $chatID
Audio = $audio
Performer = 'Metallica'
Title = 'Halo On Fire'
FileName = 'halo_on_fire.mp3'
Caption = 'Check out this __awesome__ audio track\.'
ParseMode = 'MarkdownV2'
}
Send-TelegramLocalAudio @sendTelegramLocalAudioSplat
Sends audio message via Telegram API with properly formatted underlined word and escaped special character.
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
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
Local path to audio file
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Brief title or explanation for media
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: 5
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: False
Duration of the audio in seconds
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Performer
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Track Name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Original File Name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
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/
Your audio must be in the .mp3 format. Bots can currently send audio 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/
https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalAudio
https://core.telegram.org/bots/api#sendaudio
https://core.telegram.org/bots/api#html-style
https://core.telegram.org/bots/api#markdownv2-style