Additional fields for Teams Call Queues #5070
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@microsoft-github-policy-service agree |
Upstream merge
NikCharlebois
requested changes
Sep 23, 2024
ykuijs
requested changes
Nov 22, 2024
There was a problem hiding this comment.
In the schema the description of several new parameters show that they rely on the value of another parameter, for example the NoAgentActionTarget parameter relies on the value of NoAgentAction:
[Write, Description("The NoAgentActionTarget represents 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.")] String NoAgentActionTarget;
Please make sure you implement checks to the Get and Set methods to make sure these requirements are valid. In the Get you can return a Verbose message, so the discrepancy is logged. In the Set method, you should also throw an exception like this:
| [Write, Description("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.")] String MusicOnHoldAudioFileId; | ||
| [Write, Description("The NoAgentAction parameter designates the action toto 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."), ValueMap{"Queue","Forward","Disconnect","Forward","Voicemail","SharedVoicemail"},Values{"Queue","Forward","Disconnect","Forward","Voicemail","SharedVoicemail"}] String NoAgentAction; |
There was a problem hiding this comment.
Please change "action toto take" to "action to take" (one "to" too many)
And Forward is in the ValueMap and Values list twice. Please remove one entry.
There was a problem hiding this comment.
In the PR title I see that the 2nd Forward probably should be combined with the Voicemail string that is immediately behind it, so ForwardVoicemail instead of Forward, Voicemail.
| @@ -20,32 +30,46 @@ class MSFT_TeamsCallQueue : OMI_BaseResource | |||
| [Write, Description("The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID).")] String Users[]; | |||
| [Write, Description("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.")] String LanguageId; | |||
| [Write, Description("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.")] String OboResourceAccountIds[]; | |||
| [Write, Description("The WelcomeMusicFileName parameter indicates the unique identifier for the Audio file prompt which is played to the caller when entering the queue")] String WelcomeMusicFileName; | |||
| [Write, Description("The WelcomeTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when entering the queue)] String WelcomeTextToSpeechPrompt; | |||
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| [Write, Description("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.")] String OverflowRedirectPersonTextToSpeechPrompt; | ||
| [Write, Description("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.")] String OverflowRedirectPersonAudioFilePrompt; | ||
| [Write, Description("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.")] String OverflowRedirectVoiceAppTextToSpeechPrompt; | ||
| [Write, Description("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.")] String OverflowRedirectVoiceAppAudioFilePrompt; | ||
| [Write, Description("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.")] String OverflowRedirectPhoneNumberTextToSpeechPrompt; | ||
| [Write, Description("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.")] String OverflowRedirectPhoneNumberAudioFilePrompt; | ||
| [Write, Description("The OverflowRedirectPhoneNumberAudioFilePromptFileName parameter indicates the name of the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow.)] String OverflowRedirectPhoneNumberAudioFilePromptFileName; |
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| [Write, Description("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.")] String OverflowSharedVoicemailTextToSpeechPrompt; | ||
| [Write, Description("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.")] String OverflowSharedVoicemailAudioFilePrompt; | ||
| [Write, Description("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.")] Boolean EnableOverflowSharedVoicemailTranscription; | ||
| [Write, Description("The EnableOverflowSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail.)] Boolean EnableOverflowSharedVoicemailSystemPromptSuppression; |
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| [Write, Description("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.")] String TimeoutRedirectPersonTextToSpeechPrompt; | ||
| [Write, Description("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.")] String TimeoutRedirectPersonAudioFilePrompt; | ||
| [Write, Description("The TimeoutRedirectPersonAudioFilePromptFileName parameter indicates the file name for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout.)] String TimeoutRedirectPersonAudioFilePromptFileName; |
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| [Write, Description("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.")] String TimeoutRedirectVoiceAppTextToSpeechPrompt; | ||
| [Write, Description("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.")] String TimeoutRedirectVoiceAppAudioFilePrompt; | ||
| [Write, Description("The TimeoutRedirectVoiceAppAudioFilePromptFileName parameter indicates the file name for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout)] String TimeoutRedirectVoiceAppAudioFilePromptFileName; |
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| [Write, Description("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.")] String TimeoutSharedVoicemailAudioFilePrompt; | ||
| [Write, Description("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.")] Boolean EnableTimeoutSharedVoicemailTranscription; | ||
| [Write, Description("The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail.)] Boolean EnableTimeoutSharedVoicemailSystemPromptSuppression; |
There was a problem hiding this comment.
The Description field is missing a closing quote. This is causing the unit tests to fail.
| @@ -52,10 +52,44 @@ function Get-TargetResource | |||
| [System.String] | |||
| $TimeoutAction, | |||
|
|
|||
| [Parameter()] | |||
| [ValidateSet("Queue","Forward","Disconnect","Forward","Voicemail","SharedVoicemail")] | |||
There was a problem hiding this comment.
Forward is in this list twice. Please correct, also for the other methods.
There was a problem hiding this comment.
In the PR title I see that the 2nd Forward probably should be combined with the Voicemail string that is immediately behind it, so ForwardVoicemail instead of Forward, Voicemail.
| [Parameter()] | ||
| [ValidateSet("Queue","Forward","Disconnect","Forward","Voicemail","SharedVoicemail")] | ||
| [System.String] | ||
| $NoAgentAction, |
There was a problem hiding this comment.
The schema shows 22 new parameters, but the Get/Set/Test methods only show 10 new parameters. Please make sure the parameter in the schema matches the parameters in the *-TargetResource functions.
|
And like Nik mentions, please also add an entry of this change to the changelog. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request (PR) description
This PR introduces several new fields to the export of Teams Call Queues in the Microsoft365 DSC project. These changes enhance the customization and detail provided during the export, particularly around call queue handling, voicemail prompts, and redirection actions.
Added Fields:
Purpose
The inclusion of these fields aims to provide users with greater flexibility and control over their Teams Call Queue configurations. This is particularly useful in scenarios requiring customized voicemail prompts, redirection actions, and specific handling behaviors when no agents are available.
This Pull Request (PR) fixes the following issues
None