Creates a new Response Group workflow. Workflows determine the actions that are taken when the Response Group application receives a phone call.
Syntax
New-CsRgsWorkflow -Parent <RgsIdentity> -Name <String> -PrimaryUri <Uri> [-Active <$true | $false>] [-Anonymized <$true | $false>] [-BusinessHoursAction <CallAction>] [-BusinessHoursId <Nullable>] [-CustomMusicOnHold <AudioFile>] [-Description <String>] [-DisplayNumber <String>] [-EnabledForFederation <$true | $false>] [-HolidayAction <CallAction>] [-HolidaySetsId <Collection>] [-InMemory <SwitchParameter>] [-Language <String>] [-LineUri <Uri>] [-NextTarget <CallAction>] [-Tenant <Nullable>] [-Timezone <String>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Parent |
Required |
Rgs Identity |
Service where the new workflow will be hosted. For example: -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com". |
|
Name |
Required |
String |
Unique name to be assigned to the workflow. The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow GUID (globally unique identifier). |
|
Description |
Optional |
String |
Enables administrators to add additional information about a Response Group workflow. For example, the Description might include contact information for the owner of the workflow. |
|
PrimaryUri |
Required |
SIP address |
SIP address for the workflow. For example: sip:helpdesk@litwareinc.com |
|
DisplayNumber |
Optional |
String |
Phone number for the workflow as displayed in Microsoft Communicator. The DisplayNumber can formatted any way you wish; for example: -DisplayNumber "555-1219" -DisplayNumber "1-(425)-555-1219" -DisplayNumber "1.425.555.1219" |
|
LineUri |
Optional |
String |
Phone number for the workflow. The line URI must be specified using the following format: the TEL: prefix followed by a plus sign, followed by the country code, area code, and phone number (using only digits: no blank spaces, periods, hyphens, etc.). For example: -LineUri "TEL:+14255551219" |
|
Active |
Optional |
Boolean |
If set to True, this means that the workflow is active and available to take phone calls. If set to False, the workflow is not available to take phone calls. |
|
EnabledForFederation |
Optional |
Boolean |
Indicates whether the workflow is available to users from a federated domain. If set to False, only users within your organization will have access to the workflow. |
|
Language |
Optional |
Integer |
Language that used to read workflow text-to-speech prompts. The language must be specified using one of the following language codes: ca-Es – Catalan (Catalan) da-DK – Danish (Denmark) de-DE – German (Germany) en-AU – English (Australia) en-CA – English (Canada) en-GB – English (United Kingdom) en-IN – English (India0 en-US – English (US) es-ES – Spanish (Spain) es-MX – Spanish (Mexico) fi-FI – Finnish (Finland) fr-CA – French (Canada) fr-FR – French (France) it-IT – Italian (Italy) ja-JP – Japanese (Japan) ko-KR – Korean (Korea) nb-NO – Norwegian, Bokmal (Norway) nl-NL – Dutch (Netherlands) pl-PL – Polish (Poland) pt-BR – Portuguese (Brazil) pt-PT – Portuguese (Portugal) ru-RU – Russian (Russia) sv-SE – Swedish (Sweden) zh-CN – Chinese (People’s Republic of China) zh-HK – Chinese (Hong Kong SAR) zh-TW – Chinese (Taiwan) For example: -Language "nl-NL". |
|
TimeZone |
Optional |
String |
Time zone information used when determining holidays and business hours. For example: -TimeZone "Pacific Standard Time" |
|
BusinessHoursID |
Optional |
BusinessHours object |
Days of the week and times of the day that workflow agents are available to answer calls. The BusinessHoursID is best retrieved by using the Get-CsRgsBusinessHours cmdlet. |
|
BusinessHoursAction |
Optional |
CallAction object |
Action to be taken if a call is received outside the workflow’s business hours. The BusinessHoursAction must be defined using the New-CsRgsCallAction cmdlet. |
|
HolidaySetsId |
Optional |
HolidaySet object |
Represents holidays when workflow agents are not available to answer calls. The HolidaySetsID is best retrieved by using the Get-CsRgsHolidaySet cmdlet. |
|
HolidayAction |
Optional |
CallAction object |
Action to be taken if a call is received on a holiday. The HolidayAction must be defined using the New-CsRgsCallAction cmdlet. |
|
CustomMusicOnHold |
Optional |
AudioFile object |
Represents custom music to be played when callers are placed on hold. (If not defined, callers will hear the default music when placed on hold.) Custom music must be imported using the Import-CsRgsAudioFile cmdlet. |
|
Anonymized |
Optional |
Boolean |
If set to True, the identities of individual Response Group agents will be masked any time these agents answer a call. If set to False, agent identities will be available to callers. |
|
NextTarget |
Required |
CallAction object |
Indicates the action to be taken if a call goes unanswered. NextTarget must be defined by using the New-CsRgsCallAction cmdlet. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
Detailed Description
Workflows are perhaps the key element in the Response Group application. Each workflow is uniquely associated with a phone number; when someone calls that number, the workflow determines how the call will be handled. For example, the call might be routed to a series of Interactive Voice Response questions that prompt the caller to enter additional information ("Press 1 for hardware support. Press 2 for software support.") Alternatively, the call might be placed in a queue and the caller placed on hold until an agent is available to answer the call. The availability of agents to answer calls is also dictated by the workflow: workflows are used to configure business hours (the days of the week and the times of day when agents are available to answer calls) as well as holidays (days when no agents are available to answer calls).
New workflows are created using the New-CsRgsWorkflow cmdlet.
Return Types
New-CsRgsWorkflow creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object.
Examples
-------------------------- Example 1 ------------------------Add code example
 Copy Code |
|
|---|---|
New-CsRgsWorkflow -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com" |
|
The preceding command creates a new workflow on the service ApplicationServer:atl-cs-001.litwareinc.com. This workflow is given the Name Help Desk and is assigned a primary URI of sip:helpdesk@litwareinc.com
-------------------------- Example 2 ------------------------Add code example
| Copy Code |
|
|---|---|
$prompt = New-CsRgsWorkflowPrompt -PromptTts "Welcome to the help desk." $queue = (Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk").Identity $callAction = New-CsRgsCallAction -Prompt $prompt -Target TransferToQueue -TargetQueueId $queue New-CsRgsWorkflow -Parent service:Redmond-ApplicationServer-1 -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com" -NextTarget $callAction |
|
The command shown in example 2 create a new workflow prompt and call action, then assign those new items to a new Response Group workflow. In the first command, the New-CsWorkflowPrompt cmdlet is used to create a text-to-speech prompt “Welcome to the help desk.” This new prompt is stored in a variable named $prompt.
The second command uses the Get-CsRgsQueue cmdlet to retrieve the Identity of an existing Response Group queue named Help Desk Queue; the returned Identity is stored in a variable named $queue.
Command 3 then creates a new call action (stored in a variable named $callAction) that references both the new prompt ($prompt) and the retrieved queue ($queue). Finally, the last command in the example creates a new workflow named Help Desk; this workflow has a PrimaryUri of sip:helpdesk@litwareinc,com and sets the value of the NextTarget property to the call action created in the previous steps.