Adding YouMail script to Routing scripts - Revision history

Luc Morissette at 19:41, 8 February 2021

2021-02-08T19:41:54Z

Luc Morissette at 19:17, 8 February 2021

2021-02-08T19:17:02Z

Luc Morissette at 19:15, 8 February 2021

2021-02-08T19:15:58Z

Luc Morissette at 19:15, 8 February 2021

2021-02-08T19:15:23Z

Luc Morissette at 19:06, 8 February 2021

2021-02-08T19:06:25Z

Luc Morissette: Updated YouMail page

2021-02-08T19:05:24Z

Updated YouMail page

Luc Morissette: Page creation

2021-02-08T18:31:03Z

Page creation

New page

=== '''''Applies to version(s): v3.1, v3.2''''' ===
{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions - INCOMPLETE}}
This shows how to add '''youmail_spam_risk.rb''' script to any Routing scripts.

== Requirements for this script ==
# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface.

== Add '''youmail_spam_risk.rb''' Scripts in system ==
Download this file:
{| cellpadding="5" border="1" class="wikitable"
|-
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" |Capture DTMF Script
|-
| valign="top" |
*[[Media:R_n_cdr.zip|R_n_cdr.rb]]
|}
Then upload it in the system with these instructions:
[[Import_Customized_Routing_Script_C]]

== Setting up '''Routing Number''' Scripts ==

To setup a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script. 

First, go to the routing script section of the Web portal
<pre>Gateway -> Routing scripts -> Example Scripts -> simple_routing_sbc.rb [Edit]
</pre>
Four things need to be added. At the start of the script: 
<pre>require 'r_n_cdr'
</pre>
In the main class: 
<pre>include RnCdr
</pre>
<pre>before_filter :method => :RN_cdr
</pre>
<pre>after_remap_filter :method => :Swap_back
</pre>
 
The final script will look like this:
<pre>
require 'base_routing'
require 'r_n_cdr'

class SimpleRouting < BaseRouting
include RnCdr

before_filter :method => :RN_cdr

route_match :call_field_name => :called
route_match :call_field_name => :calling
route_match :call_field_name => :nap
route_remap :call_field_name => :called, :route_field_name => :remapped_called
route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap

after_remap_filter :method => :Swap_back
end
</pre>
== Update Text CDR Configuration ==
To have the Routing Number (RN) in the CDR logs, add these fields:
Gateway -> Text CDR parameters -> CDR format (Start): ,RN='@{ScriptAttribute:RN}'
Gateway -> Text CDR parameters -> CDR format (End): ,RN='@{ScriptAttribute:RN}'
And replace the called fields:
Gateway -> Text CDR parameters -> CDR format (Start): ,Called='@{ScriptAttribute:Called2}'
Gateway -> Text CDR parameters -> CDR format (End): ,Called='@{ScriptAttribute:Called2}'
See instructions here: [[Text_Call_Detail_Records]] 

== Configure LNP Settings ==
LNP settings need to be:
profiles -> Outgoing calls LNP mode: Relay LNP Information
profiles -> Incoming calls LNP mode: Forward LNP from incoming to outgoing call
See instructions here: [[Modify_LNP_profile_D]]

@@ Line 1: / Line 1: @@
 === '''''Applies to version(s): v3.1, v3.2''''' ===
-{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions - INCOMPLETE}}
+{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions}}
 This shows how to add '''youmail_spam_risk.rb''' script to any Routing scripts.
@@ Line 74: / Line 74: @@
 There may be other scripts called by this 'Main' script, this is normal.

@@ Line 4: / Line 4: @@
 == Requirements for this script  ==
-# Devices must be installed with release 3.1.113 or later.
+* Devices must be installed with release 3.1.113 or later.
-# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
+* The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
-# Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.
+* Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.
 <br>

@@ Line 4: / Line 4: @@
 == Requirements for this script  ==
 # The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
 # Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.

@@ Line 30: / Line 30: @@
 <pre>Gateway -&gt; Routing scripts -&gt; simple_routing_sbc.rb [Edit]
 </pre>
