en-US/PoshGram-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TelegramCustomEmojiStickerInfo</command:name> <command:verb>Get</command:verb> <command:noun>TelegramCustomEmojiStickerInfo</command:noun> <maml:description> <maml:para>Retrieve information about Telegram custom emoji stickers using their identifiers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function interacts with the Telegram Bot API to gather detailed information about custom emoji stickers specified by their unique identifiers. It can handle requests for up to 200 custom emoji IDs at a time</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TelegramCustomEmojiStickerInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>CustomEmojiIdentifier</maml:name> <maml:Description> <maml:para>Custom emoji ID number(s). Specify up to 200 custom emoji IDs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>CustomEmojiIdentifier</maml:name> <maml:Description> <maml:para>Custom emoji ID number(s). Specify up to 200 custom emoji IDs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> <maml:para>Note: - This function is currently experimental. Bots can only access custom emoji sticker information for purchased additional usernames on Fragment. - This makes it difficult to determine the custom emoji ID for a custom emoji sticker pack. - pwshEmojiExplorer is used to retrieve additional emoji information.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' Get-TelegramCustomEmojiStickerInfo -BotToken $botToken -CustomEmojiIdentifier 5404870433939922908</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the custom emoji sticker with identifier 5404870433939922908.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' Get-TelegramCustomEmojiStickerInfo -BotToken $botToken -CustomEmojiIdentifier 5404870433939922908, 5368324170671202286</dev:code> <dev:remarks> <maml:para>Fetches information for multiple custom emoji stickers, using their respective identifiers 5404870433939922908 and 5368324170671202286.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Get-TelegramCustomEmojiStickerInfo</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Get-TelegramCustomEmojiStickerInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/doctesting/PoshGram-Sticker-Info/</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/doctesting/PoshGram-Sticker-Info/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#getcustomemojistickers</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#getcustomemojistickers</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sticker</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TelegramStickerPackInfo</command:name> <command:verb>Get</command:verb> <command:noun>TelegramStickerPackInfo</command:noun> <maml:description> <maml:para>Retrieve detailed information about a specified Telegram sticker pack.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function connects to the Telegram Bot API to fetch detailed information about a specified sticker pack. It is designed to help you explore the contents of a Telegram sticker pack by providing a variety of information for each sticker. This includes details like the associated emoji, its group and subgroup classifications, Unicode code, shortcode, and the sticker's file ID. It also leverages the capabilities of pwshEmojiExplorer to retrieve additional emoji information, enriching the data set provided. To effectively use this function, you need the name of the sticker pack. You can find this by sharing the sticker pack within the Telegram app, which will generate a link containing the pack's name. More information is available in the links.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TelegramStickerPackInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StickerSetName</maml:name> <maml:Description> <maml:para>Name of the sticker set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StickerSetName</maml:name> <maml:Description> <maml:para>Name of the sticker set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> <maml:para>Note: - Some sticker authors use the same emoji for several of their stickers. - pwshEmojiExplorer is used to retrieve additional emoji information.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' Get-TelegramStickerPackInfo -BotToken $botToken -StickerSetName STPicard</dev:code> <dev:remarks> <maml:para>Retrieves information for the STPicard sticker pack from the Telegram Bot API.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' Get-TelegramStickerPackInfo -BotToken $botToken -StickerSetName FriendlyFelines</dev:code> <dev:remarks> <maml:para>Retrieves information for the FriendlyFelines sticker pack from the Telegram Bot API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Get-TelegramStickerPackInfo</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Get-TelegramStickerPackInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/doctesting/PoshGram-Sticker-Info/</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/doctesting/PoshGram-Sticker-Info/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#getstickerset</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#getstickerset</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sticker</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramContact</command:name> <command:verb>Send</command:verb> <command:noun>TelegramContact</command:noun> <maml:description> <maml:para>Sends Telegram phone contact message via BOT API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send contact information to specified Telegram chat.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramContact</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhoneNumber</maml:name> <maml:Description> <maml:para>Contact phone number</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FirstName</maml:name> <maml:Description> <maml:para>Contact first name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LastName</maml:name> <maml:Description> <maml:para>Contact last name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhoneNumber</maml:name> <maml:Description> <maml:para>Contact phone number</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FirstName</maml:name> <maml:Description> <maml:para>Contact first name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LastName</maml:name> <maml:Description> <maml:para>Contact last name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $phone = '1-222-222-2222' $firstName = 'Jean-Luc' Send-TelegramContact -BotToken $botToken -ChatID $chatID -PhoneNumber $phone -FirstName $firstName</dev:code> <dev:remarks> <maml:para>Sends contact via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $phone = '1-222-222-2222' $firstName = 'Jean-Luc' $lastName = 'Picard' $sendTelegramContactSplat = @{ BotToken = $botToken ChatID = $chatID PhoneNumber = $phone FirstName = $firstName LastName = $lastName DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramContact @sendTelegramContactSplat</dev:code> <dev:remarks> <maml:para>Sends contact via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramContact</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramContact</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendcontact</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendcontact</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramDice</command:name> <command:verb>Send</command:verb> <command:noun>TelegramDice</command:noun> <maml:description> <maml:para>Sends Telegram animated emoji that will display a random value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send animated emoji that will display a random value to specified Telegram chat.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramDice</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Emoji</maml:name> <maml:Description> <maml:para>Emoji on which the dice throw animation is based.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Emoji</maml:name> <maml:Description> <maml:para>Emoji on which the dice throw animation is based.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $emoji = 'basketball' Send-TelegramDice -BotToken $botToken -ChatID $chatID -Emoji $emoji</dev:code> <dev:remarks> <maml:para>Sends animated basketball emoji that displays a random value via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $emoji = 'dice' $sendTelegramDiceSplat = @{ BotToken = $botToken ChatID = $chatID DisableNotification = $true ProtectContent = $true Verbose = $true Emoji = $emoji } Send-TelegramDice @sendTelegramDiceSplat</dev:code> <dev:remarks> <maml:para>Sends animated dice emoji that displays a random value via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramDice</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramDice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#senddice</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#senddice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalAnimation</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalAnimation</command:noun> <maml:description> <maml:para>Sends Telegram animation message via Bot API from locally sourced animation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send animation message to specified Telegram chat. The animation will be sourced from the local device and uploaded to telegram. Several options can be specified to adjust message parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalAnimation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationPath</maml:name> <maml:Description> <maml:para>File path to local image</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Animation needs to be covered with a spoiler animation</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationPath</maml:name> <maml:Description> <maml:para>File path to local image</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Animation needs to be covered with a spoiler animation</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>The following animation types are supported: GIF</maml:para> <maml:para>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/</maml:para> <maml:para>Get creative by sending Gifs with your bot!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $animation = 'C:\animation\animation.gif' Send-TelegramLocalAnimation -BotToken $botToken -ChatID $chatID -AnimationPath $animation</dev:code> <dev:remarks> <maml:para>Sends AnimationPath message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $animation = 'C:\animation\animation.gif' $sendTelegramLocalAnimationSplat = @{ BotToken = $botToken ChatID = $chatID AnimationPath = $animation Caption = 'Check out this animation' ParseMode = 'MarkdownV2' HasSpoiler = $true DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramLocalAnimation @sendTelegramLocalAnimationSplat</dev:code> <dev:remarks> <maml:para>Sends animation message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $animation = 'C:\animation\animation.gif' $sendTelegramLocalAnimationSplat = @{ BotToken = $botToken ChatID = $chatID AnimationPath = $animation Caption = 'Check out this __awesome__ animation\.' ParseMode = 'MarkdownV2' } Send-TelegramLocalAnimation @sendTelegramLocalAnimationSplat</dev:code> <dev:remarks> <maml:para>Sends animation message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalAnimation</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalAnimation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendanimation</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendanimation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalAudio</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalAudio</command:noun> <maml:description> <maml:para>Sends Telegram audio message via Bot API from locally sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalAudio</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Audio</maml:name> <maml:Description> <maml:para>Local path to audio file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of the audio in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Performer</maml:name> <maml:Description> <maml:para>Performer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Track Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Audio</maml:name> <maml:Description> <maml:para>Local path to audio file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of the audio in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Performer</maml:name> <maml:Description> <maml:para>Performer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Track Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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.</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $audio = 'C:\audio\halo_on_fire.mp3' Send-TelegramLocalAudio -BotToken $botToken -ChatID $chatID -Audio $audio</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalAudio</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalAudio</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendaudio</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendaudio</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalDocument</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalDocument</command:noun> <maml:description> <maml:para>Sends Telegram document message via Bot API from locally sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send document message to specified Telegram chat. The document will be sourced from the local device and uploaded to Telegram. Several options can be specified to adjust message parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>Local path to file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableContentTypeDetection</maml:name> <maml:Description> <maml:para>set to HTML by default</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>Local path to file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableContentTypeDetection</maml:name> <maml:Description> <maml:para>set to HTML by default</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>Bots can currently send files of up to 50 MB in size, this limit may be changed in the future.</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $file = 'C:\Logs\Log1.txt' Send-TelegramLocalDocument -BotToken $botToken -ChatID $chatID -File $file</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $file = 'C:\Logs\Log1.txt' $sendTelegramLocalDocumentSplat = @{ BotToken = $botToken ChatID = $chatID File = $file Caption = 'Check out this file' ParseMode = 'MarkdownV2' DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramLocalDocument @sendTelegramLocalDocumentSplat</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $file = 'C:\Logs\Log1.txt' $sendTelegramLocalDocumentSplat = @{ BotToken = $botToken ChatID = $chatID File = $file Caption = 'Check out this __important__ file\.' ParseMode = 'MarkdownV2' } Send-TelegramLocalDocument @sendTelegramLocalDocumentSplat</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalDocument</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalDocument</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#senddocument</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#senddocument</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalPhoto</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalPhoto</command:noun> <maml:description> <maml:para>Sends Telegram photo message via Bot API from locally sourced photo image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send photo message to specified Telegram chat. The photo will be sourced from the local device and uploaded to telegram. Several options can be specified to adjust message parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalPhoto</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhotoPath</maml:name> <maml:Description> <maml:para>File path to local image</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Photo needs to be covered with a spoiler animation</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhotoPath</maml:name> <maml:Description> <maml:para>File path to local image</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Photo needs to be covered with a spoiler animation</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>The following photo types are supported: JPG, JPEG, PNG, GIF, BMP, WEBP, SVG, TIFF</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photo = 'C:\photos\aphoto.jpg' Send-TelegramLocalPhoto -BotToken $botToken -ChatID $chatID -PhotoPath $photo</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photo = 'C:\photos\aphoto.jpg' $sendTelegramLocalPhotoSplat = @{ BotToken = $botToken ChatID = $chatID PhotoPath = $photo Caption = 'Check out this photo' ParseMode = 'MarkdownV2' HasSpoiler = $true DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramLocalPhoto @sendTelegramLocalPhotoSplat</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photo = 'C:\photos\aphoto.jpg' $sendTelegramLocalPhotoSplat = @{ BotToken = $botToken ChatID = $chatID PhotoPath = $photo Caption = 'Check out this __awesome__ photo\.' ParseMode = 'MarkdownV2' } Send-TelegramLocalPhoto @sendTelegramLocalPhotoSplat</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalPhoto</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalPhoto</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendphoto</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendphoto</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalSticker</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalSticker</command:noun> <maml:description> <maml:para>Sends Telegram sticker message via Bot API from locally sourced sticker image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send sticker message to specified Telegram chat. The sticker will be sourced from the local device and uploaded to telegram.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalSticker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StickerPath</maml:name> <maml:Description> <maml:para>File path to the sticker you wish to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Emoji</maml:name> <maml:Description> <maml:para>Emoji associated with the sticker</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StickerPath</maml:name> <maml:Description> <maml:para>File path to the sticker you wish to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Emoji</maml:name> <maml:Description> <maml:para>Emoji associated with the sticker</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>The following sticker types are supported: WEBP, TGS, WEBM</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sticker = 'C:\stickers\sticker.webp' Send-TelegramLocalSticker -BotToken $botToken -ChatID $chatID -StickerPath $sticker</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sticker = 'C:\stickers\sticker.webp' $sendTelegramLocalStickerSplat = @{ BotToken = $botToken ChatID = $chatID StickerPath = $sticker Emoji = '😀' DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramLocalSticker @sendTelegramLocalStickerSplat</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalSticker</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalSticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendsticker</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendsticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocalVideo</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocalVideo</command:noun> <maml:description> <maml:para>Sends Telegram video message via Bot API from locally sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocalVideo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Video</maml:name> <maml:Description> <maml:para>Local path to video file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of sent video in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Video width</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Video height</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Video needs to be covered with a spoiler animation</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Streaming</maml:name> <maml:Description> <maml:para>Use if the uploaded video is suitable for streaming</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Video</maml:name> <maml:Description> <maml:para>Local path to video file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of sent video in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Video width</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Video height</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasSpoiler</maml:name> <maml:Description> <maml:para>Video needs to be covered with a spoiler animation</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Streaming</maml:name> <maml:Description> <maml:para>Use if the uploaded video is suitable for streaming</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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.</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $file = 'C:\videos\video.mp4' Send-TelegramLocalVideo -BotToken $botToken -ChatID $chatID -Video $video</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalVideo</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocalVideo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendvideo</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendvideo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramLocation</command:name> <command:verb>Send</command:verb> <command:noun>TelegramLocation</command:noun> <maml:description> <maml:para>Sends Telegram location to indicate point on map</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send latitude and longitude points on map to specified Telegram chat.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramLocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $latitude = 37.621313 $longitude = -122.378955 Send-TelegramLocation -BotToken $botToken -ChatID $chatID -Latitude $latitude -Longitude $longitude</dev:code> <dev:remarks> <maml:para>Sends location via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sendTelegramLocationSplat = @{ BotToken = $botToken ChatID = $chatID Latitude = $latitude Longitude = $longitude DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramLocation @sendTelegramLocationSplat</dev:code> <dev:remarks> <maml:para>Sends location via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocation</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramLocation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendlocation</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendlocation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramMediaGroup</command:name> <command:verb>Send</command:verb> <command:noun>TelegramMediaGroup</command:noun> <maml:description> <maml:para>Sends Telegram a group of photos, videos, documents, or audios as an album via Bot API from locally sourced media</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send a group of photos, videos, documents, or audios as an album message to specified Telegram chat. The media will be sourced from the local device and uploaded to telegram. This function only supports sending one media type per send (Photo | Video | Documents | Audio). 2 files minimum and 10 files maximum are required for this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramMediaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MediaType</maml:name> <maml:Description> <maml:para>Type of media to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FilePaths</maml:name> <maml:Description> <maml:para>List of filepaths for media you want to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MediaType</maml:name> <maml:Description> <maml:para>Type of media to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FilePaths</maml:name> <maml:Description> <maml:para>List of filepaths for media you want to send</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/ This works with PowerShell Version: 6.1+</maml:para> <maml:para>The following photo types are supported: JPG, JPEG, PNG, GIF, BMP, WEBP, SVG, TIFF</maml:para> <maml:para>The following video types are supported: Telegram clients support mp4 videos</maml:para> <maml:para>The following audio types are supported: MP3, M4A</maml:para> <maml:para>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/</maml:para> <maml:para>? This was really hard to make.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sendTelegramMediaGroupSplat = @{ BotToken = $botToken ChatID = $chatID MediaType = 'Photo' FilePaths = 'C:\photo\photo1.jpg', 'C:\photo\photo2.jpg' } Send-TelegramMediaGroup @sendTelegramMediaGroupSplat</dev:code> <dev:remarks> <maml:para>Uploads all provided photo files as album via Telegram Bot API.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sendTelegramMediaGroupSplat = @{ BotToken = $botToken ChatID = $chatID MediaType = 'Photo' FilePaths = (Get-ChildItem C:\PhotoGroup | Select-Object -ExpandProperty FullName) } Send-TelegramMediaGroup @sendTelegramMediaGroupSplat</dev:code> <dev:remarks> <maml:para>Retrieves all photo file paths from C:\PhotoGroup and uploads as photo album. Keep in mind that your location must have at least 2, but not more than 10 files.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $vPath = 'C:\VideoGroup' $vFiles = @( "$vPath\first_contact.mp4", "$vPath\root_beer.mp4" ) $sendTelegramMediaGroupSplat = @{ BotToken = $botToken ChatID = $chatID MediaType = 'Video' FilePaths = $vFiles DisableNotification = $true ProtectContent = $true } Send-TelegramMediaGroup @sendTelegramMediaGroupSplat</dev:code> <dev:remarks> <maml:para>Uploads all provided video files as album via Telegram Bot API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramMediaGroup</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramMediaGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendmediagroup</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendmediagroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramPoll</command:name> <command:verb>Send</command:verb> <command:noun>TelegramPoll</command:noun> <maml:description> <maml:para>Sends Telegram native poll.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send a native poll with a question and several answer options.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramPoll</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Question</maml:name> <maml:Description> <maml:para>Poll question</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>String array of answer options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsAnonymous</maml:name> <maml:Description> <maml:para>True, if the poll needs to be anonymous, defaults to True</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PollType</maml:name> <maml:Description> <maml:para>Poll type, "quiz" or "regular", defaults to "regular"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Regular</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MultipleAnswers</maml:name> <maml:Description> <maml:para>True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuizAnswer</maml:name> <maml:Description> <maml:para>0-based identifier of the correct answer option, required for polls in quiz mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Explanation</maml:name> <maml:Description> <maml:para>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</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExplanationParseMode</maml:name> <maml:Description> <maml:para>HTML vs Markdown for explanation formatting - HTML by default - https://core.telegram.org/bots/api#formatting-options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenPeriod</maml:name> <maml:Description> <maml:para>Amount of time in seconds the poll will be active after creation, 5-600.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-TelegramPoll</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Question</maml:name> <maml:Description> <maml:para>Poll question</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>String array of answer options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsAnonymous</maml:name> <maml:Description> <maml:para>True, if the poll needs to be anonymous, defaults to True</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PollType</maml:name> <maml:Description> <maml:para>Poll type, "quiz" or "regular", defaults to "regular"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Regular</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MultipleAnswers</maml:name> <maml:Description> <maml:para>True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuizAnswer</maml:name> <maml:Description> <maml:para>0-based identifier of the correct answer option, required for polls in quiz mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Explanation</maml:name> <maml:Description> <maml:para>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</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExplanationParseMode</maml:name> <maml:Description> <maml:para>HTML vs Markdown for explanation formatting - HTML by default - https://core.telegram.org/bots/api#formatting-options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseDate</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Question</maml:name> <maml:Description> <maml:para>Poll question</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>String array of answer options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsAnonymous</maml:name> <maml:Description> <maml:para>True, if the poll needs to be anonymous, defaults to True</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PollType</maml:name> <maml:Description> <maml:para>Poll type, "quiz" or "regular", defaults to "regular"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Regular</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MultipleAnswers</maml:name> <maml:Description> <maml:para>True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuizAnswer</maml:name> <maml:Description> <maml:para>0-based identifier of the correct answer option, required for polls in quiz mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Explanation</maml:name> <maml:Description> <maml:para>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</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExplanationParseMode</maml:name> <maml:Description> <maml:para>HTML vs Markdown for explanation formatting - HTML by default - https://core.telegram.org/bots/api#formatting-options</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OpenPeriod</maml:name> <maml:Description> <maml:para>Amount of time in seconds the poll will be active after creation, 5-600.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CloseDate</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> <maml:para>Telegram currently supports questions 1-300 characters Telegram currently supports 2-10 options 1-100 characters each</maml:para> <maml:para>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.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends poll via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends poll via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends quiz via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends quiz via Telegram API with answer explanation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends quiz via Telegram API with answer explanation properly formatted in MarkdownV2. Quiz will be open for 24 hours (1 day).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramPoll</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramPoll</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendpoll</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendpoll</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramSticker</command:name> <command:verb>Send</command:verb> <command:noun>TelegramSticker</command:noun> <maml:description> <maml:para>Sends Telegram sticker message via Bot API by file_id or sticker pack emoji.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramSticker</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StickerSetName</maml:name> <maml:Description> <maml:para>Name of the sticker set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShortCode</maml:name> <maml:Description> <maml:para>Specifies the shortcode of the emoji to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-TelegramSticker</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileID</maml:name> <maml:Description> <maml:para>Telegram sticker file_id If you do not know the file ID of a sticker, you can use Get-TelegramStickerPackInfo to determine it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-TelegramSticker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileID</maml:name> <maml:Description> <maml:para>Telegram sticker file_id If you do not know the file ID of a sticker, you can use Get-TelegramStickerPackInfo to determine it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-TelegramSticker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StickerSetName</maml:name> <maml:Description> <maml:para>Name of the sticker set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShortCode</maml:name> <maml:Description> <maml:para>Specifies the shortcode of the emoji to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileID</maml:name> <maml:Description> <maml:para>Telegram sticker file_id If you do not know the file ID of a sticker, you can use Get-TelegramStickerPackInfo to determine it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StickerSetName</maml:name> <maml:Description> <maml:para>Name of the sticker set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShortCode</maml:name> <maml:Description> <maml:para>Specifies the shortcode of the emoji to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> <maml:para>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.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $sticker = 'CAADAgADwQADECECEGEtCrI_kALvFgQ' Send-TelegramSticker -BotToken $botToken -ChatID $chatID -FileID $sticker</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' Send-TelegramSticker -BotToken $botToken -ChatID $chatID -StickerSetName STPicard -Shortcode ':slightly_smiling_face:'</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramSticker</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramSticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendsticker</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendsticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramTextMessage</command:name> <command:verb>Send</command:verb> <command:noun>TelegramTextMessage</command:noun> <maml:description> <maml:para>Send a text message via Telegram Bot API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends text messages to a specified Telegram chat using the Telegram Bot API. Several options can be specified to adjust message parameters, including message delivery options. Supports plain text, MarkdownV2, and HTML formats, allowing for rich text presentation. You can also incorporate custom or inline keyboards, link previews, and message protection options.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramTextMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Text of the message to be sent</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LinkPreviewURL</maml:name> <maml:Description> <maml:para>URL to use for the link preview. If empty, then the first URL found in the message text will be used. Has no effect if LinkPreviewOption is Disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>LinkPreviewOption</maml:name> <maml:Description> <maml:para>Choose how link previews are shown. Default is Disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Disabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Keyboard</maml:name> <maml:Description> <maml:para>Custom or inline keyboard object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LinkPreviewAboveText</maml:name> <maml:Description> <maml:para>Use if the link preview must be shown above the message text. Has no effect if LinkPreviewOption is Disabled.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Text of the message to be sent</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LinkPreviewURL</maml:name> <maml:Description> <maml:para>URL to use for the link preview. If empty, then the first URL found in the message text will be used. Has no effect if LinkPreviewOption is Disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>LinkPreviewOption</maml:name> <maml:Description> <maml:para>Choose how link previews are shown. Default is Disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Disabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LinkPreviewAboveText</maml:name> <maml:Description> <maml:para>Use if the link preview must be shown above the message text. Has no effect if LinkPreviewOption is Disabled.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Keyboard</maml:name> <maml:Description> <maml:para>Custom or inline keyboard object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> <maml:para>Markdown Style: This is a legacy mode, retained for backward compatibility. When using Markdown/Markdownv2 you must properly escape characters. Certain characters in Telegram must be escaped with the preceding character '\' - see examples.</maml:para> <maml:para>See https://core.telegram.org/bots/api#inlinekeyboardbutton for additional details for forming inline keyboards. See https://core.telegram.org/bots/api#replykeyboardmarkup for additional details for forming custom keyboards.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' Send-TelegramTextMessage -BotToken $botToken -ChatID $chatID -Message "Hello"</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram Bot API.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $message = 'This is how to use: <b>bold</b>, <i>italic</i>, <u>underline</u>, <s>strikethrough</s>, <tg-spoiler>spoiler</tg-spoiler>, <a href="http://www.example.com/">inline URL</a>, <code>inline fixed-width code</code>, <pre>pre-formatted fixed-width code block</pre>, <pre><code class="language-powershell">#pre-formatted fixed-width code block written in the PowerShell programming language</code></pre> <blockquote>Block quotation started\nBlock quotation continued\nThe last line of the block quotation</blockquote> with default HTML formatting.' $sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = $message } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends a text message through the Telegram Bot API using HTML for text formatting. This example illustrates how to apply various HTML tags like bold, italic, underline, strikethrough, and more to create richly formatted messages.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $message = 'This is how to use: *bold*, _italic_, __underline__, ~strikethrough~, ||spoiler||, [inline URL](http://www.example.com/), `inline fixed-width code`,, >Block quotation started >Block quotation continued >The last line of the block quotation with MarkdownV2 style formatting' $sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = $message ParseMode = 'MarkdownV2' } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram API with properly formatted MarkdownV2 syntax.</maml:para> <maml:para>Sends a text message via the Telegram Bot API using MarkdownV2 syntax for text formatting. This example showcases the use of various MarkdownV2 formatting options, such as bold, italic, underline, strikethrough, and more, to create richly formatted messages.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID ParseMode = 'MarkdownV2' Message = 'This is how to escape an __underscore__ in a message: \_' } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram Bot API using MarkdownV2 syntax for text formatting. This example showcases an underlined word and a properly escaped character.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>$sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID ParseMode = 'MarkdownV2' Message = "`u{1F192} Sending emojis is cool\! `u{1F49B}" } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram Bot API using MarkdownV2 syntax for text formatting. This example showcases two properly escaped special character (!) and use of emojis.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>$inlineRow1 = @( @{ text = "`u{1F517} Visit" url = 'https://www.techthoughts.info' } ) $inlineRow2 = @( @{ text = "`u{1F4CC} Pin" url = 'https://www.techthoughts.info/learn-powershell-series/' } ) $inlineKeyboard = @{ inline_keyboard = @( $inlineRow1, $inlineRow2 ) } $sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = 'Sending an example of inline keyboard' Keyboard = $inlineKeyboard } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message with an inline keyboard right next to the message it belongs to.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>$row1 = @( @{ text = "`u{1F513} Unlock" } ) $row2 = @( @{ text = "`u{1F512} Lock" } ) $customKeyboard = @{ keyboard = @( $row1, $row2 ) one_time_keyboard = $true } $sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = 'Sending an example of a custom keyboard' Keyboard = $customKeyboard } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message with a custom keyboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>$sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = 'Sending a protected content message' ProtectContent = $true } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram Bot API and enables the 'ProtectContent' feature. When 'ProtectContent' is set to $true, it prevents the message from being forwarded or saved. This is useful for sending sensitive or confidential information that should remain within the confines of the original chat.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <dev:code>$sendTelegramTextMessageSplat = @{ BotToken = $botToken ChatID = $chatID Message = 'Sending a message with a link preview' LinkPreviewURL = 'https://www.techthoughts.info' LinkPreviewOption = 'Small' LinkPreviewAboveText = $true } Send-TelegramTextMessage @sendTelegramTextMessageSplat</dev:code> <dev:remarks> <maml:para>Sends text message via Telegram Bot API and enables the 'LinkPreview' feature. When 'LinkPreview' is set to Small, it will generate a small link preview for the provided url. When 'LinkPreviewAboveText' is set to $true, it will display the link preview above the message text.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramTextMessage/</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramTextMessage/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendmessage</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendmessage</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#inlinekeyboardbutton</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#inlinekeyboardbutton</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#replykeyboardmarkup</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#replykeyboardmarkup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLAnimation</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLAnimation</command:noun> <maml:description> <maml:para>Sends Telegram animation message via Bot API from URL sourced animation image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLAnimation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationURL</maml:name> <maml:Description> <maml:para>URL path to animation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AnimationURL</maml:name> <maml:Description> <maml:para>URL path to animation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends animation message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends animation message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$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</dev:code> <dev:remarks> <maml:para>Sends animation message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLAnimation</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLAnimation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendanimation</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendanimation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLAudio</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLAudio</command:noun> <maml:description> <maml:para>Sends Telegram audio message via Bot API from URL sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send audio message to specified Telegram chat. The file will be sourced from the provided URL and sent to Telegram. Several options can be specified to adjust message parameters. Only works for mp3 files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLAudio</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AudioURL</maml:name> <maml:Description> <maml:para>URL path to audio file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of the audio in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Performer</maml:name> <maml:Description> <maml:para>Performer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Track Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AudioURL</maml:name> <maml:Description> <maml:para>URL path to audio file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of the audio in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Performer</maml:name> <maml:Description> <maml:para>Performer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Track Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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.</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $audioURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Tobu-_-Syndec-Dusk-_NCS-Release_-YouTube.mp3' Send-TelegramURLAudio -BotToken $botToken -ChatID $chatID -AudioURL $audioURL</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $audioURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Tobu-_-Syndec-Dusk-_NCS-Release_-YouTube.mp3' $sendTelegramURLAudioSplat = @{ BotToken = $botToken ChatID = $chatID AudioURL = $audioURL 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-TelegramURLAudio @sendTelegramURLAudioSplat</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $audioURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Tobu-_-Syndec-Dusk-_NCS-Release_-YouTube.mp3' $sendTelegramURLAudioSplat = @{ BotToken = $botToken ChatID = $chatID AudioURL = $audioURL Title = 'Halo On Fire' FileName = 'halo_on_fire.mp3' Performer = 'Metallica' Caption = 'Check out this __awesome__ audio track\.' ParseMode = 'MarkdownV2' } Send-TelegramURLAudio @sendTelegramURLAudioSplat</dev:code> <dev:remarks> <maml:para>Sends audio message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLAudio</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLAudio</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendaudio</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendaudio</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLDocument</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLDocument</command:noun> <maml:description> <maml:para>Sends Telegram document message via Bot API from URL sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send document message to specified Telegram chat. The file will be sourced from the provided URL and sent to Telegram. Several options can be specified to adjust message parameters. Only works for gif, pdf and zip files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FileURL</maml:name> <maml:Description> <maml:para>URL path to file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableContentTypeDetection</maml:name> <maml:Description> <maml:para>set to HTML by default</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FileURL</maml:name> <maml:Description> <maml:para>URL path to file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableContentTypeDetection</maml:name> <maml:Description> <maml:para>set to HTML by default</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>In sendDocument, sending by URL will currently only work for gif, pdf and zip files.</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $fileURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/LogExample.zip' Send-TelegramURLDocument -BotToken $botToken -ChatID $chatID -FileURL $fileURL</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $fileURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/LogExample.zip' $sendTelegramURLDocumentSplat = @{ BotToken = $botToken ChatID = $chatID FileURL = $fileURL Caption = 'Log Files' ParseMode = 'MarkdownV2' DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramURLDocument @sendTelegramURLDocumentSplat</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $fileURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/LogExample.zip' $sendTelegramURLDocumentSplat = @{ BotToken = $botToken ChatID = $chatID FileURL = $fileURL Caption = 'Here are the __important__ Log Files\.' ParseMode = 'MarkdownV2' } Send-TelegramURLDocument @sendTelegramURLDocumentSplat</dev:code> <dev:remarks> <maml:para>Sends document message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLDocument</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLDocument</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#senddocument</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#senddocument</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLPhoto</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLPhoto</command:noun> <maml:description> <maml:para>Sends Telegram photo message via Bot API from URL sourced photo image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send photo message to specified Telegram chat. The photo will be sourced from the provided URL and sent to Telegram. Several options can be specified to adjust message parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLPhoto</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhotoURL</maml:name> <maml:Description> <maml:para>URL path to photo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>PhotoURL</maml:name> <maml:Description> <maml:para>URL path to photo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photoURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/techthoughts.png' Send-TelegramURLPhoto -BotToken $botToken -ChatID $chatID -PhotoURL $photourl</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photoURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/techthoughts.png' $sendTelegramURLPhotoSplat = @{ BotToken = $botToken ChatID = $chatID PhotoURL = $photourl Caption = 'DSC is a great technology' ParseMode = 'MarkdownV2' DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramURLPhoto @sendTelegramURLPhotoSplat</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $photoURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/techthoughts.png' $sendTelegramURLPhotoSplat = @{ BotToken = $botToken ChatID = $chatID PhotoURL = $photourl Caption = "DSC is a __great__ technology\." ParseMode = 'MarkdownV2' } Send-TelegramURLPhoto @sendTelegramURLPhotoSplat</dev:code> <dev:remarks> <maml:para>Sends photo message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLPhoto</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLPhoto</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendphoto</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendphoto</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLSticker</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLSticker</command:noun> <maml:description> <maml:para>Sends Telegram sticker message via Bot API from URL sourced sticker image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send sticker message to specified Telegram chat. The sticker will be sourced from the provided URL and sent to Telegram.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLSticker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StickerURL</maml:name> <maml:Description> <maml:para>URL path to sticker</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>StickerURL</maml:name> <maml:Description> <maml:para>URL path to sticker</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>The following sticker types are supported: WEBP, WEBM</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $stickerURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/techthoughts.webp' Send-TelegramURLSticker -BotToken $botToken -ChatID $chatID -StickerURL $stickerURL</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $stickerURL = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/techthoughts.webp' $sendTelegramURLStickerSplat = @{ BotToken = $botToken ChatID = $chatID StickerURL = $stickerURL DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramURLSticker @sendTelegramURLStickerSplat</dev:code> <dev:remarks> <maml:para>Sends sticker message via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLSticker</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLSticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendsticker</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendsticker</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramURLVideo</command:name> <command:verb>Send</command:verb> <command:noun>TelegramURLVideo</command:noun> <maml:description> <maml:para>Sends Telegram video message via Bot API from URL sourced file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send video message to specified Telegram chat. The file will be sourced from the provided URL and sent to Telegram. Several options can be specified to adjust message parameters. Only works for gif, pdf and zip files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramURLVideo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VideoURL</maml:name> <maml:Description> <maml:para>URL path to video file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of sent video in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Video width</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Video height</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Streaming</maml:name> <maml:Description> <maml:para>Use if the uploaded video is suitable for streaming</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VideoURL</maml:name> <maml:Description> <maml:para>URL path to video file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>Duration of sent video in seconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Video width</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Video height</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>Original File Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Caption</maml:name> <maml:Description> <maml:para>Brief title or explanation for media</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>ParseMode</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HTML</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Streaming</maml:name> <maml:Description> <maml:para>Use if the uploaded video is suitable for streaming</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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.</maml:para> <maml:para>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/</maml:para> <maml:para>Markdown Style: This is a legacy mode, retained for backward compatibility. When using Markdown/Markdownv2 you must properly escape characters.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $videourl = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Intro.mp4' Send-TelegramURLVideo -BotToken $botToken -ChatID $chatID -VideoURL $videourl</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $videourl = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Intro.mp4' $sendTelegramURLVideoSplat = @{ BotToken = $botToken ChatID = $chatID VideoURL = $videourl Duration = 16 Width = 1920 Height = 1080 FileName = 'video.mp4' Caption = 'Check out this video' ParseMode = 'MarkdownV2' Streaming = $true DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramURLVideo @sendTelegramURLVideoSplat</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $videourl = 'https://github.com/techthoughts2/PoshGram/raw/main/test/SourceFiles/Intro.mp4' $sendTelegramURLVideoSplat = @{ BotToken = $botToken ChatID = $chatID VideoURL = $videourl ParseMode = 'MarkdownV2' FileName = 'video.mp4' Caption = 'Check out this __awesome__ video\.' } Send-TelegramURLVideo @sendTelegramURLVideoSplat</dev:code> <dev:remarks> <maml:para>Sends video message via Telegram API with properly formatted underlined word and escaped special character.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLVideo</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramURLVideo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendvideo</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendvideo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#html-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#html-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdownv2-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdownv2-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#markdown-style</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#markdown-style</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TelegramVenue</command:name> <command:verb>Send</command:verb> <command:noun>TelegramVenue</command:noun> <maml:description> <maml:para>Sends Telegram information about a venue.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Telegram Bot API to send latitude, longitude, title, and address information about a venue to specified Telegram chat.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TelegramVenue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Name of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Address of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChatID</maml:name> <maml:Description> <maml:para>Unique identifier for the target chat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Name of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Address of the venue</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableNotification</maml:name> <maml:Description> <maml:para>Send the message silently. Users will receive a notification with no sound.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtectContent</maml:name> <maml:Description> <maml:para>Protects the contents of the sent message from forwarding and saving</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $latitude = 37.621313 $longitude = -122.378955 $title = 'Star Fleet Headquarters' $address = 'San Francisco, CA 94128' Send-TelegramVenue -BotToken $botToken -ChatID $chatID -Latitude $latitude -Longitude $longitude -Title $title -Address $address</dev:code> <dev:remarks> <maml:para>Sends venue information via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $chatID = '-nnnnnnnnn' $latitude = 37.621313 $longitude = -122.378955 $title = 'Star Fleet Headquarters' $address = 'San Francisco, CA 94128' $sendTelegramVenueSplat = @{ BotToken = $botToken ChatID = $chatID Latitude = $latitude Longitude = $longitude Title = $title Address = $address DisableNotification = $true ProtectContent = $true Verbose = $true } Send-TelegramVenue @sendTelegramVenueSplat</dev:code> <dev:remarks> <maml:para>Sends venue information via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Send-TelegramVenue</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Send-TelegramVenue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#sendvenue</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#sendvenue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-BotToken</command:name> <command:verb>Test</command:verb> <command:noun>BotToken</command:noun> <maml:description> <maml:para>Validates Bot auth Token</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-BotToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>BotToken</maml:name> <maml:Description> <maml:para>Use this token to access the HTTP API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> <maml:para>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/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' Test-BotToken -BotToken $botToken</dev:code> <dev:remarks> <maml:para>Validates the specified Bot auth token via Telegram API</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$botToken = 'nnnnnnnnn:xxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx' $testBotTokenSplat = @{ BotToken = $botToken Verbose = $true } Test-BotToken @testBotTokenSplat</dev:code> <dev:remarks> <maml:para>Validates the specified Bot auth token via Telegram API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://poshgram.readthedocs.io/en/latest/Test-BotToken</maml:linkText> <maml:uri>https://poshgram.readthedocs.io/en/latest/Test-BotToken</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api#getme</maml:linkText> <maml:uri>https://core.telegram.org/bots/api#getme</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://core.telegram.org/bots/api</maml:linkText> <maml:uri>https://core.telegram.org/bots/api</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |