Skip to content

Commit 490b697

Browse files
Merge pull request #13511 from CLYVR/patch-70
Add AutoRecordingTemplateId to New-CsAutoAttendant
2 parents beeb738 + 326176e commit 490b697

1 file changed

Lines changed: 54 additions & 27 deletions

File tree

teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md

Lines changed: 54 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA).
2020
## SYNTAX
2121

2222
```powershell
23-
New-CsAutoAttendant -Name <String> -LanguageId <String> -TimeZoneId <String> -DefaultCallFlow <Object> [-CallFlows <Object>] [-CallHandlingAssociations <Object>] [-Operator <Object>] [-VoiceId <String>] [-EnableVoiceResponse] [-EnableMainlineAttendant] [-MainlineAttendantAgentVoiceId <String>] [-InclusionScope <Object>] [-ExclusionScope <Object>] [-AuthorizedUsers <List>] [-HideAuthorizedUsers <List>] [-UserNameExtension <String>] [-Tenant <Guid>] [<CommonParameters>]
23+
New-CsAutoAttendant -Name <String> -LanguageId <String> -TimeZoneId <String> -DefaultCallFlow <Object> [-CallFlows <Object>] [-CallHandlingAssociations <Object>] [-Operator <Object>] [-VoiceId <String>] [-EnableVoiceResponse] [-EnableMainlineAttendant] [-MainlineAttendantAgentVoiceId <String>] [-InclusionScope <Object>] [-ExclusionScope <Object>] [-AuthorizedUsers <List>] [-HideAuthorizedUsers <List>] [-UserNameExtension <String>] [-AutoRecordingTemplateId <String>] [-Tenant <Guid>] [<CommonParameters>]
2424
```
2525

2626
## DESCRIPTION
@@ -42,10 +42,11 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat
4242
>
4343
> - -EnableMainLineAttendant
4444
> - -MainlineAttendantAgentVoiceId
45+
> - -AutoRecordingTemplateId
4546
4647
**NOTES**:
4748

