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

Modifies configuration settings for the Response Group application.


Set-CsRgsConfiguration -Identity <RgsIdentity> [-AgentRingbackGracePeriod <Int16>] [-Confirm [<SwitchParameter>]] [-DefaultMusicOnHold <AudioFile>] [-DisableCallContext <$true | $false>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]
Set-CsRgsConfiguration -Instance <ServiceSettings> [-Confirm [<SwitchParameter>]] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Name of the service hosting the Response Group configuration settings. For example: -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com."



ServiceSettings object

Object reference to the Response Group configuration settings to be modified. An object reference is typically retrieved by using the Get-CsRgsConfiguration cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com and stores that object reference in a variable named $x:

$x = Get-CsRgsConfiguration -Identity service:ApplicationServer:atl-cs-001.litwareinc.com




If an agent declines a call, the AgentRingbackGracePeriod represents the amount of time (in seconds) that can elapse before the call returns to the same agent. The grace period can be set to any integer value between 30 and 600 seconds (10 minutes), inclusive. The default value is 60 seconds.



AudioFile object

Represents the music that, by default, will be played any time a caller is placed on hold. The default music will play only if a Response Group workflow has not defined its own music on hold.

The DefaultMusicOnHold property must be configured using an object reference created via the Import-CsRgsAudioFile cmdlet.



Switch Parameter

If set to False (the default value) each agent is able to see the call context (information such as caller wait time as well as workflow questions and answers) any time a call received. (This information is visible from within Microsoft Communicator.) If set to True, call context information is not relayed to agents when a call is received.



Switch Parameter

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


Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing 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 a set of 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, be given the asked-for information or be routed to a Response Group agent.

The Set-CsRgsConfiguration cmdlet provides a way for you to modify the properties of a Response Group application instance.

Return Types

Set-CsRgsConfiguration does not return any objects or values. Instead, the cmdlet configures existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object.


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

Copy Code
Set-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -AgentRingbackGracePeriod 30

The command shown in Example 1 modifies the AgentRingbackGracePeriod property for the Response Group Service configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com. In this example, AgentRingbackGracePeriod is set to 30 seconds.