Retrieves information about the Response Group Service queues in use in your organization. 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
Get-CsRgsQueue -Identity <RgsIdentity> [-Name <String>] [-Tenant <Nullable>] |
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 GUID (globally unique identifier); 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 followed by the queue name. That enables you to retrieve a specific Response Group queue without having to know the GUID assigned to that queue. |
|
Name |
Optional |
String |
Unique name given to the Response Group queue at the time the queue was created. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running 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 a specific 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. Note that Get-CsRgsQueue can only return information from a single service at a time; that means that you won’t necessarily get back all of your Response Group queues by using just one. For example, if you have queues on ApplicationServer:atl-cs-001.litwareinc.com and on ApplicationServer:dublin-cs-001.litwareinc.com you will need to run separate commands to return the queues from both services.
Return Types
Get-CsRgsQueue returns 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 |
|
The command shown in Example 1 returns information about all the Response Group queues located on the service ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" |
|
In Example 2, information is returned for a single Response Group queue: the queue named Help Desk (-Name "Help Desk") located on the service ApplicationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty TimeoutAction |
|
The command shown in Example 2 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-CsRgsWorkflow 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, a property that happens to be an embedded object. When you expand the TimeoutAction property, you see the individual properties of that object: Prompt; TargetQuestion; Target; TargetQueueID; and TargetUri.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"}
|
|
The preceding command returns information about the response Group queues on ApplicationServer:atl-cs-001.litwareinc.com that have the OverflowCandidate property 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 ApplicationServer:atl-cs-001.litwareinc.com. That collection is then piped to the Where-Object cmdlet, which selects only those queues where the OverflowCandidate property is equal to (-eq) NewestCall.