58.1. CTIIAX resource

The Abilis IAX driver provides gateway functionalities between IAX and ISDN networks for audio services only; it isn't intended to support full IAX to IAX videoconferencing gateway. The Abilis IAX driver can be interfaced with:

58.1.1. Activating the CTIIAX resource

Add the resource to the Abilis system with the following command.

[09:08:14] ABILIS_CPX:a res:ctiiax

RES:CTIIAX ALREADY EXISTS

The CTIIAX resource may already exist in the system, but may not yet be active: set it active with the command:

[09:10:00] ABILIS_CPX:s act res:ctiiax

COMMAND EXECUTED
[Caution]Caution

You must restart the Abilis to make the resource running (use the command warm start to reboot the Abilis) after adding or setting the CTIIAX active.

[11:01:39] ABILIS_CPX:s p ctiiax act:yes

COMMAND EXECUTED

[11:01:39] ABILIS_CPX:d p ctiiax

RES:CtiIax - Not Saved (SAVE CONF), Not Refreshed (INIT) ----------------------
       ------------------------------------------------------------------------
       DESCR:Inter-Asterisk_eXchange_Version_2
       LOG:NO                  ACT:YES
       mxps:2172               sesnum:10               udp-locport:4569
       SRCADD:OUT-IP                                   TOS:0-D
       IPSRC:*                 IPSRCLIST:#
       AUTH:MD5                REM-AUTH:MD5            CTIP-TYPE:USER
       LIFETIME:60             REM-LIFETIME:60         NP-CT:SYS
       RETR-FREQ:400           TRUNK:NO                ROUTING:EN-BLOC
       RETR-EXCEED:10000       TRUNK-FREQ:40           DIALT:5
       RETR-EXCEED-FAST:2000   TRUNK-TS:YES            T302:15
       PLAY-DTMF:150           CHAN-FREQ:20            ROUTE-BY-SD:NO
       PLAY-SILENCE:100        DISC-AUDIO:NO           PROVIDE-SG:NO
       DETECT-DTMF:40          CLIP-RULE:PRIVATE       CPO:NO
       DETECT-SILENCE:40       RG-IN:DISABLE           CPO-STATE:ACCEPT
       NETSTATS:NO             TRANSFER:IAX            CPO-DROP:NO
       HTML-IN:
       HTML-OUT:
[Caution]Caution

Execute the initialization command init res:ctiiax to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters.

58.1.2. CTIIAX resource parameters

Use the below command to display the parameters of the resource; the d p ctiiax ? command shows the meaning of parameters.

[11:01:39] ABILIS_CPX:d p ctiiax

RES:CtiIax - Not Saved (SAVE CONF), Not Refreshed (INIT) ----------------------
       ------------------------------------------------------------------------
       DESCR:Inter-Asterisk_eXchange_Version_2
       LOG:NO                  ACT:YES
       mxps:2172               sesnum:10               udp-locport:4569
       SRCADD:OUT-IP                                   TOS:0-D
       IPSRC:*                 IPSRCLIST:#
       AUTH:MD5                REM-AUTH:MD5            CTIP-TYPE:USER
       LIFETIME:60             REM-LIFETIME:60         NP-CT:SYS
       RETR-FREQ:400           TRUNK:NO                ROUTING:EN-BLOC
       RETR-EXCEED:10000       TRUNK-FREQ:40           DIALT:5
       RETR-EXCEED-FAST:2000   TRUNK-TS:YES            T302:15
       PLAY-DTMF:150           CHAN-FREQ:20            ROUTE-BY-SD:NO
       PLAY-SILENCE:100        DISC-AUDIO:NO           PROVIDE-SG:NO
       DETECT-DTMF:40          CLIP-RULE:PRIVATE       CPO:NO
       DETECT-SILENCE:40       RG-IN:DISABLE           CPO-STATE:ACCEPT
       NETSTATS:NO             TRANSFER:IAX            CPO-DROP:NO
       HTML-IN:
       HTML-OUT:

Meaning of the most important parameters:

LOG

Logging functionalities activation/deactivation.

ACT

Runtime CTIIAX activation/deactivation.

sesnum

Maximum number of IAX simultaneous sessions.

udp-locport

UDP port number on which the incoming IAX (call signalling protocol) call is accepted.

SRCADD

Source IP address for outgoing connections [R-ID: the source IP address of the outgoing datagrams will be set to the current RouterID value; OUT-IP: the source IP address of the outgoing datagrams will be set on the base of the output IP interface; 1-126.x.x.x, 128-223.x.x.x: the source IP address of the outgoing datagrams will be set to the selected value; Ip-nnn: use the current IPADD of the specified IP resource].

TOS

Sets the TOS value for CTIIAX resource.

IPSRC

Incoming requests: accepted source IP address [*, 1-126.x.x.x, 127.0.0.1, 128-223.x.x.x].

IPSRCLIST

