TeamsCallQueue

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The Name parameter specifies a unique name for the Call Queue.
AgentAlertTime	Write	SInt32	The Name parameter specifies a unique name for the Call Queue.
AllowOptOut	Write	Boolean	The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue.
DistributionLists	Write	StringArray[]	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.
UseDefaultMusicOnHold	Write	Boolean	The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId.
WelcomeMusicAudioFileId	Write	String	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.
WelcomeTextToSpeechPrompt	Write	String	The WelcomeTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is played to callers when they connect to the Call Queue.
MusicOnHoldAudioFileId	Write	String	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.
OverflowAction	Write	String	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.	DisconnectWithBusy, Forward, Voicemail, SharedVoicemail
OverflowActionTarget	Write	String	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.
OverflowThreshold	Write	SInt32	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.
TimeoutAction	Write	String	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.	Disconnect, Forward, Voicemail, SharedVoicemail
TimeoutActionTarget	Write	String	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.
TimeoutThreshold	Write	SInt32	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.
RoutingMethod	Write	String	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.	Attendant, Serial, RoundRobin, LongestIdle
PresenceBasedRouting	Write	Boolean	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.
ConferenceMode	Write	Boolean	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.
Users	Write	StringArray[]	The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID).
LanguageId	Write	String	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.
HideAuthorizedUsers	Write	StringArray[]	This is a list of UserPrincipalNames of authorized users who should not appear on the list of supervisors for the agents who are members of this queue.
OboResourceAccountIds	Write	StringArray[]	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. Only Call Queue managed by a Teams Channel will be able to use this feature.
OverflowDisconnectTextToSpeechPrompt	Write	String	The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow.
OverflowDisconnectAudioFilePrompt	Write	String	The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow.
OverflowRedirectPersonTextToSpeechPrompt	Write	String	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.
OverflowRedirectPersonAudioFilePrompt	Write	String	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.
OverflowRedirectVoiceAppTextToSpeechPrompt	Write	String	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.
OverflowRedirectVoiceAppAudioFilePrompt	Write	String	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.
OverflowRedirectPhoneNumberTextToSpeechPrompt	Write	String	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.
OverflowRedirectPhoneNumberAudioFilePrompt	Write	String	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.
OverflowRedirectVoicemailTextToSpeechPrompt	Write	String	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.
OverflowRedirectVoicemailAudioFilePrompt	Write	String	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.
OverflowSharedVoicemailTextToSpeechPrompt	Write	String	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.
OverflowSharedVoicemailAudioFilePrompt	Write	String	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.
EnableOverflowSharedVoicemailTranscription	Write	Boolean	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.
EnableOverflowSharedVoicemailSystemPromptSuppression	Write	Boolean	The EnableOverflowSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail.
OverflowActionCallPriority	Write	SInt32	If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account GUID, this parameter indicates the priority assigned to the call. Supported values are from 1 (Very High) to 5 (Very Low).	1, 2, 3, 4, 5
TextAnnouncementForCR	Write	String	The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled.
TextAnnouncementForCRFailure	Write	String	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.
CustomAudioFileAnnouncementForCR	Write	String	The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the audio file prompt played to callers when compliance recording for call queues is enabled.
CustomAudioFileAnnouncementForCRFailure	Write	String	The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the audio file prompt played to callers if the compliance recording bot is unable to join or drops from the call.
ComplianceRecordingForCallQueueTemplateId	Write	StringArray[]	The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to two Compliance Recording for Call Queue templates to apply to the call queue.
SharedCallQueueHistoryTemplateId	Write	String	The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue.
AutoRecordingTemplateId	Write	String	The AutoRecordingTemplateId parameter indicates the auto recording template to apply to the call queue.
TimeoutDisconnectTextToSpeechPrompt	Write	String	The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout.
TimeoutDisconnectAudioFilePrompt	Write	String	The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout.
TimeoutRedirectPersonTextToSpeechPrompt	Write	String	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.
TimeoutRedirectPersonAudioFilePrompt	Write	String	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.
TimeoutRedirectVoiceAppTextToSpeechPrompt	Write	String	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.
TimeoutRedirectVoiceAppAudioFilePrompt	Write	String	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.
TimeoutRedirectPhoneNumberTextToSpeechPrompt	Write	String	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.
TimeoutRedirectPhoneNumberAudioFilePrompt	Write	String	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.
TimeoutRedirectVoicemailTextToSpeechPrompt	Write	String	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.
TimeoutRedirectVoicemailAudioFilePrompt	Write	String	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.
TimeoutSharedVoicemailTextToSpeechPrompt	Write	String	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.
TimeoutSharedVoicemailAudioFilePrompt	Write	String	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.
EnableTimeoutSharedVoicemailTranscription	Write	Boolean	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.
EnableTimeoutSharedVoicemailSystemPromptSuppression	Write	Boolean	The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when TimeoutAction is set to SharedVoicemail.
TimeoutActionCallPriority	Write	SInt32	If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account GUID, this parameter indicates the priority assigned to the call. Supported values are from 1 (Very High) to 5 (Very Low).	1, 2, 3, 4, 5
NoAgentAction	Write	String	The NoAgentAction parameter defines the action to take if no agents are available. Supported values are Queue, Disconnect, Forward, Voicemail, and SharedVoicemail.	Queue, Disconnect, Forward, Voicemail, SharedVoicemail
NoAgentActionTarget	Write	String	The NoAgentActionTarget parameter represents the target of the no agent action. If NoAgentAction is Forward, this parameter must be a GUID or telephone number with the tel: prefix. If NoAgentAction is SharedVoicemail, this parameter must be a group ID.
NoAgentSharedVoicemailTextToSpeechPrompt	Write	String	The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are transferred to shared voicemail because no agents are available.
NoAgentSharedVoicemailAudioFilePrompt	Write	String	The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are transferred to shared voicemail because no agents are available.
EnableNoAgentSharedVoicemailTranscription	Write	Boolean	The EnableNoAgentSharedVoicemailTranscription parameter turns on transcription for voicemails left when no agents are available. This parameter is only applicable when NoAgentAction is SharedVoicemail.
EnableNoAgentSharedVoicemailSystemPromptSuppression	Write	Boolean	The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter turns off the default voicemail system prompts when no agents are available. This parameter is only applicable when NoAgentAction is SharedVoicemail.
NoAgentApplyTo	Write	String	The NoAgentApplyTo parameter defines whether NoAgentAction applies to all calls in queue or only new calls when the no agents condition occurs.	AllCalls, NewCalls
NoAgentDisconnectAudioFilePrompt	Write	String	The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are disconnected because no agents are available.
NoAgentDisconnectTextToSpeechPrompt	Write	String	The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are disconnected because no agents are available.
NoAgentRedirectPersonAudioFilePrompt	Write	String	The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are redirected to a person because no agents are available.
NoAgentRedirectPersonTextToSpeechPrompt	Write	String	The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are redirected to a person because no agents are available.
NoAgentRedirectVoiceAppAudioFilePrompt	Write	String	The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are redirected to a voice application because no agents are available.
NoAgentRedirectVoiceAppTextToSpeechPrompt	Write	String	The NoAgentRedirectVoiceAppTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are redirected to a voice application because no agents are available.
NoAgentRedirectPhoneNumberAudioFilePrompt	Write	String	The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are redirected to an external PSTN phone number because no agents are available.
NoAgentRedirectPhoneNumberTextToSpeechPrompt	Write	String	The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are redirected to an external PSTN phone number because no agents are available.
NoAgentRedirectVoicemailAudioFilePrompt	Write	String	The NoAgentRedirectVoicemailAudioFilePrompt parameter indicates the unique identifier for the audio file prompt played when callers are redirected to a person's voicemail because no agents are available.
NoAgentRedirectVoicemailTextToSpeechPrompt	Write	String	The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played when callers are redirected to a person's voicemail because no agents are available.
NoAgentActionCallPriority	Write	SInt32	If NoAgentAction is set to Forward, and NoAgentActionTarget is set to an Auto attendant or Call queue resource account GUID, this parameter indicates the priority assigned to the call. Supported values are from 1 (Very High) to 5 (Very Low).	1, 2, 3, 4, 5
IsCallbackEnabled	Write	Boolean	The IsCallbackEnabled parameter indicates whether callback is enabled for the call queue.
CallbackRequestDtmf	Write	String	The CallbackRequestDtmf parameter indicates the DTMF key callers press to select callback.	Tone0, Tone1, Tone2, Tone3, Tone4, Tone5, Tone6, Tone7, Tone8, Tone9, ToneStar, TonePound
WaitTimeBeforeOfferingCallbackInSecond	Write	SInt32	The WaitTimeBeforeOfferingCallbackInSecond parameter indicates the number of seconds a call must wait before becoming eligible for callback.
NumberOfCallsInQueueBeforeOfferingCallback	Write	SInt32	The NumberOfCallsInQueueBeforeOfferingCallback parameter indicates the number of calls in queue before a call becomes eligible for callback.
CallToAgentRatioThresholdBeforeOfferingCallback	Write	SInt32	The CallToAgentRatioThresholdBeforeOfferingCallback parameter indicates the call-to-agent ratio threshold before a call becomes eligible for callback. The minimum value is 1.
CallbackOfferAudioFilePromptResourceId	Write	String	The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the audio file prompt played to calls that are eligible for callback.
CallbackOfferTextToSpeechPrompt	Write	String	The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt played to calls that are eligible for callback.
CallbackEmailNotificationTarget	Write	String	The CallbackEmailNotificationTarget parameter indicates the group ID that receives notifications when a callback times out or cannot be completed.
ServiceLevelThresholdResponseTimeInSecond	Write	SInt32	The ServiceLevelThresholdResponseTimeInSecond parameter indicates the target number of seconds calls should be answered in for service level calculation.
ShouldOverwriteCallableChannelProperty	Write	Boolean	The ShouldOverwriteCallableChannelProperty parameter indicates whether reassignment of a Teams channel to a new call queue should be forced.
ShiftsTeamId	Write	String	Id of the Team containing the Scheduling Group to connect a call queue to.
ShiftsSchedulingGroupId	Write	String	Id of the Scheduling Group to connect a call queue to.
ChannelId	Write	String	Id of the channel to connect a call queue to.
ChannelUserObjectId	Write	String	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 the channels belongs to.
AuthorizedUsers	Write	StringArray[]	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).
Ensure	Write	String	Present ensures the Team Message Policy exists, absent ensures it is removed	Present, Absent
Credential	Write	PSCredential	Credentials of the Teams Service Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword	Write	PSCredential	Username can be made up to anything but password will be used for CertificatePassword
CertificatePath	Write	String	Path to certificate used in service principal usually a PFX file.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	StringArray[]	Access token used for authentication.

