Returns information about configuration settings for the Response Group application.
Syntax
Get-CsRgsConfiguration -Identity <RgsIdentity> [-Tenant <Nullable>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Rgs Identity |
Name of the service hosting the Response Group configuration settings; for example: -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com". If you do not include this parameter Get-CsRgsConfiguration will prompt you to supply an Identity. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
Detailed Description
The Response Group application provides a way for you to automatically route phone calls to entities such as a help desk or customer support line. When someone calls a designated phone number, that call can be automatically routed to the appropriate set of Response Group Service agents. Alternatively, the call might be routed to an Interactive Voice Response (IVR) queue. In that queue, the caller would be asked a series of questions ("Are you calling about an existing order?") and then, based on the answers to those questions, either be given the asked-for information or be routed to a Response Group queue.
The Get-CsRgsConfiguration cmdlet provides a way for you to return information about how the Response Group application has been configured. Note that this cmdlet can only return information from one instance of the Response Group application at a time. For example, if you have separate installations of the Response Group application – one on ApplicationServer:atl-cs-001.litwareinc.com and one on ApplicationServer:dublin-cs-001.litwareinc.com – you will need to make separate calls to Get-CsRgsConfiguration in order to return information for each of these Response Group instances.
Return Types
Get-CsRgsConfiguration returns instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" |
|
Example 1 returns the Response Group Service configuration settings for the service ApplicationServer:atl-cs-001.litwareinc.com. Because there can only be one collection of settings per service, this command will never return more than a single item.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
(Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com ").DisableCallContext |
|
The preceding command returns the value of a single property -- DisableCallContext -- for the Response Group configuration settings found on the service Redmond-ApplicationServer-1. To accomplish this task, Get-CsRgsConfiguration is first used to retrieve all the property values for the Response Group configuration settings for ApplicationServer:atl-cs-001.litwareinc.com. Note that this command is enclosed in parentheses; that ensures that Windows PowerShell returns all the property values before doing anything else.
After all the property values have been returned, standard "dot notation" is used to display the value of the property DisableCallContext (and only the value of that property). Standard dot notation consists of the object followed by a period (dot) followed by the name of the property to be displayed. For example, to display the value of the AgentRingbackGracePeriod property (and only the value of that property) you can use this command:
(Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com").AgentRingbackGracePeriod.