Integration › PBX / SBC

Innovaphone

CTI

Innovaphone systems can be connected to the XPhone server classically via a TAPI service provider or via the newer SOAP interface.

SOAP interface

Create a user for the CTI-SOAP interface

Create a user in the Innovaphone configuration under PBX > Objects. The following points must be observed during creation:

• Select the Hide from LDAP checkbox so that this user does not appear in the address book of other Innovaphone phones/clients

• Configure a name. This will be entered later in the CTI gateway of the XPhone server.

• Configure a Password.

• Select the PBX.

• This user requires full access rights Full PBX Administration.

Tip

The Critical checkbox can be optionally set when creating the user. It means that the user is grayed out in the Innovaphone administration. This makes the user stand out visually from other users.

Hint

If no Name is configured in the Innovaphone user, the XPhone Server uses the Hardware Id as the display name for line generation.

Create a static group

• Create a static group and assign it to the user.

• All users who are to be monitored/controlled must be in this group.

XPhone Connect configuration

Hint

The chapter Trusting self-signed certificates explains the necessary steps for setting up corresponding certificates.

• Navigate in the Web-Administration to:

  System settings > Telephony & Meetings > Telephony > CTI

• Click New Landline Gateway in the header of the table. The Create new landline gateway dialogue opens:

  

• Configure the CTI gateway settings:

  • PBX Type

    Select Innovaphone.

  • Name

    Enter a unique name here.

  • Dialing parameter:

    Select a Dialling parameters.

  • Deactivated

    Set this flag if this gateway is to be preconfigured but should not go active.

  • Connection to the PBX

    Protocol: Select https or http.

    • XPhone Connect expects fully trusted certificates. You may need to import the Innovaphone RootCA in the Windows certificate store.

    Domain: Enter the IP/FQDN of the Innovaphone system.

    Tip

    You can find the domain in the Innovaphone interface under PBX > Config > DNS.

  • Access parameters

    Logon name / Password: Enter the user name and password combination of the new account that you have created in Innovaphone.

Logging

• If you want to test the connection with HTTP instead of HTTPS, the Force HTTPS checkbox must be unchecked in Innovaphone under Services > HTTP.

• If the gateway does not connect, but a red dot is displayed in the CTI gateway overview, take a look at the logging.

  Activate logging for CTI gateway

  • The log must first be activated under:

    Logging > Telephony gateways > Select CTI gateway > Edit

  • Set the log level to Debug messages.

  • Then navigate back to the created CTI gateway, check the Deactivated box and save the settings.

  • Then activate it again.

  • Select the gateway and click on Display log files.

Tip

You can see whether the SOAP registration was successful in Innovaphone under PBX > SOAP.

Special configuration

Configuration of an XPhone line (one or more Innovaphone devices)

If only one device is entered for the user in the Innovaphone administration and only one CTI line is to be created in XPhone Connect, no further configuration steps are required.

However, if several devices are entered in the Innovaphone user mask and you only want to create one XPhone CTI line, the connector uses the first device entered by the Innovaphone user for line creation by default. In the following example, the device with the hardware ID 0090334ccc38 would be used.

However, if a specific device from the list is to be used or if all devices are to be used simultaneously, further adjustments must be made in the XPhone Server, which are described in this chapter.

Specific device control

In this scenario, the Innovaphone user also has several devices as in the above image. However, it is possible that the device to be controlled is not in the first position. In this case, the device to be used can be selected via a special parameter using a regular expression.

You can carry out this configuration either directly in the lines or in the CTI gateway for all assigned lines.

Setting in the CTI gateway:

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI.

• Open the Innvoaphone CTI gateway and navigate to the Parameter records for lines (advanced settings).

• Select the entry Standard and click on Edit.

  • Click on Add and configure the new entry as follows:

    • Name = INUserDevice

    • Value = $[Regex]

      Hint

      • [Regex] stands for a string with the syntax <Hardware Id>;<Name>.

      • Example 1: If all devices with Hardware Id starting with 49 are to be used, [Regex] must be ^49.*, for example.

        • The Value field should be $^49.*.

      • Example 2: If all devices whose Hardware Id begins with 4 and whose name begins with Table are to be used, then the regex must be e.g. ^4[^;]*;Table.*.

        • • The Value field should accordingly contain $^4[^;]*;Table.*.

  • Save your settings with the Apply button.

Setting in the line:

• Navigate to: System settings > Telephony & Meetings > Telephony > Lines.

• Open an Innovaphone CTI line and open the Advanced settings .

  • Click on Add and configure the following settings:

    • Name = INUserDevice

    • Value = $[Regex]

      Hint

      • [Regex] stands for a string with the syntax <Hardware Id>;<Name>.

      • Example 1: If all devices with Hardware Id starting with 49 are to be used, [Regex] must be ^49.*, for example.

        • The Value field should be $^49.*.

      • Example 2: If all devices whose Hardware Id begins with 4 and whose name begins with Table are to be used, then the regex must be e.g. ^4[^;]*;Table.*.

        • • The Value field should accordingly contain $^4[^;]*;Table.*.

Multi-device control

You can assign all devices entered in the Innovaphone user to a line. This means that an incoming call is signaled on the XPhone Client, but since all devices are monitored simultaneously on an XPhone line, the call cannot be answered on the XPhone Client. An incoming call must therefore be accepted on the respective device.

For calls that are to be initiated via the XPhone Client, no specific device can be selected in this operating mode. Therefore, all Innovaphone devices ring after the call is initiated in the XPhone Client. The call to the destination is only set up after acceptance on a device.

Once the call has been established, the user has access to all familiar CTI functions in the XPhone Client (e.g. dial, hold, connect, conference, disconnect).

You can carry out this configuration either directly in the lines or in the CTI gateway for all assigned lines.

Setting in the CTI gateway:

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI.

• Open the Innvoaphone CTI gateway and navigate to the Parameter records for lines (advanced settings).

• Select the entry Standard and click on Edit.

  • Click on Add and configure the new entry as follows:

    • Name = INUserDevice

    • Value = *

  • Save your settings with the Apply button.

Setting in the line:

• Navigate to: System settings > Telephony & Meetings > Telephony > Lines.

• Open an Innovaphone CTI line and open the Advanced settings .

  • Click on Add and configure the following settings:

    • Name = INUserDevice

    • Value = *

  • Save your settings with the Apply button.

Configuration of multiple XPhone lines (multiple Innovaphone devices)

Here you can find out how to use several devices that you have entered in the Innovaphone user mask in the XPhone Client.

Connector configuration for multiple devices

Configure the following in the connector (Active Directory or Text):

• Select the checkbox: Assign users available lines on the basis of their phone numbers.

• Select the radio button: Assign all lines that match the phone number.

• Select the radio button: Taking consideration of advanced settings for creating lines.

  • Select also a PBX.

  • Configure under Additional flags (optional) = 0x10000000

    • This parameter is used to delegate line generation to the Landline Gateway.

    • You can also set this value via the Powershell in all connectors at the same time.

Add phone number ranges

• Navigate to the CTI gateway:

  System settings > Telephony & Meetings > Telephony > CTI

• Select the Innovaphone CTI gateway and click on Create lines.

• Use Add to add all phone number ranges whose lines are to be created via the connector.

• Exit this window with Close (Attention: not with Create lines)

Special configuration for line creation

Some advanced settings must be made in the CTI gateway.

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI

• Open the Innvoaphone CTI gateway and navigate to the Advanced settings