Description

This resource is used to manage Call Queue in your Skype for Business Online organization.

Permissions

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        TeamsCallQueue "TestQueue"
        {
            AgentAlertTime                             = 114;
            AllowOptOut                                = $True;
            AuthorizedUsers                            = @("9abce74d-d108-475f-a2cb-bbb82f484982");
            ChannelId                                  = "19:Y6MG7XdME2Cf9IRmU8PUXNfA1OtqmjyBgCmCGBN2tzY1@thread.tacv2";
            ConferenceMode                             = $True;
            Credential                                 = $Credscredential;
            DistributionLists                          = @("36c88f29-faba-4f4a-89a7-e5af29e7095e");
            EnableOverflowSharedVoicemailTranscription = $False;
            EnableTimeoutSharedVoicemailTranscription  = $False;
            Ensure                                     = "Present";
            LanguageId                                 = "fr-CA";
            Name                                       = "TestQueue";
            OverflowAction                             = "Forward";
            OverflowActionTarget                       = "9abce74d-d108-475f-a2cb-bbb82f484982";
            OverflowThreshold                          = 50;
            PresenceBasedRouting                       = $True;
            RoutingMethod                              = "RoundRobin";
            TimeoutAction                              = "Forward";
            TimeoutActionTarget                        = "9abce74d-d108-475f-a2cb-bbb82f484982";
            TimeoutThreshold                           = 1200;
            UseDefaultMusicOnHold                      = $False;
        }
    }
}