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

Returns information about all the dial-in conferencing access numbers configured for use in your organization. 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.

Syntax

Get-CsDialInConferencingAccessNumber [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]
Get-CsDialInConferencingAccessNumber [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-Region <String>] [-ResultSize <Unlimited>]
Get-CsDialInConferencingAccessNumber -EmptyRegion <SwitchParameter> [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]

Parameters

Parameter Required Type Description

Identity

Optional

SIP address

SIP address of the dial-in conferencing access number (that is, the contact object that represents that number) to be retrieved. You must include the sip: prefix when specifying the Identity; for example, -Identity sip:RedmondDialIn@litwareinc.com.

If this parameter is not specified then Get-CsDialInConferencingAccessNumber will return all the dial-in conferencing access numbers configured for use in your organization.

Filter

Optional

String

Enables you to limit the returned data by filtering on specific attributes for Microsoft Communications Server 2010. For example, you can limit returned data to dial-in conferencing numbers that have the string value "Redmond" in their display name, or toll-free dial-in conferencing numbers that use the 1-800 prefix.

The -Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only that have the 1-800 prefix would look like this: {LineUri -like "tel:+1800*"}, withLineUri representing the Active Directory Domain Services attribute, -like representing the comparison operator, and "tel:+1800*" representing the filter value.

For details, see the about_communications_server_filters Help topic.

Region

Optional

String

Returns all the dial-in conferencing access numbers associated with the specified dial plan region. For example, to return all the dial-in numbers for the Northwest region, use this syntax: -Region Northwest.

Credential

Optional

PS Credential object

Enables you to run the Get-CsAdContact cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects.

To use the -Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. See the help topic for that cmdlet for more information.

DomainController

Optional

String

Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the -DomainController parameter followed by the computer name (e.g., atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com).

OU

Optional

String

Enables you to limit the retrieved information from a specific Active Directory Domain Services organizational unit (OU). This returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUS - AccountsPayable and AccountsReceivable - contacts will be returned from each of these three OUs.

When specifying an OU, use the distinguished name of that container; for example: OU=Finance,dc=litwareinc,dc=com.

ResultSize

Optional

Integer

Enables you to limit the number of records returned by a command. For example, to return just 7 contacts (regardless of how many contacts are in your forest) simply include the -ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 contacts will be returned. If you set the ResultSize to 7 but you have only 3 contacts in your forest the command will return those 3 users and then complete without error.

The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned.

EmptyRegion

Optional

Switch Parameter

When specified, returns all the dial-in conferencing access numbers that have not been associated with a dial plan region.

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 just 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.

When you use Get-CsDialInConferencingAccessNumber to return dial-in conferencing numbers you get detailed information regarding those numbers; what you don’t get back, however, is information about the scope that each of these numbers have been assigned to. (Dial-in conferencing numbers can be assigned to the global scope, the site scope, or to the UserServices service scope.) If you want information about the different scopes, and the dial-in numbers assigned to each of these scopes, use the Get-CsConferenceAccessNumberList cmdlet.

Return Types

Get-CsDialInConferencingAccessNumber returns instances of the Microsoft.Rtc.Management.Xds.AccessNumber object.

Examples

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

Copy Code
Get-CsDialInConferencingAccessNumber

The command shown in Example 1 returns a collection of all the dial-in conferencing access numbers configured for use in the organization. Calling Get-CsDialInConferencingAccessNumber without any additional parameters will always return a collection of all the available dial-in access numbers.

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

Copy Code
Get-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com

In Example 2, the dial-in conferencing access number with the Identity sip:RedmondDialIn@litwareinc.com is returned. Because identities must be unique, this command will never return more than one access number.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber -Region "Redmond"

Example 3 uses the -Region parameter to return all the dial-in conferencing access numbers associated with the Redmond region. To do this, Get-CsDialInConferencingAccessNumber is called along with the -Region parameter. Specifying "Redmond" as the parameter value causes Get-CsDialInConferencingAccessNumber to return all the numbers where "Redmond" appears in the list of associated regions. For example, an access number that only listed Redmond as a region would be returned, as would an access number that listed both Redmond and Paris.

-------------------------- Example 4 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber -EmptyRegion

The preceding command returns all the dial-in conferencing access numbers that are not associated with a region (that is, the Regions property is empty).

-------------------------- Example 5 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber -Filter {DisplayName -like "*Seattle*"}

In Example 5, the -Filter parameter is used in order to return a collection of all the dial-in conferencing access numbers that include the string value "Seattle" somewhere in their DisplayName. The filter value {DisplayName -like "*Seattle*"} limits the returned data to access numbers where the DisplayName include the word "Seattle" (for example, Seattle Access Number; Dial-In Number for Seattle; Tacoma/Seattle Access Number; etc.).

-------------------------- Example 6 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1425*"}

Example 6 returns all the dial-in conferencing access numbers where the line Uri begins with tel:+1425; that effectively returns all the US phone numbers with the area code 425. To do this, Get-CsDialInConferencingAccessNumber is called along with the -Filter parameter; the filter value {LineUri -like "tel:+1425*"} limits the returned data to line Uris that begin with the string value "tel:+1425". To return all the phone numbers for area code 425 or for the area code 206 use this filter value: {LineUri -like tel:+1425* -or LineUri -like "tel:+1206*"}

-------------------------- Example 7 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "it-IT"}

The preceding example returns a collection of all the dial-in conferencing access numbers where the primary language is set to Italian. To carry out this task, Get-CsDialInConferencingAccessNumber is first called in order to return a collection of all the access numbers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those numbers where the PrimaryLanguage property is equal to (-eq) Italian ("it-Italian").

-------------------------- Example 8 ------------------------

Copy Code
Get-CsDialInConferencingAccessNumber  | Where-Object {$_.SecondaryLanguages -contains "fr-FR"}

The command shown in Example 8 returns all the dial-in conferencing access numbers where French is listed as one of the secondary languages. To accomplish this task, Get-CsDialInConferencingAccessNumber is first called without any parameters; that returns a complete collection of access numbers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those numbers where the SecondaryLanguages property includes (-contains) a listing for French (fr-FR).