[Index]

Model: device/msteamsonline/CsOnlinePstnGateway

Tenant Dialplan

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

To view and update information related to Microsoft Teams dial plans, go to (default menu) MS Teams Dial Plan Management, and select the relevant menu:

Related Topics

Microsoft Overview in the Core Feature Guide

Sync with Flow Through in the Core Feature Guide

VOSS Automate Configuration and Sync in the Core Feature Guide

Configure Microsoft Tenant Dialplan in the Core Feature Guide

Number Management Overview in the Core Feature Guide

Model Details: device/msteamsonline/CsOnlinePstnGateway

Title Description Details
Bypass Mode Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle.
  • Field Name: BypassMode
  • Type: ["String", "Null"]
  • Choices: ["None", "Always", "OnlyForLocalUsers"]
Description
  • Field Name: Description
  • Type: ["String", "Null"]
Enabled Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false).
  • Field Name: Enabled
  • Type: Boolean
Failover Response Codes Comma separated numbers between 400 and 599
  • Field Name: FailoverResponseCodes
  • Type: String
Failover Time Seconds When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10.
  • Field Name: FailoverTimeSeconds
  • Type: Integer
Forward Call History Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False).
  • Field Name: ForwardCallHistory
  • Type: Boolean
Forward PAI Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325.
  • Field Name: ForwardPai
  • Type: Boolean
FQDN Fully qualified domain name
  • Field Name: Fqdn
  • Type: String
Gateway LBR Enabled User Override
  • Field Name: GatewayLbrEnabledUserOverride
  • Type: Boolean
Gateway Site ID PSTN Gateway Site ID.
  • Field Name: GatewaySiteId
  • Type: String
Gateway Site LBR Enabled Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False).
  • Field Name: GatewaySiteLbrEnabled
  • Type: Boolean
Name * The parameter is mandatory when modifying an existing SBC.
  • Field Name: Identity
  • Type: String
Inbound PSTN Number Translation Rules Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
  • Field Name: InboundPstnNumberTranslationRules
  • Type: ["Array", "Null"]
Inbound Teams Number Translation Rules This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.
  • Field Name: InboundTeamsNumberTranslationRules
  • Type: ["Array", "Null"]
Max Concurrent Sessions Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.
  • Field Name: MaxConcurrentSessions
  • Type: ["Integer", "Null"]
Media Bypass Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
  • Field Name: MediaBypass
  • Type: Boolean
Media Relay Routing Location Override This parameter is reserved for use with managed carriers. Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. This parameter allows manually set the preferred region for media traffic. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter
  • Field Name: MediaRelayRoutingLocationOverride
  • Type: ["String", "Null"]
Outbound PSTN Number Translation Rules Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.
  • Field Name: OutboundPstnNumberTranslationRules
  • Type: ["Array", "Null"]
Outbound Teams Number Translation Rules Assigns an ordered list of Teams translation rules, that apply to Teams numbers on outbound direction.
  • Field Name: OutboundTeamsNumberTranslationRules
  • Type: ["Array", "Null"]
PIDF-LO Supported Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user.
  • Field Name: PidfLoSupported
  • Type: Boolean
Proxy SBC
  • Field Name: ProxySbc
  • Type: ["String", "Null"]
Send SIP Options Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True.
  • Field Name: SendSipOptions
  • Type: Boolean
SIP Signaling Port * Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535.
  • Field Name: SipSignalingPort
  • Type: Integer