SIP Softphone Lines

This chapter describes how to add and configure SIP softphone lines. The line can be used by the ProCall client to make phone calls via a SIP PBX by assigning the line number to a user.

Add and configure new lines

In the Lines dialog, press the Add telephone system button and select your system from the list of known telephone systems. Softphone lines can be configured using classic SIP registration or via a SIP trunk. be connected to the telephone system. Pressing Add calls up an SIP wizard which will guide you through the configuration. If you want to modify an existing line, you can right-click on the corresponding line or line group and modify Properties.

Configure the location settings in the Line Group.

Registrar
or SIP trunk registrar
or SIP trunk connection (for SIP trunk with fixed IP)

• Name of the Line Group
  Choose a unique name as desired for the group of lines. If multiple telephone systems should be integrated into UCServer, a name that identifies the telephone system used will be helpful.
• Registrar/IP Address (of the PBX)
  Enter the DNS name (FQDN) or the IP address of the registrar or of the SIP trunk of the telephone system. Enter the port that the telephone system uses for SIP messages (usually 5060).
  If the telephone system is to be connected via a proxy, the IP address or the FQDN of the proxy server is configured here. In most cases, the setting of the registrar domains is also required (see below).
• Domain
  If the registration at the telephone system is to take place via a proxy, the setting of the registrar domain is usually required. In this case, deactivate the Apply registrar as logon domain field and enter the desired value in the Domain field. If, for example, a Session Border Controller (SBC) is to be placed as a proxy between the telephone system and the UCServer, the SBC can be addressed with the parameter "Registrar/IP address" and the domain of the telephone system with the parameter "Domain". This menu item is only available for certain telephone systems.
• Register expires
  UCServer will send a SIP REGISTER notification to the telephone system so that the softphones will be made available for calls. If necessary, choose the time period that should be entered for cyclical SIP REGISTER notifications in accordance with RFC3261 using the Expires entry. The value should be greater than or equal to the corresponding setting of the registrar. A value that is too small can lead to logon errors. If the telephone system answers with a different value, this is automatically taken over by UCServer. This menu item is only available for telephone systems with registrar.
• Register delay
  UCServer can insert a delay between SIP REGISTER messages. This makes it possible, in large installations with many registrations, to avoid overloading the telephone system when starting UCServer. If necessary, deviate from the default value and select an appropriate value.
• NAT Refresh
  The UCServer can send cyclical "NAT Refresh" messages to the SIP registrar, in case the SIP registrar is located behind a NAT Device. This is the case e.g. if a UCServer located in the internal LAN has to log on to an SIP registrar of a SIP provider in the public internet (WAN). In many cases, the time between two SIP registrations is sufficient (see menu item Reregister after) to keep the ports on the NAT open for incoming calls. Then cyclical NAT Refreshes can be deactivated by setting 0 s. However, if there is not enough time, a corresponding value may be selected. The value does not depend on the set SIP provider, but rather depends on the used NAT Device. This menu item is only available for specified telephone systems (e.g. SIP provider).
• SIP Transport
  In some cases it is desirable to set a different value for the SIP Transport Protocol than the default. However, it is recommended to leave the default settings, since they have been tested for proper function. If you make changes to the settings, you are doing so at your own risk. The UDP, TCP and TLS/sRTP transport protocols are offered. If TLS (in the signaling) is set, sRTP (for Media) will automatically be used. Please also make certain to use a port suitable for the transport protocol, which is set at the Registrar (e.g., for UDP usually Port 5060 and for TLS Port 5061, depending on the setting of the telephone system).
• SIP Options Refresh
  The UCServer sends SIP OPTIONS messages to the PBX cyclically to maintain the connection state to the PBX. If necessary, select the maximum time period that should elapse between SIP OPTIONS messages. This menu item is only available for telephone systems with SIP trunk and fixed IP address.
• SIP GW Listener
  If the SIP trunk of the telephone system uses a fixed IP address, the set network interface is displayed here via SIP GW Listerer with the IP address, port and transport protocol. This menu item is only available for telephone systems with SIP trunk and fixed IP address.

Softphone registrations and lines

Softphone registrations an der PBX oder Nummern aus dem Rufnummernbereich eines SIP-Trunks entsprechen den Softphone-Leitungen im UCServer.

