Differences

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

--- cookbooks:devel:pseudovariables [2019/11/15 14:21] – giavac
+++ cookbooks:devel:pseudovariables [2022/04/11 13:24] (current) – geoip2 henningw
@@ Line 1: / Line 1: @@
+====== Pseudo-Variables ======
+Version: Kamailio SIP Server v5.6.x (devel)
 {{ :cookbooks:devel:pseudovariables.png?200|}}
-====== Kamailio SIP Server v5.4.x (devel): Pseudo-Variables ======
 ===== Introduction =====
@@ Line 168: / Line 171: @@
 <code c>
 xlog("$$avp(x) fount $cnt($avp(x)) times\n");
+</code>
+**$cnt(xavp)** - return the number of xavps
+<code>
+ * $cnt($xavp(key[*])) : number of XAVPs "key".
+ * $cnt($xavp(key[n]=>sub[*])) : number of children "sub" in XAVP "key[n]".
+ * $cnt($xavp(key[*]=>sub[*])) : total number of children "sub" in all XAVPs "key".
+ * $cnt($xavp(key[n])) : 1 or 0 (if this index exists or not).
+ * $cnt($xavp(key[-n])) : same but with reverse indexing (-1 is the last index).
+ * $cnt($xavp(key[*]=>sub[n])) : number of children "sub[n]" that exist in all XAPVs "key".
+ * $cnt($xavp(key)) is the same as $cnt($xavp(key[*])).
+ * $cnt($xavp(key=>sub)) is the same as $cnt($xavp(key[*]=>sub[*]))
 </code>
 ==== $conid - TCP Connection ID ====
@@ Line 193: / Line 212: @@
 **$dd** - reference to domain of destination uri (without port)
+==== $def(name) - Defined Value ====
+**$def(name)** - return a defined value.
+Example:
+<code c>
+#!define ABC xyz
+xlog("FLT_ACC: $def(ABC)\n");
+</code>
+==== $defn(name) - Defined Value As Number ====
+**$defn(name)** - return a defined value as a signed integer.
+Example:
+<code c>
+#!define FLT_ACC 1
+xlog("FLT_ACC: $defn(FLT_ACC)\n");
+</code>
 ==== $di - Diversion header URI ====
@@ Line 243: / Line 284: @@
 **$fd** - reference to domain in URI of 'From' header
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $fn - From display name ====
@@ Line 248: / Line 291: @@
 **$fn** - reference to display name of 'From' header
-==== $fs - Forced socket ====
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
-**$fs** - reference to the forced socket for message sending (if any) in the form proto:ip:port
+==== $fs - Forced Send Socket ====
+**$fs** - reference to the forced send socket for the SIP message (if any) in the form "proto:ip:port". It is the socket from where Kamailio is going to send out the message.
 <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file). Transport proto can be omitted when assigning value, in which case it is taken from destination URI of the message.</fc>
+Example:
+<code c>
+listen=udp:1.2.3.4:5060
+...
+$fs = "udp:1.2.3.4:5060";
+</code>
+==== $fsn - Forced Send Socket Name ====
+**$fsn** - reference to the name of the forced send socket for the SIP message. The name can be assigned to this variable to select a send socket via its name.
+<code c>
+listen=udp:1.2.3.4:5060 name "s1"
+...
+$fsn = "s1";
+...
+$fs = "udp:1.2.3.4:5060";
+xdbg("name for forced send socket: $fsn\n");
+</code>
 ==== $ft - From tag ====
@@ Line 269: / Line 335: @@
 **$fu** - reference to URI of 'From' header
-<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
 ==== $fU - From URI username ====
 **$fU** - reference to username in URI of 'From' header
-<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
+==== $fUl - From URI Username Length ====
+**$fUl** - length of the username in the From URI
 ==== $mb - SIP message buffer ====
@@ Line 331: / Line 403: @@
 **$oU** - reference to username in request's original URI
+==== $oUl - Original R-URI Username Length ====
+**$oUl** - the length of the username in the original R-URI
 ==== $pd - Domain in P-Preferred-Identity header URI ====
