Routing Script Tutorial: Script Parameters Definition

Hide TOC

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.

• unknown_number (2 or 0x2)
• international_number (4 or 0x4)
• national_number (3 or 0x3)
• subscriber_number (1 or 0x1)
• network_specific (5 or 0x5)
• network_routing_national_format (7 or 0x7)
• network_routing_international_format (8 or 0x8)
• abbreviated_number (6 or 0x6)
• subscriber_number_operator_requested (113 or 0x71)
• national_number_operator_requested (114 or 0x72)
• international_number_operator_requested (115 or 0x73)
• no_number_present_operator_requested (116 or 0x74)
• no_number_present_cut_through_call_to_carrier (117 or 0x75)
• test_line_test_code (119 or 0x77)
• non_unique_subscriber_number (113 or 0x71)
• non_unique_national_number (115 or 0x73)
• non_unique_international_number (116 or 0x74)
• call_950_number (118 or 0x76)
• special_number (115 or 0x73)
• national_number_with_transit_network_selection (116 or 0x74)
• international_number_with_transit_network_selection (117 or 0x75)

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

• call_params[:called_noa] = 0x70

or

• call_params[:called_noa] = 112

Npi values

• unknown_number
• isdn
• telephony
• private
• data
• telex
• national

Calling Display Type values

• unspecified => Type is unspecified.
• calling_party_name => Type is 0xB1.

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

• call_params[:calling_display_type] = 0xB1

or

• call_params[:calling_display_type] = 177

Calling Display value

• call_params[:calling_display] = "Roger Fluffy"

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.

• unspecified
• not_available (0x2)
• allowed (0x0)
• restricted (0x1)
• addr_restricted
• name_restricted

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

Routing Script string	SS7 raw value	R2 CAS scripts	Default Rx CAS	default Tx CAS	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

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.
In case it is required to use a value that is not defined in the text values below, an 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.

• unspecified
• no (0x0)
• pass (0x1)
• fail (0x2)
• network_provided (0x3)

Redirecting indicator values

SS7:

• no_redirection
• call_rerouted
• call_rerouted_all_restricted
• call_diverted
• call_diverted_all_restricted
• call_rerouted_restricted
• call_diverted_restricted
• spare

Redirecting number, Original Called Number and Diversion Reason

ISDN:

• unknown
• busy
• no_reply
• deflection
• dte_out_of_order
• forwarding_by_called_dte
• unconditional

SS7:

• unknown
• busy (SIP: user-busy)
• no_reply (SIP: no-answer)
• unconditional
• deflection
• deflection_immediate
• mobile_not_reachable

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:

• digital
• restricted_digital
• digital_with_tones
• speech
• 3_1_khz_audio
• video

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.

MLPP Precedence values

mlpp_look_for_busy:

• allowed
• path_reserved
• not_allowed

mlpp_precedence_level:

• flash_override
• flash
• immediate
• priority
• routine

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:

• nsap
• nsap_ia5
• nsap_bcd
• user

called_isub: calling_isub:

Digits for the subaddress information.

Network Identification Plan

network_identification_plan:

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