[Index]

Model: device/skypeforbusinesshybrid/CsRgsWorkflow

Model Details

Title Description Details
DisplayNumber Phone number for the workflow as displayed in Skype for Business. The DisplayNumber can be formatted any way you want; for example: -DisplayNumber "555-1219" -DisplayNumber "1-(425)-555-1219" -DisplayNumber "1.425.555.1219"
  • Field Name: DisplayNumber
  • Type: String
TimeZone Time zone information used when determining holidays and business hours. For example: -TimeZone "Pacific Standard Time"
  • Field Name: TimeZone
  • Type: String
Name * 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's globally unique identifier (GUID).
  • Field Name: Name
  • Type: String
OwnerPool
  • Field Name: OwnerPool
  • Type: String
Parent * Service where the new workflow will be hosted. For example: -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".
  • Field Name: Parent
  • Type: String
HolidaySetIDList Represents days when workflow agents are not available to answer calls. The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet.
  • Field Name: HolidaySetIDList
  • Type: String
Anonymous 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 (the default value), agent identities will be available to callers.
  • Field Name: Anonymous
  • Type: Boolean
Active If set to True, this means that the workflow is active and available to take phone calls. If set to False (the default value), the workflow is not available to take phone calls. When the Active property is set to True then the workflow will be validated before it is created. For example, the workflow will not be created if a DefaultAction has not been specified. If Active is set to False (or not configured) then no validation will take place, and the workflow will be created even if a DefaultAction has not been specified.
  • Field Name: Active
  • Type: Boolean
