Openzap Configuration Examples

About

Numerous examples and ideas to help you configure your OpenZap / ZapTel interface.

Using with PRI

OpenZAP native stack

Sample single span PRI card with the EuroISDN (Q931) dialect:

OpenZAP stack

 <configuration name="openzap.conf" description="OpenZAP Configuration">
   <settings>
     <param name="debug" value="0"/>
   </settings>
   <pri_spans>
     <span id="1" name="PRI_1">
       <param name="mode" value="user"/>
       <param name="dialect" value="q931"/>
       <param name="dialplan" value="XML"/>
       <param name="context" value="default"/>
     </span>
   </pri_spans>
 </configuration>

It is important that the span name matches one of those defined in conf/openzap.conf

param mode: "user", "network"
param dialect (default "national"): "q931" (generic, used for EuroISDN), "national" (NI2), "dms" (Nortel DMS-100) or "5ess" (AT&T 4ESS/5ESS)
param opts (one or more): "suggest_channel", "omit_display", "disable_tones"
param digit_timeout (in ms, default "10000"): 3000 to 30000
param q921loglevel: -1 (none) to 7 (debug)
param q931loglevel: -1 (none) to 7 (debug)
param tonegroup (default "us"): "us" (and other countries)

libpri compatibility stack

Sample single span PRI card with NI2 dialect:

libpri stack

 <configuration name="openzap.conf" description="OpenZAP Configuration">
   <libpri_spans>
     <span name="PRI_1">
        <param name="node" value="cpe"/>
        <param name="switch" value="ni2"/>
        <param name="opts" value="omit_redirecting_number"/>
        <param name="dp" value="unknown"/>
        <param name="debug" value="all"/>
        <param name="dialplan" value="XML"/>
        <param name="context" value="public"/>
      </span>
   </libpri_spans>
 </configuration>

It is important that the span name matches one of those defined in conf/openzap.conf

param node (default "cpe"): "cpe", "network"
param switch (default "dms100"): "ni1", "ni2", "dms100", "lucent5e" OR "5ess", "att4ess" OR "4ess", "euroisdn", "gr303eoc", "gr303tmc"
param opts (one or more, default "none"): "suggest_channel", "omit_display", "omit_redirecting_number"
param dp (Type Of Number + Number Plan ID, default "unknown"): "international", "national", "local", "private", "unknown"
param l1 (default "ulaw"): "alaw", "ulaw"
param debug (one or more, default "none"): "q921_raw", "q921_dump", "q921_state", "config", "q931_dump", "q931_state", "q931_anomaly", "apdu", "aoc", "all"

Using with PRI and CAS on a 4 Port Card

Sample config for a 4 port tor2 (corresponds to second Openzap.conf example)

PRI and CAS configuration

<configuration name="openzap.conf" description="OpenZAP Configuration, tor2">
  <settings>
    <param name="debug" value="1"/>
  </settings>
<!-- Configure CAS spans just like their analog equivalents; this is how it's done, e.g., with channel banks -->
  <analog_spans>
    <span id="1">
      <param name="dialplan" value="XML"/>
      <param name="context" value="default"/>
      <param name="dial-regex" value="9996"/> 
      <param name="dial-regex-fail" value="9996"/>
    </span>
    <span id="2">
      <param name="dialplan" value="XML"/>
      <param name="context" value="default"/>
      <param name="dial-regex" value="9996"/>
      <param name="dial-regex-fail" value="9996"/>
    </span>
  </analog_spans>
  <pri_spans>
    <span id="3"> <!-- to PSTN --> 
      <param name="mode" value="user"/>
      <param name="dialect" value="national"/>
      <param name="dialplan" value="XML"/>
      <param name="context" value="default"/>
    </span>
    <span id="4"> <!-- to PSTN --> 
      <param name="mode" value="user"/>
      <param name="dialect" value="DMS"/>
      <param name="dialplan" value="XML"/>
      <param name="context" value="default"/>
    </span>
  </pri_spans>
</configuration>

Using with BRI

Sample HFC-4S card:

mode can be "user" for TE or "net" for NT;
dialect can be "q931" for EuroISDN, "national", "dms" or "5ess"

BRI configuration

 <configuration name="openzap.conf" description="OpenZAP Configuration">
   <settings>
     <param name="debug" value="0"/>
   </settings>
   <pri_spans>
     <span id="1">
       <param name="mode" value="user"/>
       <param name="dialect" value="q931"/>
       <param name="dialplan" value="XML"/>
       <param name="context" value="default"/>
     </span>
     <span id="2">
       <param name="mode" value="user"/>
       <param name="dialect" value="q931"/>
       <param name="dialplan" value="XML"/>
       <param name="context" value="default"/>
     </span>
     <span id="3">
       <param name="mode" value="user"/>
       <param name="dialect" value="q931"/>
       <param name="dialplan" value="XML"/>
       <param name="context" value="default"/>
     </span>
     <span id="4">
       <param name="mode" value="user"/>
       <param name="dialect" value="q931"/>
       <param name="dialplan" value="XML"/>
       <param name="context" value="default"/>
     </span>
   </pri_spans>
 </configuration>

Using Digium TDM400P card

Analog interface with 2 FXO and 2 FXS ports configured on it

TDM400P card

<configuration name="openzap.conf" description="OpenZAP Configuration">
 <settings>
   <param name="debug" value="9"/>
 </settings>
 <analog_spans>
  <span id="1">
   <param name="tonegroup" value="us"/>
   <param name="digit-timeout" value="2000"/>
   <param name="max-digits" value="11"/>
   <param name="dialplan" value="XML"/>
   <param name="context" value="default"/>
   <param name="enable-analog-option" value="3-way"/>
   <param name="moh" value="$${base_dir}/sounds/Dardedisco.wav"/>
  </span>
  <span id="2">
   <param name="tonegroup" value="us"/>
   <param name="digit-timeout" value="2000"/>
   <param name="max-digits" value="11"/>
   <param name="dialplan" value="XML"/>
   <param name="context" value="default"/>
   <param name="enable-analog-option" value="3-way"/>
   <param name="moh" value="$${base_dir}/sounds/Dardedisco.wav"/>
  </span>
  <span id="3">
   <param name="tonegroup" value="us"/>
   <param name="digit-timeout" value="2000"/>
   <param name="max-digits" value="11"/>
   <param name="dialplan" value="XML"/>
   <param name="context" value="default"/>
  </span>
  <span id="4">
   <param name="tonegroup" value="us"/>
   <param name="digit-timeout" value="2000"/>
   <param name="max-digits" value="11"/>
   <param name="dialplan" value="XML"/>
   <param name="context" value="default"/>
  </span>
 </analog_spans>
</configuration>

Openzap Configuration Examples

About​

Using with PRI​

OpenZAP native stack​

libpri compatibility stack​

Using with PRI and CAS on a 4 Port Card​

Using with BRI​

Using Digium TDM400P card​