Get-CsRgsQueue
Topic Last Modified: 2012-03-23
Retrieves information about the Response Group queues in use in your organization. With the Response Group application, phone calls are put in a queue and calls are placed on hold until a Response Group agent is available to answer that call.
Syntax
Get-CsRgsQueue [-Identity <RgsIdentity>] [-Name <String>]
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 a Response Group 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 Response Group 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 Get-CsRgsQueue cmdlet provides a way for you to return information about the Response Group queues configured for use in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsRgsQueue cmdlet locally: RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsRgsQueue"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Rgs Identity |
Represents either the Identity of the service where the Response Group queue is hosted or the full Identity of the queue itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group queues hosted on that service will be returned. If you specify the Identity of the queue, then only the specified Response Group queue will be returned. Note that the Identity of a queue consists of the service Identity followed by a globally unique identifier (GUID); for example: service:ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83. An alternate way to return a single Response Group queue is to specify the service Identity, then include the Name parameter and the queue name. That enables you to retrieve a specific Response Group queue without having to know the GUID assigned to that queue. If called without any parameters, Get-CsRgsQueue returns all the Response Group queues configured for use in your organization. |
Name |
Optional |
String |
Unique name given to the Response Group queue at the time the queue was created. |
Input Types
String. Get-CsRgsQueue accepts a string value representing the Identity of the Response Group queue.
Return Types
Get-CsRgsQueue returns instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object.
Example
-------------------------- Example 1 ------------------------
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com
The preceding command returns information about all the Response Group queues configured for use in the organization. This is done by calling Get-CsRgsQueue without any parameters.
-------------------------- Example 2 ------------------------
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com
The command shown in Example 2 returns information about all the Response Group queues located on the service ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 3 ------------------------
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk"
In Example 3, information is returned for a single Response Group queue: the queue named "Help Desk" located on the service ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 4 ------------------------
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty TimeoutAction
The command shown in Example 4 displays detailed information about the TimeoutAction property for each Response Group queue found on the service ApplicationServer:atl-cs-001.litwareinc.com. To carry out this task, Get-CsRgsQueue is first used to return information about all the queues found on ApplicationServer:atl-cs-001.litwareinc.com. This information is then passed to the Select-Object cmdlet, which "expands" the value stored in the TimeoutAction property. When you expand the TimeoutAction property, you see the individual properties of the embedded object that make up the property value: Prompt; TargetQuestion; Target; TargetQueueID; and TargetUri.
-------------------------- Example 5 ------------------------
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"}
The preceding command returns information about all the Response Group queues on ApplicationServer:atl-cs-001.litwareinc.com where the OverflowCandidate property is set to NewestCall. To accomplish this task, the command first uses Get-CsRgsQueue to return a collection of all the Response Group queues found on the specified service. That collection is then piped to the Where-Object cmdlet, which selects only those queues where the OverflowCandidate property is equal to "NewestCall".