Set-CsHuntGroup

Updates a Call Queue in your Skype for Business Online organization.

Syntax

Set-CsHuntGroup
   -PrimaryUri <System.Uri>
   [-AgentAlertTime <Int16>]
   [-AllowOptOut <System.Boolean>]
   [-DistributionLists <System.Collections.Generic.List`1[System.Guid]>]
   [-LineUri <System.Uri>]
   [-MusicOnHoldFileContent <System.Byte[]>]
   [-MusicOnHoldFileName <System.String>]
   [-Name <System.String>]
   [-OverflowAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction>]
   [-OverflowActionTarget <System.Uri>]
   [-OverflowThreshold <Int16>]
   [-RoutingMethod <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod>]
   [-TimeoutAction <Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction>]
   [-TimeoutActionTarget <System.Uri>]
   [-TimeoutThreshold <Int16>]
   [-UseDefaultMusicOnHold <System.Boolean>]
   [-WelcomeMusicFileContent <System.Byte[]>]
   [-WelcomeMusicFileName <System.String>] 
   [<CommonParameters>]

Description

Set-CsHuntGroup cmdlet provides a way for you to modify the properties of an existing Call Queue; for example, you can change the phone number for the Call Queue, the distribution lists associated with the Call Queue, or the welcome audio file.

The Set-CsHuntGroup cmdlet may suggest additional steps required to complete the Call Queue setup.

The following parameters are not applicable to Skype for Business Online: AsJob, ClientAudience, DomainController, Force, HuntGroupServiceCallbackUri, and PipelineVariable

Examples

-------------------------- Example 1 --------------------------

Set-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -UseDefaultMusicOnHold $true

This example updates the Call Queue with primary uri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" by making it use the default music on hold.

-------------------------- Example 2 --------------------------

$musicOnHoldContent = Get-Content ".\MusicOnHold.wav" -ReadCount 0 -Encoding Byte
Set-CsHuntGroup -PrimaryUri "sip:hg_a82e2406b9b5474a9878e9659f32dbc3@litwareinc.com" -LineUri "tel:+19998881234" -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldFileName "MusicOnHold.wav" -MusicOnHoldFileContent $musicOnHoldContent

This example saves the contents of music on hold to a temporary variable. Then, it updates the Call Queue with new phone number, distribution lists, and the name and content of the music on hold file.

Required Parameters

-PrimaryUri

The PrimaryUri parameter represents the SIP address for the Call Queue. It must start with "sip:".

Type:System.Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

Optional Parameters

-AgentAlertTime

The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 30 and 180 seconds (3 minutes), inclusive.

Type:Int16
Position:Named
Default value:30
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-AllowOptOut

The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue.

Type:System.Boolean
Position:Named
Default value:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-AsJob

This parameter is reserved for Microsoft internal use only.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-BypassDualWrite

This parameter is reserved for Microsoft internal use only.

Type:System.Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ClientAudience

This parameter is reserved for Microsoft internal use only.

Type:System.String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Confirm

The Confirm switch causes the command to pause processing, and requires confirmation to proceed. This parameter is reserved for Microsoft internal use only.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-DistributionLists

The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue.

Type:System.Collections.Generic.List`1[System.Guid]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-DomainController

This parameter is reserved for Microsoft internal use only.

PARAMVALUE: Fqdn

Type:Object
Aliases:DC
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Force

This parameter is reserved for Microsoft internal use only.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-HuntGroupServiceCallbackUri

This parameter is reserved for Microsoft internal use only.

Type:System.Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-LineUri

The LineUri parameter is the phone number for the Call Queue. The line Uniform Resource Identifier (URI) must be specified by using the following format: the tel: prefix followed by a plus sign, followed by the country/region calling code, area code, and phone number (using only digits: no blank spaces, periods, or hyphens). For example: -LineUri "tel:+14255551219".

Type:System.Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-MusicOnHoldFileContent

The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the content of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified.

Type:System.Byte[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-MusicOnHoldFileName

The MusicOnHoldFileName parameter represents music to play when callers are placed on hold. This is the name of the audio file. Supported formats are: .wav, .mp3, and .wma. This parameter is required if the UseDefaultMusicOnHold parameter is not specified.

Type:System.String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Name

The Name parameter specifies a unique name for the Call Queue.

Type:System.String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-OverflowAction

The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following three values: DisconnectWithBusy, Forward, and Voicemail.

PARAMVALUE: DisconnectWithBusy | Forward | Voicemail

Type:Microsoft.Rtc.Management.Hosted.HuntGroup.Models.OverflowAction
Position:Named
Default value:DisconnectWithBusy
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-OverflowActionTarget

The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this parameter is optional.

Type:System.Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-OverflowThreshold

The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately.

Type:Int16
Position:Named
Default value:50
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-RoutingMethod

The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel.

PARAMVALUE: Attendant | Serial

Type:Microsoft.Rtc.Management.Hosted.HuntGroup.Models.RoutingMethod
Position:Named
Default value:Attendant
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Tenant

This parameter is reserved for Microsoft internal use only.

Type:System.Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TimeoutAction

The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following three values: Disconnect, Forward, and Voicemail. The default value is Disconnect.

PARAMVALUE: Disconnect | Forward | Voicemail

Type:Microsoft.Rtc.Management.Hosted.HuntGroup.Models.TimeoutAction
Position:Named
Default value:Disconnect
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TimeoutActionTarget

The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a SIP address. Otherwise, this field is optional.

Type:System.Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TimeoutThreshold

The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken.

Type:Int16
Position:Named
Default value:1200
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-UseDefaultMusicOnHold

The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldFileName and MusicOnHoldFileContent.

Type:System.Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-WelcomeMusicFileContent

The WelcomeMusicFileContent parameter represents the audio file to play when callers are connected with the Call Queue. This is the content of the audio file. Supported formats are: .wav, .mp3, .and wma.

Type:System.Byte[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-WelcomeMusicFileName

The WelcomeMusicFileName parameter represents audio file to play when callers are connected with the Call Queue. This is the name to the audio file. Supported formats are: .wav, .mp3, and .wma.

Type:System.String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-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. This parameter is reserved for Microsoft internal use only.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

Outputs

Microsoft.Rtc.Management.Hosted.HuntGroup.Models.HuntGroup