Set-CsUserCallForwardingSettings

  • Reference
Module:
SkypeForBusiness
Applies to:
Skype for Business Server 2019

This cmdlet modifies the specified user's call forwarding settings. This cmdlet returns the specified user's call forwarding settings as an object, and displays the same on the screen, in case of success. In case of failure, the appropriate error message is shown.

Syntax

Set-CsUserCallForwardingSettings
   [-DisableForwarding]
   [-SettingsActiveWorkHours]
   [-UnansweredToVoicemail]
   [-UnansweredToOther <String>]
   [-UnansweredWaitTime <Int32>]
   [-User] <String>
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CsUserCallForwardingSettings
   -EnableForwarding <String>
   [-SettingsActiveWorkHours]
   [-DelegateRingWaitTime <Int32>]
   [-Delegates <System.Management.Automation.PSListModifier`1[System.String]>]
   [-User] <String>
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CsUserCallForwardingSettings
   -EnableSimulRing <String>
   [-SettingsActiveWorkHours]
   [-UnansweredToVoicemail]
   [-UnansweredToOther <String>]
   [-UnansweredWaitTime <Int32>]
   [-TeamDelegateRingWaitTime <Int32>]
   [-Delegates <System.Management.Automation.PSListModifier`1[System.String]>]
   [-Team <System.Management.Automation.PSListModifier`1[System.String]>]
   [-User] <String>
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user.

The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below:

  • CsAdministrator - Get and Set for all cmdlets
  • CsVoiceAdministrator - Get and Set for all cmdlets
  • CsServerAdministrator - Get and Set for all cmdlets
  • CsHelpDesk - Get for all cmdlets

Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets.

Examples

Example 1

PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -DisableForwarding

This example disables the user's call forwarding settings.

Example 2

PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -EnableForwarding +4721956666

This example modifies the user's call forwarding settings, activating call forwarding to a specific phone number.

Example 3

PS C:\> Set-CsUserCallForwardingSettings -User user1@contoso.com -EnableSimulRing Team -Team user2@contoso.com,user2@contoso.com -TeamDelegateRingWaitTime 5

This example modifies the SimulRing settings, activating simultaneous ring for the users listed in the Team parameter.

Example 4

PS C:\> Set-CsUserCallForwardingSettings -User user@contoso.com -DisableForwarding -UnansweredToVoicemail -UnansweredWaitTime 30

This example sends unanswered calls to voicemail after 30 seconds.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-DelegateRingWaitTime

Specifies the time, in seconds, to wait before ringing delegates. Acceptable inputs: 0, 5, 10, 15. The parameter DelegateWaitRingTime needs to be explicitly set to a positive value to allow call forwarding to delegates.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-Delegates

Specifies the list of delegates that calls will be forwarded to. This parameter can only be used with EnableForwarding and EnableSimulRing parameters.

Type:System.Management.Automation.PSListModifier`1[System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-DisableForwarding

This is a switch parameter that disables forwarding. Cannot be used with the EnableSimulRing and EnableForwarding parameters.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-EnableForwarding

Enables forwarding to the specified destination. Cannot be used with the EnableSimulRing and DisableForwarding parameters.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-EnableSimulRing

This is a switch parameter that enables forwarding to the specified destination. Cannot be used along with the DisableForwarding and EnableForwarding parameters. SimulRingDestination can be a phone number, delegates, or team call group. Acceptable input formats: "<phone number>", Team, Delegates.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-SettingsActiveWorkHours

Switch parameter that specifies that settings should apply during work hours defined in Outlook. When this is not specified, settings apply all the time by default.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-Team

Specifies list of team members that calls will be forwarded to. The add and remove switches will add and remove specified users from the Team Members list. The replace parameter will set the list to the specified list, wiping out the previous list. Add and remove can be used together, but neither of them can be used along with replace. Acceptable input formats for add/remove/replace list: The inputs can be a single user address (in one of the below formats), or a comma separated list of user addresses, in the 4 standard formats that Identity parameter accepts.

Type:System.Management.Automation.PSListModifier`1[System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-TeamDelegateRingWaitTime

Specifies the time, in seconds, to wait before ringing team members.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-UnansweredToOther

Specifies that unanswered calls will be send to other user or phone number.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-UnansweredToVoicemail

Specifies that unanswered calls will be send to voicemail.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-UnansweredWaitTime

Specifies the time, in seconds, to wait before send unanswered calls to voicemail.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

-User

Specifies the SIP address of the user whose call forwarding settings will be modified.

Type:String
Aliases:DisplayName, SipAddress, Identity
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Skype for Business Server 2019CU1

Inputs

System.String

Outputs

System.Object