Set-CsCallQueue

Syntax

Default (Default)

Set-CsCallQueue
 -Identity <Guid>
 [-AgentAlertTime <Int16>]
 [-AllowOptOut <Boolean>]
 [-ChannelId <Guid>]
 [-ChannelUserObjectId <Guid>]
 [-ShiftsTeamId <String>]
 [-ShiftsSchedulingGroupId <String>]
 [-DistributionLists <List>]
 [-MusicOnHoldAudioFileId <Guid>]
 [-Name <String>]
 [-OboResourceAccountIds <List>]
 [-OverflowAction <Object>]
 [-OverflowActionTarget <Guid>]
 [-OverflowActionCallPriority <Int16>]
 [-OverflowThreshold <Int16>]
 [-RoutingMethod <Object>]
 [-TimeoutAction <Object>]
 [-Tenant <Guid>]
 [-TimeoutActionTarget <Guid>]
 [-TimeoutActionCallPriority <Int16>]
 [-TimeoutThreshold <Int16>]
 [-NoAgentApplyTo <String>]
 [-NoAgentAction <Object>]
 [-NoAgentActionTarget <Guid>]
 [-NoAgentActionCallPriority <Int16>]
 [-UseDefaultMusicOnHold <Boolean>]
 [-WelcomeMusicAudioFileId <Guid>]
 [-PresenceBasedRouting <Boolean>]
 [-ConferenceMode <Boolean>]
 [-Users <List>]
 [-LanguageId <String>]
 [-LineUri <String>]
 [-OverflowRedirectPersonTextToSpeechPrompt <String>]
 [-OverflowRedirectPersonAudioFilePrompt <Guid>]
 [-OverflowRedirectVoiceAppTextToSpeechPrompt <String>]
 [-OverflowRedirectVoiceAppAudioFilePrompt <Guid>]
 [-OverflowRedirectPhoneNumberTextToSpeechPrompt <String>]
 [-OverflowRedirectPhoneNumberAudioFilePrompt <Guid>]
 [-OverflowRedirectVoicemailTextToSpeechPrompt <String>]
 [-OverflowRedirectVoicemailAudioFilePrompt <Guid>]
 [-OverflowSharedVoicemailTextToSpeechPrompt <String>]
 [-OverflowSharedVoicemailAudioFilePrompt <Guid>]
 [-EnableOverflowSharedVoicemailTranscription <Boolean>]
 [-EnableOverflowSharedVoicemailSystemPromptSuppression <Boolean>]
 [-TimeoutRedirectPersonTextToSpeechPrompt <String>]
 [-TimeoutRedirectPersonAudioFilePrompt <Guid>]
 [-TimeoutRedirectVoiceAppTextToSpeechPrompt <String>]
 [-TimeoutRedirectVoiceAppAudioFilePrompt <Guid>]
 [-TimeoutRedirectVoicemailTextToSpeechPrompt <String>]
 [-TimeoutRedirectVoicemailAudioFilePrompt <Guid>]
 [-TimeoutSharedVoicemailTextToSpeechPrompt <String>]
 [-TimeoutSharedVoicemailAudioFilePrompt <Guid>]
 [-TimeoutSharedVoicemailTextToSpeechPrompt <String>]
 [-TimeoutSharedVoicemailAudioFilePrompt <Guid>]
 [-EnableTimeoutSharedVoicemailTranscription <Boolean>]
 [-EnableTimeoutSharedVoicemailSystemPromptSuppression <Boolean>]
 [-NoAgentRedirectPersonTextToSpeechPrompt <String>]
 [-NoAgentRedirectPersonAudioFilePrompt <Guid>]
 [-NoAgentRedirectVoiceAppTextToSpeechPrompt <String>]
 [-NoAgentRedirectVoiceAppAudioFilePrompt <Guid>]
 [-NoAgentRedirectPhoneNumberTextToSpeechPrompt <String>]
 [-NoAgentRedirectPhoneNumberAudioFilePrompt <Guid>]
 [-NoAgentRedirectVoicemailTextToSpeechPrompt <String>]
 [-NoAgentRedirectVoicemailAudioFilePrompt <Guid>]
 [-NoAgentSharedVoicemailTextToSpeechPrompt <String>]
 [-NoAgentSharedVoicemailAudioFilePrompt <Guid>]
 [-EnableNoAgentSharedVoicemailTranscription <Boolean>]
 [-EnableNoAgentSharedVoicemailSystemPromptSuppression <Boolean>]
 [-AuthorizedUsers <List>]
 [-HideAuthorizedUsers <List>]
 [-WelcomeTextToSpeechPrompt <String>]
 [-IsCallbackEnabled <Boolean>]
 [-CallbackRequestDtmf <String>]
 [-WaitTimeBeforeOfferingCallbackInSecond <Int16>]
 [-NumberOfCallsInQueueBeforeOfferingCallback <Int16>]
 [-CallToAgentRatioThresholdBeforeOfferingCallback <Int16>]
 [-CallbackOfferAudioFilePromptResourceId <Guid>]
 [-CallbackOfferTextToSpeechPrompt <String>]
 [-CallbackEmailNotificationTarget <Guid>]
 [-ComplianceRecordingForCallQueueTemplateId <List>]
 [-TextAnnouncementForCR <String>]
 [-CustomAudioFileAnnouncementForCR <Guid>]
 [-TextAnnouncementForCRFailure <String>]
 [-CustomAudioFileAnnouncementForCRFailure <Guid>]
 [-ShouldOverwriteCallableChannelProperty <Boolean>]
 [-SharedCallQueueHistoryTemplateId <String>]
 [-AutoRecordingTemplateId <String>]
 [<CommonParameters>]

