Send-TelegramSticker¶
SYNOPSIS¶
Sends Telegram sticker message via Bot API by file_id or sticker pack emoji.
SYNTAX¶
FileEmojiG¶
Send-TelegramSticker [-BotToken <String>] [-ChatID <String>] [-StickerSetName <String>] [-ShortCode <String>]
[-DisableNotification] [-ProtectContent] [<CommonParameters>]
FileIDG¶
Send-TelegramSticker [-BotToken <String>] [-ChatID <String>] [-FileID <String>] [-DisableNotification]
[-ProtectContent] [<CommonParameters>]
ByFileID¶
Send-TelegramSticker -BotToken <String> -ChatID <String> -FileID <String> [-DisableNotification]
[-ProtectContent] [<CommonParameters>]
BySPShortCode¶
Send-TelegramSticker -BotToken <String> -ChatID <String> -StickerSetName <String> -ShortCode <String>
[-DisableNotification] [-ProtectContent] [<CommonParameters>]
DESCRIPTION¶
Uses Telegram Bot API to send sticker message to specified Telegram chat. The file_id can be specified if you know it. Use Get-TelegramStickerPackInfo if you do not already know the file_id of the sticker. Alternatively you can specify the sticker pack name and an emoji shortcode. This function will make an attempt to find the sticker that corresponds with the specified emoji. See notes for details.
EXAMPLES¶
EXAMPLE 1¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$sticker = 'CAADAgADwQADECECEGEtCrI_kALvFgQ'
Send-TelegramSticker -BotToken $botToken -ChatID $chatID -FileID $sticker
Sends sticker message via Telegram API
EXAMPLE 2¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$sticker = 'CAADAgADwQADECECEGEtCrI_kALvFgQ'
$sendTelegramStickerSplat = @{
BotToken = $botToken
ChatID = $chatID
FileID = $sticker
DisableNotification = $true
ProtectContent = $true
Verbose = $true
}
Send-TelegramSticker @sendTelegramStickerSplat
Sends sticker message via Telegram API
EXAMPLE 3¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
Send-TelegramSticker -BotToken $botToken -ChatID $chatID -StickerSetName STPicard -Shortcode ':slightly_smiling_face:'
Sends sticker message via Telegram API
EXAMPLE 4¶
$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx'
$chatID = '-nnnnnnnnn'
$sendTelegramStickerSplat = @{
BotToken = $botToken
ChatID = $chatID
StickerSetName = 'STPicard'
Shortcode = ':slightly_smiling_face:'
DisableNotification = $true
ProtectContent = $true
Verbose = $true
}
Send-TelegramSticker @sendTelegramStickerSplat
Sends sticker message via Telegram API
PARAMETERS¶
-BotToken¶
Use this token to access the HTTP API
Type: String
Parameter Sets: FileEmojiG, FileIDG
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: ByFileID, BySPShortCode
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ChatID¶
Unique identifier for the target chat
Type: String
Parameter Sets: FileEmojiG, FileIDG
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: ByFileID, BySPShortCode
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileID¶
Telegram sticker file_id If you do not know the file ID of a sticker, you can use Get-TelegramStickerPackInfo to determine it.
Type: String
Parameter Sets: FileIDG
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: ByFileID
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StickerSetName¶
Name of the sticker set
Type: String
Parameter Sets: FileEmojiG
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: BySPShortCode
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ShortCode¶
Specifies the shortcode of the emoji to retrieve.
Type: String
Parameter Sets: FileEmojiG
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: BySPShortCode
Aliases:
Required: True
Position: Named
Default value: None
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/
Sticker packs are controlled by their author Not every sticker has a corresponding emoji Some sticker authors have the same emoji linked to multiple stickers This function will make a best attempt to look up the sticker pack you specify and send a sticker that matches the corresponding emoji shortcode.
RELATED LINKS¶
https://poshgram.readthedocs.io/en/latest/Send-TelegramSticker