@@ Line 380: / Line 456: @@
 **$retcode** - same as **$rc**
+Note that the value of $rc is overwritten by each new function call.
+Example of use:
+<code c>
+	lookup("location");
+	$var(rc) = $rc;
+	if ($var(rc) < 0) {
+		t_newtran();
+		switch ($var(rc)) {
+			case -1:
+			case -3:
+				send_reply("404", "Not Found");
+				exit;
+			case -2:
+				send_reply("405", "Method Not Allowed");
+				exit;
+		}
+	}
+</code>
 ==== $rd - Domain in R-URI ====
@@ Line 455: / Line 552: @@
 <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+==== $rUl - R-URI Username Length ====
+**$rU** - the length of the username in R-URI
 ==== $rv - SIP message version ====
@@ Line 481: / Line 582: @@
 **$Rp** - reference to the port where the message was received
+==== $Rn - Received socket name ====
+**$Rn** - reference to the name of the socket where the message was received
 ==== $RAu - Advertised socket URI ====
@@ Line 571: / Line 676: @@
 **$td** - reference to domain in URI of 'To' header
+<fc #0000FF>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $tn - To display name ====
 **$tn** - reference to display name of 'To' header
+<fc #0000FF>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $tt - To tag ====
@@ Line 590: / Line 699: @@
 **$tu** - reference to URI of 'To' header
+<fc #0000FF>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $tU - To URI Username ====
 **$tU** - reference to username in URI of 'To' header
+<fc #0000FF>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
+==== $tUl - To URI Username Length ====
+**$tU** - the length of the username in To URI
 ==== $Tb - Startup timestamp ====
@@ Line 639: / Line 756: @@
 **$env(NAME)** - value of the environment variable named NAME
+Example:
+<code c>
+xdbg("PATH environment variable:  $env(PATH)\n");
+</code>
 ===== $avp(id) - AVPs =====
@@ Line 709: / Line 831: @@
 ===== $xavp(id) - XAVPs =====
-xavp - extended AVP's - are structures that can store multiple values. They work like a stack, much like AVPs, and are attached to SIP transactions. Each xavp has a name and can contain multiple named values, the structure name and the value name are separated by <nowiki>=></nowiki> like <nowiki>$xavp(root=>branch)</nowiki> where "root" is the name of the structure and branch is a named value. To assign a value use
+**xavp** - eXtended AVPs - are variables that can store multiple values, which can also be grouped in a structure-like fashion. Their value can be a string, an integer number or a list of named values (child values).
+They work like a stack, similar to AVPs, and are attached to SIP transactions and automatically destroyed when the transaction is finished.
+Each xavp has a string name and can contain a string, and integer or a list of named values. The structure name (or root list name) and the value name (or field name, or child value name) are separated by <nowiki>=></nowiki> like <nowiki>$xavp(root=>field)</nowiki> where "root" is the name of the structure and "field" is the name of the (child) value.
+To assign a single value use:
 <code c>
-$xavp(root=>branch)="value";
+$xavp(root)="string value";
+$xavp(root)=intnumber;
+</code>
+To assign a named value use:
+<code c>
+$xavp(root=>field)="string value";
+$xavp(root=>field)=intnumber;
 </code>
 Like avps, xavp act like a stack. To refer to an existing value, use an index. The newest xavp has index zero [0].
 <code c>
-$xavp(root[0]=>newbranch)=12;
+$xavp(root[0]=>field)=12;
 </code>
 If you assign a value without an index, a new xavp is allocated and the old one is pushed up the stack, becoming index [1]. Old index [1] becomes [2] etc.
 <code c>
