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
cookbooks:devel:pseudovariables [2017/10/01 00:06]
mslehto [$csb - CSeq Header Body] s/cs/csb/
cookbooks:devel:pseudovariables [2020/07/17 08:12]
miconda
Line 1: Line 1:
 {{ :cookbooks:devel:pseudovariables.png?200|}} {{ :cookbooks:devel:pseudovariables.png?200|}}
-====== Kamailio SIP Server v5.1.x (devel): Pseudo-Variables ======+====== Pseudo-Variables ====== 
 + 
 +Version: Kamailio SIP Server v5.5.x (devel)
  
 ===== Introduction ===== ===== Introduction =====
Line 20: Line 22:
   * avpops   * avpops
   * htable   * htable
 +  * http_async_client
   * textops   * textops
   * uac   * uac
Line 76: Line 79:
 **$aU** - whole username from Authorization or Proxy-Authorization header **$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 auth username ($au) if exists or From username ($fU) 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 ==== ==== $branch(name) - Branch attributes ====
  
Line 225: Line 230:
  
 If loose_route() returns TRUE a destination uri is set according to the first Route header. 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:kamailio.org
    sip:pbx123.kamailio.org;transport=udp    sip:pbx123.kamailio.org;transport=udp
Line 244: Line 250:
 **$fn** - reference to display name of 'From' header **$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> <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 ==== ==== $ft - From tag ====
Line 268: Line 295:
  
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
 +
 ==== $fU - From URI username ==== ==== $fU - From URI username ====
  
Line 275: Line 303:
  
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. 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 - SIP message buffer ====
  
 **$mb** - reference to 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 ==== ==== $mf - Flags ====
Line 323: Line 360:
  
 **$oU** - reference to username in request's original URI **$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 ==== ==== $pd - Domain in P-Preferred-Identity header URI ====
Line 447: Line 488:
  
 <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)</fc>
 +
 +==== $rUl - R-URI Username Length ====
 +
 +**$rU** - the length of the username in R-URI
  
 ==== $rv - SIP message version ==== ==== $rv - SIP message version ====
Line 490: Line 535:
 **$Rut** - local socket where the SIP messages was received in URI format, always with transport parameter. **$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 ==== ==== $sbranch(attr) - Static Branch ====
  
Line 519: Line 567:
 **$si** - reference to IP source address of the message - see also $siz **$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 - Source IP address ====
  
Line 580: Line 631:
  
 **$tU** - reference to username in URI of 'To' header **$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 ==== ==== $Tb - Startup timestamp ====
Line 625: Line 680:
 **$env(NAME)** - value of the environment variable named NAME **$env(NAME)** - value of the environment variable named NAME
  
 +Example:
 +
 +<code c>
 +xdbg("PATH environment variable:  $env(PATH)\n");
 +</code>
 ===== $avp(id) - AVPs ===== ===== $avp(id) - AVPs =====
  
Line 695: Line 755:
 ===== $xavp(id) - XAVPs ===== ===== $xavp(id) - XAVPs =====
  
-xavp - extended AVP'- 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> <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> </code>
  
 Like avps, xavp act like a stack. To refer to an existing value, use an index. The newest xavp has index zero [0]. 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> <code c>
-$xavp(root[0]=>newbranch)=12;+$xavp(root[0]=>field)=12;
 </code> </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. 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> <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> </code>
  
Line 719: Line 802:
 Another example: Another example:
 <code c> <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"; $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_timer)=10;
 $xavp(sf[0]=>fr_inv_timer)=15; $xavp(sf[0]=>fr_inv_timer)=15;
 $xavp(sf[0]=>headers)="X-CustomerID: 1234\r\n"; $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"; $xavp(sf=>uri)="sip:10.10.10.11";
 +# add named values (child values)
 $xavp(sf[0]=>fr_timer)=20; $xavp(sf[0]=>fr_timer)=20;
 $xavp(sf[0]=>fr_inv_timer)=35; $xavp(sf[0]=>fr_inv_timer)=35;
  
-#Create a third xavp+create new (the thirdxavp 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"; $xavp(sf=>uri)="sip:10.10.10.12";
 +# add named values (child values)
 $xavp(sf[0]=>fr_timer)=10; $xavp(sf[0]=>fr_timer)=10;
 $xavp(sf[0]=>fr_inv_timer)=15; $xavp(sf[0]=>fr_inv_timer)=15;
Line 739: Line 824:
 </code> </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) - Headers =====
  
Line 748: Line 857:
 **$(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 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. 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 841: Line 952:
 <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)</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 ===== ===== $time(name) - Broken-down time =====
  
Line 907: Line 1027:
 } }
 </code> </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> 
 + 
 +===== Send Data Attributes =====
  
 ==== $sndfrom(name) ==== ==== $sndfrom(name) ====
Line 926: Line 1072:
   * af - address family to be used to send (numeric)   * af - address family to be used to send (numeric)
   * port - port of destination address   * 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)   * sproto - transport protocol to be used to send (string)
   * buf - entire send buffer as string   * buf - entire send buffer as string