Description

Examples

Example 1

Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true

Example 2

Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id

Parameters

-AgentAlertTime

The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive.

Parameter properties

Parameter sets

-AllowOptOut

The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue.

Parameter properties

Parameter sets

-AuthorizedUsers

This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Parameter properties

Parameter sets

-AutoRecordingTemplateId

Voice applications private preview customers only.

Saving a call queue configuration through Teams admin center will remove this setting.

The AutoRecordingTemplateId parameter indicates the Auto Recording template to apply to the call queue.

Parameter properties

Parameter sets

-CallbackEmailNotificationTarget

The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to True.

Parameter properties

Parameter sets

-CallbackOfferAudioFilePromptResourceId

The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or -CallbackOfferTextToSpeechPrompt, becomes a required parameter when IsCallbackEnabled is set to True.

Parameter properties

Parameter sets

-CallbackOfferTextToSpeechPrompt

The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or -CallbackOfferAudioFilePromptResourceId, becomes a required parameter when IsCallbackEnabled is set to True.

Parameter properties

Parameter sets

-CallbackRequestDtmf

The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values:

• Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9.
• ToneStar - Corresponds to DTMF tone *.
• TonePound - Corresponds to DTMF tone #.

This parameter becomes a required parameter when IsCallbackEnabled is set to True.

Parameter properties

Parameter sets

-CallToAgentRatioThresholdBeforeOfferingCallback

The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition.

At least one of -WaitTimeBeforeOfferingCallbackInSecond, -NumberOfCallsInQueueBeforeOfferingCallback, or -CallToAgentRatioThresholdBeforeOfferingCallback must be set to a value other than null when -IsCallbackEnabled is True.

Parameter properties

Parameter sets

-ChannelId

Id of the channel to connect a call queue to.

Parameter properties

Parameter sets

-ChannelUserObjectId

The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to.

Parameter properties

Parameter sets

-ComplianceRecordingForCallQueueTemplateId

The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue.

Parameter properties

Parameter sets

-ConferenceMode

The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes:

• Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off.

• Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off.

Parameter properties

Parameter sets

-CustomAudioFileAnnouncementForCR

The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled.

Parameter properties

Parameter sets

-CustomAudioFileAnnouncementForCRFailure

The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call.

Parameter properties

Parameter sets

-DistributionLists

The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue.

Parameter properties

Parameter sets

