TPP: Configuration of XCAPI to work with SwyxWare (kb4014)

The information in this article applies to:

  • SwyxWare v6.20
  • XCAPI Version 3.3.109

[ Summary | Information ]


This article describes the needed configuration of the application XCAPI V.3.3.109 from TE-Systems.

XCAPI is known as software which adapts between the CAPI and among others the SIP protocol. With this software you will be able to connect CAPI-based application to SwyxWare.


SwyxWare v6.20 or higher, XCAPI Version 3.3.109


Configuration of SwyxWare:

XCAPI does not provide a registrar. Therfore you need to create an unregistered SIP-Link to SwyxWare.
Due to several specific parameters, you need to create seperate profile for your XCAPI SIP-trunk.

This profile must contain the following parameters:

  • id="xcapi"
  • name="XCAPI SIP-Trunk"
  • proxy="IP-Adresse or DNS-Name of your XCAPI-Server"
  • UseRegistration="false"
  • DtmfMode="Rfc2833_Event"
  • CallingPartyNumberPosition="FromHeaderSIPURI"
  • NumberFormats outbound_called="Subscriber"
  • outbound_calling="Extension"
  • inbound_called="Extension"
  • inbound_calling="Subscriber"

If you need any assistance creating this profile please find the following knowledege base article:


Configuration of XCAPI application:
XCAPI does come with configurationwizard that contains a specific profile for SwyxWare.

Click to enlarge...

Click to enlarge...

Start the "Controller-Wizard" and attend to the instructions.

If the provided profile does not comply to your needs, or if it does not work for any reason, you can customize the connection manually.

Please  proceed as follows:

  1. Create a appropriate type of controller and choose the tab "Controller". Here you can assign a name to your controller and you can configure the number channels that can be used at the same time. The maximum count of channels depends on your XCAPI license.

    Click to enlarge...

    Select the tab "Features" and activate these values:
    "Simulate ECT by switching B-Channels" = activated
    "Software-Fax to use Speech-channels" = activated

    Click to enlarge...

  2. SIP-Configuration: "Options":
     Please use the SIP-Realm of SwyxWare to be entered into field "Standard SIP Domain". (If not otherwise specified it is the hostname of your SwyxWare-server)
    All other fields must be blank.

    Click to enlarge...

  3. SIP-Configuration: "Proxies"
    Please enter the IP-address or hostname of your SwyxWare server.
    Attention! Port is 65002

    Click to enlarge...

  4. SIP-Configuration: "Protocol"
    Activate the checkbox: "Allow applications to set their own calling number"

    Click to enlarge...

    Keep all other predefined values.

  5. Hold
    SwyxWare supports the feature "Call Hold" via SDP. Therefore activate the checkbox "Attribute sendonly".

    Click to enlarge...

  6. Codecs
    You should always make use of those codecs that are really neccessary. Especially the Softfax functionalities need a none-compressing speechcodec. G711 µ-law by preference.
    Activate the checkbox for using "Telephone-Event (RFC 2833) for DTMF signalling".

    Click to enlarge...

  7. XCAPI is a media endpoint in SwyxWare environments. To interpret "Inband DTMF tones", you need to activate DTMF detection in XCAPI application. Open the tab "Tweaks" and create the following "Standard-Tweak":
    "SDP_ENABLE_RECOGNIZER_SIG“ and give the value 1.

    Click to enlarge...

For any further support, especially for XCAPI configurations, please contact "TE-Systems".
On the website you will find a lot of  helpful information


Comment on this article

If we have any follow-up questions, where can we contact you?

E-Mail Address (optional)


This feedback form can't be used for support requests. Those requests must be directed to your Swyx reseller or distributor.