Get-CsUserCallingSettings
This cmdlet shows call forwarding, simultaneous ringing, call group, busy-on-busy, and delegation settings for users. It also supports Shared Line Appearance (SLA) for resource accounts, including forwarding, unanswered call settings, maximum concurrent calls, and CAP or user delegation.
Syntax
Get (Default)
Get-CsUserCallingSettings
-Identity <String>
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[<CommonParameters>]
GetViaIdentity
Get-CsUserCallingSettings
-InputObject <IConfigApiBasedCmdletsIdentity>
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[<CommonParameters>]
Description
This cmdlet shows the call forwarding, simultaneous ringing, call group, busy on busy and delegation settings for a user. It will also show any call groups the user is a member of and if someone else has added the user as a delegate.
For phone-centric scenarios, this cmdlet also supports resource accounts configured for Teams Phone Agents, Call Queues, Auto Attendants, and standalone resource accounts. For these resource accounts, the cmdlet shows immediate forwarding, unanswered call settings, and the maximum number of concurrent calls. It also shows Common Area Phone (CAP) users or regular users assigned as delegates for the resource account.
Examples
Example 1
Get-CsUserCallingSettings -Identity user1@contoso.com
SipUri : sip:user1@contoso.com
IsForwardingEnabled : True
ForwardingType : Immediate
ForwardingTarget :
ForwardingTargetType : Voicemail
IsUnansweredEnabled : False
UnansweredTarget :
UnansweredTargetType : Voicemail
UnansweredDelay : 00:00:20
Delegates :
Delegators :
MaximumConcurrentCalls :
CallGroupOrder : InOrder
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride :
BusyOnBusyOption :
This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType).
Example 2
Get-CsUserCallingSettings -Identity user2@contoso.com
SipUri : sip:user2@contoso.com
IsForwardingEnabled : True
ForwardingType : Simultaneous
ForwardingTarget : sip:user3@contoso.com
ForwardingTargetType : SingleTarget
IsUnansweredEnabled : True
UnansweredTarget :
UnansweredTargetType : Voicemail
UnansweredDelay : 00:00:20
Delegates :
Delegators :
MaximumConcurrentCalls :
CallGroupOrder : InOrder
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride :
BusyOnBusyOption :
This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com (ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed to voicemail (UnansweredTargetType).
Example 3
Get-CsUserCallingSettings -Identity user4@contoso.com
SipUri : sip:user4@contoso.com
IsForwardingEnabled : True
ForwardingType : Simultaneous
ForwardingTarget :
ForwardingTargetType : Group
IsUnansweredEnabled : True
UnansweredTarget :
UnansweredTargetType : Voicemail
UnansweredDelay : 00:00:20
Delegates :
Delegators :
MaximumConcurrentCalls :
CallGroupOrder : InOrder
CallGroupTargets : {sip:user5@contoso.com}
GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com
GroupNotificationOverride : Mute
BusyOnBusyOption :
(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails
CallGroupOwnerId NotificationSetting
---------------- -------------------
sip:user6@contoso.com Ring
This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com (CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder).
You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride).
Example 4
Get-CsUserCallingSettings -Identity user7@contoso.com
SipUri : sip:opr7@contoso.com
IsForwardingEnabled : True
ForwardingType : Simultaneous
ForwardingTarget :
ForwardingTargetType : MyDelegates
IsUnansweredEnabled : True
UnansweredTarget :
UnansweredTargetType : Voicemail
UnansweredDelay : 00:00:20
Delegates : Id:sip:user8@contoso.com
Delegators :
MaximumConcurrentCalls :
CallGroupOrder : InOrder
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride : Ring
BusyOnBusyOption :
(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates
Id : sip:user8@contoso.com
MakeCalls : True
ManageSettings : True
ReceiveCalls : True
PickUpHeldCalls : True
JoinActiveCalls : True
This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate (Delegates) and that user has all the permissions you can have as a delegate (Delegates).
Example 5
Get-CsUserCallingSettings -Identity user9@contoso.com
SipUri : sip:user9@contoso.com
IsForwardingEnabled : False
ForwardingType : Immediate
ForwardingTarget :
ForwardingTargetType : Voicemail
IsUnansweredEnabled : True
UnansweredTarget :
UnansweredTargetType : Voicemail
UnansweredDelay : 00:00:20
Delegates :
Delegators : Id:sip:user10@contoso.com
MaximumConcurrentCalls :
CallGroupOrder : InOrder
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride : Ring
BusyOnBusyOption :
(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators
Id : sip:user10@contoso.com
MakeCalls : True
ManageSettings : True
ReceiveCalls : True
PickUpHeldCalls : True
JoinActiveCalls : True
This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the permissions you can have as a delegate (Delegators).
Example 6
Get-CsUserCallingSettings -Identity user11@contoso.com
SipUri : sip:user11@contoso.com
IsForwardingEnabled :
ForwardingType :
ForwardingTarget :
ForwardingTargetType :
IsUnansweredEnabled :
UnansweredTarget :
UnansweredTargetType :
UnansweredDelay : 00:00:20
Delegates :
Delegators :
MaximumConcurrentCalls :
CallGroupOrder : Simultaneous
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride :
BusyOnBusyOption :
This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, unanswered calls will by default be forwarded to voicemail after 30 seconds.
Example 7 - View Resource Account Call Delegation Settings
Get-CsUserCallingSettings -Identity resource_account1@contoso.com
SipUri :
IsForwardingEnabled : True
ForwardingType : Simultaneous
ForwardingTarget :
ForwardingTargetType : MyDelegates
IsUnansweredEnabled : True
UnansweredTarget :
UnansweredTargetType : ResourceAccount
UnansweredDelay : 00:00:20
Delegates : {CAPphone1@contoso.com, CAPphone2@contoso.com, CAPphone3@contoso.com}
Delegators :
MaximumConcurrentCalls : 10
CallGroupOrder : Simultaneous
CallGroupTargets : {}
GroupMembershipDetails :
GroupNotificationOverride :
This example displays the call delegation settings for a resource account configured with multiple Common Area Phone (CAP) users as delegates. The output shows that incoming calls are simultaneously forwarded to the assigned delegates and that the resource account allows a maximum of 10 concurrent calls. If the number of concurrent calls reaches this limit, the 11th incoming call is handled directly according to the resource account's unanswered call settings. Calls that aren't answered within the configured 20-second delay are also handled according to the resource account's unanswered call settings.
Parameters
-Break
{{ Fill Break Description }}
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HttpPipelineAppend
{{ Fill HttpPipelineAppend Description }}
Parameter properties
| Type: | Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HttpPipelinePrepend
{{ Fill HttpPipelinePrepend Description }}
Parameter properties
| Type: | Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
The identity of the user or resource account to show call forwarding, simultaneous ringing, call group, delegation, and other applicable calling settings for. A user can be specified using the SIP address or ObjectId. A resource account can be specified using its ObjectId.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
{{ Fill InputObject Description }}
Parameter properties
| Type: | Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Proxy
{{ Fill Proxy Description }}
Parameter properties
| Type: | System.Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProxyCredential
{{ Fill ProxyCredential Description }}
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProxyUseDefaultCredentials
{{ Fill ProxyUseDefaultCredentials Description }}
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Notes
The cmdlet is available in Teams PowerShell module 4.0.0 or later.
The BusyOnBusyOption output property is available in Teams PowerShell module 8.0.0 or later. It shows the per-user busy on busy setting and can be PlayBusySignal,
RedirectAsUnansweredCall or RingUser. It is empty for a user that has no per-user busy on busy setting. You set this property with Set-CsUserCallingSettings -BusyOnBusyOption.
Resource account delegation is currently in Private Preview. The General Availability (GA) date is not yet determined.