Get-NectarNumber
- 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarNumber
- Updated on 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Returns a list of Nectar DXP numbers from the DID Management tool
Syntax
Get-NectarNumber
-PhoneNumber <String>
-LocationName <String>
-RangeName <String>
-NumberState <String>
-TenantName <String>
-PageSize <Int32>
-ResultSize <Int32>
Examples
Example 1
Get-NectarNumber
Returns the first 10 numbers
Example 2
Get-NectarNumber -ResultSize 100
Returns the first 100 numbers
Example 3
Get-NectarNumber -LocationName Tokyo
Returns the first 10 numbers at the Tokyo location
Example 4
Get-NectarNumber -RangeName Range2
Returns up to 10 numbers from a number range called Range2.
Example 5
Get-NectarNumber -RangeName Range2 -NumberState UNUSED -ResultSize 100
Returns up to 100 unused numbers in the Range2 range.
Parameters
-PhoneNumber <String>
The phone number to return information about. Can be a partial match. To return an exact match and to avoid ambiguity, enclose number with ^ at the beginning and $ at the end.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-LocationName <String>
The name of the location to get number information about. Will be an exact match.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-RangeName <String>
The name of the range to get number information about. Will be an exact match.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-NumberState <String>
Returns information about numbers that are either USED, UNUSED or RESERVED
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-PageSize <Int32>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | 10000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-ResultSize <Int32>
The number of results to return. Defaults to 1000.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?