[Index]

Model: data/DP_msteamsonline_CsOnlinePstnGateway

PSTN Usages

Full HTML Help

Tip

Use the Action search to navigate Automate

To view and update information related to Microsoft Teams dial plans, go to one of the following items in the GUI, depending on the details you wish to view and update:

Automate also allows you to predefine dial plan templates for Microsoft data models, and to push the dial plan, on-demand. For details, see Microsoft Dial Plan Models

Related topics

Microsoft overview in the Core Feature Guide

Sync to site with flow through in the Core Feature Guide

Automate configuration and sync in the Core Feature Guide

Configure Microsoft tenant dial plan in the Core Feature Guide

Number management overview in the Core Feature Guide

Prevent duplicate numbers in the Core Feature Guide

CsCallingLineIdentity

Full HTML Help

Overview

Automate supports the ability to predefine dial plan templates for Microsoft data models, and to push the dial plans, on-demand, for a specific customer or site.

Microsoft dial plan models workflow

To use this feature:

  1. Ensure you have the Dial Plan Management Tool menus exposed in the Admin Portal:

    Note

    • The Dial Plan Input Data menu is relevant only for Cisco dial plans.
    • For Microsoft dial plans, include the Microsoft Dial Plan Models menu and Microsoft models in your menu layout.
  2. Create Dial Plan Name

  3. Create Data Models

  4. Preview a Configured Dial Plan

  5. Push a Dial Plan to Customer or Site

The following Microsoft data models and corresponding device models (Microsoft dial plan elements) are supported:

Device Model Menu
device/msteamsonline/CsTenantDialplan Tenant Dialplan
device/msteamsonline/CsOnlinePstnGateway SBC Gateways
device/msteamsonline/CsOnlinePstnUsage PSTN Usages
device/msteamsonline/CsOnlineVoiceRoute Voice Routes
device/msteamsonline/CsOnlineVoiceRoutingPolicy Voice Routing Policies
device/msteamsonline/CsTeamsTranslationRule Translation Rules

Additional Microsoft device models have been added to offer providers a one-step in the customer onboarding process: pushing provider-specific dial plan elements as well as Teams polices to the customer's tenant.

The following Microsoft device models are supported. The equivalent data models have names that match the device model name as follows:

DP_msteamsonline_<device model name>

For example, DP_msteamsonline_CsOnlineVoicemailPolicy.

Device Model Menu
device/msteamsonline/CsCallingLineIdentity Calling Line Identity [1]
device/msteamsonline/CsOnlineVoicemailPolicy Online Voicemail Policies
device/msteamsonline/CsTeamsCallingPolicy Calling Policies
device/msteamsonline/CsTeamsCallParkPolicy Call Park Policies
device/msteamsonline/CsTeamsEmergencyCallingPolicy Emergency Calling Policies
device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy Emergency Call Routing Policies
device/msteamsonline/CsTeamsEnhancedEncryptionPolicy Enhanced Encryption Policies
[1]

When adding an instance by creating a data model (Create Data Models) and if Calling ID Substitute is set to Resource Account, a Resource Account which has a number can be selected.

The Calling Party Name is also visible and can be configured.

Related topics

Create the dial plan name

  1. Go to Dial Plan.
  2. Click Add.
  3. Fill out a dial plan name, and a description.
  4. At Dial Plan Type, choose an option, either Global, Site, or Multi-tenant / Shared Architecture.
  5. Save.
  6. Next steps: Create the data models, with their data.

Create data models

Once you have a dial plan name you can create the data models with data in them.

  1. Go to Dial Plan Management Tool > Microsoft Dial Plan Models.

  2. Click on the relevant model.

  3. Click Add.

  4. Fill out data for the model:

  5. Save.

    The details you provided goes to the data model.

  6. Next steps: Repeat this procedure to fill out data for any other models (if required) to build out your dial plan, then preview the dial plan you configured.

Preview a configured dial plan

You can preview dial plans via the Dial Plan Viewer, which provides a read-only view of all data model entries added to a selected dial plan name.

Note

The Dial Plan Viewer displays read-only data. You cannot add or update any model entries via the Dial Plan Viewer. You can modify your data entries via the menus, then return to the viewer to see your changes, if required.

If you have data model entries added to a dial plan name for both Cisco and Microsoft dial plan models, these are all accessible for inspection in the tabs of the Dial Plan Viewer.

  1. Go to Dial Plan Management Tool > Dial Plan Viewer.

  2. In the Dial Plan Viewer summary list, click on the relevant dial plan name.

  3. The tabs of the Dial Plan Viewer display the data for each data model entry created for the selected dial plan name.

    Note

    A dial plan can contain entries for both Cisco and Microsoft dial plan models, allowing you to push dial plans to both CUCM clusters and to the Microsoft tenant (for Microsoft Teams).

  4. Next steps: Push the dial plan, to a customer or to a site.

Push a dial plan to customer or site

The Dial Plan Management Tool can push dial plan data to a customer or to a site, to the Microsoft tenant and to CUCM clusters, depending on the hierarchy where you created the dial plan, and on the data model entries included in your dial plan.

Important

If your dial plan is configured at a specific customer hierarchy, you'll need to push it from that hierarchy. If a dial plan is added at a site, it must be pushed to the site at that hierarchy.

  1. Choose the hierarchy where you added your dial plan (a customer or site).

  2. Go to Dial Plan Management Tool > Dial Plan Maintenance.

  3. At Dial Plan Name, select the name of the dial plan you wish to push to the site or customer.

    Note

    The Dial Plan Name drop-down lists dial plan names added to the current hierarchy.

  4. From Target Call Manager Cluster and Target Microsoft Tenant, choose the relevant target destination for the dial plan, either a CUCM cluster or a Microsoft tenant, or both, provided you have these added to your system.

  5. From the Operation drop-down, choose an option, either Push Dial Plan or Remove Dial Plan. To push your dial plan, select Push Dial Plan.

  6. Click Save.

    The relevant workflows are triggered to determine the content of the dial plan you defined. The dial plan data is pushed to the target (CUCM cluster or Microsoft tenant, as applicable).

    For Microsoft, the dial plans are added to the Microsoft Tenant in Automate (accessible via the default menus as MS Teams Dial Plan Management > Tenant Dialplan), and the dial plan details are also updated to the Microsoft Teams cloud portal.

Dial plan template model for device/msteamsonline/CsOnlinePstnGateway version 2019.1

Model Details: data/DP_msteamsonline_CsOnlinePstnGateway

Title Description Details
Dial Plan Name *
  • Field Name: dpName
  • Type: String
Name * The parameter is mandatory when modifying an existing SBC.
  • Field Name: Identity
  • Type: String
Description
  • Field Name: Description
  • Type: String
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
  • Choices: ["None", "Always", "OnlyForLocalUsers"]
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
Inbound PSTN Number Translation Rules Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
  • Field Name: InboundPstnNumberTranslationRules.[n]
  • Type: Array
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.[n]
  • Type: Array
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
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
Outbound PSTN Number Translation Rules Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.
  • Field Name: OutboundPstnNumberTranslationRules.[n]
  • Type: Array
Outbound Teams Number Translation Rules Assigns an ordered list of Teams translation rules, that apply to Teams numbers on outbound direction.
  • Field Name: OutboundTeamsNumberTranslationRules.[n]
  • Type: Array
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
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