-EnableNoAgentSharedVoicemailSystemPromptSuppression

The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-EnableNoAgentSharedVoicemailTranscription

The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-EnableOverflowSharedVoicemailSystemPromptSuppression

The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-EnableOverflowSharedVoicemailTranscription

The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-EnableTimeoutSharedVoicemailSystemPromptSuppression

The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-EnableTimeoutSharedVoicemailTranscription

The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail.

Parameter properties

Parameter sets

-HideAuthorizedUsers

This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Parameter properties

Parameter sets

-Identity

PARAMVALUE: Guid

Parameter properties

Parameter sets

-IsCallbackEnabled

The IsCallbackEnabled parameter is used to turn on/off callback.

Parameter properties

Parameter sets

-LanguageId

The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail.

You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet.

Parameter properties

Parameter sets

-LineUri

This parameter is reserved for Microsoft internal use only.

Parameter properties

Parameter sets

-MusicOnHoldAudioFileId

The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified.

Parameter properties

Parameter sets

-Name

The Name parameter specifies a unique name for the Call Queue.

Parameter properties

Parameter sets

-NoAgentAction

The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue.

PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail

Parameter properties

Parameter sets

-NoAgentActionCallPriority

If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable.

PARAMVALUE: 1 | 2 | 3 | 4 | 5

• 1 = Very High
• 2 = High
• 3 = Normal / Default
• 4 = Low
• 5 = Very Low

Parameter properties

Parameter sets

-NoAgentActionTarget

The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional.

Parameter properties

Parameter sets

-NoAgentApplyTo

The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls.

PARAMVALUE: AllCalls | NewCalls

Parameter properties

Parameter sets

-NoAgentDisconnectAudioFilePrompt

The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents.

Parameter properties

Parameter sets

-NoAgentDisconnectTextToSpeechPrompt

The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectPersonAudioFilePrompt

The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectPersonTextToSpeechPrompt

The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectPhoneNumberAudioFilePrompt

The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectPhoneNumberTextToSpeechPrompt

The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectVoiceAppAudioFilePrompt

The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectVoiceAppTextToSpeechPrompt

The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents.

Parameter properties

Parameter sets

-NoAgentRedirectVoicemailAudioFilePrompt

The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent.

Parameter properties

Parameter sets

-NoAgentRedirectVoicemailTextToSpeechPrompt

The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent.

Parameter properties

Parameter sets

-NoAgentSharedVoicemailAudioFilePrompt

The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null.

Parameter properties

Parameter sets

-NoAgentSharedVoicemailTextToSpeechPrompt

The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null.

Parameter properties

Parameter sets

-NumberOfCallsInQueueBeforeOfferingCallback

The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition.

At least one of -WaitTimeBeforeOfferingCallbackInSecond, -NumberOfCallsInQueueBeforeOfferingCallback, or -CallToAgentRatioThresholdBeforeOfferingCallback must be set to a value other than null when -IsCallbackEnabled is True.

Parameter properties

Parameter sets

-OboResourceAccountIds

The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs.

Parameter properties

Parameter sets

-OverflowAction

The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy.

PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail

Parameter properties

Parameter sets

-OverflowActionCallPriority

If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable.

PARAMVALUE: 1 | 2 | 3 | 4 | 5

• 1 = Very High
• 2 = High
• 3 = Normal / Default
• 4 = Low
• 5 = Very Low

Parameter properties

Parameter sets

-OverflowActionTarget

The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional.

Parameter properties

Parameter sets

-OverflowDisconnectAudioFilePrompt

The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow.

Parameter properties

Parameter sets

-OverflowDisconnectTextToSpeechPrompt

The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectPersonAudioFilePrompt

The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectPersonTextToSpeechPrompt

The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectPhoneNumberAudioFilePrompt

The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectPhoneNumberTextToSpeechPrompt

The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectVoiceAppAudioFilePrompt

The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectVoiceAppTextToSpeechPrompt

The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectVoicemailAudioFilePrompt

The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow.

