|
| 1 | +--- |
| 2 | +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://docs.microsoft.com/powershell/module/teams/get-csusercallingsettings |
| 5 | +applicable: Microsoft Teams |
| 6 | +author: jenstrier |
| 7 | +ms.author: jenstr |
| 8 | +ms.reviewer: |
| 9 | +manager: |
| 10 | +schema: 2.0.0 |
| 11 | +--- |
| 12 | + |
| 13 | +# Get-CsUserCallingSettings |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. |
| 17 | + |
| 18 | +> [!NOTE] |
| 19 | +> **Preview** The use of this cmdlet is in Public Preview. |
| 20 | + |
| 21 | +## SYNTAX |
| 22 | + |
| 23 | +```powershell |
| 24 | +Get-CsUserCallingSettings -Identity <String> [<CommonParameters>] |
| 25 | +
|
| 26 | +``` |
| 27 | + |
| 28 | +## DESCRIPTION |
| 29 | +This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and |
| 30 | +if someone else has added the user as a delegate. |
| 31 | + |
| 32 | +## EXAMPLES |
| 33 | + |
| 34 | +### Example 1 |
| 35 | +```powershell |
| 36 | +Get-CsUserCallingSettings -Identity [email protected] |
| 37 | +``` |
| 38 | +```output |
| 39 | + |
| 40 | +IsForwardingEnabled : True |
| 41 | +ForwardingType : Immediate |
| 42 | +ForwardingTarget : |
| 43 | +ForwardingTargetType : Voicemail |
| 44 | +ForwardingDelay : 00:00:00 |
| 45 | +IsUnansweredEnabled : False |
| 46 | +IsSafeForward : False |
| 47 | +UnansweredTarget : |
| 48 | +UnansweredTargetType : Voicemail |
| 49 | +UnansweredDelay : 00:00:20 |
| 50 | +Delegates : |
| 51 | +Delegators : |
| 52 | +CallGroupOrder : InOrder |
| 53 | +CallGroupTargets : {} |
| 54 | +CallGroupDelay : |
| 55 | +GroupMembershipDetails : |
| 56 | +GroupNotificationOverride : |
| 57 | +``` |
| 58 | + |
| 59 | +This example shows that [email protected] has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). |
| 60 | + |
| 61 | +### Example 2 |
| 62 | +```powershell |
| 63 | +Get-CsUserCallingSettings -Identity [email protected] |
| 64 | +``` |
| 65 | +```output |
| 66 | + |
| 67 | +IsForwardingEnabled : True |
| 68 | +ForwardingType : Simultaneous |
| 69 | +ForwardingTarget : [email protected] |
| 70 | +ForwardingTargetType : SingleTarget |
| 71 | +ForwardingDelay : 00:00:00 |
| 72 | +IsUnansweredEnabled : True |
| 73 | +IsSafeForward : False |
| 74 | +UnansweredTarget : |
| 75 | +UnansweredTargetType : Voicemail |
| 76 | +UnansweredDelay : 00:00:20 |
| 77 | +Delegates : |
| 78 | +Delegators : |
| 79 | +CallGroupOrder : InOrder |
| 80 | +CallGroupTargets : {} |
| 81 | +CallGroupDelay : |
| 82 | +GroupMembershipDetails : |
| 83 | +GroupNotificationOverride : |
| 84 | +``` |
| 85 | + |
| 86 | +This example shows that [email protected] has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to [email protected] (ForwardingTarget and ForwardingTargetType) |
| 87 | +and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed to voicemail (UnansweredTargetType). |
| 88 | + |
| 89 | +### Example 3 |
| 90 | +```powershell |
| 91 | +Get-CsUserCallingSettings -Identity [email protected] |
| 92 | +``` |
| 93 | +```output |
| 94 | + |
| 95 | +IsForwardingEnabled : True |
| 96 | +ForwardingType : Simultaneous |
| 97 | +ForwardingTarget : |
| 98 | +ForwardingTargetType : Group |
| 99 | +ForwardingDelay : 00:00:00 |
| 100 | +IsUnansweredEnabled : True |
| 101 | +IsSafeForward : False |
| 102 | +UnansweredTarget : |
| 103 | +UnansweredTargetType : Voicemail |
| 104 | +UnansweredDelay : 00:00:20 |
| 105 | +Delegates : |
| 106 | +Delegators : |
| 107 | +CallGroupOrder : InOrder |
| 108 | +CallGroupTargets : {[email protected]} |
| 109 | +CallGroupDelay : |
| 110 | +GroupMembershipDetails : CallGroupOwnerId:[email protected] |
| 111 | +GroupNotificationOverride : Mute |
| 112 | +``` |
| 113 | +```powershell |
| 114 | +(Get-CsUserCallingSettings -Identity [email protected]).GroupMembershipDetails |
| 115 | +``` |
| 116 | +```output |
| 117 | +CallGroupOwnerId NotificationSetting |
| 118 | +---------------- ------------------- |
| 119 | + |
| 120 | +``` |
| 121 | + |
| 122 | +This example shows that [email protected] has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains [email protected] (CallGroupTargets). |
| 123 | +The call group is defined to ring members in the order listed in the call group (CallGroupOrder). |
| 124 | +You can also see that [email protected] is a member of [email protected]'s call group (GroupMembershipDetails), that [email protected] defined the call group with Ring |
| 125 | +notification for [email protected] (NotificationSetting) and that [email protected] has decided to turn off call notification for call group calls (GroupNotificationOverride). |
| 126 | + |
| 127 | + |
| 128 | +### Example 4 |
| 129 | +```powershell |
| 130 | +Get-CsUserCallingSettings -Identity [email protected] |
| 131 | +``` |
| 132 | +```output |
| 133 | + |
| 134 | +IsForwardingEnabled : True |
| 135 | +ForwardingType : Simultaneous |
| 136 | +ForwardingTarget : |
| 137 | +ForwardingTargetType : MyDelegates |
| 138 | +ForwardingDelay : 00:00:00 |
| 139 | +IsUnansweredEnabled : True |
| 140 | +IsSafeForward : True |
| 141 | +UnansweredTarget : |
| 142 | +UnansweredTargetType : Voicemail |
| 143 | +UnansweredDelay : 00:00:20 |
| 144 | + |
| 145 | +Delegators : |
| 146 | +CallGroupOrder : InOrder |
| 147 | +CallGroupTargets : {} |
| 148 | +CallGroupDelay : |
| 149 | +GroupMembershipDetails : |
| 150 | +GroupNotificationOverride : Ring |
| 151 | +``` |
| 152 | +```powershell |
| 153 | +(Get-CsUserCallingSettings -Identity [email protected]).Delegates |
| 154 | +``` |
| 155 | +```output |
| 156 | + |
| 157 | +IsActive : True |
| 158 | +CreatedDate : 14-10-2021 09:46:00 |
| 159 | +MakeCalls : True |
| 160 | +ManageSettings : True |
| 161 | +ReceiveCalls : True |
| 162 | +``` |
| 163 | + |
| 164 | +This example shows that [email protected] has simultaneous ringing set to his/her delegates (ForwardingTargetType). [email protected] is the only delegate (Delegates) and that user |
| 165 | +has all the permissions you can have as a delegate (Delegates). |
| 166 | + |
| 167 | +### Example 5 |
| 168 | +```powershell |
| 169 | +Get-CsUserCallingSettings -Identity [email protected] |
| 170 | +``` |
| 171 | +```output |
| 172 | + |
| 173 | +IsForwardingEnabled : False |
| 174 | +ForwardingType : Simultaneous |
| 175 | +ForwardingTarget : |
| 176 | +ForwardingTargetType : Voicemail |
| 177 | +ForwardingDelay : 00:00:00 |
| 178 | +IsUnansweredEnabled : True |
| 179 | +IsSafeForward : True |
| 180 | +UnansweredTarget : |
| 181 | +UnansweredTargetType : Voicemail |
| 182 | +UnansweredDelay : 00:00:20 |
| 183 | +Delegates : |
| 184 | + |
| 185 | +CallGroupOrder : InOrder |
| 186 | +CallGroupTargets : {} |
| 187 | +CallGroupDelay : |
| 188 | +GroupMembershipDetails : |
| 189 | +GroupNotificationOverride : Ring |
| 190 | +``` |
| 191 | +```powershell |
| 192 | +(Get-CsUserCallingSettings -Identity [email protected]).Delegators |
| 193 | +``` |
| 194 | +```output |
| 195 | + |
| 196 | +IsActive : True |
| 197 | +CreatedDate : 14-10-2021 09:46:56 |
| 198 | +MakeCalls : True |
| 199 | +ManageSettings : True |
| 200 | +ReceiveCalls : True |
| 201 | +``` |
| 202 | + |
| 203 | +This example shows that [email protected] is a delegate of [email protected] (Delegators) and that [email protected] has given [email protected] all the permissions you can have as a delegate (Delegators). |
| 204 | + |
| 205 | + |
| 206 | + |
| 207 | +## PARAMETERS |
| 208 | + |
| 209 | +### -Identity |
| 210 | +The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId, the SIP address |
| 211 | +or the e-mail address. |
| 212 | + |
| 213 | +```yaml |
| 214 | +Type: System.String |
| 215 | +Parameter Sets: (All) |
| 216 | +Aliases: |
| 217 | + |
| 218 | +Required: True |
| 219 | +Default value: None |
| 220 | +Accept pipeline input: False |
| 221 | +Accept wildcard characters: False |
| 222 | +``` |
| 223 | +
|
| 224 | +### CommonParameters |
| 225 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 226 | +
|
| 227 | +## INPUTS |
| 228 | +
|
| 229 | +### None |
| 230 | +
|
| 231 | +## OUTPUTS |
| 232 | +
|
| 233 | +### System.Object |
| 234 | +
|
| 235 | +## NOTES |
| 236 | +The cmdlet is available in Teams PowerShell module 2.6.1-preview or later. |
| 237 | +
|
| 238 | +You might see raw identities, i.e. ObjectId's, for identities used in the output. It is a known issue that we are working to fix. |
| 239 | +
|
| 240 | +## RELATED LINKS |
| 241 | +
|
0 commit comments