Asterisk config sirrix.conf group

Group definition


[{groupname}]
{setting} = {value}



[groupname]
user defined group name (case sensitive)

  • Example: [incoming]



include
include settings from other group

  • Example: include = internal


mode
mode for ports (NT (master) or TE (slave))

  • Possible values:
    - NT / nt / n
    - TE / te / t
  • Example: mode = NT
  • Note: Please also check the datasheet of the Sirrix.PCI4S0 for details on the RJ45 pinout. By default, the RJ45 plugs are *wired* for NT mode, so can connect phones with standard 1:1 cables. For connecting to the public net in TE mode, you need to use a crossed cable where the following pins are swapped: -> Pin 3 with pin 4 and pin 5 with pin 6 <- See the Sirrix.PCI4S0 datasheet for details!



ptp
mode for ports (Point-to-Point or Point-to-MultiPoint)

  • Possible values:
    - yes (for PtP (Anlagenanschluss))
    - no (for PtMP (Mehrgeraeteanschluss))
  • Example: ptp = yes



ports
one ore more ports on Sirrix.PCI cards.
You can specify multiple ports by separating them with a +

  • Examples:
    ports = 0102 for the third port on the second Sirrix.PCI4S0
    ports = 0102+0203 for the third port on the second Sirrix.PCI4S0 and the fourth port on the third Sirrix.PCI4S0
    ports = 1000 for the first port on the first Sirrix.PCI2E1



channels
one or more channels on Sirrix.PCI cards.
Only the specified channels are allowed for use on all ports of the group definition. You can specify single channels, multiple channels or a channel range. Use "," to separate channels and "-" to specify a channel range. Available channels on a BRI port are 1 and 2. Available channels on a PRI port are 1-15 and 17-31; channel 0 is used for synchronization, channel 16 is the D-channel and are therefore not available. You can specify unavailable channels without an error. If the "channels" parameter is not specified or empty, all available channels are used (recommended).

  • Examples:
    channels = 1
    channels = 1,2
    channels = 1-15
    channels = 1-15,17-31



context
Asterisk context for incoming calls

  • Example: context = incoming



language
Asterisk language for this group



country
Asterisk country (for indications) for this group

  • The given setting is used to lookup entries in the indications.conf Asterisk configuration file. In addition to the common entries (dial, busy, ring, congestion, info, stutter), the entries "dialint" and "dialredir" are used if present. Otherwise the settings for "dial" are applied.

  • If "country" is either not set (empty) or invalid, internally generated indications are used.

  • Examples for indications.conf:


; dial is used for an external dialtone
dial = 425

; dialint is used for an internal dialtone
; fallback to dial if dialint does not exist
dialint = 425/300,0/300,425/300,0/300,425/300,0/900

; dialredir is used for an internal dialtone if an
; unconditional call forward (CFU) is enabled
; fallback to stutter, dialint or dial if dialredir does not
; exist.
dialredir = 425+400/300,0/300,425+400/300,0/300,425+400/300,0/900



extension
Extension to call for incoming calls.
To allow appending of digits, append +

  • Example:
    extension = 123+
    number = 456+
    When a call comes in for number 45678, then the extension 12378 will be called.



callerid
Callerid for incoming calls.
Set to "asreceived" to get the callerid as received with the channel variable "CALLINGTON" set to the received type of number. To allow appending digits, append +

  • Example:
    callerid = 012+
    If the incoming CallingPartyNumber is 345 then the Asterisk CallerID will be set to 012345

The CallerID Name can also be set:
  • Example: callerid = MyName <1234>

This can also be combined with the +.
  • Example: callerid = Line <012+>
  • default value: asreceived


number
Incoming calls: calling number prefix on NT, called number prefix on TE
Outgoing calls: called number prefix on NT, calling number prefix on TE
To allow appending of digits, append +

  • Example:
    number = 123+
    This will match every number starting with 123



numbertype
Outgoing calls: numbertype of called party on NT, numbertype of calling party on TE

  • possible values:
    - unknown
    - international
    - national
    - network_specific
    - subscriber / user (default)
    - abbreviated
    - reserved
  • Example: numbertype = unknown



