In this section:
Ribbon Communications recommends embedded URLs be accessed in a separate browser window/tab. To open embedded URLs in a separate window/tab, Ctrl+Left-click or Right-click with your mouse and select Open Link in New Tab/Open Link in New Window.
Ribbon Communications and Yealink® support uninterrupted voice services if a connectivity loss occurs between an enterprise site hosting Yealink Teams voice-related clients and the Microsoft® Phone System hosted in the Microsoft Azure™ cloud.
The benefits of voice service survivability between enterprise sites hosting Yealink Teams voice-related clients and Phone System hosted in the Azure cloud include the following:
This best practice describes the Teams client survivability services available using Ribbon and Yealink products. The best practice also provides instructions for configuring, activating, and validating the services. For details of the Yealink and Ribbon collaboration, refer to the integrated solution announcement and related links.
The following Yealink Teams clients collaborate with the Ribbon Communications SBC Edge to support survivability:
Yealink Teams Clients - Conference and Desk Phones
For details about devices that support Teams voice services, refer to the Yealink Teams client products page for the latest feature descriptions and specifications for available models.
The firmware version required to support survivability in a Teams context is:
For product documentation that details the configuration and operation of the Teams clients, visit support.yealink.com
The following SBC Edge offerings support Yealink Teams Client Local Survivability:
The SBC Edge firmware versions required to support Teams client survivability are Release 8.0.1 for the SBC SWe Lite and Release 8.0.1 for the SBC 1000/SBC 2000. Using earlier firmware versions is not supported and may result in conflicts and unexpected behavior.
Contact an authorized Ribbon Communications sales representative or partner to obtain the appropriate firmware release.
The survivability capabilities available to Teams clients vary based on the accessibility of Phone System and the deployment type (on-premises or Azure).
When the Phone System is accessible, the Yealink Teams and SBC Edge operate as designed for the integrated solution.
When the SBC Edge is deployed on-premises, operation with the Yealink Teams clients is as follows with the Phone System accessible:
Normal Operation when Teams Phone System is Accessible (SBC on enterprise premises)
When the the SBC SWe Lite is deployed in Azure, operation with the Yealink Teams clients is as follows with Phone System accessible:
Normal Operation when Teams Phone System is Accessible (SBC SWe Lite in Azure)
Operation of the Yealink Teams clients and the SBC Edge (deployed on-premises) when the Phone System is not available (e.g. WAN outage, etc.) is characterized by:
Operation when Teams Phone System is Not Accessible (SBC on enterprise premises)
Operation of the Yealink Teams clients and the SBC Edge (deployed in Azure) when the Phone System is not available is characterized by:
Operation when Teams Phone System is Not Accessible (SBC on enterprise premises)
Please note that a WAN outage has the potential to sever the connection not only between the on-premises Yealink Teams clients and Phone System, but also the connection between the on-premises Yealink Teams clients and the SBC SWe Lite found in Azure. Please consider the location of the SBC (on-premises vs. Azure-based) carefully to ensure business availability requirements are properly addressed.
To place outgoing calls using the SBC Edge instead of using the Phone System ( for example, if Phone System is temporarily unavailable), the Teams client user must access the Survivability (SIP) display of the Yealink device UI using the SIP "Quick Ball" icon. From the survivability UI, the user can place calls that route to their intended destination via the SBC Edge.
"Quick Ball"-enabled Survivability on Yealink Teams Devices
The Yealink client device does not present the user with an indication that Phone System is unavailable to process a call establishment request from the Teams Client UI. If the user observes a condition that suggests Phone System is unavailable (e.g. a timeout on a call attempt, etc.):
The Yealink device UI automatically presents the appropriate UI (whether the Teams Client or Survivability) depending upon the originator of the incoming call (Phone System in the former case, and the SBC Edge in the latter). The user simply needs to answer the incoming call to engage in the call.
When call routing is configured appropriately post-deployment, the SBC Edge automatically offers survivability services with no additional intervention.
Yealink Teams client-supporting devices (phones, etc.) must fulfill the following prerequisites prior to undertaking further actions:
As an option, Yealink devices may be configured to communicate with the SBC Edge using TLS (Transport Layer Security, used for SIP signaling encryption) and SRTP (Secure Real-time Transport Protocol, used for media encryption).
Ribbon Communications and Yealink strongly recommend the use of TLS and SRTP for secure encrypted communication between the Yealink devices and the SBC, especially when the latter is deployed in the Azure public cloud. When the SBC is deployed in Azure, the use of encryption safeguards the communication that transits the public Internet. Please refer to the following links to configure the Yealink devices and the SBC for secure communication:
For the Yealink devices, refer to the relevant administrator guide, and undertake the configuration as a prerequisite step (now). An example administrator guide with encryption configuration instructions (for the desk Phone T58A) is available at support.yealink.com.
Assuming the conditions are fulfilled, the Yealink devices are ready for Teams-related survivability configuration, and should be updated only after the SBC Edge prerequisites and configuration are complete.
Refer to the following sources of information for basic Microsoft Phone System features and deployment:
In all cases, the SBC Edge product must be deployed with a supporting firmware image. Once such an image is in place, please also ensure the following conditions are met depending upon the location (enterprise premises or Azure) of the SBC in the network topology.
For SBC Edge devices deployed on-premises, confirm the following:
Initial setup is complete.
SBC SWe Lite on-premise deployment initial steps
The SBC SWe Lite initial setup instructions include content related to feature licensing, trials, and easy configuration. Note the following:
You can choose to undertake feature licensing under the initial setup instructions, please ensure the minimum licensing requirements listed in step 2 are addressed;
You can choose to configure the SBC SWe Lite for Yealink Teams Client Local Survivability with a trial license and as such, temporarily disregard the instructions in step 2; however, there are considerations:
Note the number of registered Yealink devices and session capacity will be limited to the capabilities of the trial license;
Please do not undertake any Easy Configuration Wizard actions at this time; the easy configuration actions in a Teams-related deployment has additional considerations, as defined in step 3
Licensing has been acquired and properly assigned.
The following SIP registration license(s) are required for registering Yealink devices:
SBC 1000 and SBC 2000 registration licenses
SBC 1000 and SBC 2000 SIP session licenses;
SBC SWe Lite licenses for on-premises deployments.
For instructions on how to obtain and apply licenses, refer to Working with Licenses.
Any intervening routers undertaking LAN ↔ WAN addressing conversions, such as those related to NAT;
Any intervening firewalls undertaking network traffic filtering actions.
Please contact your IT administrator to ensure communication can be undertaken between the network segments hosting the Yealink Teams client devices and the SBC Edge. The IT administrator should be knowledgeable regarding the private IP addresses assigned to all devices, along with the required routing to achieve inter-device communications.
Once the previous steps have been completed, the SBC Edge device is ready for further configuration for Yealink Teams Client Local Survivability.
For an SBC SWe Lite deployed in Azure, confirm the following:
Initial setup is complete per the instructions applicable for an Azure deployment.
The SBC SWe Lite initial setup instructions include content related to feature licensing, trials, and easy configuration. Note the following:
You can choose to undertake feature licensing under the initial setup instructions, please ensure the minimum licensing requirements listed in step 2 are addressed.
You can choose to configure the SBC SWe Lite for Yealink Teams Client Local Survivability with a trial license and as such, temporarily disregard the instructions in step 2; however, there are considerations:
Note the number of registered Yealink devices and session capacity will be limited to the capabilities of the trial license.
Licensing has been acquired and properly assigned.
SIP registration license(s) (namely one or more instances of the SBC-SWELITE-LIC-RG-CLOUD) are absolutely required, to enable the registration of Yealink devices.
SIP session licenses are required, as the IP-based SIP signaling and RTP media to/from the subtended Yealink clients is connected by the SBC SWe Lite to an IP-based client (e.g. a SIP trunk, a SIP-based IP PBX, etc.)
For instructions on how to obtain and apply licenses, refer to Working with Licenses.
Any enterprise premises-based routers undertaking LAN ↔ WAN addressing conversions, such as those related to NAT;
Any enterprise premises-based firewalls undertaking network traffic filtering actions.
The Azure-based virtual network and VM (virtual machine) hosting the SBC SWe Lite, especially the network security group (NSG) security rules.
Please contact your IT administrator to ensure communication can be undertaken between the network segments hosting the Yealink Teams client devices and the SBC Edge hosted in the Azure cloud. The IT administrator should be knowledgeable regarding the private & public IP addresses assigned to all devices, along with the required routing to achieve inter-device communications.
Refer to the following sources of information for basic Azure virtual networking concepts, features and deployment:
After you complete the steps above, the SBC SWe Lite in Azure is ready for further configuration for Yealink Teams Client Local Survivability.
The following instructions detail how to configure the Ribbon SBC to accept Yealink Teams client devices registrations and to route calls properly between the devices and the PSTN. Please note the following context prior to the configuration being undertaken:
Create new call routing for use whenever a Yealink device needs to place calls via the SBC.
Create a new Call Routing Table instance.
Create two new Transformation Table instances (one for intra-office calling and one for PSTN access), each with an entry to pass the user dialed digits through for routing purposes;
Specify two new call routing entries to identify the final instructions for intra-office and PSTN routing for a Yealink device-originated call.
● A specific call route entry is required to be configured for intra-office calling between one Yealink device and another Yealink device registered with the same SIP Local Registrar instance.
● The PSTN-related signaling group will already have been created through the Easy Configuration wizard undertaken in the prerequisites of the SBC setup.
Update the pre-existing Call Routing Table instance (associated with the incoming PSTN trunk) to include updated routing for call processing that uses the newly created Signaling Group instance when Phone System is unavailable:
Create a new Transformation Table instance and entries to modify the incoming dialed digits received from the PSTN for local routing to the newly created SIP local registrar instance.
Specify a new call routing entry to identify the final instructions for routing to an SBC-subtended Yealink device.
● The pre-existing Call Routing Table instance associated with the incoming PSTN trunk was initially created through the use of the Easy Configuration wizard template undertaken in the prerequisites of the SBC setup. This Call Routing Table instance already has a routing entry to support the routing of an incoming call to Phone System. Refer to Using the Easy Configuration Wizard.
● The soon to be added new routing entry will be prioritized below the Teams-related call routing entry; this new routing entry will only be referenced in the event the Phone System is unavailable (i.e. the Yealink Teams Client Local Survivability scenario ).
To aid in the comprehension of the subsequent configuration instructions, please refer to the example network presenting pre-existing attribute values and device identifiers, along with soon to be added (identified in green italic font) attributes and values. Note select values (denoted with an X) are redacted for privacy purposes.
Sample Configuration Attribute Values for Example SBC Network Topology
In the left navigation page, access SIP > Local Registrars Table.
Click
to add a row.In the Create SIP Local Registrar dialog box, type the desired identifier name and maximum number of registering clients for your new SIP local registrar instance. For our example deployment, the entered name is LocalReg.
For details on SIP local registrar configuration, refer to Creating and Modifying SIP Local Registrars.
Click OK.
Newly Created Example SIP Local Registrar Instance "LocalReg", to Which Yealink Devices Will Register as SIP Endpoints
In the left navigation page, access SIP > Local/Pass-thru Auth Tables
Click () to add a local pass-through authorization table.
In the Description dialog box, type the desired Local Pass-through Authorization Table name. For our example deployment, the name specified is Local registration table.
Click OK.
Newly Created Example Local Pass-through Authorization Table instance "Local Registration table", that will shortly define acceptable credentials for successful registration
For details on Local Pass-through Authorization Tables configuration, refer to Managing Local Pass-through Authorization Tables.
In the left navigation page, access SIP > Local/Pass-thru Auth Tables, and select (click) the new Local Pass-through Authorization Table just created. In example deployment, the entered name is Local registration table. The table displays under the tabs, with the note: -- Table is empty --
Click the Create Local Pass-through Authorization Entry ( ) icon
Specify the following values for fields:
Local Pass-through Authorization Entry Attributes
Field | Required Entry |
---|---|
Type of Address of Record | Local, to signify the SBC is the registrant of record. |
Address of Record URI | Specify the acceptable Address of Record (AOR) URI from a potential valid registering endpoint. In the example deployment, one such AOR URI is sip:30001. |
User Name | Specify the acceptable user name from the registering endpoint. In the example deployment, one acceptable User Name is 30001 . |
Enter Password | Specify the password the registering endpoint must submit for successful registration. |
Confirm Password | Type the same password as entered above for confirmation. |
For details on Local Pass-through Authorization Table Entry configuration, refer to Creating and Modifying Entries to Local Pass-through Authorization Tables.
Click OK.
Highlighted Example New Local Pass-through Authorization Entry
Ribbon and Yealink strongly recommend the use of the optional Local Passthrough Authorization Table, especially for Azure-based SBC deployments. The use of the Local Passthrough Authorization Table deters the fraudulent use of your enterprise's SIP trunking services by unauthorized users.
Optional Step for encrypted SIP signaling: Create the TLS profile to define the cryptographic parameters for the SIP signaling between the subtended Yealink devices and the SBC.
In the left navigation pane, go to Security > TLS Profiles.
Configure the parameters shown below. Leave all other parameters as default.
New TLS Profile Entry Attributes for Registered Yealink SIP Clients ↔ SBC Communication
Field | Required Entry |
---|---|
Description | Specify a descriptive name for the entry. A sample name may be Yealink SIP Client SBC Signaling |
TLS Protocol | Set the administrative state to TLS 1.0 - 1.2 |
Mutual Authentication | Specify the authentication as Disabled. |
Client Cipher List | Select a cipher value (this value must be supported by the subtended registered Yealink clients). See above for guidelines. Ribbon recommends TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384. |
Validate Server FQDN | Specify the validation as Disabled. |
All other fields | Please leave all default values as-is for basic SIP signaling encryption purposes. |
Click OK, and confirm the presence of the new TLS Profile entry.
While optional, Ribbon Communications and Yealink strongly recommend the use of TLS and SRTP for secure encrypted communication between the Yealink devices and the SBC, especially when the latter is deployed in the Azure public cloud. For more information, please refer above.
For more information about creating new TLS Profile entries, refer to Managing TLS Profiles.
Access the WebUI, click the Settings tab.
In the left navigation pane, go to Call Routing > Call Routing Table.
Click ().
Enter a descriptive name in the Description text field; for this deployment example, the value is From Local SIP EP
Click OK.
Highlighted Example New Call Routing Table for Registered SIP Client-Initiated Call Processing
For more information about creating call routing tables, refer to Managing Call Routing Tables.
In the left navigation pane, go to Call Routing -> Transformation .
Click the Create (
) icon.In the Description dialog box, enter the desired Transformation Table name identifier for calling to the PSTN. For our example deployment, the entered name is from SIP to IMS.
Click OK .
Highlighted New Transformation Table for Registered SIP Clients to Call the PSTN
For details on Transformation Table configuration, refer to Managing Transformation Tables.
Click the Create ( ) icon
Type or select the following values to specify the passthrough of dialed digits from the subtended registered Yealink Survivability (SIP) client to the PSTN:
New Transformation Table Entry Attributes for Registered SIP Clients to Reach the PSTN
Field | Required Entry |
---|---|
Description | Specify a descriptive name for the entry. In the example deployment, the entered name is SIP to PSTN. |
Admin State | Set the administrative state to Enabled. |
Type (Input Field) | Specify the type for input as Called Address/Number. |
Value (Input Field) | Specify an asterisk (.*) to indicate acceptance of any digits. |
Type (Output Field) | Specify the type for output as Called Address/Number. |
Value (Output Field) | Specify the value of output as \1 to indicate that digits received will be passed through to the outbound route without any change made. |
For details on Transformation Table Entry configuration, refer to Creating and Modifying Entries to Transformation Tables. For call digit matching and manipulation through the use of regular expressions, please reference Creating Call Routing Logic with Regular Expressions.
Click OK .
Highlighted New Transformation Table Entry for Registered SIP Clients to Call the PSTN
In the left navigation pane, go to Call Routing > Transformation.
Click the Create ( ) icon.
In the Description dialog box, enter the desired Transformation Table name identifier for intra-office calling. For our example deployment, the entered name is from SIP to SIP.
Click OK.
Highlighted New Transformation Table for Registered SIP Clients to Call Other SIP Clients in the Office
For details on Transformation Table configuration, refer to Managing Transformation Tables.
In the left navigation page, go to Transformation, and select (click) the new Transformation Table just created for intra-office calling. In example deployment, the entered name is from SIP to SIP. The table will appear under the tabs, with a note stating – Table is empty --
Click the Create ( ) icon
Enter or select the following values into the pop-up window, to specify the pass through of dialed digits from the subtended registered Yealink Survivability (SIP) client to another subtended registered Yealink Survivability (SIP) client.
Transformation Table Entry Attributes for Intra-Office Calling
Field | Required Entry |
---|---|
Description | Please use a descriptive name for the entry. In the example deployment, the entered name is SIP to SIP. |
Admin State | Enabled |
Type (Input Field) | Called Address/Number |
Value (Input Field) | Please enter a regular expression to confirm a private dial plan number that conforms to the private dial plan assigned to the registered SIP clients. In the example deployment, the entered expression is ^(3\d{4})$, signifying the called digits must be 5 characters in length, and must start with a 3. |
Type (Output Field) | Called Address/Number |
Value (Output Field) | \1 , signifying matching digits received will be passed through to the outbound route without change. |
For details on Transformation Table Entry configuration, refer to Creating and Modifying Entries to Transformation Tables. For call digit matching and manipulation through the use of regular expressions, please reference Creating Call Routing Logic with Regular Expressions.
Click OK .
Highlighted New Transformation Table Entry for Registered SIP Clients to Call Other Registered SIP Clients
In the left navigation pane, go to Call Routing > Call Routing Table and select the newly created Call Routing Table; for our example deployment, the newly created table is From Local SIP EP.
Click the Create Routing Entry ( ) icon to create the route for calling into the PSTN.
Enter the following values into the pop-up window:
Call Routing Entry Attributes for Calling from Registered Yealink Devices to the PSTN
Field | Required Entry |
---|---|
Description | Enter an informative name in the text field; for our example deployment, the value is to IMS |
Admin State | Select Enabled |
Number/Name Transformation Table | Select the newly created Transformation Table instance to which calls from a subtended registered Yealink device will be routed to the PSTN. For the example deployment, the value is from SIP to IMS. |
Destination Type | Select Normal |
Destination Signaling Groups | Select the PSTN-related Signaling Group. For the example deployment, the value is IMS |
All other fields | Please leave all default values as-is for basic configuration purposes. |
For details on call routing table entry configuration including modification of fields with default values, refer to Creating and Modifying Entries to Call Routing Tables.
Click OK .
Example Call Routing Entry Attributes for Calling from Registered Yealink Devices to the PSTN
Click the Create Routing Entry (
) icon once again to create the route entry for intra-office calling.Type or choose the following values:
Call Routing Entry Attributes for Calling from Registered Yealink Devices to Other Registered Yealink Devices
Field | Required Entry |
---|---|
Description | Type a descriptive name in the text field; for the example deployment, the value is SIP TO SIP. |
Admin State | Select Enabled |
Number/Name Transformation Table | Select the newly created Transformation Table instance to which calls from a subtended registered Yealink device will be routed when attempting to reach another subtended registered Yealink device. For the example deployment, the value is from SIP to SIP. |
Destination Type | Select Registrar Table |
Destination Signaling Groups | Select the newly created SIP Local Registrar-related Signaling Group to which the subtended registered Yealink devices are associated. For the example deployment, the value is LocalReg |
All other fields | Leave all other default values as-is for basic configuration purposes. |
Click OK.
Example Call Routing Entry Attributes for Calling from Registered Yealink Devices to Other Registered Yealink Devices
Review and confirm the two new Call Routing Table entries in the newly created Call Routing Table.
New Priority Call Routing Table Entry
Access the WebUI, click the Settings tab.
In the left navigation pane, go to Signaling Groups.
From the top menu bar, click Create Signaling Group and select SIP Signaling Group (note: for the SBC SWe Lite, select Add SIP SG )
Create the SIP Signaling Group using the following configuration:
SIP Signaling Group Attribute Values for Registered Yealink Devices
Field | Required Entry |
---|---|
Description | Enter an informative name in the Description text field; for the example deployment, the value is LocalReg . |
Admin State | Select Enabled |
Call Routing Table | Select the recently created Call Routing Table Instance that will define routing for calls that originate from the subtended registered Yealink devices. For the example deployment, the value is from Local SIP EP . |
SIP Mode | Select the Local Registrar value. |
Registrar | Select the recently created SIP Local Registrar instance to which subtended Yealink devices will advertise their presence. For the example deployment, the value is LocalReg. |
Challenge Request | Select Enable |
Local/Pass-thru Auth Table | Select the recently created Local Pass-through Authorization Table that defines the credentials the subtended Yealink devices must present to the SBC to be successfully recognized (registered). For the example deployment, the value is Local registration table. |
Media List ID (Optional Step for encrypted media) | If you specified a new TLS Profile ID, please select the Media List ID value associated with Phone System Signaling Group for SRTP communication with the registered subtended Yealink client devices. The value to be selected should be MS Teams Media List , originally created through the use of the Teams DR-related easy configuration wizard during the SBC setup. The contains SRTP cryptographic settings that can be used for SBC Edge ↔ subtended registered Yealink client device encrypted media exchange. NOTE: For details on Media List ID configuration including the setup of attributes related to media encryption, please refer to Managing Media Lists and Managing SDES-SRTP Profiles . |
Listen Port | Click the ( ) icon to create a new instance of the SIP Listen Port, and update as follows:Option 1: For unencrypted SBC Edge ↔ subtended registered Yealink client device communication, please enter the Port value as 5060, the Protocol value as UDP, and the TLS Profile ID as N/A. Option 2: For encrypted SBC Edge ↔ subtended registered Yealink client device communication (you must have specified a new TLS Profile ID entry earlier), please enter the Port value as 5061, the Protocol value as TLS, and the TLS Profile ID as the new entry created earlier (e.g. Yealink SIP Client SBC Signaling) . |
Federated IP/FQDN | Click the ( For our example deployment, the IP/FQDN is entered as XXX.0.0.0, with the Netmask/Prefix as 255.0.0.0, meaning the signaling group will accept communication with any host (i.e. Yealink device) that presents a host IP of anywhere from XXX.0.0.1 → XXX.255.255.254 ) icon to create a new instance of the Federated IP/FQDN, and specify as follows to identify the networking IP addresses of your Yealink Teams client devices, supplied by the enterprise IT administrator. |
All other fields | Please leave all default values as-is for basic configuration purposes. |
For details on Signaling Group configuration attributes described above including modification of fields with default values, refer to Creating and Modifying SIP Signaling Groups.
Click OK . The new SIP Signaling Group (in the example deployment, named LocalReg ) may be expanded to present the following sample attributes.
Example SIP Signaling Group Configuration for Connection to Registered Yealink Teams Devices; Key User-Supplied values Highlighted
In the WebUI, click the Settings tab.
In the left navigation pane, Call Routing -> Transformation .
Click the Create (
) icon.In the Description dialog box, enter the desired Transformation Table name identifier for calls received from the PSTN and destined for a subtended Yealink device. For our example deployment, the entered name is from IMS to SIP.
Click OK .
Highlighted New Transformation Table for PSTN Call Routing to Registered Yealink Devices
For details on Transformation Table configuration, refer to Managing Transformation Tables.
In the left navigation page, go to Transformation, and select (click) the new Transformation Table just created. In example deployment, the entered name is from IMS to SIP. The table will appear under the tabs, with a note stating – Table is empty --
Click the Create ( ) icon
Enter or select the following values into the pop-up window, to specify the modification of dialed digits from the PSTN to reach a subtended registered Yealink Survivability (SIP) client:
New Transformation Table Entry Attributes for a PSTN Call to Reach a Specific Registered Yealink Device
Field | Required Entry |
---|---|
Description | Please use a descriptive name for the entry. In the example deployment, the entered name is Entry ID 1 |
Admin State | Enabled |
Type (Input Field) | Called Address/Number |
Value (Input Field) | Please enter a regular expression to define the Teams Phone Number assigned to the Yealink device with the survivability. In the example deployment, the entered expression is \+86XXXX604392, the Teams Phone Number assigned to the Yealink device that also carries the SIP phone number 30001 (latter used in the Survivability UI). |
Type (Output Field) | Called Address/Number |
Value (Output Field) | Enter a regular expression to replace the Teams Phone Number dialed by the PSTN user to the assigned to the SIP phone number assigned to the Yealink device with the survivability. In the example deployment, the entered expression is 30001, the Teams Phone Number assigned to the Yealink device that also carries the Teams Phone Number +86XXXX604392 (latter used in the Teams client UI). |
For details on Transformation Table Entry configuration, refer to Creating and Modifying Entries to Transformation Tables. For call digit matching and manipulation through the use of regular expressions, please reference Creating Call Routing Logic with Regular Expressions.
Click OK.
New Transformation Table Entry for PSTN Calls to Reach Registered Yealink Device
Repeat steps 1, 2 & 3 for each remaining possible registered Yealink device with both the Teams client and the Survivability (SIP) client. In the example deployment, steps 1, 2, and 3 are repeated for the Yealink device with the SIP phone number 30003.
Completed Example New Transformation Table for PSTN Calls to Reach Registered Yealink Devices
In the left navigation pane, go to Call Routing > Call Routing Table and select the Call Routing Table originally created through the use of the Easy Configuration wizard (refer to Using the Easy Configuration Wizard) template for processing calls originating from the PSTN. For our example deployment, the table requiring the new entry is From IMS .
Click the Create Routing Entry (
) icon.Enter the following values into the pop-up window:
Key Call Routing Entry Attribute Values That Must be Explicitly Submitted by User
Field | Required Entry |
---|---|
Description | Enter an informative name in the text field; for our example deployment, the value is from IMS TO SIP |
Admin State | Select Enabled |
Number/Name Transformation Table | Select the newly created Transformation Table instance to which calls from the PSTN will be routed during survivability scenarios (i.e. when Phone System is unavailable). For the example deployment, the value is from IMS to SIP. |
Destination Type | Select Registrar Table |
Destination Signaling Groups | Select the newly created SIP Local Registrar-related Signaling Group to which the subtended Yealink devices are associated. For the example deployment, the value is LocalReg |
All other fields | Leave all default values as-is for basic configuration purposes. |
Call Route Entry Attributes for Example Teams Survivability-Related Call Route Entry
For details on call routing table entry configuration including modification of fields with default values, refer to Creating and Modifying Entries to Call Routing Tables.
Click OK and review the new Call Routing Table Entry related to survivability in the updated PSTN-related Call Routing Table from the left navigation pane.
Newly Created Teams Survivability Call Routing Entry in PSTN-Originated Call Routing Table
Access the WebUI, click the Monitor tab. Confirm the new SIP Signaling Group instance associated with the new SIP Local Registrar instance is active. For our example deployment, the new SIP Signaling Group instance is LocalReg.
Example SIP Signaling Group Linked to Registered Yealink Devices Shows Active
This section assumes the following actions are complete:
The following general (i.e. not sample) CLI commands may be submitted via the Yealink client devices UI to enable registration with the SBC for Teams client survivability services.
features.hybrid_mode.enable=1 account.X.sip_server.1.address = <SBC IP Address> account.X.user_name = <Username> account.X.password = <Password> [X ranges from 1 to 16] features.hybrid_mode.quick_ball.enable=1 [This item is optional]
Sample commands (based on our example deployment) will appear as follows:
features.hybrid_mode.enable=1 account.1.sip_server.1.address = XX.1.10.127 account.1.user_name = 30001 account.1.password = XXXXX features.hybrid_mode.quick_ball.enable=1
The user also has the option to submit instructions via a configuration file (*.cfg) to enable registration with the SBC for Teams client survivability services. To undertake such an operation, please refer to Yealink Teams client reference material.
The configuration commands (whether via a configuration file or the CLI) must be repeated with each Yealink client device that is to register with the SBC Edge.
Product manuals that describe the configuration and operation of the Teams clients may be found at support.yealink.com
Five key tests are required to confirm the Yealink Teams client devices can successfully offer users survivability services in the event that Phone System is unavailable, while defaulting to Teams-related services when Phone System is available.
Confirm the phone icons in the device's Survivability (SIP) UI are green signifying successful registration and availability with a remote SIP server (in this case, the SBC's SIP Local Registrar). Note the 30001 phone number assigned to the Yealink device.
Yealink Device Survivability (SIP) UI with Green Phone Icons
Access the WebUI, click the Settings tab.
In the left navigation page, access SIP > Local Registrars Table.
Confirm the SIP Local Registrar instance created to support survivability appears in the main body of the WebUI. For our example deployment, the the SIP Local Registrar instance is identified as LocalReg.
From the SIP Local Registrar instance presented in step 2, click Registered Users.
Registered Yealink Phones with Example SIP Local Registrar
Confirm the presence of the Yealink device. For the example deployment, the correct user name (phone number) is 30001 and is clearly visible in the first row of the table.
For details surrounding the information available on the registered users, refer to Managing SIP Local Registrars.
Access a Yealink device's Survivability (SIP) UI. In the example deployment, one such device is the 30001 client.
Yealink Device Survivability (SIP) UI
Place a call from the UI to the PSTN, and confirm two-way audio. Note the following indicators in the UI:
The green handset icon indicating a live call;
The Talking text indicating a live audio path.
Yealink Device Displaying Active Call in Survivability Mode with PSTN Client via the SBC
Access the WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams.
Review the channel states for each signaling group, and confirm correct operation:
One channel is seized (blue) in the PSTN-related signaling group (for our example deployment, the IMS signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device (e.g. call direction is outgoing, call originator has the same phone number as the Yealink device, called party number is the dialed PSTN number, etc.).
One channel is seized (blue) in the SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device.
All channels remain idle (light green) in Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group).
SBC Displaying (from the Monitor) an Active Call Between Yealink Client (in Survivability Mode) with PSTN Client via the SIP Trunk
For details surrounding the information available in the monitor related to signaling groups, refer to Monitoring Real Time Status . Note pop-ups must be enabled in your Internet browser to allow channel details to be presented.
Access one SBC subtended Yealink device's Survivability (SIP) UI. In the example deployment, one such device is the 30001 client.
Yealink Device Survivability (SIP) UI
Place a call from the Survivability (SIP) UI to a second Yealink device, using the SIP phone number to the second Yealink device. For the example deployment, the SIP phone number assigned to the second Yealink device is 30003.
Please dial from first Yealink device the SIP phone number associated with the second Yealink device, as opposed to the phone number associated with the Teams (SIP) client. By using the SIP phone number, the test confirms that the transformation and routing table entries associated with the SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group) have been correctly provisioned for intra-office dialing when Phone System is unavailable.
Answer the call from the Survivability (SIP) UI on the second Yealink device, and confirm two-way audio. Note the following indicators in the UI:
The green handset icon indicating a live call;
The Talking text indicating a live audio path.
Yealink Device Displaying Active Call in Survivability Mode with PSTN Client via the SBC
Access the WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams .
Review the channel states for each signaling group, and confirm correct operation:
Two channels are seized and in connected state (channels will be blue) in the SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group). Double-click either seized channels to ensure consistency between the channel details and the call placed from one Yealink device to the other.
All channels remain idle ( represented by the light green) in the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group) as well as the PSTN-related signaling group (for our example deployment, the IMS signaling group).
SBC Displaying (from the Monitor) an Active Call Between Yealink Client (in Survivability Mode) with PSTN Client via the SIP Trunk
For details surrounding the information available in the monitor related to signaling groups, refer to Monitoring Real Time Status.
Access the Yealink device's Teams UI.
Yealink Device Teams UI
Place a call from the Teams UI to the PSTN, and confirm two-way audio. Note the active call indicators in the display.
Yealink Phone Displaying Active Call (in Teams Mode) with PSTN Client via the SBC
Access the WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams .
Review the channel states for each signaling group, and confirm correct operation:
One channel is seized (blue) in the PSTN-related signaling group (for our example deployment, the IMS signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device (e.g. call direction is outgoing, call originator has the same phone number as the Yealink device, called party number is the dialed PSTN number, etc.).
One channel is seized (blue) in the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device.
All channels remain idle (light green) in the SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group).
SBC Displaying (from the Monitor) an Active Call Between Yealink Client (in Teams Mode of Operation) with PSTN Client via the SIP Trunk
Access the WebUI, click the Settings tab.
In the left navigation pane, go to Signaling Groups
From the main display, select the check box next to the Teams Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group) and click the Out of Service () icon.
Confirm that the Phone System-related signaling group is out of service, through the Down indication in the Service Status field.
Example Teams Phone System-Related SIP Signaling Group in Out of Service State
For details on SIP Signaling Group operation including enablement and disablement, refer to Creating and Modifying SIP Signaling Groups.
Access the Yealink device's Survivability (SIP) UI.
Yealink Device Survivability (SIP) UI Prior to Incoming Call
Place a call from the PSTN to the Yealink device, using the Teams phone number assigned to the Yealink device. For the example deployment, the Teams phone number assigned to the Yealink device with the 30003 SIP-related number is +86XXXX604393.
Please dial from the PSTN the phone number required to reach the Teams client on the Yealink device, as opposed to the phone number associated with the Survivability (SIP) client. By using the Teams client phone number, the test confirms that the transformation table entries associated with the PSTN signaling group (for our example deployment, the IMS signaling group) have been correctly provisioned for survivability routing.
Confirm an incoming call is presented in the Survivability (SIP) UI. Note the alerting indication.
Yealink Device Displaying Incoming Call from PSTN Client
Access the SBC's WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams .
Review the channel states for each signaling group, and confirm correct operation:
The PSTN-related signaling group (for our example deployment, the IMS signaling group) presents an alerting indication (magenta) in a single channel. Double-click the seized channel to ensure consistency between the channel details and the call placed from the PSTN (e.g. call direction is incoming, called digits are the Teams client number of the 30003 endpoint, calling party number is the PSTN endpoint, etc.).
The SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group) presents an alerting indication (magenta) in a single channel. Double-click the seized channel to ensure consistency between the channel details and the call placed from the PSTN (e.g. call direction is incoming, called digits are the Teams client number of the 30003 endpoint, calling party number is the PSTN endpoint, etc.).
All channels remain out of service (gray) in the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group).
SBC displaying (from the Monitor) a call attempt from the PSTN to a Yealink device, Using a Teams client #
From the Yealink device's survivability (SIP) UI, answer the call and confirm two-way audio. Note the following indicators in the UI:
The green handset icon indicating a live call;
The Talking text indicating a live audio path.
Yealink Device Displaying Active Call in Survivability Mode with PSTN Client
Access the SBC's WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams .
Review the channel states for each signaling group, and confirm correct operation:
The PSTN-related signaling group (for our example deployment, the IMS signaling group) presents a connected indication (blue) in the channel that previously presented the alerting indication. Double-click the seized channel to ensure consistency between the channel details and the call placed from the PSTN (e.g. call direction is incoming, called digits are the Teams client number of the 30003 endpoint, calling party number is the PSTN endpoint, etc.).
The SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group) presents a connected indication (blue) in the channel that previously presented the alerting indication. Double-click the seized channel to ensure consistency between the channel details and the call placed from the PSTN (e.g. call direction is incoming, called digits are the Teams client number of the 30003 endpoint, calling party number is the PSTN endpoint, etc.).
All channels remain out of service (gray) in the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group).
SBC displaying the connected call from the PSTN to a Yealink device, Using a Teams client #
Access the WebUI, click the Settings tab.
In the left navigation pane, go to Signaling Groups
From the main display, select the check box next to the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group) and click the Enable ( ) icon.
Confirm the Phone System-related signaling group is active, through the Up indication in the Service Status field.
Access the Yealink device's Teams UI.
Yealink Device Teams UI
Place a call from the PSTN to the Yealink device, using the Teams phone number assigned to the Yealink device. For the example deployment, the Teams phone number assigned to the Yealink device with the 30003 SIP-related number is +86XXXX604393.
Please dial from the PSTN the phone number required to reach the Teams client on the Yealink device, as opposed to the phone number associated with the Survivability (SIP) client. By using the Teams client phone number, the test confirms that the routing table entries associated with the PSTN signaling group (for our example deployment, the IMS signaling group) have been correctly provisioned to prioritize call routing to Phone System when the latter is available for processing calls.
Confirm an incoming call is presented in the Teams UI. Note the alerting indication.
Yealink Device Displaying Incoming Call from PSTN Client in Teams UI
Answer the call, and confirm two-way audio.
Yealink Phone Displaying Active Call (in Teams Mode) with PSTN Client via the SBC
Access the WebUI, and click the Monitor tab.
Expand the three signaling groups (that pertain to the survivability scenario) so all channels become visible. For our example deployment, the three signaling groups identifiers are LocalReg (the signaling group to which the Yealink devices are registered), IMS (the PSTN-related signaling group), and Microsoft Teams.
Review the channel states for each signaling group, and confirm correct operation:
One channel is seized (blue) in the PSTN-related signaling group (for our example deployment, the IMS signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device (e.g. call direction is incoming, called party number has the same phone number as the Yealink device, calling party number is the PSTN number from which you made the call, etc.).
One channel is seized (blue) in the Phone System-related signaling group (for our example deployment, the Microsoft Teams signaling group). Double-click the seized channel to ensure consistency between the channel details and the call placed from the Yealink device.
All channels remain idle (light green) in the SIP local registrar-related signaling group (for our example deployment, the LocalReg signaling group).
SBC Displaying (from the Monitor) an Active Call Between Yealink Client (in Teams Mode of Operation) with PSTN Client via the SIP Trunk
If all test cases are successfully completed, Teams client survivability is correctly provisioned and operational. If any test cases fail, please revisit all prerequisites and provisioning.