User Tools

Site Tools


cookbooks:devel:pseudovariables

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
cookbooks:devel:pseudovariables [2021/07/30 12:38]
miconda [Send Data Attributes]
cookbooks:devel:pseudovariables [2021/11/24 18:11]
miconda [$tls_version]
Line 1201: Line 1201:
 ===== Header Field Iterator ===== ===== Header Field Iterator =====
  
-====== $hfitname(iname) ======+==== $hfitname(iname) ====
  
 The header name of the header field iterator. The header name of the header field iterator.
Line 1215: Line 1215:
 </code> </code>
  
-====== $hfitbody(iname) ======+==== $hfitbody(iname) ====
  
 The header body of the header field iterator. The header body of the header field iterator.
Line 1231: Line 1231:
 ===== Body Line Iterator ===== ===== Body Line Iterator =====
  
-====== $blitval(iname) ======+==== $blitval(iname) ====
  
 The value of the body line iterator. The value of the body line iterator.
Line 2056: Line 2056:
  
 ===== TLS Module ===== ===== TLS Module =====
 +
 +==== $tls(key) ====
 +
 +Variables related to TLS communication and certificates.
 +
 +The **key** can be:
 +
 +  * **m_subject_line** - return local (my) certificate subject line
 +  * **p_subject_line** - return remote (peer) certificate subject line
 +
 +Example:
 +
 +<code c>
 +if(proto==TLS) {
 +    xinfo("local certificate subject: $tls(m_subject_line)\n");
 +}
 +</code>
  
 ==== $tls_version ==== ==== $tls_version ====
 +
 The TLS/SSL version which is used on the TLS connection from which the message was received. String type. The TLS/SSL version which is used on the TLS connection from which the message was received. String type.
 ==== $tls_description ==== ==== $tls_description ====
Line 2195: Line 2213:
   * $msg(hdrs) - sip message headers   * $msg(hdrs) - sip message headers
   * $msg(fline) - sip message first line   * $msg(fline) - sip message first line
 +
 +===== POSOPS Module =====
 +
 +==== $pos(key) ====
 +
 +Get attributes after a function of the module is executed.
 +
 +The key can be:
 +
 +  * ret - the return code on success or -1
 +  * idx - position inside message buffer, for find/search it is the start of matching
 +  * len - the length of matching string for search functions
  
 ===== XHTTP Module ===== ===== XHTTP Module =====
Line 2394: Line 2424:
   * 2 charge   * 2 charge
   * 3 spare   * 3 spare
 +
 +
 +==== $sipt(redirection_info) / $sipt_redirection_info ===
 +Returns the value of the Redirecting reason of the Call Diversion Information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Call Diversion Information is not present.
 +
 +Can return the following values:
 +
 +  * 0 Unknown
 +  * 1 User busy
 +  * 2 no reply
 +  * 3 unconditional
 +  * 4 deflection during alerting
 +  * 5 deflection immediate response
 +  * 6 mobile subscriber not reachable
 +
 +
 +==== $sipt(redirection_number) / $sipt_redirection_number ===
 +Returns the value (Address signal) of the Redirection Number.
 +Returns -1 if there is a parsing error or if the Redirection Number is not present.
 +
 +Example:
 +<code c>
 +# get the redirection number
 +$avp(s:redir_num) = $sipt(redirection_number);
 +</code>
 +
 +
 +==== $sipt(redirection_number.nai) / $sipt_redirection_number_nai ===
 +Returns the value of the Nature of Address Indicator of the Redirection Number. Returns -1 if there is a parsing error or if the Redirection Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(calling_party_number) ===
 +Returns the value (Address signal) of the Calling Party for the IAM message.
 +Returns -1 if there is a parsing error or if the Calling Party Number is not present.
 +
 +
 +==== $sipt(called_party_number) ===
 +Returns the value (Address signal) of the Called Party for the IAM message.
 +Returns -1 if there is a parsing error or if the Called Party Number is not present.
 +
 +
 +==== $sipt(sipt_redirection_information_reason) ===
 +Returns the value of the Redirection reason of the Redirection information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Redirection information is not present.
 +
 +
 +==== $sipt(sipt_redirection_information_original_reason) ===
 +Returns the value of the Original Redirection reason of the Redirection information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Redirection information is not present.
 +
 +
 +==== $sipt(redirecting_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Redirecting Number. Returns -1 if there is a parsing error or if the Redirecting Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(redirecting_number) ===
 +Returns the value (Address signal) of the Redirecting Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Redirecting Number is not present.
 +
 +
 +==== $sipt(original_called_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Original Called Number. Returns -1 if there is a parsing error or if the Original Called Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(original_called_number) ===
 +Returns the value (Address signal) of the Original Called Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Original Called Number is not present.
 +
 +
 +==== $sipt(generic_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Generic Number. Returns -1 if there is a parsing error or if the Generic Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(generic_number) ===
 +Returns the value (Address signal) of the Generic Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Generic Number is not present.
  
  
cookbooks/devel/pseudovariables.txt ยท Last modified: 2022/04/11 15:24 by henningw