Modifies the property values of an existing dial-in conferencing access number. Dial-in conferencing provides a way for users to use a "regular" telephone or cell phone (that is, a device on the Public Switched Telephone Network) to join the audio portion of an online conference. To take advantage of this capability, users must call a predefined dial-in conferencing access number.
Syntax
Set-CsDialInConferencingAccessNumber -Instance <AccessNumber> [-Confirm [<SwitchParameter>]] [-PassThru <SwitchParameter>] [-ScopeToGlobal <SwitchParameter>] [-ScopeToSite <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Set-CsDialInConferencingAccessNumber -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DisplayNumber <String>] [-LineUri <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-Regions <MultiValuedProperty>] [-ScopeToGlobal <SwitchParameter>] [-ScopeToSite <SwitchParameter>] [-SecondaryLanguages <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] |
Set-CsDialInConferencingAccessNumber -Identity <UserIdParameter> -Priority <Int32> -ReorderedRegion <String> [-Confirm [<SwitchParameter>]] [-PassThru <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
SIP address |
SIP address of the contact object that represents the dial-in conferencing number. When specifying the PrimaryUri you must include the "sip:" prefix: -PrimaryUri " sip:RedmondDialIn@litwareinc.com". |
Instance |
Optional |
||
ScopeToGlobal |
Optional |
Switch Parameter |
If present, the dial-in conferencing number will be assigned to the global scope. |
ScopeToSite |
Optional |
Switch Parameter |
If present, the dial-in conferencing number will be scoped to the site where the contact object’s registrar pool resides. |
ScopeToService |
Optional |
Switch Parameter |
If present, the dial-in conferencing number will be scoped to the UserServices service in the site where the contact object’s registrar pool resides. |
DisplayName |
Optional |
String |
Active Directory display name for the new contact object. |
LineUri |
Optional |
String |
The actual dial-in conferencing phone number. The LineUri must be specified using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country code, area code, and phone number. For example: tel:+18005551234. Note that spaces, hyphens, parentheses and other characters are not allowed. |
PrimaryLanguage |
Optional |
String |
Primary language used for making dial-in conferencing announcements. 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 collection |
Optional collection of languages that can also be used for making dial-in conferencing announcements. 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". |
Regions |
Optional |
String |
Dial plan regions associated with the dial-in number. If a region is not included in at least one dial plan then it cannot be associated with a dial-in conferencing access number. To specify multiple regions, use a comma-separated list: -Regions "Northwest", "Southwest" |
Priority |
Optional |
Integer |
|
ReorderedRegion |
Optional |
String |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Dial-in conferencing enables users to use any kind of telephone - a standard "land line", a cell phone, a Voice over IP phone, etc. - to join the audio portion of an online conference. This enables users to participate in the meeting even if they do not have a computer or an Internet connection. Users have full audio capabilities: they can speak to other participants and hear everything they takes place. They simply, and obviously, won’t be able to see shared slides, video feeds, or other visual elements.
In order to provide users with dial-in conferencing capabilities you must create dial-in conferencing access numbers: phone numbers that users can call in order to be connected to a meeting. Dial-in conferencing access numbers are created using the New-CsDialInConferencingAccessNumber cmdlet. When you create a new dial-in conferencing access number, you are actually creating a new contact object in Active Directory; this contact object is used to represent the access number and all its properties. Contact numbers can be retrieved using the Get-CsDialInConferencingAccessNumber cmdlet. Alternatively, you can find these contacts using Active Directory Sites and Services. Open the Sites and Services snap-in and, if necessary, right-click Active Directory Sites and Services, point to View, and then click Show Services Node. Expand the Services node and then expand RTC Services. Your contact objects can then be found in the Application Contacts folder.
After a dial-in conferencing number has been created, you can use the Set-CsDialInConferencingAccessNumber cmdlet to modify the properties of that number. For example, you can change such things as the phone number (LineUri) itself; you can always change the SIP address or display name for the contact object that represents that number. Set-CsDialInConferencingAccessNumber also enables you to modify the scope of the number; for example, you can use this cmdlet to take a number that has been assigned to the global scope and reassign it to the site or service scope.
Return Types
Set-CsDialInConferencingAccessNumber does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Xds.AccessNumber object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -DisplayName "Redmond Dial-In Access Number" |
The command shown in Example 1 modifies the DisplayName property for the dial-in conferencing access number with the Identity sip:RedmondDialIn@litwareinc.com. In this example, the display name is set to "Redmond Dial-In Access Number".
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -Region "Redmond", "Seattle" |
In Example 2, the dial-in conferencing access number with the Identity sip:RedmondDialIn@litwareinc.com is modified to list two regions: Redmond and Seattle. To do this, the -Region parameter is called, followed by the two regions (two string values separated by commas). Note that this command will fail unless both the Redmond and Seattle regions have already been defined in dial plans.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "fr-FR" | Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-CA" |
In the preceding example, all the dial-in conferencing access numbers where the primary language is French are modified to include French Canadian as the secondary language. To carry out this task Get-CsDialInConferencingAccessNumber is first called to return a collection of all the dial-in access numbers configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out the access numbers where the PrimaryLanguage property is equal to (-eq) French ("fr-FR"). This filtered collection is then piped to Set-CsDialInConferencingAccessNumber, which sets the value of the SecondaryLanguages property to French Canadian ("fr-CA"). Note that this command will fail if you try to set SecondaryLanguages to a language not supported for dial-in conferencing. To view the list of support languages type the following command from the Windows PowerShell prompt: Get-CsDialInConferencingLanguageList.
-------------------------- Example 4 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default DialIn Access Number"} | Set-CsDialInConferencingAccessNumber -DisplayName "Litwareinc Conferencing" |
The command shown in Example 4 changes the Active Directory display name for the specified dial-in conferencing access number. To do this, the command first uses Get-CsDialInConferencingAccessNumber and the -Filter parameter to return the dial-in access number where the DisplayName property is equal to (-eq) "Default DialIn Access Number". That access number is then piped to the Set-CsDialInConferencingAccessNumber cmdlet, which changes the display name to Litwareinc Conferencing.
-------------------------- Example 5 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -Filter {DisplayNumber -eq "1-425-555-8715"} | Set-CsDialInConferencingAccessNumber -DisplayNumber "1-425-555-1298" -LineUri "tel:+14255551298" |
In Example 5, both the display number and the line URI are modified for the specified dial-in conferencing access number. To retrieve the number to be modified, the command first uses Get-CsDialInConferencingAccessNumber and the -Filter parameter; the accompanying filter value limits the returned data to the access number where the DisplayNumber property is equal to (-eq) 1-425-555-8715. That access number is then piped to Set-CsDialInConferencingAccessNumber, which, in turn, modifies both the item’s DisplayNumber and LineUri properties.
-------------------------- Example 6 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "en-US"} | Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-FR","it-IT" |
The preceding command assigns a pair of secondary languages to all the dial-in conferencing access numbers that do not use US English as their primary language. To do this, the command first calls Get-CsDialInConferencingAccessNumber to return a collection of all the dial-in conferencing access numbers configured for use I in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those numbers where the PrimaryLanguage property is not equal to (-ne) US English (en-US). The filtered collection is then piped to Set-CsDialInConferencingAccessNumber, which uses the -SecondaryLanguages parameter to assign each number in the collection the secondary languages French (fr-FR) and Italian (it-IT).