Deletes an existing 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
Remove-CsRgsQueue -Identity <RgsIdentity> [-Confirm [<SwitchParameter>]] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Rgs Identity |
Unique identifier for the queue to be removed. The Identity of a Response Group queue consists of the location of the service where the queue is hosted plus a globally unique identifier (GUID). That means that a Response Group queue will have an Identity similar to this: service:ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83. Because GUIDs are difficult to remember, and to work with, the Examples section demonstrates alternate ways that you can identify the queue to be removed. |
|
Force |
Optional |
Switch Parameter |
Forces the deletion of a Response Group queue. If this parameter is present, the queue will be deleted without warning, even if it is assigned to an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any queue currently being used by an active workflow. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
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 specified number of seconds.
In addition to creating new queues you can also remove existing queues; that’s what the Remove-CsRgsQueue cmdlet is for. Note that, by default, you will be prompted if you try to remove a queue that is currently assigned to an active workflow; that prompt will ask you to verify that you want to delete the queue, and PowerShell will pause (and no queue will be deleted) until you answer the prompt. To bypass the prompt, and to delete queues that are being used by an active workflow, add the –Force parameter. For example:
Get-CsRgsQueue –Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Remove-CsRgsQueue –Force.
Return Types
Remove-CsRgsQueue deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsQueue |
|
The command shown in Example 1 deletes all the Response Group queues found on the service ApplicationServer:atl-cs-001.litwareinc.com. To carry out this task, the command first uses Get-CsRgsQueue to return a collection of all the queues found on ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to Remove-CsRgsQueue, which deletes each queue in the collection.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" | Remove-CsRgsQueue |
|
In Example 2, a single Response Group Service queue is deleted: the queue named "Help Desk Queue", which is located on the service ApplicationServer:atl-cs-001.litwareinc.com. To delete this queue, Get-CsRgsQueue is called along with the -Identity and -Name parameters; the single queue returned by this call is then piped to, and deleted by, Remove-CsRgsQueue.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"} | Remove-CsRgsQueue
|
|
The preceding command deletes all the Response Group queues found on the service ApplicationServer:atl-cs-001.litwareinc.com, provided those queues have ab OverflowCandidate property set to NewestCall. To carry out this task, Get-CsRgsQueue is first called in order to return a collection of all the Response Group queues found on ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to the Where-Object cmdlet, which selects only those queue where the OverflowCandidate property is equal to (-eq) NewestCall. The filtered collection is then piped to Remove-CsRgsQueue, which deletes each queue in the collection.