-$xavp(example=>name)="one";
+# new item (person => [(lastname = "Smith")])
-#create new
+$xavp(person=>lastname)="Smith";
-$xavp(example=>name)="two";
-#add extra value to "two"
+# add new item (person => [(lastname = "Doe")])
-$xavp(example[0]=>value)="John";
+$xavp(person=>lastname)="Doe";
-#add value to first variable - "one"
-$xavp(example[1]=>value)="Anna";
+# add another named value to the last example item
+#   (person => [(firstname="John"), (lastname = "Doe")])
+$xavp(person[0]=>firstname)="John";
+# add another named value to first example item
+#   (person => [(firstname="Alice"), (lastname = "Smith")])
+xavp(person[1]=>firstname)="Alice";
 </code>
@@ Line 733: / Line 878: @@
 Another example:
 <code c>
-# Create new xavp
+# create new (the first) root xavp with a named value of string type
 $xavp(sf=>uri)="sip:10.10.10.10";
-#assign values
+# add named values (child values)
 $xavp(sf[0]=>fr_timer)=10;
 $xavp(sf[0]=>fr_inv_timer)=15;
 $xavp(sf[0]=>headers)="X-CustomerID: 1234\r\n";
-#create new xavp, moving previous one to sf[1]
+# create new (the second) root xavp with a named value of string type, moving previous one to sf[1]
 $xavp(sf=>uri)="sip:10.10.10.11";
+# add named values (child values)
 $xavp(sf[0]=>fr_timer)=20;
 $xavp(sf[0]=>fr_inv_timer)=35;
-#Create a third xavp
+# create new (the third) xavp with a named value of string type, moving previous one to sf[1] and the other one to sf[2]
 $xavp(sf=>uri)="sip:10.10.10.12";
+# add named values (child values)
 $xavp(sf[0]=>fr_timer)=10;
 $xavp(sf[0]=>fr_inv_timer)=15;
@@ Line 753: / Line 900: @@
 </code>
-xavps are read and write variables. You can create multilevel xavps, as xavps may contain xavps.
+xavps are read and write variables.
+===== $xavu(id) - XAVUs =====
+Similar to XAVPs, but with single value items, therefore there are no indexes in the naming format. XAVUs are also stored in transaction context and destroyed when the transaction is terminated.
+Examples:
+<code c>
+$xavu(x) = 123; # <- set the value
+$xavu(x) = 234; # <- update to the value, not adding to a list like for xavps
+$xavu(x) = $null; # <- delete the xavu
+$xavu(a=>b) = "xyz"; # <- two level naming supported
+</code>
+===== $xavi(id) - XAVIs =====
+Similar to XAVPs, but with key names are case insensitive. XAVIs are also stored in transaction context and destroyed when the transaction is terminated.
+Examples:
+<code c>
+$xavi(WhatEver=>FoO) = 123; # <- set the value
+# $xavi(whatever[0]=>foo) == 123
+</code>
 ===== $hdr(name) - Headers =====
-**$hdr(name)** - represents the body of first header identified by 'name'
+**$hdr(name)** - represents the body of first header field identified by 'name'
-**$(hdr(name)[N])** - represents the body of the N-th header identified by 'name'.
+**$(hdr(name)[N])** - represents the body of the N-th header field identified by 'name'.
 If [N] is omitted then the body of the first header is printed. The body of first header is returned when N=0, for the second N=1, a.s.o. In case of a comma-separated multi-body headers, it returns all the bodies, comma-separated. To print the last header of that type, use -1, or other negative values to count from the end. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.
@@ Line 778: / Line 949: @@
 <fc #0000ff>It is read-only variable. You can remove or add headers using functions from textops module.</fc>
+===== $hfl(name) - Header Field With List Of Bodies =====
+Similar to **$hdr(name)**, but for some of the standard headers that can have many bodies serialized in the same header field (i.e., comma separated list of bodies in same header field) is able to return the individual body values.
+Implemented for:
+  * Contact
+  * Record-Route
+  * Route
+  * Via
+For the rest of the headers works like **$hdr(name)**.
+**$hfl(name)** - represents the first body of first header field identified by 'name'.
+**$(hfl(name)[N])** - represents the body of the N-th header field identified by 'name'.
+Example of usage:
+<code c>
+if($(hfl(Via)[1])=~"TLS") {
+...
+}
+</code>
 ===== $hdrc(name) - Number of Headers =====