-Four things need to be added. At the start of the script:<br>
+Three things need to be added. At the start of the script:<br>
 <pre>require 'youmail_spam_risk'
 </pre>
@@ Line 71: / Line 71: @@
 end
 </pre>

@@ Line 28: / Line 28: @@
 <br>
 Go to the routing script section of the Web portal
-<pre>Gateway -&gt; Routing scripts -&gt; Example Scripts -&gt; simple_routing_sbc.rb [Edit]
+<pre>Gateway -&gt; Routing scripts -&gt; simple_routing_sbc.rb [Edit]
 </pre>
 Four things need to be added. At the start of the script:<br>

@@ Line 4: / Line 4: @@
 == Requirements for this script  ==
-# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface.
+# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
 == Add '''youmail_spam_risk.rb''' Scripts in system<br>  ==
@@ Line 10: / Line 12: @@
 {| cellpadding="5" border="1" class="wikitable"
 |-
-! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" |Capture DTMF Script
+! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" |YouMail spam risk ruby script
 |-
 | valign="top" |
-*[[Media:R_n_cdr.zip|R_n_cdr.rb]]
+*[[Media:Youmail_spam_risk.zip‎|Youmail_spam_risk.rb]]
 |}
 Then upload it in the system with these instructions:
-[[Import_Customized_Routing_Script_C]]
+[[Import_Customized_Routing_Script_C|Import Customized Routing Script]]
-== Setting up '''Routing Number''' Scripts<br>  ==
+== Setting up '''YouMail spam risk''' Scripts<br>  ==
-To setup a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script.<br>
+To setup a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script with the 'Main' type.<br>
-First, go to the routing script section of the Web portal
+<br>
 <pre>Gateway -&gt; Routing scripts -&gt; Example Scripts -&gt; simple_routing_sbc.rb [Edit]
 </pre>
 Four things need to be added. At the start of the script:<br>
-<pre>require 'r_n_cdr'
+<pre>require 'youmail_spam_risk'
 </pre>
 In the main class:<br>
-<pre>include RnCdr
+<pre>include YouMailSpamRisk
 </pre>
-<pre>before_filter :method => :RN_cdr
+<pre>   after_filter :method                      => :filter_by_https_spam_risk,
-</pre>
+                :server_url                  => "https://dataapi.youmail.com/api/v2/",
-<pre>after_remap_filter :method => :Swap_back
+                :data_api_sid                => "abc123",  # Need to get the sid and key from YouMail
 </pre>
 <br>
-The final script will look like this:
+The final 'Main' script will look like this:
 <pre>
 require 'base_routing'
-require 'r_n_cdr'
+require 'youmail_spam_risk'
 class SimpleRouting < BaseRouting
-   include RnCdr
+   include YouMailSpamRisk
    route_match :call_field_name => :called
    route_match :call_field_name => :calling
    route_match :call_field_name => :nap
    route_remap :call_field_name => :called, :route_field_name => :remapped_called
    route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
    route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
 end
 </pre>
-== Update Text CDR Configuration <br>  ==
-To have the Routing Number (RN) in the CDR logs, add these fields:
- Gateway -> Text CDR parameters -> CDR format (Start): ,RN='@{ScriptAttribute:RN}'
- Gateway -> Text CDR parameters -> CDR format (End):   ,RN='@{ScriptAttribute:RN}'
-And replace the called fields:
- Gateway -> Text CDR parameters -> CDR format (Start): ,Called='@{ScriptAttribute:Called2}'
- Gateway -> Text CDR parameters -> CDR format (End):   ,Called='@{ScriptAttribute:Called2}'
-See instructions here: [[Text_Call_Detail_Records]]  <br>
-−
-== Configure LNP Settings ==
-LNP settings need to be:
- profiles -> Outgoing calls LNP mode: Relay LNP Information
- profiles -> Incoming calls LNP mode: Forward LNP from incoming to outgoing call
-See instructions here: [[Modify_LNP_profile_D]]  <br>