New-CsHuntGroup

 

Topic Last Modified: 2017-02-22

Use the New-CsHuntGroup cmdlet to create a new call queue.

New-CsHuntGroup -Domain <String> -LineUri <Uri> -Name <String> [-AgentAlertTime <Int16>] [-DistributionLists <List>] [-MusicOnHoldFileContent <Byte[]>] [-MusicOnHoldFileName <String>] [-OverflowAction <DisconnectWithBusy | Forward | Voicemail>] [-OverflowActionTarget <Uri>] [-OverflowThreshold <Int16>] [-TimeoutAction <Disconnect | Forward | Voicemail>] [-TimeoutActionTarget <Uri>] [-TimeoutThreshold <Int16>] [-UseDefaultMusicOnHold <$true | $false>] [-WelcomeMusicFileContent <Byte[]>] [-WelcomeMusicFileName <String>]

This example creates a new call queue that is called "Contoso helpdesk." If the call is not answered in 40 seconds, it is routed to another agent. Two distribution lists (DistList1 and DistList2) are added to the call queue. If the caller is placed on hold, the music contained in the moh.wav file is played. If too many calls are incoming at once, the call is forwarded. If the call is on hold for 5 minutes, it is forwarded.

New-CsHuntGroup -Name "Contoso helpdesk" -AgentAlertTime 40 -DistributionLists "DistList1", "DistList2" -MusicOnHoldFileName "moh.wav"  -OverflowAction Forward OverflowActionTarget "sip:helpdesk2@litwareinc.com" -OverflowThreshold 100 -TimeoutAction Forward -TimeoutActionTarget "tel:+12345678" -TimeoutThreshold 5 -WelcomeMusicFileName "welcome.wav"

Call queues are a key element in the Cloud PBX application. Each call queue is uniquely associated with a phone number; when someone calls that number, the call queue determines how the call is handled. For example, the caller might hear a welcome message upon connecting to a call, and hear music when the call is placed in a queue to be matched with an agent.

When you create a new call queue, a PrimaryUri is generated that is based on the call queue name.

NoteNote:
After a call queue is created with one or more distribution lists, the members in the distribution lists appear in the call queue after the expansion service starts.

 

Parameter Required Type Description

Domain

Required

System.String

The Domain parameter denotes the domain part of the primary uri for the call queue. This domain name is validated against the list of domains that the tenant owns.

LineUri

Required

System.Uri

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".

Name

Required

System.String

The Name parameter specifies a unique name for the call queue.

AgentAlertTime

Optional

System.Int16

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. The default value is 30 seconds.

DistributionLists

Optional

System.Collections.Generic.List

The DistributionLists parameter lets you add all the members of the distribution lists to the call queue. This is a list of distribution list GUID. 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 not supported. If a DL has nested DLs, the parent DL is ignored.

MusicOnHoldFileContent

Optional

System.Byte[]

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.

MusicOnHoldFileName

Optional

System.String

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.

OverflowAction

Optional

Microsoft.Rtc.Management.Hosted.HuntGroup.Models.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

  • Voicemail

The default value is DisconnectWithBusy.

OverflowActionTarget

Optional

System.Uri

The OverflowActionTarget parameter represents the target of the overflow action. For example, if the OverFlowAction is set to Forward, this parameter might be set to a SIP address or a PSTN phone number.

This parameter is optional unless the OverflowAction is set to Forward, which requires either a SIP address or a PSTN phone number.

OverflowThreshold

Optional

System.Int16

The OverflowThreshold parameter defines the number of simultaneous 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. The default value is 50. A value of 0 causes the overflow action to be taken immediately.

TimeoutAction

Optional

Microsoft.Rtc.Management.Hosted.HuntGroup.Models.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

  • Voicemail

The default value is Disconnect. In MVP1, the busy tone might not be played before disconnecting.

TimeoutActionTarget

Optional

System.Uri

The TimeoutActionTarget represents the target of the timeout action. For example, if the TimeoutAction is set to Forward, this parameter might be set to a SIP address or a PSTN phone number.

This field is optional unless the TimeoutAction is set to Forward, which requires either a SIP address or a PSTN phone number.

TimeoutThreshold

Optional

System.Int16

The TimeoutThreshold parameter defines the time (in minutes) 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 TimeoutAction can be any integer value between 0 and 45 minutes, inclusive; the default value is 20 minutes.

UseDefaultMusicOnHold

Optional

System.Boolean

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

WelcomeMusicFileContent

Optional

System.Byte[]

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.

WelcomeMusicFileName

Optional

System.String

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

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

WhatIf

Optional

System.Management.Automation.SwitchParameter

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.

The New-CsHuntGroup cmdlet creates new instances of the Microsoft.Skype.Rgs.Configuration.HuntGroup object.

 
Show: