Differences

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

--- cookbooks:devel:pseudovariables [2017/02/27 18:13]
coudot $env() class
+++ cookbooks:devel:pseudovariables [2021/12/08 15:15] (current)
miconda [$msg(attr)]
@@ Line 1: / Line 1: @@
+====== Pseudo-Variables ======
+Version: Kamailio SIP Server v5.6.x (devel)
 {{ :cookbooks:devel:pseudovariables.png?200|}}
-====== Kamailio SIP Server v5.1.x (devel): Pseudo-Variables ======
 ===== Introduction =====
@@ Line 20: / Line 23: @@
   * avpops
   * htable
+  * http_async_client
   * textops
   * uac
@@ Line 76: / Line 80: @@
 **$aU** - whole username from Authorization or Proxy-Authorization header
-==== $Au - Acc username ====
+==== $Au - Acc username and realm/domain ====
-**$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.
+**$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns the auth username and realm ($au@$ar) if exists or From URI ($fu) otherwise.
+==== $AU - Acc username ====
+**$AU** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns the auth username ($au) if exists or From user ($fU) otherwise.
 ==== $branch(name) - Branch attributes ====
@@ Line 165: / 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 170: / Line 192: @@
 **$conid** - The TCP connection ID of the connection the current message arrived on for TCP, TLS, WS, and WSS.  Set to $null for SCTP and UDP.
-==== $cs - CSeq ====
+==== $cs - CSeq Number ====
-**$cs** - reference to the sequence number in the cseq header. The method in the CSeq header is identical to the request method, thus use $rm to get the method (works also for responses).
+**$cs** - reference to the sequence number in the CSeq header. The method in the CSeq header is identical to the request method, thus use $rm to get the method (works also for responses).
+==== $csb - CSeq Header Body ====
+**$csb** - reference to the CSeq header body (number method).
 ==== $ct - Contact header ====
@@ Line 187: / 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 222: / Line 269: @@
 If loose_route() returns TRUE a destination uri is set according to the first Route header.
-$du is also set if lookup() function of 'registrar' module finds contact(s) behind NAT. You can
+$du is also set if lookup() function of 'registrar' module finds contact(s) behind NAT or
-set $du to any SIP URI.
+if you use the path functionality. The function handle_ruri_alias() from the nathelper
+module will also set it. You can set $du to any SIP URI.
    sip:kamailio.org
    sip:pbx123.kamailio.org;transport=udp
@@ Line 236: / 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)</fc>
 ==== $fn - From display name ====
@@ Line 241: / Line 291: @@
 **$fn** - reference to display name of 'From' header
-==== $fs - Forced socket ====
+==== $fs - Forced Send Socket ====
-**$fs** - reference to the forced socket for message sending (if any) in the form proto:ip:port
+**$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 265: / Line 336: @@
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
 ==== $fU - From URI username ====
@@ Line 272: / Line 344: @@
 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 ====
 **$mb** - reference to SIP message buffer
+==== $mbu - updated SIP message buffer ====
+**$mbu** - reference to updated SIP message buffer, after applying changes
 ==== $mf - Flags ====
@@ Line 320: / Line 401: @@
 **$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 333: / Line 418: @@
 **$pp** - reference to process id (pid)
-==== $pr - Protocol of received message ====
+==== $pr or $proto - Protocol of received message ====
 **$pr** or **$proto** - protocol of received message (udp, tcp, tls, sctp, ws, wss)
+==== $prid - protocol id ====
+**$prid** - internal protocol id
+  * 0 - NONE
+  * 1 - UDP
+  * 2 - TCP
+  * 3 - TLS
+  * 4 - SCTP
+  * 5 - WS
+  * 6 - WSS
+  * 7 - OTHER
 ==== $pU - User in P-Preferred-Identity header URI ====
@@ Line 357: / Line 454: @@
 **$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 433: / Line 551: @@
 <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 ====
+**$rv** - reference to SIP message (reply or request) version
 ==== $ruid - Record internal Unique ID ====
@@ Line 440: / Line 565: @@
 **$rz** - returns R-URI scheme, possible values: sip, sips, tel, tels and urn, R-URI scheme parsing error should be reflected by value: none
+==== $RAi - Received advertised IP address ====
+**$RAi** - reference to advertised IP address of the interface where the request has been received, or $Ri if no advertised address.
+==== $RAp - Received advertised port ====
+**$RAp** - reference to advertised port where the request has been received, or $Rp if no advertised port.
 ==== $Ri - Received IP address ====
 **$Ri** - reference to IP address of the interface where the request has been received
 ==== $Rp - Received port ====
 **$Rp** - reference to the port where the message was received
+==== $RAu - Advertised socket URI ====
+**$RAu** - local socket where the SIP messages was received in URI format, without transport parameter for UDP, using advertised address when available.
+==== $RAut - Advertised socket URI ====
+**$RAut** - local socket where the SIP messages was received in URI format, always with transport parameter, using advertised address when available.
+==== $Ru - Received socket URI ====
+**$Ru** - local socket where the SIP messages was received in URI format, without transport parameter for UDP.
+==== $Rut - Received socket URI ====
+**$Rut** - local socket where the SIP messages was received in URI format, always with transport parameter.
+==== $sas - Source address in socket format ====
+**$sas** - get source address in socket format (proto:address:port).
 ==== $sbranch(attr) - Static Branch ====
@@ Line 476: / Line 627: @@
 ==== $si - Source IP address ====
-**$si** - reference to IP source address of the message
+**$si** - reference to IP source address of the message - see also $siz
+==== $sid - Server ID ====
+**$sid** - the value for server id (server_id parameter)
+==== $siz - Source IP address ====
+**$siz** - reference to IP source address of the message, with enclosing square brackets for IPv6
 ==== $sp - Source port ====
@@ Line 502: / Line 660: @@
 ==== $sut - Source address as full URI ====
-**$su** - returns the representation of source address (ip, port, proto) as full SIP URI. The proto UDP is added also as transport parameter.
+**$sut** - returns the representation of source address (ip, port, proto) as full SIP URI. The proto UDP is added also as transport parameter.
 Its value looks like:
@@ Line 535: / Line 693: @@
 **$tU** - reference to username in URI of 'To' header
+==== $tUl - To URI Username Length ====
+**$tU** - the length of the username in To URI
 ==== $Tb - Startup timestamp ====
@@ Line 567: / Line 729: @@
 **$ua** - reference to user agent header field
+==== $version() - version ====
+**$version(num)** - version as number
+**$version(full)** - full version string "name version architecture/platform"
+**$version(hash)** - TBA
 ===== $env(NAME) - environment variables =====
@@ Line 572: / Line 742: @@
 **$env(NAME)** - value of the environment variable named NAME
+Example:
+<code c>
+xdbg("PATH environment variable:  $env(PATH)\n");
+</code>
 ===== $avp(id) - AVPs =====
@@ Line 642: / Line 817: @@
 ===== $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 666: / Line 864: @@
 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 686: / Line 886: @@
 </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 first header is got 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.
+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.
+If name is *, then any header name is matched, e.g., $hdr(*) is body of first header, $(hdr(*)[-1]) is body of last header.
 The module should identify compact header names. It is recommended to use dedicated specifiers for headers (e.g., $ua for user agent header), if they are available -- they are faster.
@@ Line 709: / Line 935: @@
 <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 =====
+**$hdrc(name)** - get the number of headers with the respective name
+Example of usage:
+<code c>
+if($hdrc(Via) == 2) {
+...
+}
+</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 760: / Line 1042: @@
 ===== $shv(name) - Shared memory variables =====
-**$shv(name)**  - it is a class of pseudo-variables stored in shared memory. The value of $shv(name) is visible across all Kamailio processes. Each “shv” has single value and it is initialised to integer 0. You can use “shvset” parameter of **pv module** to initialize the shared variable. The module exports a set of MI functions to get/set the value of shared variables.
+**$shv(name)**  - it is a class of pseudo-variables stored in shared memory. The value of $shv(name) is visible across all Kamailio processes. Each “shv” has single value and it is initialised to integer 0. You can use “shvset” parameter of **pv module** to initialize the shared variable. The module exports a set of RPC functions to get/set the value of shared variables.
 Example - shv(name) pseudo-variable usage:
@@ Line 776: / Line 1058: @@
 <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 824: / Line 1115: @@
 <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 842: / Line 1151: @@
 }
 </code>
-===== Send Address Attributes =====
+===== Received Data Attributes =====
+==== $rcv(key) ====
+Attributes of received data. The variables must be used inside **event_route[core:msg-received]** routing block.
+The key can be:
+  * buf - received message
+  * len - lenght of received message
+  * srcip - source ip
+  * rcvip - local ip where it was received
+  * scrport - source port
+  * rcvport - local port where it was received
+  * proto - protocol as int id
+  * sproto - protocol as string
+  * af - address family
+Example of usage:
+<code c>
+event_route[core:msg-received] {
+  xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n");
+}
+</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 =====
 ==== $sndfrom(name) ====
@@ Line 861: / Line 1281: @@
   * af - address family to be used to send (numeric)
   * port - port of destination address
-  * proto - transport protocol to be used to send (numeric)
+  * proto - transport protocol to be used to send (numeric - UDP=1, TCP=2, TLS=3, SCTP=4, WS=5, WSS=6)
   * sproto - transport protocol to be used to send (string)
   * buf - entire send buffer as string
@@ Line 878: / Line 1298: @@
 </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 939: / Line 1423: @@
 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 950: / Line 1434: @@
 ==== $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 1009: / Line 1494: @@
 module.
-===== HTable module Pseudo-Variables =====
+===== HTable Module =====
 ==== $sht(htable=>key) ====
@@ Line 1015: / Line 1500: @@
 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 1162: / Line 1647: @@
 }
 </code>
-===== Memcached module Pseudo-Variables =====
+===== Memcached Module =====
 ==== $mct(key) ====
@@ Line 1238: / Line 1723: @@
 ...
 </code>
+===== http_async_client Module =====
+==== $http_req_id ====
+The $http_req_id read-only variable can be used in REQUEST_ROUTE to retrive the unique identifier for a query after sending it or in the HTTP callback route to retrive the id of the query the reply belongs to. Useful mainly in non-transactional context.
+==== $http_req(key) ====
+The $http_req(key) write-only variable can be used to set custom parameters before sending a HTTP query.
+**key** can be one of:
+  * all: if set to $null, resets all the parameters to their default value (the ones defined in modparam)
+  * hdr: sets/modifies/removes a HTTP header. N.B.: setting this variable multiple times will add several headers to the query.
+  * body: sets/modifies/removes the request body
+  * method: sets the HTTP method: either "GET", "POST", "PUT" or "DELETE" (these are the supported methods). (Note: if the method is not set, curl will use GET, or POST if a body is specified)
+  * timeout: sets the HTTP timeout. (Note, this timeout should be normally less than tm.fr_timer timeout, because transaction timeout has a higher priority over HTTP timeout)
+  * tls_client_cert: sets the client certificate to use
+  * tls_client_key: sets the client certificate key to use
+  * tls_ca_path: sets the CA certificate path to use
+  * authmethod: Sets the preferred authentication mode for HTTP/HTTPS requests. The value is a bitmap and multiple methods can be used. Note that in this case, the CURL library will make an extra request to discover server-supported authentication methods. You may want to use a specific value. Valid values are:
+      * 1 - BASIC authentication
+      * 2 - HTTP Digest authentication
+      * 4 - GSS-Negotiate authentication
+      * 8 - NTLM authentication
+      * 16 - HTTP Digest with IE flavour.
+      * (Default value is 3 - BASIC and Digest authentication.)
+  * username: sets the username to use for authenticated requests
+  * password: sets the password to use for authenticated requests
+  * suspend: if set to 0 it doesn't suspend the current transaction before performing the query
+  * tcp_keepalive: enable TCP keepalive
+  * tcp_ka_idle: set TCP keepalive idle time wait
+  * tcp_ka_interval: set TCP keepalive interval
+==== Other read-only variables ====
+The following read-only pseudo variables can only be used in the callback routes executed by http_async_query()
+=== $http_ok ===
+if cURL executed the request successfully, 0 otherwise (check $http_err for details).
+=== $http_err ===
+cURL error string if an error occurred, $null otherwise.
+=== $http_rs ===
+HTTP status.
+=== $http_rr ===
+HTTP reason phrase.
+=== $http_hdr(Name) ===
+Value of the Name header (the $(http_hdr(Name)[N]) syntax can also be used, check the SIP $hdr() PV documentation for details).
+=== $http_mb and $http_ml ===
+HTTP response buffer (including headers) and length.
+=== $http_rb and $http_bs ===
+HTTP response body and body length,
 ===== XMLOPS Pseudo-Variables =====
@@ Line 1256: / Line 1799: @@
 </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 1322: / Line 1869: @@
 The **name** can be:
-  * id_index - return the internal index of current transaction
+  * id_index - return the internal index of current transaction or $null if not transaction is found
-  * id_label - return the internal label of current transaction
+  * id_label - return the internal label of current transaction or $null if not transaction is found
-  * reply_code - alias to $T_reply_code
+  * id_index_n - return the internal index of current transaction, if no transaction exists yet, create it
-  * branch_index - alias to $T_branch_idx
+  * id_label_n - return the internal label of current transaction, if no transaction exists yet, create it
+  * reply_code - reply code (alias to $T_reply_code)
+  * reply_reason - reply reason
+  * reply_last - last received reply code
+  * branch_index - branch index (alias to $T_branch_idx)
   * ruid - return the internal location ruid field for current branch
   * reply_type - 1 if it is a local generated reply, 0 - if no reply for transaction or it is a received reply
@@ Line 1341: / Line 1892: @@
-===== UAC module Pseudo-Variables =====
+===== UAC Module =====
 ==== $uac_req(key) ====
@@ Line 1377: / Line 1928: @@
 }
 </code>
-===== Nathelper module Pseudo-Variables =====
+===== Nathelper Module =====
 ==== $rr_count ====
@@ Line 1387: / Line 1938: @@
   * 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 1413: / Line 1964: @@
 ==== $TV(name) ====
-Seconds and microseconds taken from struct timeval.
+Seconds and microseconds taken from struct timeval. The time at that moment is represented by **seconds.microseconds**.
   * $TV(s) - seconds (cached at first call per sip message)
   * $TV(u) - microseconds (cached at first call per sip message)
-  * $TV(sn) - seconds (not cached)
+  * $TV(sn) - seconds (not cached, taken at that moment)
-  * $TV(un) - microseconds (not cached)
+  * $TV(un) - microseconds (corresponding to the moment $TV(sn) is retrieved)
-  * $TV(Sn) - string representation seconds.microseconds (not cached)
+  * $TV(Sn) - string representation seconds.microseconds (not cached, taken at that moment)
 ===== Next hop address =====
 ==== $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 1433: / Line 1983: @@
   * $nh(P) - transport protocol (upper case p)
-===== GeoIP module Pseudo-Variables =====
+===== NDB_REDIS Module =====
+==== $redis(res=>key) ====
+Access the attributes of the Redis response.
+The key can be:
+  * type - type of the reply (as in hiredis.h)
+  * value - the value returned by REDIS server;
+  * info - in case of error from REDIS, it will contain an info message.
+If reply type is an array (as in hiredis.h), there are other keys available:
+  * size - returns number of elements in the array.
+  * type[n] - returns the type of the nth element in the array. type - returns array type.
+  * value[n] - returns value of the nth element. value - returns null for an array. You need to get each element by index.
+In case one of the members of the array is also an array (for example calling SMEMBERS in a MULTI/EXEC transaction), the members of the array can be accessed by adding any of the above keys, after a value[n] key. The first value[n] references the element in the first array, while the next key references an element of the referenced array.
+Example:
+<code>
+redis_cmd("srvN", "GET foo", "r");
+xlog("===== result type: $redis(r=>type) * value: $redis(r=>value)\n");
+</code>
+==== $redisd(key) ====
+Return the corresponding value for various defines from hiredis library.
+The key can be:
+  * rpl_str - return REDIS_REPLY_STRING
+  * rpl_arr - return REDIS_REPLY_ARRAY
+  * rpl_int - return REDIS_REPLY_INTEGER
+  * rpl_nil - return REDIS_REPLY_NIL
+  * rpl_sts - return REDIS_REPLY_STATUS
+  * rpl_err - return REDIS_REPLY_ERROR
+$redisd(rpl_XYZ) can be compared with $redis(r=>type).
+Example:
+<code>
+redis_cmd("srvN", "GET foo", "r");
+if ($redis(r=>type) == $redisd(rpl_int)) {
+}
+</code>
+===== GeoIP Module =====
 ==== $gip(pvc=>key) ====