@@ Line 790: / Line 985: @@
 </code>
+===== $hflc(name) - Number of Header Bodies =====
+Similar to **$hdrc(name)**, but for some of the standard headers that can have many bodies serialized in the same header field (i.e., comma separated list of bodies in same header field) is able to count the number of individual bodies.
+Implemented for:
+  * Record-Route
+  * Route
+  * Via
+For the rest of the headers works like **$hdrc(name)**.
+Example of usage:
+<code c>
+if($hflc(Via)==3) {
+...
+}
+</code>
 ===== $var(name) - Private memory variables (zero) =====
@@ Line 857: / Line 1072: @@
 <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+===== $dsv(key) - Dispatcher variables =====
+Return attributes related to dispatcher module.
+The key can be:
+  * code - the SIP response code that caused the execution of event_route 'dispatcher:dst-up' or 'dispatcher:dst-down', if available
+  * reason - the SIP response reason that caused the execution of event_route 'dispatcher:dst-up' or 'dispatcher:dst-down', if available
+  * flags - flags set internally when executing event_route 'dispatcher:dst-up' or 'dispatcher:dst-down'
 ===== $time(name) - Broken-down time =====
@@ Line 905: / Line 1129: @@
 <code c>
 xlog("The time is $utimef(%m/%d/%y %H:%M:%S)\n");
+</code>
+===== $ccp(key) - Config Custom Parameters =====
+Get the value for global custom parameters:
+  * https://www.kamailio.org/wiki/cookbooks/devel/core#custom_global_parameters
+Example:
+<code c>
+gv.sval = "hello" desc "hello var"
+gv.ival = 10 desc "ten var"
+request_route {
+    xinfo("global vars: $ccp(gv.sval) :: $ccp(gv.ival)\n");
+}
 </code>
@@ Line 948: / Line 1190: @@
 }
 </code>
+===== $rpl(key) =====
+Attributes of the SIP reply processed at that moment. The variables must be used during SIP reply processing, otherwise it returns $null.
+The key can be:
+  * duri - SIP URI corresponding to the address where the SIP reply is going to be sent based on 2nd via
+  * dhost - host part of duri
+  * dport - port part of duri
+  * dproto - proto part of duri
+  * dprotoid - proto id of duri
+  * cntvia - the number of Via header bodies
+Example of usage:
+<code c>
+reply_route{
+  xinfo("reply to be sent to: $rpl(duri)\n");
+}
+</code>
+===== $msgbuf(index) =====
+Get or set the character in the message buffer at the position index.
+The index has to be a positive integer or a variable holding such value.
+Note that the variable returns a clone of the character stored in a static buffer, copy it to another variable if you want to compare with another $msgbuf(index).
+The update is done directly and immediately in the message buffer -- use it with care!
+Example of usage:
+<code c>
+if ($msgbuf(20)=="V") {
+    $msgbuf(20) = "v";
+}
+</code>
+===== Header Field Iterator =====
+==== $hfitname(iname) ====
+The header name of the header field iterator.
+Example:
+<code c>
+    hf_iterator_start("i1");
+    while(hf_iterator_next("i1")) {
+        xlog("hdr[$hfitname(i1)] is: $hfitbody(i1)\n");
+    }
+    hf_iterator_end("i1");
+</code>
+==== $hfitbody(iname) ====
+The header body of the header field iterator.
+Example:
+<code c>
+    hf_iterator_start("i1");
+    while(hf_iterator_next("i1")) {
+        xlog("hdr[$hfitname(i1)] is: $hfitbody(i1)\n");
+    }
+    hf_iterator_end("i1");
+</code>
+===== Body Line Iterator =====
+==== $blitval(iname) ====
+The value of the body line iterator.
+Example:
+<code c>
+    bl_iterator_start("b1");
+    while(bl_iterator_next("b1")) {
+        xlog("body line: $blitval(b1)");
+    }
+    bl_iterator_end("b1");
+</code>
 ===== Send Data Attributes =====
