Send-TelegramURLAnimation¶

SYNOPSIS¶

Sends Telegram animation message via Bot API from URL sourced animation image

SYNTAX¶

Send-TelegramURLAnimation [-BotToken] <String> [-ChatID] <String> [-AnimationURL] <String>
 [[-Caption] <String>] [[-ParseMode] <String>] [-DisableNotification] [-ProtectContent] [<CommonParameters>]

DESCRIPTION¶

Uses Telegram Bot API to send animation message to specified Telegram chat. The animation will be sourced from the provided URL and sent to Telegram. Several options can be specified to adjust message parameters.

EXAMPLES¶

EXAMPLE 1¶

$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$animationURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/jean.gif'
Send-TelegramURLAnimation -BotToken $botToken -ChatID $chatID -AnimationURL $animationURL

Sends animation message via Telegram API

EXAMPLE 2¶

$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$animationURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/jean.gif'
$sendTelegramURLAnimationSplat = @{
    BotToken            = $botToken
    ChatID              = $chatID
    AnimationURL        = $animationURL
    Caption             = 'Live long, and prosper.'
    DisableNotification = $true
    ProtectContent      = $true
    Verbose             = $true
}
Send-TelegramURLAnimation @sendTelegramURLAnimationSplat

Sends animation message via Telegram API

EXAMPLE 3¶

$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$animationURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/jean.gif'
$sendTelegramURLAnimationSplat = @{
    BotToken            = $botToken
    ChatID              = $chatID
    AnimationURL        = $animationURL
    Caption             = 'Live __long__, and prosper\.'
    ParseMode           = 'MarkdownV2'
}
Send-TelegramURLAnimation @sendTelegramURLAnimationSplat

Sends animation 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

-AnimationURL¶

URL path to animation

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
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: 4
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: 5
Default value: HTML
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/

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-TelegramURLAnimation

https://core.telegram.org/bots/api#sendanimation

https://core.telegram.org/bots/api#html-style

https://core.telegram.org/bots/api#markdownv2-style

https://core.telegram.org/bots/api#markdown-style

https://core.telegram.org/bots/api