New-CsAnnouncement

Syntax

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

New-CsAnnouncement
   -Parent <String>
   -Name <String>
   [-AudioFilePrompt <String>]
   [-Language <String>]
   [-TargetUri <String>]
   [-TextToSpeechPrompt <String>]
   [-Force]
   [-InMemory]
   [-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 creates these announcement settings.

You can assign announcements to unassigned numbers by calling the New-CsUnassignedNumber or the Set-CsUnassignedNumber cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Help Desk Announcement" -TextToSpeechPrompt "Welcome to the Help Desk." -Language "en-US"

Example 1 demonstrates how you can create a new announcement that will play a TTS prompt in U.S. English. The first parameter we specify is Identity. The Identity must be at the service scope, followed by the service ID of the Application Server (ApplicationServer:redmond.litwareinc.com). Next we give the announcement a Name, in this case Help Desk Announcement. To assign a TTS prompt to this announcement we use the TextToSpeechPrompt parameter followed by a string with the announcement text. When a TTS prompt is used for an announcement you must specify a language, which we do here by including the Language parameter followed by a string representing U.S. English (en-US).

Note that announcement identities are composed of two parts: the service where the announcement is to be stored, and a 36-character GUID (globally unique identifier). You will see the full Identity after you create the new announcement; the GUID is generated and applied automatically. That Identity will be similar to this: service:ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90.

-------------------------- EXAMPLE 2 --------------------------

New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Welcome Announcement" -AudioFilePrompt "WelcomeMessage.wav"

Example 2 is similar to Example 1 in that we begin by entering the required parameters, Identity and Name. In this example, however, instead of a TTS prompt, we want the announcement to play an audio file. To do that we include the AudioFilePrompt parameter and pass it a string containing the name of the audio file (WelcomeMessage.wav). This file must be in the File Store in order for this announcement to play. You can add audio files to the File Store by calling the Import-CsAnnouncementFile cmdlet.

-------------------------- EXAMPLE 3 --------------------------

New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri sip:kmyer@litwareinc.com

Like Example 2, this example creates an announcement that plays an audio file when the number is reached. However, in this example in addition to the Identity, Name, and AudioFilePrompt parameters, we also specify the TargetUri parameter. We pass this parameter the SIP URI of the user or phone to which the caller will be forwarded after the announcement has been played.

-------------------------- EXAMPLE 4 --------------------------

New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri "sip:+14255551212@litwareinc.com;user=phone"

Example 4 is identical to Example 3 except that instead of forwarding the call based on a user's SIP address, the call is forwarded to a phone number.

-------------------------- EXAMPLE 5 --------------------------

New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Busy"

In this example we don't specify a prompt or a target URI, we include only an Identity and a Name. That means the caller will hear a busy signal when a call to an unassigned number associated with this announcement is connected.

Parameters

-AudioFilePrompt

-Confirm

-Force

-Identity

-InMemory

-Language

-Name

-Parent

-TargetUri

-TextToSpeechPrompt

-WhatIf

Inputs

None.

Outputs

Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement.

Related Links

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