For a SIP trunk with registrar, registering one number (e.g. the first number of the number range) activates the entire SIP trunk on the PBX. The remaining numbers of the number range must be added during the configuration in the wizard by "configure more softphones" or in the line group in the tab "Softphone lines". In the "Softphone lines" tab, the number registering the SIP trunk is marked with a "Register".
In the case of a SIP trunk with a fixed IP address, on the other hand, a "Refresher" is marked in the "Softphone lines" tab, which uses cyclic SIP OPTIONS to maintain the connection state with the PBX.

• User name(s)
  Enter the user name for logging on to the SIP Registrar here. The user name usually corresponds to the call number of the SIP-Softphone line. If you wish to register several call numbers at the PBX, which have the same password, you can also define several call numbers (e.g.e.g. 123 or 100-120 or also 150;177;200-220). If the user name does not match the call number of the line, a call number can be manually assigned to the line.
  If multiple phone numbers should be registered with the PBX, activate the Configure Additional Softphones option. Doing so will list all registrations from that group of lines. The registrations can be changed, deleted or others added. New registrations can also be added by importing softphone lines.
• Password
  Enter the password for SIP authentication, if present.
• Auth. user name
  If you have to configure an authentication user name please uncheck Take authentication user name from user name. Enter the value into the field Auth. user name. If you enter multiple numbers and these are a part of the authentication user name you may use the place holder <*>. At the appropriate place in the Authentication user name, <*> is replaced by the number entered in the User name field.
• Phone number
  Some telephone systems require a manual configuration of the call numbers when the user name of the Softphone registration does not match the extension number of the line. For manual configuration, deactivate the Apply Call Number from User Name field. Enter the desired value in the Call number field. This can be the extension or the canonically formatted number (e.g., +49123456781). The number must correspond to the location settings. This menu item is only available for specified telephone systems (e.g., SIP providers). However, it is also visible when the parameter Automatically set call numbers is deactivated in the Settings of the line group.
• Registrar SIP-Trunk User
  The number or line for registration can be changed by activating the "SIP Options Refresher" checkbox for a different number. This menu item is only available for SIP trunk connections via registrar.
• SIP Options Refresher
  The number or line for the SIP Options Refresh can be changed by activating the corresponding checkbox for a different number. This menu item is only available for SIP trunk connections with a fixed IP address.

Import of Softphone lines

In the case of a large number of Softphone lines, manually entering the user name, password and call number via dialog box is rather time-consuming. For this reason, there is an import function available for importing the line information from a CSV formatted file. In the dialog box for Softphone registrations the Add button can be expanded by the Import option. The import file can be selected there.
The data records to be imported must be present in the import file in the CSV format (values separated by commas). For each Softphone line to be imported, one line must be provided containing the required parameters.
The sequence of the parameters is strictly defined. Missing values must be marked with a comma.

Value: User name (mandatory field),
Value: Auth.User name (optional),
Value: Password (optional),
Value: Call number deviating from user name (optional).

Example of data records to be imported with non-used Auth. User name:

abc_xxx,,asdfghjklö,+49123456781
abc_yyy,,asdfghjklö,+49123456782
abc_zzz,,asdfghjklö,+49123456783
...

The Import function only allows new user name entries to be added. Existing user name entries are skipped over in the list of Softphone registrations, even if parameters in those entries have been changed. An import also cannot be used to delete user names from the list.

Line group name (defined under Registrar)

• Line group properties
  

PCAP-Log

• SIP PCAP log files
  You can find more information in the chapter Creating SIP PCAP Log Files.

Activation of the SIP Softphone Lines

Once the SIP softphone line appears as a line in the group(s) of lines, the line can be activated by checking the left checkbox and clicking the Accept button at the top. A colorful icon symbolizes the line status or the success of the SIP registration with the telephone system. Green indicates successful registration. A mouse tooltip will provide additional indicators about the current status (such as Line is functional). To see the SIP notifications, the corresponding line can be right-clicked and Display SIP Events selected from the context menu to inspect them more precisely and track the SIP notifications in an event window. To reset the line (send a new SIP registration message), right-click on the corresponding line and re-start by selecting Reset Line on the context menu.

Once registration is successful (the icon is green), the line can be assigned to a User (see User Administration - Users). Right-clicking on the corresponding user and selecting Properties from the context menu will display the Telephone Numbers tab page where the line can be selected from the Business entry or the First Telephone entry using the button on the right. Alternatively, the number that corresponds to the line number can be entered manually.