Set-CsAnnouncement

Syntax

Set-CsAnnouncement
   [[-Identity] <XdsIdentity>]
   [-Name <String>]
   [-AudioFilePrompt <String>]
   [-TextToSpeechPrompt <String>]
   [-Language <String>]
   [-TargetUri <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsAnnouncement
   [-Instance <PSObject>]
   [-Name <String>]
   [-AudioFilePrompt <String>]
   [-TextToSpeechPrompt <String>]
   [-Language <String>]
   [-TargetUri <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

An organization can own phone numbers that are not assigned to users or phones, but that are still valid numbers that can be called. By default when someone dials one of those numbers, that person will receive a busy signal and the call may result in an error returned to the SIP client. By applying announcement settings to unassigned numbers, administrators have the option of playing a message, returning a busy signal, or redirecting the call. This cmdlet modifies these announcement settings.

Examples

-------------------------- Example 1 ------------------------

Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -AudioFilePrompt "helpdesk.wav"

The command shown in Example 1 assigns a new audio file to the Help Desk announcement. To perform this task, the command first uses the Get-CsAnnouncement cmdlet, without any parameters, to return a collection of all the announcements currently available. This collection is then piped to the Where-Object cmdlet, which picks the one announcement where the Name is equal to (-eq) "Help Desk Announcement". In turn, that announcement is then piped to the Set-CsAnnouncement cmdlet, which sets the value of the AudioFilePrompt property to helpdesk.wav.

Note that if this announcement already has a TextToSpeechPrompt value assigned to it, this command will generate a warning that the TextToSpeechPrompt value will be ignored.

-------------------------- Example 2 ------------------------

Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TextToSpeechPrompt $Null

In Example 2, the TextToSpeechPrompt property for the announcement Help Desk Announcement is set to a null value; this effectively erases the property value. To do this, the command first uses the Get-CsAnnouncement cmdlet to return a collection of all the announcements currently available. This collection is then piped to the Where-Object cmdlet, which selects the announcement where the Name is equal to (-eq) "Help Desk Announcement". This announcement is then piped to the Set-CsAnnouncement cmdlet, which sets the TextToSpeechPrompt property to a null value ($Null).

-------------------------- Example 3 ------------------------

Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TargetUri "sip:kmyer@litwareinc.com;opaque=app:voicemail"

This example updates the TargetUri for the Announcement with the name Help Desk Announcement. The command first uses the Get-CsAnnouncement cmdlet to return a collection of all the announcements currently available. This collection is then piped to the Where-Object cmdlet, which selects the announcement where the Name is equal to (-eq) "Help Desk Announcement". This announcement is then piped to the Set-CsAnnouncement cmdlet, which sets the TargetUri property to a voice mail location (sip:kmyer@litwareinc.com;opaque=app:voicemail).

Parameters

-AudioFilePrompt

-Confirm

-Force

-Identity

-Instance

-Language

-Name

-TargetUri

-TextToSpeechPrompt

-WhatIf

Inputs

Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. Accepts pipelined input of announcement objects.

Outputs

The Set-CsAnnouncement cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object.

Related Links

• New-CsAnnouncement
• Remove-CsAnnouncement
• Get-CsAnnouncement
• Import-CsAnnouncementFile