modules: readme files regenerated - sipt ... [skip ci]

src/modules/sipt/README

@@ -23,6 +23,7 @@ Torrey Searle
                       called_category, e2e_indicator)
 
               3.3. sipt_set_calling(origin, nai, presentation, screening)
+              3.4. sipt_forwarding(origin, nai)
 
         4. Exported pseudo-variables
 
@@ -42,6 +43,10 @@ Torrey Searle
 
               4.7. $sipt(event_info)
               4.8. $sipt(backward_call_indicator.charge_indicator)
+              4.9. $sipt(redirection_info) / $sipt_redirection_info
+              4.10. $sipt(redirection_number) / $sipt_redirection_number
+              4.11. $sipt(redirection_number.nai) /
+                      $sipt_redirection_number_nai
 
    List of Tables
 
@@ -51,18 +56,22 @@ Torrey Searle
    1.4. Called Nature of Address Values
    1.5. Event Info Values
    1.6. Charge Indicator Values
+   1.7. Redirecting reason Values
+   1.8. Redirecting number NAI Values
 
    List of Examples
 
    1.1. sipt_destination(destination, hops, nai) usage
    1.2. sipt_destination(destination, hops, nai) usage
    1.3. sipt_set_calling(origin, nai, presentation, screening) usage
-   1.4. sipt_presentation pseudo-variable usage
-   1.5. sipt_screening pseudo-variable usage
-   1.6. sipt_hop_counter pseudo-variable usage
-   1.7. sipt_cpc pseudo-variable usage
-   1.8. sipt_calling_party_nai pseudo-variable usage
-   1.9. sipt_called_party_nai pseudo-variable usage
+   1.4. sipt_set_calling(origin, nai) usage
+   1.5. sipt_presentation pseudo-variable usage
+   1.6. sipt_screening pseudo-variable usage
+   1.7. sipt_hop_counter pseudo-variable usage
+   1.8. sipt_cpc pseudo-variable usage
+   1.9. sipt_calling_party_nai pseudo-variable usage
+   1.10. sipt_called_party_nai pseudo-variable usage
+   1.11. sipt_redirection_number usage
 
 Chapter 1. Admin Guide
 
@@ -77,6 +86,7 @@ Chapter 1. Admin Guide
                 called_category, e2e_indicator)
 
         3.3. sipt_set_calling(origin, nai, presentation, screening)
+        3.4. sipt_forwarding(origin, nai)
 
    4. Exported pseudo-variables
 
@@ -92,6 +102,9 @@ Chapter 1. Admin Guide
 
         4.7. $sipt(event_info)
         4.8. $sipt(backward_call_indicator.charge_indicator)
+        4.9. $sipt(redirection_info) / $sipt_redirection_info
+        4.10. $sipt(redirection_number) / $sipt_redirection_number
+        4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
 
 1. Overview
 
@@ -113,6 +126,7 @@ Chapter 1. Admin Guide
           e2e_indicator)
 
    3.3. sipt_set_calling(origin, nai, presentation, screening)
+   3.4. sipt_forwarding(origin, nai)
 
 3.1. sipt_destination(destination, hops, nai[, terminator=1])
 
@@ -160,6 +174,18 @@ sipt_set_bci_1("2", "1", "1", "0");
 sipt_set_calling($fU, 4, 0, 3);
 ...
 
+3.4. sipt_forwarding(origin, nai)
+
+   updates the IAM in the body if it exists, setting (or adding) the
+   forwarding number to “origin” with the nature address specified in
+   “nai”.
+
+   Example 1.4. sipt_set_calling(origin, nai) usage
+...
+# update the forwarding number to the value in the from header
+sipt_forwarfing($avp(s:forwarding_number), 3);
+...
+
 4. Exported pseudo-variables
 
    4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
@@ -174,6 +200,9 @@ sipt_set_calling($fU, 4, 0, 3);
 
    4.7. $sipt(event_info)
    4.8. $sipt(backward_call_indicator.charge_indicator)
