Edit

New-CsAutoAttendantCallableEntity

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity.

Syntax

New-CsAutoAttendantCallableEntity
   -Identity <String>
   -Type <User | ApplicationEndpoint | ExternalPstn | SharedVoicemail>
   [-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
  • 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 --- Private Preview customers only

The Call Priority of the MenuOption, only applies when the Type is ApplicationEndpoint.

PARAMVALUE: 1 | 2 | 3 | 4 | 5

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

Type:Int16
Position:Named
Default value:3
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-EnableSharedVoicemailSystemPromptSuppression

Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-EnableTranscription

Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Identity

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.
Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Tenant

Type:System.Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Type

The Type parameter represents the type of the callable entity, which can be any of the following:

  • User
  • ApplicationEndpoint
  • ExternalPstn
  • SharedVoicemail
Type:Object
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

Inputs

None

Outputs

Microsoft.Rtc.Management.Hosted.OAA.Models.CallableEntity