[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Creates a new Response Group queue. With the Response Group application, phone calls are put in a queue and callers are placed on hold until an agent is available to answer that call.

Syntax

New-CsRgsQueue -Parent <RgsIdentity> -Name <String> [-AgentGroupsId <Collection>] [-Description <String>] [-InMemory <SwitchParameter>] [-OverflowAction <CallAction>] [-OverflowCandidate <NewestCall | OldestCall>] [-OverflowThreshold <Nullable>] [-Tenant <Nullable>] [-TimeoutAction <CallAction>] [-TimeoutThreshold <Nullable>]

Parameters

Parameter Required Type Description

Parent

Required

Rgs Identity

Service where the new queue will be hosted. For example: -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".

Name

Required

String

Unique name to be assigned to the queue. The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue’s GUID (globally unique identifier).

Description

Optional

String

Enables administrators to provide additional, explanatory information about the Response Group queue. For example, the Description might contain information about who to contact should the queue not work as expected.

TimeoutThreshold

Optional

Integer

Amount of time (in seconds) that a call can be in the queue before the call times out. At that point, the system will take the action specified by the TimeoutAction parameter.

The timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out.

TimeoutAction

Optional

CallAction object

Action to be taken if the timeout threshold is reached. The TimeoutAction must be created using the New-CsRgsCallAction cmdlet.

OverflowThreshold

Optional

Integer

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 1000, inclusive. The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time.

OverflowAction

Optional

CallAction object

Action to be taken if the overflow threshold is reached. The OverflowAction must be created using the New-CsRgsCallAction cmdlet.

OverflowCandidate

Optional

PS List Modifier

Indicates which call will be acted upon should the overflow threshold be reached. The OverflowCandidate property must be set to one of the following two values:

NewestCall

OldestCall

The default value is OldestCall.

AgentGroupsId

Optional

AgentGroup collection

Identity of the Response Group agent groups to be added to the queue. The agent group identities are best retrieved using the Get-CsRgsAgentGroup cmdlet; see the Examples section for more information.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

InMemory

Optional

Switch Parameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.

Detailed Description

When someone calls a phone number associated with the Response Group application one of two things typically happens: either the call is transferred to a question that the caller must answer in order to continue (for example, "Press 1 for hardware support; press 2 for software support") or the call is placed in a queue until an agent is available to answer the call.

Instead of having a single queue for all phone calls, the Response Group application enables you to create multiple queues that can be associated with different workflows and different agent groups. In turn, this means queues can respond differently to events such as a designated number of calls being simultaneously held in the queue, or to callers that have been on hold for a specified number of seconds.

The New-CsRgsQueue cmdlet provides an easy way for administrators to create new Response Group queues.

Return Types

New-CsRgsQueue creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object.

Examples

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

Copy Code
New-CsRgsQueue -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -OverflowCandidate "OldestCall"

Example 1 creates a new Response Group queue for the service ApplicationServer:atl-cs-001.litwareinc.com. This queue has the name Help Desk (-Name "Help Desk") and has been configured to use the oldest call as the overflow candidate (-OverflowCandidate "OldestCall"). To create the queue, the command uses the New-CsRgsQueue cmdlet, and includes the -Parent, -Name, and -OverflowCandidate parameters.