48-
- To setup your AA for calling, you need to create an application instance first using `New-CsOnlineApplicationInstance` cmdlet , then associate it with your AA configuration using `New-CsOnlineApplicationInstanceAssociation` cmdlet.
49+
- To setup your AA for calling, you need to create an application instance first using [New-CsOnlineApplicationInstance](new-csonlineapplicationinstance.md) cmdlet , then associate it with your AA configuration using [New-CsOnlineApplicationInstanceAssociation](new-csonlineapplicationinstanceassociation.md) cmdlet.
4950
- The default call flow has the lowest precedence, and any custom call flow has a higher precedence and is executed if the schedule associated with it is in effect.
5051
- Holiday call flows have higher priority than after-hours call flows. Thus, if a holiday schedule and an after-hours schedule are both in effect at a particular time, the call flow corresponding to the holiday call flow will be rendered.
5152
- The default call flow can be used either as the 24/7 call flow if no other call flows are specified, or as the business hours call flow if an "after hours" call flow was specified together with the corresponding schedule and call handling association.
@@ -215,11 +216,11 @@ Get-CsOnlineSchedule $christmasSchedule.Id
215216
# AssociatedConfigurationIds : a65b3434-05a1-48ed-883d-e3ca35a60af8, 236450c4-9f1e-4c19-80eb-d68819d36a15
216217
```
217218

218-
This example creates two new AAs named _Main auto attendant_ and _Customer Support Auto Attendant_. Both AAs share the same Christmas holiday schedule. This was done by reusing the Schedule ID of the _Christmas_ holiday when creating the call handling associations for those two AAs using New-CsAutoAttendantCallHandlingAssociation cmdlet.
219+
This example creates two new AAs named _Main auto attendant_ and _Customer Support Auto Attendant_. Both AAs share the same Christmas holiday schedule. This was done by reusing the Schedule ID of the _Christmas_ holiday when creating the call handling associations for those two AAs using [New-CsAutoAttendantCallHandlingAssociation](new-csautoattendantcallhandlingassociation.md) cmdlet.
219220

220-
We can see when we ran the Get-CsOnlineSchedule cmdlet at the end, to get the _Christmas Holiday_ schedule information, that the configuration IDs for the newly created AAs have been added to the `AssociatedConfigurationIds` properties of that schedule. This means any updates made to this schedule would reflect in both associated AAs.
221+
We can see when we ran the [Get-CsOnlineSchedule](get-csonlineschedule.md) cmdlet at the end, to get the _Christmas Holiday_ schedule information, that the configuration IDs for the newly created AAs have been added to the `AssociatedConfigurationIds` properties of that schedule. This means any updates made to this schedule would reflect in both associated AAs.
221222

222-
Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) cmdlet documentation for examples on how to do that.
223+
Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](set-csautoattendant.md) cmdlet documentation for examples on how to do that.
223224

224225
### Example 4
225226
```powershell
@@ -290,11 +291,31 @@ Accept pipeline input: False
290291
Accept wildcard characters: False
291292
```
292293
294+
### -AutoRecordingTemplateId
295+
296+
The Auto Recording template ID to apply to the Auto attendant.
297+
298+
> [!NOTE]
299+
> 1. Requires that Mainline attendant be enabled.
300+
> 1. The template must not have an audio file configured.
301+
302+
```yaml
303+
Type: String
304+
Parameter Sets: (All)
305+
Aliases:
306+
307+
Required: False
308+
Position: Named
309+
Default value: None
310+
Accept pipeline input: False
311+
Accept wildcard characters: False
312+
```
313+
293314
### -CallFlows
294315
295316
The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter.
296317
297-
You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet.
318+
You can create CallFlows by using the [New-CsAutoAttendantCallFlow](new-csautoattendantcallflow.md) cmdlet.
298319
299320
```yaml
300321
Type: System.Collections.Generic.List
@@ -313,7 +334,7 @@ Accept wildcard characters: False
313334
The CallHandlingAssociations parameter represents the call handling associations.
314335
The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect.
315336
316-
You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet.
337+
You can create CallHandlingAssociations by using the [New-CsAutoAttendantCallHandlingAssociation](new-csautoattendantcallhandlingassociation.md) cmdlet.
317338
318339
```yaml
319340
Type: System.Collections.Generic.List
@@ -331,7 +352,7 @@ Accept wildcard characters: False
331352
332353
The DefaultCallFlow parameter is the flow to be executed when no other call flow is in effect (for example, during business hours).
333354
334-
You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet.
355+
You can create the DefaultCallFlow by using the [New-CsAutoAttendantCallFlow](new-csautoattendantcallflow.md) cmdlet.
335356
336357
```yaml
337358
Type: Object
@@ -370,6 +391,8 @@ Accept wildcard characters: False
370391

371392
The MainlineAttendantAgentVoiceId parameter sets the voice that will be used with Mainline Attendant.
372393

394+
See [Get-CsMainlineAttendantSupportedVoices](get-csmainlineattendantsupportedvoices.md) for a list of supported voices.
395+
373396
PARAMVALUE: Alloy | Echo | Shimmer
374397

375398
```yaml
@@ -386,7 +409,7 @@ Accept wildcard characters: False
386409

387410
### -EnableVoiceResponse
388411

389-
The EnableVoiceResponse parameter indicates whether voice response for AA is enabled.
412+
The EnableVoiceResponse parameter indicates whether voice response for Auto attendant is enabled.
390413

391414
```yaml
392415
Type: SwitchParameter
@@ -405,7 +428,7 @@ Accept wildcard characters: False
405428
Specifies the users to which call transfers are not allowed through directory lookup feature.
406429
If not specified, no user in the organization is excluded from directory lookup.
407430

408-
Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet.
431+
Dial scopes can be created by using the [New-CsAutoAttendantDialScope](new-csautoattendantdialscope.md) cmdlet.
409432

410433
```yaml
411434
Type: Object
@@ -440,7 +463,7 @@ Accept wildcard characters: False
440463
Specifies the users to which call transfers are allowed through directory lookup feature.
441464
If not specified, all users in the organization can be reached through directory lookup.
442465

443-
Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet.
466+
Dial scopes can be created by using the [New-CsAutoAttendantDialScope](new-csautoattendantdialscope.md) cmdlet.
444467

445468
```yaml
446469
Type: Object
@@ -458,7 +481,9 @@ Accept wildcard characters: False
458481

459482
The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts.
460483

461-
You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage) cmdlet.
484+
See [Get-CsMainlineAttendantSupportedLanguages](get-csmainlineattendantsupportedlanguages.md) for a list of languages supported with Mainline attendant.
485+
486+
See [Get-CsAutoAttendantSupportedLanguage](get-csautoattendantsupportedlanguage.md) for a list of languages supported with Auto attendant.
462487

463488
```yaml
464489
Type: System.String
@@ -492,7 +517,7 @@ Accept wildcard characters: False
492517

493518
The Operator parameter represents the SIP address or PSTN number of the operator.
494519

495-
You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet.
520+
You can create callable entities by using the [New-CsAutoAttendantCallableEntity](new-csautoattendantcallableentity.md) cmdlet.
496521

497522
```yaml
498523
Type: Object
@@ -526,7 +551,7 @@ Accept wildcard characters: False
526551

527552
The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone.
528553

529-
You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone) cmdlet.
554+
See [Get-CsAutoAttendantSupportedTimeZone](get-csautoattendantsupportedtimezone.md) for a list of supported time zones.
530555

531556
```yaml
532557
Type: System.String
@@ -570,7 +595,9 @@ Accept wildcard characters: False
570595

571596
The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts.
572597

573-
You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet.
598+
See [Get-CsMainlineAttendantSupportedVoices](get-csmainlineattendantsupportedvoices.md) for a list of voices supported with Mainline attendant.
599+
600+
See [Get-CsAutoAttendantSupportedLanguage](get-csautoattendantsupportedlanguage.md) for a list of voices supported with Auto attendant
574601

575602
```yaml
576603
Type: System.String
@@ -600,26 +627,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
600627

601628
## RELATED LINKS
602629

603-
[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation)
630+
[New-CsOnlineApplicationInstanceAssociation](new-csonlineapplicationinstanceassociation.md)
604631

605-
[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant)
632+
[Get-CsAutoAttendant](get-csautoattendant.md)
606633

607-
[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus)
634+
[Get-CsAutoAttendantStatus](get-csautoattendantstatus.md)
608635

609-
[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage)
636+
[Get-CsAutoAttendantSupportedLanguage](get-csautoattendantsupportedlanguage.md)
610637

611-
[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone)
638+
[Get-CsAutoAttendantSupportedTimeZone](get-csautoattendantsupportedtimezone.md)
612639

613-
[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity)
640+
[New-CsAutoAttendantCallableEntity](new-csautoattendantcallableentity.md)
614641

615-
[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow)
642+
[New-CsAutoAttendantCallFlow](new-csautoattendantcallflow.md)
616643

617-
[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation)
644+
[New-CsAutoAttendantCallHandlingAssociation](new-csautoattendantcallhandlingassociation.md)
618645

619-
[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule)
646+
[New-CsOnlineSchedule](new-csonlineschedule.md)
620647

621-
[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant)
648+
[Remove-CsAutoAttendant](remove-csautoattendant.md)
622649

623-
[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant)
650+
[Set-CsAutoAttendant](set-csautoattendant.md)
624651

625-
[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant)
652+
[Update-CsAutoAttendant](update-csautoattendant.md)

0 commit comments

Comments
 (0)