@@ Line 1469: / Line 2071: @@
 </code>
-===== TLS module Pseudo-Variables =====
+===== 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 1538: / Line 2160: @@
 ==== $tls_peer_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type.
+==== $tls_peer_subject_uid ====
+UID in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type.
+==== $tls_my_subject_uid ====
+UID in the subject section of the certificate. String type.
 ==== $tls_my_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type.
@@ Line 1581: / Line 2207: @@
 ==== $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 1591: / Line 2229: @@
   * $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 =====
+==== $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 Pseudo-Variables =====
+===== XHTTP Module =====
 ==== $hu ====
@@ Line 1600: / Line 2251: @@
   * 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.
@@ Line 1669: / Line 2320: @@
 The internal integer id for TCP/TLS connection.
-===== SIPT module Pseudo-Variables =====
+===== SIPT Module =====
 ==== $sipt(calling_party_number.presentation) / $sipt_presentation ====
@@ Line 1792: / Line 2443: @@
   * 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 1800: / Line 2560: @@
 The key can be:
- * line - return current line in config
+  * line - return the current line in config
- * name - return the name of current config file
+  * name - return the name of current config file
+  * file - return the name of current config file
+  * route - return the name of routing block
 Example:
@@ Line 1871: / Line 2633: @@
 </code>
-===== JSONRPC-S Variables =====
+===== JSONRPCS Variables =====
 ==== $jsonrpl(key) - JSONRPC Reply ====
@@ Line 1882: / Line 2644: @@
   * body - the body of the JSONRPC response
-===== Presence Module Pseudo-Variables =====
+===== Presence Module =====
 ==== $subs(key) - Subscription Attributes ====
@@ Line 1890: / Line 2652: @@
 The key can be:
   * 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.
-===== $C(xy) - Foreground and background colors =====
+===== Registrar Module =====
+==== $ulc(profile=>attr) - Registered Contact Attributes ====
+Access the attributes of contact addresses stored in 'profile'.
+It must be used after a call of “reg_fetch_contacts()”.
+===== Sipcapture Module =====
+==== $hep(key) - HEP Packet Attributes ====
+The key refers to HEP packet header values:
+  * version - HEP version
+  * src_ip - source IP address
+  * dst_ip - destination IP address
+  * 0x000 - HEP attribute 0x000
+  * 0x999 - HEP attribute 0x999
+===== 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:
+  * number - phone number that is matched
+  * valid - 1 if the matched number has a valid result; 0 otherwise
+  * normalized - normalized phone number
+  * cctel - country code for phone number
+  * ltype - local network type
+  * ndesc - phone number description
+  * error - error string if phone number matching fails.
+<code c>
+if(phonenum_match("1-484-555-8888", "src")) {
+    if($phn(src=>valid)==1) {
+        xlog("number normalized to: $phn(src=>normalized)\n");
+    } else {
+        xlog("number normalization error: $phn(src=>error)\n");
+    }
+}
+</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 =====
+  * $sdp(body) - full SDP body (read only)
+  * $sdp(sess_version) - sess-version -attribute from SDP o= -line. When set to special value -1, current value is incremented. (read + write)
+===== $sruid - Unique ID =====
+  * $sruid - return unique ID generated internally Kamailio
+===== $ltt(key) - Local To-Tag =====
+$ltt(key) - return local generated To-tag when Kamailio sends a reply
+  * $ltt(s) - the to-tag used in stateless replies
+  * $ltt(t) - the to-tag used in transaction stateful replies (transaction has to be created at that time, eg., by t_newtran() or in a branch/failure route, otherwise it returns $null)
+  * $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 =====
+$tcp(key) - return TCP connection attributes.
+The key can be:
+  * c_si - connection source ip (useful with HAProxy connections)
+  * 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 =====
 $C(xy) - reference to an escape sequence. “x” represents the foreground color and “y” represents the background color.
@@ Line 1908: / Line 2794: @@
+===== $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 =====

Kamailio SIP Server Wiki

User Tools

Site Tools

Differences

Page Tools