TB Wiki - User contributions [en]

File:ClearIP Query LCR.zip

2024-12-19T19:07:35Z

Nicole Tan: Script includes LCR

== Summary ==
Script includes LCR

ProSBC:Authentication Redirect

2024-12-19T19:06:21Z

Nicole Tan: NT: Need to point to a different script file

{{DISPLAYTITLE:ProSBC Configuration for 302 Redirect routing with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for a combination of Robocall Analytics, Stir/Shaken Authenticating/Verification, CNAM query and LCR routing from ClearIP.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions

=Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==LCR Routing Call Flow==
[[Image:ClearIP LCR Routing _Verification_CNAM_Robocal Analytics.jpg|800px|Network Diagram]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for verification with CNAM and Robocall Analytics

3. ClearIP performs a verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity )

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302:
4d: 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity ):
ProSBC extracts the CNAM ([V] prefix)) in the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with CNAM ([V] prefix)) ---Next Routes

4e: 302 with list of the destination IP in the contact headers:
e.g. Contact: <sip:Coolwave66886688914506558993@8.8.8.8>;q=0.99, <sip:C2A1Internet6688914506558993@8.8.8.8>;q=0.98,
<sip:A3BC66886688914506558993@8.8.8.8>;q=0.97
ProSBC composes list of the routes according to the Contact list of the returned 302 message and send the call to them with reroute retry function
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite--> called@IP of the first contact list with reroute retry function

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query_LCR.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

===Add prosbc_routing in RoutesColumn ===
Routes Columns->Create New Routes Column
Name->prosbc_routing
Type attributes -> YES|NO
Default ->YES
[[Image:prosbc_routing.jpg|800px]]
*Set the value to "YES" for ProSBC routing

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

File:ClearIP Query.zip

2024-12-19T18:53:49Z

Nicole Tan: Nicole Tan reverted File:ClearIP Query.zip to an old version

ProSBC:Stir Shaken

2024-12-19T18:53:23Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration STIR/SHAKEN with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for STIR/SHAKEN.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions
*In case you are new to STIR-SHAKEN technology is highly recommended to watch the explanatory webinar available in our YouTube channel:

