[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Enables you to modify the property values for any of the audio test service application contacts currently in use in your organization.

Syntax

Set-CsAudioTestServiceApplicationContact -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-CSEnabled <$true | $false>] [-DisplayName <String>] [-DisplayNumber <String>] [-EnabledForFederation <$true | $false>] [-EnterpriseVoiceEnabled <$true | $false>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-SecondaryLanguages <MultiValuedProperty>] [-SipAddress <String>] [-Type <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

UserID Parameter

EnabledForFederation

Optional

Boolean

Indicates whether this audio test contact is available to users from a federated domain. If set to False, only users within your organization will have access to the contact.

PrimaryLanguage

Optional

String

Primary language used for the audio test service. The language must be configured using one of the available dial-in conferencing language codes; for example, en-US for US English; fr-FR for French; etc. To return a list of the available language codes, type the following command at the Windows PowerShell prompt: Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages.

SecondaryLanguages

Optional

String array

Optional collection of languages that can also be used for the audio test service. Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; -SecondaryLanguages "fr-CA", "fr-FR".

DisplayName

Optional

String

Enables you to modify the Active Directory display name of the contact object.

DisplayNumber

Optional

String

Phone number as displayed in Microsoft Communicator. The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc.

Type

Optional

String

Indicates which kind of test contact being deployed. By default, contacts are listed as Automaton, which means they can interact with callers.

EnterpriseVoiceEnabled

Optional

Boolean

Indicates whether the contact object has been enabled for Enterprise Voice, Microsoft’s implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can use make telephone calls using the Internet rather than using the standard telephone network.

LineUri

Optional

String

Telephone number of the contact object. The line URI should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. For example: TEL:+14255551297. Any extension number should be added to the end of the line URI, for example: TEL:+14255551297; ext=51297.

SipAddress

Optional

SIP address

Unique identifier (similar to an email address) that allows the contact object to communicate using SIP devices such as Communicator "14". The SIP address must be prefaced by sip:; for example: -SipAddress "sip:kenmyer@litwareinc.com".

CsEnabled

Optional

Boolean

Indicates whether or not the contact object has been enabled for Communications Server. If you set this value to False ($False), the contact will no longer be able to log on to Communications Server; setting this value to True ($True) re-enables the contact’s logon privileges.

PassThru

Optional

Switch Parameter

Returns a contact object representing the audio test service contact being modified.

WhatIf

Optional

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

The Audio Test Service enables Microsoft Communicator users to test their voice connections before they make a voice call. To do this, users click the Check call quality button found on the Audio Device tab of the Communicator Options dialog box. When a user clicks this button, a call will be made to an automated audio test service application contact. The call will be answered and, after a brief introductory recording is played, the caller will be prompted to record a brief message (10 seconds maximum). That recording will then be replayed, enabling the caller to hear what he or she sounds like over the current connection.

Audio test service contacts are automatically created for you when you install Unified Communications Application Server; there is no provision for manually creating these contacts. However, administrators can use the Set-CsAudioTestServiceApplicationContact cmdlet to modify property values for any of the test service contacts currently in use in the organization.

Return Types

Set-CsAudioTestServiceApplicationContact does not create any objects.

Examples

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

Copy Code 
Set-CsAudioTestServiceApplicationContact -Identity "sip:RedmondAudioTest@litwareinc.com" -DisplayNumber "1-(800)-555-1298" -EnabledForFederation $True

The command shown in Example 1 modifies the DisplayNumber and EnabledForFederation properties for the audio test contact with the Identity sip:RedmondAudioTest@litwareinc.com.

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

Copy Code 
Get-CsAudioTestServiceApplicationContact | Set-CsAudioTestServiceApplicationContact -EnabledForFederation $True

The preceding command retrieves all the audio test service contacts in the organization and then enables each one for federation. To do this, the command first calls Get-CsAudioTestServiceApplicationContact without any parameters in order to return a collection of all the existing audio test service contacts. This collection is then piped to Set-CsAudioTestServiceApplicationContact, which takes each contact in the collection and sets the value of the EnabledForFederation property to True ($True).