Creates a new 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
New-CsDialInConferencingAccessNumber -DisplayNumber <String> -LineURI <String> -Pool <Fqdn> -PrimaryLanguage <String> -PrimaryUri <String> -Regions <MultiValuedProperty> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-PassThru <SwitchParameter>] [-ScopeToSite <SwitchParameter>] [-SecondaryLanguages <MultiValuedProperty>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
PrimaryUri |
Required |
SIP address |
SIP address to be assigned to the new contact object. When specifying the PrimaryUri you must include the "sip:" prefix: -PrimaryUri " sip:RedmondDialIn@litwareinc.com". |
|
DisplayNumber |
Required |
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. |
|
LineUri |
Required |
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. |
|
Pool |
Required |
FQDN |
Registrar pool for the new contact object. |
|
PrimaryLanguage |
Required |
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 |
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" |
|
DisplayName |
Optional |
String |
Active Directory display name for the new contact object. |
|
ScopeToSite |
Optional |
Switch Parameter |
If present, the new number will be scoped to the site where the contact object’s registrar pool resides. If neither the ScopeToSite nor the ScopeToService parameters are included the new number will be assigned to the global scope. |
|
ScopeToService |
Optional |
Switch Parameter |
If present, the new number will be scoped to the UserServices service in the site where the contact object’s registrar pool resides. If neither the ScopeToSite nor the ScopeToService parameters are included the new number will be assigned to the global scope. |
|
PassThru |
Optional |
Switch Parameter |
|
|
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
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.
As noted, the New-CsDialInConferencingAccessNumber is used to create new dial-in access numbers and their associated contact objects. When creating a new dial-in number you must include the following parameters: -PrimaryUri; -LineUri; -CAG; -DisplayNumber; -PrimaryLanguage; and -Regions. All of those parameters (and their parameter values) are reasonably straightforward, with one exception: Regions. When you create a new contact number, that number must be associated with one or more regions. That’s not particularly difficult; you just need to know that a region cannot be associated with a dial-in conferencing number unless that region appears in at least one dial plan. If a region appears in the DialInConferencingRegion property of at least one dial plan then it can be associated with an access number. If not, then it can’t be associated with an access number.
Return Types
New-CsDialInConferencingAccessNumber creates new instances of the Microsoft.Rtc.Management.Xds.AccessNumber object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" - LineUri "tel:+18005551234" -Pool atl-Cs-001.litwareinc.com -PrimaryLanguage "en-US" -Region "Redmond" |
|
Example 1 creates a new dial-in conferencing access number with the primary URI RedmondDialIn@litwareinc.com. In addition to the -PrimaryUri parameter, the command also includes parameters that configure the telephone number as displayed in Active Directory (-DisplayNumber); the telephone number in the E.164 format (LineUri); the registrar pool the new number is assigned to (-Pool): the primary language for the number (-PrimaryLanguage); and the region the new number is assigned to (-Region).
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" - LineUri "tel:+18005551234" -Pool atl-Cs-001.litwareinc.com -PrimaryLanguage "en-US" -Region "Redmond" -SecondaryLanguages "fr-CA", "fr-FR" |
|
The command shown in Example 2 is a variation of the command shown in Example 1; the only difference is that the command shown in this example also assigns two secondary languages (French Canadian and French) to the new dial-in conferencing access number. To assign these secondary languages, the -SecondaryLanguages parameter is included, along with a comma-separated list of the languages to be assigned (fr-CA and fr-FR).