Skip to content

Latest commit

 

History

History
882 lines (646 loc) · 22.6 KB

File metadata and controls

882 lines (646 loc) · 22.6 KB
applicable Microsoft Teams
author serdarsoysal
external help file Microsoft.Rtc.Management.Hosted.dll-help.xml
Locale en-US
manager bulenteg
Module Name MicrosoftTeams
ms.author serdars
ms.reviewer alejandramu
online version https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy
schema 2.0.0
title New-CsTeamsCallingPolicy

New-CsTeamsCallingPolicy

SYNOPSIS

Use this cmdlet to create a new instance of a Teams Calling Policy.

SYNTAX

Identity (Default)

New-CsTeamsCallingPolicy [-Identity] <string>
 [-AIInterpreter <string>]
 [-AllowCallForwardingToPhone <boolean>]
 [-AllowCallForwardingToUser <boolean>]
 [-AllowCallGroups <boolean>]
 [-AllowCallRedirect <string>]
 [-AllowCloudRecordingForCalls <boolean>]
 [-AllowDelegation <boolean>]
 [-AllowPrivateCalling <boolean>]
 [-AllowSIPDevicesCalling <boolean>]
 [-AllowTranscriptionForCalling <boolean>]
 [-AllowVoicemail <string>]
 [-AllowWebPSTNCalling <boolean>]
 [-AutoAnswerEnabledType <string>]
 [-BusyOnBusyEnabledType <string>]
 [-CallingSpendUserLimit <long>]
 [-CallRecordingExpirationDays <long>]
 [-Confirm]
 [-Copilot <string>]
 [-Description <string>]
 [-EnableSpendLimits <boolean>]
 [-EnableWebPstnMediaBypass <Boolean>]
 [-Force]
 [-InboundFederatedCallRoutingTreatment <string>]
 [-InboundPstnCallRoutingTreatment <string>]
 [-LiveCaptionsEnabledTypeForCalling <string>]
 [-MusicOnHoldEnabledType <string>]
 [-PopoutAppPathForIncomingPstnCalls <string>]
 [-PopoutForIncomingPstnCalls <string>]
 [-PreventComplianceRecording <string>]
 [-PreventTollBypass <boolean>]
 [-SpamFilteringEnabledType <string>]
 [-VoiceSimulationInInterpreter <string>]
 [-RealTimeText <string>]
 [-ExplicitRecordingConsent <string>]
 [-WhatIf]
 [-EnableRecordingAndTranscriptionCustomMessage <Boolean>]
 [-RecordingAndTranscriptionCustomMessageIdentifier <Guid>]
 [<CommonParameters>]

DESCRIPTION

The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to create new policy instances.

EXAMPLES

Example 1

PS C:\> New-CsTeamsCallingPolicy -Identity Sales -AllowPrivateCalling $false

The cmdlet create the policy instance Sales and sets the value of the parameter AllowPrivateCalling to False. The rest of the parameters are set to the corresponding values in the Global policy instance.

PARAMETERS

-AIInterpreter

Applicable: Microsoft Teams

Note

This feature has not been released yet and will have no changes if it is enabled or disabled.

Enables the user to use the AI Interpreter related features.

Possible values:

  • Disabled
  • Enabled
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False

-AllowCallForwardingToPhone

Applicable: Microsoft Teams

Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowCallForwardingToUser

Applicable: Microsoft Teams

Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowCallGroups

Applicable: Microsoft Teams

Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowCallRedirect

Applicable: Microsoft Teams

Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway.

Valid options are:

  • Enabled: Enables the user to redirect an incoming call.

  • Disabled: The user is not enabled to redirect an incoming call.

  • UserOverride: This option is not available for use.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowCloudRecordingForCalls

Applicable: Microsoft Teams

Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowDelegation

Applicable: Microsoft Teams

Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowPrivateCalling

Applicable: Microsoft Teams

Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowSIPDevicesCalling

Applicable: Microsoft Teams

Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowTranscriptionForCalling

Applicable: Microsoft Teams

Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowVoicemail

Applicable: Microsoft Teams

Enables inbound calls to be routed to voicemail.

Valid options are:

  • AlwaysEnabled: Calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user.
  • AlwaysDisabled: Calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams.
  • UserOverride: Calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowWebPSTNCalling

Applicable: Microsoft Teams

Allows PSTN calling from the Team web client.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AutoAnswerEnabledType

Applicable: Microsoft Teams

Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. This setting applies only to incoming meeting invites and does not include support for other call types.

Valid options are:

  • Enabled: Auto-answer is enabled.
  • Disabled: Auto-answer is disabled. This is the default setting.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-BusyOnBusyEnabledType

Applicable: Microsoft Teams

Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold.

Valid options are:

  • Enabled: New or incoming calls will be rejected with a busy signal.
  • Unanswered: The user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user.
  • Disabled: New or incoming calls will be presented to the user.
  • UserOverride: Users can set their busy options directly from call settings in Teams app.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CallingSpendUserLimit

Applicable: Microsoft Teams

The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes.

Possible values: any positive integer

Type: Long
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CallRecordingExpirationDays

Applicable: Microsoft Teams

Sets the expiration of the recorded 1:1 calls. Default is 60 days.

Type: Long
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Applicable: Microsoft Teams

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Copilot

Applicable: Microsoft Teams

Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call.