+   4.9. $sipt(redirection_info) / $sipt_redirection_info
+   4.10. $sipt(redirection_number) / $sipt_redirection_number
+   4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
 
 4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
 
@@ -187,7 +216,7 @@ sipt_set_calling($fU, 4, 0, 3);
    2 address not avail (national use)
    3 spare
 
-   Example 1.4. sipt_presentation pseudo-variable usage
+   Example 1.5. sipt_presentation pseudo-variable usage
 ...
 # add privacy header if restriction is requested
 if($sipt(calling_party_number.presentation) == 1)
@@ -210,7 +239,7 @@ if($sipt(calling_party_number.presentation) == 1)
    2 Reserved (user provided, verified and failed)
    3 Network provided
 
-   Example 1.5. sipt_screening pseudo-variable usage
+   Example 1.6. sipt_screening pseudo-variable usage
 ...
 
 # remove P-Asserted-Identity header if the screening isn't verified
@@ -228,7 +257,7 @@ if($avp(s:screening) != 1 && $avp(s:screening) != 3)
    Returns the value of the Hop Counter for the IAM message if it exists.
    Returns -1 if there isn't a hop counter.
 
-   Example 1.6. sipt_hop_counter pseudo-variable usage
+   Example 1.7. sipt_hop_counter pseudo-variable usage
 ...
 # get the hop counter and update the Max-Forwards header if it exists
 $avp(s:hop) = $sipt(hop_counter);
@@ -245,7 +274,7 @@ if($avp(s:hop) > 0)
    Returns the value of the Calling Party Category for the IAM message.
    Returns -1 if there is a parsing error.
 
-   Example 1.7. sipt_cpc pseudo-variable usage
+   Example 1.8. sipt_cpc pseudo-variable usage
 ...
 # get the Cpc code and set put it in a custom sip header
 append_hf("X-CPC: $sipt(cpc)\r\n");
@@ -266,7 +295,7 @@ $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
    3 National (significant) number (national use)
    4 International use
 
-   Example 1.8. sipt_calling_party_nai pseudo-variable usage
+   Example 1.9. sipt_calling_party_nai pseudo-variable usage
 ...
 # get the Calling Nai and add country code if national
 if($sipt(calling_party_number.nai) == 3)
@@ -290,7 +319,7 @@ $sipt(called_party_number.nai) / $sipt_called_party_nai
    4 International use
    5 Network-specific number (national use)
 
-   Example 1.9. sipt_called_party_nai pseudo-variable usage
+   Example 1.10. sipt_called_party_nai pseudo-variable usage
 ...
 # get the Called Nai and add country code if national
 if($sipt(called_party_number.nai) == 3)
@@ -325,3 +354,41 @@ if($sipt(called_party_number.nai) == 3)
    1 no charge
    2 charge
    3 spare
+
+4.9. $sipt(redirection_info) / $sipt_redirection_info
+
+   Returns redirection info header from ISUP Returns "Redirecting reason"
+   or -1 if no redirection info found.
+
+   Table 1.7. Redirecting reason Values
+   0 Unknown
+   1 User busy
+   2 PROGRESS
+   3 no reply
+   4 deflection during alerting
+   5 deflection immediate response
+   6 mobile subscriber not reachable
+
+4.10. $sipt(redirection_number) / $sipt_redirection_number
+
+   Returns number to which redirection will trigered Returns -1 if there
+   is a parsing error.
+
+   Example 1.11. sipt_redirection_number usage
+...
+# get the redirection number
+$avp(s:redir_num) = $sipt(redirection_number);
+
+...
+
+4.11. $sipt(redirection_number.nai) / $sipt_redirection_number_nai
+
+   Returns NAI for redirection number from ISUP Returns NAI for
+   redirection number or -1 if no info found.
+
+   Table 1.8. Redirecting number NAI Values
+   0 Spare
+   1 Subscriber Number (national use)
+   2 Unknown (national use)
+   3 National (significant) number (national use)
+   4 International use