Parameter properties

Parameter sets

-OverflowRedirectVoicemailTextToSpeechPrompt

The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow.

Parameter properties

Parameter sets

-OverflowSharedVoicemailAudioFilePrompt

The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null.

Parameter properties

Parameter sets

-OverflowSharedVoicemailTextToSpeechPrompt

The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null.

Parameter properties

Parameter sets

-OverflowThreshold

The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately.

Parameter properties

Parameter sets

-PresenceBasedRouting

The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available.

Parameter properties

Parameter sets

-RoutingMethod

The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called.

PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle

Parameter properties

Parameter sets

-ServiceLevelThresholdResponseTimeInSecond

The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage.

A value of $null indicates that a service level percentage will not be calculated for this call queue.

Parameter properties

Parameter sets

-SharedCallQueueHistoryTemplateId

The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue.

Parameter properties

Parameter sets

-ShiftsSchedulingGroupId

Id of the Scheduling Group to connect a call queue to.

Parameter properties

Parameter sets

-ShiftsTeamId

Id of the Team containing the Scheduling Group to connect a call queue to.

Parameter properties

Parameter sets

-ShouldOverwriteCallableChannelProperty

A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true.

Parameter properties

Parameter sets

-Tenant

This parameter is reserved for Microsoft internal use only.

Parameter properties

Parameter sets

-TextAnnouncementForCR

The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled.

Parameter properties

Parameter sets

-TextAnnouncementForCRFailure

The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call.

Parameter properties

Parameter sets

-TimeoutAction

The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect.

PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail

Parameter properties

Parameter sets

-TimeoutActionCallPriority

If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable.

PARAMVALUE: 1 | 2 | 3 | 4 | 5

• 1 = Very High
• 2 = High
• 3 = Normal / Default
• 4 = Low
• 5 = Very Low

Parameter properties

Parameter sets

-TimeoutActionTarget

The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional.

Parameter properties

Parameter sets

-TimeoutDisconnectAudioFilePrompt

The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout.

Parameter properties

Parameter sets

-TimeoutDisconnectTextToSpeechPrompt

The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectPersonAudioFilePrompt

The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectPersonTextToSpeechPrompt

The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectPhoneNumberAudioFilePrompt

The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectPhoneNumberTextToSpeechPrompt

The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectVoiceAppAudioFilePrompt

The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectVoiceAppTextToSpeechPrompt

The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectVoicemailAudioFilePrompt

The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout.

Parameter properties

Parameter sets

-TimeoutRedirectVoicemailTextToSpeechPrompt

The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout.

Parameter properties

Parameter sets

-TimeoutSharedVoicemailAudioFilePrompt

The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null.

Parameter properties

Parameter sets

-TimeoutSharedVoicemailTextToSpeechPrompt

The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null.

Parameter properties

Parameter sets

-TimeoutThreshold

The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken.

Parameter properties

Parameter sets

-UseDefaultMusicOnHold

The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId.

Parameter properties

Parameter sets

-Users

The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID).

Parameter properties

Parameter sets

-WaitTimeBeforeOfferingCallbackInSecond

The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition.

At least one of -WaitTimeBeforeOfferingCallbackInSecond, -NumberOfCallsInQueueBeforeOfferingCallback, or -CallToAgentRatioThresholdBeforeOfferingCallback must be set to a value other than null when -IsCallbackEnabled is True.

Parameter properties

Parameter sets

-WelcomeMusicAudioFileId

The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file.

Parameter properties

Parameter sets

-WelcomeTextToSpeechPrompt

This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue.

Parameter properties

Parameter sets

CommonParameters

Outputs

Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue

Related Links

• Create a Phone System Call Queue
• New-CsCallQueue
• Get-CsCallQueue
• Remove-CsCallQueue
• New-CsComplianceRecordingForCallQueueTemplate
• Set-CsComplianceRecordingForCallQueueTemplate
• Get-CsComplianceRecordingForCallQueueTemplate
• Remove-CsComplianceRecordingForCallQueueTemplate