New-CsAutoAttendantCallableEntity
The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity.
Syntax
Default (Default)
New-CsAutoAttendantCallableEntity
-Identity <String>
[-Tenant <Guid>]
[-EnableTranscription]
[-EnableSharedVoicemailSystemPromptSuppression]
[-CallPriority <Int16>]
[<CommonParameters>]
Description
The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity for use with call transfers from the Auto Attendant service. Callable entities can be created using either Object ID or TEL URIs and can refer to any of the following entities:
- User
- ApplicationEndpoint
- ConfigurationEndpoint
- ExternalPstn
- SharedVoicemail
NOTE: In order to setup a shared voicemail, an Office 365 Group that can receive external emails is required.
Examples
Example 1
$callableEntity = New-CsAutoAttendantCallableEntity -Identity "9bad1a25-3203-5207-b34d-1bd933b867a5" -Type User
This example creates a user callable entity.
Example 2
$callableEntity = New-CsAutoAttendantCallableEntity -Identity "tel:+1234567890" -Type ExternalPSTN
This example creates an ExternalPSTN callable entity.
Example 3
$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId
$callableEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User
This example gets a user object using Get-CsOnlineUser cmdlet. We then use the Microsoft Entra ObjectId of that user object to create a user callable entity.
Example 4
$callableEntityId = Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant" -MaxResults 1 | Select-Object -Property Id
$callableEntity = New-CsAutoAttendantCallableEntity -Identity $callableEntityId.Id -Type ApplicationEndpoint
This example gets an application instance by name using Find-CsOnlineApplicationInstance cmdlet. We then use the Microsoft Entra ObjectId of that application instance to create an application endpoint callable entity.
Example 5
$callableEntityGroup = Find-CsGroup -SearchQuery "Main Auto Attendant" -ExactMatchOnly $true -MailEnabledOnly $true
$callableEntity = New-CsAutoAttendantCallableEntity -Identity $callableEntityGroup -Type SharedVoicemail -EnableTranscription
This example gets an Office 365 group by name using Find-CsGroup cmdlet. Then the Guid of that group is used to create a shared voicemail callable entity that supports transcription.
Parameters
-CallPriority
Applicable: Microsoft Teams
Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default.
The Call Priority of the MenuOption, only applies when the Type is ApplicationEndpoint or ConfigurationEndpoint.
PARAMVALUE: 1 | 2 | 3 | 4 | 5
1 = Very High 2 = High 3 = Normal / Default 4 = Low 5 = Very Low
Important
Call priorities isn't currently supported for Authorized users in Queues App. Authorized users will not be able to edit call flows with priorities.
Parameter properties
| Type: | Int16 |
| Default value: | 3 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSharedVoicemailSystemPromptSuppression
Applicable: Microsoft Teams
Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableTranscription
Applicable: Microsoft Teams
Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Microsoft Teams
The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI.
- Only the Object IDs of users that have Enterprise Voice enabled are supported.
- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Microsoft Teams
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Applicable: Microsoft Teams
The Type parameter represents the type of the callable entity, which can be any of the following:
- User
- ApplicationEndpoint (when transferring to a Resource Account)
- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue)
- ExternalPstn
- SharedVoicemail
Important
Nesting Auto attendants and Call queues via ConfigurationEndpoint isn't currently supported for Authorized users in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue.
Parameter properties
| Type: | Object |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.