{{#ev:youtube|https://www.youtube.com/watch?v=zHullJT-yRI|720|center}}

=Typical Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==Stir/Shaken Call Flow==
[[Image:STIR_SHAKEN_Summary_CallFlow.jpg|800px|Call Flow]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for Authentication or Verification or Robocall Analytics

3. ClearIP performs Authentication or Verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with Identity for Authentication, or Verstat in PAI header (P-Asserted-Identity ) for Verification. Or CNAM in PAI header

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
ProSBC takes the Identity or the Verstat string from the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with Identity for Authentication, or Verstat in PAI header for Verification, Or CNAM in PAI header

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_Query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_Query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

ProSBC:Stir Shaken

2024-12-19T18:43:07Z

Nicole Tan: NT:need to name the zip a different name to point to another file

{{DISPLAYTITLE:ProSBC Configuration STIR/SHAKEN with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for STIR/SHAKEN.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions
*In case you are new to STIR-SHAKEN technology is highly recommended to watch the explanatory webinar available in our YouTube channel:

{{#ev:youtube|https://www.youtube.com/watch?v=zHullJT-yRI|720|center}}

=Typical Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==Stir/Shaken Call Flow==
[[Image:STIR_SHAKEN_Summary_CallFlow.jpg|800px|Call Flow]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for Authentication or Verification or Robocall Analytics

3. ClearIP performs Authentication or Verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with Identity for Authentication, or Verstat in PAI header (P-Asserted-Identity ) for Verification. Or CNAM in PAI header

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
ProSBC takes the Identity or the Verstat string from the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with Identity for Authentication, or Verstat in PAI header for Verification, Or CNAM in PAI header

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query_LCR.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_Query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_Query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

File:ClearIP Query.zip

2024-12-19T17:14:28Z

Nicole Tan: Nicole Tan uploaded a new version of File:ClearIP Query.zip

ProSBC:Stir Shaken

2024-12-09T22:08:44Z

Nicole Tan: NT: Corrected before_filter :method => :ClearIP_Query

ProSBC:Stir Shaken

2024-12-09T22:01:25Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration STIR/SHAKEN with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for STIR/SHAKEN.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions
*In case you are new to STIR-SHAKEN technology is highly recommended to watch the explanatory webinar available in our YouTube channel:

{{#ev:youtube|https://www.youtube.com/watch?v=zHullJT-yRI|720|center}}

=Typical Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==Stir/Shaken Call Flow==
[[Image:STIR_SHAKEN_Summary_CallFlow.jpg|800px|Call Flow]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for Authentication or Verification or Robocall Analytics

3. ClearIP performs Authentication or Verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with Identity for Authentication, or Verstat in PAI header (P-Asserted-Identity ) for Verification. Or CNAM in PAI header

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
ProSBC takes the Identity or the Verstat string from the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with Identity for Authentication, or Verstat in PAI header for Verification, Or CNAM in PAI header

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_Query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

Support:Contacting TelcoBridges technical support

2024-09-13T16:15:32Z

Nicole Tan: NT: 2024.09.13 Updated the regional contact number

{{DISPLAYTITLE:Contacting TelcoBridges technical support}}

Worldwide technical support is available via either of the following channels:

 '''Americas & Europe Technical Support Centre (GMT-05:00,  Montreal, Canada)'''
 Office hours: Monday to Friday from 09:00 to 17:00 Eastern Time

Phone: '''+1-450-300-1895 '''

Supported languages: English, French, Mandarin, Cantonese 

'''Asia Technical Support Centre (GMT +08:00)'''
 Office hours: Monday to Friday from 09:00 to 17:00 Vietnam Time

Phone: '''+1-450-300-2123 '''

Supported languages: English, Vietnamese

 

'''EMEA Technical Support Centre (GMT +03:00, TRT)'''
 Office hours: Monday to Friday from 09:00 to 17:00 Turkey Time

Phone: '''+1-450-300-2091'''

Supported languages: English, Turkish

 

'''24/7 Support''' '''International''' (Public Holiday and non-office hours) 

Phone: '''+1-866-438-4703 '''

Supported languages: English

Note: For customers for who have purchased 24/7 TBSupport bank of hours or have an SLA, please contact TBSupport via this 24/7 hotline for emergency

 
'''TelcoBridges''' 
TelcoBridges office number: '''+1-450-655-8993''' 
E-mail: [mailto:support@telcobridges.com support@telcobridges.com] 
TBsupport tracking system: https://support.telcobridges.com 
 

'''Chat/Teams'''

Send request to [mailto:support@telcobridges.com support@telcobridges.com] for contacts

 
'''Please kindly note that TelcoBridges office is closed during [[support:public_holidays|public holidays]].'''

File:HostRoleSecondary 6 A.png

2024-01-15T20:05:46Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRoleSecondary 6 A.png

File:HostRoleSecondary 4 A.png

2024-01-15T20:00:02Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRoleSecondary 4 A.png

File:HostRolePrimary 6 A.png

2024-01-15T19:57:24Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRolePrimary 6 A.png

File:HostRoleSecondary 3 A.png

2024-01-15T19:50:12Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRoleSecondary 3 A.png

File:HostRolePrimary 5 A.png

2024-01-15T19:48:49Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRolePrimary 5 A.png

File:HostRolePrimary 4 A 20240115.png

2024-01-15T19:47:40Z

Nicole Tan:

Toolpack:Host 1Plus1 Primary A

2024-01-15T19:45:48Z

Nicole Tan: NT: Updated HostRolePrimary_4_A

{{DISPLAYTITLE:Setting the Role to a Primary Unit in a 1+1 System}}
{| class="wikitable"
|-
|rowspan="2"|This article applies to:
|'''Product'''
|'''Version'''
|-
|Tmedia
|2.8, 2.9, 2.10, 3.0, 3.2
|}
The first time that you connect to a gateway, the web portal setup wizard will be displayed and you will be asked to select how you would like to configure the role of the gateway. Your choices are standalone, primary, or secondary. Once the role configuration settings are applied, the gateway will start up and display the web portal configuration management tool.

'''To configure the host role of the gateway as the primary unit in a 1+1 system, do the following:'''

1- When the setup wizard is displayed, click '''Continue'''

[[Image:HostRolePrimary_0_A.png]]

2- Select '''As part of a 1+1 redundant system''' and click '''Continue'''.

[[Image:HostRolePrimary_1_A.png]]

3- Select '''The primary unit''' and click '''Continue'''.

[[Image:HostRolePrimary_2_A.png]]

4- When you are asked if the unit should get configuration and packages from an existing secondary unit, select '''No''' and click '''Continue'''.

[[Image:HostRolePrimary_3_A.png]]

5- If you need to change the default subnet address or subnet mask, click '''change internal subnets''' and proceed to step 5a, otherwise click '''Continue''' and go to step 6.

[[Image:HostRolePrimary_4_A_20240115.png]]

5a- Enter the subnet address and subnet mask for each VLAN ID and click '''Continue'''.

[[Image:HostRolePrimary_5_A.png]]

6- Once you are satisfied with your settings, click '''Confirm'''.

[[Image:HostRolePrimary_6_A.png]]

Allow for the host role changes to take effect.

[[Image:HostRolePrimary_7_A.png]]

7- The Web Portal Log On page is displayed.
* Enter the '''user name''' and '''password'''.

[[Image:HostRolePrimary_8_A.png]]

File:HostRolePrimary 4 A.png

2024-01-15T19:38:42Z

Nicole Tan: Nicole Tan uploaded a new version of File:HostRolePrimary 4 A.png

File:Mtp3 routes new.zip

2023-11-22T21:42:03Z

Nicole Tan:

File:Mtp3 routes.zip

2023-11-22T21:41:27Z

Nicole Tan:

RESTful API: Add MTP3 Routes

2023-11-22T21:41:06Z

Nicole Tan: NT: Created new page

{{DISPLAYTITLE:RESTful API: Add MTP3 Routes}}
== Add MTP3 Routes with tbconfig commands ==
=== Display MTP3 Routes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config//mtp3_stacks/mtp3_config/mtp3_networks/MTP3_ANSI/mtp3_routes mtp3_routes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /mtp3_stacks/mtp3_config/mtp3_networks/MTP3_ANSI/mtp3_routes mtp3_routes.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as mtp3_routes_new.json ===

=== Import mtp3_routes_new.json ===
tbconfig /configurations/main_config//mtp3_stacks/mtp3_config/mtp3_networks/MTP3_ANSI/mtp3_routes mtp3_routes_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[Media:mtp3_routes.zip|Click to download mtp3_routes.json]]
*[[Media:mtp3_routes_new.zip|Click to download mtp3_routes_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-22T21:36:48Z

Nicole Tan:

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes using tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list, in general, enter:
tbconfig -u root -p root /configurations/main_config/point_codes
'''Note''': Change “main_config” to the name of your configuration.

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r

'''Note''': Change “main_config” to the name of your configuration.

The file pc.json will resemble the following:

{

"DPC_2_2_2" : {
"length" : "24bits format=8.8.8",
"name" : "DPC_2_2_2",
"point_code" : "2.2.2",
"type" : "DPC"
},
"OPC_1_1_1" : {
"length" : "24bits format=8.8.8",
"name" : "OPC_1_1_1",
"point_code" : "1.1.1",
"type" : "OPC"
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

'''Note''': Change “main_config” to the name of your configuration.

=== Example of pc.json and pc_new.json ===
*[[Media:pc.zip|Click to download pc.json]]
*[[Media:pc_new.zip|Click to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T22:44:48Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[Media:pc.zip|Click here to download pc.json]]
*[[Media:pc_new.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T22:44:30Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[Media:pc.zip|Click here to download pc.json]]
*[[File:pc_new.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T22:44:20Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[File:pc.zip|Click here to download pc.json]]
*[[File:pc_new.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T22:43:54Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[File:pc.zip|Click here to download pc.json]
*[File:pc_new.zip|Click here to download pc_new.json]

File:Pc new.zip

2023-11-20T22:37:07Z

Nicole Tan:

RESTful API: Add MTP3 Point Codes

2023-11-20T22:36:53Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[File:pc.zip|Click here to download pc.json]]
*[[File:pc_new.zip|Click here to download pc_new.json]]

File:Pc.zip

2023-11-20T22:36:10Z

Nicole Tan:

RESTful API: Add MTP3 Point Codes

2023-11-20T21:37:49Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[File:pc.json|Click here to download pc.json]]
*[[File:pc_newjson.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:37:02Z

Nicole Tan:

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[File:pc_json.zip|Click here to download pc.json]]
*[[File:pc_newjson.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:31:46Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc_json.zip|Click here to download pc.json]]
*[[:File:pc_newjson.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:30:54Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc_json.zip|Click here to download pc.json]]
*[[:File:pc_newjson.zip|Click here to download pc_new.json]]
*[[:File:ClearIP_Query_1.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:29:54Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc_json.zip|Click here to download pc.json]]
*[[:File:pc_newjson.zip|Click here to download pc_new.json]]
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:28:39Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc_json.zip|Click here to download pc.json]]
*[[:File:pc_newjson.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:28:02Z

Nicole Tan: /* Example of pc.json and pc_new.json */

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc.json.zip|Click here to download pc.json]]
*[[:File:pc_new.json.zip|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:26:36Z

Nicole Tan:

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes with tbconfig commands ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

=== Example of pc.json and pc_new.json ===
*[[:File:pc.json|Click here to download pc.json]]
*[[:File:pc_new.json|Click here to download pc_new.json]]

RESTful API: Add MTP3 Point Codes

2023-11-20T21:25:49Z

Nicole Tan: NT: Added the example json files

RESTful API: Add MTP3 Point Codes

2023-11-20T21:20:16Z

Nicole Tan:

RESTful API: Add MTP3 Point Codes

2023-11-20T21:19:32Z

Nicole Tan: NT: Recreated the page

{{DISPLAYTITLE:RESTful API: Add MTP3 Point Codes}}
== Add MTP3 Point Codes ==
=== DisplayMTP3 point codes list ===
To show the MTP3 point codes list in general it will be:
tbconfig -u root -p root /configurations/main_config/point_codes
<<<<Note: Change the “main_config” to your configuration name

=== Export the current point codes table to a json file ===
tbconfig /configurations/main_config/point_codes pc.json -r
<<<<Note: Change the “main_config” to your configuration name

The file pc.json will look something like this:
{
"MTP3_2_2_2" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_2_2_2",
"point_code" : "DPC_2_2_2",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"MTP3_LOCAL" : {
"advanced_parameters" : {
"broadcast" : false,
"route_to_adjacent" : false,
"sls_selector_bit1" : true,
"sls_selector_bit2" : false,
"sls_selector_bit3" : false,
"sls_selector_bit4" : false,
"support_multi_message_prio" : false,
"support_route_congestion_test" : true
},
"mtp3_linksets" : [
"MTP3_LS_ANSI"
],
"name" : "MTP3_LOCAL",
"point_code" : "OPC_1_1_1",
"point_code_type" : "SP",
"sls_range" : "ANSI 5 bits",
"timers" : {
"t6_timer" : "800 milliseconds",
"t8_timer" : "800 milliseconds",
"t10_timer" : "30 seconds",
"t11_timer" : "30 seconds",
"t18_timer" : 11000,
"t19_timer" : "67 seconds",
"t21_timer" : "63 seconds",
"t25_timer" : "30 seconds",
"tc_timer" : "500 milliseconds"
}
},
"***meta***" : {
"src_path" : "",
"version" : "3.2.55"
}
}

=== Add the new point codes and save it as pc_new.json ===

=== Import pc_new.json ===
tbconfig /configurations/main_config/point_codes pc_new.json -U

<<<<Note: Change the “main_config” to your configuration name

Toolpack Application:tbconfig

2023-11-20T20:49:50Z

Nicole Tan: NT: Added 2 more cases

{{DISPLAYTITLE:Toolpack Application:tbconfig}}

== Role ==
tbconfig is used to provision the system using the RESTful API. It supports three different modes of operations : interactive mode, shell mode and command line mode.

== Interactive mode ==
This mode allows to explore and modify the configurations using arrow keys and simple commands. Multiple modifications can be made before they are applied to the unit. While inside the interactive mode, type the question mark (?) key to get a more detailed help.
*'''To launch the tool in interactive mode :'''
tbconfig

== Shell mode ==
This mode allows to explore and modify the configurations using cd (change directory), ls (list files) and other simple commands. Multiple modifications can be made before they are applied to the unit. While inside the shell mode, type "help" key to get a more detailed help.
*'''To launch the tool in shell mode :'''
tbconfig --shell

== Command line mode ==
This mode allows to export or import configurations to/from files. It also allows to instantly modify values.
*'''To use the tool in command line mode :'''
tbconfig [args]
*'''To get detailed commands examples :'''
tbconfig --help

== Additional arguments ==
By default, tbconfig sends HTTP requests to the [[Toolpack_Application:web_server|web server]] using 127.0.0.1:12358 with root/root as the username and password.
 This can be changed using the following arguments:
-h : [host] Host to connect to (IP address or domain name)
--port : [port] Port to use for connecting to HTTP server
-u : [user] User name to use for connecting to HTTP server
-p : [pass] Password to use for connecting to HTTP server
-s : [HTTPS] to connect using HTTPS

For example, if the TMG’s web server has been reconfigured to use HTTPS on port 443 and you want to log with user my_username and password my_secret_password, tbconfig should be invoked using the following parameters:
tbconfig --port 443 -s HTTPS -u my_username -p my_secret_password

Unix environment variables can be set to avoid adding those parameters every time.
TBCONFIG_HOST : Replaces -h
TBCONFIG_PORT : Replaces --port
TBCONFIG_USER : Replaces -u
TBCONFIG_PASS : Replaces –p
TBCONFIG_SCHEME : Replaces -s

== Use cases ==
* [[RESTful_API:_Exporting_a_configuration|Exporting a configuration]]
* [[RESTful_API:_Importing_a_configuration|Importing a configuration]]
* [[RESTful_API:_Activating_a_configuration|Activating a configuration]]
* [[RESTful_API:_Updating_a_Route|Updating a static route]]
* [[RESTful_API:_Add_MTP3_Point_Codes|Add MTP3 Point Codes]]
* [[RESTful_API:_Add_MTP3_Routes|Add MTP3 Routes]]

File:ClearIP Query.zip

2023-06-15T03:26:13Z

Nicole Tan: Nicole Tan uploaded a new version of File:ClearIP Query.zip

ProSBC:CAPTCHA Authentication

2023-03-08T21:24:59Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration for CAPTCHA Authentication – 302 Redirect with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure ProSBC to operate with the TransNexus/ClearIP server for Verification with CNAM and Robocall Analytics.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support Verification with CNAM and Robocall Analytics with TransNexus.

*For simple Robocall Mitigation, please check the instruction here: https://docs.telcobridges.com/tbwiki/ProSBC:Robocall_Mitigation

=Typical Call Scenarios=
This section provides the simplified network diagram with typical call flows.
==Captcha Call Flow==
[[Image:Captcha_CallFlow.jpg|800px]]

1. Source of ServiceProvider sends a call to ProSBC.

2. ProSBC forwards the call to ClearIP for Verification with CNAM and Robocall Analytics

3. ClearIP performs Verification, CNAM lookup, Robocall Analytics, then sends one of the following responses to ProSBC

*3a. SIP 404 Not Found: No fraud is detected, not a robocall.

*3b. SIP 503 Service unavailable: No fraud is detected, not a robocall.

*4c. SIP 603 Decline: Fraud is detected, block the call.

*4d. SIP 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity )

4. Upon receiving 404 or 503
4a: - ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

4b: - ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
4c: ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
4d: 302 with the captcha.clearip.com in the contact header
ProSBC will send the call the CAPTCHA NAP- captcha.clearip.com
Captcha will request the caller to enter the code:
-- Code entered correctly within the timer; Captcha returns 503. ProSBC will do advance route
-- Code entered incorrectly 3 times or timeout, Captcha returns 603, call will be dropped

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

ProSBC:CAPTCHA Authentication

2023-03-08T21:22:48Z

Nicole Tan: /* Captcha Call Flow */

ProSBC:CAPTCHA Authentication

2023-03-08T21:21:37Z

Nicole Tan: /* Typical Call Flows */

ProSBC:CAPTCHA Authentication

2023-03-08T21:21:09Z

Nicole Tan:

File:Captcha CallFlow.jpg

2023-03-08T21:20:40Z

Nicole Tan:

ProSBC:CAPTCHA Authentication

2023-03-08T21:20:26Z

Nicole Tan:

ProSBC:Stir Shaken

2023-03-08T20:33:49Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration STIR/SHAKEN with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for STIR/SHAKEN.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions
*In case you are new to STIR-SHAKEN technology is highly recommended to watch the explanatory webinar available in our YouTube channel:

{{#ev:youtube|https://www.youtube.com/watch?v=zHullJT-yRI|720|center}}

=Typical Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==Stir/Shaken Call Flow==
[[Image:STIR_SHAKEN_Summary_CallFlow.jpg|800px|Call Flow]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for Authentication or Verification or Robocall Analytics

3. ClearIP performs Authentication or Verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with Identity for Authentication, or Verstat in PAI header (P-Asserted-Identity ) for Verification. Or CNAM in PAI header

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
ProSBC takes the Identity or the Verstat string from the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with Identity for Authentication, or Verstat in PAI header for Verification, Or CNAM in PAI header

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

ProSBC:CNAM Verification Robocall Analytics

2023-03-08T20:32:01Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration for CNAM Verification and Robocall Analytics with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for verification with CNAM and Robocall Analytics.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions

=Typical Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==CNAM Lookup Call Flow==
[[Image:CNAM_Lookup.jpg|800px|Call Flow]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for verification with CNAM and Robocall Analytics

3. ClearIP performs a verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with CNAM in PAI header or X-Identity header
Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
ProSBC extracts the CNAM in PAI header or X-Identity header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with CNAM in PAI or X-Identity header --->Next Routes

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the filter script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.

ProSBC:Authentication Redirect

2023-03-08T20:29:23Z

Nicole Tan:

{{DISPLAYTITLE:ProSBC Configuration for 302 Redirect routing with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure a ProSBC to operate with the TransNexus/ClearIP server for a combination of Robocall Analytics, Stir/Shaken Authenticating/Verification, CNAM query and LCR routing from ClearIP.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. 

ProSBC 3.0.90 or a later version is needed to support verification with CNAM and Robocall Analytics with TransNexus.

*For other configurations with all Transnexus/ClearIP Solutions, please refer to: https://docs.telcobridges.com/tbwiki/ProSBC_With_Transnexus_Solutions

=Call-Flow Scenario=
In this call flow scenario the network diagram illustrates the typical layout of the network. This is followed by a detailed description of the call flow.
==LCR Routing Call Flow==
[[Image:ClearIP LCR Routing _Verification_CNAM_Robocal Analytics.jpg|800px|Network Diagram]]

1. The ProSBC receives an inbound call from the Service Provider.

2. ProSBC forwards the call to ClearIP for verification with CNAM and Robocall Analytics

3. ClearIP performs a verification, CNAM lookup, Robocall Analytics, and then sends one of the following responses to ProSBC

*SIP 404 Not Found: No fraud is detected. This is not a robocall.
*SIP 503 Service unavailable: No fraud is detected. This is not a robocall.
*SIP 603 Decline: Fraud is detected. Block the call.
*SIP 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity )

Upon receiving 404 or 503
ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302:
4d: 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity ):
ProSBC extracts the CNAM ([V] prefix)) in the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with CNAM ([V] prefix)) ---Next Routes

4e: 302 with list of the destination IP in the contact headers:
e.g. Contact: <sip:Coolwave66886688914506558993@8.8.8.8>;q=0.99, <sip:C2A1Internet6688914506558993@8.8.8.8>;q=0.98,
<sip:A3BC66886688914506558993@8.8.8.8>;q=0.97
ProSBC composes list of the routes according to the Contact list of the returned 302 message and send the call to them with reroute retry function
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite--> called@IP of the first contact list with reroute retry function

=ProSBC Configuration=
This section provides the ProSBC configuration procedures for the solution. They are grouped into 4 main sections.
*Initial Common Procedures: The procedures in this section are common to any scenario. You must follow them.
*Scenario 1, One ClearIP NAP: Follow this section to learn how to configure ProSBC with one ClearIP NAP without a need to differentiate between Inbound and Outbound calls.
*Scenario 2, More than one ClearIP NAP: Follow this section to learn how to configure ProSBC in which you have more than one ClearIP NAP and you need to differentiate between Inbound and Outbound calls.
*Final Common Procedures: The procedures in this section are common to all scenarios.

==Initial Common Procedures==
===Configure Routing Script===
ProSBC is configured to use routing scripts to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:ClearIP_Query.zip|Click here to download ClearIP_Query.rb (the fitler script)]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->ClearIP_Query.rb
ScriptType->filter
Load on startup->checked

*Include the filter script in the main script, default is simple_routing_sbc.rb.
Note: Only one "main" script should show the set of the Scripts:

Gateway->Routes->Routing Script->Edit the main script:

[[Image:Scripts.jpg|800px]]
- Add the "require 'ClearIP_Query' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
* Note: if label routing or other before_filter script are used, please place ClearIP_query last
*[[:File:Main_ClearIP.zip|Refer to Main_ClearIP.rb here to know what it should look like in your existing "main" script]]

===Add service_type in NAPs Column ===
NAPs Columns->Create New NAPs Column
Name->service_type
Type attributes -> NORMAL|AUTHENTICATION|VERIFICATION
Default ->NORMAL
[[Image:service_type.jpg|800px]]
*Set the value to "AUTHENTICATION" for CLEARIP NAPs

===Add prosbc_routing in RoutesColumn ===
Routes Columns->Create New Routes Column
Name->prosbc_routing
Type attributes -> YES|NO
Default ->YES
[[Image:prosbc_routing.jpg|800px]]
*Set the value to "YES" for ProSBC routing

==Scenario 1:One ClearIP NAP==
Follow the procedures in this scenario of you will only have one ClearIP NAP and do not need to differentiate between inbound and outbound calls.
===Create Transport Server for ClearIP NAP===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP
SIP Transport Servers->SIP_TS_CLEARIP
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP===
NAP Columns -> select NAP_CLEARIP
service_type: AUTHENTICATION

===Add Route to NAP_CLEARIP===
Routes -> Create New Route
Name: To_ClearIP
NAP: (Any) (or you can choose specific NAPs - you may need to create multiple routes in this case)
Remapped NAP: NAP_CLEARIP
Priority: 10

==Scenario 2: More than one ClearIP NAP==
Follow the procedures in this scenario if you have more than one ClearIP NAP and must differentiate between inbound and outbound calls.

===Create 2 TCP transport servers: one for inbound and one for outbound===
SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_IN
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

SIP -> Create New Transport Server
Name->SIP_TS_CLEARIP_OUT
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

===Create Inbound ClearIP NAP and Outbound ClearIP NAP===
NAPs->Create New NAP
Name->NAP_CLEARIP_IN
SIP Transport Servers->SIP_TS_CLEARIP_IN
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)
NAPs->Create New NAP
Name->NAP_CLEARIP_OUT
SIP Transport Servers->SIP_TS_CLEARIP_OUT
Proxy address->sip.clearip.com (Or appropriate Domain provided by ClearIP)
Port range->[Select port range of IP interface above)

===Set service_type to "AUTHENTICATION" for NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
NAP Columns -> select NAP_CLEARIP_IN
service_type: AUTHENTICATION
NAP Columns -> select NAP_CLEARIP_OUT
service_type: AUTHENTICATION

===Add Routes to NAP_CLEARIP_IN and NAP_CLEARIP_OUT===
Routes -> Create New Route
Name: To_ClearIP_IN
NAP: specific NAPs which carry the inbound traffic
Remapped NAP: NAP_CLEARIP_IN
Priority: 10
Routes -> Create New Route
Name: To_ClearIP_OUT
NAP: specific NAPs which carry the outbound traffic
Remapped NAP: NAP_CLEARIP_OUT
Priority: 10

==Final Common Procedures==
Follow these procedures to wrap up the ProSBC configuration work. They apply to both previously described scenarios.
===Configure other Routes===
You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

===Configure Route Retry Action for the related Reason Cause Code===
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Note:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.