Get-CsOnlineTelephoneNumber

 

Topic Last Modified: 2017-01-24

Use the Get-CsOnlineTelephoneNumber to retrieve telephone numbers from the Business Voice Directory.

Get-CsOnlineTelephoneNumber [-ActivationState <String>] [-Assigned <String>] [-BypassDualWrite <$true | $false>] [-CapitalOrMajorCity <String>] [-DomainController <Fqdn>] [-ExpandLocation <SwitchParameter>] [-Force <SwitchParameter>] [-InventoryType <String>] [-IsNotAssigned <SwitchParameter>] [-ResultSize <Unlimited>] [-TelephoneNumber <String>] [-TelephoneNumberGreaterThan <String>] [-TelephoneNumberLessThan <String>] [-TelephoneNumberStartsWith <String>] [-Tenant <Guid>]

This example gets the attributes of a specific phone number.

Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177

This example gets the phone numbers with the city code designating New York, New York.

Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY

Here is an example of the output of the Get-CsOnlineTelephoneNumber cmdlet.

RunspaceId     : f90303a9-c6a8-483c-b3b3-a5b8cdbab19c
CallingProfile : BandwidthUS
InventoryType  : Service
CityCode       : NOAM-US-NY-NY
Id             : 19294450177
O365Region     : NOAM
SourceType     : Tnm
TargetType     : caa
TargetMeta     : ;BridgeId=5bc815ae-d9e9-4fb6-af74-cf4fa73ceaa6
User           :
BridgeNumber   :

 

Parameter Required Type Description

ActivationState

Optional

System.String

PARAMVALUE: String

Assigned

Optional

System.String

Specifies the function of the telephone number. The acceptable values are:

  • "caa" for numbers assigned to conferencing functions.

  • "user" for numbers assigned to public switched telephone network (PSTN) functions.

NoteNote:
The values for the Assigned parameter are case-sensitive.

BypassDualWrite

Optional

System.Boolean

PARAMVALUE: $true | $false

CapitalOrMajorCity

Optional

System.String

Specifies the target geographical city for the cmdlet. To get a list of geographical codes for cities, use the Get-CsOnlineTelephoneNumberInventoryCities cmdlet.

NoteNote:
The values for the CapitalOrMajorCity parameter are case-sensitive.

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is reserved for internal Microsoft use.

ExpandLocation

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

InventoryType

Optional

System.String

Specifies the target telephone number type for the cmdlet. Acceptable values are:

  • "Service" for numbers assigned to conferencing support.

  • "Subscriber" for numbers supporting public switched telephone network (PSTN) functions.

IsNotAssigned

Optional

System.Management.Automation.SwitchParameter

Specifying this switch parameter will return only telephone numbers which are not assigned.

ResultSize

Optional

Microsoft.Rtc.Management.ADConnect.Core.Unlimited

Specifies the number of records returned by the cmdlet. 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.

TelephoneNumber

Optional

System.String

Specifies the target telephone number. For example: -TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567

TelephoneNumberGreaterThan

Optional

System.String

Specifies a telephone number used by the cmdlet as the lower boundary of the telephone numbers returned. The telephone numbers returned will all be greater than the number provided. The telephone number should be in E.164 format.

TelephoneNumberLessThan

Optional

System.String

Specifies a telephone number used by the cmdlet as the upper boundary of the telephone numbers returned. The telephone numbers returned will all be less than the number provided. The telephone number should be in E.164 format.

TelephoneNumberStartsWith

Optional

System.String

Specifies the digits that the returned telephone numbers must begin with. To return numbers in the 425 area code, use this syntax: -TelephoneNumberStartsWith 425. To return numbers that are in the 206 area code and that begin with 88, use this syntax: -TelephoneNumberStartsWith 20688. You can use up to nine digits.

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

Returns an instance, or an array of Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Number objects.

 
Show: