Parameter Mapping

Script parameter name <>

ISDN <>

R2_CAS <>

SS7 <>

SIP <>

Comment

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:[email protected]>

calling_sip_port

N/A

N/A

N/A

SIP:From - port

For example : The '6060' in From: "Cullen Jennings" <sip:[email protected]: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:[email protected]>

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:[email protected]>

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:[email protected]:6060>

supp_private_address_forward_enabled

N/A

N/A

N/A

N/A

Overwrite default supplementary/second P-Asserted-Identity header forwarding behavior from incoming to outgoing leg

supp_private_address

N/A

N/A

N/A

SIP:P-Asserted-Identity - userinfo

For example : The 'fluffy' in supplementary/second P-Asserted-Identity: "Cullen Jennings" <sip:[email protected]>

supp_private_address_display_name

N/A

N/A

N/A

SIP:P-Asserted-Identity - display name

For example : The 'Cullen Jennings' in supplementary/second P-Asserted-Identity: "Cullen Jennings" <sip:[email protected]>

supp_private_address_sip_host

N/A

N/A

N/A

SIP:P-Asserted-Identity - host (domain or IP)

For example : The 'telcobridges.com' in supplementary/second P-Asserted-Identity: "Cullen Jennings" <sip:[email protected]>

supp_private_address_sip_port

N/A

N/A

N/A

SIP:P-Asserted-Identity - port

For example : The '6060' in supplementary/second P-Asserted-Identity: "Cullen Jennings" <sip:[email protected]: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:[email protected]>

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:[email protected]>

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:[email protected]>

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:[email protected]: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:[email protected]>

called_sip_port

N/A

N/A

N/A

SIP:To - port number

For example : The '6060' in To: "Cullen Jennings" <sip:[email protected]: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 'Enable SIP Custom Headers' in Profiles->SIP

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

network_identification

Q931: 'Transit network selection' IE - Network identification

N/A

Q763: 'Transit network selection' IE - Network identification

SIP: Request-Line - cic

network_identification_plan

Q931: 'Transit network selection' IE - Network identification plan

N/A

Q763: 'Transit network selection' IE - Network identification plan

N/A

location_number_forward_enabled

N/A

N/A

N/A

N/A

Overwrite default location number forwarding behavior from incoming to outgoing leg

location_number

N/A

N/A

Q763: 'Location number' IE - address signals

N/A

location_number_noa

N/A

N/A

Q763: 'Location number' IE - nature of address indicator

N/A

location_number_npi

N/A

N/A

Q763: 'Location number' IE - numbering plan indicator

N/A

location_number_presentation

N/A

N/A

Q763: 'Location number' IE - presentation restricted indicator

N/A

location_number_screening

N/A

N/A

Q763: 'Location number' IE - screening

N/A

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.

mlpp_look_for_busy

N/A

N/A

Q763: 'MLPP precedence' IE - look ahead for busy

N/A

mlpp_precedence_level

N/A

N/A

Q763: 'MLPP precedence' IE - precedence level

SIP:Resource-Priority - q735

mlpp_network_identity

N/A

N/A

Q763: 'MLPP precedence' IE - network identity

N/A

mlpp_service_domain

N/A

N/A

Q763: 'MLPP precedence' IE - MLPP service domain

N/A

isub_forward_enabled

N/A

N/A

N/A

N/A

Overwrite default ISUB forwarding behavior from incoming to outgoing leg

called_isub

Q931: 'Called party subaddress' IE - subaddress information

N/A

Q763: 'Access transport' IE

SIP:To - isub parameter

called_isub_type

Q931: 'Called party subaddress' IE - type of subaddress

N/A

Q763: 'Access transport' IE

SIP:To - isub-encoding parameter

calling_isub

Q931: 'Calling party subaddress' IE - subaddress information

N/A

Q763: 'Access transport' IE

SIP:From - isub

calling_isub_type

Q931: 'Calling party subaddress' IE - type of subaddress

N/A

Q763: 'Access transport' IE

SIP:From - isub-encoding

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

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

ss7_bci_default

N/A

N/A

Default backward call indicator (BCI) value.

N/A

Toolpack will overwrite BCI bits A, B, I, K, M and N with appropriate values according to call conditions. These values are taken from ITU Q.763, section 3.5: Backward call indicators.

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

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

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

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

rtp_local_addr

N/A

N/A

N/A

Incoming leg local SDP IP address

(read-only)

rtp_local_port

N/A

N/A

N/A

Incoming leg local SDP IP port

(read-only)

rtp_remote_addr

N/A

N/A

N/A

Incoming leg remote SDP IP address

(read-only)

rtp_remote_port

N/A

N/A

N/A

Incoming leg remote SDP IP port

(read-only)

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)

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)

reverse_charging_indication_forward_enabled

N/A

N/A

N/A

N/A

Enable forwarding of reverse charging indication from incoming to outgoing leg

sip_call_id

N/A

N/A

N/A

Incoming leg SIP Call-Id

(read-only)

sip_local_addr

N/A

N/A

N/A

Incoming leg local SIP IP address

(read-only)

sip_local_port

N/A

N/A

N/A

Incoming leg local SIP port

(read-only)

sip_remote_addr

N/A

N/A

N/A

Incoming leg remote SIP IP address

(read-only)

sip_remote_port

N/A

N/A

N/A

Incoming leg remote SIP port

(read-only)

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)

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)

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)

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)

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)

PreviousAccessing Routing Script ParametersNextScript Parameters Definition

Last updated

Was this helpful?