@@ Line 985: / Line 1312: @@
 </code>
-===== Benchmark module Pseudo-Variables =====
+===== SIPDUMP Module =====
+==== $sipdump(name) ====
+**$sipdump(name)** - return attributes of the message handled in the event_route[sipdump:msg].
+The name can be:
+  * tag - the tag of processing (rcv or snd)
+  * buf - entire message buffer as string
+  * len - length of the message (length of above buf)
+  * af - address family
+  * src_ip - source IP address
+  * dst_ip - destination IP address
+  * src_port - port of source address
+  * dst_port - port of source address
+  * proto - transport protocol
+Example:
+<code c>
+event_route[sipdump:msg] {
+  if($sipdump(len) > 1024) {
+    ...
+  }
+}
+</code>
+===== SIPTRACE Module =====
+==== $siptrace(name) ====
+**$siptrace(name)** - return attributes of the message handled in the event_route[siptrace:msg].
+The name can be:
+  * src_addr - source socket address (proto:ip:port)
+  * dst_addr - destination socket address (proto:ip:port)
+  * src_host - source host, for IPv6 host contains `[]`
+  * dst_host - destination host, for IPv6 host contains `[]`
+  * src_hostip - source host, for IPv6 host do not contains `[]`
+  * dst_hostip - destination host, for IPv6 host do not contains `[]`
+  * src_port - source port
+  * dst_port - destination port
+  * src_proto - source proto
+  * dst_proto - destination proto
+Example:
+<code c>
+event_route[siptrace:msg]
+{
+    if (allow_address("1", "$siptrace(src_hostip)", "0")) {
+        return;
+    }
+    if (compare_ips($siptrace(src_host), "[2001:DB8::1]")) {
+        return;
+    }
+}
+</code>
+===== Benchmark Module =====
 ==== $BM_time_diff ====
 $BM_time_diff - the time difference elapsed between calls of bm_start_timer(name) and bm_log_timer(name). The value is 0 if no bm_log_timer() was called.
-===== Dialog module Pseudo-Variables =====
+===== Dialog Module =====
 ==== $dlg(attr) ====
@@ Line 1046: / Line 1437: @@
 The 'key' can be any string.
-===== Erlang module Pseudo-Variables =====
+===== Erlang Module =====
-==== Erlang pseudo-variable attributes ===
+==== Attributes ===
 * type - get variable type. Possible types are: atom, integer, list, string, tuple, pid and ref.
@@ Line 1057: / Line 1448: @@
 ==== $erl_atom(name) ====
 //$erl_atom(name)// pseudo variable allows create analog to Erlang atom data type.
 Erlang atom is a literal, a constant with name. Formatted output pseudo variable
@@ Line 1116: / Line 1508: @@
 module.
-===== HTable module Pseudo-Variables =====
+===== HTable Module =====
 ==== $sht(htable=>key) ====
@@ Line 1122: / Line 1514: @@
 Access hash table entries.
-<fc #0000ff>It is R/W variable, you can assign values to it directly in configuration file.  Hash table entry can be deleted by assigning value $null to it.</fc>
+<fc #0000ff>It is R/W variable, you can assign values to it directly in configuration file.  Hash table entry can be deleted by assigning value $null to it.  Value of a non-existing hash table entry is $null.</fc>
 The “htname” must be a hash table name defined via “htable” parameter.
@@ Line 1269: / Line 1661: @@
 }
 </code>
-===== Memcached module Pseudo-Variables =====
+===== Memcached Module =====
 ==== $mct(key) ====
@@ Line 1346: / Line 1738: @@
 </code>
-===== http_async_client module Pseudo-Variables =====
+===== http_async_client Module =====
 ==== $http_req_id ====
@@ Line 1421: / Line 1813: @@
 </code>
-===== TMX module Pseudo-Variables =====
+===== TMX Module =====
 ==== $T_branch_idx ====