numberplan
Outgoing calls: numberplan of called party on NT, numberplan of calling party on TE

  • possible values:
    - unknown
    - telephony / isdn (default)
    - private
  • Example: numberplan = private



othertype
Outgoing calls: numbertype of calling party on NT, numbertype of called party on TE

  • possible values:
    - unknown (default)
    - international
    - national
    - network_specific
    - subscriber / user
    - abbreviated
    - reserved



otherplan
Outgoing calls: numberplan of calling party on NT, numberplan of called party on TE

  • possible values:
    - unknown
    - telephony (default)
    - private



mailbox
ONLY NT mode: mailbox number for checking for new messages; sends a MWI (Message Waiting Indication) if new messages are available; checks for new messages every "notify_time" seconds; see also option "vmexten"



vmexten
ONLY NT mode: extension to dial for receiving voicemail messages; will be send within a MWI; see also option "mailbox"



aocd
ONLY NT mode: type of Advice of Charge During connection to this group. For further details on the integrated AOC engine, please see README.aoc.

  • possible values:
    - none (default)
    - units
    - currency
  • Example: aocd = currency

ONLY TE mode: in TE mode received AOCD information is logged to CDR automatically. For further details, please see AOC Engine.



aoc_unit
ONLY NT mode: configured price of one AOC unit in the device. This setting consists of an integer or floating point number and an optional currency. A maximum of the decimal digits may be used. For further details on the integrated AOC engine, please see AOC Engine

  • Examples:
    aoc_unit = 0.061 EUR
    aoc_unit = 123456.678
    aoc_unit = 1 GBP
    aoc_unit = 5



cfnotify
ONLY NT mode: notify this group of changes in programmed call forwarding every "notify_time" seconds; if this option is enabled, a "humming sound" will be used for dialtone instead of the normal internal dialtone

  • Type: -boolean value-



cfu
ONLY NT mode: allow programming of call forward unconditional for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cfb
ONLY NT mode: allow programming of call forward busy for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cfnr
ONLY NT mode: allow programming of call forward no reply for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cd
ONLY NT mode: allow call deflection for this group

  • Type: -boolean value-



colp
allow presentation of connected party number to this group

  • Type: -boolean value-



redir
allow presentation of redirection on "incoming calls" to this group

  • Type: -boolean value-



notify
allow notify of remote changes (call held, retrieved, ...) to this group

  • Type: -boolean value-



3pty
ONLY NT mode: allow initiation of a three party call for this group

  • Type: -boolean value-



busyonbusy
ONLY NT mode: don't allow more than one call for this group at one time

  • Type: -boolean value-



callwaiting
ONLY NT mode: indicate calls to this group even if no B-channel is available

  • Type: -boolean value-



implicit_ct
ONLY NT mode: execute call transfer upon reception of DISCONNECT on HELD party; this may be required on phones that do not support ECT

  • Type: -boolean value-
  • default value: yes



implicit_ct_rev
ONLY NT mode: execute call transfer upon reception of DISCONNECT on ACTIVE party; this may be required on phones that neither support ECT nor send DISCONNECT on the HELD party if call shall be transferred; be careful with setting this option as it prevents disconnecting an ACTIVE party to be disconnected when a HELD party is available.

  • Type: -boolean value-
  • default value: no



show_cidname
transmit CallerID ->Name<- via DISPLAY IE

  • Type: -boolean value-



providetones
ONLY TE mode: shall this group forward tones (in-band information or pattern to calling party for OUTGOING calls)

  • Type: -boolean value-



