Introduction

With the Device Connection Framework (DCF), Swyx defines a standard that enables every telephone manufacturer to integrate their SIP phones into SwyxWare. Where possible, the DCF is based on the RFC standards and defines clear interfaces for the areas that are not specified in the RFCs.

DCF is not limited to the usual call scenarios, but also covers the CTI / remote control functions for SIP phones according to uaCSTA specification.

Installation

The Swyx Control Center (SCC) is mandatory for the installation and configuration of the new DCF/Yealink phones. The configuration is not possible via the previous MMC based SwyxWare Administration.

For SwyxON all necessary installations regarding SCC are done automatically for you.

In the SwyxWare on premises case proceed as follows:
You install the SCC separately via the SwyxControlCenter.msi installation package on the SwyxServer. The SCC is based on the IIS, which can be installed if necessary. Then open the SCC in the browser of your choice via https://ServerName:9443/SwyxControlCenter. During the SwyxWare installation you were asked to create an administrative account. With this account you log in to the SCC.

Provisioning the phones

For the provisioning of telephones, a distinction must be made between operation with the SwyxON cloud solution and SwyxWare on premises. In both cases the phone must be created in SwyxWare using the new Swyx Control Center (SCC), the web-based administration of SwyxWare, and assigned to a SwyxWare user via its MAC address. Please refer to the Swyx Control Center online help for the individual steps.

Provisioning for SwyxON

After the phone including its MAC address has been created in the SCC, SwyxWare stores the MAC address of the phone at the Yealink provisioning server. In addition to the MAC address of the phone, the IP address of the SwyxServer assigned to this phone is also stored. As soon as the Yealink phone is connected to the network and starts for the first time, it will contact the Yealink Provisioning Server and receive the initial configuration data, e.g. the IP address of the responsible SwyxServer.

Provisioning for SwyxWare on premises

Also in the on premises case the phone including its MAC address is created in the SCC. In this case, however, no communication with the Yealink provisioning server is necessary.
The Yealink phone sends a multicast to the network (SIP SUBSCRIBE) during commissioning. The SwyxServer will answer this multicast message with a SIP 200 OK and send a SIP NOTIFY to the phone. This NOTIFY message contains a provisioning URL for the phone in its content. The phone will call this provisioning URL. The URL is structured like this:

http://SwyxServerName.company.com:9200/ippbx/client/v1.0/device/provision/

(!) It is important that the DNS server in the network is configured correctly and can resolve the DNS name of the SwyxServer communicated in the URL (in the example SwyxServerName.company.com).

Tip: If it is not possible to configure a DNS server accordingly, or to ensure the transmission of multicasts between phone and SwyxServer, you can create the string REG_SZ LocalIpAddress in the registry under HKLM\Software\Wow6432Node\Swyx\General\CurrentVersion\Options on the SwyxServer and enter the IP address of the SwyxServer there, as well as restart the SwyxServer service afterwards.
The DNS name of the SwyxServer is then no longer used in the above mentioned provisioning URL, but its IP address.

Example:
HKLM\Software\Wow6432Node\Swyx\General\CurrentVersion\Options
(REG_SZ) LocalIPAddress=172.20.1.1

(!) Since the phone sends a multicast, make sure that the phone and the SwyxServer are in the same network segment, or at least that the multicast message is forwarded if routers are between the phone and the SwyxServer.

Tip: If it is not possible to ensure that the multicast messages of the phone arrive at the SwyxServer, you can configure the phone manually with the provisioning URL. To do this, go to the web interface of the phone: http://IpAdresseDesTelefons. Then log in with the default credentials user name "admin" and password "admin". In the menu "Settings/Auto Provision" enter in the line "Server URL" the above mentioned provisioning URL (e.g. "http://172.20.1.1:9200/ippbx/client/v1.0/device/provision/" the 172.20.1.1 has to be replaced by the SwyxServer IP address). In the entry "User Name" please enter the MAC address of the phone (without any delimiter symbols, format has to be like "805e0c10fd78") and in the line "Password" please enter the activation key of the phone, which you can see in the Swyx Control Center. Then first click "confirm" at the bottom to save these new settings, then click on "Autoprovision Now" to start the process.

