60.2. CTIIAX tables

60.2. CTIIAX tables
	Chapter 60. IAX - Inter-Asterisk eXchange

60.2.1. Users table

IAX users must be registered in the Users table; all the parameters mandatory for the registration, the authentication and the IAX identification are defined in each Abilis user's profile.

Use the following command to display the parameters of the users; the d user: ? command shows the meaning of parameters.

[08:47:38] ABILIS_CPX:d user

- Not Saved (SAVE CONF) -------------------------------------------------------
------------------------+-------------+----------------------------------------
USER             PWD ACT|CTIP CLUS    |CHAT LDAP PPP FTP HTTP MAIL IAX SIP VO
------------------------+-------------+----------------------------------------
admin            *** YES #    #        YES  YES  YES YES YES  NO   NO  NO  NO
guest                YES #    #        NO   YES  NO  NO  NO   NO   NO  NO  NO
iax_user             YES #    #        NO   NO   NO  NO  NO   NO   YES NO  NO

To view the details of a single user type the following command:

[08:47:39] ABILIS_CPX:d user:iax_user

- Not Saved (SAVE CONF) -------------------------------------------------------
Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 iax_user
REAL-NAME:            iax_user                                      
ID:                   3                                            <Read Only>
PWD:                  ***
ACT:                  YES                                          
CP-LEVEL:             NO                                           
SSH-IP-PERMIT:        *
TELNET-IP-PERMIT:     *
CTI-ROLE:             EXTENSION
GROUP:                
CTIP:                 #
CTIP-CDI-PERMIT:      *
CLUS:                 #
CLUS-CDI-PERMIT:      *
ADDRBOOK-SYNC:        SYS                                          
ADDRBOOK-NUMBER:      AUTO                                         
ADDRBOOK-OUTDIAL:     NONE                                         
ADDRBOOK-PRIV-MAX:    SYS
ADDRBOOK-PUB-EDITABLE:SYS                                          
IO-MAP:               #
OPC-ROLE:             USER
OPC-VIEW:             *
OPC-HIDE-NUMBERS:     NO
OPC-MONITOR:          NONE
OPC-PRIVACY:          NO
CHAT:                 NO    
CHAT-USER:            SYS
CHAT-PWD:             SYS
IAX:                  YES   
IAX-HOST:             DYNAMIC
IAX-SRCADD:           SYS
IAX-PORT:             (DYNAMIC)
IAX-IP-PERMIT:        *
IAX-MAXSES-BID:       2
IAX-MAXSES-IN:        0
IAX-MAXSES-OUT:       0
IAX-CDI-PERMIT:       *
IAX-NUMBER:           
IAX-ADDRBOOK-NUM:     IAX-NUMBER
IAX-CG-NUM:           AUTO
IAX-FWD-CG-NUM:       CALLER
IAX-CTIP-TYPE:        SYS
IAX-RG-IN:            SYS
IAX-ROUTE-BY-SD:      NO                                           
IAX-PROVIDE-SG:       NO
IAX-CLIP-RULE:        SYS
IAX-BUSY-NOCHAN:      NO
IAX-LCS-GROUP:        NONE
IAX-CPO:              SYS
IAX-CPO-STATE:        SYS
IAX-CPO-DROP:         SYS
IAX-SS:               NO
IAX-SS-PICKUP:        GROUPS
IAX-SS-PRES-CG:       YES
IAX-SS-CF-DND:        YES
IAX-SS-VM:            YES
IAX-CONTEXT:          
IAX-PROVIDE-NAME:     BLANK
IAX-AUTH:             SYS
IAX-NETSTATS:         SYS
IAX-TRUNK:            SYS
IAX-TRUNK-FREQ:       SYS
IAX-TRUNK-TS:         SYS
IAX-CHAN-FREQ:        SYS
IAX-TRANSFER:         SYS
IAX-DISC-AUDIO:       SYS
IAX-HTML-IN:          SYS
IAX-HTML-OUT:         SYS
IAX-REM-USER:         
IAX-REM-PASS:                 
IAX-REM-AUTH:         SYS
IAX-REM-REG:          NO                                           
-------------------------------------------------------------------------------

Meaning of the most important parameters:

IAX

Enables/disables IAX service for the user.

IAX-HOST

