Howto:XCAPI
Applies To
This information applies to
- Configuring the XCAPI with the innovaphone Gateways and innovaphone PBX
Introduction
This document is intended to support you with the integration of the XCAPI (version 3.3.226.0) into an existing environment of current innovaphone gateways (Version 6 and following). In the following sections we describe the essential steps of configuration to allow for optimal cooperation of both the XCAPI and the innovaphone PBX/gateway. At this point, we suppose that the innovaphone PBX, the hardware the XCAPI is running on and both the XCAPI and your CAPI applications are already installed properly. For some extended information on installation procedures please refer to the respective manuals. A short installation manual for the XCAPI is available at the XCAPI Homepage (http://www.te-systems.de/community/index.php?L=0).
Both XCAPI and Innovaphone support H.323 and SIP and we can configure the Trunk between them using the Gateway/Relay or directly registering XCAPI on the PBX. However the only method recommend to be used it's registering XCAPI directly on the innovaphone PBX using SIP Protocol.
Configuring the innovaphone
In this example, we are going to use one PBX gateway object (XCAPI-SIP-GW) and register XCAPI on this Object.
Creating a Gateway Object in the PBX
Log in to the PBX administration and create a new gateway object. The name of the object is "XCAPI-SIP-GW", and the number is 93 in this case.
Routing to and from the XCAPI gateway
Create routes from GW3 (XCAPI) to all desired destinations (PSTN, PBX, the XCAPI itself if needed). In this example, we use 0 as prefix for PSTN access, 1 for PBX access, and 93 to route calls back to the XCAPI itself (normally, this is only required for testing purposes).
PBX users can access the XCAPI via the XCAPI gateway object in the PBX configuration, but their calls will be routed to GW4 (XCAPI-SIP-GW-PBX). For XCAPI access, we have to add a route from GW4 to GW3 (XCAPI). In this example, we route calls beginning with 93 to the XCAPI gateway.
Here is an overview of the routes to the XCAPI. Calls from the PSTN, the XCAPI and the PBX can access the XCAPI via prefix 93.
XCAPI Configuration
When the XCAPI configuration is started for the first time, there are no configured controllers. Use the link "Click here to add a controller" in the overview page to start the controller wizard.
Add new VoIP controller
On the welcome page of the controller wizard, select to add a new VoIP controller.
Network Interface
In the next dialog, select the network interface that you want to use for the SIP connection between the XCAPI and the innovaphone gateway.
Select VoIP environment template
From the list of predefined VoIP environments, select a generic SIP template.
Provide SIP user information
The XCAPI is connected as a SIP trunk (gateway mode), so it is not necessary to enter any user information.
Default SIP domain
As default SIP domain, please enter the IP address of the innovaphone gateway. Please do not use any configured DNS hostnames because of interoperability reasons.
Registrar and Proxy
It is not necessary to activate the registrar or proxy function.
STUN
STUN functionality is also not required.
Description and channels
Enter a meaningful description and the number of lines that the XCAPI can use to communicate with the innovaphone gateway simultaneously. In this example, we enter the prefix number (81893) of the XCAPI as the description. This way, we always know which number to dial if we want to call the XCAPI. 818 is the trunk number of the PSTN access while 93 is the prefix from the innovaphone gateway routing.
Confirmation
Check if all necessary information has been entered correctly (green symbols on the left) and confirm all data by clicking Finish.
The new controller appears in the XCAPI configuration. Save the changes and stop all running CAPI applications before restarting them.
Configuration Video Guide
- Here are some video guides how to configure XCAPI with Innovaphone in 4 modes with V9 PBX and XCAPI version 3.3.226.0.
Video of SIP PBX Registration configuration with XCAPI