-  * the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'.
+  * the index (starting with 0 for the first branch) of the branch for which is executed the branch_route[].
+  * in failure_route[] block, the value is the number of completed branches added to the number of new new branches
+  * in request_route block, the value is number of created branches
+  * in onreply_route[], the value is the index of the branch receiving the reply
+  * if used outside of transaction processing, the value is '-1'
 ==== $T_reply_ruid ====
@@ Line 1510: / Line 1906: @@
-===== UAC module Pseudo-Variables =====
+===== UAC Module =====
 ==== $uac_req(key) ====
@@ Line 1524: / Line 1920: @@
   * hdrs - SIP Headers
   * body - Body
+  * flags - flags for processing
+    * 1 - the password is provided in HA1 format
   * auser - authentication username
   * apasswd - authentication password
@@ Line 1546: / Line 1944: @@
 }
 </code>
-===== Nathelper module Pseudo-Variables =====
+===== Nathelper Module =====
 ==== $rr_count ====
@@ Line 1556: / Line 1954: @@
   * If topmost Record Route in received SIP request or reply is a double Record Route, value of $rr_top_count is 2. If it a single Record Route, value of $rr_top_count is 1. If there is no Record Route(s), value of $rr_top_count is 0.
-===== MQueue module Pseudo-Variables =====
+===== MQueue Module =====
 ==== $mqk(q) ====
@@ Line 1593: / Line 1991: @@
 ==== $nh(key) ====
-Return attributes of next hop for the SIP request. Address is taken from dst_uri, if set, if not from new r-uri or original r-uri.
+Return attributes of next hop for the SIP messages. For SIP requests, the address is taken from dst_uri, if set, if not from new r-uri or original r-uri. For SIP replies, the attributes are taken from 2nd Via header (username is always $null for SIP replies).
   * $nh(u) - uri (lower case u)
@@ Line 1689: / Line 2087: @@
 </code>
-===== TLS module Pseudo-Variables =====
+==== $gip2(pvc=>key) ====
+Variables exported by GeoIP2 module, returning geo-location attributes. The attributes are populated upon calling function **geoip_match2(ipaddr, pvc)**.
+**pvc** (container id) is second parameter of geoip_match2(..) and **key** can be:
+  * cc - country code
+  * tz - time zone
+  * zip - postal code
+  * lat - latitude
+  * lon - longitude
+  * dma - dma code
+  * ips - ip start
+  * ipe - ip end
+  * city - city
+  * area - area code
+  * regc - region
+  * regn - region name
+  * metro - metro code
+  * contc - continent code
+You can call several time **geoip_match(ipaddr, pvc)** with different ip address and containers in your config, to compare, for example, attributes of source and destination of a call.
+<code c>
+geoip_match2("$si", "src");
+geoip_match2("$nh(d)", "dst");
+if($gip2(src=>cc)==$gip2(dst=>cc))
+{
+    # source and destination from same country
+}
+</code>
+===== TLS Module =====
+==== $tls(key) ====
+Variables related to TLS communication and certificates.
+The **key** can be:
+  * **m_issuer_line** - return local (my) certificate issuer line
+  * **p_issuer_line** - return remote (peer) certificate issuer line
+  * **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 ====
 The TLS/SSL version which is used on the TLS connection from which the message was received. String type.
 ==== $tls_description ====
@@ Line 1805: / Line 2257: @@
 ==== $tls_peer_server_name ====
 The SNI server name of the peer
+==== $tls_peer_raw_cert ====
+The raw PEM-encoded client certificate. String type.
+==== $tls_my_raw_cert ====
+The raw PEM-encoded client certificate. String type.
+==== $tls_peer_urlencoded_cert ====
+The PEM-encoded client certificate, urlencoded. String type.
+==== $tls_my_urlencoded_cert ====
+The PEM-encoded client certificate, urlencoded. String type.
 ===== SIP Message Attributes =====
@@ Line 1815: / Line 2279: @@
   * $msg(body) - sip message body
   * $msg(body_len) - sip message body length