echocancel
select echo cancellation algorithm for this group

  • possible values:
    - off / no (default; disable echo cancellation)
    - speex (Echo cancellation from speex.org)
    - aec (Acoustic Echo Cancellation from DFS)
    - mg2 (Michael Gernoth's 2nd EC)
    - fir (FIR echo-canceller from msstate.edu)
    - hw (Hardware Echo Cancellation; only if Sirrix.PCI2E1 or Sirrix.PCIEC is available)
  • Example: echocancel = fir



crypto
shall this group encrypt and decrypt?

  • Type: -boolean value-



dialtimeout
shall the overlap dialing timeout be enabled?

  • Type: -boolean value-



force_start
shall the calling party immediately be connected to the s-exension (if existent)?

  • Type: -boolean value-
  • default values:
    - TE mode: no
    - NT mode: yes



nameportchan
shall the group be named in port-chan scheme?

  • Type: -boolean value-



txgain
change gain of TX data by -100 .. 100 (in percent)

  • Example: txgain = -20



rxgain
change gain of RX data by -100 .. 100 (in percent)



callgroup
sets Asterisk call group



pickupgroup
sets Asterisk pickup group



master
ONLY TE mode: may the ports of this group become PCM master?

  • Type: -boolean value-
  • It is very important to set "master = yes" on at least one group with "mode = TE" that is connected to the public net or a superior PBX system. Otherwise you will get bit errors on Layer 1.
  • default values:
    - TE mode: yes
    - NT mode: no



disabled
shall this group be disabled?

  • Type: -boolean value-



NOTICE

If {groupname} = default, then no group is built, but the settings are used as default values for the next group(s). The "default" group may appear multiple times.

REMARKS (connection to public net)

Inbound calls:
To match any number, you can set "number = +" and "extension = +". That would call an extension with the same number as the Called Party Number on ISDN. To get a correct "routing selection prefix" (that would be e. g. a "0" to get an outgoing line), you should set "callerid = <0+>". That gives you the ISDN Calling Party Number prefixed with "0" as Asterisk CallerID.

  • Example:
    If you set "number = 1234+", "extension = 815+" and the Telco sends Called Party Number "1234 98", the extension "815 98" will be called.


Outbound calls:
For outbound calls you do not need the "callerid"-setting in sirrix.conf, as the ISDN Calling Party Number is generated by "number" appended by the Asterisk
CallerID, if "number" has the "+" as last character. Otherwise "number" is used as ISDN Calling Party Number.

  • Example:
    If you set "number = 1234+" and the Asterisk CallerID of the calling party is "4711", this will give an ISDN Calling Party Number of "1234 4711".





See Also


Previous: Global settings
Next: Usage in extensions.conf
Index: Asterisk Sirrix ISDN channels


Group definition


[{groupname}]
{setting} = {value}



[groupname]
user defined group name (case sensitive)

  • Example: [incoming]



include
include settings from other group

  • Example: include = internal


mode
mode for ports (NT (master) or TE (slave))

  • Possible values:
    - NT / nt / n
    - TE / te / t
  • Example: mode = NT
  • Note: Please also check the datasheet of the Sirrix.PCI4S0 for details on the RJ45 pinout. By default, the RJ45 plugs are *wired* for NT mode, so can connect phones with standard 1:1 cables. For connecting to the public net in TE mode, you need to use a crossed cable where the following pins are swapped: -> Pin 3 with pin 4 and pin 5 with pin 6 <- See the Sirrix.PCI4S0 datasheet for details!



ptp
mode for ports (Point-to-Point or Point-to-MultiPoint)

  • Possible values:
    - yes (for PtP (Anlagenanschluss))
    - no (for PtMP (Mehrgeraeteanschluss))
  • Example: ptp = yes



ports
one ore more ports on Sirrix.PCI cards.
You can specify multiple ports by separating them with a +

  • Examples:
    ports = 0102 for the third port on the second Sirrix.PCI4S0
    ports = 0102+0203 for the third port on the second Sirrix.PCI4S0 and the fourth port on the third Sirrix.PCI4S0
    ports = 1000 for the first port on the first Sirrix.PCI2E1



channels
one or more channels on Sirrix.PCI cards.
Only the specified channels are allowed for use on all ports of the group definition. You can specify single channels, multiple channels or a channel range. Use "," to separate channels and "-" to specify a channel range. Available channels on a BRI port are 1 and 2. Available channels on a PRI port are 1-15 and 17-31; channel 0 is used for synchronization, channel 16 is the D-channel and are therefore not available. You can specify unavailable channels without an error. If the "channels" parameter is not specified or empty, all available channels are used (recommended).

  • Examples:
    channels = 1
    channels = 1,2
    channels = 1-15
    channels = 1-15,17-31



context
Asterisk context for incoming calls

  • Example: context = incoming



language
Asterisk language for this group



country
Asterisk country (for indications) for this group

  • The given setting is used to lookup entries in the indications.conf Asterisk configuration file. In addition to the common entries (dial, busy, ring, congestion, info, stutter), the entries "dialint" and "dialredir" are used if present. Otherwise the settings for "dial" are applied.

  • If "country" is either not set (empty) or invalid, internally generated indications are used.

  • Examples for indications.conf:


; dial is used for an external dialtone
dial = 425

; dialint is used for an internal dialtone
; fallback to dial if dialint does not exist
dialint = 425/300,0/300,425/300,0/300,425/300,0/900

; dialredir is used for an internal dialtone if an
; unconditional call forward (CFU) is enabled
; fallback to stutter, dialint or dial if dialredir does not
; exist.
dialredir = 425+400/300,0/300,425+400/300,0/300,425+400/300,0/900



extension
Extension to call for incoming calls.
To allow appending of digits, append +

  • Example:
    extension = 123+
    number = 456+
    When a call comes in for number 45678, then the extension 12378 will be called.



callerid
Callerid for incoming calls.
Set to "asreceived" to get the callerid as received with the channel variable "CALLINGTON" set to the received type of number. To allow appending digits, append +

  • Example:
    callerid = 012+
    If the incoming CallingPartyNumber is 345 then the Asterisk CallerID will be set to 012345

The CallerID Name can also be set:
  • Example: callerid = MyName <1234>

This can also be combined with the +.
  • Example: callerid = Line <012+>
  • default value: asreceived


number
Incoming calls: calling number prefix on NT, called number prefix on TE
Outgoing calls: called number prefix on NT, calling number prefix on TE
To allow appending of digits, append +

  • Example:
    number = 123+
    This will match every number starting with 123



numbertype
Outgoing calls: numbertype of called party on NT, numbertype of calling party on TE

  • possible values:
    - unknown
    - international
    - national
    - network_specific
    - subscriber / user (default)
    - abbreviated
    - reserved
  • Example: numbertype = unknown



numberplan
Outgoing calls: numberplan of called party on NT, numberplan of calling party on TE

  • possible values:
    - unknown
    - telephony / isdn (default)
    - private
  • Example: numberplan = private



othertype
Outgoing calls: numbertype of calling party on NT, numbertype of called party on TE

  • possible values:
    - unknown (default)
    - international
    - national
    - network_specific
    - subscriber / user
    - abbreviated
    - reserved



otherplan
Outgoing calls: numberplan of calling party on NT, numberplan of called party on TE

  • possible values:
    - unknown
    - telephony (default)
    - private



mailbox
ONLY NT mode: mailbox number for checking for new messages; sends a MWI (Message Waiting Indication) if new messages are available; checks for new messages every "notify_time" seconds; see also option "vmexten"



vmexten
ONLY NT mode: extension to dial for receiving voicemail messages; will be send within a MWI; see also option "mailbox"



aocd
ONLY NT mode: type of Advice of Charge During connection to this group. For further details on the integrated AOC engine, please see README.aoc.

  • possible values:
    - none (default)
    - units
    - currency
  • Example: aocd = currency

ONLY TE mode: in TE mode received AOCD information is logged to CDR automatically. For further details, please see AOC Engine.



aoc_unit
ONLY NT mode: configured price of one AOC unit in the device. This setting consists of an integer or floating point number and an optional currency. A maximum of the decimal digits may be used. For further details on the integrated AOC engine, please see AOC Engine

  • Examples:
    aoc_unit = 0.061 EUR
    aoc_unit = 123456.678
    aoc_unit = 1 GBP
    aoc_unit = 5



cfnotify
ONLY NT mode: notify this group of changes in programmed call forwarding every "notify_time" seconds; if this option is enabled, a "humming sound" will be used for dialtone instead of the normal internal dialtone

  • Type: -boolean value-



cfu
ONLY NT mode: allow programming of call forward unconditional for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cfb
ONLY NT mode: allow programming of call forward busy for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cfnr
ONLY NT mode: allow programming of call forward no reply for this group. (cf. clause "Asterisk CallForward DB")

  • Type: -boolean value-



cd
ONLY NT mode: allow call deflection for this group

  • Type: -boolean value-



colp
allow presentation of connected party number to this group

  • Type: -boolean value-



redir
allow presentation of redirection on "incoming calls" to this group

  • Type: -boolean value-



notify
allow notify of remote changes (call held, retrieved, ...) to this group

  • Type: -boolean value-



3pty
ONLY NT mode: allow initiation of a three party call for this group

  • Type: -boolean value-



busyonbusy
ONLY NT mode: don't allow more than one call for this group at one time

  • Type: -boolean value-



callwaiting
ONLY NT mode: indicate calls to this group even if no B-channel is available

  • Type: -boolean value-



implicit_ct
ONLY NT mode: execute call transfer upon reception of DISCONNECT on HELD party; this may be required on phones that do not support ECT

  • Type: -boolean value-
  • default value: yes



implicit_ct_rev
ONLY NT mode: execute call transfer upon reception of DISCONNECT on ACTIVE party; this may be required on phones that neither support ECT nor send DISCONNECT on the HELD party if call shall be transferred; be careful with setting this option as it prevents disconnecting an ACTIVE party to be disconnected when a HELD party is available.

  • Type: -boolean value-
  • default value: no



show_cidname
transmit CallerID ->Name<- via DISPLAY IE

  • Type: -boolean value-



providetones
ONLY TE mode: shall this group forward tones (in-band information or pattern to calling party for OUTGOING calls)

  • Type: -boolean value-



echocancel
select echo cancellation algorithm for this group

  • possible values:
    - off / no (default; disable echo cancellation)
    - speex (Echo cancellation from speex.org)
    - aec (Acoustic Echo Cancellation from DFS)
    - mg2 (Michael Gernoth's 2nd EC)
    - fir (FIR echo-canceller from msstate.edu)
    - hw (Hardware Echo Cancellation; only if Sirrix.PCI2E1 or Sirrix.PCIEC is available)
  • Example: echocancel = fir



crypto
shall this group encrypt and decrypt?

  • Type: -boolean value-



dialtimeout
shall the overlap dialing timeout be enabled?

  • Type: -boolean value-



force_start
shall the calling party immediately be connected to the s-exension (if existent)?

  • Type: -boolean value-
  • default values:
    - TE mode: no
    - NT mode: yes



nameportchan
shall the group be named in port-chan scheme?

  • Type: -boolean value-



txgain
change gain of TX data by -100 .. 100 (in percent)

  • Example: txgain = -20



rxgain
change gain of RX data by -100 .. 100 (in percent)



callgroup
sets Asterisk call group



pickupgroup
sets Asterisk pickup group



master
ONLY TE mode: may the ports of this group become PCM master?

  • Type: -boolean value-
  • It is very important to set "master = yes" on at least one group with "mode = TE" that is connected to the public net or a superior PBX system. Otherwise you will get bit errors on Layer 1.
  • default values:
    - TE mode: yes
    - NT mode: no



disabled
shall this group be disabled?

  • Type: -boolean value-



NOTICE

If {groupname} = default, then no group is built, but the settings are used as default values for the next group(s). The "default" group may appear multiple times.

REMARKS (connection to public net)

Inbound calls:
To match any number, you can set "number = +" and "extension = +". That would call an extension with the same number as the Called Party Number on ISDN. To get a correct "routing selection prefix" (that would be e. g. a "0" to get an outgoing line), you should set "callerid = <0+>". That gives you the ISDN Calling Party Number prefixed with "0" as Asterisk CallerID.

  • Example:
    If you set "number = 1234+", "extension = 815+" and the Telco sends Called Party Number "1234 98", the extension "815 98" will be called.


Outbound calls:
For outbound calls you do not need the "callerid"-setting in sirrix.conf, as the ISDN Calling Party Number is generated by "number" appended by the Asterisk
CallerID, if "number" has the "+" as last character. Otherwise "number" is used as ISDN Calling Party Number.

  • Example:
    If you set "number = 1234+" and the Asterisk CallerID of the calling party is "4711", this will give an ISDN Calling Party Number of "1234 4711".





See Also


Previous: Global settings
Next: Usage in extensions.conf
Index: Asterisk Sirrix ISDN channels


Created by: sirrix, Last modification: Wed 09 of May, 2007 (20:41 UTC)
Please update this page with new information, just login and click on the "Edit" or "Discussion" tab. Get a free login here: Register Thanks! - Find us on Google+