New-CsCallingLineIdentity

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization.

Syntax

New-CsCallingLineIdentity
   [-Identity] <string>
   [-BlockIncomingPstnCallerID <bool>]
   [-CallingIDSubstitute <string>]
   [-CompanyName <string>]
   [-Description <string>]
   [-EnableUserOverride <bool>]
   [-ResourceAccount <string>]
   [-ServiceNumber <string>][-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Note: The use of CallingIDSubstitute Service has been deprecated. You are no longer able to create new Caller ID policies using CallingIDSubstitute Service and existing policies using CallingIDSubstitute Service are not being honored. You should use CallingIDSubstitute Resource instead.

You can either change or block the Caller ID (also called a Calling Line ID) for a user. By default, the Teams or Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed.

Note:

  • Identity must be unique.
  • If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty.

Examples

Example 1

New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false

This example creates a new Caller ID policy that sets the Caller ID to Anonymous.

Example 2

New-CsCallingLineIdentity -Identity BlockIncomingCLID -BlockIncomingPstnCallerID $true

This example creates a new Caller ID policy that blocks the incoming Caller ID.

Example 3

$ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId
New-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -EnableUserOverride $false -ResourceAccount $ObjId -CompanyName "Contoso"

This example creates a new Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso

Example 4

New-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true

This example creates a new Caller ID policy that allows Teams users to make anonymous calls.

Parameters

-BlockIncomingPstnCallerID

The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false.

The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a user, then Caller ID for incoming calls is suppressed/anonymous.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-CallingIDSubstitute

Note: The use of CallingIDSubstitute Service will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource instead.

The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, LineUri, and Resource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-CompanyName

This parameter sets the Calling party name (typically referred to as CNAM) on the outgoing PSTN call.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Confirm

The Confirm switch causes the command to pause processing and requires confirmation to proceed.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Description

The Description parameter briefly describes the Caller ID policy.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-EnableUserOverride

The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous.

If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous.

EnableUserOverride has precedence over other settings in the policy unless substitution is set to Anonymous. For example, assume the policy instance has substitution using a resource account and EnableUserOverride is set and enabled by the user. In this case, the outbound caller ID will be blocked and Anonymous will be used.

Type:Boolean
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Identity

The Identity parameter identifies the Caller ID policy.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-ResourceAccount

This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://video2.skills-academy.com/microsoftteams/manage-resource-accounts

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-ServiceNumber

Note: The use of CallingIDSubstitute Service and -ServiceNumber will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource and -ResourceAccount instead.

The ServiceNumber parameter lets you add any valid service number for the CallingIdSubstitute.

Note: Do not add '+' to the Service number. For example, if the Service number is +1425-xxx-xxxx then valid input is 1425xxxxxxx

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-WhatIf

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

Inputs

None

Outputs

None