-  * $msg(hdrs) - sip message headers
+  * $msg(hdrs) - sip message headers (surrounding white space and EoL chars trimmed)
-  * $msg(fline) - sip message first line
+  * $msg(fline) - sip message first line (surrounding white space and EoL chars trimmed)
+  * $msg(fpart) - sip message first line and the headers
+  * $msg(lpart) - sip message headers and the body
+===== POSOPS Module =====
-===== XHTTP module Pseudo-Variables =====
+==== $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 =====
 ==== $hu ====
@@ Line 1824: / Line 2301: @@
   * URL of http request.
-===== MSRP Module Pseudo Variables =====
+===== MSRP Module =====
 This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames.
 ==== $msrp(buf) ====
 The entire content of MSRP frame - first line, headers, body and end-line.
 ==== $msrp(body) ====
 The body of MSRP frame.
 ==== $msrp(code) ====
 The code of MSRP replies.
 ==== $msrp(hdrs) ====
 The headers in a MSRP frame.
 ==== $msrp(msgid) ====
 The body of Message-Id header.
 ==== $msrp(method) ====
 The method of a MSRP request.
 ==== $msrp(buflen) ====
 The length of entire MSRP frame.
 ==== $msrp(sessid) ====
 The session id for MSRP frame. It is taken from the first MSRP URI in To-Path header.
 ==== $msrp(reason) ====
 The reason text in a MSRP reply.
 ==== $msrp(crthop) ====
 The URI for current hop - it is the first URI in To-Path header.
 ==== $msrp(bodylen) ====
@@ Line 1864: / Line 2352: @@
 The transaction ID from the first line of MSRP frame.
 ==== $msrp(prevhop) ====
 The MSRP URI of the previous hop - the first address in From-Path header.
 ==== $msrp(nexthop) ====
 The URI of the next hop - the second address in To-Path header.
 ==== $msrp(lasthop) ====
 The last hop URI - the last address in To-Path header.
 ==== $msrp(srcaddr) ====
 The address of the previous hop set as MSRP URI using received source IP and port.
 ==== $msrp(srcsock) ====
-The local socket where the MSRP frame was received, set as **proto:ipaddr:port".
+The local socket where the MSRP frame was received, set as **proto:ipaddr:port**.
 ==== $msrp(firsthop) ====
 The URI of the first hop - the last address in From-Path header.
 ==== $msrp(prevhops) ====
 The number of previous hops - it is the number of addresses in From-Path header.
 ==== $msrp(nexthops) ====
@@ Line 1893: / Line 2389: @@
 The internal integer id for TCP/TLS connection.
-===== SIPT module Pseudo-Variables =====
+===== SIPT Module =====
 ==== $sipt(calling_party_number.presentation) / $sipt_presentation ====
@@ Line 2016: / Line 2512: @@
   * 2 charge
   * 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.
@@ Line 2108: / Line 2713: @@
   * body - the body of the JSONRPC response
-===== Presence Module Pseudo-Variables =====
+===== $lsock(expr) =====
+Get attributes for listen sockets (from corex module).
+The **expr** is an expression specifying what to match and return, the format is:
+<code>
+matchid/value/field
+</code>
+The **expr** can contain variables that are evaluated before parsing the expression.
+The **matchid** can be:
+  * n - match on name
+  * l - match on listen address
+The **value** specifies what to match with.
+The **field** can be (only first character matches):
+  * name - return name
+  * listen - return the listen address
+  * advertise - return the advertise address
+  * index - return the index in the list of all sockets
+Example:
+<code>
+listen=udp:127.0.0.1:5060 advertise 127.0.0.1:5090 name "s0"
+...
+xinfo("$lsock(n/s0/listen)\n");
+xinfo("$lsock(l/udp:127.0.0.1:5060/name)\n");
+$var(s0) = "n/s0/listen";
+xinfo("$lsock($var(s0))\n");
+</code>
+===== Evrexec Module =====
+==== $evr(key) ====
+evrexec attributes:
+  * $evr(data) - processing data
+  * $evr(srcip) - source ip
+  * $evr(srcport) - sourceport as string
+  * $evr(srcportno) - source port as number
+===== Presence Module =====
 ==== $subs(key) - Subscription Attributes ====