Alternative: If you want to use multiple phones where multicast messages cannot be used due to the network infrastructure, you can also distribute the above provisioning URL via DHCP Option 66.

Technical Info

The Yealink phones are authenticated at SwyxWare via their MAC address and the PIN to be entered once by the SwyxWare user. It is not necessary to configure SIP Credentials or SwyxWare username/password combinations via SwyxWare Administration for the Yealink phones.

The CTI control is supported by the Windows client SwyxIt! and the MAC client Swyx Desktop.

To activate the CTI control for the Yealink phones in the soft client (SwyxIt! or Swyx Desktop for MAC) at any time, the phones not only log on to the SwyxServer service but also to the new SwyxUaCSTA service via SIP REGISTER. This service is mandatory for the CTI control of the DCF phones via uaCSTA protocol. If this second login is not desired, the function "Use SIP terminals as system telephone" can be activated at the SwyWare user under Settings/Administration/SIP. This setting must also be activated if a SIP telephone (e.g. DECT telephone) is to be controlled via CTI+.

The Yealink phones use LDAP to display the global phonebook of the SwyxWare. SwyxWare provides this via port 389.

Currently the call forwarding configuration and the DND status are always synchronized for all devices of a SwyxWare user.

Additionally the BusyLampField (BLF) and call pickup with the Yealink phones are supported.

(!) Only the Yealink phones of the S-Series (T41S, T42S, T46S, T48S) and the Conference Phones CP920, CP960 & CP960 WIMI are supported with SwyxWare. There is no support for the G-Series!

(!) The Yealink phone should only be configured via the Swyx Control Center (SCC), never directly via the phone's web interface. Reason: Configurations made directly via the phone's web interface (e.g. name key assignments) are not overwritten when configured via the SCC. I.e. in this case only a factory reset of the Yealink phone helps to be able to configure it again completely with the SCC. The phone can be reset in the basic state by simply pressing the OK button for a long time, or alternatively via the menu/web interface.

(!) The DCF/Yealink phones can be used from SwyxWare version 11.25 and require for each phone the new license "Feature Pack for certified SIP phones".

Firmware Updates

By default, the Yealink phones contact the Yealink server for firmware updates. However, it is also possible to provide a local server for firmware updates. Both ftp and http are supported for the firmware update. In the online help of the SCC you will find the corresponding details.
The firmware itself can be obtained from the Yealink support pages.

Analysis Options

SwyxWare offers the usual trace possibilities, also for the new function of the DCF.

All information concerning the DCF is written to the trace files of the CDS (ConfigDataStore Service). Tracing for DCF is activated via the new "DCF" module in the IpPbxCDSService.exe.config file. Set here the value 4. In addition to the information in the trace file of the CDS, 2 files per phone are stored in the trace directory of SwyxWare by setting the value 4. These files contain all parameters with which the phone is provisioned. The file names follow this scheme:

Provisioning<MAC Address Phone>-<Timestamp>-common.cfg
Provisioning<MAC Address Phone>-<Timestamp>-mac.cfg

Example: Provisioning805ec02a4d5c-20180919-152257-mac.cfg

The file ending with common contains general parameters, e.g. network settings, the file ending with mac contains account configurations.

The SIP messages exchanged between the phone and the SwyxServer can be logged via the usual trace setting in the SwyxServer registry. For this the module "SIP" has to be set to the value 5 or higher.

The same applies to the recording of the SIP messages of the new SwyxUaCSTA service.

The tracesetting can be found under the registry key [HKLM\software\Wow6432Node\Swyx]. There the values are to be set in the corresponding subkey for the IpPbxSrv and IpPbx.uaCSTA.

Manufacturer information

Further information, including technical details, can be obtained directly from the manufacturer Yealink via its website (user guides, administrator guides, etc.):

Yealink SIP-T4X Info