New-CsDialInConferencingAccessNumber
Topic Last Modified: 2012-03-23
Creates a new dial-in conferencing access number. Dial-in conferencing provides a way for users to use a "regular" telephone, cell phone or other device on the public switched telephone network (PSTN) to join the audio portion of a conference.
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>]]
Detailed Description
Dial-in conferencing enables users to use any kind of telephone (such as standard "land line," a mobile phone, or a Voice over Internet Protocol (VoIP) phone) 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 that takes place. They just aren’t 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 users can call in order to be connected to a meeting. Dial-in conferencing access numbers are created by using the New-CsDialInConferencingAccessNumber cmdlet. When you create a new dial-in conferencing access number, you actually create a new contact object in Active Directory Domain Services (AD DS); this contact object is used to represent the access number and all its properties.
When creating a new dial-in number you must include the following parameters: PrimaryUri; LineURI; Pool; DisplayNumber; PrimaryLanguage; and Regions. All of these parameters (and their parameter values) are reasonably straightforward, with perhaps one exception: Regions. When you create a new access number, that number must be associated with one or more regions. In turn, 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 the region cannot be associated with an access number. That simply means you must first create a dial plan, and specify a region for that dial plan, before you can create a dial-in conferencing access number.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsDialInConferencingAccessNumber cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDialInConferencingAccessNumber"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
PrimaryUri |
Required |
SIP address |
Unique SIP address to be assigned to the new contact object. When specifying the PrimaryUri you must include the "sip:" prefix. For example: -PrimaryUri "sip:RedmondDialIn@litwareinc.com". |
DisplayName |
Optional |
String |
Active Directory display name for the new contact object. This is the name that will also be displayed in Microsoft Lync 2010. |
DisplayNumber |
Required |
String |
Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. |
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/region calling code, area code, and phone number. For example: tel:+18005551234. Note that spaces, hyphens, parentheses and other characters are not allowed. LineURIs must be unique throughout Active Directory. |
Regions |
Required |
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" |
Pool |
Required |
FQDN |
Home 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 U.S. 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 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". A single access number can have as many as four secondary languages. |
ScopeToSite |
Optional |
Switch Parameter |
If present, the new number will be scoped to the same site as the contact object’s home pool. If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. |
PassThru |
Optional |
Switch Parameter |
Enables you to pass a contact object through the pipeline that represents the new dial-in conferencing access number. By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. |
Tenant |
Optional |
Guid |
This parameter is not applicable to the on-premises version of Lync Server 2010. |
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. |
Input Types
None. New-CsDialInConferencingAccessNumber does not accept pipelined input.
Return Types
New-CsDialInConferencingAccessNumber creates new instances of the Microsoft.Rtc.Management.Xds.AccessNumber object.
Example
-------------------------- Example 1 ------------------------
New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond"
Example 1 creates a new dial-in conferencing access number with the primary URI sip:RedmondDialIn@litwareinc.com. In addition to the PrimaryUri parameter, the command also includes parameters that configure the telephone number as displayed in Microsoft Lync 2010 (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 (Regions).
-------------------------- Example 2 ------------------------
New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "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).
-------------------------- Example 3 ------------------------
New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" -ScopeToSite
The preceding command creates a new dial-in conferencing access number that is scoped to the site where the contact object’s home pool is located. To do this, the command includes the parameter ScopeToSite.