@@ Line 2117: / Line 2771: @@
   * uri - subscription URI. Useful in particular for subscriptions within the dialog, when the request URI in SUBSCRIBE is the Contact address from the initial subscription.
-===== Registrar Module Pseudo-Variables =====
+===== Registrar Module =====
 ==== $ulc(profile=>attr) - Registered Contact Attributes ====
@@ Line 2125: / Line 2779: @@
 It must be used after a call of “reg_fetch_contacts()”.
-===== sipcapture Module Pseudo-Variables =====
+===== Sipcapture Module =====
 ==== $hep(key) - HEP Packet Attributes ====
@@ Line 2137: / Line 2791: @@
   * 0x999 - HEP attribute 0x999
-===== $phn(rid=>key) - Phonenum Variables =====
+===== Phonenum Variables =====
 $phn(rid=>key) - rid is an identifier for this query result; it is designated by the second parameter of phonenum_match(). The key can be one of the following:
@@ Line 2159: / Line 2813: @@
 </code>
+===== SecSIPId Variables =====
+$secsipid(key) - return attributes of secsipid module.
+The key can be:
+  * val - the value of Identity computed by secsipid_build_identity(...)
+  * ret - the return code of the libsecsipid function used by secsipid_build_identity(...)
+Example:
+<code c>
+if(secsipid_build_identity("$fU", "$rU", "A", "",
+        "https://kamailio.org/stir/$rd/cert.pem", "/secsipid/$rd/key.pem")) {
+    xinfo("identity value: $secsipid(val)\n");
+}
+</code>
 ===== sdpops module variables =====
@@ Line 2177: / Line 2847: @@
   * $ltt(x) - $ltt(t) if the transaction was created already, otherwise $ltt(s)
+===== $via0(attr) - Via[0] Attributes =====
+$via0(attr) - attributes of first Via header.
+The attr can be:
+  * host - host part (string)
+  * port - port (number)
+  * proto - protocol - transport part (string)
+  * protoid - protocol id (integer id)
+  * branch - branch parameter
+  * rport - rport parameter value (string)
+  * received - received parameter value (string)
+  * i - i parameter value (string)
+===== $via1(attr) - Second Via Attributes =====
+$via1(attr) - attributes of second Via header. The attr can be the same as for $via0(attr).
+===== $viaZ(attr) - Last Via Attributes =====
+$viaZ(attr) - attributes of last Via header. The attr can be the same as for $via0(attr).
 ===== tcpops module variable =====
@@ Line 2185: / Line 2877: @@
   * c_sp - connection source port (useful with HAProxy connections)
   * conid - connection id
+===== pv_headers module variables =====
+  * $x_hdr(//header_name//): //header_name// header value
+  * $x_fu: Full From header
+  * $x_fU: From header user part
+  * $x_fd: From header domain part
+  * $x_fn: From header Display Name part
+  * $x_ft: From header Tag
+  * $x_tu: Full To header
+  * $x_tU: To header user part
+  * $x_td: To header domain part
+  * $x_tn: To header Display Name part
+  * $x_tt: To header Tag
+  * $x_rs:
+  * $x_rr:
 ===== $C(xy) - Foreground and background colors =====
@@ Line 2203: / Line 2912: @@
+===== $K(key) - Kamailio Constants =====
+$K(key) - return the numeric values corresponding to Kamailio configuration constants.
+The key can be:
+  * IPv4 - return AF_INET
+  * IPv6 - return AF_INET6
+  * UDP - return PROTO_UDP
+  * TCP - return PROTO_TCP
+  * TLS - return PROTO_TLS
+  * SCTP - return PROTO_SCTP
+  * WS - return PROTO_WS
+  * WSS - return PROTO_WSS
+<code c>
+xinfo("proto UDP numeric id: $K(UDP)\n");
+</code>
 ===== Examples =====