• Add the following entries:

  • CreateLineFlags = 0x3000

    • Special parameter for line generation of the Innovaphone PBX (use of hardware names and multiline mode).

  • UserLineFormat = ^[^;]*\[([^;]+)\]||$1

    • Formatting of the line names for the user from the name of the line (match the value in square brackets).

  • UserLineSort = ^[^;]*\[Tisch.*||@main

    • The users’ main lines are lines whose hardware names begin with ‘Table’. These are displayed as the first entry at the top of the XPhone Client device selection.

Hint

In Innovaphone Administration, devices can be assigned a name or not. If no name is available, the XPhone Server uses the hardware ID as a fallback for the name displayed in the XPhone Client as a selectable device. Please note this, as the hardware ID may not be optimized for display in the client.

Trust self-signed certificates

The HTTPS protocol can be selected for the SOAP interface. If a fully trusted certificate has been configured for this interface, no further settings are required as the certificate is trusted by default. The XPhone server uses the operating system’s list of trusted certificates for validation.

However, if a self-signed server certificate is used for the SOAP interface, the issuing certification authority must be explicitly trusted. You can find out how to configure this in this chapter.

Windows

Requirements:

• Administrator rights in the Windows of the XPhone server.

• Access to the CA certificate (.crt or .cer file).

Tutorial

1. Open Certificate Management for the computer account.

   • Press Windows + R, enter certlm.msc and confirm with Enter. This opens the certificate management for the computer account.

2. Navigate to the folder Trusted Root Certification Authorities.

   • In the certlm.msc window, navigate to Trusted Root Certification Authorities and open the Certificates subfolder.

3. Importing the CA certificate

   • Right-click on Certificates in the Trusted Root Certification Authorities folder and select All Tasks > Import….

   • The certificate import wizard opens.

4. Using the certificate import wizard

   • Click Next and select the CA certificate file (.crt or .cer) that you want to import.

   • Select Trusted root certification authorities as the storage location and click Next.

   • Click on Finish to complete the import. A confirmation message should appear that the import was successful.

5. Open the imported certificate and copy the fingerprint or serial number.

   • Locate the imported certificate in the Trusted Root Certification Authorities > Certificates folder and double-click it to open it.

   • In the certificate window, switch to the Details tab.

   • Scroll down the list of fields and select either:

     • Fingerprint to display and copy the fingerprint of the certificate, or

     • Serial number to use the serial number of the certificate.

   • Note or copy the desired value by selecting it and pressing Ctrl + C.

     • One of these two values is required later in XPhone Web Administration.

6. Checking the import and the noted data

   Make sure that the fingerprint or serial number has been copied or noted correctly and that the certificate has been imported successfully.

Attention

Please ensure that you only import certificates from trustworthy CAs, as this may affect the system’s security settings.

CTI gateway

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI.

• Open the Innvoaphone CTI gateway and navigate to the Advanced settings.

• Click Add.

  • Configure the new entry as follows:

    • Name = INCertificateSearchServer

    • Value = <Fingerprint of the certificate> or SN:<Serial number of the certificate>

    Hint

    If you configure SN:0 in the Value field, the digital signature of the certificate provided by Innovaphone SOAP is not checked. This means that every certificate is automatically accepted.

    • Attention! If digital signature verification is deactivated, there is an increased security risk, as certificates from untrustworthy sources or manipulated certificates could also be permitted.

  • Save your settings with the Apply button.

Internal and external call forwarding

XPhone Connect enables differentiated call forwarding based on internal and external calls.

For example, if call forwarding is configured in the XPhone Client with Internal calls to to any destination, calls from colleagues are forwarded, while calls from external callers are not forwarded. The reverse is true for the External calls to call forwarding option.

This behavior can be configured either individually in the lines or for all lines in the Innovaphone CTI gateways:

For individual lines:

• Navigate to: System settings > Telephony & Meetings > Telephony > Lines

• Open the Innvoaphone line and navigate to Advanced Settings.

• Click Add.

  • Configure the new entry as follows:

    • Name = INFlagsRemove

    • Value = 0x200

  • Save your settings with the Apply button.

For all lines:

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI.

• Open the Innvoaphone CTI gateway and navigate to the Parameter records for lines (advanced settings).

• Select Default and click Edit.

• Click Add.

  • Configure the new entry as follows:

    • Name = INFlagsRemove

    • Value = 0x200

  • Save your settings with the Apply button.

Attention

The Innovaphone devices (including the Innovaphone apps) do not support a distinction between internal and external call forwarding. Therefore, this special parameter should not be configured if Innovaphone apps are to be used, as the corresponding call forwarding are not displayed in the Innovaphone apps. If the special parameter is to be used, it must be ensured that no Innovaphone apps are used.

E.164 Operating mode

As a rule, the lines to be monitored are identified using the Number of the Innovaphone user, which is normally in extension format. However, if Innovaphone is used in E.164 operating mode, this must be adjusted in the Innovaphone CTI gateway, otherwise no lines can be created.

• Navigate to: System settings > Telephony & Meetings > Telephony > CTI.

• Open the Innvoaphone CTI gateway and navigate to the Advanced settings.

• Click Add.

  • Configure the new entry as follows:

    • Name = INNodeNumbersEnabled

    • Value = true

  • Save your settings with the Apply button.

Migration TAPI to SOAP

This chapter describes how to replace a TAPI-based CTI gateway with a SOAP-based CTI gateway.

Hint

• TAPI-based and SOAP-based CTI gateways can be operated in parallel so that a changeover is possible during operation.

• The SIP gateways remain unchanged. AnyDevice and softphone-only users are not affected by the changeover.

• Carry out a backup of the XPhone server before the changeover, ideally with the integrated Backup.

1. Create a user in the Innovaphone at.

2. Create a static group or assign the existing static TAPI group to the SOAP user.

3. Create the CTI gateway.

4. Reconfigure the lines:

   Hint

   Depending on the scenario, flags may have to be set for line generation, e.g. for multiple CTI devices or if TapiMode = 1 is set on the TAPI-based CTI gateway.

   Connectors for line generation

   If connectors were previously used for line generation, adjust the following settings:

   • Open the connector and navigate to the options.

   • Select the radio button: Taking consideration of advanced settings for creating lines.

   • On the next page, select the dialing parameters and the SOAP-based CTI gateway.

     If you do not select a dialling parameter, the dialling parameter is taken from the CTI gateway.

     Hint

     • Pay attention to the Special settings e.g. for several CTI devices.

       • You can set the Additional flags (optional) field with this Powershell instruction in all connectors at the same time.

     • If you want to select the CTI gateway in all connectors, you can also use these Powershell instructions.

   Testing with one user

   To test the new interface in advance:

   • Manually create a SOAP-based CTI line.

   • Delete the TAPI-based CTI line that was previously assigned to the user or remove the assignment of the line.

   • Assign the new CTI line to the user.

   • Check on the client whether all CTI features are working.

5. Complete the changeover

   • Delete the existing TAPI-based CTI gateway.

     This deletes all associated lines.

   • Execute the connector or connectors. This creates and assigns all defined CTI lines of the SOAP-based CTI gateway.

Hint

After the changeover, the main line is automatically assigned as the active device in multi-device configurations. Each user must therefore reactivate their preferred device manually.

TAPI interface

Install the TAPI driver and enter the access data:

XPhone Connect configuration

System settings > Telephony & Meetings > Telephony > CTI

Click New Landline Gateway in the header of the table. The Create new landline gateway dialogue opens:

• PBX Type:

  Select Microsoft TAPI 2.x (local).

• Name:

  Enter a unique name here.

• Dialing parameter:

  Select a Dialling parameters.

• Deactivated:

  Set this flag if this gateway is to be preconfigured but should not go active.

• Advanced settings:

  Because the PBX delivers addresses of the TAPI lines partly in the format 49xxx (instead of +49xxx), the following parameter must be set for monitoring the lines:

  • Name: AdaptAddressNumbers and Value: ^49\(.*)$||+$0

System settings > Telephony & Meetings > Telephony > CTI > New Landline gateway

When the configuration is completed, click Save.

UM

Configuring the PBX

1. Set up gateway:

2. Set up gateway for PBX:

3. Set up the routes:

XCAPI configuration

Start the XCAPI setup programme (path on XPhone DVD Server3rdPartyxcapi) and install the programme. We recommend installing XCAPI before installing the XPhone Connect Server. Install XCAPI on the same computer where the XPhone UM services are installed (all solution components are generally installed on one machine). Make sure that no other CAPI products are installed on the target machine. The set-up assistant starts after the installation. Proceed with the following steps:

Innovaphone (gateway) is selected as a voice-over-IP environment:

Select H.323 as the signaling protocol.

XCC

The SIP gateway for the AnyDevice, Conference service and TeamDesk functions is configured completely independently of the SIP gateway for the UM functions.

Configuring the PBX

General hints

The test was carried out with an Innovaphone IP 6010 version 12R1(12.0672).

Configuration

1. First of all, a gateway object must be set up for the XCC (XPhone Call Controller). In this example, we use the 30x block in the direction of XCC:

2. The gateway must then be set up. Please note the following settings: Media-Relay, No ICE and SRTP Key Exchange:

3. Gateway without Registration in the direction of XCC:

4. Configure the routing to and from XCC.

   • In this case, we access an external line directly with 0.

   • Internal calls from XCC are sent directly to the PBX.

Hint

If a ? appears as the phone number in the Connect Client for internal calls that are forwarded to the XPhone Desktop Softphone and the entry No phone number appears in the journal, you must uncheck Hide Connected Endpoint in the XCC gateway object under User.

Configuration of the XPhone Connect Server

SIP gateway

System settings > Telephony & Meetings > Telephony > SIP > SIP-Trunk Objekt

Sample configuration:

Select Innovaphone as the gateway type.