IP address of the IAX host (the ip address of the user) [DYNAMIC: IP is not known in advance, it's known after the user executes the registration; 1.0.0.0-126.255.255.255, 128.0.0.0-223.255.255.255: remote IP is known in advance; calls and registrations are performed and accepted only with this IP].

IAX-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; SYS: uses the value in SRCADD parameter in CTIIAX resource].

IAX-PORT

UDP port on which the remote user is listening; Abilis outgoing UDP calls for this user will be sent to this port.

IAX-IP-PERMIT

Range of allowed IP addresses of the IAX user.

IAX-MAXSES-BID

Maximum number of simultaneous bidirectional sessions.

IAX-MAXSES-IN

Maximum number of simultaneous reserved input sessions.

IAX-MAXSES-OUT

Maximum number of simultaneous reserved output sessions.

IAX-CDI-PERMIT

Permitted called address in incoming calls. Name of an IN/INN/INR/IS/INP/RU/MR list or *. See also CDI-PERMIT-FAIL-REWRITE: parameter in CTISYS for the action to be taken upon failure.

IAX-NUMBER

Number that identifies the user; if this number is not null, it's used to route calls to the user.

IAX-CG-NUM

Calling number to use for calls coming from the user. The parameter accepts from 1 up to 20 characters in the following range: [AUTO: enforces caller id information element equal to IAX-NUMBER; [0..9]: enforces the content with these exact digits; [0..9]*: replaces first specified digits and passes the remaining transparently; *: passes calling address information element transparently; #: removes calling number information element; ##: enforces the presentation restricted: the calling number is sent empty; ##[0..9]: enforces the presentation restricted: the calling number is sent with these exact digits; ##[0..9]*: enforces the presentation restricted: the first specified digits are replaced and the remaining are passed transparently; ##*: enforces the presentation restricted: the calling number is sent transparently].

IAX-FWD-CG-NUM

Indicates how the calling number is managed in unconditional call transfers and call forwarding [CALLER: the calling number of the original call is passed to the new recipient; USER: the calling number of the IAX user performing the action is passed to the new recipient].

IAX-ROUTE-BY-SD

Allows routing using subaddress called field. Calls from CTIR and directed to IAX users are first directed to the user with a USERNAME equal to what is specified in Subaddress Called; if such user does not exists, or the user disallows IAX-ROUTE-BY-SD, the call is routed using standard CTIIAX table matches.

IAX-PROVIDE-SG

Allows insertion of IAX USER NAME in subaddress calling field.

IAX-LCS-GROUP

Last Calling number Service group identifier [NONE, 1..32].

	Tip
Interesting chapters: Section 61.5.6, “Last Calling Service for a SIP user”; Section 84.18, “How to configure Last Calling Service”; Section 17.3, “Last Calling Service for UMTSBOX”.

Tip

Interesting chapters:

Section 61.5.6, “Last Calling Service for a SIP user”;

Section 84.18, “How to configure Last Calling Service”;

Section 17.3, “Last Calling Service for UMTSBOX”.

IAX-CONTEXT

Context string to use for resource dial-plan choice in other IAX peers.

IAX-PROVIDE-NAME

Rule to provide CALLING NAME in outgoing calls [BLANK: provides an empty CALLING NAME; SG: provides Calling Subaddress as CALLING NAME; REM-USER: provides IAX-REM-USER as CALLING NAME; NO: doesn't provide CALLING NAME].

IAX-AUTH

Authentication types offered to autenticating/registering users (incoming calls/registrations) [SYS: uses the value in AUTH parameter in CTIIAX resource; PLAIN: basic authentication via user/password; MD5: MD5 authentication type].

IAX-NETSTATS

Indicates how often the user availability is checked [SYS: uses the value in NETSTATS parameter in CTIIAX resource; 1..60: frequency for statistics (sec); NO: No statistics].

IAX-TRUNK

Enables/disables trunking [SYS: uses the value in TRUNK parameter in CTIIAX resource; NO: doesn't allow trunking; YES: allows trunking].

IAX-TRUNK-FREQ

IAX trunk frequency [SYS: uses the value in TRUNK-FREQ parameter in CTIIAX resource; 20..240: frequency for trunking (msec)].

IAX-CHAN-FREQ

IAX desired channel frequency for bandwidth optimisation, to be rounded down to a codec frame length multiple [SYS: uses the value in CHAN-FREQ parameter in CTIIAX resource; 30..90: frequency for banwidth optimisation].

IAX-CPO

Enables/disables Call Path Optimization (CPO) [SYS: uses the value in CPO parameter in CTIIAX resource; NO: doesn't allow CPO; YES: allows CPO].

IAX-CPO-STATE

Earlier state of both call legs in which the Call Path Optimization can be ordered [SYS: uses the value in CPO-STATE parameter in CTIIAX resource; RINGING: CPO on RINGING receiving; ANSWER: CPO on ANSWER receiving].

IAX-CPO-DROP

Enables/disables call drop on Call Path Optimization (CPO) failure [SYS: uses the value in CPO-DROP parameter in CTIIAX resource; NO: call will not drop on CPO failure.; YES: call will drop on CPO failure.].

IAX-SS

Enable/disable IAX supplementary services

IAX-SS-PICKUP

IAX supplementary service. Pickup permissions [NO, ANY]

IAX-SS-PRES-CG

IAX supplementary service. Calling present [NO, YES]

IAX-SS-CF-DND

IAX supplementary service. Call forwarding and Do-Not-Disturb [NO, YES]

IAX-TRANSFER

Unattended call transfer handling type [SYS: uses the value in IAX-TRANSFER parameter in CTIIAX resource; 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].

IAX-HTML-IN

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

IAX-HTML-OUT

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

IAX-REM-USER

The name used in the remote IAX server to identify the Abilis (this name is used for both registration and authentication purposes).

IAX-REM-PASS

The password used in the remote IAX server to identify the Abilis (this password is used for both registration and authentication purposes).

IAX-REM-AUTH

Authentication method when Abilis is authenticating/registering to a peer (outgoing calls/registrations) [SYS: uses the value in REM-AUTH parameter in CTIIAX resource; PLAIN: basic authentication via user/password; MD5: MD5 authentication type].

IAX-REM-REG

Enables/disables the registration of the Abilis to the remote IAX server.

60.2.2. CTIIAX translation table

This table contains relations between an IAX-number (or a prefix, when * is included in the number) and an IAX-user. The calls which CTIR forwards to CTIIAX find the destination user by matching the called number. It's the result of CDO field of the CTI routing, with the CDI field of the table.

When the parameter IAX-CG-NUM is set to AUTO, calls from CTIIAX to CTIR have the callerid provided by IAX user validated against the CTIIAX translation table and the IAX-number set in user service. In case of validation failure the callerid will be overwritten with the value configured in the IAX-number of the user table (*, as wildcard, isn't included).

To view the details of the CTIIAX translation table, type:

[08:59:25] ABILIS_CPX:d ctiiax numbers

Total:2         Iax-Number:1         Static:1         

NUMx: [IAX-NUMBER:]       USER:                             Provenience:
------------------------------------------------------------------------
7*                     asterisk                                   STATIC
200                    iax_user                               IAX-NUMBER

There are two types of entries:

IAX-NUMBER: when you specify an IAX-NUMBER in the IAX users chart, the CDI parameter you find in the table will be the same.
Tip
The IAX-NUMBER entries are automatically added.
STATIC: when you don't specify an IAX-NUMBER in the IAX user table, but you associate it by hand in the table: this system is used when you need to add several numbers to the same user (for instance in case of static routings)

	Tip
The IAX-NUMBER entries are automatically added.

To manage the IAX translation table use the following commands:

a ctiiax numx:<IAX-NUMBER> username:<name>: adds a new IAX-NUMBER;
s ctiiax numx:<IAX-NUMBER> username:<name>: modifies the username of an existing IAX-NUMBER;
c ctiiax numx:<IAX-NUMBER>: clears an IAX-NUMBER;
d ctiiax numx:<IAX-NUMBER>: displays the list of IAX-NUMBER or a specific one.
Tip
More IAX-numbers can be associated with a single user.

	Tip
More IAX-numbers can be associated with a single user.

The IAX user creation creates the NumIax list in which are located all the IAX-NUMBERS of the users (it's very useful for the CTIR configuration).

To view the list type:

[16:40:26] ABILIS_CPX:d list:numiax

LIST:NumIax               - IN                - Ref-Numb:0     Items-Numb:2    
     Automatically_generated_CTI_IAX_Numbers_list_(ReadOnly)
     --------------------------------------------------------------------------
     601                     602

	Note
	It's a “read only” list as it's automatically created by the system.


60.1. CTIIAX resource		60.3. CTI Routings