Valid options are:

  • Enabled: Copilot can work with or without transcription during calls. This is the default value.
  • EnabledWithTranscript: Copilot will only work when transcription is enabled during calls.
  • Disabled: Copilot is disabled for calls.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False

-Description

Applicable: Microsoft Teams

Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableSpendLimits

Applicable: Microsoft Teams

This setting allows an admin to enable or disable spend limits on PSTN calls for their user base.

Possible values:

  • True
  • False
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableWebPstnMediaBypass

Determines if MediaBypass is enabled for PSTN calls on specified Web platforms.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Applicable: Microsoft Teams

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Name of the policy instance being created.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InboundFederatedCallRoutingTreatment

Applicable: Microsoft Teams

Setting this parameter lets you control how inbound federated calls should be routed.

Valid options are:

  • RegularIncoming: No changes are made to default inbound routing. This is the default setting.

  • Unanswered: The inbound federated call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected.

  • Voicemail: The inbound federated call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected.

Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: RegularIncoming
Accept pipeline input: False
Accept wildcard characters: False

-InboundPstnCallRoutingTreatment

Applicable: Microsoft Teams

Setting this parameter lets you control how inbound PSTN calls should be routed.

Valid options are:

  • RegularIncoming: No changes are made to default inbound routing. This is the default setting.
  • Unanswered: The inbound PSTN call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected.
  • Voicemail: The inbound PSTN call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected.
  • UserOverride: For now, setting the value to UserOverride is the same as RegularIncoming.

Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: RegularIncoming
Accept pipeline input: False
Accept wildcard characters: False

-LiveCaptionsEnabledTypeForCalling

Applicable: Microsoft Teams

Determines whether real-time captions are available for the user in Teams calls.

Valid options are:

  • DisabledUserOverride: Allows the user to turn on live captions.
  • Disabled: Prohibits the user from turning on live captions.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MusicOnHoldEnabledType

Applicable: Microsoft Teams

Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold.

Valid options are:

  • Enabled: Music on hold is enabled. This is the default.
  • Disabled: Music on hold is disabled.
  • UserOverride: For now, setting the value to UserOverride is the same as Enabled.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False

-PopoutAppPathForIncomingPstnCalls

Applicable: Microsoft Teams

Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a {phone} placeholder that is replaced with the caller's PSTN number in E.164 format when launched.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: ""
Accept pipeline input: False
Accept wildcard characters: False

-PopoutForIncomingPstnCalls

Applicable: Microsoft Teams

Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-PreventComplianceRecording

Applicable: Microsoft Teams

Note

This feature has not been released yet and will have no changes if it is enabled or disabled.

Controls whether Compliance Recording (CR)-enabled users are blocked from joining calls owned by the policy-assigned user. When set to None, no restriction is applied and compliance recording operates as configured for the tenant. When set to All, CR-enabled users are blocked from joining calls initiated by or received by the policy-assigned user. This applies to both internal and external CR-enabled users (including federated and B2B guests). Anonymous and PSTN users are unaffected as they cannot be assigned compliance recording.

Possible values:

  • None: Compliance recording is not prevented. The tenant's compliance recording configuration applies normally. This is the default value.
  • All: CR-enabled users are blocked from joining calls initiated by or received by the policy-assigned user. This applies to all CR-enabled users regardless of whether they are internal or external to the tenant.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreventTollBypass

Applicable: Microsoft Teams

Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls.

Note

Do not set this parameter to True for Calling Plan or Operator Connect users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RealTimeText

Applicable: Microsoft Teams

Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time.

Possible Values:

  • Enabled: User is allowed to turn on real time text.
  • Disabled: User is not allowed to turn on real time text.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False

-SpamFilteringEnabledType

Applicable: Microsoft Teams

Determines Spam filtering mode.

Possible values:

  • Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams.

  • Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VoiceSimulationInInterpreter

Applicable: Microsoft Teams

Note

This feature has not been released yet and will have no changes if it is enabled or disabled.

Enables the user to use the voice simulation feature while being AI interpreted.

Possible Values:

  • Disabled
  • Enabled
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-ExplicitRecordingConsent

Applicable: Microsoft Teams

Note

This feature has not been released yet and will have no changes if it is enabled or disabled.

This setting controls whether users must provide or obtain explicit consent before recording a 1:1 PSTN or Teams call. When enabled, both parties will receive a notification, and consent must be given before recording starts.

Possible values:

  • Enabled: Requires users to give and obtain explicit consent before starting a call recording.
  • Disabled: Users are not required to obtain explicit consent before recording starts.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Applicable: Microsoft Teams

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableRecordingAndTranscriptionCustomMessage

Note

This feature has not been fully released yet, so the setting will have no effect. This policy controls whether custom strings can be shown for recording and transcription in user's Teams calls. It need to work with RecordingAndTranscriptionCustomMessageIdentifier.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecordingAndTranscriptionCustomMessageIdentifier

Note

This feature has not been fully released yet, so the setting will have no effect. This attribute holds the unique identifier for the custom recording and transcription calling message. It stores a GUID that points to the CustomMessage in TeamsCustomMessageConfiguration.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-CsTeamsCallingPolicy

Remove-CsTeamsCallingPolicy

Grant-CsTeamsCallingPolicy

Set-CsTeamsCallingPolicy