Line 943: Line 1089:
 </code> </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> 
 + 
 + 
 +===== Benchmark Module =====
  
 ==== $BM_time_diff ==== ==== $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.  $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) ==== ==== $dlg(attr) ====
Line 1004: Line 1180:
 The 'key' can be any string. 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. * type - get variable type. Possible types are: atom, integer, list, string, tuple, pid and ref.
Line 1015: Line 1191:
  
 ==== $erl_atom(name) ==== ==== $erl_atom(name) ====
 +
 //$erl_atom(name)// pseudo variable allows create analog to Erlang atom data type. //$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 Erlang atom is a literal, a constant with name. Formatted output pseudo variable
Line 1074: Line 1251:
 module. module.
  
-===== HTable module Pseudo-Variables =====+===== HTable Module =====
  
 ==== $sht(htable=>key) ==== ==== $sht(htable=>key) ====
Line 1080: Line 1257:
 Access hash table entries. 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. The “htname” must be a hash table name defined via “htable” parameter.
Line 1227: Line 1404:
 } }
 </code> </code>
-===== Memcached module Pseudo-Variables =====+===== Memcached Module =====
  
 ==== $mct(key) ==== ==== $mct(key) ====
Line 1303: Line 1480:
 ... ...
 </code> </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 ===
 +1 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 ===== ===== XMLOPS Pseudo-Variables =====
Line 1321: Line 1556:
 </code> </code>
  
-===== TMX module Pseudo-Variables =====+===== TMX Module =====
  
 ==== $T_branch_idx ==== ==== $T_branch_idx ====
Line 1410: Line 1645:
  
  
-===== UAC module Pseudo-Variables =====+===== UAC Module =====
  
 ==== $uac_req(key) ==== ==== $uac_req(key) ====
Line 1446: Line 1681:
 } }
 </code> </code>
-===== Nathelper module Pseudo-Variables =====+===== Nathelper Module =====
  
 ==== $rr_count ==== ==== $rr_count ====
Line 1456: Line 1691:
   * 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.   * 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) ==== ==== $mqk(q) ====
Line 1482: Line 1717:
 ==== $TV(name) ==== ==== $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(s) - seconds (cached at first call per sip message)
   * $TV(u) - microseconds (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 ===== ===== Next hop address =====
  
Line 1502: Line 1736:
   * $nh(P) - transport protocol (upper case p)   * $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) ==== ==== $gip(pvc=>key) ====
Line 1538: Line 1824:
 </code> </code>
  
-===== TLS module Pseudo-Variables =====+===== TLS Module =====
  
 ==== $tls_version ==== ==== $tls_version ====
Line 1607: Line 1893:
 ==== $tls_peer_subject_unit ==== ==== $tls_peer_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type. 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 ==== ==== $tls_peer_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type. organizationalUnitName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_unit ==== ==== $tls_my_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type. 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 ==== ==== $tls_my_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type. organizationalUnitName in the issuer section of the certificate. String type.
Line 1650: Line 1940:
 ==== $tls_peer_server_name ==== ==== $tls_peer_server_name ====
 The SNI server name of the peer 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 ===== ===== SIP Message Attributes =====
  
Line 1663: Line 1965:
   * $msg(fline) - sip message first line   * $msg(fline) - sip message first line
  
-===== XHTTP module Pseudo-Variables =====+===== XHTTP Module =====
  
 ==== $hu ==== ==== $hu ====
Line 1669: Line 1971:
   * URL of http request.   * 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. This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames.
Line 1738: Line 2040:
 The internal integer id for TCP/TLS connection. The internal integer id for TCP/TLS connection.
  
-===== SIPT module Pseudo-Variables =====+===== SIPT Module =====
  
 ==== $sipt(calling_party_number.presentation) / $sipt_presentation ==== ==== $sipt(calling_party_number.presentation) / $sipt_presentation ====
Line 1953: Line 2255:
   * body - the body of the JSONRPC response   * body - the body of the JSONRPC response
  
-===== Presence Module Pseudo-Variables =====+===== Presence Module =====
  
 ==== $subs(key) - Subscription Attributes ==== ==== $subs(key) - Subscription Attributes ====
Line 1962: Line 2264:
   * 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.   * 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 ==== ==== $ulc(profile=>attr) - Registered Contact Attributes ====
Line 1970: Line 2272:
 It must be used after a call of “reg_fetch_contacts()”. It must be used after a call of “reg_fetch_contacts()”.
  
-===== sipcapture Module Pseudo-Variables =====+===== Sipcapture Module =====
  
 ==== $hep(key) - HEP Packet Attributes ==== ==== $hep(key) - HEP Packet Attributes ====
Line 1981: Line 2283:
   * 0x000 - HEP attribute 0x000   * 0x000 - HEP attribute 0x000
   * 0x999 - HEP attribute 0x999   * 0x999 - HEP attribute 0x999
 +
 +===== $phn(rid=>key) - 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>
 +
 +
 +===== 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)
 +
 +===== 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) - Foreground and background colors =====
cookbooks/devel/pseudovariables.txt · Last modified: 2020/07/17 08:12 by miconda