Identity Represents either the Identity of the service where the Response Group workflow is hosted or the full Identity of the workflow itself. If you specify the service Identity (for example, service: ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group workflows hosted on that service will be returned. If you specify the Identity of the workflow, then only that one Response Group workflow will be returned. Note that the Identity of a workflow 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 workflow is to specify the service Identity, then include the Name parameter and the workflow name. That enables you to retrieve a specific workflow without having to know the GUID assigned to that workflow. If called without any parameters, Get-CsRgsWorkflow returns a collection of all the workflows configured for use in your organization.
  • Field Name: Identity
  • Type: String
NonBusinessHoursAction Action to be taken if a call is received outside the workflow's business hours. The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet.
  • Field Name: NonBusinessHoursAction
  • Type: Object
Action
  • Field Name: NonBusinessHoursAction.Action
  • Type: String
  • Choices: ["The call is terminated", "The call is transferred to a Response Group queue", "The call is transferred to a Response Group question", "The call is transferred to the specified SIP Uniform Resource Identifier ", "The call is transferred to a public switched telephone network (PSTN) telephone"]
Question
  • Field Name: NonBusinessHoursAction.Question
  • Type: String
Prompt
  • Field Name: Prompt
  • Type: Object
TextToSpeechPrompt
  • Field Name: NonBusinessHoursAction.Prompt.TextToSpeechPrompt
  • Type: String
AudioFilePrompt
  • Field Name: NonBusinessHoursAction.Prompt.AudioFilePrompt
  • Type: String
Uri
  • Field Name: NonBusinessHoursAction.Uri
  • Type: String
QueueID
  • Field Name: NonBusinessHoursAction.QueueID
  • Type: String
  • Target: device/skypeforbusinesshybrid/CsRgsQueue
  • Target attr: Identity
  • Format: uri
CustomMusicOnHoldFile 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 by using the Import-CsRgsAudioFile cmdlet.
  • Field Name: CustomMusicOnHoldFile
  • Type: String
Language Language that is used to read workflow text-to-speech prompts. The language parameter is optional as long as the operating system is using one of the supported languages shown in the list below. (Note that supported speech languages represent a subset of the languages that can be used on the operating system.) If the operating system is not using a supported language, then the Language parameter becomes mandatory, and the parameter must specify the language code for a supported language. If your operating system is using a non-supported language on the operating system, and you run the New-CsRgsWorkflow cmdlet without including the Language parameter, your command will fail. For example, suppose your operating system is running under the Faroese language. This language is supported by the Windows operating system, but not by the Response Group application. Therefore, you must include the Language parameter and a supported language when creating a new workflow. This is required because, if no language is specified, the workflow uses the operating system language. However, that language can be used in a workflow only if it is a language supported by the Response Group application. The language must be specified using one of the following language codes: ca-ES - Catalan (Spain) da-DK - Danish (Denmark) de-DE - German (Germany) en-AU - English (Australia) en-CA - English (Canada) en-GB - English (United Kingdom) en-IN - English (India) en-US - English (United States) 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".
  • Field Name: Language
  • Type: String
EnabledForFederation 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.
  • Field Name: EnabledForFederation
  • Type: Boolean
ManagersByUri SIP addresses of the user (or users) who will manage the workflow. For example: -ManagedByUri "sip:[email protected]" To specify multiple managers separate the manager SIP addresses by using commas: -ManagedByUri "sip:[email protected]", "sip:[email protected]"
  • Field Name: ManagersByUri
  • Type: String
DefaultAction Indicates the action to be taken when a workflow is opened during business hours. DefaultAction must be defined by using the New-CsRgsCallAction cmdlet, and must either direct the call to a queue or to a question. The DefaultAction parameter is mandatory if the workflow is active, but can be omitted if the workflow is inactive.
  • Field Name: DefaultAction
  • Type: Object
Action
  • Field Name: DefaultAction.Action
  • Type: String
  • Choices: ["The call is terminated", "The call is transferred to a Response Group queue", "The call is transferred to a Response Group question", "The call is transferred to the specified SIP Uniform Resource Identifier ", "The call is transferred to a public switched telephone network (PSTN) telephone"]
Question
  • Field Name: DefaultAction.Question
  • Type: String
Prompt
  • Field Name: Prompt
  • Type: Object
TextToSpeechPrompt
  • Field Name: DefaultAction.Prompt.TextToSpeechPrompt
  • Type: String
AudioFilePrompt
  • Field Name: DefaultAction.Prompt.AudioFilePrompt
  • Type: String
Uri
  • Field Name: DefaultAction.Uri
  • Type: String
QueueID
  • Field Name: DefaultAction.QueueID
  • Type: String
  • Target: device/skypeforbusinesshybrid/CsRgsQueue
  • Target attr: Identity
  • Format: uri
LineUri Phone number for the workflow. The line Uniform Resource Identifier (URI) must be specified by using the following format: the TEL: prefix followed by a plus sign, followed by the country/region calling code, area code, and phone number (using only digits: no blank spaces, periods, or hyphens). For example: -LineUri "TEL:+14255551219"
  • Field Name: LineUri
  • Type: String
Description 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. This description appears in the Skype for Business contact card for the workflow.
  • Field Name: Description
  • Type: String
InMemory 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>.
  • Field Name: InMemory
  • Type: Boolean
BusinessHoursID Days of the week and times of the day that workflow agents are available to answer calls. The business hour Identities can be retrieved by using the Get-CsRgsHoursOfBusiness cmdlet.
  • Field Name: BusinessHoursID
  • Type: String
  • Target: device/skypeforbusinesshybrid/CsRgsHoursOfBusiness
  • Target attr: Identity
  • Format: uri
Managed When set to True indicates that the workflow will be managed by one or more users. Those users can be specified by using the ManagedByUri parameter.
  • Field Name: Managed
  • Type: Boolean
PrimaryUri * SIP address for the workflow. For example: -PrimaryUri "sip:[email protected]". The PrimaryUri must begin with the "sip:" prefix.
  • Field Name: PrimaryUri
  • Type: String
HolidayAction Action to be taken if a call is received on a holiday. The HolidayAction must be defined by using the New-CsRgsCallAction cmdlet.
  • Field Name: HolidayAction
  • Type: Object
Action
  • Field Name: HolidayAction.Action
  • Type: String
  • Choices: ["The call is terminated", "The call is transferred to a Response Group queue", "The call is transferred to a Response Group question", "The call is transferred to the specified SIP Uniform Resource Identifier ", "The call is transferred to a public switched telephone network (PSTN) telephone"]
Question
  • Field Name: HolidayAction.Question
  • Type: String
Prompt
  • Field Name: Prompt
  • Type: Object
TextToSpeechPrompt
  • Field Name: HolidayAction.Prompt.TextToSpeechPrompt
  • Type: String
AudioFilePrompt
  • Field Name: HolidayAction.Prompt.AudioFilePrompt
  • Type: String
Uri
  • Field Name: HolidayAction.Uri
  • Type: String
QueueID
  • Field Name: HolidayAction.QueueID
  • Type: String
  • Target: device/skypeforbusinesshybrid/CsRgsQueue
  • Target attr: Identity
  • Format: uri
API reference for device/skypeforbusinesshybrid/CsRgsWorkflow