Incoming requests: list of further accepted source IP addresses [#, IP/IR/RU/MR listname].

AUTH

Authentication method offered to authenticating/registering users (incoming calls/registrations).

REM-AUTH

Authentication method when Abilis is authenticating/registering to a peer (outgoing calls/registrations).

LIFETIME

Default duration of incoming registration; users must register themselves before this time interval expires.

REM-LIFETIME

Default duration of outgoing registration; Abilis must register before this time interval expires.

CTIP-TYPE

CTIP type assigned to CTIIAX driver.

NP-CT

Enables/disables Net-Public to Net-Public call transfer [NO: NP to NP disabled; YES: NP to NP enabled, except when both calls are outgoing, which is not allowed to avoid the “hang trunk” problem; SYS: NP to NP depends on NP-CT in CtiSys].

ROUTING

Routing management.

DIALT

Dialling timeout.

T302

Timeout for “empty” setup.

RETR-FREQ

Retransmission frequency (time interval between a retransmission attempt of a IAX full frame and another one if acknowledgement doesn't arrive).

RETR-EXCEED

Retransmission time limit (maximum time for which a frame can stay unacknowledged).

RETR-EXCEED-FAST

Retransmission time limit for NEW and REGREQ messages (these messages are used to setup a call); a shorter timeout for these messages helps in keeping small the time lost in case of peer failure and make a more effective alternative routing.

TRUNK

Enables/disables trunking.

TRUNK-FREQ

Trunk frequency: it represents how much time to wait prior to send the UDP packet. During this time other voice packets coming form the same or other channels can be inserted in the same UDP header thus sensibly reducing the transmisison overhead; of course it adds some delay, but great benefit toward the bandwidth saving.

TRUNK-TS

Enables/disables individual timestamps in a meta trunk.

CHAN-FREQ

Channel frequency for bandwidth optimisation. It represents how many msec of voice are desired to be packed into a single UDP packet; it's a “desire” in the sense that the actual optimisation will depend on the frame length in msec of the coder in use, and the result will be an a approximation by defect.

ROUTE-BY-SD

It allows routing using subaddress called field (SD) [NO: the SD is completely ignored; YES: the user corresponding to SD is searched: if found the call is forwarded to that user, otherwise the standard search in CtiIax table is performed; USER: the user corresponding to SD is searched: if found and the user has parameter IAX-ROUTE-BY-SD:YES, the call is forwarded to that user, otherwise the standard search in CtiIax table is performed].

PROVIDE-SG

Allows insertion of IAX USER NAME in subaddress calling field [NO: disable insertion of USERNAME in calling subaddress; YES: enable insertion of USERNAME in calling subaddress; USER: insertion of USERNAME in calling subaddress depends on individual user configuration]. When it's enabled, either as result of value YES or because value is USER and the user corresponing to the subaddress content allows it, the call sent to CTIR will include in the subaddress calling field the IAX USER NAME of the caller.

PLAY-DTMF

Duration of a DTMF played from a DTMF FULL FRAME. When CTIIAX has to convert a DTMF FULL FRAME command to CTIR DTMF frame, it produces as many frames as needed to cover the period specified by this parameter. The actual interval must be rounded to the value immediately higher than configured one.

PLAY-SILENCE

Duration of a silence played after a PLAY-DTMF. When CTIIAX has to convert a DTMF FULL FRAME command to CTIR DTMF frame, it produces as many frames as needed to cover the perios specified by PLAY-DTMF parameter. Before a new DTMF can be played, a silence period must elapse, and this is controlled by this parameter.

DETECT-DTMF

Duration of a DTMF from CTIR in order to allow digit recognition. When CTIIAX received DTMF frames from CTIR, and after it created the most accurate and monotonical timestamp, the DTMF length is measured and for a successful digit recognition it must be of at least the length specified here. If the configured value is not an exact multiple of the frame rate, it must be rounded to the next upper value multiple of frame rate.

DETECT-SILENCE

Duration of a silence after a DTMF from CTIR in order to recognise a digit.

TRANSFER

Unattended call transfer handling type [IAX: the handling respects IAX specifications: the original call is dropped; CPX: the handling is modified by Abilis: the original call is kept up in case that transferred one fails(user busy, not reacheable, etc...)].

CPO

Enables/disables Call Path Optimization between two IAX users. It's used when IAX-CPO:SYS in user service, otherwise the value of IAX-CPO is used.

CPO-STATE

Earlier state of both call legs in which the Call Path Optimization can be ordered [ACCEPT: CPO on ACCEPT receiving; RINGING: CPO on RINGING receiving; ANSWER: CPO on ANSWER receiving].

CPO-DROP

Enables/disables call drop on Call Path Optimization (CPO) failure. If enabled, the call will drop if CPO will fail. It's used when IAX-CPO-DROP:SYS in user service, otherwise the value of IAX-CPO-DROP is used.

NETSTATS

Enables/disables network statistics and checks connection every the specified value of seconds.

HTML-IN

URL to send to a caller IAX user using the HTML full frame of the IAX protocol.

HTML-OUT

URL to send to a called IAX user using the HTML full frame of the IAX protocol.

The following command allows the administrator to change the configuration of the resource:

s p ctiiax parameter:value...

[Caution]Caution

Execute the initialization command init res:ctiiax to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters.