TBwiki - User contributions [en]

H.248

2020-05-29T14:12:15Z

CThompson: Add "Analogue Display Signalling Package" for Nokia CLIP projet

Also known as Megaco, H.248 is a protocol for controlling media gateways via a [[Softswitch|softswitch]] or a [[Softswitch|Media Gateway Controller (MGC)]].

 

== TelcoBridges and H.248 ==

[[Toolpack]] now supports the H.248 protocol.

As indicated in the diagram below, the H.248 stack is a module in the media gateway application residing on the application server. It communicates with the various Toolpack classes (CAFClass, [[CMC library|CMC Library]], CMC Class) as required via a new [[CAF: Working With Call Legs|Media Leg API]]. In turn, the media gateway application communicates with the softswitch / media gateway controller via the H.248 protocol.

 [[Image:H.248 schematic.jpg|H.248 schematic.jpg]]

 

=== H.248 package support ===

[[Toolpack]] supports the following packages.

*'''H.248.1'''
**Protocol v2
**IPSec connection support
**Support UDP (2944 or user-defined)

 

*'''H.248.1 - Basic packages'''
**Generic
**Base Root
**Tone generator (for extension purposes only)
**Tone detection (for extension purposes only)
**Basic DTMF generation
**DTMF detection
**Call Progress Tones Generator (Ringing, Busy, Congestion and Warning tones supported)
**Basic continuity package
**Network package
**RTP package
**TDM Circuit package (only echo-cancellation)

 

*'''H.248.2 Facsimile, text conversation and call discrimination packages'''
**Fax/TextPhone/Modem tones detection (fax and data only)
**Call type discrimination package (fax and data only)
**IP Fax (Event: Fax Connection Change - end of fax session, call terminating)

 

*'''H.248.4 Transport over Stream Control Transmission Protocol (SCTP)'''
** Partial support
 

*'''H.248.7 Generic announcement package'''
**Generic announcement package (Fix Announcement play only)

 

*'''H.248.10 Media gateway resource congestion handling package'''
**Congestion handling package

 

*'''H.248.11 Media gateway overload control package'''
**Overload control package

 

*'''H.248.13 Quality alert ceasing package'''
**Quality alert ceasing package

 

*'''H.248.14 Inactivity timer package'''
**Inactivity timer package

 

*'''H.248.16 Enhanced digit collection packages and procedures'''
**Extended DTMF detection package
**Enhanced DTMF detection package

 

*'''H.248.23 Enhanced alerting packages'''
**Enhanced alerting package
**Analogue Display Signalling package
 

*'''H.248.25 Basic CAS packages'''
**Basic CAS package
**Basic CAS addressing
 

*'''H.248.27 Supplemental tones packages'''
**Carrier tones generation package
**Diagnostic tones generation package
 

*'''H.248.28 International CAS packages'''
**International CAS
**CAS blocking

 

*'''H.248.29 International CAS compelled register signaling packages'''
** Annex A.1 only in 'enbloc' compelled mode (International CAS Compelled package - No digitmap control: Digitmaps are preconfigured on MG)

 

*'''Q.1950 packages'''
**Basic call progress tones generator package
**Expanded call progress tones generator package
**Basic services tones generator package

 

== Additional details ==

*Support for text mode only

== Configuration ==
*[[Toolpack:Protocol_Stack_Settings_D#H.248_MEGACO|Web Portal v3.0: H.248 Configuration]]
*[[Toolpack:Protocol_Stack_Settings_C#H.248_MEGACO|Web Portal v2.10: H.248 Configuration]]
*[[Toolpack:Protocol_Stack_Settings_B#H.248_MEGACO|Web Portal v2.9: H.248 Configuration]]
*[[Toolpack:Protocol_Stack_Settings_A#H.248_MEGACO|Web Portal v2.8: H.248 Configuration]]
<div class="mw-collapsible mw-collapsed" data-collapsetext="other versions" data-expandtext="Click here for other versions" style="width: 400px;">
*[[Web_Portal_Tutorial_Guide_v2.7#H.248|Web Portal v2.7: H.248 Configuration]]
*[[Toolpack_v2.5:Creating_an_H.248_Configuration|Configuring H.248 on TMG devices (v2.6 and before)]]
</div>

== References ==

*[http://en.wikipedia.org/wiki/Megaco Wikipedia article]

[[Category:Glossary]]
[[Category:Tmedia_Features|H.248/Megaco]]
[[Category:Revise on Major]]

Routing script tutorial:Mini Development Guide

2019-09-09T15:24:12Z

CThompson: - Added ACLI IE (Additional Calling Party Information) - Carl Thompson

== Call object ==

=== Get ===

This function is used to get the call parameters. The possible parameters are described in the section "Call parameters"

called_number = caf_call.get :called

=== List_params ===

This function is used to retrieve the list of supported call parameters. For example to extract all the possible call parameters from the the call object and put it in hash.

caf_call.list_params.each {|param| call[param] = caf_call.get param }

=== Accept ===

This function is used to accept a call. It actually creates one outgoing route that the gateway application will use to bridge the incoming call leg. If more than one outgoing route is "accepted", the gateway will try them one by one in the same order that they were accepted. If an outgoing call leg fails (according to 'route retry' parameters), the next route in line will be used.

This method takes 2 arguments, the call parameters (hash) and the route parameters (hash). Note that calling this method does NOT stop the flow of the script.

Apply route remapping rules

caf_call.accept out_call, route

=== Refuse ===

This function is used to set the reason code for the incoming call leg refusal. However, this function does NOT stop the flow of the script.

caf_call.refuse :reason => :temporary_failure

To immediately refuse the incoming call leg and stop processing the script, the script must raise an exception. Exiting the script by raising the exception overwrites any reason cause previously stored using refuse().

raise RoutingException, :no_route

The supported refusal cause values for both refuse() and raise() are described in the section "[[Routing_script_tutorial:Mini_Development_Guide#Reason_values|Reason values]]".

=== Script parameters protocol mapping ===

The following call parameters are available in the call object. For example:

called_number = call[:called]

For information on how to use and remap call parameters, see [[Toolpack:_How_to_Use_RegEx_in_Remapped_Called_and_Calling_Number_Mask | How to use regex in Remapped Called and Calling Number Mask]]

{| cellspacing="1" cellpadding="1" border="1" style="width: 921px; height: 805px;"
|-
! scope="col" | '''Script parameter name'''
! scope="col" | '''ISDN '''
! scope="col" | '''R2 CAS''' 
! scope="col" | '''SS7 '''
! scope="col" | '''SIP '''
! scope="col" | '''Comment '''
! scope="col" | '''Toolpack version '''
|-
| leg_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Leg ID 
| 
|-
| session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Session ID 
| 
|-
| original_session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Original Session ID (before call transfer or redirections) 
| 
|-
| calling 
| Q931: 'Calling party number' IE - Number digits 
| ANI (Group B) 
| Q763: 'Calling party number' IE - address signals (*) 
| SIP:From - user-info 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead. 
| 
|-
| calling_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:From - host (domain or IP) 
| For example : The 'telcobridges.com' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| calling_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:From - port 
| For example : The '6060' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| calling_noa 
| Q931: 'Calling party number' IE - Type of number 
| N/A 
| Q763: 'Calling party number' IE - nature of address indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_npi 
| Q931: 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Calling party number' IE - numbering plan indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_display 
| Q931: 'Display' IE - Display information 
Q931: 'Facility CNAM' IE when presentation is allowed for DMS/NI2 variants 
| N/A 
| Q763
ITU97: 'Display information' IE - display information
ANSI95: 'Generic name' IE - display information
| SIP:From - display-name 
| 
| 
|-
| calling_display_type 
| Q931: 'Display' IE - Display information (present and/or first byte) 
| N/A 
| Q763: 'Display information' IE - present or not 
| N/A 
| 
| 
|-
| calling_presentation 
| Q931: 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: 'Calling party number' IE - address presentation restricted indicator 
|
SIP:From - display-name (displays 'anonymous' or not)

SIP:Remote-party-id - privacy 

| 
| 
|-
| calling_screening 
| Q931: 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: 'Calling party number' IE - screening 
| SIP:Remote-party-id - screen 
| 
| 
|-
| calling_category 
| N/A 
| Call party category (Group A) 
| Q763: 'Calling party's category' IE - calling party's category 
|
SIP:From - cpc

SIP:P-asserted-identity - cpc 

| 
| 
|-
| calling_subscriber
(Generic Number / NDS) 
| Q931: 2nd 'Calling party number' IE - Number digits 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - Number digits 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| Requires option 'support 2 calling number IE' in the profile. This variable has priority over 'private_address' in the outgoing direction. 
| 
|-
| calling_subscriber_noa 
| Q931: 2nd 'Calling party number' IE - Type of number 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - nature of address indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_npi 
| Q931: 2nd 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - numbering plan indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
 
| 
|-
| calling_subscriber_presentation 
| Q931: 2nd 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - presentation restricted indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_screening 
| Q931: 2nd 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - screening 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| private_display 
| Q931: 'Facility CNAM' IE when presentation is restricted for DMS/NI2 variants 
| N/A 
| N/A 
|
SIP:P-asserted-identity - display-name 

SIP:Remote-party-id - display-name 

| 
| 
|-
| private_display_type 
| N/A 
| N/A 
| N/A 
| N/A 
| Indicate presence or not of the private calling information 
| 
|-
| private_address 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 

| For example : The 'fluffy' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - host (domain or IP)

SIP:Remote-party-id - host (domain or IP) 

| For example : The 'telcobridges.com' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - port

SIP:Remote-party-id - port 

| For example : The '6060' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| preferred_id_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default P-Preferred-Identity header forwarding behavior from incoming to outgoing leg 
| 
|-
| preferred_id 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - userinfo

| For example : The 'fluffy' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_display_name 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - display name

| For example : The 'Cullen Jennings' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - host (domain or IP)

| For example : The 'telcobridges.com' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - port

| For example : The '6060' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called 
| Q931: 'Called party number' IE - Number digits 
| DNIS (Group A) 
| Q763: 'Called party number' IE - address signals 
| SIP:To - user-info and host 
| 
| 
|-
| called_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:To - host 
| For example : The 'telcobridges.com' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| called_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:To - port number 
| For example : The '6060' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called_noa 
| Q931: 'Called party number' IE - Type of number 
| N/A 
| Q763: 'Called party number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| called_npi 
| Q931: 'Called party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Called party number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| charge_number 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - address signals 
| N/A 
| 
| 
|-
| charge_number_noa 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| charge_number_npi 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default redirecting number and original called number forwarding behavior from incoming to outgoing leg 
| 
|-
| redirecting_number 
| Q931: 'Redirecting number' 1st IE - Number digits 
| N/A 
| Q763: 'Redirecting number' IE - address signals 
| SIP:Diversion (2nd header) - display-name 
| 
| 
|-
| redirecting_number_noa 
| Q931: 'Redirecting number' 1st IE - Type of number 
| N/A 
| Q763: 'Redirecting number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| redirecting_number_npi 
| Q931: 'Redirecting number' 1st IE - Numbering plan identification 
| N/A 
| Q763: 'Redirecting number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_presentation 
| Q931: 'Redirecting number' 1st IE - Presentation indicator 
| N/A 
| Q763: 'Redirecting number' IE - address presentation restricted indicator 
| SIP:Diversion (2nd header) - diversion-privacy 
| 
| 
|-
| redirecting_number_indicator 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirecting indicator 
| N/A 
| 
| 
|-
| redirecting_number_reason 
| Q931: 'Redirecting number' 1st IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - redirecting reason 
| SIP:Diversion (2nd header) - diversion-reason 
| 
| 
|-
| redirecting_number_counter 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirection counter 
| SIP:Diversion (2nd header) - diversion-counter 
| 
| 
|-
| original_called_number
(OCN) 
| Q931: 'Redirecting number' 2nd IE - Number digits 
| N/A 
| Q763: 'Redirection number' IE - address signals 
| SIP:Diversion  (1st header) - display-name 
| 
| 
|-
| original_called_number_noa 
| Q931: 'Redirecting number' 2nd IE - Type of number 
| N/A 
| Q763: 'Redirection number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| original_called_number_npi 
| Q931: 'Redirecting number' 2nd IE - Numbering plan identification 
| N/A 
| Q763: 'Redirection number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| original_called_number_presentation 
| Q931: 'Redirecting number' 2nd IE - Presentation indicator 
| N/A 
| Q763: 'Redirection number' IE - address presentation restricted indicator 
| SIP:Diversion (1st header) - diversion-privacy 
| 
| 
|-
| original_called_number_reason 
| Q931: 'Redirecting number' 2nd IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - original redirection reason 
| SIP:Diversion (1st header) - diversion-reason 
| 
| 
|-
| original_called_number_counter 
| N/A 
| N/A 
| N/A 
| SIP:Diversion (1st header) - diversion-counter 
| 
| 
|-
| ported_number_npdi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - with qualifier=Ported number is present 
| SIP:RequestURI - npdi=yes is present 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number 
| N/A 
| N/A 
| Q763: 'Generic number' IE - address signals with qualifier=Ported number 
| SIP:RequestURI - to user part when rn is present 
| rn is stored in the called number 
| 
|-
| ported_number_noa 
| N/A 
| N/A 
| Q763: 'Generic number' IE - nature of address indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number_npi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - numbering plan indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| oli
(Originating line information) 
| 5ESS Codeset 6 OLI - Value 
| N/A 
| ANSI: 'Originating line information' IE - OLI 
|
SIP:From - oli

SIP:P-asserted-identity - oli 

| 
| 
|-
| request_uri 
| N/A 
| N/A 
| N/A 
| Complete Request URI string 
| 
| 
|-
| request_uri_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default URI forwarding behavior from incoming to outgoing leg 
| 
|-
| sip_header 
| N/A 
| N/A 
| N/A 
| Any header 
| Requires option 'Forward custom headers' in Profiles->SIP 
| 2.7.63 
|-
| nap
(Network Access Point) 
| N/A 
| N/A 
| N/A 
| N/A 
| Incoming leg NAP name (read-only) 
| 
|-
| type_of_network_identification 
| Q931: 'Transit network selection' IE - Type of network identification 
| N/A 
| Q763: 'Transit network selection' IE - Type of network identification 
| N/A 
| 
| 2.7 
|-
| network_identification 
| Q931: 'Transit network selection' IE - Network identification 
| N/A 
| Q763: 'Transit network selection' IE - Network identification 
| SIP: Request-Line - cic 
| 
| 2.7 
|-
| network_identification_plan 
| Q931: 'Transit network selection' IE - Network identification plan 
| N/A 
| Q763: 'Transit network selection' IE - Network identification plan 
| N/A 
| 
| 2.7 
|-
| location_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default location number forwarding behavior from incoming to outgoing leg 
| 2.7 
|-
| location_number 
| N/A 
| N/A 
| Q763: 'Location number' IE - address signals 
| N/A 
| 
| 2.7 
|-
| location_number_noa 
| N/A 
| N/A 
| Q763: 'Location number' IE - nature of address indicator 
| N/A 
| 
| 2.7 
|-
| location_number_npi 
| N/A 
| N/A 
| Q763: 'Location number' IE - numbering plan indicator 
| N/A 
| 
| 2.7 
|-
| location_number_presentation 
| N/A 
| N/A 
| Q763: 'Location number' IE - presentation restricted indicator 
| N/A 
| 
| 2.7 
|-
| location_number_screening 
| N/A 
| N/A 
| Q763: 'Location number' IE - screening 
| N/A 
| 
| 2.7 
|-
| mlpp_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| A script needs to set this to true if it wants to overwrite MLPP information in the outgoing leg. Otherwise, profile relay 'outgoing mode' applies automatically. 
| 2.7 
|-
| mlpp_look_for_busy 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - look ahead for busy 
| N/A 
| 
| 2.7 
|-
| mlpp_precedence_level 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - precedence level 
| SIP:Resource-Priority - q735 
| 
| 2.7 
|-
| mlpp_network_identity 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - network identity 
| N/A 
| 
| 2.7 
|-
| mlpp_service_domain 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - MLPP service domain 
| N/A 
| 
| 2.7 
|-
| isub_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default ISUB forwarding behavior from incoming to outgoing leg 
| 3.0.138 
|-
| called_isub 
| Q931: 'Called party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub parameter 
| 
| 2.7 
|-
| called_isub_type 
| Q931: 'Called party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub-encoding parameter 
| 
| 2.7 
|-
| calling_isub 
| Q931: 'Calling party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub 
| 
| 2.7 
|-
| calling_isub_type 
| Q931: 'Callinf party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub-encoding 
| 
| 2.7 
|-
| ss7_fci_default 
| N/A 
| N/A 
| Default forward call indicator (FCI) value. 
| N/A 
| Toolpack will overwrite FCI bits A, D, F, I and M with appropriate values according to call conditions 
| 2.7 
|-
| ss7_fci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_fci_default that must be forced. 
| N/A 
| Bits from ss7_fci_default which corresponding bit in ss7_fci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| ss7_bci_default 
| N/A 
| N/A 
| Default backward call indicator (BCI) value. 
| N/A 
| Toolpack will overwrite BCI bits AB, I, K, M and N with appropriate values according to call conditions 
| 2.7 
|-
| ss7_bci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_bci_default that must be forced. 
| N/A 
| Bits from ss7_bci_default which corresponding bit in ss7_bci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| tdm_ls_name_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable line service and timeslot selection to create the outgoing leg. tdm_ls_name and tdm_timeslot_nb must be defined along with tdm_ls_name_forward_enabled 
| 3.0 
|-
| tdm_ls_name
(Line Service or T1/E1 trunk) 
| Incoming leg line service name 
| Incoming leg line service name 
| Incoming leg line service name 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this line service name to create outgoing leg 
| 2.7 
|-
| tdm_timeslot_nb 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this timeslot number to create outgoing leg 
| 2.7 
|-
| rtp_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP port 
| (read-only) 
| 2.7 
|-
| rtp_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP port 
| (read-only) 
| 2.7 
|-
| ss7_cot_enabled 
| N/A 
| N/A 
| Requests SS7 in-call continuity test for this outgoing SS7 call 
| N/A 
| Toolpack will request a continuity test on the timeslot before making the outgoing call. If COT fails, the call will be dropped (then another route may be attempted) 
| 2.8 
|-
| reverse_charging_indication 
| Incoming leg Reverse charging indication IE present 
| N/A 
| N/A 
| N/A 
| If set in routing script, will add Reverse charging indication IE in outgoing leg (also use reverse_charging_indication_forward_enabled) 
| 2.8.12 
|-
| reverse_charging_indication_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable forwarding of reverse charging indication from incoming to outgoing leg 
| 2.8.12 
|-
| sip_call_id 
| N/A 
| N/A 
| N/A 
| Incoming leg SIP Call-Id 
| (read-only) 
| 2.9.112 / 3.0.131 
|-
| sip_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP port 
| (read-only) 
| 2.8.13 
|-
| sip_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP port 
| (read-only) 
| 2.8.13 
|-
| acli 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - address signals.
A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_nao 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - nature of address indicator.
A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_npi 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - numbering plan indicator.
A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_presentation 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - address presentation restricted indicator.
A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_screening 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - screening indicator.
A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|}

 

=== Noa values ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unknown_number (0x2)</tt>
*<tt>international_number (0x4)</tt>
*<tt>national_number (0x3)</tt>
*<tt>subscriber_number (0x1)</tt>
*<tt>network_specific (0x5)</tt>
*<tt>network_routing_national_format (0x7)</tt>
*<tt>network_routing_international_format (0x8)</tt>
*<tt>abbreviated_number (0x6)</tt>
*<tt>subscriber_number_operator_requested (0x71)</tt>
*<tt>national_number_operator_requested (0x72)</tt>
*<tt>international_number_operator_requested (0x73)</tt>
*<tt>no_number_present_operator_requested (0x74)</tt>
*<tt>no_number_present_cut_through_call_to_carrier (0x75)</tt>
*<tt>test_line_test_code (0x77)</tt>
*<tt>non_unique_subscriber_number (0x71)</tt>
*<tt>non_unique_national_number (0x73)</tt>
*<tt>non_unique_international_number (0x74)</tt>
*<tt>call_950_numbe (0x76)</tt>
*<tt>special_number (0x73)</tt>
*<tt>national_number_with_transit_network_selection (0x74)</tt>
*<tt>international_number_with_transit_network_selection (0x75)</tt>

Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:

*<tt>call_params[:called_noa] = 0x70</tt>

or

*<tt>call_params[:called_noa] = 112</tt>

=== Npi values ===

*<tt>unknown_number</tt>
*<tt>isdn</tt>
*<tt>telephony</tt>
*<tt>private</tt>
*<tt>data</tt>
*<tt>telex</tt>
*<tt>national</tt>

=== Calling Display Type values ===

*<tt>unspecified</tt> => Type is unspecified.
*<tt>calling_party_name</tt> => Type is 0xB1.

Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:

*<tt>call_params[:calling_display_type] = 0xB1</tt>

or

*<tt>call_params[:calling_display_type] = 177</tt>

=== Calling Display value ===

*<tt>call_params[:calling_display] = "Roger Fluffy"</tt>

=== Presentation values for Calling number, Calling Subscriber (Generic Number), Redirecting Number, Original Called Number (OCN) and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>not_available (0x2)</tt>
*<tt>allowed (0x0)</tt>
*<tt>restricted (0x1)</tt>
*<tt>addr_restricted</tt>
*<tt>name_restricted</tt>

=== Calling Party Category ===
The text below represents the value normally used by routing script. 
In case it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 

Mapping from routing script to SS7/CAS R2/SIP
{| cellspacing="1" cellpadding="1" border="1"
|-
! scope="col" | '''Routing Script string '''
! scope="col" | '''SS7 raw value '''
! scope="col" | '''R2 CAS scripts''' 
! scope="col" | '''Default Rx CAS''' 
! scope="col" | '''default Tx CAS''' 
! scope="col" | '''SIP "cpc=" '''
|-
| subscriber 
| 0xa 
| CATEGORY_SUBSCRIBER 
| 1 and 7 
| 7 
| ordinary 
|-
| subscriber_with_priority 
| 0xb 
| CATEGORY_SUBSCRIBER_WITH_PRIORITY 
| 2 and 9 
| 2 
| priority 
|-
| operator_french 
| 0x1 
| CATEGORY_OPERATOR_FRENCH 
| 5 
| 5 
| operator 
|-
| operator_english 
| 0x2 
| CATEGORY_OPERATOR_ENGLISH (5) 
| 5 
| 5 
| operator 
|-
| operator_german 
| 0x3 
| CATEGORY_OPERATOR_GERMAN (5) 
| 5 
| 5 
| operator 
|-
| operator_russian 
| 0x4 
| CATEGORY_OPERATOR_RUSSIAN (5) 
| 5 
| 5 
| operator 
|-
| operator_spanish 
| 0x5 
| CATEGORY_OPERATOR_SPANISH (5) 
| 5 
| 5 
| operator 
|-
| data 
| 0xc 
| CATEGORY_DATA 
| 6 and 8 
| 6 
| datacall 
|-
| test 
| 0xd 
| CATEGORY_TEST 
| 3 
| 3 
| test 
|-
| payphone 
| 0xf 
| CATEGORY_PAYPHONE 
| none 
| 7 
| payphone 
|-
| unknown 
| 0x0 
| CATEGORY_UNKNOWN 
| 4, 11 to 15 
| 7 
| unknown 
|-
| unspecified 
| 0xa 
| invalid 
| none 
| none 
| invalid 
|}
[[CAS_R2_scripting#Category_meanings|Link to calling party categories used in CAS R2 scripts]]

=== Screening values for Calling number, Calling Subscriber (Generic Number), and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>no (0x0)</tt>
*<tt>pass (0x1)</tt>
*<tt>fail (0x2)</tt>
*<tt>network_provided (0x3)</tt>

=== Redirecting indicator values ===

SS7:

*<tt>no_redirection</tt>
*<tt>call_rerouted</tt>
*<tt>call_rerouted_all_restricted</tt>
*<tt>call_diverted</tt>
*<tt>call_diverted_all_restricted</tt>
*<tt>call_rerouted_restricted</tt>
*<tt>call_diverted_restricted</tt>
*<tt>spare</tt>

=== Redirecting number, Original Called Number and Diversion Reason ===

ISDN:

*<tt>unknown</tt>
*<tt>busy</tt>
*<tt>no_reply</tt>
*<tt>deflection</tt>
*<tt>dte_out_of_order</tt>
*<tt>forwarding_by_called_dte</tt>
*<tt>unconditional</tt>

SS7:

*<tt>unknown</tt>
*<tt>busy (SIP: user-busy)</tt>
*<tt>no_reply (SIP: no-answer)</tt>
*<tt>unconditional</tt>
*<tt>deflection</tt>
*<tt>deflection_immediate</tt>
*<tt>mobile_not_reachable</tt>

=== OLI (originating line information) values ===

The OLI parameter is a string that represents an integer value from 0 to 255.

=== Information Transfer Capability values ===

information_transfer_capability:

*<tt>digital</tt>
*<tt>restricted_digital</tt>
*<tt>digital_with_tones</tt>
*<tt>speech</tt>
*<tt>3_1_khz_audio</tt>
*<tt>video</tt>

=== redirecting_number_forward_enabled values ===

Controls forwarding or discarding of redirecting number (SIP: diversion header) to the outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
*0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg
*1/true: Redirecting number (and original called number) is forwarded to outgoing call leg

The value for this parameter at the input of the routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

Note: To "insert" a new redirecting number value on the outgoing leg, redirecting_number_forward_enabled must also be set to true.

=== request_uri ===

Enables access to the Request-Line URI. 

For example, if the Request-Line is:
<pre>Request-Line: INVITE sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0</pre>
Then the retrieved request_uri will be "sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0". 

In the routing scripts, to retrieve only the called number, this script can be used: 
<pre> if call_params[:request_uri] && call_params[:request_uri] =~ /sip:(.*)@.*/
call_params[:called] = $1
end
</pre>
==== request_uri_forward_enabled ====

This call parameter controls forwarding or discarding of request uri to outgoing call leg.The request uri is the information in the "Request-Line:" of the SIP INVITE message. 

Values for this parameter are "0", "1", "false" or "true. 

* 0/false: Request uri is not forwarded to outgoing call leg 

* 1/true: Request uri is forwarded to outgoing call leg 

The default value for this parameters is false. 

==== sip_scheme ====
(Available in Toolpack 3.1+)
This call parameters indicates the scheme (generally "sip" or "sips") of the incoming call.

This also allows to control the scheme used for the outgoing call (regardless if request_uri_forward_enabled is used or not)

Note: sips scheme must only be used on TLS NAPs (will cause call routing failure if NAP has only UDP or TCP transport types).

=== sip_header values ===
Contains custom sip headers from the inbound call leg. Any custom sip header can be added to an outgoing call leg: 

'''Note:'''

The SIP header is in string format.

'''string format:'''
<pre>call[ :sip_header ] = "P-my-custom-header:value1 \nP-my-custom-header2:value2 \nP-my-custom-header3:value3"
</pre>
(Note: \n above are actual newline characters, not '\' followed by 'n')

* PCAP sample: [[File:TB_Custom_SIP_Headers.pcap]]

List of sip headers that will not appear in call[:sip_header] since they are already processed by the SIP stack:
<pre>
Accept Error-Info Remote-Party-ID
Accept-Contact Event Replaces
Accept-Encoding Expires Reply-To
Accept-Language From Request-Disposition
Alert-Info In-Reply-To Subject
Allow Max-Forwards Subscription-State
Allow-Events MIME-version Supported
Also Min-Expires Timestamp
Anonymity Min-SE To
Authorization Organization Unsupported
Authentication-Info Path User-Agent
Call-ID Priority Via
Call-Info Privacy Warning
Contact Proxy-Authenticate WWW-Authenticate
Content-Disposition Proxy-Authorization Require
Content-Encoding Proxy-Require Response-Key
Content-Language P-Media-Authorization Retry-After
Content-Length P-Preferred-Identity RPID-Privacy
Content-Type P-Asserted-Identity Route
CSeq RAck RSeq
RAck Reason Security-Client
Reason Record-Route Security-Server
Date Refer-To Security-Verify
Diversion Referred-By Server
Encryption Reject-Contact Service-Route
Session-Expires
</pre>

=== sip header parameters ===
The routing script can read (and modify) some SIP header parameters (user parameters, URI parameters or header parameters) from some SIP headers (To, From, P-Asserted-Identity, Remote-Party-ID, Contact).

==== Available parameters ====
* '''call[ :calling_parameters ]''' (SIP "From" header)
* '''call[ :called_parameters ]''' (SIP "To" header)
* '''call[ :private_address_parameters ]''' (SIP "P-Asserted-Identity" or "Remote-Party-ID" header)
* '''call[ :preferred_id_parameters ]''' (SIP "P-Preferred-Identity" header)
* '''call[ :contact_parameters ]''' (SIP "Contact" header)

These parameters (if present) contain a hash with 3 keys: user_param, uri_param and header_param.
Each of this key points to a string that contains all the parameters found in the corresponding SIP header.
* '''User parameters''' (parameters between the user name/number and the host). Example <sip:alice;'''param=value'''@somewhere.com>
* '''URI parameters''' (parameters at the end of the URI). Example <sip:alice@somewhere.com;'''param=value'''>
* '''Header parameters''' (outside the URI). Example <sip:alice@somewhere.com>;'''param=value'''
Example to print all parameters of SIP "To" header:
call[ :called_parameters ].inspect -> '{ :user_param => "name1=value1;name2=value2", :uri_param => "name=value", :header_param => "name=value;example_param_without_value" }'
Example to modify (replace) the URI parameters of SIP "To" header:
call[ :called_parameters ][ :uri_param ] = "user=phone"

==== Exceptions ====
'''Note:''' Some parameters are reported as their own call attribute (oli, isub, cpc, transport) so they have the same representation for all protocols (SS7, IDSN, SIP). They won't appear present in the generic SIP header parameters structures above.

==== Forwarding from inbound to outbound call ====

==== Legacy behavior ====
(For base_routing version 1.32 or older)
By default, the parameters are not forwarded in a SIP to SIP call flow. The parameters '''will be forwarded''' when:
* accessed (read) from either the inbound or outbound call parameters
* written in either the inbound or outbound call parameters

==== Current behavior ====
(For Toolpack 3.0.118+, with base_routing version 1.33+)
SIP headers host and parameters are forwarded by default.

A route attribute "forward_sip_domain" (along with filter script "forward_sip_domain.rb") will control, per route, if SIP headers host+parameters must be forwarded.

==== Example usage ====
Example to print the user parameters:
<pre>
if call[:calling_parameters]
puts "user parameters = #{call[:calling_parameters][:user_param].inspect}"
end
</pre>

Example SIP "From" header:
From:<sip:123456782;test1=val1;test2=val2@something.com;test3=val3;test4=val4>;test5=val5;test6=val6
And the resulting content in the routing script:
call[:calling_parameters].inspect -> {:user_param=>"test1=val1;test2=val2", :uri_param=>"test3=val3;test4=val4", :header_param=>"test5=val5;test6=val6"}

Example to overwrite inbound leg calling parameters with new parameters for the outbound leg:
<pre>
call [:calling_parameters] = {
:user_param => "user_param7=7;user_param8=8",
:uri_param => "uri_param9=value9",
:header_param => "header_paramA=A" }
</pre>

Example to add user=phone and keep all other uri parameters.
<pre>
call[:calling_parameters] ||= {} # Create a hash if not already present
call[:calling_parameters][:uri_param] ||= "" # Create a string if not already present
call[:calling_parameters][:uri_param] += ";" if call[:calling_parameters][:uri_param] != ""
call[:calling_parameters][:uri_param] += "user=phone"
</pre>

=== MLPP Precedence values ===

mlpp_look_for_busy:

*<tt>allowed</tt>
*<tt>path_reserved</tt>
*<tt>not_allowed</tt>

mlpp_precedence_level:

*<tt>flash_override</tt>
*<tt>flash</tt>
*<tt>immediate</tt>
*<tt>priority</tt>
*<tt>routine</tt>

mlpp_network_identity:

3 digits value from 0 to 999

mlpp_service_domain:

24 bits value from 0 to 16777215

=== ISUB subaddress information values ===

called_isub_type:
calling_isub_type:

*<tt>nsap</tt>
*<tt>nsap_ia5</tt>
*<tt>nsap_bcd</tt>
*<tt>user</tt>

called_isub:
calling_isub:

Digits for the subaddress information.

=== Network Identification Plan ===

network_identification_plan:

*<tt>Unknown</tt> (value 0)
*<tt>cic</tt> (3 digits carrier identification code plus circuit code, value 1, SS7 or ISDN)
*<tt>user</tt> (User, value 2, ISDN only)
*<tt>cic4</tt> (4 digits carrier identification code plus circuit code, value 2, SS7 only)
*<tt>dnic</tt> (public Data Network ID, value 3, SS7 only)
*<tt>mnic</tt> (public land mobile network, value 6, SS7 only)

=== Registered Users Information ===
Routing script can access information about registered users (when either the calling or called user is a known registered user).
When these fields are empty, it means that the calling/called (SIP from/to) does not correspond to a known registered user (routing script may still decide to route the call based on static routes).

Information for the called user:
params[:registered_user]
Information for the calling user:
params[:calling_registered_user]

These parameters are a hash of key/values that provide information about the contact.
{
:contact_list=>
[
{
:contact=>"<sip:user_name_or_number@hostname:7070;transport=UDP>", -> Full contact
:expires=>"60", -> Contact expiry time (seconds)
:host=>"hostname", -> host name from the contact header
:name=>"user_name_or_number", -> user name from the contact header
:nap_in=>"NAP_NAME", -> NAP that the contact has registered from
:port=>"7070", -> Port from the contact header
:transport=>"UDP" -> Transport type from the contact header
:q_value=>"0.00", -> Q-value for the contact (for contact ordering)
:src_host=>"10.0.0.10", -> Actual source IP address that the contact has registered from
:src_port=>"7070", -> Actual source port that the contact has registered from
:src_transport=>"UDP", -> Actual protocol that the contact has been registering with
}
]
}

== Route parameters ==

All route may have these parameters:

*calling
*called
*nap
*remapped_calling
*remapped_called
*remapped_nap
*remapped_destination_leg_profile (called remapped_profile prior to Toolpack 2.9)
*remapped_source_leg_profile (called remapped_incoming_profile prior to Toolpack 2.9)

Example:

route[:remapped_nap]

Additionally it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.
For example:
*priority
*weight

== Routing calls toward registered users ==
Static routes normally chose an outbound NAP to forward the call to.

But it's also possible to create routes which outbound NAP is dynamically chosen by matching a registered user (when using [[Sip_registration_forwarding|SIP registration forwarding]]).

More information can be found [[Sip_registration_forwarding#SIP_Calls_routing|here]] about the way to control the [[Sip_registration_forwarding#SIP_Calls_routing|priority of "dynamic" vs "static" routes]].

More information can be found [[#Registered_Users_Information|here]] about using routing scripts to access registered users information during call routing.

== Playing prompts announcements or tones ==

New feature in release 2.6, all bridges may have these parameters. These can be used to play IVR prompts (audio files) in different states of the call flow.

*'''announcement_tone''' (played before outgoing call is routed)
*'''ring_tone''' (played after when waiting for outgoing call to answer)
*'''busy_tone''' (played if outgoing call failed)
*'''disconnect_tone''' (played after the call has reached it's maximum duration)

Example to play an announcement to incoming call (before routing outgoing call, regardless if a matching route is found or not):
bridge[:announcement_tone ] = "my_announcement.wav"

Example to play a ring-tone while the outgoing call is ringing:
bridge[:ring_tone] = "my_ring_tone.wav"

Example to play an audio file when outgoing call fails (no route, or outgoing call is refused):
bridge[:busy_tone] = "my_busy_tone.wav"

Example to play an audio file when call has reached the maximum allowed duration:
bridge[:disconnect_tone] = "your_account_balance_is_empty.wav"

=== Announcement file path format and options ===

All file plabyacks (:announcement_tone, :busy_tone, :ring_tone, :disconnect_tone) inside bridge parameters use this format.
<pre>"file1.wav:repeat:start_off:end_off,file2.wav:repeat:start_off:end_off,file3.wav:repeat:start_off:end_off"
</pre>
Optional parameters:
* repeat: number of times to play the file (0 and 1 have the same result)
* start_off: Start offset in milliseconds
* end_off: End offset in milliseconds

Http and other path formats are described here: [[Customer_application_framework:play_audio_files#Play_path_format|Path format]]

==== Example 1 ====
The following example will play file1.wav once, and then play file2.wav in loop:
"file1.wav,file2.wav:-1"

==== Example 2 ====
The following example will play file1.wav from start offset of 1 second to end offset of 3 seconds, then twice file2.wav from second 5 to second 10.
"file1.wav:0:1000:3000,file2.wav:2:5000:10000"

==== Example 3 ====
The following example will play file1.wav once, ending at offset of 30 seconds.
"file1.wav:0:0:30000"

=== announcement_tone ===

params[:bridge][:announcement_tone] = "announcement.wav"

Audio file played on the incoming call before any outgoing call is placed. The outgoing call occurs when the file finished playing.

==== announcement_tone options ====
===== announcement_tone_answer =====
params[:bridge][:announcement_tone_answer] = "yes"

Forces an answer of the call before playing the announcement. Default if argument not provided is "no", in which case call is only alerted with in-band media.

===== announcement_code_detect =====
This option allows that the tone detection is enabled during the announcement play.

Collected digits can be inserted into the CDR logs (radius attribute "Telcob-CollectedDigits", or text CDR variable @{CollectedDigits}).

Collected digits can also be sent back to routing script, which is called again with the same call attributes, except that the called number is replaced by the collected digits.

Code detect has multiple options, as shown in the following code:
code_detect = {
:type => :DTMF, # :DTMF or :MFR1 tone detection.
# Default is MFR1.
:prefix => "", # Prefix (digits) that is removed from collected digits.
# Default is empty.
:suffix => "", # Suffix (digits) that is removed from collected digits
# and causes routing script to be immediately called.
# Default is empty.
:suffix_removal => false, # Controls the removal of the suffix from the collected digit string that's reported to routing script.
# Default is false
:timeout => 0, # Inter-digit timeout (ms) after which collected digits are passed to the routing script.
# Use 0 for "no timeout".
# Default is 1000ms
:barge_in_interruption => true, # When enabled, playing announcement is stopped as soon as first digit is collected.
# Default is true.
:proceed_on_play_done => false, # When true: Outgoing call is made after announcement finishes playing.
# Routing script is not called again.
# When false: Outgoing call is never made.
# Digits are collected until timeout or suffix match,
# then routing script is called again.
# Default is false.
:cas_on_hook => false, # Specific for CAS-R1 calls. Makes CAS bits switch to "on-hook" when announcement finished playing
# (but the call is not "terminated" from Toolpack point of view)
# Default is false.
:cas_on_hook_delay => 0, # Duration of cas bits "on-hook" state.
# Only effective if cas_on_hook is set to true.
# Value of 0 stands for "infinite delay".
# Default is 0.
:repeat_delay => 0, # Delay between repetition of the announcement. The announcement will repeat
# itself every "repeat_delay" until a code is detected (suffix match or timetout).
# Value of 0 stands for "infinite delay" (no repeating).
# Default is 0.
}
'''Example 1''': Collect DTMF digits, and call routing script again with collected digits upon timeout or suffix match.
code_detect = { :type => :DTMF, :suffix => "#", :timeout => 5000 }
params[:bridge][:announcement_code_detect] = code_detect

'''Example 2''': Collect digits during the announcement (for CDR logs), then proceed (make outgoing call) after announcement finishes playing
code_detect = { :type => :DTMF, :timeout => 0, :barge_in_interruption => false, :proceed_on_play_done => true }
params[:bridge][:announcement_code_detect] = code_detect

==== Controlling what happens after announcement ====
The routing script can control what happens with the call after the announcement finishes playing:
* An outgoing call is made
* Incoming call is hung-up
* Do nothing (wait for the incoming call to hang-up)
===== An outgoing call is made =====
This happens when the script has returned matching routes (and did not raise RoutingException)

===== Incoming call is hung-up =====
This happens when the script returns no routes (in which case base_routing will raise RoutingException with cause :no_route).

It also happens when the script explicitly raises RoutingException.

The incoming call will be terminated with the specified cause.
For example
raise RoutingException, :temporary_failure
(See "Reason values" section in this page for list of available causes)

===== Do nothing (wait for the incoming call to hang-up) =====
If a filter raises RoutingException with code :ok, then the incoming call will not be terminated at the end of the announcement play.
Announcement digit collection will remain active if appropriate.
For example:
raise RoutingException, :ok

=== ring_tone ===
params[:bridge][:ring_tone] = "ringing.wav"

Audio file played on the incoming call while waiting for the outgoing call to be answered.

Ring tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:ring_tone] will override the profile's ring tone behavior).

==== ring_tone options ====
===== ring_tone_state =====
params[:bridge][:ring_tone_state] = :alerted

Call state from which ring tone is being played. Available values are:
* '''immediately''': Ring tone starts playing immediately on the incoming leg
* '''accepted''': Ring tone starts playing as soon as outgoing call is accepted
* '''callprogress''': Ring tone starts playing as soon as "call progress" is received on the outgoing call
* '''alerted''' (default): Ring tone starts playing only once outgoing call is alerted (but won't play if alert indicates early media from outgoing call)

This option also apply when params[:bridge][:ring_tone] is not used, because it also apply to ring tone playback configured in the Web Portal, from the incoming call's profile.

=== busy_tone ===
Toolpack 2.8 and above:
params[:bridge][:busy_tone] = "no_route.wav"

Note: Obsolete name (toolpack 2.7.153 and earlier, but still supported in recent releases):
params[:bridge][:call_progress_tone] = "no_route.wav"

Audio file played on the incoming call when outgoing call fails (never answered).

Note that announcement_tone, if used, is played before the outgoing call attempt is made, and thus before the busy_tone.

Busy tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:busy_tone] will override the profile's busy tone behavior).

Special value '''"none"''' can be used by routing script to force playing nothing (as empty string would default to profile's behavior)

==== busy_tone options ====
===== busy_tone_answer =====
params[:bridge][:busy_tone_answer] = "yes"

Forces an answer of the call before playing the busy tone. Default if argument not provided is "no", in which case call is only alerted with in-band media.

=== disconnect_tone ===
params[:bridge][:disconnect_tone] = "max_duration.wav"

Audio file played on the incoming call when call duration (:max_call_duration) is reached. Then the leg will be terminated with specified reason (:call_duration_reason).

==== disconnect_tone options ====
===== max_call_duration =====
params[:bridge][:max_call_duration] = "60000"

Maximum call duration in millisecond. This timer is started when entering answer state.

===== call_duration_reason =====
params[:bridge][:call_duration_reason] = :resource_unavailable

Drop both legs with this reason when call duration (:max_call_duration) is reached.

=== Managing audio prompts through Web Portal ===
Audio prompts can be uploaded or deleted from the TMedia unit through the Web Portal:
[[Toolpack:Configuring_Audio_Prompts_A|Managing audio prompts]]

Prompts management must be done using the Web Portal of the primary server (in systems with redundant TMedia units or redundant host servers).
The file will automatically get replicated to the secondary server.

=== Managing audio prompts manually ===
Any file on the TMedia host file system can be played. This means it's possible to manage prompts through ssh/scp.

==== The default (replicated) prompts folder ====
By default, when playing a prompt, Toolpack will look in the default prompts folder:
/lib/tb/toolpack/pkg/prompts
The root of this "prompts" directory is automatically replicated to secondary unit of redundant setups (1+1, N+1, redundant hosts). Sub-folders won't be replicated.

Any prompt play request without explicit file path will map to this folder. For example:
params[:bridge][:busy_tone] = "no_route.wav"
This will correspond to file /lib/tb/toolpack/pkg/prompts/no_route.wav

==== Relative file paths ====
Any file path that begins with "file://" is considered relative to the tbstreamserver application's working directory:
/lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/
(Where "2.8" may be replaced by the current major version of your system)

For example:
params[:bridge][:busy_tone] = "file://my_folder/no_route.wav"
This will correspond to file /lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/my_folder/no_route.wav

==== Absolute file paths ====
Absolute paths can also be provided.
For example:
params[:bridge][:busy_tone] = "file:///root/my_folder/no_route.wav"
This will correspond to file /root/my_folder/no_route.wav

== Recording call legs ==
Introduced in release 2.6.44, it's now possible to use routing scripts to ask for recording incoming and/or outgoing call legs.

See example filter script "call_recording" (created by default in Web Portal routing scripts starting with 2.6.44) for an example.

=== Recording the incoming call leg ===
To record the incoming call leg, the routing script (in a "after filter" for example) has to set the following parameter:

bridge[ :record_incoming ] = ""

=== Recording the outgoing call leg ===
To record the outgoing call leg, the routing script (in a "after filter" for example) has to set the following parameter, per route (the decision to record or not, or the file name to record to, can be set per matching route):

# Need to clone the routes in order to have the right to modify them
routes = clone_routes params[:routes]
routes.each do |route|
route[ :record_outgoing ] = ""
end
# Store modified routes back to the parameters for this outgoing call
params[:routes] = routes

=== Record the outgoing call leg within incoming leg's recorded file (mixing) ===
[...]
route[ :record_outgoing ] = "@{MixWithIncoming}"
[...]

=== Choosing file path to record to ===
The value assigned to ":record_incoming" or ":record_outgoing" is the path to record the file to.

The paths can be absolute, or relative. When relative, they are relative to the "tbstreamserver" application working directory, for example:
/lib/tb/toolpack/setup/12358/2.7/apps/tbstreamserver/

* Empty file name will default to a name that contains various information about the call:
** ''LinkId'': Id common between all legs of this call bridge
** ''LegId'': Unique Id for this leg
** ''Nap'': Current NAP name this call leg is from
** ''Direction'': "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
** ''Calling'': The calling number of this call leg
** ''Called'': The called number of this call leg
** ''Protocol'': The signaling protocol of this call leg (SS7, ISDN, CAS, SIP)
** ''Media info'': Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
* To record outgoing call leg in the same audio file as incoming call leg (mixing), use the following:
** @{MixWithIncoming}: Record outgoing legs in same file as incoming legs
* Variables can be used to insert in the recording path information that's not already available from routing scripts:
** @{CURRENT_PKG}: Version of current package
*** Example: 2.6.45
** @{DATE format}: Prints the date, where 'format' is expressed as described for the 'strftime' function
*** Example: @{DATE %Y-%m-%d} => 2013-01-28
** @{DefaultName}: Replaced by the default file name for recording, which contains:
*** LinkId: Id common between all legs of this call bridge
*** LegId: Unique Id for this leg
*** Nap: Current NAP name this call leg is from
*** Direction: "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
*** Calling: Calling number
*** Called: Called number
*** Protocol: Protocol type of this call (SS7, ISDN, CASR2, SIP)
*** Media info: Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
*** Example: "73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{DefaultPath}: Default recording folder and file name: "@{RECORD_PATH}/@{DATE %Y-%m-%d}/@{DefaultName}"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{Direction}: Direction of current leg (IN our OUT)
*** Example: IN
** @{LegId}: Current LegId (Unique Id for this leg)
*** Example: F3D67B4B
** @{LinkId}: Current LinkId (Id common between all legs of this call bridge)
*** Example: 73EBA698
** @{PKG_HOME}: Path where packages are stored.
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg
** @{PROMPT_PATH}: Default path where audio prompts are stored
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg/prompts
** @{Protocol}: Protocol of current leg
*** Example: SS7
** @{RECORD_PATH}: Default recording folder: "@{TB_SETUP_HOME}/recorded_calls/"
** @{TBX_GW_PORT}: Current "System Id" (also called "Gateway Port")
*** Example: 12358
** And all variables listed here: [[Customer_application_framework:play_audio_files#Helpful_variables_to_build_play_or_record_file_paths|Building play or record file path]]

== Controlling UUI (user-to-user information) relay ==
UUI (user-to-user information) can be present in different messages received by either call leg during a call. For example, information can be carried during the initial invite, other information can be carried when the call is alerted, answered, or terminated.

Routing scripts can control if the UUI received from one leg through the call will be forwarded to the other call leg:
*uui_forward_enabled

Routing scripts can also read and modify the UUI received with the incoming call leg, before it gets forwarded upon creation of the outgoing call leg:
*uui

=== UUI (user-to-user indication) values ===

Byte array represented as ruby String. Use ''bridge=params[:bridge]'', then ''bridge[:uui]'' to access the data.

To access the bytes in Ruby, use ruby String operator []. For example: bridge[:uui][0] will return the binary value of the first UUI byte.

Function each_byte can also be useful to iterate through all bytes of the UUI.

=== uui_forward_enabled values ===

Controls forwarding or discarding of UUI to outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
* 0/false: UUI is not forwarded between call legs
* 1/true: UUI is forwarded between call legs

The value for this parameter at input of routing script depends on the "Forward UUI" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

== Authorization ==
Starting with release 2.7, it is possible to issue RADIUS authorization requests from routing scripts. To do so, the params[:authorization] object must be filled with the required RADIUS attributes and [[#Refuse|an exception must be raised]] with reason :authorization_required.

When the authorization is completed, the routing script is called again with the result. The params[:authorization] object will be filled with the RADIUS attributes from the response. The params[:authorization][:result] field will also contain a string indicating the result of the authorization:

* ''accept'': The authorization was successful.
* ''reject'': The authorization was refused.
* ''challenge'': The authorization was challenged.
* ''timeout'': The authorization was not answered.

== Call diversion options ==
It's possible to control the call flow when a call diversion information is received in the alerting state.

Two fields are available: bridge[ :diversion ] and bridge[ :diversion_reason ]

The internal release cause TOOLPACK_DIVERT_NOT_ALLOWED is used by gateway application to terminate both legs.

bridge[ :diversion ] = :allowed
The alert message will not be analyzed and the call will be progressed. Default behavior.
bridge[ :diversion ] = :not_allowed
If the alert message indicates that the call is diverted, the call will be released no matter the In-band information to allow
early media.
bridge[ :diversion ] = :not_allowed_w_early_media
The call will be released If the alert message indicates that the call is diverted with in-band information to allow early media.
bridge[ :diversion_reason ] = "*"
If the diversion is not allowed, the gateway will drop the call for any redirecting reason.
bridge[ :diversion_reason ] = "0,1,2"
or
bridge[ :diversion_reason ] = "unknown,busy,no_reply"
If the diversion is not allowed, the redirecting reason will be analyzed and the call will only be dropped for the configured cases.

See section [[Routing_script_tutorial:Mini_Development_Guide#Redirecting_number,_Original_Called_Number_and_Diversion_Reason|Redirecting number reason values]].

== Call transfer requests ==
Toolpack allows that [[Call transfer]] requests are relayed from one leg to the other, or to process them locally (making another outgoing call to replace the call that requested the call transfer).

If the chosen [[Call transfer]] mode is to process requests locally, upon reception of a call transfer request (SIP REFER or ISDN Facility), routing script will be called once again, to select the routes for the new outgoing call (call transfer target).

=== How to route call transfer request ===
Routing of a call transfer request is done exactly like routing of a normal incoming call.
The routing script generally does not need any modification to support that.

In some cases, the routing script may want to use information related to the transfer request to perform routing, or to insert information in the outgoing call leg.
Additional information is provided to the routing script, allowing routing decisions using information from the call transfer request (SIP REFER or ISDN Facility).
See below...

=== params[ :call ] content during transfer request ===
When processing a call transfer request, the params[ :call ] hash contains the information from the inbound call (same as was passed to the routing script upon arrival of the inbound call)
call = params[ :call ] -> Information from original inbound call, with exception of call[ :called ]

One exception (convenient because it allows a unmodified routing script to process call transfer request the same way as any other routing request):
call[ :called ] -> Replaced by the called number from the call transfer request (also called "redirection number")
Complementary information:
call[ :original_called_number ] -> Contains the called number that was initially received from the incoming call, prior to call transfer request
call[ :redirecting_number ] -> Number of the call from which the call transfer request was received (generally equals to original_called_number)

These fields will also be included in the outgoing call made after routing:
* original called number and redirecting number are existing fields on SS7 and ISDN calls
* SIP "diversion" header is used for SIP calls

=== params[ :transfer ] content ===
(this if valid only for release 2.7.102 and above) 
When processing a call transfer request, information from the call transfer request message (SIP REFER, ISDN Facility) is provided in params[ :transfer ]:
transfer = params[ :transfer ]
The following field is always present:
transfer[ :original_nap ] -> Contains the NAP of the first call from which a call transfer request was received
transfer[ :redirecting_nap ] -> Contains the NAP of the call from which the current call transfer request was received
(same as :original_nap for the first call transfer, different for subsequent transfers)
Examples of other fields that may be present, when appropriate:
transfer[ :uui ] -> The UUI (user-to-user information) found in the call transfer request
transfer[ :sip_header ] -> Contains custom SIP headers from the call transfer request
transfer[ :request_uri ] -> Contains the SIP Request URI

These fields are 'read-only'. They will not be included in the outgoing call, as they represent the contents of the call transfer request, and not the outgoing call to be made.

To insert/modify attributes of the outgoing call, the parameters from params[ :call ] must be edited instead.

== Redirection ==
In release 2.8 and above, redirection contacts are obtained from the routing engine in the following format:

contacts = params[ :contacts ]
contacts = {
:index=>"3",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"", :raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127", :raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
{:called_number=>"6662", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6662@192.168.215.128", :raw_data=>"<sip:6662@192.168.215.128>", :expiration=>"3600"},
{:called_number=>"6663", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6663@192.168.215.129", :raw_data=>"<sip:6663@192.168.215.129>", :expiration=>"3600"},
{:called_number=>"6664", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6664@192.168.215.150", :raw_data=>"<sip:6664@192.168.215.150>", :expiration=>"3600"}
],
:source_indexes=>"nil,0,0,0,2"
}

* <code>params[:contacts][:list]</code> contains the contact log. Each contact within the list has the following fields:
** <code>:called_number</code> - the called number
** <code>:is_number_ported</code> - if the called number has been ported (for SIP: if the npdi parameter is present)
** <code>:ported_number</code> - the called number that was ported (for SIP: the rn parameter value, if available)
** <code>:sip_uri</code> - the SIP URI of the contact, without the contact-params section (without the expires and q contact parameters)
** <code>:raw_data</code> - the raw data representing the contact in the signaling protocol. For SIP, this is the full SIP URI (including the expires and q contact parameters).
** <code>:priority</code> - the priority of the contact [0-1000]
** <code>:expiration</code> - the expiration time in seconds of the contact
* <code>params[:contacts][:index]</code> contains the index of the contact that is currently being routed.
* <code>params[:contacts][:source_indexes]</code> contains a comma-separated list of indexes from <code>params[:contacts][:list]</code>. Each index represents the contact from which the contact in the list was obtained from.

To get more information, see:
*[[Routing_script_tutorial:SIP_Redirection_Contacts|SIP Redirection Contacts Parameters in a Call Flow]]

== Connected number ==
Insert a connected number in the answer message of the call flow.

Routing script example:
bridge = params[ :bridge ]
bridge [ :connected_number ] = "3335577"
bridge [ :connected_number_noa ] = :national_number
bridge [ :connected_number_npi ] = :private
bridge [ :connected_number_presentation ] = :allowed
bridge [ :connected_number_screening ] = :pass

== Terminating calls ==
In release 2.8, it is now possible to terminate a call through the routing scripts. The [[#Reason values|reason code]] must be specified in <code>params[:bridge][:reason]</code>. The <code>:terminate</code> hash must be created and copied into <code>params</code>:
terminate = {}
params[:terminate] = terminate
The following fields can then be set in <code>:terminate</code>:
* <code>:sip_header</code>
* <code>:contacts</code> # list of contacts as described in the [[#Redirection|redirection]] section
* <code>:isup_raw</code>
* <code>:isup_raw_variant</code>
* <code>:redirecting_number</code>
* <code>:redirecting_number_noa</code>
* <code>:redirecting_number_npi</code>
* <code>:redirecting_number_presentation</code>
* <code>:redirecting_number_reason</code>
* <code>:redirecting_number_counter</code>
* <code>:redirecting_number_indicator</code>
* <code>:original_called_number</code>
* <code>:original_called_number_noa</code>
* <code>:original_called_number_npi</code>
* <code>:original_called_number_presentation</code>
* <code>:original_called_number_reason</code>
* <code>:original_called_number_counter</code>

== Reason values ==

Check here for Termination Reason Cause codes: 

[[Termination_cause_codes|Termination Reason Cause codes]]
 

Example to refuse an incoming call leg.
raise RoutingException, :no_route

Reason cause strings available inside routing scripts:

List of Q.850 reason causes:
:unallocated_number
:no_route_to_network
:no_route_to_destination
:send_special_tone
:misdialled_trunk_prefix
:channel_unacceptable
:call_awarded_in_established_channel
:preemption
:reattempt
:qor_ported_number
:normal_call_clearing
:user_busy
:no_user_responding
:no_answer_from_user
:subscriber_absent
:call_rejected
:number_changed
:redirection
:exchange_routing_error
:non_selected_user_clearing
:destination_out_of_order
:address_incomplete
:facility_rejected
:response_to_status_enquiry
:normal_unspecified
:no_circuit_available
:network_out_of_order
:frame_mode_out_of_service
:frame_mode_connection_operational
:temporary_failure
:switching_equipment_congestion
:access_information_discarded
:requested_circuit_not_available
:precedence_call_blocked
:resource_unavailable
:quality_of_service_not_available
:requested_facility_not_subscribed
:outgoing_calls_barred
:outgoing_calls_barred_within_cug
:incoming_calls_barred
:incoming_calls_barred_within_cug
:bearer_cap_not_authorized
:bearer_cap_not_available
:inconsistency_access_info
:service_not_available
:bearer_cap_not_implemented
:channel_type_not_implemented
:requested_facility_not_implemented
:only_restricted_digital_info
:service_not_implemented
:invalid_call_reference
:channel_does_not_exist
:call_identity_does_not_exist
:call_identity_in_use
:no_call_suspended
:call_has_been_cleared
:user_not_member_of_cug
:incompatible_destination
:non_existant_cug
:invalid_transit_network
:invalid_message_unspecified
:mandatory_ie_missing
:message_type_non_existent
:message_not_compatible_with_call_state
:ie_non_existent
:invalid_ie_content
:msg_not_compatible_with_call_state
:recovery_on_timer_expiry
:parameter_non_existent_passed_on
:message_with_non_recognized_parameters_discarded
:protocol_error
:interworking_unspecified

List of toolpack reason causes:

:toolpack_normal or :normal
:toolpack_resource_error or :resource_error
:toolpack_timeout or :timeout
:toolpack_no_route or :no_route
:toolpack_call_collision or :call_collision
:toolpack_sync_drop or :sync_drop
:toolpack_signaling_error or :signaling_error
:toolpack_locally_rejected or :locally_rejected
:toolpack_interface_not_available or :interface_not_available
:toolpack_reset_in_progress or :reset_in_progress
:toolpack_adapter_reject or :adapter_reject
:toolpack_missing_or_invalid_ie or :missing_or_invalid_ie
:toolpack_incoming_only or :incoming_only
:toolpack_system_configuration_changed or :system_configuration_changed
:toolpack_resource_no_more_available or :resource_no_more_available
:toolpack_incompatible_media or :incompatible_media
:toolpack_resource_allocation_failed or :resource_allocation_failed
:toolpack_data_path_not_available or :data_path_not_available
:toolpack_local_congestion or :local_congestion
:toolpack_authorization_required or :authorization_required
:toolpack_call_divert_is_not_allowed or :call_divert_is_not_allowed

List of SIP reason causes: 
Reason causes starting with a digit must use the following syntax (can't use : as prefix).

'300_multiple_choices'
'301_moved_permanently'
'302_moved_temporarily'
'305_use_proxy'
'380_alternative_service'
'400_bad_request'
'401_unauthorized'
'402_payment_required'
'403_forbidden'
'404_not_found'
'405_method_not_allowed'
'406_not_acceptable'
'407_proxy_authentication_required'
'408_request_timeout'
'409_conflict'
'410_gone'
'413_request_entity_too_large'
'414_request_URI_too_long'
'415_unsupported_media'
'416_unsupported_URI_scheme'
'420_bad_extension'
'421_extension_required'
'422_session_timer_too_small'
'423_interval_too_brief'
'429_referrer_identity_error'
'480_temporary_unavailable'
'481_call_or_transaction_does_not_exist'
'482_loop_detected'
'483_too_many_hops'
'484_address_incomplete'
'485_ambiguous'
'486_busy_here'
'487_request_terminated'
'488_not_acceptable_here'
'489_bad_event'
'491_retry_after'
'500_server_internal_error'
'501_not_implemented'
'502_bad_gateway'
'503_service_unavailable'
'504_server_timeout'
'505_version_unsupported'
'513_message_too_large'
'600_busy_everywhere'
'603_decline'
'604_not_exist_anywhere'
'606_not_acceptable'

== Nap status ==

All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.

'''Notice:''' These values may change between major release.

Routing script call attribute name Description
--------------------------------------------------------------------------------------------
"name" NAP name.
"signaling_type" Signaling type (SS7, ISDN, CASR2, SIP)
"profile" Profile name.
"sip_destination_ip" Destination IP address.
"sip_destination_port" Destination IP port.
"sip_transport_type" SIP transport type (:udp, :tcp, or :tls) (Toolpack 3.1 and more)
"inst_incoming_call_cnt" Instantaneous Count of incoming calls.
"inst_outgoing_call_cnt" Instantaneous Count of outgoing calls.
"available_cnt" Number of available circuits or channels.
"unavailable_cnt" Number of unavailable circuits or channels.
"availability_percent" Percentage of available circuits or channels.
"usage_percent" Percentage of used circuits or channels.
"unused_shared_percent" Percentage of used circuits or channels of this NAP available to make new calls with (taking into account shared with other NAPs)
"total_incoming_call_cnt" Total Count of incoming calls.
"global_asr_percent" Global calculated ASR percentage.
"total_outgoing_call_cnt" Total Count of outgoing calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_outgoing_call_cnt" Last 24 hours outgoing calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_outgoing_call_cnt" Current hour outgoing calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_outgoing_call_cnt" Last hour outgoing calls.
"poll_remote_proxy" Remote proxy polling enabled
"is_available" Remote proxy actually available or not
"time_since_polling" Time since the last availibility polling
"time_available_seconds" Number of seconds since the NAP is available
"time_unavailable_seconds" Number of seconds since the NAP is unavailable
"register_to_proxy" Register to proxy enabled
"registered" Actually registered or not
"time_since_refresh" Time since the last refresh
"time_registered_seconds" Number of seconds since the NAP is registered
"time_not_registered_seconds" Number of seconds since the NAP is not registered
"asr_stats_incoming_struct" Detailed Answer-Seizure Rate incoming statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"asr_stats_outgoing_struct" Detailed Answer-Seizure Rate outgoing statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"mos_struct" Detailed Mean Opinion Score statistics.
{
"last_24h_ingress" Last 24 hours calculated MOS for incoming RTP packets.
"last_24h_egress" Last 24 hours calculated MOS for outgoing RTP packets.
"current_hour_ingress" Current hour calculated MOS for incoming RTP packets.
"current_hour_egress" Current hour calculated MOS for outgoing RTP packets.
"last_hour_ingress" Last hour calculated MOS for incoming RTP packets.
"last_hour_egress" Last hour calculated MOS for outgoing RTP packets.
}
"network_quality_struct" Detailed network quality statistics.
{
"last_24h_ingress" Last 24 hours network quality percentage for incoming RTP packets.
"last_24h_egress" Last 24 hours network quality percentage for outgoing RTP packets.
"current_hour_ingress" Current hour network quality percentage for incoming RTP packets.
"current_hour_egress" Current hour network quality percentage for outgoing RTP packets.
"last_hour_ingress" Last hour network quality percentage for incoming RTP packets.
"last_hour_egress" Last hour network quality percentage for outgoing RTP packets.
}

 If the nap status is part of a substructure, the substructure will be a hash containing all subfield elements.

Example to access the signaling type and the number of incoming call count for the NAP of the current call:

incoming_nap = params[:naps][ params[:call][ :nap ].to_sym]
log_trace 4,"Incoming NAP parameters=" + incoming_nap.inspect
log_trace 4,"Incoming NAP signaling type=" + incoming_nap[:signaling_type].inspect
log_trace 4,"Incoming NAP call cnt=" + incoming_nap[:asr_stats_incoming_struct][:total_call_cnt].inspect

 It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.

== Telephony Services ==
In release 2.10 and the above, telephony services (CNAM Request) can be manage from the routing engine in the following format:

params[:telephony_services].each do |service| -> Array of telephony services
service[:name] -> Customer telephony service name
service[:type] -> For now only "CNAM Request"
service[:enabled] -> Indicate if the service is enabled (true) or not (false)
(Only the telephony service define in the profile associated to the NAP is enabled)
(The others telephony services define in others profiles are disabled)
(If we are in the case where we return in the routing script with a response, it is important to set :enabled to false in order to avoid repeating the same query)
serviceParams = service[:params]
serviceParams[:return_to_script] -> Indicates to Gateway if we must return to the routing script after receiving the CNAM response
(It is important to set back to false this field to avoid an infinite loop)
serviceQuery = service[:query]
serviceQuery[:phone] -> 10 digits of calling number from the incoming call to send to the CNAM server
serviceQuery[:timeout] -> Timeout in millisecond to wait a CNAM response from CNAM server
(Default value from profile configuration)
serviceResponse = service[:response]
serviceResponse[:success] -> Indicates if we received a good CNAM response from the CNAM Server (Only present if :return_to_script is set to true)
serviceResponse[:caller_name] -> The caller name received in the CNAM response from the CNAM Server (Only present if :return_to_script is set to true)

== Custom user context ==
The routing script may '''save per-call information within the call context''', that will be available if routing is called again later during the call flow.

Cases where routing is called multiple time for the same call are:
- Call transfer requests
- SIP redirect requests
- Radius Authorization result
- Announcement server with digit collection

The routing script can save a recursive hash of attributes here:
params[:user_context]

For example
params[:user_context] = { "SomeKey" => "Some value I want to retrieve upon next routing for this call", "OtherVal" => { "subkey" => "subval" } }

Upon first call to routing script, params[:user_context] will be nil.
Upon subsequent calls to routing script, it will contain whatever the script had stored upon previous call (or nil if it was not set)

Note: This feature is available starting from release 2.9.85, 2.10.31 and 3.0.15 (in respective branches 2.9, 2.10 or 3.0)

== Routing Script Tests ==
The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
This is available in the Routing Scripts section of the Web portal.

=== Test parameters ===
==== @call_params ====

That variable should contain a hash of call parameters that will be passed to the routing script. This is equivalent to the incoming call parameters.

 

==== @nap_list ====

A list of the hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.

'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.

 

==== @params ====

A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.

@params = {
:bridge => {:announcement_tone, "announcement.wav"},
:contacts => {
:index=>"1",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",
:raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",
:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
],
:source_indexes=>"nil,0"
}
}

 

----

 Back to [[Routing script tutorial|Routing Script Tutorial]].

Routing script tutorial:Mini Development Guide

2019-09-09T15:17:07Z

CThompson: Undo revision 27820 by CThompson (talk)

== Call object ==

=== Get ===

This function is used to get the call parameters. The possible parameters are described in the section "Call parameters"

called_number = caf_call.get :called

=== List_params ===

This function is used to retrieve the list of supported call parameters. For example to extract all the possible call parameters from the the call object and put it in hash.

caf_call.list_params.each {|param| call[param] = caf_call.get param }

=== Accept ===

This function is used to accept a call. It actually creates one outgoing route that the gateway application will use to bridge the incoming call leg. If more than one outgoing route is "accepted", the gateway will try them one by one in the same order that they were accepted. If an outgoing call leg fails (according to 'route retry' parameters), the next route in line will be used.

This method takes 2 arguments, the call parameters (hash) and the route parameters (hash). Note that calling this method does NOT stop the flow of the script.

Apply route remapping rules

caf_call.accept out_call, route

=== Refuse ===

This function is used to set the reason code for the incoming call leg refusal. However, this function does NOT stop the flow of the script.

caf_call.refuse :reason => :temporary_failure

To immediately refuse the incoming call leg and stop processing the script, the script must raise an exception. Exiting the script by raising the exception overwrites any reason cause previously stored using refuse().

raise RoutingException, :no_route

The supported refusal cause values for both refuse() and raise() are described in the section "[[Routing_script_tutorial:Mini_Development_Guide#Reason_values|Reason values]]".

=== Script parameters protocol mapping ===

The following call parameters are available in the call object. For example:

called_number = call[:called]

For information on how to use and remap call parameters, see [[Toolpack:_How_to_Use_RegEx_in_Remapped_Called_and_Calling_Number_Mask | How to use regex in Remapped Called and Calling Number Mask]]

{| cellspacing="1" cellpadding="1" border="1" style="width: 921px; height: 805px;"
|-
! scope="col" | '''Script parameter name'''
! scope="col" | '''ISDN '''
! scope="col" | '''R2 CAS''' 
! scope="col" | '''SS7 '''
! scope="col" | '''SIP '''
! scope="col" | '''Comment '''
! scope="col" | '''Toolpack version '''
|-
| leg_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Leg ID 
| 
|-
| session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Session ID 
| 
|-
| original_session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Original Session ID (before call transfer or redirections) 
| 
|-
| calling 
| Q931: 'Calling party number' IE - Number digits 
| ANI (Group B) 
| Q763: 'Calling party number' IE - address signals (*) 
| SIP:From - user-info 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead. 
| 
|-
| calling_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:From - host (domain or IP) 
| For example : The 'telcobridges.com' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| calling_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:From - port 
| For example : The '6060' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| calling_noa 
| Q931: 'Calling party number' IE - Type of number 
| N/A 
| Q763: 'Calling party number' IE - nature of address indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_npi 
| Q931: 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Calling party number' IE - numbering plan indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_display 
| Q931: 'Display' IE - Display information 
Q931: 'Facility CNAM' IE when presentation is allowed for DMS/NI2 variants 
| N/A 
| Q763
ITU97: 'Display information' IE - display information
ANSI95: 'Generic name' IE - display information
| SIP:From - display-name 
| 
| 
|-
| calling_display_type 
| Q931: 'Display' IE - Display information (present and/or first byte) 
| N/A 
| Q763: 'Display information' IE - present or not 
| N/A 
| 
| 
|-
| calling_presentation 
| Q931: 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: 'Calling party number' IE - address presentation restricted indicator 
|
SIP:From - display-name (displays 'anonymous' or not)

SIP:Remote-party-id - privacy 

| 
| 
|-
| calling_screening 
| Q931: 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: 'Calling party number' IE - screening 
| SIP:Remote-party-id - screen 
| 
| 
|-
| calling_category 
| N/A 
| Call party category (Group A) 
| Q763: 'Calling party's category' IE - calling party's category 
|
SIP:From - cpc

SIP:P-asserted-identity - cpc 

| 
| 
|-
| calling_subscriber
(Generic Number / NDS) 
| Q931: 2nd 'Calling party number' IE - Number digits 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - Number digits 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| Requires option 'support 2 calling number IE' in the profile. This variable has priority over 'private_address' in the outgoing direction. 
| 
|-
| calling_subscriber_noa 
| Q931: 2nd 'Calling party number' IE - Type of number 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - nature of address indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_npi 
| Q931: 2nd 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - numbering plan indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
 
| 
|-
| calling_subscriber_presentation 
| Q931: 2nd 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - presentation restricted indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_screening 
| Q931: 2nd 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - screening 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| private_display 
| Q931: 'Facility CNAM' IE when presentation is restricted for DMS/NI2 variants 
| N/A 
| N/A 
|
SIP:P-asserted-identity - display-name 

SIP:Remote-party-id - display-name 

| 
| 
|-
| private_display_type 
| N/A 
| N/A 
| N/A 
| N/A 
| Indicate presence or not of the private calling information 
| 
|-
| private_address 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 

| For example : The 'fluffy' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - host (domain or IP)

SIP:Remote-party-id - host (domain or IP) 

| For example : The 'telcobridges.com' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - port

SIP:Remote-party-id - port 

| For example : The '6060' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| preferred_id_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default P-Preferred-Identity header forwarding behavior from incoming to outgoing leg 
| 
|-
| preferred_id 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - userinfo

| For example : The 'fluffy' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_display_name 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - display name

| For example : The 'Cullen Jennings' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - host (domain or IP)

| For example : The 'telcobridges.com' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - port

| For example : The '6060' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called 
| Q931: 'Called party number' IE - Number digits 
| DNIS (Group A) 
| Q763: 'Called party number' IE - address signals 
| SIP:To - user-info and host 
| 
| 
|-
| called_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:To - host 
| For example : The 'telcobridges.com' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| called_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:To - port number 
| For example : The '6060' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called_noa 
| Q931: 'Called party number' IE - Type of number 
| N/A 
| Q763: 'Called party number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| called_npi 
| Q931: 'Called party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Called party number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| charge_number 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - address signals 
| N/A 
| 
| 
|-
| charge_number_noa 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| charge_number_npi 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default redirecting number and original called number forwarding behavior from incoming to outgoing leg 
| 
|-
| redirecting_number 
| Q931: 'Redirecting number' 1st IE - Number digits 
| N/A 
| Q763: 'Redirecting number' IE - address signals 
| SIP:Diversion (2nd header) - display-name 
| 
| 
|-
| redirecting_number_noa 
| Q931: 'Redirecting number' 1st IE - Type of number 
| N/A 
| Q763: 'Redirecting number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| redirecting_number_npi 
| Q931: 'Redirecting number' 1st IE - Numbering plan identification 
| N/A 
| Q763: 'Redirecting number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_presentation 
| Q931: 'Redirecting number' 1st IE - Presentation indicator 
| N/A 
| Q763: 'Redirecting number' IE - address presentation restricted indicator 
| SIP:Diversion (2nd header) - diversion-privacy 
| 
| 
|-
| redirecting_number_indicator 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirecting indicator 
| N/A 
| 
| 
|-
| redirecting_number_reason 
| Q931: 'Redirecting number' 1st IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - redirecting reason 
| SIP:Diversion (2nd header) - diversion-reason 
| 
| 
|-
| redirecting_number_counter 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirection counter 
| SIP:Diversion (2nd header) - diversion-counter 
| 
| 
|-
| original_called_number
(OCN) 
| Q931: 'Redirecting number' 2nd IE - Number digits 
| N/A 
| Q763: 'Redirection number' IE - address signals 
| SIP:Diversion  (1st header) - display-name 
| 
| 
|-
| original_called_number_noa 
| Q931: 'Redirecting number' 2nd IE - Type of number 
| N/A 
| Q763: 'Redirection number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| original_called_number_npi 
| Q931: 'Redirecting number' 2nd IE - Numbering plan identification 
| N/A 
| Q763: 'Redirection number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| original_called_number_presentation 
| Q931: 'Redirecting number' 2nd IE - Presentation indicator 
| N/A 
| Q763: 'Redirection number' IE - address presentation restricted indicator 
| SIP:Diversion (1st header) - diversion-privacy 
| 
| 
|-
| original_called_number_reason 
| Q931: 'Redirecting number' 2nd IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - original redirection reason 
| SIP:Diversion (1st header) - diversion-reason 
| 
| 
|-
| original_called_number_counter 
| N/A 
| N/A 
| N/A 
| SIP:Diversion (1st header) - diversion-counter 
| 
| 
|-
| ported_number_npdi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - with qualifier=Ported number is present 
| SIP:RequestURI - npdi=yes is present 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number 
| N/A 
| N/A 
| Q763: 'Generic number' IE - address signals with qualifier=Ported number 
| SIP:RequestURI - to user part when rn is present 
| rn is stored in the called number 
| 
|-
| ported_number_noa 
| N/A 
| N/A 
| Q763: 'Generic number' IE - nature of address indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number_npi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - numbering plan indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| oli
(Originating line information) 
| 5ESS Codeset 6 OLI - Value 
| N/A 
| ANSI: 'Originating line information' IE - OLI 
|
SIP:From - oli

SIP:P-asserted-identity - oli 

| 
| 
|-
| request_uri 
| N/A 
| N/A 
| N/A 
| Complete Request URI string 
| 
| 
|-
| request_uri_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default URI forwarding behavior from incoming to outgoing leg 
| 
|-
| sip_header 
| N/A 
| N/A 
| N/A 
| Any header 
| Requires option 'Forward custom headers' in Profiles->SIP 
| 2.7.63 
|-
| nap
(Network Access Point) 
| N/A 
| N/A 
| N/A 
| N/A 
| Incoming leg NAP name (read-only) 
| 
|-
| type_of_network_identification 
| Q931: 'Transit network selection' IE - Type of network identification 
| N/A 
| Q763: 'Transit network selection' IE - Type of network identification 
| N/A 
| 
| 2.7 
|-
| network_identification 
| Q931: 'Transit network selection' IE - Network identification 
| N/A 
| Q763: 'Transit network selection' IE - Network identification 
| SIP: Request-Line - cic 
| 
| 2.7 
|-
| network_identification_plan 
| Q931: 'Transit network selection' IE - Network identification plan 
| N/A 
| Q763: 'Transit network selection' IE - Network identification plan 
| N/A 
| 
| 2.7 
|-
| location_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default location number forwarding behavior from incoming to outgoing leg 
| 2.7 
|-
| location_number 
| N/A 
| N/A 
| Q763: 'Location number' IE - address signals 
| N/A 
| 
| 2.7 
|-
| location_number_noa 
| N/A 
| N/A 
| Q763: 'Location number' IE - nature of address indicator 
| N/A 
| 
| 2.7 
|-
| location_number_npi 
| N/A 
| N/A 
| Q763: 'Location number' IE - numbering plan indicator 
| N/A 
| 
| 2.7 
|-
| location_number_presentation 
| N/A 
| N/A 
| Q763: 'Location number' IE - presentation restricted indicator 
| N/A 
| 
| 2.7 
|-
| location_number_screening 
| N/A 
| N/A 
| Q763: 'Location number' IE - screening 
| N/A 
| 
| 2.7 
|-
| mlpp_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| A script needs to set this to true if it wants to overwrite MLPP information in the outgoing leg. Otherwise, profile relay 'outgoing mode' applies automatically. 
| 2.7 
|-
| mlpp_look_for_busy 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - look ahead for busy 
| N/A 
| 
| 2.7 
|-
| mlpp_precedence_level 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - precedence level 
| SIP:Resource-Priority - q735 
| 
| 2.7 
|-
| mlpp_network_identity 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - network identity 
| N/A 
| 
| 2.7 
|-
| mlpp_service_domain 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - MLPP service domain 
| N/A 
| 
| 2.7 
|-
| isub_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default ISUB forwarding behavior from incoming to outgoing leg 
| 3.0.138 
|-
| called_isub 
| Q931: 'Called party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub parameter 
| 
| 2.7 
|-
| called_isub_type 
| Q931: 'Called party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub-encoding parameter 
| 
| 2.7 
|-
| calling_isub 
| Q931: 'Calling party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub 
| 
| 2.7 
|-
| calling_isub_type 
| Q931: 'Callinf party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub-encoding 
| 
| 2.7 
|-
| ss7_fci_default 
| N/A 
| N/A 
| Default forward call indicator (FCI) value. 
| N/A 
| Toolpack will overwrite FCI bits A, D, F, I and M with appropriate values according to call conditions 
| 2.7 
|-
| ss7_fci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_fci_default that must be forced. 
| N/A 
| Bits from ss7_fci_default which corresponding bit in ss7_fci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| ss7_bci_default 
| N/A 
| N/A 
| Default backward call indicator (BCI) value. 
| N/A 
| Toolpack will overwrite BCI bits AB, I, K, M and N with appropriate values according to call conditions 
| 2.7 
|-
| ss7_bci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_bci_default that must be forced. 
| N/A 
| Bits from ss7_bci_default which corresponding bit in ss7_bci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| tdm_ls_name_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable line service and timeslot selection to create the outgoing leg. tdm_ls_name and tdm_timeslot_nb must be defined along with tdm_ls_name_forward_enabled 
| 3.0 
|-
| tdm_ls_name
(Line Service or T1/E1 trunk) 
| Incoming leg line service name 
| Incoming leg line service name 
| Incoming leg line service name 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this line service name to create outgoing leg 
| 2.7 
|-
| tdm_timeslot_nb 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this timeslot number to create outgoing leg 
| 2.7 
|-
| rtp_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP port 
| (read-only) 
| 2.7 
|-
| rtp_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP port 
| (read-only) 
| 2.7 
|-
| ss7_cot_enabled 
| N/A 
| N/A 
| Requests SS7 in-call continuity test for this outgoing SS7 call 
| N/A 
| Toolpack will request a continuity test on the timeslot before making the outgoing call. If COT fails, the call will be dropped (then another route may be attempted) 
| 2.8 
|-
| reverse_charging_indication 
| Incoming leg Reverse charging indication IE present 
| N/A 
| N/A 
| N/A 
| If set in routing script, will add Reverse charging indication IE in outgoing leg (also use reverse_charging_indication_forward_enabled) 
| 2.8.12 
|-
| reverse_charging_indication_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable forwarding of reverse charging indication from incoming to outgoing leg 
| 2.8.12 
|-
| sip_call_id 
| N/A 
| N/A 
| N/A 
| Incoming leg SIP Call-Id 
| (read-only) 
| 2.9.112 / 3.0.131 
|-
| sip_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP port 
| (read-only) 
| 2.8.13 
|-
| sip_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP port 
| (read-only) 
| 2.8.13 
|}

 

=== Noa values ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unknown_number (0x2)</tt>
*<tt>international_number (0x4)</tt>
*<tt>national_number (0x3)</tt>
*<tt>subscriber_number (0x1)</tt>
*<tt>network_specific (0x5)</tt>
*<tt>network_routing_national_format (0x7)</tt>
*<tt>network_routing_international_format (0x8)</tt>
*<tt>abbreviated_number (0x6)</tt>
*<tt>subscriber_number_operator_requested (0x71)</tt>
*<tt>national_number_operator_requested (0x72)</tt>
*<tt>international_number_operator_requested (0x73)</tt>
*<tt>no_number_present_operator_requested (0x74)</tt>
*<tt>no_number_present_cut_through_call_to_carrier (0x75)</tt>
*<tt>test_line_test_code (0x77)</tt>
*<tt>non_unique_subscriber_number (0x71)</tt>
*<tt>non_unique_national_number (0x73)</tt>
*<tt>non_unique_international_number (0x74)</tt>
*<tt>call_950_numbe (0x76)</tt>
*<tt>special_number (0x73)</tt>
*<tt>national_number_with_transit_network_selection (0x74)</tt>
*<tt>international_number_with_transit_network_selection (0x75)</tt>

Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:

*<tt>call_params[:called_noa] = 0x70</tt>

or

*<tt>call_params[:called_noa] = 112</tt>

=== Npi values ===

*<tt>unknown_number</tt>
*<tt>isdn</tt>
*<tt>telephony</tt>
*<tt>private</tt>
*<tt>data</tt>
*<tt>telex</tt>
*<tt>national</tt>

=== Calling Display Type values ===

*<tt>unspecified</tt> => Type is unspecified.
*<tt>calling_party_name</tt> => Type is 0xB1.

Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:

*<tt>call_params[:calling_display_type] = 0xB1</tt>

or

*<tt>call_params[:calling_display_type] = 177</tt>

=== Calling Display value ===

*<tt>call_params[:calling_display] = "Roger Fluffy"</tt>

=== Presentation values for Calling number, Calling Subscriber (Generic Number), Redirecting Number, Original Called Number (OCN) and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>not_available (0x2)</tt>
*<tt>allowed (0x0)</tt>
*<tt>restricted (0x1)</tt>
*<tt>addr_restricted</tt>
*<tt>name_restricted</tt>

=== Calling Party Category ===
The text below represents the value normally used by routing script. 
In case it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 

Mapping from routing script to SS7/CAS R2/SIP
{| cellspacing="1" cellpadding="1" border="1"
|-
! scope="col" | '''Routing Script string '''
! scope="col" | '''SS7 raw value '''
! scope="col" | '''R2 CAS scripts''' 
! scope="col" | '''Default Rx CAS''' 
! scope="col" | '''default Tx CAS''' 
! scope="col" | '''SIP "cpc=" '''
|-
| subscriber 
| 0xa 
| CATEGORY_SUBSCRIBER 
| 1 and 7 
| 7 
| ordinary 
|-
| subscriber_with_priority 
| 0xb 
| CATEGORY_SUBSCRIBER_WITH_PRIORITY 
| 2 and 9 
| 2 
| priority 
|-
| operator_french 
| 0x1 
| CATEGORY_OPERATOR_FRENCH 
| 5 
| 5 
| operator 
|-
| operator_english 
| 0x2 
| CATEGORY_OPERATOR_ENGLISH (5) 
| 5 
| 5 
| operator 
|-
| operator_german 
| 0x3 
| CATEGORY_OPERATOR_GERMAN (5) 
| 5 
| 5 
| operator 
|-
| operator_russian 
| 0x4 
| CATEGORY_OPERATOR_RUSSIAN (5) 
| 5 
| 5 
| operator 
|-
| operator_spanish 
| 0x5 
| CATEGORY_OPERATOR_SPANISH (5) 
| 5 
| 5 
| operator 
|-
| data 
| 0xc 
| CATEGORY_DATA 
| 6 and 8 
| 6 
| datacall 
|-
| test 
| 0xd 
| CATEGORY_TEST 
| 3 
| 3 
| test 
|-
| payphone 
| 0xf 
| CATEGORY_PAYPHONE 
| none 
| 7 
| payphone 
|-
| unknown 
| 0x0 
| CATEGORY_UNKNOWN 
| 4, 11 to 15 
| 7 
| unknown 
|-
| unspecified 
| 0xa 
| invalid 
| none 
| none 
| invalid 
|}
[[CAS_R2_scripting#Category_meanings|Link to calling party categories used in CAS R2 scripts]]

=== Screening values for Calling number, Calling Subscriber (Generic Number), and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>no (0x0)</tt>
*<tt>pass (0x1)</tt>
*<tt>fail (0x2)</tt>
*<tt>network_provided (0x3)</tt>

=== Redirecting indicator values ===

SS7:

*<tt>no_redirection</tt>
*<tt>call_rerouted</tt>
*<tt>call_rerouted_all_restricted</tt>
*<tt>call_diverted</tt>
*<tt>call_diverted_all_restricted</tt>
*<tt>call_rerouted_restricted</tt>
*<tt>call_diverted_restricted</tt>
*<tt>spare</tt>

=== Redirecting number, Original Called Number and Diversion Reason ===

ISDN:

*<tt>unknown</tt>
*<tt>busy</tt>
*<tt>no_reply</tt>
*<tt>deflection</tt>
*<tt>dte_out_of_order</tt>
*<tt>forwarding_by_called_dte</tt>
*<tt>unconditional</tt>

SS7:

*<tt>unknown</tt>
*<tt>busy (SIP: user-busy)</tt>
*<tt>no_reply (SIP: no-answer)</tt>
*<tt>unconditional</tt>
*<tt>deflection</tt>
*<tt>deflection_immediate</tt>
*<tt>mobile_not_reachable</tt>

=== OLI (originating line information) values ===

The OLI parameter is a string that represents an integer value from 0 to 255.

=== Information Transfer Capability values ===

information_transfer_capability:

*<tt>digital</tt>
*<tt>restricted_digital</tt>
*<tt>digital_with_tones</tt>
*<tt>speech</tt>
*<tt>3_1_khz_audio</tt>
*<tt>video</tt>

=== redirecting_number_forward_enabled values ===

Controls forwarding or discarding of redirecting number (SIP: diversion header) to the outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
*0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg
*1/true: Redirecting number (and original called number) is forwarded to outgoing call leg

The value for this parameter at the input of the routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

Note: To "insert" a new redirecting number value on the outgoing leg, redirecting_number_forward_enabled must also be set to true.

=== request_uri ===

Enables access to the Request-Line URI. 

For example, if the Request-Line is:
<pre>Request-Line: INVITE sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0</pre>
Then the retrieved request_uri will be "sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0". 

In the routing scripts, to retrieve only the called number, this script can be used: 
<pre> if call_params[:request_uri] && call_params[:request_uri] =~ /sip:(.*)@.*/
call_params[:called] = $1
end
</pre>
==== request_uri_forward_enabled ====

This call parameter controls forwarding or discarding of request uri to outgoing call leg.The request uri is the information in the "Request-Line:" of the SIP INVITE message. 

Values for this parameter are "0", "1", "false" or "true. 

* 0/false: Request uri is not forwarded to outgoing call leg 

* 1/true: Request uri is forwarded to outgoing call leg 

The default value for this parameters is false. 

==== sip_scheme ====
(Available in Toolpack 3.1+)
This call parameters indicates the scheme (generally "sip" or "sips") of the incoming call.

This also allows to control the scheme used for the outgoing call (regardless if request_uri_forward_enabled is used or not)

Note: sips scheme must only be used on TLS NAPs (will cause call routing failure if NAP has only UDP or TCP transport types).

=== sip_header values ===
Contains custom sip headers from the inbound call leg. Any custom sip header can be added to an outgoing call leg: 

'''Note:'''

The SIP header is in string format.

'''string format:'''
<pre>call[ :sip_header ] = "P-my-custom-header:value1 \nP-my-custom-header2:value2 \nP-my-custom-header3:value3"
</pre>
(Note: \n above are actual newline characters, not '\' followed by 'n')

* PCAP sample: [[File:TB_Custom_SIP_Headers.pcap]]

List of sip headers that will not appear in call[:sip_header] since they are already processed by the SIP stack:
<pre>
Accept Error-Info Remote-Party-ID
Accept-Contact Event Replaces
Accept-Encoding Expires Reply-To
Accept-Language From Request-Disposition
Alert-Info In-Reply-To Subject
Allow Max-Forwards Subscription-State
Allow-Events MIME-version Supported
Also Min-Expires Timestamp
Anonymity Min-SE To
Authorization Organization Unsupported
Authentication-Info Path User-Agent
Call-ID Priority Via
Call-Info Privacy Warning
Contact Proxy-Authenticate WWW-Authenticate
Content-Disposition Proxy-Authorization Require
Content-Encoding Proxy-Require Response-Key
Content-Language P-Media-Authorization Retry-After
Content-Length P-Preferred-Identity RPID-Privacy
Content-Type P-Asserted-Identity Route
CSeq RAck RSeq
RAck Reason Security-Client
Reason Record-Route Security-Server
Date Refer-To Security-Verify
Diversion Referred-By Server
Encryption Reject-Contact Service-Route
Session-Expires
</pre>

=== sip header parameters ===
The routing script can read (and modify) some SIP header parameters (user parameters, URI parameters or header parameters) from some SIP headers (To, From, P-Asserted-Identity, Remote-Party-ID, Contact).

==== Available parameters ====
* '''call[ :calling_parameters ]''' (SIP "From" header)
* '''call[ :called_parameters ]''' (SIP "To" header)
* '''call[ :private_address_parameters ]''' (SIP "P-Asserted-Identity" or "Remote-Party-ID" header)
* '''call[ :preferred_id_parameters ]''' (SIP "P-Preferred-Identity" header)
* '''call[ :contact_parameters ]''' (SIP "Contact" header)

These parameters (if present) contain a hash with 3 keys: user_param, uri_param and header_param.
Each of this key points to a string that contains all the parameters found in the corresponding SIP header.
* '''User parameters''' (parameters between the user name/number and the host). Example <sip:alice;'''param=value'''@somewhere.com>
* '''URI parameters''' (parameters at the end of the URI). Example <sip:alice@somewhere.com;'''param=value'''>
* '''Header parameters''' (outside the URI). Example <sip:alice@somewhere.com>;'''param=value'''
Example to print all parameters of SIP "To" header:
call[ :called_parameters ].inspect -> '{ :user_param => "name1=value1;name2=value2", :uri_param => "name=value", :header_param => "name=value;example_param_without_value" }'
Example to modify (replace) the URI parameters of SIP "To" header:
call[ :called_parameters ][ :uri_param ] = "user=phone"

==== Exceptions ====
'''Note:''' Some parameters are reported as their own call attribute (oli, isub, cpc, transport) so they have the same representation for all protocols (SS7, IDSN, SIP). They won't appear present in the generic SIP header parameters structures above.

==== Forwarding from inbound to outbound call ====

==== Legacy behavior ====
(For base_routing version 1.32 or older)
By default, the parameters are not forwarded in a SIP to SIP call flow. The parameters '''will be forwarded''' when:
* accessed (read) from either the inbound or outbound call parameters
* written in either the inbound or outbound call parameters

==== Current behavior ====
(For Toolpack 3.0.118+, with base_routing version 1.33+)
SIP headers host and parameters are forwarded by default.

A route attribute "forward_sip_domain" (along with filter script "forward_sip_domain.rb") will control, per route, if SIP headers host+parameters must be forwarded.

==== Example usage ====
Example to print the user parameters:
<pre>
if call[:calling_parameters]
puts "user parameters = #{call[:calling_parameters][:user_param].inspect}"
end
</pre>

Example SIP "From" header:
From:<sip:123456782;test1=val1;test2=val2@something.com;test3=val3;test4=val4>;test5=val5;test6=val6
And the resulting content in the routing script:
call[:calling_parameters].inspect -> {:user_param=>"test1=val1;test2=val2", :uri_param=>"test3=val3;test4=val4", :header_param=>"test5=val5;test6=val6"}

Example to overwrite inbound leg calling parameters with new parameters for the outbound leg:
<pre>
call [:calling_parameters] = {
:user_param => "user_param7=7;user_param8=8",
:uri_param => "uri_param9=value9",
:header_param => "header_paramA=A" }
</pre>

Example to add user=phone and keep all other uri parameters.
<pre>
call[:calling_parameters] ||= {} # Create a hash if not already present
call[:calling_parameters][:uri_param] ||= "" # Create a string if not already present
call[:calling_parameters][:uri_param] += ";" if call[:calling_parameters][:uri_param] != ""
call[:calling_parameters][:uri_param] += "user=phone"
</pre>

=== MLPP Precedence values ===

mlpp_look_for_busy:

*<tt>allowed</tt>
*<tt>path_reserved</tt>
*<tt>not_allowed</tt>

mlpp_precedence_level:

*<tt>flash_override</tt>
*<tt>flash</tt>
*<tt>immediate</tt>
*<tt>priority</tt>
*<tt>routine</tt>

mlpp_network_identity:

3 digits value from 0 to 999

mlpp_service_domain:

24 bits value from 0 to 16777215

=== ISUB subaddress information values ===

called_isub_type:
calling_isub_type:

*<tt>nsap</tt>
*<tt>nsap_ia5</tt>
*<tt>nsap_bcd</tt>
*<tt>user</tt>

called_isub:
calling_isub:

Digits for the subaddress information.

=== Network Identification Plan ===

network_identification_plan:

*<tt>Unknown</tt> (value 0)
*<tt>cic</tt> (3 digits carrier identification code plus circuit code, value 1, SS7 or ISDN)
*<tt>user</tt> (User, value 2, ISDN only)
*<tt>cic4</tt> (4 digits carrier identification code plus circuit code, value 2, SS7 only)
*<tt>dnic</tt> (public Data Network ID, value 3, SS7 only)
*<tt>mnic</tt> (public land mobile network, value 6, SS7 only)

=== Registered Users Information ===
Routing script can access information about registered users (when either the calling or called user is a known registered user).
When these fields are empty, it means that the calling/called (SIP from/to) does not correspond to a known registered user (routing script may still decide to route the call based on static routes).

Information for the called user:
params[:registered_user]
Information for the calling user:
params[:calling_registered_user]

These parameters are a hash of key/values that provide information about the contact.
{
:contact_list=>
[
{
:contact=>"<sip:user_name_or_number@hostname:7070;transport=UDP>", -> Full contact
:expires=>"60", -> Contact expiry time (seconds)
:host=>"hostname", -> host name from the contact header
:name=>"user_name_or_number", -> user name from the contact header
:nap_in=>"NAP_NAME", -> NAP that the contact has registered from
:port=>"7070", -> Port from the contact header
:transport=>"UDP" -> Transport type from the contact header
:q_value=>"0.00", -> Q-value for the contact (for contact ordering)
:src_host=>"10.0.0.10", -> Actual source IP address that the contact has registered from
:src_port=>"7070", -> Actual source port that the contact has registered from
:src_transport=>"UDP", -> Actual protocol that the contact has been registering with
}
]
}

== Route parameters ==

All route may have these parameters:

*calling
*called
*nap
*remapped_calling
*remapped_called
*remapped_nap
*remapped_destination_leg_profile (called remapped_profile prior to Toolpack 2.9)
*remapped_source_leg_profile (called remapped_incoming_profile prior to Toolpack 2.9)

Example:

route[:remapped_nap]

Additionally it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.
For example:
*priority
*weight

== Routing calls toward registered users ==
Static routes normally chose an outbound NAP to forward the call to.

But it's also possible to create routes which outbound NAP is dynamically chosen by matching a registered user (when using [[Sip_registration_forwarding|SIP registration forwarding]]).

More information can be found [[Sip_registration_forwarding#SIP_Calls_routing|here]] about the way to control the [[Sip_registration_forwarding#SIP_Calls_routing|priority of "dynamic" vs "static" routes]].

More information can be found [[#Registered_Users_Information|here]] about using routing scripts to access registered users information during call routing.

== Playing prompts announcements or tones ==

New feature in release 2.6, all bridges may have these parameters. These can be used to play IVR prompts (audio files) in different states of the call flow.

*'''announcement_tone''' (played before outgoing call is routed)
*'''ring_tone''' (played after when waiting for outgoing call to answer)
*'''busy_tone''' (played if outgoing call failed)
*'''disconnect_tone''' (played after the call has reached it's maximum duration)

Example to play an announcement to incoming call (before routing outgoing call, regardless if a matching route is found or not):
bridge[:announcement_tone ] = "my_announcement.wav"

Example to play a ring-tone while the outgoing call is ringing:
bridge[:ring_tone] = "my_ring_tone.wav"

Example to play an audio file when outgoing call fails (no route, or outgoing call is refused):
bridge[:busy_tone] = "my_busy_tone.wav"

Example to play an audio file when call has reached the maximum allowed duration:
bridge[:disconnect_tone] = "your_account_balance_is_empty.wav"

=== Announcement file path format and options ===

All file plabyacks (:announcement_tone, :busy_tone, :ring_tone, :disconnect_tone) inside bridge parameters use this format.
<pre>"file1.wav:repeat:start_off:end_off,file2.wav:repeat:start_off:end_off,file3.wav:repeat:start_off:end_off"
</pre>
Optional parameters:
* repeat: number of times to play the file (0 and 1 have the same result)
* start_off: Start offset in milliseconds
* end_off: End offset in milliseconds

Http and other path formats are described here: [[Customer_application_framework:play_audio_files#Play_path_format|Path format]]

==== Example 1 ====
The following example will play file1.wav once, and then play file2.wav in loop:
"file1.wav,file2.wav:-1"

==== Example 2 ====
The following example will play file1.wav from start offset of 1 second to end offset of 3 seconds, then twice file2.wav from second 5 to second 10.
"file1.wav:0:1000:3000,file2.wav:2:5000:10000"

==== Example 3 ====
The following example will play file1.wav once, ending at offset of 30 seconds.
"file1.wav:0:0:30000"

=== announcement_tone ===

params[:bridge][:announcement_tone] = "announcement.wav"

Audio file played on the incoming call before any outgoing call is placed. The outgoing call occurs when the file finished playing.

==== announcement_tone options ====
===== announcement_tone_answer =====
params[:bridge][:announcement_tone_answer] = "yes"

Forces an answer of the call before playing the announcement. Default if argument not provided is "no", in which case call is only alerted with in-band media.

===== announcement_code_detect =====
This option allows that the tone detection is enabled during the announcement play.

Collected digits can be inserted into the CDR logs (radius attribute "Telcob-CollectedDigits", or text CDR variable @{CollectedDigits}).

Collected digits can also be sent back to routing script, which is called again with the same call attributes, except that the called number is replaced by the collected digits.

Code detect has multiple options, as shown in the following code:
code_detect = {
:type => :DTMF, # :DTMF or :MFR1 tone detection.
# Default is MFR1.
:prefix => "", # Prefix (digits) that is removed from collected digits.
# Default is empty.
:suffix => "", # Suffix (digits) that is removed from collected digits
# and causes routing script to be immediately called.
# Default is empty.
:suffix_removal => false, # Controls the removal of the suffix from the collected digit string that's reported to routing script.
# Default is false
:timeout => 0, # Inter-digit timeout (ms) after which collected digits are passed to the routing script.
# Use 0 for "no timeout".
# Default is 1000ms
:barge_in_interruption => true, # When enabled, playing announcement is stopped as soon as first digit is collected.
# Default is true.
:proceed_on_play_done => false, # When true: Outgoing call is made after announcement finishes playing.
# Routing script is not called again.
# When false: Outgoing call is never made.
# Digits are collected until timeout or suffix match,
# then routing script is called again.
# Default is false.
:cas_on_hook => false, # Specific for CAS-R1 calls. Makes CAS bits switch to "on-hook" when announcement finished playing
# (but the call is not "terminated" from Toolpack point of view)
# Default is false.
:cas_on_hook_delay => 0, # Duration of cas bits "on-hook" state.
# Only effective if cas_on_hook is set to true.
# Value of 0 stands for "infinite delay".
# Default is 0.
:repeat_delay => 0, # Delay between repetition of the announcement. The announcement will repeat
# itself every "repeat_delay" until a code is detected (suffix match or timetout).
# Value of 0 stands for "infinite delay" (no repeating).
# Default is 0.
}
'''Example 1''': Collect DTMF digits, and call routing script again with collected digits upon timeout or suffix match.
code_detect = { :type => :DTMF, :suffix => "#", :timeout => 5000 }
params[:bridge][:announcement_code_detect] = code_detect

'''Example 2''': Collect digits during the announcement (for CDR logs), then proceed (make outgoing call) after announcement finishes playing
code_detect = { :type => :DTMF, :timeout => 0, :barge_in_interruption => false, :proceed_on_play_done => true }
params[:bridge][:announcement_code_detect] = code_detect

==== Controlling what happens after announcement ====
The routing script can control what happens with the call after the announcement finishes playing:
* An outgoing call is made
* Incoming call is hung-up
* Do nothing (wait for the incoming call to hang-up)
===== An outgoing call is made =====
This happens when the script has returned matching routes (and did not raise RoutingException)

===== Incoming call is hung-up =====
This happens when the script returns no routes (in which case base_routing will raise RoutingException with cause :no_route).

It also happens when the script explicitly raises RoutingException.

The incoming call will be terminated with the specified cause.
For example
raise RoutingException, :temporary_failure
(See "Reason values" section in this page for list of available causes)

===== Do nothing (wait for the incoming call to hang-up) =====
If a filter raises RoutingException with code :ok, then the incoming call will not be terminated at the end of the announcement play.
Announcement digit collection will remain active if appropriate.
For example:
raise RoutingException, :ok

=== ring_tone ===
params[:bridge][:ring_tone] = "ringing.wav"

Audio file played on the incoming call while waiting for the outgoing call to be answered.

Ring tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:ring_tone] will override the profile's ring tone behavior).

==== ring_tone options ====
===== ring_tone_state =====
params[:bridge][:ring_tone_state] = :alerted

Call state from which ring tone is being played. Available values are:
* '''immediately''': Ring tone starts playing immediately on the incoming leg
* '''accepted''': Ring tone starts playing as soon as outgoing call is accepted
* '''callprogress''': Ring tone starts playing as soon as "call progress" is received on the outgoing call
* '''alerted''' (default): Ring tone starts playing only once outgoing call is alerted (but won't play if alert indicates early media from outgoing call)

This option also apply when params[:bridge][:ring_tone] is not used, because it also apply to ring tone playback configured in the Web Portal, from the incoming call's profile.

=== busy_tone ===
Toolpack 2.8 and above:
params[:bridge][:busy_tone] = "no_route.wav"

Note: Obsolete name (toolpack 2.7.153 and earlier, but still supported in recent releases):
params[:bridge][:call_progress_tone] = "no_route.wav"

Audio file played on the incoming call when outgoing call fails (never answered).

Note that announcement_tone, if used, is played before the outgoing call attempt is made, and thus before the busy_tone.

Busy tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:busy_tone] will override the profile's busy tone behavior).

Special value '''"none"''' can be used by routing script to force playing nothing (as empty string would default to profile's behavior)

==== busy_tone options ====
===== busy_tone_answer =====
params[:bridge][:busy_tone_answer] = "yes"

Forces an answer of the call before playing the busy tone. Default if argument not provided is "no", in which case call is only alerted with in-band media.

=== disconnect_tone ===
params[:bridge][:disconnect_tone] = "max_duration.wav"

Audio file played on the incoming call when call duration (:max_call_duration) is reached. Then the leg will be terminated with specified reason (:call_duration_reason).

==== disconnect_tone options ====
===== max_call_duration =====
params[:bridge][:max_call_duration] = "60000"

Maximum call duration in millisecond. This timer is started when entering answer state.

===== call_duration_reason =====
params[:bridge][:call_duration_reason] = :resource_unavailable

Drop both legs with this reason when call duration (:max_call_duration) is reached.

=== Managing audio prompts through Web Portal ===
Audio prompts can be uploaded or deleted from the TMedia unit through the Web Portal:
[[Toolpack:Configuring_Audio_Prompts_A|Managing audio prompts]]

Prompts management must be done using the Web Portal of the primary server (in systems with redundant TMedia units or redundant host servers).
The file will automatically get replicated to the secondary server.

=== Managing audio prompts manually ===
Any file on the TMedia host file system can be played. This means it's possible to manage prompts through ssh/scp.

==== The default (replicated) prompts folder ====
By default, when playing a prompt, Toolpack will look in the default prompts folder:
/lib/tb/toolpack/pkg/prompts
The root of this "prompts" directory is automatically replicated to secondary unit of redundant setups (1+1, N+1, redundant hosts). Sub-folders won't be replicated.

Any prompt play request without explicit file path will map to this folder. For example:
params[:bridge][:busy_tone] = "no_route.wav"
This will correspond to file /lib/tb/toolpack/pkg/prompts/no_route.wav

==== Relative file paths ====
Any file path that begins with "file://" is considered relative to the tbstreamserver application's working directory:
/lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/
(Where "2.8" may be replaced by the current major version of your system)

For example:
params[:bridge][:busy_tone] = "file://my_folder/no_route.wav"
This will correspond to file /lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/my_folder/no_route.wav

==== Absolute file paths ====
Absolute paths can also be provided.
For example:
params[:bridge][:busy_tone] = "file:///root/my_folder/no_route.wav"
This will correspond to file /root/my_folder/no_route.wav

== Recording call legs ==
Introduced in release 2.6.44, it's now possible to use routing scripts to ask for recording incoming and/or outgoing call legs.

See example filter script "call_recording" (created by default in Web Portal routing scripts starting with 2.6.44) for an example.

=== Recording the incoming call leg ===
To record the incoming call leg, the routing script (in a "after filter" for example) has to set the following parameter:

bridge[ :record_incoming ] = ""

=== Recording the outgoing call leg ===
To record the outgoing call leg, the routing script (in a "after filter" for example) has to set the following parameter, per route (the decision to record or not, or the file name to record to, can be set per matching route):

# Need to clone the routes in order to have the right to modify them
routes = clone_routes params[:routes]
routes.each do |route|
route[ :record_outgoing ] = ""
end
# Store modified routes back to the parameters for this outgoing call
params[:routes] = routes

=== Record the outgoing call leg within incoming leg's recorded file (mixing) ===
[...]
route[ :record_outgoing ] = "@{MixWithIncoming}"
[...]

=== Choosing file path to record to ===
The value assigned to ":record_incoming" or ":record_outgoing" is the path to record the file to.

The paths can be absolute, or relative. When relative, they are relative to the "tbstreamserver" application working directory, for example:
/lib/tb/toolpack/setup/12358/2.7/apps/tbstreamserver/

* Empty file name will default to a name that contains various information about the call:
** ''LinkId'': Id common between all legs of this call bridge
** ''LegId'': Unique Id for this leg
** ''Nap'': Current NAP name this call leg is from
** ''Direction'': "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
** ''Calling'': The calling number of this call leg
** ''Called'': The called number of this call leg
** ''Protocol'': The signaling protocol of this call leg (SS7, ISDN, CAS, SIP)
** ''Media info'': Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
* To record outgoing call leg in the same audio file as incoming call leg (mixing), use the following:
** @{MixWithIncoming}: Record outgoing legs in same file as incoming legs
* Variables can be used to insert in the recording path information that's not already available from routing scripts:
** @{CURRENT_PKG}: Version of current package
*** Example: 2.6.45
** @{DATE format}: Prints the date, where 'format' is expressed as described for the 'strftime' function
*** Example: @{DATE %Y-%m-%d} => 2013-01-28
** @{DefaultName}: Replaced by the default file name for recording, which contains:
*** LinkId: Id common between all legs of this call bridge
*** LegId: Unique Id for this leg
*** Nap: Current NAP name this call leg is from
*** Direction: "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
*** Calling: Calling number
*** Called: Called number
*** Protocol: Protocol type of this call (SS7, ISDN, CASR2, SIP)
*** Media info: Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
*** Example: "73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{DefaultPath}: Default recording folder and file name: "@{RECORD_PATH}/@{DATE %Y-%m-%d}/@{DefaultName}"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{Direction}: Direction of current leg (IN our OUT)
*** Example: IN
** @{LegId}: Current LegId (Unique Id for this leg)
*** Example: F3D67B4B
** @{LinkId}: Current LinkId (Id common between all legs of this call bridge)
*** Example: 73EBA698
** @{PKG_HOME}: Path where packages are stored.
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg
** @{PROMPT_PATH}: Default path where audio prompts are stored
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg/prompts
** @{Protocol}: Protocol of current leg
*** Example: SS7
** @{RECORD_PATH}: Default recording folder: "@{TB_SETUP_HOME}/recorded_calls/"
** @{TBX_GW_PORT}: Current "System Id" (also called "Gateway Port")
*** Example: 12358
** And all variables listed here: [[Customer_application_framework:play_audio_files#Helpful_variables_to_build_play_or_record_file_paths|Building play or record file path]]

== Controlling UUI (user-to-user information) relay ==
UUI (user-to-user information) can be present in different messages received by either call leg during a call. For example, information can be carried during the initial invite, other information can be carried when the call is alerted, answered, or terminated.

Routing scripts can control if the UUI received from one leg through the call will be forwarded to the other call leg:
*uui_forward_enabled

Routing scripts can also read and modify the UUI received with the incoming call leg, before it gets forwarded upon creation of the outgoing call leg:
*uui

=== UUI (user-to-user indication) values ===

Byte array represented as ruby String. Use ''bridge=params[:bridge]'', then ''bridge[:uui]'' to access the data.

To access the bytes in Ruby, use ruby String operator []. For example: bridge[:uui][0] will return the binary value of the first UUI byte.

Function each_byte can also be useful to iterate through all bytes of the UUI.

=== uui_forward_enabled values ===

Controls forwarding or discarding of UUI to outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
* 0/false: UUI is not forwarded between call legs
* 1/true: UUI is forwarded between call legs

The value for this parameter at input of routing script depends on the "Forward UUI" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

== Authorization ==
Starting with release 2.7, it is possible to issue RADIUS authorization requests from routing scripts. To do so, the params[:authorization] object must be filled with the required RADIUS attributes and [[#Refuse|an exception must be raised]] with reason :authorization_required.

When the authorization is completed, the routing script is called again with the result. The params[:authorization] object will be filled with the RADIUS attributes from the response. The params[:authorization][:result] field will also contain a string indicating the result of the authorization:

* ''accept'': The authorization was successful.
* ''reject'': The authorization was refused.
* ''challenge'': The authorization was challenged.
* ''timeout'': The authorization was not answered.

== Call diversion options ==
It's possible to control the call flow when a call diversion information is received in the alerting state.

Two fields are available: bridge[ :diversion ] and bridge[ :diversion_reason ]

The internal release cause TOOLPACK_DIVERT_NOT_ALLOWED is used by gateway application to terminate both legs.

bridge[ :diversion ] = :allowed
The alert message will not be analyzed and the call will be progressed. Default behavior.
bridge[ :diversion ] = :not_allowed
If the alert message indicates that the call is diverted, the call will be released no matter the In-band information to allow
early media.
bridge[ :diversion ] = :not_allowed_w_early_media
The call will be released If the alert message indicates that the call is diverted with in-band information to allow early media.
bridge[ :diversion_reason ] = "*"
If the diversion is not allowed, the gateway will drop the call for any redirecting reason.
bridge[ :diversion_reason ] = "0,1,2"
or
bridge[ :diversion_reason ] = "unknown,busy,no_reply"
If the diversion is not allowed, the redirecting reason will be analyzed and the call will only be dropped for the configured cases.

See section [[Routing_script_tutorial:Mini_Development_Guide#Redirecting_number,_Original_Called_Number_and_Diversion_Reason|Redirecting number reason values]].

== Call transfer requests ==
Toolpack allows that [[Call transfer]] requests are relayed from one leg to the other, or to process them locally (making another outgoing call to replace the call that requested the call transfer).

If the chosen [[Call transfer]] mode is to process requests locally, upon reception of a call transfer request (SIP REFER or ISDN Facility), routing script will be called once again, to select the routes for the new outgoing call (call transfer target).

=== How to route call transfer request ===
Routing of a call transfer request is done exactly like routing of a normal incoming call.
The routing script generally does not need any modification to support that.

In some cases, the routing script may want to use information related to the transfer request to perform routing, or to insert information in the outgoing call leg.
Additional information is provided to the routing script, allowing routing decisions using information from the call transfer request (SIP REFER or ISDN Facility).
See below...

=== params[ :call ] content during transfer request ===
When processing a call transfer request, the params[ :call ] hash contains the information from the inbound call (same as was passed to the routing script upon arrival of the inbound call)
call = params[ :call ] -> Information from original inbound call, with exception of call[ :called ]

One exception (convenient because it allows a unmodified routing script to process call transfer request the same way as any other routing request):
call[ :called ] -> Replaced by the called number from the call transfer request (also called "redirection number")
Complementary information:
call[ :original_called_number ] -> Contains the called number that was initially received from the incoming call, prior to call transfer request
call[ :redirecting_number ] -> Number of the call from which the call transfer request was received (generally equals to original_called_number)

These fields will also be included in the outgoing call made after routing:
* original called number and redirecting number are existing fields on SS7 and ISDN calls
* SIP "diversion" header is used for SIP calls

=== params[ :transfer ] content ===
(this if valid only for release 2.7.102 and above) 
When processing a call transfer request, information from the call transfer request message (SIP REFER, ISDN Facility) is provided in params[ :transfer ]:
transfer = params[ :transfer ]
The following field is always present:
transfer[ :original_nap ] -> Contains the NAP of the first call from which a call transfer request was received
transfer[ :redirecting_nap ] -> Contains the NAP of the call from which the current call transfer request was received
(same as :original_nap for the first call transfer, different for subsequent transfers)
Examples of other fields that may be present, when appropriate:
transfer[ :uui ] -> The UUI (user-to-user information) found in the call transfer request
transfer[ :sip_header ] -> Contains custom SIP headers from the call transfer request
transfer[ :request_uri ] -> Contains the SIP Request URI

These fields are 'read-only'. They will not be included in the outgoing call, as they represent the contents of the call transfer request, and not the outgoing call to be made.

To insert/modify attributes of the outgoing call, the parameters from params[ :call ] must be edited instead.

== Redirection ==
In release 2.8 and above, redirection contacts are obtained from the routing engine in the following format:

contacts = params[ :contacts ]
contacts = {
:index=>"3",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"", :raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127", :raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
{:called_number=>"6662", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6662@192.168.215.128", :raw_data=>"<sip:6662@192.168.215.128>", :expiration=>"3600"},
{:called_number=>"6663", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6663@192.168.215.129", :raw_data=>"<sip:6663@192.168.215.129>", :expiration=>"3600"},
{:called_number=>"6664", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6664@192.168.215.150", :raw_data=>"<sip:6664@192.168.215.150>", :expiration=>"3600"}
],
:source_indexes=>"nil,0,0,0,2"
}

* <code>params[:contacts][:list]</code> contains the contact log. Each contact within the list has the following fields:
** <code>:called_number</code> - the called number
** <code>:is_number_ported</code> - if the called number has been ported (for SIP: if the npdi parameter is present)
** <code>:ported_number</code> - the called number that was ported (for SIP: the rn parameter value, if available)
** <code>:sip_uri</code> - the SIP URI of the contact, without the contact-params section (without the expires and q contact parameters)
** <code>:raw_data</code> - the raw data representing the contact in the signaling protocol. For SIP, this is the full SIP URI (including the expires and q contact parameters).
** <code>:priority</code> - the priority of the contact [0-1000]
** <code>:expiration</code> - the expiration time in seconds of the contact
* <code>params[:contacts][:index]</code> contains the index of the contact that is currently being routed.
* <code>params[:contacts][:source_indexes]</code> contains a comma-separated list of indexes from <code>params[:contacts][:list]</code>. Each index represents the contact from which the contact in the list was obtained from.

To get more information, see:
*[[Routing_script_tutorial:SIP_Redirection_Contacts|SIP Redirection Contacts Parameters in a Call Flow]]

== Connected number ==
Insert a connected number in the answer message of the call flow.

Routing script example:
bridge = params[ :bridge ]
bridge [ :connected_number ] = "3335577"
bridge [ :connected_number_noa ] = :national_number
bridge [ :connected_number_npi ] = :private
bridge [ :connected_number_presentation ] = :allowed
bridge [ :connected_number_screening ] = :pass

== Terminating calls ==
In release 2.8, it is now possible to terminate a call through the routing scripts. The [[#Reason values|reason code]] must be specified in <code>params[:bridge][:reason]</code>. The <code>:terminate</code> hash must be created and copied into <code>params</code>:
terminate = {}
params[:terminate] = terminate
The following fields can then be set in <code>:terminate</code>:
* <code>:sip_header</code>
* <code>:contacts</code> # list of contacts as described in the [[#Redirection|redirection]] section
* <code>:isup_raw</code>
* <code>:isup_raw_variant</code>
* <code>:redirecting_number</code>
* <code>:redirecting_number_noa</code>
* <code>:redirecting_number_npi</code>
* <code>:redirecting_number_presentation</code>
* <code>:redirecting_number_reason</code>
* <code>:redirecting_number_counter</code>
* <code>:redirecting_number_indicator</code>
* <code>:original_called_number</code>
* <code>:original_called_number_noa</code>
* <code>:original_called_number_npi</code>
* <code>:original_called_number_presentation</code>
* <code>:original_called_number_reason</code>
* <code>:original_called_number_counter</code>

== Reason values ==

Check here for Termination Reason Cause codes: 

[[Termination_cause_codes|Termination Reason Cause codes]]
 

Example to refuse an incoming call leg.
raise RoutingException, :no_route

Reason cause strings available inside routing scripts:

List of Q.850 reason causes:
:unallocated_number
:no_route_to_network
:no_route_to_destination
:send_special_tone
:misdialled_trunk_prefix
:channel_unacceptable
:call_awarded_in_established_channel
:preemption
:reattempt
:qor_ported_number
:normal_call_clearing
:user_busy
:no_user_responding
:no_answer_from_user
:subscriber_absent
:call_rejected
:number_changed
:redirection
:exchange_routing_error
:non_selected_user_clearing
:destination_out_of_order
:address_incomplete
:facility_rejected
:response_to_status_enquiry
:normal_unspecified
:no_circuit_available
:network_out_of_order
:frame_mode_out_of_service
:frame_mode_connection_operational
:temporary_failure
:switching_equipment_congestion
:access_information_discarded
:requested_circuit_not_available
:precedence_call_blocked
:resource_unavailable
:quality_of_service_not_available
:requested_facility_not_subscribed
:outgoing_calls_barred
:outgoing_calls_barred_within_cug
:incoming_calls_barred
:incoming_calls_barred_within_cug
:bearer_cap_not_authorized
:bearer_cap_not_available
:inconsistency_access_info
:service_not_available
:bearer_cap_not_implemented
:channel_type_not_implemented
:requested_facility_not_implemented
:only_restricted_digital_info
:service_not_implemented
:invalid_call_reference
:channel_does_not_exist
:call_identity_does_not_exist
:call_identity_in_use
:no_call_suspended
:call_has_been_cleared
:user_not_member_of_cug
:incompatible_destination
:non_existant_cug
:invalid_transit_network
:invalid_message_unspecified
:mandatory_ie_missing
:message_type_non_existent
:message_not_compatible_with_call_state
:ie_non_existent
:invalid_ie_content
:msg_not_compatible_with_call_state
:recovery_on_timer_expiry
:parameter_non_existent_passed_on
:message_with_non_recognized_parameters_discarded
:protocol_error
:interworking_unspecified

List of toolpack reason causes:

:toolpack_normal or :normal
:toolpack_resource_error or :resource_error
:toolpack_timeout or :timeout
:toolpack_no_route or :no_route
:toolpack_call_collision or :call_collision
:toolpack_sync_drop or :sync_drop
:toolpack_signaling_error or :signaling_error
:toolpack_locally_rejected or :locally_rejected
:toolpack_interface_not_available or :interface_not_available
:toolpack_reset_in_progress or :reset_in_progress
:toolpack_adapter_reject or :adapter_reject
:toolpack_missing_or_invalid_ie or :missing_or_invalid_ie
:toolpack_incoming_only or :incoming_only
:toolpack_system_configuration_changed or :system_configuration_changed
:toolpack_resource_no_more_available or :resource_no_more_available
:toolpack_incompatible_media or :incompatible_media
:toolpack_resource_allocation_failed or :resource_allocation_failed
:toolpack_data_path_not_available or :data_path_not_available
:toolpack_local_congestion or :local_congestion
:toolpack_authorization_required or :authorization_required
:toolpack_call_divert_is_not_allowed or :call_divert_is_not_allowed

List of SIP reason causes: 
Reason causes starting with a digit must use the following syntax (can't use : as prefix).

'300_multiple_choices'
'301_moved_permanently'
'302_moved_temporarily'
'305_use_proxy'
'380_alternative_service'
'400_bad_request'
'401_unauthorized'
'402_payment_required'
'403_forbidden'
'404_not_found'
'405_method_not_allowed'
'406_not_acceptable'
'407_proxy_authentication_required'
'408_request_timeout'
'409_conflict'
'410_gone'
'413_request_entity_too_large'
'414_request_URI_too_long'
'415_unsupported_media'
'416_unsupported_URI_scheme'
'420_bad_extension'
'421_extension_required'
'422_session_timer_too_small'
'423_interval_too_brief'
'429_referrer_identity_error'
'480_temporary_unavailable'
'481_call_or_transaction_does_not_exist'
'482_loop_detected'
'483_too_many_hops'
'484_address_incomplete'
'485_ambiguous'
'486_busy_here'
'487_request_terminated'
'488_not_acceptable_here'
'489_bad_event'
'491_retry_after'
'500_server_internal_error'
'501_not_implemented'
'502_bad_gateway'
'503_service_unavailable'
'504_server_timeout'
'505_version_unsupported'
'513_message_too_large'
'600_busy_everywhere'
'603_decline'
'604_not_exist_anywhere'
'606_not_acceptable'

== Nap status ==

All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.

'''Notice:''' These values may change between major release.

Routing script call attribute name Description
--------------------------------------------------------------------------------------------
"name" NAP name.
"signaling_type" Signaling type (SS7, ISDN, CASR2, SIP)
"profile" Profile name.
"sip_destination_ip" Destination IP address.
"sip_destination_port" Destination IP port.
"sip_transport_type" SIP transport type (:udp, :tcp, or :tls) (Toolpack 3.1 and more)
"inst_incoming_call_cnt" Instantaneous Count of incoming calls.
"inst_outgoing_call_cnt" Instantaneous Count of outgoing calls.
"available_cnt" Number of available circuits or channels.
"unavailable_cnt" Number of unavailable circuits or channels.
"availability_percent" Percentage of available circuits or channels.
"usage_percent" Percentage of used circuits or channels.
"unused_shared_percent" Percentage of used circuits or channels of this NAP available to make new calls with (taking into account shared with other NAPs)
"total_incoming_call_cnt" Total Count of incoming calls.
"global_asr_percent" Global calculated ASR percentage.
"total_outgoing_call_cnt" Total Count of outgoing calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_outgoing_call_cnt" Last 24 hours outgoing calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_outgoing_call_cnt" Current hour outgoing calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_outgoing_call_cnt" Last hour outgoing calls.
"poll_remote_proxy" Remote proxy polling enabled
"is_available" Remote proxy actually available or not
"time_since_polling" Time since the last availibility polling
"time_available_seconds" Number of seconds since the NAP is available
"time_unavailable_seconds" Number of seconds since the NAP is unavailable
"register_to_proxy" Register to proxy enabled
"registered" Actually registered or not
"time_since_refresh" Time since the last refresh
"time_registered_seconds" Number of seconds since the NAP is registered
"time_not_registered_seconds" Number of seconds since the NAP is not registered
"asr_stats_incoming_struct" Detailed Answer-Seizure Rate incoming statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"asr_stats_outgoing_struct" Detailed Answer-Seizure Rate outgoing statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"mos_struct" Detailed Mean Opinion Score statistics.
{
"last_24h_ingress" Last 24 hours calculated MOS for incoming RTP packets.
"last_24h_egress" Last 24 hours calculated MOS for outgoing RTP packets.
"current_hour_ingress" Current hour calculated MOS for incoming RTP packets.
"current_hour_egress" Current hour calculated MOS for outgoing RTP packets.
"last_hour_ingress" Last hour calculated MOS for incoming RTP packets.
"last_hour_egress" Last hour calculated MOS for outgoing RTP packets.
}
"network_quality_struct" Detailed network quality statistics.
{
"last_24h_ingress" Last 24 hours network quality percentage for incoming RTP packets.
"last_24h_egress" Last 24 hours network quality percentage for outgoing RTP packets.
"current_hour_ingress" Current hour network quality percentage for incoming RTP packets.
"current_hour_egress" Current hour network quality percentage for outgoing RTP packets.
"last_hour_ingress" Last hour network quality percentage for incoming RTP packets.
"last_hour_egress" Last hour network quality percentage for outgoing RTP packets.
}

 If the nap status is part of a substructure, the substructure will be a hash containing all subfield elements.

Example to access the signaling type and the number of incoming call count for the NAP of the current call:

incoming_nap = params[:naps][ params[:call][ :nap ].to_sym]
log_trace 4,"Incoming NAP parameters=" + incoming_nap.inspect
log_trace 4,"Incoming NAP signaling type=" + incoming_nap[:signaling_type].inspect
log_trace 4,"Incoming NAP call cnt=" + incoming_nap[:asr_stats_incoming_struct][:total_call_cnt].inspect

 It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.

== Telephony Services ==
In release 2.10 and the above, telephony services (CNAM Request) can be manage from the routing engine in the following format:

params[:telephony_services].each do |service| -> Array of telephony services
service[:name] -> Customer telephony service name
service[:type] -> For now only "CNAM Request"
service[:enabled] -> Indicate if the service is enabled (true) or not (false)
(Only the telephony service define in the profile associated to the NAP is enabled)
(The others telephony services define in others profiles are disabled)
(If we are in the case where we return in the routing script with a response, it is important to set :enabled to false in order to avoid repeating the same query)
serviceParams = service[:params]
serviceParams[:return_to_script] -> Indicates to Gateway if we must return to the routing script after receiving the CNAM response
(It is important to set back to false this field to avoid an infinite loop)
serviceQuery = service[:query]
serviceQuery[:phone] -> 10 digits of calling number from the incoming call to send to the CNAM server
serviceQuery[:timeout] -> Timeout in millisecond to wait a CNAM response from CNAM server
(Default value from profile configuration)
serviceResponse = service[:response]
serviceResponse[:success] -> Indicates if we received a good CNAM response from the CNAM Server (Only present if :return_to_script is set to true)
serviceResponse[:caller_name] -> The caller name received in the CNAM response from the CNAM Server (Only present if :return_to_script is set to true)

== Custom user context ==
The routing script may '''save per-call information within the call context''', that will be available if routing is called again later during the call flow.

Cases where routing is called multiple time for the same call are:
- Call transfer requests
- SIP redirect requests
- Radius Authorization result
- Announcement server with digit collection

The routing script can save a recursive hash of attributes here:
params[:user_context]

For example
params[:user_context] = { "SomeKey" => "Some value I want to retrieve upon next routing for this call", "OtherVal" => { "subkey" => "subval" } }

Upon first call to routing script, params[:user_context] will be nil.
Upon subsequent calls to routing script, it will contain whatever the script had stored upon previous call (or nil if it was not set)

Note: This feature is available starting from release 2.9.85, 2.10.31 and 3.0.15 (in respective branches 2.9, 2.10 or 3.0)

== Routing Script Tests ==
The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
This is available in the Routing Scripts section of the Web portal.

=== Test parameters ===
==== @call_params ====

That variable should contain a hash of call parameters that will be passed to the routing script. This is equivalent to the incoming call parameters.

 

==== @nap_list ====

A list of the hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.

'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.

 

==== @params ====

A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.

@params = {
:bridge => {:announcement_tone, "announcement.wav"},
:contacts => {
:index=>"1",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",
:raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",
:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
],
:source_indexes=>"nil,0"
}
}

 

----

 Back to [[Routing script tutorial|Routing Script Tutorial]].

Routing script tutorial:Mini Development Guide

2019-09-09T15:01:44Z

CThompson: /* Script parameters protocol mapping */ - Added ACLI IE (Additional Calling Party Information) - Carl Thompson

== Call object ==

=== Get ===

This function is used to get the call parameters. The possible parameters are described in the section "Call parameters"

called_number = caf_call.get :called

=== List_params ===

This function is used to retrieve the list of supported call parameters. For example to extract all the possible call parameters from the the call object and put it in hash.

caf_call.list_params.each {|param| call[param] = caf_call.get param }

=== Accept ===

This function is used to accept a call. It actually creates one outgoing route that the gateway application will use to bridge the incoming call leg. If more than one outgoing route is "accepted", the gateway will try them one by one in the same order that they were accepted. If an outgoing call leg fails (according to 'route retry' parameters), the next route in line will be used.

This method takes 2 arguments, the call parameters (hash) and the route parameters (hash). Note that calling this method does NOT stop the flow of the script.

Apply route remapping rules

caf_call.accept out_call, route

=== Refuse ===

This function is used to set the reason code for the incoming call leg refusal. However, this function does NOT stop the flow of the script.

caf_call.refuse :reason => :temporary_failure

To immediately refuse the incoming call leg and stop processing the script, the script must raise an exception. Exiting the script by raising the exception overwrites any reason cause previously stored using refuse().

raise RoutingException, :no_route

The supported refusal cause values for both refuse() and raise() are described in the section "[[Routing_script_tutorial:Mini_Development_Guide#Reason_values|Reason values]]".

=== Script parameters protocol mapping ===

The following call parameters are available in the call object. For example:

called_number = call[:called]

For information on how to use and remap call parameters, see [[Toolpack:_How_to_Use_RegEx_in_Remapped_Called_and_Calling_Number_Mask | How to use regex in Remapped Called and Calling Number Mask]]

{| cellspacing="1" cellpadding="1" border="1" style="width: 921px; height: 805px;"
|-
! scope="col" | '''Script parameter name'''
! scope="col" | '''ISDN '''
! scope="col" | '''R2 CAS''' 
! scope="col" | '''SS7 '''
! scope="col" | '''SIP '''
! scope="col" | '''Comment '''
! scope="col" | '''Toolpack version '''
|-
| leg_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Leg ID 
| 
|-
| session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Session ID 
| 
|-
| original_session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Original Session ID (before call transfer or redirections) 
| 
|-
| calling 
| Q931: 'Calling party number' IE - Number digits 
| ANI (Group B) 
| Q763: 'Calling party number' IE - address signals (*) 
| SIP:From - user-info 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead. 
| 
|-
| calling_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:From - host (domain or IP) 
| For example : The 'telcobridges.com' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| calling_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:From - port 
| For example : The '6060' in From: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| calling_noa 
| Q931: 'Calling party number' IE - Type of number 
| N/A 
| Q763: 'Calling party number' IE - nature of address indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_npi 
| Q931: 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Calling party number' IE - numbering plan indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_display 
| Q931: 'Display' IE - Display information 
Q931: 'Facility CNAM' IE when presentation is allowed for DMS/NI2 variants 
| N/A 
| Q763
ITU97: 'Display information' IE - display information
ANSI95: 'Generic name' IE - display information
| SIP:From - display-name 
| 
| 
|-
| calling_display_type 
| Q931: 'Display' IE - Display information (present and/or first byte) 
| N/A 
| Q763: 'Display information' IE - present or not 
| N/A 
| 
| 
|-
| calling_presentation 
| Q931: 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: 'Calling party number' IE - address presentation restricted indicator 
|
SIP:From - display-name (displays 'anonymous' or not)

SIP:Remote-party-id - privacy 

| 
| 
|-
| calling_screening 
| Q931: 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: 'Calling party number' IE - screening 
| SIP:Remote-party-id - screen 
| 
| 
|-
| calling_category 
| N/A 
| Call party category (Group A) 
| Q763: 'Calling party's category' IE - calling party's category 
|
SIP:From - cpc

SIP:P-asserted-identity - cpc 

| 
| 
|-
| calling_subscriber
(Generic Number / NDS) 
| Q931: 2nd 'Calling party number' IE - Number digits 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - Number digits 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| Requires option 'support 2 calling number IE' in the profile. This variable has priority over 'private_address' in the outgoing direction. 
| 
|-
| calling_subscriber_noa 
| Q931: 2nd 'Calling party number' IE - Type of number 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - nature of address indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_npi 
| Q931: 2nd 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - numbering plan indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
 
| 
|-
| calling_subscriber_presentation 
| Q931: 2nd 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - presentation restricted indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_screening 
| Q931: 2nd 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - screening 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| private_display 
| Q931: 'Facility CNAM' IE when presentation is restricted for DMS/NI2 variants 
| N/A 
| N/A 
|
SIP:P-asserted-identity - display-name 

SIP:Remote-party-id - display-name 

| 
| 
|-
| private_display_type 
| N/A 
| N/A 
| N/A 
| N/A 
| Indicate presence or not of the private calling information 
| 
|-
| private_address 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 

| For example : The 'fluffy' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - host (domain or IP)

SIP:Remote-party-id - host (domain or IP) 

| For example : The 'telcobridges.com' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| private_address_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - port

SIP:Remote-party-id - port 

| For example : The '6060' in P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| preferred_id_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default P-Preferred-Identity header forwarding behavior from incoming to outgoing leg 
| 
|-
| preferred_id 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - userinfo

| For example : The 'fluffy' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_display_name 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - display name

| For example : The 'Cullen Jennings' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_host 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - host (domain or IP)

| For example : The 'telcobridges.com' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| preferred_id_sip_port 
| N/A 
| N/A 
| N/A 
|
SIP:P-Preferred-Identity - port

| For example : The '6060' in P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called 
| Q931: 'Called party number' IE - Number digits 
| DNIS (Group A) 
| Q763: 'Called party number' IE - address signals 
| SIP:To - user-info and host 
| 
| 
|-
| called_sip_host 
| N/A 
| N/A 
| N/A 
| SIP:To - host 
| For example : The 'telcobridges.com' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com> 
| 
|-
| called_sip_port 
| N/A 
| N/A 
| N/A 
| SIP:To - port number 
| For example : The '6060' in To: "Cullen Jennings" <sip:fluffy@telcobridges.com:6060> 
| 
|-
| called_noa 
| Q931: 'Called party number' IE - Type of number 
| N/A 
| Q763: 'Called party number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| called_npi 
| Q931: 'Called party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Called party number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| charge_number 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - address signals 
| N/A 
| 
| 
|-
| charge_number_noa 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| charge_number_npi 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default redirecting number and original called number forwarding behavior from incoming to outgoing leg 
| 
|-
| redirecting_number 
| Q931: 'Redirecting number' 1st IE - Number digits 
| N/A 
| Q763: 'Redirecting number' IE - address signals 
| SIP:Diversion (2nd header) - display-name 
| 
| 
|-
| redirecting_number_noa 
| Q931: 'Redirecting number' 1st IE - Type of number 
| N/A 
| Q763: 'Redirecting number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| redirecting_number_npi 
| Q931: 'Redirecting number' 1st IE - Numbering plan identification 
| N/A 
| Q763: 'Redirecting number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_presentation 
| Q931: 'Redirecting number' 1st IE - Presentation indicator 
| N/A 
| Q763: 'Redirecting number' IE - address presentation restricted indicator 
| SIP:Diversion (2nd header) - diversion-privacy 
| 
| 
|-
| redirecting_number_indicator 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirecting indicator 
| N/A 
| 
| 
|-
| redirecting_number_reason 
| Q931: 'Redirecting number' 1st IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - redirecting reason 
| SIP:Diversion (2nd header) - diversion-reason 
| 
| 
|-
| redirecting_number_counter 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirection counter 
| SIP:Diversion (2nd header) - diversion-counter 
| 
| 
|-
| original_called_number
(OCN) 
| Q931: 'Redirecting number' 2nd IE - Number digits 
| N/A 
| Q763: 'Redirection number' IE - address signals 
| SIP:Diversion  (1st header) - display-name 
| 
| 
|-
| original_called_number_noa 
| Q931: 'Redirecting number' 2nd IE - Type of number 
| N/A 
| Q763: 'Redirection number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| original_called_number_npi 
| Q931: 'Redirecting number' 2nd IE - Numbering plan identification 
| N/A 
| Q763: 'Redirection number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| original_called_number_presentation 
| Q931: 'Redirecting number' 2nd IE - Presentation indicator 
| N/A 
| Q763: 'Redirection number' IE - address presentation restricted indicator 
| SIP:Diversion (1st header) - diversion-privacy 
| 
| 
|-
| original_called_number_reason 
| Q931: 'Redirecting number' 2nd IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - original redirection reason 
| SIP:Diversion (1st header) - diversion-reason 
| 
| 
|-
| original_called_number_counter 
| N/A 
| N/A 
| N/A 
| SIP:Diversion (1st header) - diversion-counter 
| 
| 
|-
| ported_number_npdi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - with qualifier=Ported number is present 
| SIP:RequestURI - npdi=yes is present 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number 
| N/A 
| N/A 
| Q763: 'Generic number' IE - address signals with qualifier=Ported number 
| SIP:RequestURI - to user part when rn is present 
| rn is stored in the called number 
| 
|-
| ported_number_noa 
| N/A 
| N/A 
| Q763: 'Generic number' IE - nature of address indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number_npi 
| N/A 
| N/A 
| Q763: 'Generic number' IE - numbering plan indicator with qualifier=Ported number 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| oli
(Originating line information) 
| 5ESS Codeset 6 OLI - Value 
| N/A 
| ANSI: 'Originating line information' IE - OLI 
|
SIP:From - oli

SIP:P-asserted-identity - oli 

| 
| 
|-
| request_uri 
| N/A 
| N/A 
| N/A 
| Complete Request URI string 
| 
| 
|-
| request_uri_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default URI forwarding behavior from incoming to outgoing leg 
| 
|-
| sip_header 
| N/A 
| N/A 
| N/A 
| Any header 
| Requires option 'Forward custom headers' in Profiles->SIP 
| 2.7.63 
|-
| nap
(Network Access Point) 
| N/A 
| N/A 
| N/A 
| N/A 
| Incoming leg NAP name (read-only) 
| 
|-
| type_of_network_identification 
| Q931: 'Transit network selection' IE - Type of network identification 
| N/A 
| Q763: 'Transit network selection' IE - Type of network identification 
| N/A 
| 
| 2.7 
|-
| network_identification 
| Q931: 'Transit network selection' IE - Network identification 
| N/A 
| Q763: 'Transit network selection' IE - Network identification 
| SIP: Request-Line - cic 
| 
| 2.7 
|-
| network_identification_plan 
| Q931: 'Transit network selection' IE - Network identification plan 
| N/A 
| Q763: 'Transit network selection' IE - Network identification plan 
| N/A 
| 
| 2.7 
|-
| location_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default location number forwarding behavior from incoming to outgoing leg 
| 2.7 
|-
| location_number 
| N/A 
| N/A 
| Q763: 'Location number' IE - address signals 
| N/A 
| 
| 2.7 
|-
| location_number_noa 
| N/A 
| N/A 
| Q763: 'Location number' IE - nature of address indicator 
| N/A 
| 
| 2.7 
|-
| location_number_npi 
| N/A 
| N/A 
| Q763: 'Location number' IE - numbering plan indicator 
| N/A 
| 
| 2.7 
|-
| location_number_presentation 
| N/A 
| N/A 
| Q763: 'Location number' IE - presentation restricted indicator 
| N/A 
| 
| 2.7 
|-
| location_number_screening 
| N/A 
| N/A 
| Q763: 'Location number' IE - screening 
| N/A 
| 
| 2.7 
|-
| mlpp_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| A script needs to set this to true if it wants to overwrite MLPP information in the outgoing leg. Otherwise, profile relay 'outgoing mode' applies automatically. 
| 2.7 
|-
| mlpp_look_for_busy 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - look ahead for busy 
| N/A 
| 
| 2.7 
|-
| mlpp_precedence_level 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - precedence level 
| SIP:Resource-Priority - q735 
| 
| 2.7 
|-
| mlpp_network_identity 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - network identity 
| N/A 
| 
| 2.7 
|-
| mlpp_service_domain 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - MLPP service domain 
| N/A 
| 
| 2.7 
|-
| isub_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default ISUB forwarding behavior from incoming to outgoing leg 
| 3.0.138 
|-
| called_isub 
| Q931: 'Called party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub parameter 
| 
| 2.7 
|-
| called_isub_type 
| Q931: 'Called party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub-encoding parameter 
| 
| 2.7 
|-
| calling_isub 
| Q931: 'Calling party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub 
| 
| 2.7 
|-
| calling_isub_type 
| Q931: 'Callinf party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub-encoding 
| 
| 2.7 
|-
| ss7_fci_default 
| N/A 
| N/A 
| Default forward call indicator (FCI) value. 
| N/A 
| Toolpack will overwrite FCI bits A, D, F, I and M with appropriate values according to call conditions 
| 2.7 
|-
| ss7_fci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_fci_default that must be forced. 
| N/A 
| Bits from ss7_fci_default which corresponding bit in ss7_fci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| ss7_bci_default 
| N/A 
| N/A 
| Default backward call indicator (BCI) value. 
| N/A 
| Toolpack will overwrite BCI bits AB, I, K, M and N with appropriate values according to call conditions 
| 2.7 
|-
| ss7_bci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_bci_default that must be forced. 
| N/A 
| Bits from ss7_bci_default which corresponding bit in ss7_bci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| tdm_ls_name_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable line service and timeslot selection to create the outgoing leg. tdm_ls_name and tdm_timeslot_nb must be defined along with tdm_ls_name_forward_enabled 
| 3.0 
|-
| tdm_ls_name
(Line Service or T1/E1 trunk) 
| Incoming leg line service name 
| Incoming leg line service name 
| Incoming leg line service name 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this line service name to create outgoing leg 
| 2.7 
|-
| tdm_timeslot_nb 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| N/A 
| if tdm_ls_name_forward_enabled is set, try to use this timeslot number to create outgoing leg 
| 2.7 
|-
| rtp_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP port 
| (read-only) 
| 2.7 
|-
| rtp_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP port 
| (read-only) 
| 2.7 
|-
| ss7_cot_enabled 
| N/A 
| N/A 
| Requests SS7 in-call continuity test for this outgoing SS7 call 
| N/A 
| Toolpack will request a continuity test on the timeslot before making the outgoing call. If COT fails, the call will be dropped (then another route may be attempted) 
| 2.8 
|-
| reverse_charging_indication 
| Incoming leg Reverse charging indication IE present 
| N/A 
| N/A 
| N/A 
| If set in routing script, will add Reverse charging indication IE in outgoing leg (also use reverse_charging_indication_forward_enabled) 
| 2.8.12 
|-
| reverse_charging_indication_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable forwarding of reverse charging indication from incoming to outgoing leg 
| 2.8.12 
|-
| sip_call_id 
| N/A 
| N/A 
| N/A 
| Incoming leg SIP Call-Id 
| (read-only) 
| 2.9.112 / 3.0.131 
|-
| sip_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP port 
| (read-only) 
| 2.8.13 
|-
| sip_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP port 
| (read-only) 
| 2.8.13 
|-
| acli 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - address signals.

A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_noa 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - nature of address indicator.

A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_npi 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - numbering plan indicator.

A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_presentation 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - address presentation restricted indicator.

A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-
| acli_screening 
| N/A 
| N/A 
| 'Additional Calling Party Information' IE - screening indicator.

A new ISUP parameter is defined under national option to carry the actual calling party number of the ported subscriber (N2) in the IAM message across the Network. 
| N/A 
| (read-only) 
| 3.0.143.2 
|-|}

 

=== Noa values ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unknown_number (0x2)</tt>
*<tt>international_number (0x4)</tt>
*<tt>national_number (0x3)</tt>
*<tt>subscriber_number (0x1)</tt>
*<tt>network_specific (0x5)</tt>
*<tt>network_routing_national_format (0x7)</tt>
*<tt>network_routing_international_format (0x8)</tt>
*<tt>abbreviated_number (0x6)</tt>
*<tt>subscriber_number_operator_requested (0x71)</tt>
*<tt>national_number_operator_requested (0x72)</tt>
*<tt>international_number_operator_requested (0x73)</tt>
*<tt>no_number_present_operator_requested (0x74)</tt>
*<tt>no_number_present_cut_through_call_to_carrier (0x75)</tt>
*<tt>test_line_test_code (0x77)</tt>
*<tt>non_unique_subscriber_number (0x71)</tt>
*<tt>non_unique_national_number (0x73)</tt>
*<tt>non_unique_international_number (0x74)</tt>
*<tt>call_950_numbe (0x76)</tt>
*<tt>special_number (0x73)</tt>
*<tt>national_number_with_transit_network_selection (0x74)</tt>
*<tt>international_number_with_transit_network_selection (0x75)</tt>

Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:

*<tt>call_params[:called_noa] = 0x70</tt>

or

*<tt>call_params[:called_noa] = 112</tt>

=== Npi values ===

*<tt>unknown_number</tt>
*<tt>isdn</tt>
*<tt>telephony</tt>
*<tt>private</tt>
*<tt>data</tt>
*<tt>telex</tt>
*<tt>national</tt>

=== Calling Display Type values ===

*<tt>unspecified</tt> => Type is unspecified.
*<tt>calling_party_name</tt> => Type is 0xB1.

Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:

*<tt>call_params[:calling_display_type] = 0xB1</tt>

or

*<tt>call_params[:calling_display_type] = 177</tt>

=== Calling Display value ===

*<tt>call_params[:calling_display] = "Roger Fluffy"</tt>

=== Presentation values for Calling number, Calling Subscriber (Generic Number), Redirecting Number, Original Called Number (OCN) and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>not_available (0x2)</tt>
*<tt>allowed (0x0)</tt>
*<tt>restricted (0x1)</tt>
*<tt>addr_restricted</tt>
*<tt>name_restricted</tt>

=== Calling Party Category ===
The text below represents the value normally used by routing script. 
In case it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 

Mapping from routing script to SS7/CAS R2/SIP
{| cellspacing="1" cellpadding="1" border="1"
|-
! scope="col" | '''Routing Script string '''
! scope="col" | '''SS7 raw value '''
! scope="col" | '''R2 CAS scripts''' 
! scope="col" | '''Default Rx CAS''' 
! scope="col" | '''default Tx CAS''' 
! scope="col" | '''SIP "cpc=" '''
|-
| subscriber 
| 0xa 
| CATEGORY_SUBSCRIBER 
| 1 and 7 
| 7 
| ordinary 
|-
| subscriber_with_priority 
| 0xb 
| CATEGORY_SUBSCRIBER_WITH_PRIORITY 
| 2 and 9 
| 2 
| priority 
|-
| operator_french 
| 0x1 
| CATEGORY_OPERATOR_FRENCH 
| 5 
| 5 
| operator 
|-
| operator_english 
| 0x2 
| CATEGORY_OPERATOR_ENGLISH (5) 
| 5 
| 5 
| operator 
|-
| operator_german 
| 0x3 
| CATEGORY_OPERATOR_GERMAN (5) 
| 5 
| 5 
| operator 
|-
| operator_russian 
| 0x4 
| CATEGORY_OPERATOR_RUSSIAN (5) 
| 5 
| 5 
| operator 
|-
| operator_spanish 
| 0x5 
| CATEGORY_OPERATOR_SPANISH (5) 
| 5 
| 5 
| operator 
|-
| data 
| 0xc 
| CATEGORY_DATA 
| 6 and 8 
| 6 
| datacall 
|-
| test 
| 0xd 
| CATEGORY_TEST 
| 3 
| 3 
| test 
|-
| payphone 
| 0xf 
| CATEGORY_PAYPHONE 
| none 
| 7 
| payphone 
|-
| unknown 
| 0x0 
| CATEGORY_UNKNOWN 
| 4, 11 to 15 
| 7 
| unknown 
|-
| unspecified 
| 0xa 
| invalid 
| none 
| none 
| invalid 
|}
[[CAS_R2_scripting#Category_meanings|Link to calling party categories used in CAS R2 scripts]]

=== Screening values for Calling number, Calling Subscriber (Generic Number), and Location Number ===
The text below represents the value normally used by routing script. 
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message. 
Example numeric values for the SS7 protocol are shown in parenthesis. 
 
*<tt>unspecified</tt>
*<tt>no (0x0)</tt>
*<tt>pass (0x1)</tt>
*<tt>fail (0x2)</tt>
*<tt>network_provided (0x3)</tt>

=== Redirecting indicator values ===

SS7:

*<tt>no_redirection</tt>
*<tt>call_rerouted</tt>
*<tt>call_rerouted_all_restricted</tt>
*<tt>call_diverted</tt>
*<tt>call_diverted_all_restricted</tt>
*<tt>call_rerouted_restricted</tt>
*<tt>call_diverted_restricted</tt>
*<tt>spare</tt>

=== Redirecting number, Original Called Number and Diversion Reason ===

ISDN:

*<tt>unknown</tt>
*<tt>busy</tt>
*<tt>no_reply</tt>
*<tt>deflection</tt>
*<tt>dte_out_of_order</tt>
*<tt>forwarding_by_called_dte</tt>
*<tt>unconditional</tt>

SS7:

*<tt>unknown</tt>
*<tt>busy (SIP: user-busy)</tt>
*<tt>no_reply (SIP: no-answer)</tt>
*<tt>unconditional</tt>
*<tt>deflection</tt>
*<tt>deflection_immediate</tt>
*<tt>mobile_not_reachable</tt>

=== OLI (originating line information) values ===

The OLI parameter is a string that represents an integer value from 0 to 255.

=== Information Transfer Capability values ===

information_transfer_capability:

*<tt>digital</tt>
*<tt>restricted_digital</tt>
*<tt>digital_with_tones</tt>
*<tt>speech</tt>
*<tt>3_1_khz_audio</tt>
*<tt>video</tt>

=== redirecting_number_forward_enabled values ===

Controls forwarding or discarding of redirecting number (SIP: diversion header) to the outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
*0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg
*1/true: Redirecting number (and original called number) is forwarded to outgoing call leg

The value for this parameter at the input of the routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

Note: To "insert" a new redirecting number value on the outgoing leg, redirecting_number_forward_enabled must also be set to true.

=== request_uri ===

Enables access to the Request-Line URI. 

For example, if the Request-Line is:
<pre>Request-Line: INVITE sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0</pre>
Then the retrieved request_uri will be "sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0". 

In the routing scripts, to retrieve only the called number, this script can be used: 
<pre> if call_params[:request_uri] && call_params[:request_uri] =~ /sip:(.*)@.*/
call_params[:called] = $1
end
</pre>
==== request_uri_forward_enabled ====

This call parameter controls forwarding or discarding of request uri to outgoing call leg.The request uri is the information in the "Request-Line:" of the SIP INVITE message. 

Values for this parameter are "0", "1", "false" or "true. 

* 0/false: Request uri is not forwarded to outgoing call leg 

* 1/true: Request uri is forwarded to outgoing call leg 

The default value for this parameters is false. 

==== sip_scheme ====
(Available in Toolpack 3.1+)
This call parameters indicates the scheme (generally "sip" or "sips") of the incoming call.

This also allows to control the scheme used for the outgoing call (regardless if request_uri_forward_enabled is used or not)

Note: sips scheme must only be used on TLS NAPs (will cause call routing failure if NAP has only UDP or TCP transport types).

=== sip_header values ===
Contains custom sip headers from the inbound call leg. Any custom sip header can be added to an outgoing call leg: 

'''Note:'''

The SIP header is in string format.

'''string format:'''
<pre>call[ :sip_header ] = "P-my-custom-header:value1 \nP-my-custom-header2:value2 \nP-my-custom-header3:value3"
</pre>
(Note: \n above are actual newline characters, not '\' followed by 'n')

* PCAP sample: [[File:TB_Custom_SIP_Headers.pcap]]

List of sip headers that will not appear in call[:sip_header] since they are already processed by the SIP stack:
<pre>
Accept Error-Info Remote-Party-ID
Accept-Contact Event Replaces
Accept-Encoding Expires Reply-To
Accept-Language From Request-Disposition
Alert-Info In-Reply-To Subject
Allow Max-Forwards Subscription-State
Allow-Events MIME-version Supported
Also Min-Expires Timestamp
Anonymity Min-SE To
Authorization Organization Unsupported
Authentication-Info Path User-Agent
Call-ID Priority Via
Call-Info Privacy Warning
Contact Proxy-Authenticate WWW-Authenticate
Content-Disposition Proxy-Authorization Require
Content-Encoding Proxy-Require Response-Key
Content-Language P-Media-Authorization Retry-After
Content-Length P-Preferred-Identity RPID-Privacy
Content-Type P-Asserted-Identity Route
CSeq RAck RSeq
RAck Reason Security-Client
Reason Record-Route Security-Server
Date Refer-To Security-Verify
Diversion Referred-By Server
Encryption Reject-Contact Service-Route
Session-Expires
</pre>

=== sip header parameters ===
The routing script can read (and modify) some SIP header parameters (user parameters, URI parameters or header parameters) from some SIP headers (To, From, P-Asserted-Identity, Remote-Party-ID, Contact).

==== Available parameters ====
* '''call[ :calling_parameters ]''' (SIP "From" header)
* '''call[ :called_parameters ]''' (SIP "To" header)
* '''call[ :private_address_parameters ]''' (SIP "P-Asserted-Identity" or "Remote-Party-ID" header)
* '''call[ :preferred_id_parameters ]''' (SIP "P-Preferred-Identity" header)
* '''call[ :contact_parameters ]''' (SIP "Contact" header)

These parameters (if present) contain a hash with 3 keys: user_param, uri_param and header_param.
Each of this key points to a string that contains all the parameters found in the corresponding SIP header.
* '''User parameters''' (parameters between the user name/number and the host). Example <sip:alice;'''param=value'''@somewhere.com>
* '''URI parameters''' (parameters at the end of the URI). Example <sip:alice@somewhere.com;'''param=value'''>
* '''Header parameters''' (outside the URI). Example <sip:alice@somewhere.com>;'''param=value'''
Example to print all parameters of SIP "To" header:
call[ :called_parameters ].inspect -> '{ :user_param => "name1=value1;name2=value2", :uri_param => "name=value", :header_param => "name=value;example_param_without_value" }'
Example to modify (replace) the URI parameters of SIP "To" header:
call[ :called_parameters ][ :uri_param ] = "user=phone"

==== Exceptions ====
'''Note:''' Some parameters are reported as their own call attribute (oli, isub, cpc, transport) so they have the same representation for all protocols (SS7, IDSN, SIP). They won't appear present in the generic SIP header parameters structures above.

==== Forwarding from inbound to outbound call ====

==== Legacy behavior ====
(For base_routing version 1.32 or older)
By default, the parameters are not forwarded in a SIP to SIP call flow. The parameters '''will be forwarded''' when:
* accessed (read) from either the inbound or outbound call parameters
* written in either the inbound or outbound call parameters

==== Current behavior ====
(For Toolpack 3.0.118+, with base_routing version 1.33+)
SIP headers host and parameters are forwarded by default.

A route attribute "forward_sip_domain" (along with filter script "forward_sip_domain.rb") will control, per route, if SIP headers host+parameters must be forwarded.

==== Example usage ====
Example to print the user parameters:
<pre>
if call[:calling_parameters]
puts "user parameters = #{call[:calling_parameters][:user_param].inspect}"
end
</pre>

Example SIP "From" header:
From:<sip:123456782;test1=val1;test2=val2@something.com;test3=val3;test4=val4>;test5=val5;test6=val6
And the resulting content in the routing script:
call[:calling_parameters].inspect -> {:user_param=>"test1=val1;test2=val2", :uri_param=>"test3=val3;test4=val4", :header_param=>"test5=val5;test6=val6"}

Example to overwrite inbound leg calling parameters with new parameters for the outbound leg:
<pre>
call [:calling_parameters] = {
:user_param => "user_param7=7;user_param8=8",
:uri_param => "uri_param9=value9",
:header_param => "header_paramA=A" }
</pre>

Example to add user=phone and keep all other uri parameters.
<pre>
call[:calling_parameters] ||= {} # Create a hash if not already present
call[:calling_parameters][:uri_param] ||= "" # Create a string if not already present
call[:calling_parameters][:uri_param] += ";" if call[:calling_parameters][:uri_param] != ""
call[:calling_parameters][:uri_param] += "user=phone"
</pre>

=== MLPP Precedence values ===

mlpp_look_for_busy:

*<tt>allowed</tt>
*<tt>path_reserved</tt>
*<tt>not_allowed</tt>

mlpp_precedence_level:

*<tt>flash_override</tt>
*<tt>flash</tt>
*<tt>immediate</tt>
*<tt>priority</tt>
*<tt>routine</tt>

mlpp_network_identity:

3 digits value from 0 to 999

mlpp_service_domain:

24 bits value from 0 to 16777215

=== ISUB subaddress information values ===

called_isub_type:
calling_isub_type:

*<tt>nsap</tt>
*<tt>nsap_ia5</tt>
*<tt>nsap_bcd</tt>
*<tt>user</tt>

called_isub:
calling_isub:

Digits for the subaddress information.

=== Network Identification Plan ===

network_identification_plan:

*<tt>Unknown</tt> (value 0)
*<tt>cic</tt> (3 digits carrier identification code plus circuit code, value 1, SS7 or ISDN)
*<tt>user</tt> (User, value 2, ISDN only)
*<tt>cic4</tt> (4 digits carrier identification code plus circuit code, value 2, SS7 only)
*<tt>dnic</tt> (public Data Network ID, value 3, SS7 only)
*<tt>mnic</tt> (public land mobile network, value 6, SS7 only)

=== Registered Users Information ===
Routing script can access information about registered users (when either the calling or called user is a known registered user).
When these fields are empty, it means that the calling/called (SIP from/to) does not correspond to a known registered user (routing script may still decide to route the call based on static routes).

Information for the called user:
params[:registered_user]
Information for the calling user:
params[:calling_registered_user]

These parameters are a hash of key/values that provide information about the contact.
{
:contact_list=>
[
{
:contact=>"<sip:user_name_or_number@hostname:7070;transport=UDP>", -> Full contact
:expires=>"60", -> Contact expiry time (seconds)
:host=>"hostname", -> host name from the contact header
:name=>"user_name_or_number", -> user name from the contact header
:nap_in=>"NAP_NAME", -> NAP that the contact has registered from
:port=>"7070", -> Port from the contact header
:transport=>"UDP" -> Transport type from the contact header
:q_value=>"0.00", -> Q-value for the contact (for contact ordering)
:src_host=>"10.0.0.10", -> Actual source IP address that the contact has registered from
:src_port=>"7070", -> Actual source port that the contact has registered from
:src_transport=>"UDP", -> Actual protocol that the contact has been registering with
}
]
}

== Route parameters ==

All route may have these parameters:

*calling
*called
*nap
*remapped_calling
*remapped_called
*remapped_nap
*remapped_destination_leg_profile (called remapped_profile prior to Toolpack 2.9)
*remapped_source_leg_profile (called remapped_incoming_profile prior to Toolpack 2.9)

Example:

route[:remapped_nap]

Additionally it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.
For example:
*priority
*weight

== Routing calls toward registered users ==
Static routes normally chose an outbound NAP to forward the call to.

But it's also possible to create routes which outbound NAP is dynamically chosen by matching a registered user (when using [[Sip_registration_forwarding|SIP registration forwarding]]).

More information can be found [[Sip_registration_forwarding#SIP_Calls_routing|here]] about the way to control the [[Sip_registration_forwarding#SIP_Calls_routing|priority of "dynamic" vs "static" routes]].

More information can be found [[#Registered_Users_Information|here]] about using routing scripts to access registered users information during call routing.

== Playing prompts announcements or tones ==

New feature in release 2.6, all bridges may have these parameters. These can be used to play IVR prompts (audio files) in different states of the call flow.

*'''announcement_tone''' (played before outgoing call is routed)
*'''ring_tone''' (played after when waiting for outgoing call to answer)
*'''busy_tone''' (played if outgoing call failed)
*'''disconnect_tone''' (played after the call has reached it's maximum duration)

Example to play an announcement to incoming call (before routing outgoing call, regardless if a matching route is found or not):
bridge[:announcement_tone ] = "my_announcement.wav"

Example to play a ring-tone while the outgoing call is ringing:
bridge[:ring_tone] = "my_ring_tone.wav"

Example to play an audio file when outgoing call fails (no route, or outgoing call is refused):
bridge[:busy_tone] = "my_busy_tone.wav"

Example to play an audio file when call has reached the maximum allowed duration:
bridge[:disconnect_tone] = "your_account_balance_is_empty.wav"

=== Announcement file path format and options ===

All file plabyacks (:announcement_tone, :busy_tone, :ring_tone, :disconnect_tone) inside bridge parameters use this format.
<pre>"file1.wav:repeat:start_off:end_off,file2.wav:repeat:start_off:end_off,file3.wav:repeat:start_off:end_off"
</pre>
Optional parameters:
* repeat: number of times to play the file (0 and 1 have the same result)
* start_off: Start offset in milliseconds
* end_off: End offset in milliseconds

Http and other path formats are described here: [[Customer_application_framework:play_audio_files#Play_path_format|Path format]]

==== Example 1 ====
The following example will play file1.wav once, and then play file2.wav in loop:
"file1.wav,file2.wav:-1"

==== Example 2 ====
The following example will play file1.wav from start offset of 1 second to end offset of 3 seconds, then twice file2.wav from second 5 to second 10.
"file1.wav:0:1000:3000,file2.wav:2:5000:10000"

==== Example 3 ====
The following example will play file1.wav once, ending at offset of 30 seconds.
"file1.wav:0:0:30000"

=== announcement_tone ===

params[:bridge][:announcement_tone] = "announcement.wav"

Audio file played on the incoming call before any outgoing call is placed. The outgoing call occurs when the file finished playing.

==== announcement_tone options ====
===== announcement_tone_answer =====
params[:bridge][:announcement_tone_answer] = "yes"

Forces an answer of the call before playing the announcement. Default if argument not provided is "no", in which case call is only alerted with in-band media.

===== announcement_code_detect =====
This option allows that the tone detection is enabled during the announcement play.

Collected digits can be inserted into the CDR logs (radius attribute "Telcob-CollectedDigits", or text CDR variable @{CollectedDigits}).

Collected digits can also be sent back to routing script, which is called again with the same call attributes, except that the called number is replaced by the collected digits.

Code detect has multiple options, as shown in the following code:
code_detect = {
:type => :DTMF, # :DTMF or :MFR1 tone detection.
# Default is MFR1.
:prefix => "", # Prefix (digits) that is removed from collected digits.
# Default is empty.
:suffix => "", # Suffix (digits) that is removed from collected digits
# and causes routing script to be immediately called.
# Default is empty.
:suffix_removal => false, # Controls the removal of the suffix from the collected digit string that's reported to routing script.
# Default is false
:timeout => 0, # Inter-digit timeout (ms) after which collected digits are passed to the routing script.
# Use 0 for "no timeout".
# Default is 1000ms
:barge_in_interruption => true, # When enabled, playing announcement is stopped as soon as first digit is collected.
# Default is true.
:proceed_on_play_done => false, # When true: Outgoing call is made after announcement finishes playing.
# Routing script is not called again.
# When false: Outgoing call is never made.
# Digits are collected until timeout or suffix match,
# then routing script is called again.
# Default is false.
:cas_on_hook => false, # Specific for CAS-R1 calls. Makes CAS bits switch to "on-hook" when announcement finished playing
# (but the call is not "terminated" from Toolpack point of view)
# Default is false.
:cas_on_hook_delay => 0, # Duration of cas bits "on-hook" state.
# Only effective if cas_on_hook is set to true.
# Value of 0 stands for "infinite delay".
# Default is 0.
:repeat_delay => 0, # Delay between repetition of the announcement. The announcement will repeat
# itself every "repeat_delay" until a code is detected (suffix match or timetout).
# Value of 0 stands for "infinite delay" (no repeating).
# Default is 0.
}
'''Example 1''': Collect DTMF digits, and call routing script again with collected digits upon timeout or suffix match.
code_detect = { :type => :DTMF, :suffix => "#", :timeout => 5000 }
params[:bridge][:announcement_code_detect] = code_detect

'''Example 2''': Collect digits during the announcement (for CDR logs), then proceed (make outgoing call) after announcement finishes playing
code_detect = { :type => :DTMF, :timeout => 0, :barge_in_interruption => false, :proceed_on_play_done => true }
params[:bridge][:announcement_code_detect] = code_detect

==== Controlling what happens after announcement ====
The routing script can control what happens with the call after the announcement finishes playing:
* An outgoing call is made
* Incoming call is hung-up
* Do nothing (wait for the incoming call to hang-up)
===== An outgoing call is made =====
This happens when the script has returned matching routes (and did not raise RoutingException)

===== Incoming call is hung-up =====
This happens when the script returns no routes (in which case base_routing will raise RoutingException with cause :no_route).

It also happens when the script explicitly raises RoutingException.

The incoming call will be terminated with the specified cause.
For example
raise RoutingException, :temporary_failure
(See "Reason values" section in this page for list of available causes)

===== Do nothing (wait for the incoming call to hang-up) =====
If a filter raises RoutingException with code :ok, then the incoming call will not be terminated at the end of the announcement play.
Announcement digit collection will remain active if appropriate.
For example:
raise RoutingException, :ok

=== ring_tone ===
params[:bridge][:ring_tone] = "ringing.wav"

Audio file played on the incoming call while waiting for the outgoing call to be answered.

Ring tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:ring_tone] will override the profile's ring tone behavior).

==== ring_tone options ====
===== ring_tone_state =====
params[:bridge][:ring_tone_state] = :alerted

Call state from which ring tone is being played. Available values are:
* '''immediately''': Ring tone starts playing immediately on the incoming leg
* '''accepted''': Ring tone starts playing as soon as outgoing call is accepted
* '''callprogress''': Ring tone starts playing as soon as "call progress" is received on the outgoing call
* '''alerted''' (default): Ring tone starts playing only once outgoing call is alerted (but won't play if alert indicates early media from outgoing call)

This option also apply when params[:bridge][:ring_tone] is not used, because it also apply to ring tone playback configured in the Web Portal, from the incoming call's profile.

=== busy_tone ===
Toolpack 2.8 and above:
params[:bridge][:busy_tone] = "no_route.wav"

Note: Obsolete name (toolpack 2.7.153 and earlier, but still supported in recent releases):
params[:bridge][:call_progress_tone] = "no_route.wav"

Audio file played on the incoming call when outgoing call fails (never answered).

Note that announcement_tone, if used, is played before the outgoing call attempt is made, and thus before the busy_tone.

Busy tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:busy_tone] will override the profile's busy tone behavior).

Special value '''"none"''' can be used by routing script to force playing nothing (as empty string would default to profile's behavior)

==== busy_tone options ====
===== busy_tone_answer =====
params[:bridge][:busy_tone_answer] = "yes"

Forces an answer of the call before playing the busy tone. Default if argument not provided is "no", in which case call is only alerted with in-band media.

=== disconnect_tone ===
params[:bridge][:disconnect_tone] = "max_duration.wav"

Audio file played on the incoming call when call duration (:max_call_duration) is reached. Then the leg will be terminated with specified reason (:call_duration_reason).

==== disconnect_tone options ====
===== max_call_duration =====
params[:bridge][:max_call_duration] = "60000"

Maximum call duration in millisecond. This timer is started when entering answer state.

===== call_duration_reason =====
params[:bridge][:call_duration_reason] = :resource_unavailable

Drop both legs with this reason when call duration (:max_call_duration) is reached.

=== Managing audio prompts through Web Portal ===
Audio prompts can be uploaded or deleted from the TMedia unit through the Web Portal:
[[Toolpack:Configuring_Audio_Prompts_A|Managing audio prompts]]

Prompts management must be done using the Web Portal of the primary server (in systems with redundant TMedia units or redundant host servers).
The file will automatically get replicated to the secondary server.

=== Managing audio prompts manually ===
Any file on the TMedia host file system can be played. This means it's possible to manage prompts through ssh/scp.

==== The default (replicated) prompts folder ====
By default, when playing a prompt, Toolpack will look in the default prompts folder:
/lib/tb/toolpack/pkg/prompts
The root of this "prompts" directory is automatically replicated to secondary unit of redundant setups (1+1, N+1, redundant hosts). Sub-folders won't be replicated.

Any prompt play request without explicit file path will map to this folder. For example:
params[:bridge][:busy_tone] = "no_route.wav"
This will correspond to file /lib/tb/toolpack/pkg/prompts/no_route.wav

==== Relative file paths ====
Any file path that begins with "file://" is considered relative to the tbstreamserver application's working directory:
/lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/
(Where "2.8" may be replaced by the current major version of your system)

For example:
params[:bridge][:busy_tone] = "file://my_folder/no_route.wav"
This will correspond to file /lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/my_folder/no_route.wav

==== Absolute file paths ====
Absolute paths can also be provided.
For example:
params[:bridge][:busy_tone] = "file:///root/my_folder/no_route.wav"
This will correspond to file /root/my_folder/no_route.wav

== Recording call legs ==
Introduced in release 2.6.44, it's now possible to use routing scripts to ask for recording incoming and/or outgoing call legs.

See example filter script "call_recording" (created by default in Web Portal routing scripts starting with 2.6.44) for an example.

=== Recording the incoming call leg ===
To record the incoming call leg, the routing script (in a "after filter" for example) has to set the following parameter:

bridge[ :record_incoming ] = ""

=== Recording the outgoing call leg ===
To record the outgoing call leg, the routing script (in a "after filter" for example) has to set the following parameter, per route (the decision to record or not, or the file name to record to, can be set per matching route):

# Need to clone the routes in order to have the right to modify them
routes = clone_routes params[:routes]
routes.each do |route|
route[ :record_outgoing ] = ""
end
# Store modified routes back to the parameters for this outgoing call
params[:routes] = routes

=== Record the outgoing call leg within incoming leg's recorded file (mixing) ===
[...]
route[ :record_outgoing ] = "@{MixWithIncoming}"
[...]

=== Choosing file path to record to ===
The value assigned to ":record_incoming" or ":record_outgoing" is the path to record the file to.

The paths can be absolute, or relative. When relative, they are relative to the "tbstreamserver" application working directory, for example:
/lib/tb/toolpack/setup/12358/2.7/apps/tbstreamserver/

* Empty file name will default to a name that contains various information about the call:
** ''LinkId'': Id common between all legs of this call bridge
** ''LegId'': Unique Id for this leg
** ''Nap'': Current NAP name this call leg is from
** ''Direction'': "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
** ''Calling'': The calling number of this call leg
** ''Called'': The called number of this call leg
** ''Protocol'': The signaling protocol of this call leg (SS7, ISDN, CAS, SIP)
** ''Media info'': Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
* To record outgoing call leg in the same audio file as incoming call leg (mixing), use the following:
** @{MixWithIncoming}: Record outgoing legs in same file as incoming legs
* Variables can be used to insert in the recording path information that's not already available from routing scripts:
** @{CURRENT_PKG}: Version of current package
*** Example: 2.6.45
** @{DATE format}: Prints the date, where 'format' is expressed as described for the 'strftime' function
*** Example: @{DATE %Y-%m-%d} => 2013-01-28
** @{DefaultName}: Replaced by the default file name for recording, which contains:
*** LinkId: Id common between all legs of this call bridge
*** LegId: Unique Id for this leg
*** Nap: Current NAP name this call leg is from
*** Direction: "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
*** Calling: Calling number
*** Called: Called number
*** Protocol: Protocol type of this call (SS7, ISDN, CASR2, SIP)
*** Media info: Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
*** Example: "73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{DefaultPath}: Default recording folder and file name: "@{RECORD_PATH}/@{DATE %Y-%m-%d}/@{DefaultName}"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{Direction}: Direction of current leg (IN our OUT)
*** Example: IN
** @{LegId}: Current LegId (Unique Id for this leg)
*** Example: F3D67B4B
** @{LinkId}: Current LinkId (Id common between all legs of this call bridge)
*** Example: 73EBA698
** @{PKG_HOME}: Path where packages are stored.
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg
** @{PROMPT_PATH}: Default path where audio prompts are stored
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg/prompts
** @{Protocol}: Protocol of current leg
*** Example: SS7
** @{RECORD_PATH}: Default recording folder: "@{TB_SETUP_HOME}/recorded_calls/"
** @{TBX_GW_PORT}: Current "System Id" (also called "Gateway Port")
*** Example: 12358
** And all variables listed here: [[Customer_application_framework:play_audio_files#Helpful_variables_to_build_play_or_record_file_paths|Building play or record file path]]

== Controlling UUI (user-to-user information) relay ==
UUI (user-to-user information) can be present in different messages received by either call leg during a call. For example, information can be carried during the initial invite, other information can be carried when the call is alerted, answered, or terminated.

Routing scripts can control if the UUI received from one leg through the call will be forwarded to the other call leg:
*uui_forward_enabled

Routing scripts can also read and modify the UUI received with the incoming call leg, before it gets forwarded upon creation of the outgoing call leg:
*uui

=== UUI (user-to-user indication) values ===

Byte array represented as ruby String. Use ''bridge=params[:bridge]'', then ''bridge[:uui]'' to access the data.

To access the bytes in Ruby, use ruby String operator []. For example: bridge[:uui][0] will return the binary value of the first UUI byte.

Function each_byte can also be useful to iterate through all bytes of the UUI.

=== uui_forward_enabled values ===

Controls forwarding or discarding of UUI to outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
* 0/false: UUI is not forwarded between call legs
* 1/true: UUI is forwarded between call legs

The value for this parameter at input of routing script depends on the "Forward UUI" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

== Authorization ==
Starting with release 2.7, it is possible to issue RADIUS authorization requests from routing scripts. To do so, the params[:authorization] object must be filled with the required RADIUS attributes and [[#Refuse|an exception must be raised]] with reason :authorization_required.

When the authorization is completed, the routing script is called again with the result. The params[:authorization] object will be filled with the RADIUS attributes from the response. The params[:authorization][:result] field will also contain a string indicating the result of the authorization:

* ''accept'': The authorization was successful.
* ''reject'': The authorization was refused.
* ''challenge'': The authorization was challenged.
* ''timeout'': The authorization was not answered.

== Call diversion options ==
It's possible to control the call flow when a call diversion information is received in the alerting state.

Two fields are available: bridge[ :diversion ] and bridge[ :diversion_reason ]

The internal release cause TOOLPACK_DIVERT_NOT_ALLOWED is used by gateway application to terminate both legs.

bridge[ :diversion ] = :allowed
The alert message will not be analyzed and the call will be progressed. Default behavior.
bridge[ :diversion ] = :not_allowed
If the alert message indicates that the call is diverted, the call will be released no matter the In-band information to allow
early media.
bridge[ :diversion ] = :not_allowed_w_early_media
The call will be released If the alert message indicates that the call is diverted with in-band information to allow early media.
bridge[ :diversion_reason ] = "*"
If the diversion is not allowed, the gateway will drop the call for any redirecting reason.
bridge[ :diversion_reason ] = "0,1,2"
or
bridge[ :diversion_reason ] = "unknown,busy,no_reply"
If the diversion is not allowed, the redirecting reason will be analyzed and the call will only be dropped for the configured cases.

See section [[Routing_script_tutorial:Mini_Development_Guide#Redirecting_number,_Original_Called_Number_and_Diversion_Reason|Redirecting number reason values]].

== Call transfer requests ==
Toolpack allows that [[Call transfer]] requests are relayed from one leg to the other, or to process them locally (making another outgoing call to replace the call that requested the call transfer).

If the chosen [[Call transfer]] mode is to process requests locally, upon reception of a call transfer request (SIP REFER or ISDN Facility), routing script will be called once again, to select the routes for the new outgoing call (call transfer target).

=== How to route call transfer request ===
Routing of a call transfer request is done exactly like routing of a normal incoming call.
The routing script generally does not need any modification to support that.

In some cases, the routing script may want to use information related to the transfer request to perform routing, or to insert information in the outgoing call leg.
Additional information is provided to the routing script, allowing routing decisions using information from the call transfer request (SIP REFER or ISDN Facility).
See below...

=== params[ :call ] content during transfer request ===
When processing a call transfer request, the params[ :call ] hash contains the information from the inbound call (same as was passed to the routing script upon arrival of the inbound call)
call = params[ :call ] -> Information from original inbound call, with exception of call[ :called ]

One exception (convenient because it allows a unmodified routing script to process call transfer request the same way as any other routing request):
call[ :called ] -> Replaced by the called number from the call transfer request (also called "redirection number")
Complementary information:
call[ :original_called_number ] -> Contains the called number that was initially received from the incoming call, prior to call transfer request
call[ :redirecting_number ] -> Number of the call from which the call transfer request was received (generally equals to original_called_number)

These fields will also be included in the outgoing call made after routing:
* original called number and redirecting number are existing fields on SS7 and ISDN calls
* SIP "diversion" header is used for SIP calls

=== params[ :transfer ] content ===
(this if valid only for release 2.7.102 and above) 
When processing a call transfer request, information from the call transfer request message (SIP REFER, ISDN Facility) is provided in params[ :transfer ]:
transfer = params[ :transfer ]
The following field is always present:
transfer[ :original_nap ] -> Contains the NAP of the first call from which a call transfer request was received
transfer[ :redirecting_nap ] -> Contains the NAP of the call from which the current call transfer request was received
(same as :original_nap for the first call transfer, different for subsequent transfers)
Examples of other fields that may be present, when appropriate:
transfer[ :uui ] -> The UUI (user-to-user information) found in the call transfer request
transfer[ :sip_header ] -> Contains custom SIP headers from the call transfer request
transfer[ :request_uri ] -> Contains the SIP Request URI

These fields are 'read-only'. They will not be included in the outgoing call, as they represent the contents of the call transfer request, and not the outgoing call to be made.

To insert/modify attributes of the outgoing call, the parameters from params[ :call ] must be edited instead.

== Redirection ==
In release 2.8 and above, redirection contacts are obtained from the routing engine in the following format:

contacts = params[ :contacts ]
contacts = {
:index=>"3",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"", :raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127", :raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
{:called_number=>"6662", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6662@192.168.215.128", :raw_data=>"<sip:6662@192.168.215.128>", :expiration=>"3600"},
{:called_number=>"6663", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6663@192.168.215.129", :raw_data=>"<sip:6663@192.168.215.129>", :expiration=>"3600"},
{:called_number=>"6664", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6664@192.168.215.150", :raw_data=>"<sip:6664@192.168.215.150>", :expiration=>"3600"}
],
:source_indexes=>"nil,0,0,0,2"
}

* <code>params[:contacts][:list]</code> contains the contact log. Each contact within the list has the following fields:
** <code>:called_number</code> - the called number
** <code>:is_number_ported</code> - if the called number has been ported (for SIP: if the npdi parameter is present)
** <code>:ported_number</code> - the called number that was ported (for SIP: the rn parameter value, if available)
** <code>:sip_uri</code> - the SIP URI of the contact, without the contact-params section (without the expires and q contact parameters)
** <code>:raw_data</code> - the raw data representing the contact in the signaling protocol. For SIP, this is the full SIP URI (including the expires and q contact parameters).
** <code>:priority</code> - the priority of the contact [0-1000]
** <code>:expiration</code> - the expiration time in seconds of the contact
* <code>params[:contacts][:index]</code> contains the index of the contact that is currently being routed.
* <code>params[:contacts][:source_indexes]</code> contains a comma-separated list of indexes from <code>params[:contacts][:list]</code>. Each index represents the contact from which the contact in the list was obtained from.

To get more information, see:
*[[Routing_script_tutorial:SIP_Redirection_Contacts|SIP Redirection Contacts Parameters in a Call Flow]]

== Connected number ==
Insert a connected number in the answer message of the call flow.

Routing script example:
bridge = params[ :bridge ]
bridge [ :connected_number ] = "3335577"
bridge [ :connected_number_noa ] = :national_number
bridge [ :connected_number_npi ] = :private
bridge [ :connected_number_presentation ] = :allowed
bridge [ :connected_number_screening ] = :pass

== Terminating calls ==
In release 2.8, it is now possible to terminate a call through the routing scripts. The [[#Reason values|reason code]] must be specified in <code>params[:bridge][:reason]</code>. The <code>:terminate</code> hash must be created and copied into <code>params</code>:
terminate = {}
params[:terminate] = terminate
The following fields can then be set in <code>:terminate</code>:
* <code>:sip_header</code>
* <code>:contacts</code> # list of contacts as described in the [[#Redirection|redirection]] section
* <code>:isup_raw</code>
* <code>:isup_raw_variant</code>
* <code>:redirecting_number</code>
* <code>:redirecting_number_noa</code>
* <code>:redirecting_number_npi</code>
* <code>:redirecting_number_presentation</code>
* <code>:redirecting_number_reason</code>
* <code>:redirecting_number_counter</code>
* <code>:redirecting_number_indicator</code>
* <code>:original_called_number</code>
* <code>:original_called_number_noa</code>
* <code>:original_called_number_npi</code>
* <code>:original_called_number_presentation</code>
* <code>:original_called_number_reason</code>
* <code>:original_called_number_counter</code>

== Reason values ==

Check here for Termination Reason Cause codes: 

[[Termination_cause_codes|Termination Reason Cause codes]]
 

Example to refuse an incoming call leg.
raise RoutingException, :no_route

Reason cause strings available inside routing scripts:

List of Q.850 reason causes:
:unallocated_number
:no_route_to_network
:no_route_to_destination
:send_special_tone
:misdialled_trunk_prefix
:channel_unacceptable
:call_awarded_in_established_channel
:preemption
:reattempt
:qor_ported_number
:normal_call_clearing
:user_busy
:no_user_responding
:no_answer_from_user
:subscriber_absent
:call_rejected
:number_changed
:redirection
:exchange_routing_error
:non_selected_user_clearing
:destination_out_of_order
:address_incomplete
:facility_rejected
:response_to_status_enquiry
:normal_unspecified
:no_circuit_available
:network_out_of_order
:frame_mode_out_of_service
:frame_mode_connection_operational
:temporary_failure
:switching_equipment_congestion
:access_information_discarded
:requested_circuit_not_available
:precedence_call_blocked
:resource_unavailable
:quality_of_service_not_available
:requested_facility_not_subscribed
:outgoing_calls_barred
:outgoing_calls_barred_within_cug
:incoming_calls_barred
:incoming_calls_barred_within_cug
:bearer_cap_not_authorized
:bearer_cap_not_available
:inconsistency_access_info
:service_not_available
:bearer_cap_not_implemented
:channel_type_not_implemented
:requested_facility_not_implemented
:only_restricted_digital_info
:service_not_implemented
:invalid_call_reference
:channel_does_not_exist
:call_identity_does_not_exist
:call_identity_in_use
:no_call_suspended
:call_has_been_cleared
:user_not_member_of_cug
:incompatible_destination
:non_existant_cug
:invalid_transit_network
:invalid_message_unspecified
:mandatory_ie_missing
:message_type_non_existent
:message_not_compatible_with_call_state
:ie_non_existent
:invalid_ie_content
:msg_not_compatible_with_call_state
:recovery_on_timer_expiry
:parameter_non_existent_passed_on
:message_with_non_recognized_parameters_discarded
:protocol_error
:interworking_unspecified

List of toolpack reason causes:

:toolpack_normal or :normal
:toolpack_resource_error or :resource_error
:toolpack_timeout or :timeout
:toolpack_no_route or :no_route
:toolpack_call_collision or :call_collision
:toolpack_sync_drop or :sync_drop
:toolpack_signaling_error or :signaling_error
:toolpack_locally_rejected or :locally_rejected
:toolpack_interface_not_available or :interface_not_available
:toolpack_reset_in_progress or :reset_in_progress
:toolpack_adapter_reject or :adapter_reject
:toolpack_missing_or_invalid_ie or :missing_or_invalid_ie
:toolpack_incoming_only or :incoming_only
:toolpack_system_configuration_changed or :system_configuration_changed
:toolpack_resource_no_more_available or :resource_no_more_available
:toolpack_incompatible_media or :incompatible_media
:toolpack_resource_allocation_failed or :resource_allocation_failed
:toolpack_data_path_not_available or :data_path_not_available
:toolpack_local_congestion or :local_congestion
:toolpack_authorization_required or :authorization_required
:toolpack_call_divert_is_not_allowed or :call_divert_is_not_allowed

List of SIP reason causes: 
Reason causes starting with a digit must use the following syntax (can't use : as prefix).

'300_multiple_choices'
'301_moved_permanently'
'302_moved_temporarily'
'305_use_proxy'
'380_alternative_service'
'400_bad_request'
'401_unauthorized'
'402_payment_required'
'403_forbidden'
'404_not_found'
'405_method_not_allowed'
'406_not_acceptable'
'407_proxy_authentication_required'
'408_request_timeout'
'409_conflict'
'410_gone'
'413_request_entity_too_large'
'414_request_URI_too_long'
'415_unsupported_media'
'416_unsupported_URI_scheme'
'420_bad_extension'
'421_extension_required'
'422_session_timer_too_small'
'423_interval_too_brief'
'429_referrer_identity_error'
'480_temporary_unavailable'
'481_call_or_transaction_does_not_exist'
'482_loop_detected'
'483_too_many_hops'
'484_address_incomplete'
'485_ambiguous'
'486_busy_here'
'487_request_terminated'
'488_not_acceptable_here'
'489_bad_event'
'491_retry_after'
'500_server_internal_error'
'501_not_implemented'
'502_bad_gateway'
'503_service_unavailable'
'504_server_timeout'
'505_version_unsupported'
'513_message_too_large'
'600_busy_everywhere'
'603_decline'
'604_not_exist_anywhere'
'606_not_acceptable'

== Nap status ==

All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.

'''Notice:''' These values may change between major release.

Routing script call attribute name Description
--------------------------------------------------------------------------------------------
"name" NAP name.
"signaling_type" Signaling type (SS7, ISDN, CASR2, SIP)
"profile" Profile name.
"sip_destination_ip" Destination IP address.
"sip_destination_port" Destination IP port.
"sip_transport_type" SIP transport type (:udp, :tcp, or :tls) (Toolpack 3.1 and more)
"inst_incoming_call_cnt" Instantaneous Count of incoming calls.
"inst_outgoing_call_cnt" Instantaneous Count of outgoing calls.
"available_cnt" Number of available circuits or channels.
"unavailable_cnt" Number of unavailable circuits or channels.
"availability_percent" Percentage of available circuits or channels.
"usage_percent" Percentage of used circuits or channels.
"unused_shared_percent" Percentage of used circuits or channels of this NAP available to make new calls with (taking into account shared with other NAPs)
"total_incoming_call_cnt" Total Count of incoming calls.
"global_asr_percent" Global calculated ASR percentage.
"total_outgoing_call_cnt" Total Count of outgoing calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_outgoing_call_cnt" Last 24 hours outgoing calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_outgoing_call_cnt" Current hour outgoing calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_outgoing_call_cnt" Last hour outgoing calls.
"poll_remote_proxy" Remote proxy polling enabled
"is_available" Remote proxy actually available or not
"time_since_polling" Time since the last availibility polling
"time_available_seconds" Number of seconds since the NAP is available
"time_unavailable_seconds" Number of seconds since the NAP is unavailable
"register_to_proxy" Register to proxy enabled
"registered" Actually registered or not
"time_since_refresh" Time since the last refresh
"time_registered_seconds" Number of seconds since the NAP is registered
"time_not_registered_seconds" Number of seconds since the NAP is not registered
"asr_stats_incoming_struct" Detailed Answer-Seizure Rate incoming statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"asr_stats_outgoing_struct" Detailed Answer-Seizure Rate outgoing statistics.
{
"global_asr_percent" Global calculated ASR percentage.
"total_call_cnt" Total count of calls.
"total_accepted_call_cnt" Total count of accepted calls (not dropped due to congestion or rate-limiting).
"total_answered_call_cnt" Total count of answered calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_call_cnt" Last 24 hours count of calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_call_cnt" Current hour count of calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_call_cnt" Last hour count of calls.
}
"mos_struct" Detailed Mean Opinion Score statistics.
{
"last_24h_ingress" Last 24 hours calculated MOS for incoming RTP packets.
"last_24h_egress" Last 24 hours calculated MOS for outgoing RTP packets.
"current_hour_ingress" Current hour calculated MOS for incoming RTP packets.
"current_hour_egress" Current hour calculated MOS for outgoing RTP packets.
"last_hour_ingress" Last hour calculated MOS for incoming RTP packets.
"last_hour_egress" Last hour calculated MOS for outgoing RTP packets.
}
"network_quality_struct" Detailed network quality statistics.
{
"last_24h_ingress" Last 24 hours network quality percentage for incoming RTP packets.
"last_24h_egress" Last 24 hours network quality percentage for outgoing RTP packets.
"current_hour_ingress" Current hour network quality percentage for incoming RTP packets.
"current_hour_egress" Current hour network quality percentage for outgoing RTP packets.
"last_hour_ingress" Last hour network quality percentage for incoming RTP packets.
"last_hour_egress" Last hour network quality percentage for outgoing RTP packets.
}

 If the nap status is part of a substructure, the substructure will be a hash containing all subfield elements.

Example to access the signaling type and the number of incoming call count for the NAP of the current call:

incoming_nap = params[:naps][ params[:call][ :nap ].to_sym]
log_trace 4,"Incoming NAP parameters=" + incoming_nap.inspect
log_trace 4,"Incoming NAP signaling type=" + incoming_nap[:signaling_type].inspect
log_trace 4,"Incoming NAP call cnt=" + incoming_nap[:asr_stats_incoming_struct][:total_call_cnt].inspect

 It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.

== Telephony Services ==
In release 2.10 and the above, telephony services (CNAM Request) can be manage from the routing engine in the following format:

params[:telephony_services].each do |service| -> Array of telephony services
service[:name] -> Customer telephony service name
service[:type] -> For now only "CNAM Request"
service[:enabled] -> Indicate if the service is enabled (true) or not (false)
(Only the telephony service define in the profile associated to the NAP is enabled)
(The others telephony services define in others profiles are disabled)
(If we are in the case where we return in the routing script with a response, it is important to set :enabled to false in order to avoid repeating the same query)
serviceParams = service[:params]
serviceParams[:return_to_script] -> Indicates to Gateway if we must return to the routing script after receiving the CNAM response
(It is important to set back to false this field to avoid an infinite loop)
serviceQuery = service[:query]
serviceQuery[:phone] -> 10 digits of calling number from the incoming call to send to the CNAM server
serviceQuery[:timeout] -> Timeout in millisecond to wait a CNAM response from CNAM server
(Default value from profile configuration)
serviceResponse = service[:response]
serviceResponse[:success] -> Indicates if we received a good CNAM response from the CNAM Server (Only present if :return_to_script is set to true)
serviceResponse[:caller_name] -> The caller name received in the CNAM response from the CNAM Server (Only present if :return_to_script is set to true)

== Custom user context ==
The routing script may '''save per-call information within the call context''', that will be available if routing is called again later during the call flow.

Cases where routing is called multiple time for the same call are:
- Call transfer requests
- SIP redirect requests
- Radius Authorization result
- Announcement server with digit collection

The routing script can save a recursive hash of attributes here:
params[:user_context]

For example
params[:user_context] = { "SomeKey" => "Some value I want to retrieve upon next routing for this call", "OtherVal" => { "subkey" => "subval" } }

Upon first call to routing script, params[:user_context] will be nil.
Upon subsequent calls to routing script, it will contain whatever the script had stored upon previous call (or nil if it was not set)

Note: This feature is available starting from release 2.9.85, 2.10.31 and 3.0.15 (in respective branches 2.9, 2.10 or 3.0)

== Routing Script Tests ==
The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
This is available in the Routing Scripts section of the Web portal.

=== Test parameters ===
==== @call_params ====

That variable should contain a hash of call parameters that will be passed to the routing script. This is equivalent to the incoming call parameters.

 

==== @nap_list ====

A list of the hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.

'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.

 

==== @params ====

A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.

@params = {
:bridge => {:announcement_tone, "announcement.wav"},
:contacts => {
:index=>"1",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",
:raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",
:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
],
:source_indexes=>"nil,0"
}
}

 

----

 Back to [[Routing script tutorial|Routing Script Tutorial]].

FreeSBC:Cloud:Azure Installation A

2019-05-28T20:50:31Z

CThompson: /* Instantiate a FreeSBC */ - added these two steps: -The 'Virtual machines' dialog box appears and -From 'Virtual machines' top menu, click 'Add' item.

{{DISPLAYTITLE:FreeSBC:Cloud:Azure Installation}}

= WARNING: This page is under construction =

This page provides installation and configuration information for people launching an instance of ''FreeSBC'' on the Microsoft Azure infrastructure.

== Requirements ==
Minimum Azure cloud Requirements:
* 2 VCPUs
* 4 GB RAM
* VM Size that has a Network interface with Advanced Network capability (Mellanox NIC interface)

The Following table provides recommended VM sizes based on the number of sessions:
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | VM Size
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | VCPUs
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | RAM
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Advanced Networking Capable
|-
| valign="top" |
Up to 350*
| valign="top" |
D2 v2, DS2_v2
| valign="top" |
2
| valign="top" |
7 Gb
| valign="top" |
Yes
|-
| valign="top" |
350*-1000*
| valign="top" |
D4 v3, D4s_v3
| valign="top" |
4
| valign="top" |
16 Gb
| valign="top" |
Yes
|-
| valign="top" |
1000*-2000*
| valign="top" |
D8 v3, D8s_v3
| valign="top" |
8
| valign="top" |
32 Gb
| valign="top" |
Yes
|-
| valign="top" |
2000*-4000*
| valign="top" |
D16 v3, D16s_v3
| valign="top" |
16
| valign="top" |
64 Gb
| valign="top" |
Yes
|}
<nowiki>*</nowiki>Preliminary estimated values

== Retrieving the Image ==
Go to [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site] to retrieve a copy of the latest FreeSBC Image.

== Installation on Azure cloud ==

=== FreeSBC Azure Image ===
A virtual machine image is a single file that contains a virtual disk that has a bootable operating system installed on it. Images are used to create virtual machine instances in the cloud.

The following sections describe how to upload the latest FreeSBC image to your Microsoft Azure account and launch a virtual machine instance running the FreeSBC software.

=== Get a Storage Account ===
You will need a blob container in your Azure storage account. This blob container is required to upload and store a FreeSBC VM image. You can either use an existing storage account or create a new one, but make sure that the storage account location matches the location where you plan to create and run your VM.

==== Create Resource Group ====
If you need to create a storage account to upload the VM image, then you will need a resource group that matches the location where you plan to create and run your VM.
If required, create a resource group as follows:

*Log in to the dashboard.
*Select 'Resource groups'.
*From 'Resource groups', click 'Add' item.
*The 'Create a resource group' dialog box appears.
*Provide a name for the resource group.
*Select the appropriate resource group location. This is where you will be creating the VM.
*Click 'Review + Create'.
[[File:Az_resource_groups.png|850px]]
*Wait for completion of the resource group creation before proceeding with the next steps.

==== Create Storage Account ====
If you require a storage account, do the following:
*Log in to the dashboard.
*Select 'Storage accounts'.
*From 'Storage accounts', click 'Add' item.
*The 'Create a storage account' dialog box appears.
*Select the appropriate resource group.
*Provide a name for the storage account.
*Select the appropriate storage account location. This is where you will be creating the VM.
*For the other parameters, consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Review + Create'.
[[File:Az_storage_accounts.png|850px]]
*Wait for completion of storage account creation before proceeding with the next steps.

==== Create Storage Blob Container ====
If you require a blob container, do the following:
*Log in to the dashboard.
*Click 'Storage accounts'.
*Select a storage account item to add the blob container.
*Click Blob Services button.
[[File:Az_storage_blob_container1.png|850px]]

*From 'Blobs' top menu, click 'Container' item.
*The 'Blob container' dialog box appears.
*Provide a name for this blob container.
*For the other parameters, consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Ok'.
[[File:Az_storage_blob_container2.png|850px]]
*Wait for completion of storage blob container before proceeding with the next steps.

=== Upload a Virtual Hard Disk (VHD) Image ===
Follow this procedure to upload the FreeSBC image to a storage blob container:
*Before being able to upload the FreeSbc image to the storage blob container, you must uncompress (tag.gz) the FreeSBC image locally on your PC. You will require at least 40 GB of free space to uncompress the image.
*Log in to the dashboard.
*Click'Storage accounts'.
*Select the appropriate 'storage account' then 'Blobs' container.
[[File:Az_upload_image1.png|850px]]

*From the 'Blobs' container top menu, Click 'Upload' menu item.
*The 'Upload blob' dialog box appears.
*Select the Virtual Hard Disk image (freesbc_azure.vhd) to upload from your local disk image location.
*Click 'Upload' button.
[[File:Az_upload_image2.png|850px]]
*Wait until upload completion before proceeding with the next steps. This operation will take a long period of time (40GB to upload).

=== Create a VM Image from the FreeSBC storage blob ===
Follow this procedure to create a VM image from a storage blob:
*Log in to the dashboard.
*Select 'Create a resource'.
*The 'Create resource' dialog box appears.
*Type 'image' in the search text box.
*A list of suggested items appears.
*Click 'Image' item.
[[File:az_create_vm_image1.png]]

*The 'Create image' dialog box appears.
*Click 'Create'.
[[File:az_create_vm_image2.png]]

*Provide an image name.
*Select the appropriate resource group.
*Select the appropriate location.
*Click on 'Linux' button for the OS type.
*Browse through storage accounts to select the FreeSBC blob.
*Click 'Select' button to complete FreeSBC blob selection.
*For the other parameters, consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Create' button.
[[File:az_create_vm_image3.png|850px]]

*Wait until create completion before proceeding with following steps.

=== Create a Virtual Network ===
If not already available, follow this procedure to create a Virtual Network:
*Log in to the dashboard.
*Select 'Virtual networks'.
*The 'Virtual networks' dialog box appears.
*From 'Virtual networks' top menu, click 'Add' item.
*The 'Create a virtual network' dialog box appears.
*Provide a virtual network name.
*Provide the virtual network's address range in CIDR notation.
*Select appropriate resource group.
*Select appropriate location.
*Provide subnet name and address range.
*For the other parameters, consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Create' button.
[[File:az_create_virtual_network.png|700px]]

*Wait until create completion before proceeding with the next steps.

=== '''Instantiate a FreeSBC''' ===
Follow this procedure to create a FreeSBC instance:
*Log in to the dashboard.
*Select 'Virtual machines'.
*The 'Virtual machines' dialog box appears.
*From 'Virtual machines' top menu, click 'Add' item.
*The 'Create a virtual machine' dialog box appears.
*Select the appropriate resource group.
*Provide a virtual machine name.
*Select the appropriate region. This is where you will be creating the VM.
*Browse VM images to select the appropriate FreeSBC VM image.
*Select VM size according to expected performace.
*Select 'SSH public key' option as the Authentification type.
*Type 'centos' as SSH Authentification Username.
*Provide a SSH public key as SSH Authentification.
*Click 'Next:Disk>'.
[[File:az_create_vm1.png|750px]]

*The Disks dialog box appears.
*Select the appropriate 'OS disk type' to support your workload or scenario.
*Click 'Next:Networking>'.
[[File:az_create_vm2.png|700px]]

*Select the appropriate Virtual network.
*For the other parameters of this page and the following pages, consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Next:Review + create>'.
[[File:az_create_vm3.png|700px]]

*Wait until create completes before proceeding with the following steps.

==== Add Inbound Security Rules ====
Follow this procedure to add inbound security rules:
*Log in to the dashboard.
*Select 'Virtual machines'.
*The 'Virtual machines' list dialog box appears.
*Select the appropriate virtual machine to add inbound security rules.
*The virtual machine overview dialog box appears.
*Select 'Networking' item from the virtual machine 'Settings' section.
*Click the 'Add inbound port rule' button.
[[File:az_add_inbound_port_rule1.png|850px]]

*The 'Add inbound security rule' dialog box appears.
*Fill the different fields in accordance with the expected VM accessibility from public network.
*The security rules must at least allow access to the VM through ports 22 and 12358 for SSH and Web Portal management access.
*The security rules must also allow access to the VM through other ports (i.e. 5060) for signaling and RTP access (ports depend on your system configuration).
*Consult https://docs.microsoft.com/en-us/azure for more details.
*Click 'Add' to create the inbound security rule.
[[File:az_add_inbound_port_rule2.png|850px]]

==== Advanced Networking ====
The Azure GUI does not allow the enabling of the 'Advanced Networking' when creating the VM from a custom image. You must use Azure CLI to do so. Follow this procedure to enable 'Advanced Networking' on a networking interface:
*Log in to the dashboard.
*Select 'Virtual machines'.
*The 'Virtual machines' list dialog box appears.
*Select the appropriate virtual machine.
*The 'Virtual machine' dialog box appears.
*Select 'Networking' item from the virtual machine 'Settings' section.
*Copy to the clipboard the network interface name to modify the 'Accelerated Networking' setting.
[[File:az_advanced_networking1.png|850px]]

*Open a shell command prompt, which is Azure CLI capable (consult https://docs.microsoft.com/en-us/azure to install the Azure CLI).
*Enter the following command, using the correct network interface name and resource group, and press enter:
az network nic update --name azure-1if-2801 --resource-group sw_group --accelerated-networking true

*The Azure CLI command output will look like the following:
[[File:az_advanced_networking2.png|700px]]

*Rebooting will NOT activate the 'Accelarated Networking' on the VM network interface. It is required to do the following operations to complete 'Accelarated Networking' activation:
**First, 'Stop' the virtual machine (This will take some time to stop the virtual machine).
**Then, 'Start' the virtual machine.

== Accessing the FreeSBC ==
==== FreeSBC SSH Access ====
By default, there is no root password. You will need to SSH on to the FreeSBC using an SSH private key matching the public provided in the '''SSH public key''' when [[#Instantiate a FreeSBC]] instance. Log in using ''centos'' as username.

For example, if your FreeSBC management IP is 192.168.178.30:
> ssh centos@192.168.178.30
ECDSA key fingerprint is 5d:94:a1:93:0f:a4:7a:5d:41:cc:29:49:79:5a:58:f3.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '192.168.178.30' (ECDSA) to the list of known hosts.

CentOS-7-x86_64-Minimal-1511/112/190195:197392, Fri 7 Apr 17:41:46 EDT 2017
[centos@freesbc ~]$

=== Accessing the FreeSBC web portal ===
* Open a web browser to the management IP of the FreeSBC, on port 12358. For example, if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
* You should get to the FreeSBC Configuration Wizard [[File:FreeSBC_WebPortal_Configuration_wizard.png|350px]]

From this point, go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration]]

[[Category:Revise on Major]]

== External References ==
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]

TSBC-SW:WebPortal:Initial Configuration

2018-09-19T13:01:41Z

CThompson: Changed Note: by **

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:FreeSBC Initial Configuration}}
Initial configuration of the FreeSBC is done through a web browser (Chrome, Firefox or other).
Before starting, you need the following information:
* '''Product key''': it has the format VTB-XXX-XXXX. If you do not have this key, please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site].
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Does the system require '''external transcoding'''? As an example, G.711 to G.729a transcoding
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the FreeSBC ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the SBC Configuration Wizard and click on Continue 
[[File:TSBC_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TSBC_SW_EULA_agreement_1.png|600px]] 
4- Enter your activation key and hostname 
<nowiki>**</nowiki> No need to enter host name for AWS. 
[[Image:TSBC_SW_Enter_activation_key_1.png|600px]] 
5- Enter your SSH and WEB root password 
<nowiki>**</nowiki> No need to enter SSH password for AWS. 
[[Image:TSBC-SW Enter SSH WEB Password.png|600px]] 
6- Select the configuration of your SBC - either standalone, or in a Primary/Secondary configuration 
<nowiki>**</nowiki> Not applicable for AWS. 
[[Image:TSBC_SW_standalone_1.png|600px]] 
7- If the system requires external transcoding, select it here. As an example, if the system needs G.711 to G.729a transcoding, then select yes. 
<nowiki>**</nowiki> Not applicable for AWS. 
[[Image:TSBC_SW_transcoding_1.png|600px]] 
8- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system (suggested name: mgmt0)
* ctrl0: Used for communication with the external transcoding devices (suggested name: ctrl0)
* ctrl1: Same as ctrl0. Adds redundancy (suggested name: ctrl1)
* LAN/WAN: SIP/RTP access to private network (suggested name: LAN0) or public network (suggested name: WAN0).

You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TSBC_SW_choose_LAN_interface_role_1.png|600px]] 
9- You can select the "+" sign to get more information on this interface 
[[Image:TSBC_SW_choose_LAN_interface_role_2.png|600px]] 
If 1+1 (control networks ctrl0/ctrl1) or multiple vlan interfaces are needed, make sure all of them are assigned to the appropriate MAC address taken from the Platform (VMware Instance settings or other)
 [[Image:Initial_screen_Match_MAC_1.png|600px]][[File:Network_adapters_MAC_Address_primary_1.png|800px]] 
10- Once completed, you will be asked get the license seed of this unit to allow for license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TSBC_A|Retrieving a License for SBC Units]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

TSBC-SW:WebPortal:Initial Configuration

2018-09-18T21:09:51Z

CThompson: Some fields not used by AWS

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:FreeSBC Initial Configuration}}
Initial configuration of the FreeSBC is done through a web browser (Chrome, Firefox or other).
Before starting, you need the following information:
* '''Product key''': it has the format VTB-XXX-XXXX. If you do not have this key, please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site].
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Does the system require '''external transcoding'''? As an example, G.711 to G.729a transcoding
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the FreeSBC ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the SBC Configuration Wizard and click on Continue 
[[File:TSBC_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TSBC_SW_EULA_agreement_1.png|600px]] 
4- Enter your activation key and hostname 
Note: No need to enter hostname for AWS 
[[Image:TSBC_SW_Enter_activation_key_1.png|600px]] 
5- Enter your SSH and WEB root password 
Note: No need to enter SSH password for AWS 
[[Image:TSBC-SW Enter SSH WEB Password.png|600px]] 
6- Select the configuration of your SBC - either standalone, or in a Primary/Secondary configuration 
Note: Not applicable for AWS 
[[Image:TSBC_SW_standalone_1.png|600px]] 
7- If the system requires external transcoding, select it here. As an example, if the system needs G.711 to G.729a transcoding, then select yes. 
Note: Not applicable for AWS 
[[Image:TSBC_SW_transcoding_1.png|600px]] 
8- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system (suggested name: mgmt0)
* ctrl0: Used for communication with the external transcoding devices (suggested name: ctrl0)
* ctrl1: Same as ctrl0. Adds redundancy (suggested name: ctrl1)
* LAN/WAN: SIP/RTP access to private network (suggested name: LAN0) or public network (suggested name: WAN0).

You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TSBC_SW_choose_LAN_interface_role_1.png|600px]] 
9- You can select the "+" sign to get more information on this interface 
[[Image:TSBC_SW_choose_LAN_interface_role_2.png|600px]] 
If 1+1 (control networks ctrl0/ctrl1) or multiple vlan interfaces are needed, make sure all of them are assigned to the appropriate MAC address taken from the Platform (VMware Instance settings or other)
 [[Image:Initial_screen_Match_MAC_1.png|600px]][[File:Network_adapters_MAC_Address_primary_1.png|800px]] 
10- Once completed, you will be asked get the license seed of this unit to allow for license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TSBC_A|Retrieving a License for SBC Units]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

FreeSBC:Cloud:AWS Installation A

2018-09-18T20:50:24Z

CThompson: Removed subnet selection

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Accessing the TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:ChooseSubnet.png

2018-09-18T20:49:08Z

CThompson: uploaded a new version of "File:ChooseSubnet.png": Removed subnet selection. Used default.

FreeSBC:Cloud:AWS Installation A

2018-09-18T16:06:23Z

CThompson: Added web portal initial configuration section

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Accessing the TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

FreeSBC:Cloud:AWS Installation A

2018-09-18T16:05:07Z

CThompson: Added configuration web portal link

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Accessing the TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:AWS TSBC WebPortal Configuration wizard.jpg

2018-09-18T16:01:37Z

CThompson:

FreeSBC:Cloud:AWS Installation A

2018-09-18T16:01:24Z

CThompson: Update web portal recovery wizaed

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Accessing the TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:TSBC WebPortal Configuration wizard.jpg

2018-09-18T15:51:31Z

CThompson: uploaded a new version of "File:TSBC WebPortal Configuration wizard.jpg": Reverted to version as of 15:55, 13 April 2017

File:TSBC WebPortal Configuration wizard.jpg

2018-09-18T15:51:12Z

CThompson: uploaded a new version of "File:TSBC WebPortal Configuration wizard.jpg"

FreeSBC:Cloud:AWS Installation A

2018-09-18T15:50:27Z

CThompson: Added Accessing the TSBC-SW section

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Accessing the TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:Ready.png

2018-09-14T20:15:25Z

CThompson: uploaded a new version of "File:Ready.png": Removed eth1

FreeSBC:Cloud:AWS Installation A

2018-09-14T20:12:55Z

CThompson: Changed eth1 by eth0

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== It's time to connect ==
You are ready to connect to '''FreeSBC''' instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port
like this: [http://<Public IP>:12358/]

*Username:
** root
*Password:
** <The ID of the instance on which the web portal is running.>

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:InterfaceID.png

2018-09-14T20:11:21Z

CThompson: uploaded a new version of "File:InterfaceID.png": Removed eth1

File:GetTheRightNetworkInterface.png

2018-09-14T20:06:58Z

CThompson: uploaded a new version of "File:GetTheRightNetworkInterface.png": Remove eth1

FreeSBC:Cloud:AWS Installation A

2018-09-14T20:02:13Z

CThompson: Added Optional Elastic IP section

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== '''Instantiate a FreeSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth1''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth1''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== It's time to connect ==
You are ready to connect to '''FreeSBC''' instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port
like this: [http://<Public IP>:12358/]

*Username:
** root
*Password:
** <The ID of the instance on which the web portal is running.>

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:NextTag.png

2018-09-14T19:38:52Z

CThompson: uploaded a new version of "File:NextTag.png": Added 40 GiB and delete on termination

FreeSBC:Cloud:AWS Installation A

2018-09-14T19:36:50Z

CThompson: Added - Check the box "Delete on Termination" in Volume section

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== Instantiate a FreeSBC ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

* For your instance to become accessible, you need to associate a public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth1''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth1''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

You are ready to connect to '''FreeSBC''' instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port
like this: [http://<Public IP>:12358/]

*Username:
** root
*Password:
** <The ID of the instance on which the web portal is running.>

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

FreeSBC:Cloud:AWS Installation A

2018-09-14T19:19:02Z

CThompson: Removed "Add Device" step in Network Interface section

{{DISPLAYTITLE:FreeSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''FreeSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).

== Instantiate a FreeSBC ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate FreeSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the FreeSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
[[File:SelectResources.png| 800px]]

* Choose an existing subnet from the list (Do not leave it to default, to allow for multiple network interfaces or associate a public IP (called "Elastic IP")):
* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Please note that FreeSBC is free of charges. However, you will still be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

* You will be prompted to create a key pair, allowing you to securely connect to your instance. Select “Create a new key pair” if you do not own one, and give it a name. Then, click on “Download Key Pair” to download a .pem file since it is needed for a SSH connection. (Note: Make sure to not lose it, since you would then lose access the the SSH connection for the instance):
[[File:DownloadKey.png| 800px]]

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

* For your instance to become accessible, you need to associate a public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

* Go to the left pane and click on "Instance". Then select the instance "FreeSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth1''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth1''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "FreeSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

You are ready to connect to '''FreeSBC''' instance on AWS through the Web Portal. To connect to the Web Portal, use the public IP address with the port
like this: [http://<Public IP>:12358/]

*Username:
** root
*Password:
** <The ID of the instance on which the web portal is running.>

Take note that it may take a while for the FreeSBC system to make the Web Portal available (around 3-5 minutes).

== Validating the installation ==
To test that the FreeSBC was correctly installed, you can call a special number via any SIP phone to get an automated message from the FreeSBC

* Call the number 5551234@<FreeSBC's public IP address>

You should get a message from the FreeSBC along with a "special treat" :).

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]

[[Category:Revise on Major]]

File:ChooseSubnet.png

2018-09-14T19:16:49Z

CThompson: uploaded a new version of "File:ChooseSubnet.png": Removed "Add Device" step

FreeSBC:Cloud:VmWare Installation A

2018-05-09T17:24:53Z

CThompson: Added accessing IP address sub-section.

{{DISPLAYTITLE:FreeSBC:Cloud:VmWare Installation}}
== Requirements ==
Minimal Cloud requirements:
* Vmware ESX 5 or 6
* 64-bit infrastructure only
* E1000 NIC emulation or VMXNET3 interfaces
* One Ethernet adapter for management (mgmt0)
* One or more Ethernet adapter(s) for SIP and RTP traffic according to the table below (LAN/WAN)
* If you are deploying FreeSBC with transcoding devices or in a 1+1 configuration, you will two additional Ethernet adapters to be used as control ports (ctrl0/ctrl1).

{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | CPU
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | RAM
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Disk Space
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Data Ethernet ports
|-
| valign="top" |
Up to 5,000
| valign="top" |
2
| valign="top" |
4 Gb
| valign="top" |
40 Gb
| valign="top" |
1 Gbps
|-
| valign="top" |
5,001-20,000
| valign="top" |
4
| valign="top" |
8 Gb
| valign="top" |
60 Gb
| valign="top" |
4 X 1 Gbps or
1 X 10 Gbps
|-
| valign="top" |
20,001-50,000
| valign="top" |
4**
| valign="top" |
16 Gb
| valign="top" |
80 Gb
| valign="top" |
1 X 10 Gbps
|-
| valign="top" |
Above 50,000
| valign="top" |
6**
| valign="top" |
24+ Gb
| valign="top" |
100 Gb
| valign="top" |
Multiple 10 Gbps
|}
<nowiki>**</nowiki> The CPU number is based on Intel R630 with Xeon E5-2643. Double the CPUs number if yours are from a earlier generations.

More details on HW/CPU/NIC requirements can be found here: [[FreeSBC:RequirementsMatrix|Requirements Matrix]]

For better performance (see [[TSBC-SW:Cloud:VmWare_Optimizations|optimization]] section)
* CPU resource: allocation shares set to 'high'
* CPU resource: reservation set to maximum and no limit (i.e. 'unlimited')
* Memory resource: reserve all guest memory (all locked)
* Disk: shares 'high'
* Advanced CPU: Hyperthread core sharing to 'None'
* Latency Sensitivity: 'High'

== Getting the Image ==
Please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site] to get a copy of the latest TBSC Image.

== Installation on VmWare cloud ==

=== TBSC VmWare Image ===
A virtual machine image is a single file that contains a virtual disk that has a bootable operating system installed on it. Images are used to create virtual machine instances within the cloud.

You will need to upload the latest TSBC image into your VmWare before you can launch a virtual machine instance running the TSBC software.

==== Launching an instance ====

[[TSBC-SW:Cloud:VmWare_Launching_Instance_Web_A|Using the ESXi Web client]]

[[TSBC-SW:Cloud:VmWare_Launching_Instance_vSphere_A|Using the vSphere client application]]

If you are installing a standalone SBC, the FreeSBC will need access to LAN/WAN and MGMT networks. For transcoding on TSBC-TRANS, or HA pair installation, the FreeSBC will also need access to CTRL0, CTRL1, /and TRANS0 networks. In both instance launching methods above, when editing network adaptor, please take reference to [[TSBC-SW:Networking]] for details on network requirements. For FreeSBC Transcoding and associated network setup please also see [[FreeSBC:Transcoding and Network Setup]].

=== Accessing the TSBC-SW ===
==== Assigning IP address ====
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If you want to assigned a static IP address, you will need to configure it manually.

# Use '''tbchangeip''' shell command and answered questions to changed your Ethernet interface address:
# tbchangeip

==== Accessing the TSBC-SW web portal ====
* Open a web browser to the management IP of the TSBC, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
 
:You should get to the TSBC Configuration Wizard 
:[[File:TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 
* If you do not know the IP address, you can find it from the VMware interface: 
:[[File:FreeSBC Initial IP address.png|700px]]
 
* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation, and/or [[TSBC-SW:Baremetal:VmWare_Optimizations|optimize ]] your server to get the maximum out of your server.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration]]

== Optimizations ==
Click on the following link for VmWare optimizations:
[[TSBC-SW:Cloud:VmWare_Optimizations]]

TSBC-SW:WebPortal:Initial Configuration

2018-05-09T17:18:26Z

CThompson: Added new SSH and WEB root password step

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:FreeSBC Initial Configuration}}
Initial configuration of the FreeSBC is done through a web browser (Chrome, Firefox or other).
Before starting, you need the following information:
* '''Product key''': it has the format VTB-XXX-XXXX. If you do not have this key, please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site].
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Does the system require '''external transcoding'''? As an example, G.711 to G.729a transcoding
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the FreeSBC ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the SBC Configuration Wizard and click on Continue 
[[File:TSBC_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TSBC_SW_EULA_agreement_1.png|600px]] 
4- Enter your activation key and hostname 
[[Image:TSBC_SW_Enter_activation_key_1.png|600px]] 
5- Enter your SSH and WEB root password 
[[Image:TSBC-SW Enter SSH WEB Password.png|600px]] 
6- Select the configuration of your SBC - either standalone, or in a Primary/Secondary configuration 
[[Image:TSBC_SW_standalone_1.png|600px]] 
7- If the system requires external transcoding, select it here. As an example, if the system needs G.711 to G.729a transcoding, then select yes. 
[[Image:TSBC_SW_transcoding_1.png|600px]] 
8- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system (suggested name: mgmt0)
* ctrl0: Used for communication with the external transcoding devices (suggested name: ctrl0)
* ctrl1: Same as ctrl0. Adds redundancy (suggested name: ctrl1)
* LAN/WAN: SIP/RTP access to private network (suggested name: LAN0) or public network (suggested name: WAN0).

You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TSBC_SW_choose_LAN_interface_role_1.png|600px]] 
9- You can select the "+" sign to get more information on this interface 
[[Image:TSBC_SW_choose_LAN_interface_role_2.png|600px]] 
If 1+1 (control networks ctrl0/ctrl1) or multiple vlan interfaces are needed, make sure all of them are assigned to the appropriate MAC address taken from the Platform (VMware Instance settings or other)
 [[Image:Initial_screen_Match_MAC_1.png|600px]][[File:Network_adapters_MAC_Address_primary_1.png|800px]] 
10- Once completed, you will be asked get the license seed of this unit to allow for license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TSBC_A|Retrieving a License for SBC Units]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

File:TSBC-SW Enter SSH WEB Password.png

2018-05-09T17:13:03Z

CThompson: Screenshot of the recovery page that ask for SSH and WEB root password.

Screenshot of the recovery page that ask for SSH and WEB root password.

FreeSBC:Baremetal:Installation A

2018-05-09T15:34:18Z

CThompson: Remove the password section

{{DISPLAYTITLE:FreeSBC:Baremetal:Installation}}

== Requirements ==
Minimal server requirements:
* 64 bits server
* Optical disk drive
* One management Ethernet
* Console access through serial port or keyboard/monitor ports
* BIOS setup for maximum performance (i.e. no dynamic CPU throttling)

{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | CPU
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | RAM
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Disk Space
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Data Ethernet ports***
|-
| valign="top" |
Up to 5,000
| valign="top" |
2
| valign="top" |
4 Gb
| valign="top" |
40 Gb
| valign="top" |
1 Gbps
|-
| valign="top" |
5,000-20,000
| valign="top" |
4
| valign="top" |
8 Gb
| valign="top" |
60 Gb
| valign="top" |
4 X 1 Gbps or
1 X 10 Gbps
|-
| valign="top" |
20,000-50,000
| valign="top" |
4**
| valign="top" |
16 Gb
| valign="top" |
80 Gb
| valign="top" |
1 X 10 Gbps
|-
| valign="top" |
Above 50,000
| valign="top" |
6**
| valign="top" |
24+ Gb
| valign="top" |
100 Gb
| valign="top" |
Multiple 10 Gbps
|}
<nowiki>**</nowiki> The CPU number is based on Intel R630 with Xeon E5-2643. Double the CPUs number if yours are from a earlier generations.

<nowiki>***</nowiki> See list of supported Network Interface Cards (NICs) here: [[Supported_NICs|List of supported NICs]]

More details on HW/CPU/NIC requirements can be found here: [[FreeSBC:RequirementsMatrix|Requirements Matrix]]

For better performance (see [[TSBC-SW:Baremetal:Optimizations|optimization]] section)
* NUMA tuning
* PCIe tuning

== Getting the ISO ==
Please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site] to get a copy of the latest FreeSBC ISO.

== Installing the ISO ==
The installation process will reformat the server's disks and install all the necessary software.

=== Installing using the ISO burned onto a bootable USB flash drive ===
Use a software application to burn the ISO onto a USB flash drive. On Windows, [https://rufus.akeo.ie/ Rufus] is known to work with the FreeSBC ISO.
But generally any similar application should work. Make sure to set the volume label to "'''CENTOS 7 X8'''" and to format the drive in the FAT32 file system format.

=== Physical installation steps ===
# Identify which Ethernet networks you need and connect them to your server. Refer to [[TSBC-SW:Networking|Networking]] for more information. For FreeSBC Transcoding and associated network setup please also see [[FreeSBC:Transcoding and Network Setup]].
# Burn the ISO onto a DVD or a USB flash drive
# Get an access to the console of the server. Usually, this is achieved by connecting a keyboard and screen to the server.
# Insert the DVD in the optical drive of your server and boot from the DVD drive.
#* Alternatively, plug in your USB flash drive and boot from that drive.
# You should get the to the "Virtual Appliance Installer" menu on your display: [[File:ISO_install_prompt.jpg|350px]]
# Hit 'R' key, then 'ENTER' key to start the installation [[File:ISO_installing.jpg|350px]]
# Wait for the installation process to complete. When installation is complete, the server will reboot itself.
#* Important: Make sure to remove the DVD from the drive while the server is rebooting. If you get back to "Virtual Appliance Installer", just eject the CD or remove the USB flash drive and reboot again.
# It may take a couple of minutes for the system to be brought up after the first reboot. Until the WebPortal is accessible, you must '''not''' reboot the newly created machine to allow the installation to complete properly.

=== Assigning IP address ===
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If you want to assigned a static IP address, you will need to configure it manually.

# Use '''tbchangeip''' shell command and answered questions to changed your Ethernet interface address:
# tbchangeip

=== Accessing the FreeSBC web portal ===
# Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the FreeSBC Configuration Wizard [[File:TSBC_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation, and/or [[TSBC-SW:Baremetal:Optimizations|optimize ]] your server to get the maximum out of your server.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration]]

== Optimizations ==
Click on the following link for baremetal server optimizations:
[[TSBC-SW:Baremetal:Optimizations|Optimizations]]

FreeSBC:Baremetal:Installation A

2018-05-09T15:33:35Z

CThompson: Used tbchangeip instead of ip set command.

{{DISPLAYTITLE:FreeSBC:Baremetal:Installation}}

== Requirements ==
Minimal server requirements:
* 64 bits server
* Optical disk drive
* One management Ethernet
* Console access through serial port or keyboard/monitor ports
* BIOS setup for maximum performance (i.e. no dynamic CPU throttling)

{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | CPU
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | RAM
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Disk Space
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Data Ethernet ports***
|-
| valign="top" |
Up to 5,000
| valign="top" |
2
| valign="top" |
4 Gb
| valign="top" |
40 Gb
| valign="top" |
1 Gbps
|-
| valign="top" |
5,000-20,000
| valign="top" |
4
| valign="top" |
8 Gb
| valign="top" |
60 Gb
| valign="top" |
4 X 1 Gbps or
1 X 10 Gbps
|-
| valign="top" |
20,000-50,000
| valign="top" |
4**
| valign="top" |
16 Gb
| valign="top" |
80 Gb
| valign="top" |
1 X 10 Gbps
|-
| valign="top" |
Above 50,000
| valign="top" |
6**
| valign="top" |
24+ Gb
| valign="top" |
100 Gb
| valign="top" |
Multiple 10 Gbps
|}
<nowiki>**</nowiki> The CPU number is based on Intel R630 with Xeon E5-2643. Double the CPUs number if yours are from a earlier generations.

<nowiki>***</nowiki> See list of supported Network Interface Cards (NICs) here: [[Supported_NICs|List of supported NICs]]

More details on HW/CPU/NIC requirements can be found here: [[FreeSBC:RequirementsMatrix|Requirements Matrix]]

For better performance (see [[TSBC-SW:Baremetal:Optimizations|optimization]] section)
* NUMA tuning
* PCIe tuning

== Getting the ISO ==
Please go to our [http://www2.telcobridges.com/FreeSBCDownload FreeSBC Download site] to get a copy of the latest FreeSBC ISO.

== Installing the ISO ==
The installation process will reformat the server's disks and install all the necessary software.

=== Installing using the ISO burned onto a bootable USB flash drive ===
Use a software application to burn the ISO onto a USB flash drive. On Windows, [https://rufus.akeo.ie/ Rufus] is known to work with the FreeSBC ISO.
But generally any similar application should work. Make sure to set the volume label to "'''CENTOS 7 X8'''" and to format the drive in the FAT32 file system format.

=== Physical installation steps ===
# Identify which Ethernet networks you need and connect them to your server. Refer to [[TSBC-SW:Networking|Networking]] for more information. For FreeSBC Transcoding and associated network setup please also see [[FreeSBC:Transcoding and Network Setup]].
# Burn the ISO onto a DVD or a USB flash drive
# Get an access to the console of the server. Usually, this is achieved by connecting a keyboard and screen to the server.
# Insert the DVD in the optical drive of your server and boot from the DVD drive.
#* Alternatively, plug in your USB flash drive and boot from that drive.
# You should get the to the "Virtual Appliance Installer" menu on your display: [[File:ISO_install_prompt.jpg|350px]]
# Hit 'R' key, then 'ENTER' key to start the installation [[File:ISO_installing.jpg|350px]]
# Wait for the installation process to complete. When installation is complete, the server will reboot itself.
#* Important: Make sure to remove the DVD from the drive while the server is rebooting. If you get back to "Virtual Appliance Installer", just eject the CD or remove the USB flash drive and reboot again.
# It may take a couple of minutes for the system to be brought up after the first reboot. Until the WebPortal is accessible, you must '''not''' reboot the newly created machine to allow the installation to complete properly.

=== Changing the root password ===
# Use the console to login into the server
## user: root
## password: root
# Change the password to something stronger than root:
# passwd
New password: ........
Retype new password: ........
passwd: all authentication tokens updated successfully.

=== Assigning IP address ===
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If you want to assigned a static IP address, you will need to configure it manually.

# Use '''tbchangeip''' shell command and answered questions to changed your Ethernet interface address:
# tbchangeip

=== Accessing the FreeSBC web portal ===
# Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the FreeSBC Configuration Wizard [[File:TSBC_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation, and/or [[TSBC-SW:Baremetal:Optimizations|optimize ]] your server to get the maximum out of your server.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration]]

== Optimizations ==
Click on the following link for baremetal server optimizations:
[[TSBC-SW:Baremetal:Optimizations|Optimizations]]

Toolpack:Creating a SIP Domain SBC A

2018-04-23T13:14:18Z

CThompson: Added fields description for "Registrar Selection Mode" and "Forward After Switchover".

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:Creating a SIP Domain}}
A SIP domain represents a grouping of devices (or users) that can communicate with one another.
You must configure SIP Registration Domain for your system. The first step in doing so is to create a SIP Domain:

1- Click '''SIP Domain''' in the navigation panel

[[Image:SIP_Domain_NavigationMenu.png]]

2- Click '''Create New Domain'''

[[Image:Create_SIP_Domain.png]]

3- Create the new Domain:

* Enter a configuration '''Name''' for this domain.
* Enter a '''Domain Name''' for the SIP Registration Domain (domain can be a FQDN or an IP address)
* Set the number '''Maximum Registered Users''' for this domain
* Set the Expires value used by SBC when the remote device doesn't supply one ('''Default Contact Expire''')
* Select '''Routing Method''' the system will use to route calls to registered users (if enabled in routing scripts).
** '''Register source''': Sends SIP Invite to the registering source IP address.
** '''Contact''': Sends SIP Invite to the 'contact' from the Register message.
* Set the '''Default Contact Expiration''', this value will be used when no ''Expires'' value is supplied by the user agent.
* Set the '''Minimum Contact Expiration''', this is the minimum ''Expires'' value that can be supplied by a user agent. Lower values will be rejected with a 423 'Interval too brief' response.
* Set the '''Maximum Contact Expiration''', this is the maximum ''Expires'' value that can be supplied by a user agent. Higher value are replaced by this parameter.
* Forwarding Parameters:
** Select the Registration '''Forwarding Mode''' to the registrar:
*** '''Contact Remapping''': Changes the user and the IP address.
*** '''Contact Passthrough''': Doesn't change anything. Enables devices to be contacted directly without going through the SBC.
** Set '''Minimum Registrar Expiration''', this is the minimum ''Expires'' value sent by the SBC to the registrar. If a user agent 'Expires' value is greater than this parameter, the SBC will do rate adaptation between the user agent and the Registrar.
** Set '''Maximum Pending Register Forward''', the maximum number of simultaneous pending register requests allowed for this domain. New REGISTER request are being refused passed this threshold.
** Set '''Maximum Simultaneous Register Forward''', the maximum number of simultaneous active register requests allowed for this domain. New REGISTER request are being refused passed this threshold.
** Select the Registration '''Registrar Selection Mode''' to the registrar:
*** '''Active/Standby''': The active registrar is the one with status up and the lowest priority (automatic fallback).
** Enable the '''Forward After Switchover''': After a switchover, the first register refresh request from each user will be forwarded to the active registrar.
* Click '''Create'''

[[Image:Create_SIP_Domain1.png]]

4- Verify that the '''Sip registration domain was successfully created''' message appears

[[Image:Create_SIP_Domain2.png]]
 
[[Image:Create_SIP_Domain3.png]]

File:Create SIP Domain1.png

2018-04-16T12:20:05Z

CThompson: uploaded a new version of "File:Create SIP Domain1.png": New field "Forward After Switchover" and moved field "Registrar Selection Mode"

Creation

Sip registration forwarding

2018-04-11T19:49:27Z

CThompson: Added new "Registrar Selection Mode" section.

TSBC registration forwarding feature allows to control the registration requests flow between SIP User Agents and registrars. It allows adaptation of SIP register messages between SIP User Agents and registrars. It keeps information about SIP User Agent contacts and allows routing of SIP calls base on registration information.

== Protection ==
*TSBC protects registrar from overloading of SIP User Agents register requests using different strategies (i.e. Firewall, Rate Adaptation, SIP Header Manipulation, Etc.).

== Forwarding Modes ==
*The TSBC always modifies the contact URI in SIP register requests to remain on the path between SIP User Agents and registrars.
*The TSBC supports two different SIP registration forwarding modes (i.e. "Contact Remapping" or "Contact Passthrough").
*The "Contact Passthrough" forwarding mode makes contact username portion of the contact URI in SIP register requests to pass through unchanged.
*The "Contact Remapping" forwarding mode modifies contact username portion of the contact URI in SIP register requests and make it unique.

== Registrar Selection Mode ==
*The TSBC supports Active/Standby registrar selection mode. The active registrar is the one with status up and the lowest priority (automatic fallback).

== NAT traversal ==
*The TSBC handles SIP Calls NAT traversal then allows interaction between SIP User Agents from public and private networks.
*It supports SIP register requests "Rate Adaptation" between SIP User Agents and registrar.
*Because refreshing requests are not always sent to registrar, "Rate adaptation" feature reduces SIP register requests sent to registrar. The "Rate Adaptation" feature is also useful to keep firewall ports open.

== SIP Calls routing ==
*The TSBC keeps SIP User Agents contacts information. This information serves on SIP calls routing when a SIP User Agent is trying to reach a registered users. It could be used also to accept calls from registered users only.

== Configuration ==

{| cellpadding="5" border="1" class="wikitable"
|-
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | FreeSBC
|-
| valign="top" |
*[[Toolpack:Creating_a_SIP_Domain_SBC_A|3.0 Creating a SIP Domain]]
|}

File:Create SIP Domain1.png

2018-04-11T19:08:49Z

CThompson: uploaded a new version of "File:Create SIP Domain1.png": Added new field "Registrar Selection Mode".

Creation

File:Create New SIP Domain1.png

2018-04-11T19:04:01Z

CThompson: uploaded a new version of "File:Create New SIP Domain1.png": Added red circle around "Create" button.

New screenshot of "Creating New SIP Registration Domain" with new field "Registrar Selection Mode".

File:Create New SIP Domain1.png

2018-04-11T19:02:17Z

CThompson: New screenshot of "Creating New SIP Registration Domain" with new field "Registrar Selection Mode".

New screenshot of "Creating New SIP Registration Domain" with new field "Registrar Selection Mode".

Toolpack:Creating a SIP Registrar SBC A

2018-04-11T18:57:08Z

CThompson: New screenshot of "Creating New SIP Registration Registrar" with new fields (Poll Registrar, Polling Interval and Response Timeout)

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:Creating a SIP Registrar}}
A SIP registrar represents a SIP endpoint that provide a location service.
You must configure SIP Registrar for your system. The first step in doing so is to select your SIP Domain:

1- Click on your domain in the '''SIP Domain List'''

[[Image:Select_SIP_Domain.png]]

2- Click '''Create New SIP Registration Registrar'''

[[Image:Create_New_SIP_Registrar.png]]

3- Create the new SIP Registration Registrar

* Enter a '''Name''' for the SIP Registration Registrar
* Enter an '''Address''' to reach the registrar
* Select the registrar destination '''Port'''
* Select which local interface will be use to send REGISTER message in '''SIP Transport Server'''
* '''Poll Registrar''' enabled by default. Sends an OPTIONS message to determine registrar availability.
* '''Polling Interval''' in seconds. Time between each OPTIONS sending message.
* '''Response Timeout''' in second. Maximum waiting time for a response to a registrar polling.
* Click '''Create'''

[[Image:Create_New_SIP_Registrar3.png]]

4- Verify that the '''Sip registration registrar was successfully created''' message appears

[[Image:Create_New_SIP_Registrar2.png]]

File:Create New SIP Registrar3.png

2018-04-11T18:41:27Z

CThompson: New screenshot of Registrar creation. - New fields (Poll Registrar, Polling Interval and Response Timeout)

New screenshot of Registrar creation.
- New fields (Poll Registrar, Polling Interval and Response Timeout)

TMG7800-Ctrl:Baremetal:Installation A

2017-11-03T16:02:40Z

CThompson: Changed Assigning IP address section.

== Requirements ==
Minimal server requirements:
* 64 bits server
* Optical disk drive
* One management Ethernet
* Console access through serial port or keyboard/monitor ports
* BIOS setup for maximum performance (i.e. no dynamic CPU throttling)

See list of supported Network Interface Cards (NICs) here: [[Supported_NICs|List of supported NICs]]

== Getting the ISO ==
Please contact our [mailto:sales@telcobridges.com sales team] to get a copy of the latest TMG7800-CTRL-SW ISO and the product activation key (VTB-XXXX-XXXX).

=== Prepare an ISO burned onto a bootable USB flash drive or a DVD ===
Use a software application to burn the ISO onto a USB flash drive. On Windows, [https://rufus.akeo.ie/ Rufus ] is known to work with the TMG7800-CTRL-SW ISO.
But generally any similar application should work. Make sure to set the volume label to "'''CENTOS 7 X8'''" and to format the drive in the FAT32 file system format.

== Installing the hardware ==
# Identify which Ethernet networks you need and connect them to your server.
# Refer to "'''[[Product_Installation|TMG7800 Installation Guide]]'''" for your hardware setup.

== Installing the ISO ==
The installation process will reformat the server's disks and install all the necessary software.

=== Physical installation steps ===
# Get an access to the console of the server. Usually, this is achieved by connecting a keyboard and screen to the server.
# Plug in your USB flash drive and boot from that drive.
#* Alternatively, insert the DVD in the optical drive of your server and boot from the DVD drive.
# You should get the to the "Virtual Appliance Installer" menu on your display: [[File:ISO_install_prompt.jpg|350px]]
# Hit 'R' key, then 'ENTER' key to start the installation [[File:ISO_installing.jpg|350px]]
# Wait for the installation process to complete. When installation is complete, the server will reboot itself.
#* Important: Make sure to remove the DVD from the drive while the server is rebooting. If you get back to "Virtual Appliance Installer", just eject the CD or remove the USB flash drive and reboot again.
# It may take a couple of minutes for the system to be brought up after the first reboot. Until the WebPortal is accessible, you must '''not''' reboot the newly created machine to allow the installation to complete properly.

=== Changing the root password ===
# Use the console to login into the server
## user: root
## password: root
# Change the password to something stronger than root:
# passwd
New password: ........
Retype new password: ........
passwd: all authentication tokens updated successfully.

=== Assigning IP address ===
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If you want to assigned a static IP address, you will need to configure it manually.

# Use '''tbchangeip''' shell command and answered questions to changed your Ethernet interface address:
# tbchangeip

=== Accessing the TMG7800-CTRL-SW web portal ===
# Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the TMG7800-CTRL Configuration Wizard [[File:TMG7800-CTRL-SW_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TMG7800-CTRL-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TMG7800-CTRL-SW:WebPortal:Initial Configuration]]

Toolpack:Retreiving a License TMG7800 CTRL A

2017-11-03T15:27:24Z

CThompson: Added Upload license part for TMG7800-CTRL

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:Retrieving a License for TMG7800-CTRL Units}}

== Activate a License ==
Activate and download your license from the following site:

https://licenses.telcobridges.com

For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

=== Download a License ===

# Click on '''License Download''' from the left menu or on the '''Download''' button from the main page
# Enter the Serial number of your device (VTB-xxxx-xxxx)
# Click on the device
# Copy your '''License seed'''
# Select your '''Version''' from the drop down menu
# Click '''Download'''.

=== Uploading a License ===
Click on the following link to upload your new downloaded license:
[[Toolpack:Uploading_a_License_B]]

Toolpack:Retreiving a License TMG7800 CTRL A

2017-11-03T15:16:58Z

CThompson: Added first draft of Retreiving a License for TMG7800-CTRL

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:Retrieving a License for TMG7800-CTRL Units}}

== Activate License ==
Activate and download your license from the following site:

https://licenses.telcobridges.com

For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

=== Download License ===

# Click on '''License Download''' from the left menu or on the '''Download''' button from the main page
# Enter the Serial number of your device (VTB-xxxx-xxxx)
# Click on the device
# Copy your '''License seed'''
# Select your '''Version''' from the drop down menu
# Click '''Download'''.

TMG7800-Ctrl:Baremetal:Installation A

2017-11-03T14:35:13Z

CThompson: Fixed internal link with TMG7800 Installation Guide

== Requirements ==
Minimal server requirements:
* 64 bits server
* Optical disk drive
* One management Ethernet
* Console access through serial port or keyboard/monitor ports
* BIOS setup for maximum performance (i.e. no dynamic CPU throttling)

See list of supported Network Interface Cards (NICs) here: [[Supported_NICs|List of supported NICs]]

== Getting the ISO ==
Please contact our [mailto:sales@telcobridges.com sales team] to get a copy of the latest TMG7800-CTRL-SW ISO and the product activation key (VTB-XXXX-XXXX).

=== Prepare an ISO burned onto a bootable USB flash drive or a DVD ===
Use a software application to burn the ISO onto a USB flash drive. On Windows, [https://rufus.akeo.ie/ Rufus ] is known to work with the TMG7800-CTRL-SW ISO.
But generally any similar application should work. Make sure to set the volume label to "'''CENTOS 7 X8'''" and to format the drive in the FAT32 file system format.

== Installing the hardware ==
# Identify which Ethernet networks you need and connect them to your server.
# Refer to "'''[[Product_Installation|TMG7800 Installation Guide]]'''" for your hardware setup.

== Installing the ISO ==
The installation process will reformat the server's disks and install all the necessary software.

=== Physical installation steps ===
# Get an access to the console of the server. Usually, this is achieved by connecting a keyboard and screen to the server.
# Plug in your USB flash drive and boot from that drive.
#* Alternatively, insert the DVD in the optical drive of your server and boot from the DVD drive.
# You should get the to the "Virtual Appliance Installer" menu on your display: [[File:ISO_install_prompt.jpg|350px]]
# Hit 'R' key, then 'ENTER' key to start the installation [[File:ISO_installing.jpg|350px]]
# Wait for the installation process to complete. When installation is complete, the server will reboot itself.
#* Important: Make sure to remove the DVD from the drive while the server is rebooting. If you get back to "Virtual Appliance Installer", just eject the CD or remove the USB flash drive and reboot again.
# It may take a couple of minutes for the system to be brought up after the first reboot. Until the WebPortal is accessible, you must '''not''' reboot the newly created machine to allow the installation to complete properly.

=== Changing the root password ===
# Use the console to login into the server
## user: root
## password: root
# Change the password to something stronger than root:
# passwd
New password: ........
Retype new password: ........
passwd: all authentication tokens updated successfully.

=== Assigning IP address ===
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If there is no IP assigned, you will need to configure one manually.

# Assign a IP address to the Ethernet interface having network connectivity. Example if the NIC's name would be eth0:
# ip link set eth0 up
# ip addresss add 192.168.178.30/24 dev eth0

=== Accessing the TMG7800-CTRL-SW web portal ===
# Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the TMG7800-CTRL Configuration Wizard [[File:TMG7800-CTRL-SW_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TMG7800-CTRL-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TMG7800-CTRL-SW:WebPortal:Initial Configuration]]

TMG7800-Ctrl:Baremetal:Installation A

2017-11-03T14:33:12Z

CThompson: Fixed external link with Rufu.

== Requirements ==
Minimal server requirements:
* 64 bits server
* Optical disk drive
* One management Ethernet
* Console access through serial port or keyboard/monitor ports
* BIOS setup for maximum performance (i.e. no dynamic CPU throttling)

See list of supported Network Interface Cards (NICs) here: [[Supported_NICs|List of supported NICs]]

== Getting the ISO ==
Please contact our [mailto:sales@telcobridges.com sales team] to get a copy of the latest TMG7800-CTRL-SW ISO and the product activation key (VTB-XXXX-XXXX).

=== Prepare an ISO burned onto a bootable USB flash drive or a DVD ===
Use a software application to burn the ISO onto a USB flash drive. On Windows, [https://rufus.akeo.ie/ Rufus ] is known to work with the TMG7800-CTRL-SW ISO.
But generally any similar application should work. Make sure to set the volume label to "'''CENTOS 7 X8'''" and to format the drive in the FAT32 file system format.

== Installing the hardware ==
# Identify which Ethernet networks you need and connect them to your server.
# Refer to "'''TMG7800 Installation Guide'''" for your hardware setup.

== Installing the ISO ==
The installation process will reformat the server's disks and install all the necessary software.

=== Physical installation steps ===
# Get an access to the console of the server. Usually, this is achieved by connecting a keyboard and screen to the server.
# Plug in your USB flash drive and boot from that drive.
#* Alternatively, insert the DVD in the optical drive of your server and boot from the DVD drive.
# You should get the to the "Virtual Appliance Installer" menu on your display: [[File:ISO_install_prompt.jpg|350px]]
# Hit 'R' key, then 'ENTER' key to start the installation [[File:ISO_installing.jpg|350px]]
# Wait for the installation process to complete. When installation is complete, the server will reboot itself.
#* Important: Make sure to remove the DVD from the drive while the server is rebooting. If you get back to "Virtual Appliance Installer", just eject the CD or remove the USB flash drive and reboot again.
# It may take a couple of minutes for the system to be brought up after the first reboot. Until the WebPortal is accessible, you must '''not''' reboot the newly created machine to allow the installation to complete properly.

=== Changing the root password ===
# Use the console to login into the server
## user: root
## password: root
# Change the password to something stronger than root:
# passwd
New password: ........
Retype new password: ........
passwd: all authentication tokens updated successfully.

=== Assigning IP address ===
By default, all detect network interfaces will have DHCP enabled. Thus, the server might already have an IP address assigned if the network has a DHCP server running. In such case, you can display and use it to access the web portal configuration panel.

# Retrieve an IP address assigned by DHCP
# ifconfig

If there is no IP assigned, you will need to configure one manually.

# Assign a IP address to the Ethernet interface having network connectivity. Example if the NIC's name would be eth0:
# ip link set eth0 up
# ip addresss add 192.168.178.30/24 dev eth0

=== Accessing the TMG7800-CTRL-SW web portal ===
# Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the TMG7800-CTRL Configuration Wizard [[File:TMG7800-CTRL-SW_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TMG7800-CTRL-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TMG7800-CTRL-SW:WebPortal:Initial Configuration]]

File:TMG7800 CTRL SW Choose LAN interface role 2.jpg

2017-11-02T20:29:01Z

CThompson:

File:TMG7800 CTRL SW Choose LAN interface role 1.jpg

2017-11-02T20:28:28Z

CThompson:

File:TMG7800 CTRL SW Standalone 1.jpg

2017-11-02T20:27:44Z

CThompson:

TMG7800-CTRL-SW:WebPortal:Initial Configuration

2017-11-02T20:27:18Z

CThompson: /* Initial configuration of the TMG7800-CTRL-SW */

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:TMG7800-CTRL-SW Initial Configuration}}
Initial configuration of the TMG7800-CTRL-SW is done through a web browser (Chrome, Firefox or other).
Before starting, you need these information:
* '''Activation key''': it has the format VTB-XXX-XXXX. If you do not have this key, please contact [mailto:sales@telcobridges.com our sales team]
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the TMG7800-CTRL-SW ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the TMG7800-CTRL Configuration Wizard and click on Continue 
[[File:TMG7800-CTRL-SW_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TMG7800_CTRL_SW_EULA_agreement_1.jpg|600px]] 
4- Enter your activation key and hostname 
[[Image:TMG7800_CTRL_SW_Enter_activation_key_1.jpg|600px]] 
5- Select the configuration of your TMG7800-CTRL - either standalone, or in a Primary/Secondary configuration 
[[Image:TMG7800_CTRL_SW_Standalone_1.jpg|600px]] 
6- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system
* ctrl0: Used for communication with the external hardware unit devices
* ctrl1: Same as ctrl0. Adds redundancy
* LAN0: SIP/RTP access to private network
* WAN0: SIP/RTP Access to public network
You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_1.jpg|600px]] 
7- You can select the "+" sign to get more information on this interface 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_2.jpg|600px]] 

8- Once completed and you have '''Performance option for higher CPS rate''', you will be asked to get the license seed of this unit to allow license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TMG7800_CTRL_A]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

File:TMG7800 CTRL SW Enter activation key 1.jpg

2017-11-02T20:26:12Z

CThompson:

File:TMG7800 CTRL SW EULA agreement 1.jpg

2017-11-02T20:25:33Z

CThompson:

TMG7800-CTRL-SW:WebPortal:Initial Configuration

2017-11-02T20:22:50Z

CThompson: /* Initial configuration of the TMG7800-CTRL-SW */

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:TMG7800-CTRL-SW Initial Configuration}}
Initial configuration of the TMG7800-CTRL-SW is done through a web browser (Chrome, Firefox or other).
Before starting, you need these information:
* '''Activation key''': it has the format VTB-XXX-XXXX. If you do not have this key, please contact [mailto:sales@telcobridges.com our sales team]
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the TMG7800-CTRL-SW ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the TMG7800-CTRL Configuration Wizard and click on Continue 
[[File:TMG7800-CTRL-SW_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TMG7800_CTRL_SW_EULA_agreement_1.jpg|600px]] 
4- Enter your activation key and hostname 
[[Image:TMG7800_CTRL_SW_Enter_activation_key_1.jpg|600px]] 
5- Select the configuration of your SBC - either standalone, or in a Primary/Secondary configuration 
[[Image:TMG7800_CTRL_SW_Standalone_1.jpg|600px]] 
6- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system
* ctrl0: Used for communication with the external hardware unit devices
* ctrl1: Same as ctrl0. Adds redundancy
* LAN0: SIP/RTP access to private network
* WAN0: SIP/RTP Access to public network
You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_1.jpg|600px]] 
7- You can select the "+" sign to get more information on this interface 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_2.jpg|600px]] 

8- Once completed and you have '''Performance option for higher CPS rate''', you will be asked to get the license seed of this unit to allow license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TMG7800_CTRL_A]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

TMG7800-CTRL-SW:WebPortal:Initial Configuration

2017-11-02T20:19:16Z

CThompson: First draft of TMG7800-CTRL-SW initial configuration

=== '''''Applies to version(s): v3.0''''' ===
{{DISPLAYTITLE:TMG7800-CTRL-SW Initial Configuration}}
Initial configuration of the TMG7800-CTRL-SW is done through a web browser (Chrome, Firefox or other).
Before starting, you need these information:
* '''Activation key''': it has the format VTB-XXX-XXXX. If you do not have this key, please contact [mailto:sales@telcobridges.com our sales team]
* '''Hostname''' of the unit. It is important to set the hostname correctly and not modify it later, otherwise you will need a new license
* Is the system used as a '''standalone''' unit or is it used in a '''Primary/Secondary''' configuration?
* Role of each of the '''network interfaces'''
Then, follow the procedure below.

== Initial configuration of the TMG7800-CTRL-SW ==
1- Open a web browser to the IP of your server, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358 
2- You will get the TMG7800-CTRL Configuration Wizard and click on Continue 
[[File:TMG7800-CTRL_WebPortal_Configuration_wizard.jpg|600px]] 
3- You need to accept the EULA agreement 
[[Image:TMG7800_CTRL_SW_EULA_agreement_1.jpg|600px]] 
4- Enter your activation key and hostname 
[[Image:TMG7800_CTRL_SW_Enter_activation_key_1.jpg|600px]] 
5- Select the configuration of your SBC - either standalone, or in a Primary/Secondary configuration 
[[Image:TMG7800_CTRL_SW_Standalone_1.jpg|600px]] 
6- Here you will choose the role of the network adapters in the system here is a short description of each type: 
* mgmt: Used for management of the system
* ctrl0: Used for communication with the external hardware unit devices
* ctrl1: Same as ctrl0. Adds redundancy
* LAN0: SIP/RTP access to private network
* WAN0: SIP/RTP Access to public network
You need to configure all IP interfaces. In case of doubt, configure them as management interfaces. 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_1.jpg|600px]] 
7- You can select the "+" sign to get more information on this interface 
[[Image:TMG7800_CTRL_SW_Choose_LAN_interface_role_2.jpg|600px]] 

8- Once completed and you have '''Performance option for higher CPS rate''', you will be asked to get the license seed of this unit to allow license installation. Please go here for instructions: [[Toolpack:Retreiving_a_License_TMG7800_CTRL_A]] 
To get help, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].