View source for SIP trunk node - configuration

{{A}}[[File:SIPTrunking.PNG|thumb|500px|SIP Trunking with AlphaCom XE]]
The AlphaCom XE uses the SIP protocol for easy interoperability with telephone systems. Via SIP Trunking the AlphaCom can be interfaced to:
* Voice gateways (Analogue, GSM, ISDN)
* SIP iPABX 
* Call Managers
* Asterisk software PBX
* Tetra radio systems
* ....

This article describes how to configure a SIP Trunk in the AlphaCom XE. It is possible to define multiple SIP trunks. 
== AlphaWeb Configuration ==
=== Assign IP address to the AlphaCom XE Ethernet Port(s) ===
Log on to AlphaWeb. In [[AlphaWeb#Interfaces|System Configuration -> Interfaces]], enter a valid IP address on the Ethernet port. Consult your network administrator to obtain the IP address.

=== Assign IP routing to the AlphaCom XE Ethernet Port(s) ===
In [[AlphaWeb#Routes|System Configuration -> Routes]], create a Default gateway. This is required if the SIP device and AlphaCom are on two different networks.

=== Insert SIP Trunk licenses ===
In '''System Configuration''' -> '''License key''', install the [[Licenses#SIP_trunk_license|SIP Trunk License]].
[[Image:CiscoAlphaWebIPLicense.PNG|left|thumb|500px]]
<br style="clear:both;" />

In case there are multiple SIP Trunk nodes connected to the AlphaCom, the SIP Trunk lines are a common pool of resources for all connected SIP Trunk nodes.

=== Firewall (filter) settings ===
In '''System Configuration''' -> '''Filters''', enable the '''SIP''' and '''VoIP Audio''' on the desired Ethernet port (default enabled for Ethernet port 1).
[[Image:CiscoAlphaWebIPFilters.PNG|left|thumb|500px]]
<br style="clear:both;" />

== AlphaPro Configuration ==
=== Create a SIP Trunk Node ===
From the AlphaPro main menu, use the ‘+’ button next to the ‘Select Exchange’ dropdown list to create a new exchange. 
The exchange type must be set to ‘SIP Node’. 

Set the parameters as shown in the figure to the right.<br/>
The SIP Trunk line IP address must be identical to the IP address of the SIP gateway or iPBX. 
[[Image:SIPTrunkNode1.PNG|left|thumb|500px|Create a SIP Trunk]]
<br style="clear:both;" />

==== Hostname (optional) ====
If a hostname is required, check the Host Name checkbox, and enter the required destination hostname. 

If hostname is required both for the "destination" domain and the "from" domain, enter “destination.domain;from.domain”, no spaces. (Requires AMC software 11.1.3.5 or newer).

[[Image:SIPTrunkHostname.PNG|left|thumb|500px|Host name entered in AlphaPro]]
<br style="clear:both;" />
The link between the hostname and the IP address is defined in AlphaWeb, '''System Configuration''' - > '''Hostnames''':
[[Image:AlphaWebHostname.PNG|left|thumb|500px|Host name defined in AlphaWeb]]
<br style="clear:both;" />

=== Define the AlphaCom to SIP routing ===
In '''Exchange & System > Net Routing''' use the ''Insert'' button to create a route between the AlphaCom and SIP device.<br/>
* Set '''ACDP Link''' = SIP Link
* '''Node number''' = The node number used for the SIP Trunk
* Set '''Preferred codec''' (''G711u'' is often used) and '''RTP Packet Size''' to ''20 ms''.
[[Image:SIPTrunkRoute.PNG|left|thumb|500px]]
<br style="clear:both;" />

=== Create access numbers ===

There are different methods for calling out on a SIP trunk:
* '''Prefix''' number: Dial Prefix + Phone number. One can choose to send digit by digit (overlap dialing), or collect all digits in the AlphaCom and send the complete phone number with the INVITE message (enbloc dialing)
* '''Integrated Prefix''' number: Dial Prefix + Phone number. The prefix will be included as a part of the called telephone number.
* '''Global number''': Dial the phone number without using prefix
* '''SIP Trunk Station:''' Dial the phone number without using prefix

It is possible to combine different methods in the same system.


Example: Calling from an AlphaCom station to a SIP user 571234:
[[File:SIP Trunk call.PNG|thumb|700px|left|AlphaCom station calling SIP user 571234]]
<br style="clear:both;" />

The different options calling out on a SIP trunk:
{| border="1"
| align="center" style="background:#ffcb00;" width="250pt"|'''Dialing method'''
| align="center" style="background:#ffcb00;" width="90pt"|'''Dial'''
| align="center" style="background:#ffcb00;" width="90pt"|'''Directory No'''
| align="center" style="background:#ffcb00;" width="90pt"|'''Feature'''
| align="center" style="background:#ffcb00;" width="90pt"|'''Parameter 2'''
| align="center" style="background:#ffcb00;" width="450pt" |'''Comment'''
|-
| Prefix (overlap dialing):||align="center" |0 + 571234||align="center" |0|| align="center" |83||align="center" |0||Digits are sent one by one from AlphaCom (SIP INFO / RFC4733)
|-
| Prefix (enbloc dialing):||align="center" |0 + 571234||align="center" |0||align="center" |81||align="center" |6 ||Collect up to six digits in AlphaCom, then send the complete number ''(*)''
|-
| Integrated prefix (enbloc dialing):||align="center" |57 + 1234||align="center" |57||align="center" |83||align="center" |4 ||Collect up to four digits, then send prefix+number as one number ''(*)''
|-
| Global number (enbloc dialing):||align="center" |571234||align="center" |571234||align="center" |83||align="center" |0||Send the complete number. Maximum 8 digit number.
|-
| SIP Trunk Station (enbloc dialing):||align="center" |571234||align="center" |571234||align="center" |9||align="center" |NA||Send the complete number. Maximum 8 digit number.
|-
|}


''(*)'': Up to 32 digits can be collected before the SIP INVITE is sent. In software version 11.2.3.9 and earlier, the maximum number of digits was 16.


====Prefix number (overlap dialing)====

When overlap dialing is used (also called "two-stage dialing"), the SIP Device seizes one of the PSTN/PBX lines without performing any dialing, connects the AlphaCom station to the PSTN/PBX, and all further signaling (dialing and Call Progress Tones) is performed directly with the PBX without the SIP device's intervention. The digits are sent to the SIP device either as SIP INFO messages or as RFC4733, depending on the SDP negotiation.

The directory number must be programmed in the AlphaCom directory table with feature 83 and Node = SIP Trunk node number.
[[File:PrefixOverlap.JPG|left|thumb|500px|Prefix number is 0, calling SIP trunk node 100, using overlap dialing]]
<br style="clear:both;" />

====Prefix number (enbloc dialing)====

When enbloc dialing (also called "one-stage dialing") is used, the digit collection is done in the AlphaCom. The destination phone number is included in the INVITE message from the AlphaCom.  

The directory number must be programmed in the AlphaCom directory table with '''Feature 81''' and '''Node''' = SIP Trunk node number. In the "Parameter 2" field you must enter the maximum number of digits in a phone number. 

When the prefix is dialed, the AlphaCom will wait for more digits. When the number of digits specified in the “Parameter 2" is collected, an INVITE message is sent to the SIP device. If fewer digits are entered, the AlphaCom will send the INVITE after a 3 seconds time out. You can also terminate the digit collection by pressing the M-key. The INVITE message will then be sent immediately.

Dialing examples ("0" is the prefix):
:0 + 571234: Telephone number 571234 will be called<br>
:0 + 5712: After a 3 second timeout, telephone number 5712 will be called<br>
:0 + 5712 + M: Telephone number 5712 will be called<br>
[[File:PrefixEnbloc.JPG|left|thumb|500px|Prefix number is 0, SIP trunk node is 100, collect 6 digits, enbloc dialing]]
<br style="clear:both;" />

====Integrated Prefix number====

The directory number must be programmed in the AlphaCom directory table with '''Feature 83''' and '''Node''' = SIP Trunk node number. In the field “Parameter 2" you must enter the maximum number of digits in a phone number. 

When the prefix is dialed, the AlphaCom will wait for further digits. When the number of digits specified in the "Parameter 2" field is collected, a call setup message is sent to the SIP device. If fewer digits are entered, the AlphaCom will time out after 3 seconds, and the call setup message will be sent. You can also terminate the digit collection by pressing the M-key. The call setup message will then be sent immediately.

Dialing examples  ("57" is the prefix):
:57 + 123456: Telephone number 57123456 will be called<br>
:57 + 1234: After a 3 second timeout, telephone number 571234 will be called<br>
:57 + 1234 + M: Telephone number 571234 will be called<br>
[[File:IntegratedPrefix.JPG|left|thumb|500px|Integrated Prefix number is 57, SIP trunk node is 100, collect 6 digits, enbloc dialing]]
<br style="clear:both;" />

====Global number====

The directory number must be programmed in the AlphaCom directory table with '''Feature 83''' and '''Node''' = SIP Trunk node number. The "Parameter 2" field  must be "0".

When the global number is dialed, the AlphaCom will send an INVITE message to the SIP device containing the dialed number.
[[File:GlobalNumber.PNG|left|thumb|500px|Directory number 571234 is defined as a global number, calling out on SIP trunk node 100]]
<br style="clear:both;" />


====SIP Trunk Station ====

The directory number is programmed in the AlphaCom '''Users & Stations''' table. Select a free physical number, and enter '''Directory Number''', '''Display Text''', and enable the flag '''SIP Station'''. In the field '''Related to Trunk''', enter the node number of the SIP Trunk on which the call shall be sent.

When the SIP User number is dialed, the AlphaCom will send an INVITE message out on the SIP Trunk containing the dialed number.
[[File:SIP User on Trunk.PNG|left|thumb|500px|Directory number 571234 is defined as a SIP User, calling out on SIP trunk node 100]]
<br style="clear:both;" />

{{note|'''Notes on using SIP Trunk Station (feature 9) versus Global Number (feature 83)''':
* '''''Features''': When a SIP User is related to a physical number in AlphaCom, it will get access to more station related features, such as [[Ringing Group Feature|Ringing Group]] membership, [[Call Setup Priority]], Call Forwarding, Call Restrictions and [[Event Handler]]''
* '''''Registration''': A SIP Trunk Station does not need to register towards AlphaCom. It will appear as registered in the "Stations" list in AlphaWeb''
* '''''OPC''': A SIP Trunk Station is supported by the [[OPC Server]]. The SIP user will appear in the OPC Item tree, showing status information and allowing call operations. When using a Global Number (feature 83), it will not appear in the OPC tree'' 
* '''''Licencing''': A SIP Trunk Station does not requires a [[Licenses#SIP_station_license|SIP Station license]]. (Applicable from software version 12.5.3.0)'' }}
<br>

==== Optional settings ====
===== Enbloc dialing - Inter digit timeout =====

When using enbloc dialing, the AlphaCom will wait for 3 seconds (default) for more digits before the INVITE is sent on the SIP trunk. This timeout time is programmable from AlphaPro. Select '''Exchange & System''' > '''System''' > '''VoIP''':
[[File:DigitCollection.PNG|left|thumb|500px|Inter digit timeout on enbloc dialing]]
<br style="clear:both;" />

Enbloc dialing is used by feature 81 and feature 83 when the field "Parameter 2" is set different from 0.

===== Overlap dialing - Dial delay =====

After having made a connection to a SIP gateway, further dialing can be delayed. 

A delay might be needed especially if a phone call is made from a DAK key, a substation call button or via [[Transfer_Features|Call Forwarding]], where the prefix + phone number is programmed on the DAK string, say: 0 P 571234. Some SIP gateways needs a delay after having been accessed in order to detect dial tone from the line and get ready. 

In AlphaPro select '''Exchange & System''' > '''System''' > '''VoIP''':
[[File:SIPDialDelay.PNG|left|thumb|500px|Enter the delay from accessing the SIP gateway to digits are to be transmitted]]
<br style="clear:both;" />


Timing issues when dialing from DAK keys or substation keys can also be resolved using the [[Play_DAK_Feature]]. The [[Play_DAK_Feature]] lets you define sequences of dialing, including pauses.

==== Short numbers ====
A Short Number is a directory number, normally 2- or 3-digit long, which when called will dial a complete phone number.
Short Numbers must be programmed on User Numbers 553-600 in AlphaPro.

'''Note''': Short Number swill work only when the SIP Gateway is configured to use 'one-stage' dialing.


'''Example:'''<br>
The configuration example below shows how to create a Short Number 345, which will dial phone number 7654321.

* In AlphaPro, open the '''Users & Stations''' window, and scroll down in the list box and select a User 553 or higher
* Enter the short number ("Directory Number") and Display text
[[File:ShortNoPhone.PNG|thumb|left|500px]]
<br style="clear:both;" />

* Press the button '''Phone'''
** Enter the telephone number
** Set "Short number mode" = SIP
** Set "Node" = the SIP trunk node
[[File:PhoneShortNo.PNG|thumb|left|500px]]
<br style="clear:both;" />

<br>

=== Phone number on DAK Key ===
DAK keys and Call Buttons can be configured to call a phone number by one key press.

'''Simple dial pattern:'''
[[Image:SIPTrunk DAK1.PNG|left|thumb|700px|Call prefix 0, then the phone number]]
<br style="clear:both;" />

DAK keys can also be programmed by dialing a code on the station itself: 784 + 0 + 40002547 + M + DAK key

'''Complex dial pattern:'''

If there is a need for more complex dial pattern, one can start the DAK sequence with the letter "T":

[[Image:SIPTrunk DAK2.PNG|left|thumb|700px|Complex dial pattern]]
<br style="clear:both;" />

Description:
* Get line out "01"
* Wait 1 Second
* Dial pin code "123#"
* Wait 2 Seconds
* Dial phone number "40002500"


'''Address Book:'''

Telephone numbers in the Turbine Stations with [[Address Book]] ([[TCIS-6]], [[TCIV-6]] and [[TFIE-6]]): 
[[Image:SIPTrunk DAK3.PNG|left|thumb|700px|Call prefix 0, then the phone number]]
<br style="clear:both;" />

== Optional configuration ==

===Incoming Calls - Force Private Ringing mode===
Incoming calls from the SIP Trunk can be forced to be in private ringing mode, independent of the private/open switch of the intercom station. 

Check the flag '''Incoming calls from SIP in private ringing mode''' in AlphaPro ('''Exchange & System > System > VoIP''').
[[Image:Incoming Calls in Private.jpg|left|thumb|500px|Calls from SIP trunk will be in Private Ringing mode]]
<br style="clear:both;" />

===Incoming Calls - Selective dialing ===

An incoming call from a SIP trunk can be routed to a "Short Number". A dial tone will be heard, and the caller can dial any intercom number, or he can wait a preset time and get connected to a preprogrammed intercom number.

Configuration:
* In AlphaPro, open the '''Users & Stations''' window, and scroll down in the list box and select a User 553 or higher
* Enter the short number ("Directory Number") and Display text
* Press the '''Phone''' button
* Set Short Number Mode = '''Selective Dialing'''
* '''Timeout''': The call will be routed to a preset number if no dialing before this time
* '''Telephone number''': The intercom number to which the call will be routed to after timeout

[[Image:Shortnumber Selective dialing.jpg|thumb|500px|left|'''Selective dialing''': When a call from a SIP trunk is routed to number 657, a new dial tone is heard. If no digits are pressed within 4 sec., the call is routed to intercom number 109]] 
<br style="clear:both;" />

===Incoming Calls - Auto Attendant ===
[[Image:Auto-attendant.png|thumb|500px|The auto-attendant feature provides voice guided menus]]
The '''[[Auto-attendant|Auto-attendant]]''' feature provides voice guided menus for handling incoming calls:
*Play a welcome message on incoming telephone calls
*Press a digit to re-route the call
*If no digits are pressed, the call will be automatically re-routed 5 seconds after the message has finnished playing

The default directory number for the auto-attendant feature is '''9550'''. Incoming calls from the SIP trunk must be routed to this number.

To record a voice message: 
*From a [[SuperUser]] station dial 8180 + 9550. Press and hold the M-key while recording.
*Example: ”''Welcome to Procom Ltd, press 1 for switchboard, press 2 for Sales department, press 3 for Marketing department, or wait for an answer''”
* Release M-key to listen to the message. Press M-key again to do a new recording, or
* Press 8 to save

Alternatively a wav-file can be uploaded from the web interface AlphaWeb as described in the [[Audio Messaging]] article.

The Auto-attendant number 9550 is using the DAK table of physical station 500 for the "digit" actions. In the '''Users & Stations''' window in AlphaPro, select physical number 500 in the list box, and press the button '''DAK'''. In the DAK table enter the call destination for digit 1-9 (DAK 1-9), and digit 0 (DAK 10).
[[Image:Auto-attendant digits.PNG|thumb|left|500px|Auto-attendant digit routing: Digit 1 calls station 101, digit 2 calls station 123, digit 3 calls station 5432, and digit 0 repeats the voice menu]]
<br style="clear:both;" />
If the caller doesn't press any digits within 5 seconds, the call is automatically routed to the intercom number entered in the  first entry in the '''Search Strings''' tab.

=== Incoming Calls - Ringing signal on Ringing Group ===
When an incoming call from a SIP trunk is routed to a [[Ringing Group Feature|Ringing Group]], one can choose to have a different ringing signal in the receiving station(s) than the standard [[Private mode|Private Ringing]] signal. This can be useful in order to differentiate external calls from internal calls.

In AlphaPro, '''Exchange & System > System > VoIP''', check the flag '''Use UK style Ringing Tone on Ringing group calls from SIP''', and select which tone to use for the ringing signal. If this flag is unchecked, one will get standard Private Ringing signal.
[[File:SIP UK Style RG.PNG|left|thumb|500px|Enable and choose wanted Tone Type for Ringing Group calls from SIP]]
<br style="clear:both;" />

=== Incoming Calls - Ringing signal on Private Calls ===
When an incoming call from a SIP trunk is routed to a station in private mode, one can choose to have a different ringing signal in the receiving station(s) than the standard [[Private mode|Private Ringing]] signal. This can be useful in order to differentiate external calls from internal calls.

In AlphaPro, '''Exchange & System > System > VoIP''', check the flag '''Use UK style Ringing Tone on Private Calls from SIP''', and select which tone to use for the ringing signal. If this flag is unchecked, one will get standard Private Ringing signal.
[[File:SIP UK Style Pr.PNG|left|thumb|500px|Enable and choose wanted Tone Type for Private Calls from SIP]]
<br style="clear:both;" />

=== Incoming Calls - Group Calls ===
When activating a [[Groups|group call]] from SIP trunk, one can use the '*' key on the phone to open the speech path (simulates M-key on), and use the '#' key to close the speech path (simulates M-key off).

As an alternative, it is possible to open the speech path immediately when the group call number is dialed, without having to press any additional keys on the phone. There is a setting in AlphaPro per group call for this option. 

In AlphaPro, '''Groups > Local Groups''', select the group from the list box and enable "'''Automatic M-key only from SIP calls'''":
[[File:SIP AutoMkey.PNG|left|thumb|500px|Enable use of group call from SIP trunk without having to press M-key or */# ]]
<br style="clear:both;" />

===Door Opening Feature===
During a conversation between a door station and a telephone, the telephone operator can activate the [[Door opening|Door Opening feature]] in the AlphaCom by pressing digit 6. 

A SIP Trunk is automatically using Class of Service 15. This Class of Service group does not have the option for remote door opening enabled by default. In AlphaPro select the [[Class Of Service (AlphaPro)|Class of Service]] button, select number 15 (Outside Telephones), press change and locate feature number 58 in the "Not Valid" list. Highlight '''Feature 58''' and use the single arrow key to move it to the "valid" list.
[[File:COS15 DoorOpening.PNG|left|thumb|500px|Enable feature 58 (Door Opening) in Class of Service 15]]
<br style="clear:both;" />


The Door Opening feature is programmed in the Event Handler. When SIP trunk is involved, there are two separate events for the door opening feature, depending on who is the <u>calling</u> side.

'''Incoming call from the SIP Trunk to the AlphaCom door station:'''

The '''Standard''' door opening event is used:
[[Image:AlphaCom configuration.jpg|left|thumb|500px|Door Opening event when call is initated from the SIP Trunk]]
<br style="clear:both;" />

'''Outgoing call from the AlphaCom door station to an external telephone via the SIP Trunk:'''

When the phone presses digit 6, the event type '''Event Trigger Feature''' (15) is reported, with the digit 6 as sub event. The calling AlphaCom station is Event Owner, and called SIP phone number and node number is Related To. The RCO pulse time is specified as an additional parameter in the RCO action string, i.e. RCO 3 ON 20 means pulse RCO 3 for 2 seconds.
[[Image:Calling from the door to the Telephone.jpg|left|thumb|500px|Door Opening event when call is initated from the door intercom station]]
<br style="clear:both;" />

===Voice Switching in Noisy Environment===
If the intercom station is located in a noisy environment, it might be difficult to switch the voice direction from the telephone towards the intercom station. However, there is a setting in the AlphaCom to overcome this problem. In AlphaPro, '''Exchange & System > System > VoIP''', set the parameter '''Optimized voice duplex control when conversation with SIP trunk/stations'''

When this flag is set, the initial voice direction is forced to be from the intercom towards the telephone. When the phone operator starts to speak, the voice direction will switch towards the intercom station, regardless of the level of the audio signal from the intercom station. As soon as the phone operator stops speaking, the voice direction will switch back to the initial direction.
[[Image:Voice Switching in Noisy Environment.jpg|left|thumb|500px]]
<br style="clear:both;" />


=== Transmit DTMF signal from AlphaCom ===

==== Outgoing calls to SIP trunk ====

The DTMF signals ‘*’ and ‘#’ will be transmitted to the line when DAK 1 (*) and DAK 2 (#) is pressed during an outgoing telephone conversation. No programming is required.

==== Incoming calls from SIP trunk ====
By default digits dialed on an intercom station will be handled locally in the AlphaCom, and not transmitted out on the SIP trunk.

To be able to send DTMF signals to the SIP trunk, one have to set the station in a certain mode by the data command [[TRUNK_SIG|$TRUNK_SIG]]. The mode can be set either:
* Manually by pressing as DAK key during the call, or 
* Automatically when a call is received from the SIP trunk

Manually by pressing a DAK key:
[[File:DialOutSIPTrunk.PNG|thumb|left|500px|Enable DTMF transmission by first pressing DAK key 3]]
<br style="clear:both;" />

Automatically when receiving a call from the SIP trunk:
[[File:DialOutSIPTrunk2.PNG|thumb|left|500px|Enable DTMF transmission when receiving calls from SIP Trunk node 100]]
<br style="clear:both;" />

In this example the SIP Trunk node is 100, you need to change this according to the node number used.

Note that the data command [[TRUNK_SIG|$TRUNK_SIG]] requires AMC software 11.5.x.x or newer.

=== Call Transfer ===

==== Incoming calls from SIP Trunk ====
An incoming call to station A can be transferred to station B:
* Dial 2 (puts call on-hold)
* Dial B's number
* Dial 3 (transfers the call)

==== Outgoing calls to SIP Trunk ====
An outgoing phone call from station A can be transferred to station B:
* Press DAK 4, or DAK 9 on an analog ASLT station (turns off transparent mode)
* Dial 2 (puts call on-hold)
* Dial B's number
* Dial 3 (transfers the call)

For more details, see: [[Transparent Mode DAK-Key Configuration]]


=== Monitoring a SIP Trunk ===
==== Enable Monitoring of the SIP Trunk ====

The monitoring of the communication between the AlphaCom and the SIP server must be enabled per SIP trunk. When enabled, the AlphaCom sends a SIP message OPTIONS to the SIP server every 5 seconds, and expects a response in due time, else the link is reported down.

The monitoring is enabled from AlphaPro. Open '''Exchange & System''' > '''NetRouting''', select the route to the SIP node, and press '''Change'''. Enable the flag "Monitor SIP Trunk":

[[File:AP Enable SIP Monitoring.PNG|left|thumb|500px|Enabling monitoring of SIP trunk node 100]]
<br style="clear:both;" />

==== Reporting failure ====
The event [[AlphaNet Link (Event Type)|29 - AlphaNet Link]] is triggered when the communication with a SIP server goes up or down. The "Sub Event" is the SIP Trunk node number.

Example: The following event will report to the [[System log|System Log]] and operate [[RCO|RCO 5]] when the SIP Server on SIP Trunk node 100 goes up or down:

[[File:SIPTrunkSupervision.PNG|thumb|left|500px|Event 29, Sub Event = node number, can be used to notify failover]]
<br style="clear:both;" />

'''Software requirement''':
* AMC 11.5.3.1 or later
* AlphaPro 11.6.3.9 or later

=== Failover to redundant SIP server ===
[[File:SIP AltRouting.png|right|thumb|400px|At failover, calls are automatically routed to secondary SIP server]]
'''Failover''' is switching to a redundant or standby SIP server upon the failure of the primary SIP server. The failover is automatic and operates without warning. The switchover time is less than 5 seconds from a failure of the primary SIP server. 

The AlphaCom uses a "heartbeat" message (SIP OPTIONS) to check if the SIP servers are online. As long as the primary SIP server is online, calls will be routed to this server. If the primary SIP server goes off-line, calls will be routed to the secondary server.
As soon as the primary server comes back online, calls will be routed to this server again. 

'''Software requirement''':
* AMC 11.5.3.1 or later
* AlphaPro 11.6.3.9 or later

{{obs|
* ''Failover to redundant SIP server is supported only when using directory numbers with [[SIP_trunk_node_-_configuration#Create_access_numbers|feature number 81 and feature number 83]].''
* ''Failover is '''not''' supported when using directory numbers with feature 9 (i.e. SIP Trunk Station)'' }}
==== Configure the Failover routing ====

* Two SIP Trunk nodes must be [[#Create a SIP Trunk Node|created in AlphaPro]] in the "standard" way.
* '''Monitoring SIP Trunk''' must be enabled, as described in previous paragraph

The Failover Routing is defined in the NetRouting Window in AlphaPro. The configuration is best illustrated by an example:

Let's say that you have already created two SIP Trunk nodes:
* SIP Trunk node 100 goes to SIP Server 1
* SIP Trunk node 101 goes to SIP Server 2

In the '''NetRouting''' you create the routing from AlphaCom to SIP server 1, and define the SIP server 2 in the "Alternative Route" field:
[[File:SIP Routing Opt1.png|left|thumb|500px|Defining Primary (node 100) and Secondary (node 101) SIP server in AlphaPro]]
<br style="clear:both;" />

Now calls that normally goes to SIP Server 1, will automatically be routed to SIP Server 2 if SIP Server 1 is off-line.

Optionally it is also possible to define the SIP Server 2 as the primary server and Server 1 as the secondary server:

[[File:SIP Routing Opt2.png|left|thumb|500px|Defining SIP trunk node 101 as Primary SIP trunk, and SIP trunk node 100 as Secondary SIP trunk]]
<br style="clear:both;" />

In this case calls that normally goes to SIP Server 2, will be routed to SIP Server 1 if SIP Server 2 is off-line.

==== Failover routing if all voice channels are busy ====

A call can be routed to the secondary SIP trunk if all available voice channels to the primary SIP trunk is in use.

This can be useful e.g. if one want to expand the traffic capacity by adding one more SIP gateway (e.g. [[Configuration guide for AudioCodes MP114/118, v6.2 and higher|AudioCodes MP114]]). When all channels on the first gateway is in use, the call can automatically be routed to the second gateway.

One have to define the maximum VoIP channels that is available for the primary SIP Trunk: Select '''Exchange & System -> NetRouting''' in AlphaPro. Press the '''Change''' button, and select the '''Advanced Settings''' tab. In the field '''Max VoIP Channels''', enter the number of voice channels this trunk have access to.

[[File:MaxTrunks2.PNG|thumb|left|500px|Defining 2 VoIP channels for SIP trunk 100]]
<br style="clear:both;" />

In the example above there will be maximum two voice calls via SIP Trunk node 100. A third call will be routed to trunk node 101.

== About VoIP Audio Channels ==
=== Call capacity===
The overall maximum call capacity on SIP trunk calls are as follows:
* Maximum outgoing conversations: 16
* Maximum incoming conversations: 32

The actual number of simultaneous calls are limited by the [[Licenses#SIP_trunk_license|SIP license]] installed. 

SIP trunk calls are using resources from a common pool of VoIP channels, which is also used by other VoIP services, such as AlphaNet calls and MultiModule calls. In addition to the limit set by the SIP license, the maximum number of simultaneous SIP trunk calls will also depend on other VoIP traffic currently active in the system.

When the call is to/from analog ASLT stations, the number of simultaneous calls in handsfree mode (loudspeaking) is limited by the number of speech channels available. There is one speech channel per ASLT board.

When the call is to/from analog ASLT or ATLB stations, the number of simultaneous handset (lowspeaking) calls is 10, limited by the number [[Line_Echo_Cancellation|LEC resources]].

=== Reserving VoIP channels for a SIP trunk ===
The SIP Trunk lines are a common pool of resources for all connected SIP Trunk nodes. The VoIP channels used by SIP Trunk(s) are assigned dynamically. However, it is possible to reserve one or several of the VoIP channels for a specific SIP trunk. In this way one can make sure that there will always be VoIP channels available to this trunk.

The VoIP channels have virtual physical numbers in the AlphaCom, starting from 605 to 634. 
To reserve a VoIP channel for a SIP Trunk, select '''Exchange & System -> NetAudio''' in AlphaPro. Press '''Insert''', and select the SIP trunk from the list of nodes. Now enter the physical number of the VoIP channel, i.e. a number between 605 to 634. It is good practice to start with 605 and go upwards.
[[File:SIPTrunkReserve.PNG|thumb|left|500px|Two VoIP channels are reserved for SIP Trunk node 100]]
<br style="clear:both;" />

The SIP trunk with reserved VoIP channels will still have access to the other free VoIP channels available according to the SIP Trunk license.

=== Limiting the number of VoIP channels used by a SIP Trunk ===

The SIP Trunk license sets the overall limit on how many simultaneous calls that can be made on SIP trunks. In addition to this, it is possible to set further limits on how many VoIP channels a specific SIP Trunk should be able to use. This could be useful if there are multiple SIP trunks, and one might want to set restrictions on how many VoIP channels one particular trunk can use.

To set the maximum VoIP channels that should be available for a SIP Trunk, select '''Exchange & System -> NetRouting''' in AlphaPro. Press the '''Change''' button, and select the '''Advanced Settings''' tab. In the field '''Max Trunks''' (or '''Max VoIP Channels'''), enter the number of VoIP channels this trunk should have access to.

[[File:MaxTrunks.PNG|thumb|left|500px|Maximum three simultaneous calls can be made via SIP Trunk node 100]]
<br style="clear:both;" />

==== Priority mechanism for dedicated stations ====
When "Max Trunks" are specified, and a call is made and there are no more free VoIP channels, you will get a busy tone. It is possible to ''Camp On'', and wait for the SIP trunk to become free. 

Stations with [[Call Setup Priority]] = Alarm will get a forced connection to the SIP trunk. This is sufficient to disconnect the ongoing conversation on the SIP trunk line.

Two more setting must be done if you want the user with alarm call setup to take over the SIP trunk line.

In the Audiocodes gateway, set "Guard time between calls" to zero. Default is 1:
[[image:MP114_Guard_Time.PNG|thumb|left|500px|MP114 Guard Time]]

<br style="clear:both;" />

In AlphaPro -> Exchange & System -> VoIP, change SIP Dial Delay to 20 (2 sec). Default is zero:
[[image:SIP_Dial_Delay.PNG|thumb|left|500px|SIP Dial Delay]]

<br style="clear:both;" />

<br>

== Additional information ==
=== UDP Group on incoming calls ===
Incoming SIP Trunk calls are by default using [[UDP group|UDP Groups]] 1 and 8. This is hardcoded, and cannot be changed.

=== Change UDP port number from 5060 ===
The default UDP port number 5060 used for SIP comminication can be changed in the AMC-IP memory, either by using the NVRAM editor from the [[TST console]] or by using the [[$SNV|$SNV command]] in [[Event Handler]].
{{code|<nowiki>.ex_profile.ip_config.sip_data = 5060</nowiki>}}

A small reset of the AlphaCom is required for the change to take effect.

Remember to define and open the new port in the [[AlphaWeb#Filters|Filters settings]] in AlphaWeb.

== Related articles ==

* [[%tin]] : The %tin macro can be used in the [[Event Handler]]. It returns the current number of trunk channels used towards a specific trunk
* [[Play_DAK_Feature]]: Define sequences of dialing, including pauses

== Troubleshooting ==
* [[SIP trace]]
* [[Wireshark - capture data]]


[[Category:AlphaCom - SIP Integration]]